No description, website, or topics provided.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
data/questions
lib
spec
.gitignore
.rspec
.ruby-version
Gemfile
Guardfile
MIT-LICENSE
README.md
Rakefile
circuitdata.gemspec

README.md

Circuitdata

This gem provides helper functions that allows you to do schema checks and control files up against each other according to the CircuitData Language

Installation

Add this line to your application's Gemfile:

gem 'circuitdata'

And then execute:

$ bundle

Or install it yourself as:

$ gem install circuitdata

Usage

If not in rails

require 'circuitdata'

Commands

Circuitdata.dereferenced_schema

This returns the JSON schema used internally to validate the Circuit Data information. It returns the schema without any usage of $ref so that it can be utilized without any knowledge of the internal paths.

Circuitdata::Profile.questions

Returns a list of grouped questions that can be used for populating an input interface related to profiles.

Example output:

[
  {
    id: :rigid_conductive_layer,
    name: 'Rigid conductive layer',
    questions: [
      {
        code: :copper_foil_roughness,
        name: 'Copper foil roughness',
        defaults: {
          descriptor: {
            type: "string",
            enum: ["S", "L", "V"],
            uom: ["um"],
            description: "The roughness of the copper foil."
          },
          path: "/open_trade_transfer_package/profiles/default/printed_circuits_fabrication_data/rigid_conductive_layer/copper_foil_roughness"
        }
      },
    ]
  }
  # ...
]

Validation

To validate a CircuitData JSON file the Validator can be used. This will check that a file matches the schema defined in the CircuitData language as well as logical issues. An example of a logical issue is missing layers in the layers list for a product.

The following is an example of using the Validator:

validator = Circuitdata::Validator.new(json_file_contents)
if !validator.valid?
  puts validator.errors.inspect
end
# ...

License

The gem is available as open source under the terms of the MIT License.