palletjack 0.6.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14f3b0d5254e3fa2cf03fedf8dc389b2c40736d7
-  data.tar.gz: 7d3da40909cf135ca4f478a6859085fd561a09af
+  metadata.gz: a311c5f84cc62a899d75d2d568f1f3080708d102
+  data.tar.gz: bb4564952042bbe43374456a43b2570c8fde909a
 SHA512:
-  metadata.gz: 31c6762dabae70a3337a712b97cd03ab29b50032e07e7f80129e9dca2777bbdd1cab0a0a61b339bf01db4be4a011cd7e2db6062026105aaea879b16acc994f4d
-  data.tar.gz: cf03d5769cb6d7458db2ccf0818a9c9911129a07b35905198faf29071000a48907584060be86212daa296c720bd7ae18188540db052b2f1afd622cdd089b3b78
+  metadata.gz: 52fb77bb8e144ecefad11a4122ccf2e17783879b0bccab0075d1ffc35c3ab9b3d0ab98132132256eae2f03c941c3118b69707a28b63057fd52160353e28fe159
+  data.tar.gz: 113b72574d9fe43009d09d525a0fd02a477fa122a8ad7d5e021677612ac68dd3736d6115ea4b2d5201232991897ae0b4fcda4b4a19a59c9a04c16d95fb2b0e35

data/.rubocop.yml

@@ -2,5 +2,10 @@ inherit_from: .rubocop_todo.yml
 
 Style/IndentArray:
   EnforcedStyle: consistent
-Style/MethodName: 
-  EnforcedStyle: snake_case 
+Style/MethodName:
+  EnforcedStyle: snake_case
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/palletjack-tool_spec.rb'

data/.rubocop_todo.yml

@@ -77,7 +77,7 @@ Metrics/BlockLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 131
+  Max: 147
 
 # Offense count: 13
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
@@ -323,6 +323,7 @@ Style/GuardClause:
 Style/HashSyntax:
   Exclude:
     - 'Rakefile'
+    - 'exe/palletjack-pallet'
     - 'tools/Rakefile'
     - 'tools/exe/palletjack2pxelinux'
 

data/lib/palletjack/tool.rb

@@ -1,5 +1,6 @@
 require 'palletjack'
 require 'fileutils'
+require 'pathname'
 require 'optparse'
 require 'singleton'
 require 'rugged'
@@ -137,14 +138,18 @@ module PalletJack
                  'warehouse directory', String) {|dir|
         @options[:warehouse] = dir }
       @parser.on_tail('-h', '--help', 'display usage information') {
-        raise ArgumentError }
+        raise OptionParser::ParseError }
 
       parse_options(@parser)
 
       @parser.parse!(argv)
       @option_checks.each {|check| check.call }
-    rescue
-      abort(usage)
+    rescue OptionParser::ParseError => error
+      if error.args.empty?
+        abort(usage)
+      else
+        abort("#{error}\n\n#{usage}")
+      end
     end
 
     # Additional option parsing
@@ -188,9 +193,9 @@ module PalletJack
     #   end
 
     def required_option(*opts)
-      @option_checks << lambda do
-        raise ArgumentError unless opts.any? {|opt| options[opt]}
-      end
+      @option_checks << (lambda do
+        raise OptionParser::ParseError unless opts.any? {|opt| options[opt]}
+      end)
     end
 
     # Require the presence of no more than one of the given options.
@@ -208,9 +213,9 @@ module PalletJack
     #   end
 
     def exclusive_options(*opts)
-      @option_checks << lambda do
-        raise ArgumentError if opts.count {|opt| options[opt]} > 1
-      end
+      @option_checks << (lambda do
+        raise OptionParser::ParseError if opts.count {|opt| options[opt]} > 1
+      end)
     end
 
     # Usage information from option parser
@@ -255,9 +260,7 @@ module PalletJack
     # Build a filesystem path from path components
     #
     # Symbols are looked up in the options dictionary.
-    # All other types are converted to strings. The
-    # resulting list is fed to File#join to produce a
-    # local filesystem compliant path.
+    # All components are converted to Pathname and concatenated.
     #
     # Example:
     #   parser.on(...) {|dir| options[:output] = dir }
@@ -266,14 +269,16 @@ module PalletJack
     #   config_path :output, 'subdir2'
 
     def config_path(*path)
-      File.join(path.map {|item|
-                  case item
-                  when Symbol
-                    options.fetch(item)
-                  else
-                    item.to_s
-                  end
-                })
+      path.map { |item|
+        case item
+        when Pathname
+          item
+        when Symbol
+          Pathname.new(options.fetch(item))
+        else
+          Pathname.new(item.to_s)
+        end
+      }.reduce(&:+)
     end
 
     # :call-seq:
@@ -300,8 +305,12 @@ module PalletJack
     # config_file :option, 'fragment', 'base.ext' {|file| ... }
     # config_file ..., mode:0600 {|file| ...}
     #
-    # Creates a configuration file, with default mode:0644
-    # and calls the given block with the file as argument.
+    # Creates a temporary configuration file with an undefined name,
+    # with default mode:0644, and calls the given block with the file
+    # as argument. After the block has run, the file is atomically
+    # renamed to the given destination file name. If any errors occur,
+    # the temporary file is deleted without overwriting the
+    # destination file.
     #
     # Uses config_path to construct the path, so any symbols will
     # be looked up in the options hash.
@@ -315,9 +324,25 @@ module PalletJack
     #   end
 
     def config_file(*path, mode: 0644, &block)
-      File.open(config_path(*path),
-                File::CREAT | File::TRUNC | File::WRONLY, mode) do |file|
-        block.call(file)
+      filename = config_path(*path)
+      begin
+        temp_filename = "#{filename}.tmp.#{Process.pid}.#{rand(1_000_000)}"
+        temp_file = File.new(temp_filename,
+                             File::CREAT | File::EXCL | File::RDWR)
+      rescue Errno::EEXIST
+        retry
+      end
+
+      begin
+        temp_file.flock(File::LOCK_EX)
+        block.call(temp_file)
+        temp_file.flush
+        File.rename(temp_filename, filename)
+      rescue
+        File.unlink(temp_filename) rescue nil
+        raise
+      ensure
+        temp_file.close
       end
     end
 
@@ -337,29 +362,41 @@ module PalletJack
       config_dir :warehouse, kind, name
     end
 
-    # Write a key box file inside a pallet
+    # :call-seq:
+    # pallet_box kind, name, box, 'key.path' => value, ...
+    # pallet_box kind, name, box { { key: { path: value, ... } } }
+    #
+    # Write keys to a box file inside a pallet
+    #
+    # Any key.path assignments given as parameters, and the hash value
+    # returned from a block will be merged into the named box file.
     #
-    # The block should return a hash representing the contents of the box.
     # All keys will be stringified, so we can use key: short forms for
     # declaration of the box contents.
     #
     # Uses config_file to create the file, so any symbols will
-    # be looked up in the options hash.
-    #
-    # N.B! If the box already exists, it will be overwritten!
-    #--
-    # FIXME: should new values be merged with existing box data instead?
-    #++
+    # be looked up in the options hash, except for the box name.
     #
     # Example:
     #
     #   pallet_box 'domain', :domain, 'dns' do
     #     { dns:{ ns:options[:soa_ns].split(',') } }
     #   end
+    #--
+    # FIXME: Box I/O should probably be managed by PalletJack::Pallet,
+    #        but that requires some redesign work.
+    #++
+
+    def pallet_box(kind, name, box, keyvalues = {}, &block)
+      box_path = config_path(:warehouse, kind, name, "#{box}.yaml")
+      contents = KVDAG::KeyPathHashProxy.new
+
+      contents.merge! YAML::load_file(box_path) if box_path.file?
+      keyvalues.each { |key, value| contents[key] = value }
+      contents.merge! block.call if block_given?
 
-    def pallet_box(kind, name, box, &block)
-      config_file :warehouse, kind, name, "#{box}.yaml" do |box_file|
-        box_file << block.call.deep_stringify_keys.to_yaml
+      config_file box_path do |box_file|
+        box_file << contents.deep_stringify_keys.to_yaml
       end
     end
 
@@ -378,7 +415,8 @@ module PalletJack
 
     def pallet_links(kind, name, links = {})
       links.each do |link_type, parent|
-        link_path = config_path(:warehouse, kind, name, link_type)
+        link_base = config_path(:warehouse, kind, name)
+        link_path = config_path(link_base, link_type)
 
         begin
           File.delete(link_path)
@@ -387,9 +425,9 @@ module PalletJack
         end
         unless parent.empty?
           parent_kind, parent_name = parent
-          parent_path = config_path('..', '..', parent_kind, parent_name)
+          parent_path = config_path(:warehouse, parent_kind, parent_name)
 
-          File.symlink(parent_path, link_path)
+          File.symlink(parent_path.relative_path_from(link_base), link_path)
         end
       end
     end

data/lib/palletjack/version.rb

@@ -1,3 +1,3 @@
 module PalletJack
-  VERSION = '0.6.2'
+  VERSION = '0.6.5'
 end

data/palletjack.gemspec

@@ -1,5 +1,6 @@
 #-*- ruby -*-
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'palletjack/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: palletjack
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.5
 platform: ruby
 authors:
 - Calle Englund
@@ -31,7 +31,7 @@ cert_chain:
   f8wtQllq82VF0AXUYeLtTh1f+DW3WW5BO1e2OCu5eOV7dbyaVPaNK/+rHjCN8kM/
   DGZSwUoNADmVkQ==
   -----END CERTIFICATE-----
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport