kicad 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ea6528c30596177b5286780246f20331ff0a82109b527d0c311e5aca88d6b42
+  data.tar.gz: b439278fbd1dd60ff5f931f67d7f6009517b179937b16cf0998de12beb3d8e1e
+SHA512:
+  metadata.gz: 57e43e2a123bb69b0497b7fd62cf66a54e5fcec279b3047dfdc7701bf8ae7016c33bfdc63fb298c28628a90a6e232b601e2eb0729495d8c4c8b4000dd9bb13f7
+  data.tar.gz: 7a4474f86498962aa00c14aee3dc89a4a8c7d0d73aa66eee185cd526928b0286fd15a08762cd8604ce1fdcde651c65ed3348ba1a3e960c3bf5e034ca19d78871

data/.gitignore

@@ -0,0 +1,3 @@
+sample.*
+*.swp
+lib/kicad/grammar.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    kicad (0.8.0)
+      irb (~> 1.14, >= 1.14)
+      treetop (~> 1.6, >= 1.6.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    date (3.4.1)
+    diff-lcs (1.6.1)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    polyglot (0.3.5)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.4)
+      date
+      stringio
+    rake (13.2.1)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    stringio (3.1.7)
+    treetop (1.6.14)
+      polyglot (~> 0.3)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bundler (>= 1.11)
+  kicad!
+  rake (>= 13)
+  rspec (~> 3.3)
+
+BUNDLED WITH
+   2.6.2

data/README.md

@@ -0,0 +1,37 @@
+# KiCad
+
+Parse, load, modify and rewrite Kicad (s-epression) files into a convenient tree structure for scripting
+
+## Installation
+
+    ```ruby
+    gem 'kicad'
+    ```
+
+or
+
+    gem install kicad
+
+## Usage
+
+    $ irb -r kicad
+    irb(main):001> k = KiCad.load("my_file.kicad_lib").value
+    irb(main):001> k.children.filter{|c| c === KiCad::AST::Symbol}.map{|c| c.values[1]}
+    ["BC107", "CD4046"]
+    irb(main):001> puts k.emit
+    ...
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine from local source code, run `rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cjheath/kicad-rb
+
+## License
+
+The gem is open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Bump gem version patch number"
+task :bump do
+  path = File.expand_path('../lib/kicad/version.rb', __FILE__)
+  lines = File.open(path) do |fp| fp.readlines; end
+  File.open(path, "w") do |fp|
+    fp.write(
+      lines.map do |line|
+	line.gsub(/(VERSION *= *"[0-9.]*\.)([0-9]+)"\n/) do
+	  version = "#{$1}#{$2.to_i+1}"
+	  puts "Version bumped to #{version}\""
+	  version+"\"\n"
+	end
+      end*''
+    )
+  end
+end

data/kicad.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kicad/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kicad"
+  spec.version       = KiCad::VERSION
+  spec.authors       = ["Clifford Heath"]
+  spec.email         = ["clifford.heath@gmail.com"]
+
+  spec.summary       = %q{Load and rewrite Kicad s-expression files into a tree structure for scripting}
+  spec.description   = %q{Load and rewrite Kicad s-expression files into a tree structure for scripting}
+  spec.homepage      = "https://github.com/cjheath/kicad"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # spec.bindir        = "bin"
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 13"
+
+  spec.add_runtime_dependency "treetop", ["~> 1.6", ">= 1.6.9"]
+  spec.add_runtime_dependency "irb", ["~> 1.14", ">= 1.14"]
+end

data/lib/kicad/ast.rb

@@ -0,0 +1,146 @@
+module KiCad
+  module AST
+    class Node
+      attr_reader :values, :children
+
+      def initialize values, children
+        @values = values
+        @children = children
+      end
+
+      def emit depth = 0
+        "\t"*depth +
+        '(' +
+        @values.map{|v| value(v) }*' ' +
+        (@children.size == 0 ? '' : "\n" + @children.map{|c| c.emit(depth+1) }*''+"\t"*depth) +
+        ")\n"
+      end
+
+      def value(v)
+        case v
+        when ::Symbol
+          v.to_s
+        when String
+          v.inspect
+        when Float, Integer
+          v.to_s
+        else
+          "Internal error"
+        end
+      end
+    end
+
+    class KicadSymbolLib < Node
+      def initialize values, children
+        super
+      end
+    end
+
+    # Uncomment or add whatever class you need to customise:
+
+    class Symbol < Node
+    end
+
+=begin
+    class At < Node
+    end
+
+    class Center < Node
+    end
+
+    class Circle < Node
+    end
+
+    class Effects < Node
+    end
+
+    class EmbeddedFonts < Node
+    end
+
+    class End < Node
+    end
+
+    class ExcludeFromSim < Node
+    end
+
+    class Fill < Node
+    end
+
+    class Font < Node
+    end
+
+    class Generator < Node
+    end
+
+    class GeneratorVersion < Node
+    end
+
+    class Hide < Node
+    end
+
+    class InBom < Node
+    end
+
+    class Length < Node
+    end
+
+    class Name < Node
+    end
+
+    class Number < Node
+    end
+
+    class Offset < Node
+    end
+
+    class OnBoard < Node
+    end
+
+    class Pin < Node
+    end
+
+    class PinNames < Node
+    end
+
+    class PinNumbers < Node
+    end
+
+    class Polyline < Node
+    end
+
+    class Property < Node
+    end
+
+    class Pts < Node
+    end
+
+    class Radius < Node
+    end
+
+    class Rectangle < Node
+    end
+
+    class Size < Node
+    end
+
+    class Start < Node
+    end
+
+    class Stroke < Node
+    end
+
+    class Type < Node
+    end
+
+    class Version < Node
+    end
+
+    class Width < Node
+    end
+
+    class Xy < Node
+    end
+=end
+
+  end
+end

data/lib/kicad/grammar.tt

@@ -0,0 +1,44 @@
+require 'kicad/ast'
+
+module KiCad
+  grammar SExpr
+    rule node
+      '(' s values:( value s)+ nodes:(node s)* ')' s
+      { def value
+          klass_name = values.elements[0].value.value
+          klass = KiCad::AST::Node
+          if klass_name.is_a? ::Symbol
+	    # See if we have a defined class for this node type
+	    klass_name = klass_name.to_s.gsub(/\A[a-z]|_[a-z]/) {|from| from[-1].upcase }
+            klass = KiCad::AST.const_get(klass_name, false) rescue KiCad::AST::Node
+          end
+          klass.new values.elements.map(&:value).map(&:value),
+                    nodes.elements.map(&:node).map(&:value)
+        end
+      }
+    end
+
+    rule value
+      string / number / symbol
+    end
+
+    rule symbol
+      [a-zA-Z_]+
+        { def value; :"#{text_value}"; end }
+    end
+
+    rule string
+      '"' ('\\"' / !'"' .)* '"'
+        { def value; eval(text_value); end }  # REVISIT: Risk of evaluating code
+    end
+
+    rule number
+      '-'? [0-9]+ ( '.' [0-9]* )?
+        { def value; eval(text_value); end }
+    end
+
+    rule s
+      [ \t\r\n]*
+    end
+  end
+end

data/lib/kicad/parser.rb

@@ -0,0 +1,20 @@
+require 'treetop'
+require_relative 'grammar'
+
+module KiCad
+  def self.parse string
+    p = Parser.new
+    result = p.parse string
+    if !result
+      throw "KiCad::SExpr parse failed at line #{p.failure_line} column #{p.failure_column}: #{p.failure_reason}"
+    end
+    result
+  end
+
+  def self.load filename
+    self.parse File.read(filename)
+  end
+
+  class Parser < KiCad::SExprParser
+  end
+end

data/lib/kicad/version.rb

@@ -0,0 +1,3 @@
+module KiCad
+  VERSION = "0.8.0"
+end

data/lib/kicad.rb

@@ -0,0 +1,3 @@
+require 'kicad/version'
+require 'kicad/ast'
+require 'kicad/parser'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: kicad
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Clifford Heath
+bindir: bin
+cert_chain: []
+date: 2025-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.9
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: Load and rewrite Kicad s-expression files into a tree structure for scripting
+email:
+- clifford.heath@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- kicad.gemspec
+- lib/kicad.rb
+- lib/kicad/ast.rb
+- lib/kicad/grammar.tt
+- lib/kicad/parser.rb
+- lib/kicad/version.rb
+homepage: https://github.com/cjheath/kicad
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Load and rewrite Kicad s-expression files into a tree structure for scripting
+test_files: []