kicad 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a91d99c4c831dbc121717ef0609e05c8fe07c20d1b2044bfddda163c75c6620
-  data.tar.gz: 9110254e21b4e2913160100ec75f2887ea327107a0fefb257a23e77a9dfba362
+  metadata.gz: 9d8cfc291b0619e083673bc0239c3423c6fc9decd02348d91e99ce884dd24d39
+  data.tar.gz: df0a12ac2396bbb27f4c843e76f6c7004e8ffd8e3577c4e824be32d8717b7d91
 SHA512:
-  metadata.gz: 44681ff57b45bebeea66e8a0dc92932e8219354dd2545e2dd4a9b4feb614aa7d2d528aff3946875c4373ff701e95015961e7865d0cc12a527404b84d29ae4b74
-  data.tar.gz: f2af698d30cd4b24a700a03a937f7a7a6c9913250c63aa99b3d75828191bb7d589d6fa06acd4a342f66c7d8a585d48ed8487aa0d1059e69a70262b2ce0da54cc
+  metadata.gz: a1907a0652b06784809b3f5c1692c2cd46f187bf0178e1389597e1f56a1142ac66d0772b1964e2b5fa4eda7ffe4ec80c38b34522188b5644d83c310550ed0fb8
+  data.tar.gz: 7b268bcc9684f36967f36b205a93706128589261cddf51abea86de5dd55b71a431fd2a25b2de6d5da2d6f2b561901669f3f46f8ab925ae72fdc2af05b674ed26

data/README.md

@@ -1,18 +1,25 @@
 # KiCad
 
-Parse, load, modify and rewrite Kicad (s-epression) files into a convenient tree structure for scripting
+Parse, load, modify and rewrite Kicad (s-expression) files into a convenient tree structure for scripting
 
 ## Installation
 
     gem install kicad
 
-## Usage
+## Usage Example
+
+For all parts with no PartNumber property, copy it from the Value field and make sure it's hidden:
 
     $ irb -r kicad
-    irb(main):001> k = KiCad.load("my_file.kicad_sym").value
-    irb(main):001> k.children.filter{|c| KiCad::AST::Symbol === c }.map{|c| c.values[1]}
-    ["BC107", "CD4046"]
-    irb(main):001> puts k.emit
+    irb(main):001> k = KiCad.load('mylib.kicad_sym').value
+    => 
+    #<KiCad::AST::KicadSymbolLib:0x00000001473f5488
+    ...
+    irb(main):002> k.all_symbol.each{|s| s['PartNumber'] = s.property('Value') unless s.property('PartNumber') }; nil
+    => nil
+    irb(main):003> k.all_symbol.each{|s| s.property_node('PartNumber')&.hidden = true }
+    => nil
+    irb(main):001> File.open("rewrite.kicad_sym", "w") { |f| f.puts k.emit }
     ...
 
 ## Development
@@ -26,6 +33,10 @@ To install this gem onto your local machine from local source code, run `rake in
 KiCad uses a version of the Cadence SPECCTRA Design Language, defined in https://cdn.hackaday.io/files/1666717130852064/specctra.pdf
 
 KiCad's documentation of this is at https://dev-docs.kicad.org/en/file-formats/sexpr-intro/
+The documentation is incomplete. This library contains some items as found in KiCad 9 symbol libraries,
+and doesn't contain everything documented above, especially of those have not been found.
+Best efforts - if you find a problem, you discovered why this is open source.
+lib/kicad/asts.rb is your starting point for adding metedata.
 
 A related Rust library that was not consulted while building this is https://github.com/adom-inc/kicad_lib/tree/main/kicad_sexpr
 

data/lib/kicad/ast.rb

@@ -190,18 +190,14 @@ module KiCad
       child_types :at, :effects
 
       # Set or clear (hide) on the property_node
-      def hide=(h = true)
+      def hidden=(h = true)
         v = (h ? :yes : :no)
-        if !effects
-          # puts "No effects yet"
+        if !effects                     # No effects yet
           prop = KiCad.parse(%Q{(effects(hide #{v}))})&.value
           @children.append(prop) if prop
-        elsif (existing = effects.hide)
-          # puts "Effects and hide already"
+        elsif (existing = effects.hide) # Effects and hide already
           existing.hide = v
-        else
-          # Create new (hide) node:
-          # puts "Effects but no hide"
+        else                            # Create new (hide) node
           prop = KiCad.parse(%Q{(hide #{v})})&.value
           @children.append(prop) if prop
         end
@@ -347,19 +343,19 @@ module KiCad
       end
 
       def []=(k, v)
-        puts "Setting property #{k} to #{v.inspect}"
-        if (p = property_node)
-          p.send(:"#{self.class.to_symbol k}=", v)
+        # puts "Setting property #{k} to #{v.inspect}"
+        if (prop = property_node(k))
+          prop.value = v
         else  # Create new Property using the parser:
           prop = KiCad.parse(%Q{
             (property "#{k}" #{String === v ? v.inspect : v.to_s}
               (at 0 0 0)
-              (effects(font(size 1.27 1.27)))
-              (hide yes)
+              (effects(font(size 1.27 1.27)) (hide yes))
             )
           })&.value
           @children.append(prop) if prop
         end
+        prop
       end
     end
 
@@ -368,12 +364,12 @@ module KiCad
     end
 
     class PinNumbers < Node
-      value_types :hide => [:no, :yes]
+      # This is a child node, not as documented (a value in https://dev-docs.kicad.org/en/file-formats/sexpr-intro/)
+      child_types :hide
     end
 
     class PinNames < Node
-      child_types :offset
-      value_types :hide => [:no, :yes]
+      child_types :offset, :hide
     end
 
     class InBom < Node

data/lib/kicad/version.rb

@@ -1,3 +1,3 @@
 module KiCad
-  VERSION = "0.9.3"
+  VERSION = "0.9.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: kicad
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Clifford Heath
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler