palletjack 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92cd24bafb3571920c17d5169cfb443d5ecf802
-  data.tar.gz: 0ced78f0c35522bacd9731c8e49de89f1a94e95f
+  metadata.gz: ad0c8785d6c2e0df5f352e67ea82abad9ee6803b
+  data.tar.gz: ce7296d715491c9a78e139b7578552b505e21c1d
 SHA512:
-  metadata.gz: d263c08676ea7b3fb2ca09392e52397ca8398a7ddba90f478da4dad4c733e6874f29538ac46dc48630f6a743614b385ab87e131d7fac8dd191ce9d9486eba04c
-  data.tar.gz: a999088ef12bbd9ec420745b36c9e02ded2a9f91e3b34885e8445d0dd4bd4e9d60ea0051dfccc880ccfeeca4cb9f5554a0357dca88e06bd8eada146b5a188f6b
+  metadata.gz: ca68935c9d97734d28b139629873774eeaca5d8f06bb468047c0a16a09c5c51f4983b04cfbabce97517c9fb259739830782acea3e93b6334cc4400392b19274f
+  data.tar.gz: 6963849234c18071bdece0e5f5fd37fcf9edf8984775f69ec71084e994bbdf297959d2a1511e6c12dcc3e80a4a84c06c77efc4b5a52c3c2519d84d5fed5945ab

data/README.md

@@ -241,3 +241,11 @@ We are happy to accept contributions in the form of issues and pull requests on
     - If your code needs larger chunks of static data to work, please provide it in a separate directory under `examples/`. See e.g. [the `examples/pxelinux/` tree](https://github.com/saab-simc-admin/palletjack/tree/master/examples/pxelinux), which contains files required to make sense of the output from `palletjack2pxelinux`.
 
   - Write your commit messages in the usual Git style: a short summary in the first line, then paragraphs of explanatory text, line wrapped.
+
+- Test your code.
+
+  - Tests shall be written in [RSpec](http://rspec.info/).
+
+  - Library code shall have unit tests.
+
+  - Tools shall have integration and end-to-end tests.

data/lib/palletjack.rb

@@ -6,10 +6,12 @@ require 'palletjack/keytransformer'
 require 'palletjack/pallet'
 
 class PalletJack < KVDAG
-  attr_reader :pallets
+  attr_reader :warehouse
   attr_reader :keytrans_reader
   attr_reader :keytrans_writer
 
+  # Create and load a PalletJack warehouse, and all its pallets
+
   def self.load(warehouse)
     new.load(warehouse)
   end
@@ -19,6 +21,8 @@ class PalletJack < KVDAG
     @pallets = Hash.new
   end
 
+  # Load a PalletJack warehouse, and all its pallets
+
   def load(warehouse)
     @warehouse = File.expand_path(warehouse)
     key_transforms = YAML::load_file(File.join(@warehouse, "transforms.yaml"))
@@ -32,12 +36,26 @@ class PalletJack < KVDAG
       Dir.foreach(kindpath) do |pallet|
         palletpath = File.join(kindpath, pallet)
         next unless File.directory?(palletpath) and pallet !~ /^\.{1,2}$/
-        Pallet.new(self, palletpath)
+        pallet(kind, pallet)
       end
     end
     self
   end
 
+  # Return a named pallet from the warehouse
+  #
+  # If the pallet is not yet loaded, it will be.
+  #
+  # Raises RuntimeError if the warehouse is not loaded.
+  # Raises Errno::ENOENT if the pallet can't be loaded.
+
+  def pallet(kind, name)
+    raise "warehouse is not loaded" unless @warehouse
+
+    identity = Pallet::Identity.new(self, File.join(kind, name))
+    @pallets[identity.path] ||= Pallet.load(self, identity)
+  end
+
   # Search for pallets in a PalletJack warehouse
   #
   # The search is filtered by KVDAG::Vertex#match? expressions.
@@ -64,7 +82,7 @@ class PalletJack < KVDAG
     result = self[filter]
 
     if result.length != 1
-      raise KeyError.new("#{options} matched #{result.length} pallets")
+      raise KeyError.new("#{filter} matched #{result.length} pallets")
     end
     result.first
   end

data/lib/palletjack/pallet.rb

@@ -1,52 +1,39 @@
-class PalletJack
+require 'palletjack/pallet/identity'
+
+class PalletJack < KVDAG
   # PalletJack managed pallet of key boxes inside a warehouse.
   class Pallet < KVDAG::Vertex
 
-    attr_reader :name
-    attr_reader :kind
-
-    # N.B: A pallet should never be created manually; use
-    # +PalletJack::new+ to initialize a complete warehouse.
+    # N.B: A pallet should never be loaded manually; use
+    # +PalletJack.load+ to initialize a complete warehouse.
     #
     # [+jack+] PalletJack that will manage this pallet.
-    # [+path+] Filesystem path to pallet data.
+    # [+identity+] Identity of the pallet to be loaded.
     #
-    # Create PalletJack managed singletonish pallet.
-    #
-    # Use relative path inside of warehouse as kind/name for this
-    # pallet, and make a singletonish object for that key.
-
-    def Pallet.new(jack, path) #:doc:
-      ppath, name = File.split(path)
-      _, kind = File.split(ppath)
+    # Creates and loads a new PalletJack warehouse pallet.
 
-      jack.pallets[kind] ||= Hash.new
-      jack.pallets[kind][name] || super
+    def self.load(jack, identity)
+      new(jack).load(identity)
     end
 
-    # N.B: A pallet should never be created manually; use
-    # +PalletJack::new+ to initialize a complete warehouse.
+    # N.B: A pallet should never be loaded manually; use
+    # +PalletJack::load+ to initialize a complete warehouse.
     #
-    # [+jack+] PalletJack that will manage this pallet.
-    # [+path+] Filesystem path to pallet data.
+    # [+identity+] Identity of the pallet to be loaded.
     #
     # Loads and merges all YAML files in +path+ into this Vertex.
     #
     # Follows all symlinks in +path+ and creates edges towards
     # the pallet located in the symlink target.
 
-    private :initialize
-    def initialize(jack, path) #:notnew:
-      @jack = jack
-      @path = path
-      ppath, @name = File.split(path)
-      _, @kind = File.split(ppath)
+    def load(identity)
+      @identity = identity
       boxes = Array.new
-
-      super(jack, pallet:{@kind => @name})
+      path = @identity.path
 
       Dir.foreach(path) do |file|
-        next if file[0] == '.'
+        next if file[0] == '.' # skip dot.files
+
         filepath = File.join(path, file)
         filestat = File.lstat(filepath)
         case
@@ -55,15 +42,19 @@ class PalletJack
           boxes << file
         when filestat.symlink?
           link = File.readlink(filepath)
-          _, lname = File.split(link)
+          link_id = Identity.new(jack, File.expand_path(link, path))
 
-          pallet = Pallet.new(jack, File.absolute_path(link, path))
-          edge(pallet, pallet:{references:{file => lname}})
+          pallet = jack.pallet(link_id.kind, link_id.full_name)
+          edge(pallet, pallet:{references:{file => link_id.full_name}})
+        when filestat.directory?
+          child = jack.pallet(kind, File.join(name, file))
+          child.edge(self, pallet:{references:{_parent: name}})
         end
       end
-      merge!(pallet:{boxes: boxes})
-      @jack.keytrans_writer.transform!(self)
-      @jack.pallets[@kind][@name] = self
+      merge!(pallet:{kind => name, boxes: boxes})
+      jack.keytrans_writer.transform!(self)
+
+      self
     end
 
     def inspect
@@ -73,8 +64,42 @@ class PalletJack
     # Override standard to_yaml serialization, because pallet objects
     # are ephemeral by nature. The natural serialization is that of
     # their to_hash analogue.
+
     def to_yaml
       to_hash.to_yaml
     end
+
+    # The kind of this pallet
+
+    def kind
+      @identity.kind
+    end
+
+    # The leaf name of this pallet in its hierarchy
+
+    def leaf_name
+      @identity.leaf_name
+    end
+
+    # Compatibility alias name is the leaf name
+
+    alias name leaf_name
+
+    # The full hierarchical name of this pallet
+
+    def full_name
+      @identity.full_name
+    end
+
+    # The full name of the hierarchical parent for this pallet,
+    # or nil if there is no parent.
+
+    def parent_name
+      @identity.parent_name
+    end
+
+    private
+
+    alias :jack :dag
   end
 end

data/lib/palletjack/pallet/identity.rb

@@ -0,0 +1,65 @@
+class PalletJack < KVDAG
+  class Pallet < KVDAG::Vertex
+
+    # Represents the identity aspects of a warehouse pallet
+
+    class Identity
+      include Comparable
+
+      # Full expanded path to this pallet
+      attr_reader :path
+
+      # Base path of the warehouse for this pallet
+      attr_reader :warehouse
+
+      # The kind of this pallet
+      attr_reader :kind
+
+      # The full name of the hierarchical parent for this pallet,
+      # or nil if there is no parent.
+      attr_reader :parent_name
+
+      # The full hierarchical name for this pallet
+      attr_reader :full_name
+
+      # The leaf name for this pallet in its hierarchy
+      attr_reader :leaf_name
+
+      # Initialize identity aspects for a Pallet from components of its
+      # +path+ within the +jack.warehouse+
+
+      def initialize(jack, path)
+        @warehouse = jack.warehouse
+        @path = path = File.expand_path(path, @warehouse)
+
+        path_components = []
+        while path > @warehouse do
+          path, part = File.split(path)
+          path_components = [part, *path_components]
+        end
+
+        @kind, *path_components = path_components
+        @full_name = File.join(*path_components)
+        @leaf_name = path_components.last
+        *path_components, _ = path_components
+        @parent_name = File.join(*path_components) unless path_components.empty?
+      end
+
+      # Comparability uses the full path of the pallet
+
+      def <=>(other)
+        path <=> other.path
+      end
+
+      # Hashing uses the full path of the pallet for uniqueness
+
+      def hash
+        path.hash
+      end
+
+      # eql? must be overridden for Hash comparisons to work as expected
+
+      alias eql? ==
+    end
+  end
+end

data/lib/palletjack/tool.rb

@@ -49,8 +49,6 @@ class PalletJack
   class Tool
     include Singleton
 
-    # v0.1.1 API:
-    #
     # :call-seq:
     # run
     #
@@ -67,34 +65,10 @@ class PalletJack
     #     MyTool.run
     #   end
 
-    # v0.1.0 API, retained until all tools have been updated to
-    # v0.1.1:
-    #
-    # :call-seq:
-    # run &block
-    #
-    # Run the +block+ given in the context of the tool singleton instance
-    # as convenience for simple tools.
-    #
-    # More complex tools probably want to override parse_options to
-    # add option parsing, and split functionality into multiple methods.
-    #
-    # Example:
-    #
-    #   MyTool.run { jack.each(kind:'system') {|sys| puts sys.to_yaml } }
-
     def self.run(&block)
-      if block
-        # v0.1.0 API. When all tools have been ported, remove this and
-        # bump the minor version number.
-        instance.setup
-        instance.instance_eval(&block)
-      else
-        # v0.1.1 API
-        instance.setup
-        instance.process
-        instance.output
-      end
+      instance.setup
+      instance.process
+      instance.output
     end
 
     # Predicate for detecting if we are being invoked as a standalone

data/lib/palletjack/version.rb

@@ -1,5 +1,5 @@
 require 'kvdag'
 
 class PalletJack < KVDAG
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/palletjack.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_structure_matcher", "~> 0.0.6"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1.1.2"
 
   spec.has_rdoc	= true
 end

metadata

@@ -1,14 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: palletjack
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
-cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRYwFAYDVQQDDA1jYWxs
+  ZS5lbmdsdW5kMRkwFwYKCZImiZPyLGQBGRYJc2FhYmdyb3VwMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMB4XDTE2MTEwMjA5MjYyN1oXDTE3MTEwMjA5MjYyN1owSDEWMBQG
+  A1UEAwwNY2FsbGUuZW5nbHVuZDEZMBcGCgmSJomT8ixkARkWCXNhYWJncm91cDET
+  MBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBAM7OxaztzD0LyOwK1mPcg3BhioX1EDVbD/qAFOAzBSGGlAhtmHMqAkyvJMvs
+  iiG7xvBidWUapxiEiBwamXiOTSrp2eW+XSXW9omdWHXjBZcwHqwb1VmAlYRDkSHf
+  dzcM/z4xlV+DJw/pFyMRWzqNdVBtWTbVXAFGjJSqQ6q21ACYJldV9U71AIpXo+oF
+  VEMf6PZS2uhB1G+FgAtnX/xmy7OM1Cy3qc/CaJbWSddpegxWJMUn2HNQxFwIe40g
+  WoEoiFA7qQg9DnR/5i3lW6QyfIaA5k9cv2su1VyjqKLbkFTTTjYw0P1BJmvfXjtc
+  rMl+3HCWYj6UunZwfZi2wDGsBkkCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQUwHCMEKgrIMaiTkTVLKZn6yOD1SIwJgYDVR0RBB8w
+  HYEbY2FsbGUuZW5nbHVuZEBzYWFiZ3JvdXAuY29tMCYGA1UdEgQfMB2BG2NhbGxl
+  LmVuZ2x1bmRAc2FhYmdyb3VwLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAP9OnE0jP
+  2vRHI/vnOkgCvLFNoOqK/YB4yDVVW69Pza+xIXcmUBvl7DQ+bBdF5AK0B1A7U0rp
+  Pbdj0bpQtWxmUmMIbnE1w6iuVCXAabsyUfHY4mlztToWXMVOXc1SPlJ/S2XXaRd5
+  fiNj/nBTb0YTQA0E4pZ0Aud80qZ2WLdc6FfzHUEMW91BL3bhLeDL40noHK5Lvk52
+  phzVHIrDjCowUMTnGiPZCXEo4KZW76KwYYV6oQ6LzcrYBw5mJ4XpdgQKZgnTnRBP
+  f8wtQllq82VF0AXUYeLtTh1f+DW3WW5BO1e2OCu5eOV7dbyaVPaNK/+rHjCN8kM/
+  DGZSwUoNADmVkQ==
+  -----END CERTIFICATE-----
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +117,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_structure_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 description: Lightweight Configuration Management Database
 email:
 - calle.englund@saabgroup.com
@@ -111,6 +162,7 @@ files:
 - lib/palletjack.rb
 - lib/palletjack/keytransformer.rb
 - lib/palletjack/pallet.rb
+- lib/palletjack/pallet/identity.rb
 - lib/palletjack/tool.rb
 - lib/palletjack/version.rb
 - palletjack.gemspec
@@ -134,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Lightweight Configuration Management Database