archive-pecan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f09798c77e866d10826707615d7bdabebe7395859f6c3aee7ada5a897519822e
+  data.tar.gz: cf2a1e6559f64cee7d9f63238d11a3e646ddfbb1f31f06c1c55f9e26df162237
+SHA512:
+  metadata.gz: 48ec8905d5549badd1f450ff114002671f38cd771e281068a27d3c6f48b2c8a09932c36b327185831d1762e6de045239d1edb2d2ce773f9e22dd69a958f852ad
+  data.tar.gz: 28595f022e69c4dcf51fd27cca1169e749959976b52c1ebd22a8f595d84c610c7566f0b3b0b8ee6c6f9e9564a774c774384b7d936d4459d81a0287989cc71ade

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Nathan Campos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Pecan Gem
+
+A Ruby gem for dealing with [Pecan🥜](https://github.com/nathanpc/pecan)
+archives, which are basically files that define electronic components in your
+parts bins, allowing us to have a virtual representation that is browseable of
+our components in our parts bins.
+
+
+## License
+
+This project is licensed under the **MIT License**.
+

data/lib/archive/pecan/attribute.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module Archive
+  class Pecan
+    # Abstract representation of a component attribute as a key-value pair.
+    #
+    # @author Nathan Campos <nathan@innoveworkshop.com>
+    class Attribute
+      # @return [String] Descriptive name of the attribute.
+      attr_accessor :name
+
+      # @return [String] Value of the attribute.
+      attr_accessor :value
+
+      # Initializes a component attribute.
+      #
+      # @param name [String] Descriptive name of the attribute.
+      # @param value [String] Value of the specified attribute.
+      def initialize(name = nil, value = nil)
+        @name = name
+        @value = value
+      end
+
+      # Initializes a component attribute from an attribute file line.
+      #
+      # @param line [String] Attribute file line.
+      #
+      # @return [Attribute] Parsed attribute object from line.
+      def self.from_line(line)
+        attr = new
+
+        # Make sure we have a valid line.
+        line = line.strip
+        return nil if line.empty?
+
+        # Parse line and populate the object.
+        str = line.split("\t", 2)
+        attr.name = str[0]
+        attr.value = str[1]
+
+        attr
+      end
+
+      # String representation of this object just as it is represented in an
+      # attribute file.
+      #
+      # @return [String] Object as represented in an attribute file.
+      def to_s
+        "#{@name}\t#{value}\n"
+      end
+
+      # @see to_s
+      def to_str
+        to_s
+      end
+    end
+  end
+end

data/lib/archive/pecan/blob.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'base64'
+
+module Archive
+  class Pecan
+    # Abstract representation of a binary blob in an component archive.
+    #
+    # @author Nathan Campos <nathan@innoveworkshop.com>
+    class Blob
+      # @return [String] MIME type of the data contained in the blob.
+      attr_accessor :mime_type
+
+      # @return [#read] Blob of binary data.
+      attr_accessor :blob
+
+      # Initializes the blob object with data.
+      #
+      # @param mime_type [String] MIME type of the binary blob.
+      # @param blob [#read] Blob of binary data.
+      def initialize(mime_type, blob)
+        @mime_type = mime_type
+        @blob = blob
+      end
+
+      # String representation of the binary blob.
+      #
+      # @return [String] Base64-encoded URI string of the binary data.
+      def to_s
+        "data:#{@mime_type};charset=utf-8;base64,#{Base64.encode64(@blob)}"
+      end
+
+      # @see to_s
+      def to_str
+        to_s
+      end
+    end
+  end
+end

data/lib/archive/pecan/version.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module Archive
+  class Pecan
+    VERSION = '0.1.0'
+  end
+end

data/lib/archive/pecan.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'stringio'
+require 'minitar'
+
+require 'archive/pecan/attribute'
+require 'archive/pecan/blob'
+
+module Archive
+  # Deals with virtual electronic component files known as Pecan component
+  # archives.
+  #
+  # @author Nathan Campos <nathan@innoveworkshop.com>
+  class Pecan
+    MANIFEST_FILE  = 'manifest.tsv'
+    PARAM_FILE     = 'parameters.tsv'
+    IMAGE_FILE     = 'image.bmp'
+    DATASHEET_FILE = 'datasheet.pdf'
+
+    # @return [Array<Attribute>] Manifest attributes.
+    attr_accessor :attribs
+
+    # @return [Array<Attribute>] Parameter attributes.
+    attr_accessor :params
+
+    # @return [Image] Component image file blob.
+    attr_accessor :image
+
+    # @return [Blob] Binary blob of the PDF datasheet.
+    attr_accessor :datasheet
+
+    # Initializes a brand new, empty, component archive object.
+    def initialize
+      @attribs = []
+      @params = []
+      @image = nil
+      @datasheet = nil
+    end
+
+    # Reads an component archive and returns an populated object that
+    # represents it.
+    #
+    # @param path [String] Path to the component archive to be read.
+    #
+    # @return [Archive] Object representation of the component archive.
+    def self.read_archive(path)
+      archive = new
+
+      # Open the TAR archive.
+      Minitar::Input.open(File.open(path, 'rb')) do |tar|
+        # Go through entries inside the tar file.
+        tar.each do |entry|
+          # Parse each file in its own way.
+          case entry.full_name
+          when MANIFEST_FILE
+            # Manifest attributes file.
+            StringIO.new(entry.read).each_line do |line|
+              attr = Attribute.from_line(line)
+              archive.attribs << attr unless attr.nil?
+            end
+          when PARAM_FILE
+            # Parameters attributes file.
+            StringIO.new(entry.read).each_line do |line|
+              attr = Attribute.from_line(line)
+              archive.params << attr unless attr.nil?
+            end
+          when IMAGE_FILE
+            # Component image file.
+            archive.image = Blob.new('image/bmp', entry.read)
+          when DATASHEET_FILE
+            # Component datasheet file.
+            archive.datasheet = Blob.new('application/pdf', entry.read)
+          end
+        end
+      end
+
+      archive
+    end
+
+    # Dumps the contents of the object in a human-readable format.
+    def dump_contents
+      puts "Manifest: [#{@attribs.length}]"
+      @attribs.each { |attr| puts "    '#{attr.name}' = '#{attr.value}'" }
+
+      puts "Parameters: [#{@params.length}]"
+      @params.each { |attr| puts "    '#{attr.name}' = '#{attr.value}'" }
+
+      puts 'Has image' unless @image.nil?
+      puts 'Has datasheet' unless @datasheet.nil?
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: archive-pecan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Campos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+description: |
+  Deal with virtual electronic component files known as Pecan component
+  archives.
+email: nathan@innoveworkshop.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/archive/pecan.rb
+- lib/archive/pecan/attribute.rb
+- lib/archive/pecan/blob.rb
+- lib/archive/pecan/version.rb
+homepage: https://github.com/nathanpc/pecan.rb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/nathanpc/pecan.rb/issues
+  documentation_uri: https://www.rubydoc.info/gems/archive-pecan
+  homepage_uri: https://github.com/nathanpc/pecan.rb
+  source_code_uri: https://github.com/nathanpc/pecan.rb
+post_install_message: 
+rdoc_options:
+- "--title"
+- Pecan - Virtual Electronic Component Archives
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Virtual electronic component archives
+test_files: []