cartage 2.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb844544a84e06ad6bccddcc0a728f0fbc60c4b
-  data.tar.gz: ec610a1c7412e3be6f0bad168ba11bf7892f6d78
+  metadata.gz: 917038345215ec704cfda8af3112c1e0bc2c98a0
+  data.tar.gz: af1617b95d9f8e1bdfdc184a3f58402bb1459281
 SHA512:
-  metadata.gz: 4d8b293126b129ed714459adce60cb5c8d6f856f8e3b37c26f2ccb1fc011a0a161a2eef901407a100929a882fb211290d42c4e3667d20380a15c83f726af5716
-  data.tar.gz: a6ae8c8df8b6cc3612f60d3b59c0f367b033241c70a4185499f855d8fa2835c83b9b8aa330f04913f60ee797991ba58a591529fd2677c1095cc6da99e0ac9c86
+  metadata.gz: 34061d77b8635fa5bd7cf55b082d7d6f464111d61b1887ec2c08b7a36df07e86a6a0a63ab6803e5b8d722e40d045355ea41dacfea8bd9dad6dd328ae4a0408b9
+  data.tar.gz: b93a1abb24bc2e038c036231bd0f578c139603a998b2b81147466511020d0e653723453551bdac2015208f43e07af23299779fb3e99c5b9e2b2f55d6ed7322df

data/Contributing.md

@@ -51,15 +51,15 @@ Here's the most direct way to get your work merged into the project:
 
 *   Fork the project.
 *   Clone down your fork (`git clone
-    git://github.com/KineticCafe/cartage.git`).
+    git://github.com/<username>/cartage.git`).
 *   Create a topic branch to contain your change (`git checkout -b
     my_awesome_feature`).
 *   Hack away, add tests. Not necessarily in that order.
 *   Make sure everything still passes by running `rake`.
 *   If necessary, rebase your commits into logical chunks, without errors.
 *   Push the branch up (`git push origin my_awesome_feature`).
-*   Create a pull request against KineticCafe/cartage and describe
-    what your change does and the why you think it should be merged.
+*   Create a pull request against KineticCafe/cartage and describe your change
+    does and the why you think it should be merged.
 
 ### Contributors
 

data/History.md

@@ -1,3 +1,23 @@
+### 2.1 / 2017-02-18
+
+*   Cartage 2.1 now knows how to load plug-ins relative to the project root
+    path. If you have a plug-in that you aren’t ready to release as a gem, just
+    put it in your project as `<ROOT_PATH>/lib/cartage/plugins/foo.rb`; Cartage
+    will find it automatically. This feature does not work with command
+    extensions.
+
+*   The hidden command, `cartage info plugins`, will now correctly report
+    plug-in versions.
+
+*   Cartage tries to restore files that were modified by a build system prior
+    to packaging. This would fail on files that were not part of the resulting
+    tarball (because they were in .cartignore). This has been fixed.
+
+*   A new utility function, Cartage#recursive_copy has been added to
+    recursively copy directories from disk into the work path. The interaction
+    of relative and absolute directories is subtle but documented on the method
+    itself.
+
 ### 2.0 / 2016-05-31
 
 *   Rewrite! Over the last year, a number of deficiencies have been found,

data/Rakefile

@@ -14,6 +14,7 @@ Hoe.plugin :travis
 
 spec = Hoe.spec 'cartage' do
   developer('Austin Ziegler', 'aziegler@kineticcafe.com')
+  developer('Kinetic Cafe', 'dev@kineticcafe.com')
 
   self.history_file = 'History.md'
   self.readme_file = 'README.rdoc'
@@ -24,7 +25,7 @@ spec = Hoe.spec 'cartage' do
 
   extra_deps << ['gli', '~> 2.13']
 
-  extra_dev_deps << ['rake', '>= 10.0']
+  extra_dev_deps << ['rake', '>= 10.0', '< 12.0']
   extra_dev_deps << ['rdoc', '~> 4.2']
   extra_dev_deps << ['hoe-doofus', '~> 1.0']
   extra_dev_deps << ['hoe-gemspec2', '~> 1.1']

data/lib/cartage.rb

@@ -10,7 +10,7 @@ require 'cartage/config'
 ##
 # Cartage, a reliable package builder.
 class Cartage
-  VERSION = '2.0' #:nodoc:
+  VERSION = '2.1' #:nodoc:
 
   # Creates a new Cartage instance. If provided a Cartage::Config object in
   # +config+, sets the configuration and resolves it. If +config+ is not
@@ -298,6 +298,65 @@ class Cartage
     end
   end
 
+  # Recursively copy a provided +path+ to the #work_path, using a tar pipeline.
+  # The target location can be amended by the use of the +to+ parameter as a
+  # relative path to #work_path.
+  #
+  # If a relative +path+ is provided, it will be treated as relative to
+  # #root_path, and it will be used unmodified for writing to the target
+  # location. If an absolute path is provided, only the last part of the path
+  # will be used as the target name.
+  #
+  # An error will be raised if either +path+ or +to+ contains a parent-relative
+  # reference (<tt>../</tt>), or if the tar pipeline fails.
+  #
+  # === Examples
+  #
+  #   cartage.recursive_copy('public/assets')
+  #
+  # This will cause <tt><em>root_path</em>/public/assets</tt> to be copied into
+  # <tt><em>work_path</em>/public/assets</tt>.
+  #
+  #   cartage.recursive_copy('/tmp/public/assets')
+  #
+  # This will cause <tt>/tmp/public/assets</tt> to be copied into
+  # <tt><em>work_path</em>/assets</tt>.
+  #
+  #   cartage.recursive_copy('/tmp/public/assets', to: 'public')
+  #
+  # This will cause <tt>/tmp/public/assets</tt> to be copied into
+  # <tt><em>work_path</em>/public/assets</tt>.
+  def recursive_copy(path, to: nil)
+    path = Pathname(path)
+    to = Pathname(to) if to
+
+    if path.to_s =~ %r{\.\./} || (to && to.to_s =~ %r{\.\./})
+      fail StandardError, "Recursive copy parameters cannot contain '/../'"
+    end
+
+    if path.relative?
+      parent = root_path
+    else
+      parent, path = path.split
+    end
+
+    target = work_path
+    target /= to if to
+
+    tar_cf_cmd = [ 'tar', 'cf', '-', '-h', '-C', parent, path ].map(&:to_s)
+    tar_xf_cmd = [ 'tar', 'xf', '-', '-C', target ].map(&:to_s)
+
+    IO.popen(tar_cf_cmd) do |cf|
+      IO.popen(tar_xf_cmd, 'w') do |xf|
+        xf.write cf.read
+      end
+
+      fail StandardError, "Error running #{tar_xf_cmd.join(' ')}" unless $?.success?
+    end
+
+    fail StandardError, "Error running #{tar_cf_cmd.join(' ')}" unless $?.success?
+  end
+
   private
 
   attr_writer :release_hashref
@@ -305,8 +364,6 @@ class Cartage
   def resolve_config!
     fail 'No configuration' unless config
 
-    Cartage::Plugin.load_for(singleton_class)
-
     self.disable_dependency_cache = config.disable_dependency_cache
     self.quiet = config.quiet
     self.verbose = config.verbose
@@ -318,6 +375,12 @@ class Cartage
     maybe_assign :dependency_cache_path, config.dependency_cache_path
     maybe_assign :release_hashref, config.release_hashref
 
+    lib = root_path.join('lib').to_s
+    $LOAD_PATH.unshift(lib) unless $LOAD_PATH.any? { |l| l == lib }
+    Cartage::Plugin.load(rescan: true)
+
+    Cartage::Plugin.load_for(singleton_class)
+
     Cartage::Plugin.each do |name|
       next unless respond_to?(name)
       plugin = send(name) or next
@@ -400,6 +463,8 @@ class Cartage
   end
 
   def restore_modified_file(filename)
+    return unless work_path.join(filename).exist?
+
     command = [
       'git', 'show', "#{release_hashref}:#{filename}"
     ]

data/lib/cartage/commands/info.rb

@@ -48,7 +48,7 @@ that just provide commands are not reported as plugins.
           puts <<-plugins
 Active Plug-ins:
 
-#{plugs.join("\n")}
+#{plugs.sort.join("\n")}
           plugins
         end
       end

data/lib/cartage/plugin.rb

@@ -31,7 +31,7 @@ class Cartage
       # The version of the plug-in.
       def version
         if const_defined?(:VERSION, false)
-          VERSION
+          self::VERSION
         else
           Cartage::VERSION
         end
@@ -46,10 +46,13 @@ class Cartage
       # A utility method that will find all Cartage plug-ins and load them. A
       # Cartage plug-in is found in the Gems as <tt>cartage/plugins/*.rb</tt>
       # and descends from Cartage::Plugin.
-      def load #:nodoc:
+      def load(rescan: false) #:nodoc:
         @found ||= {}
         @loaded ||= {}
-        @files ||= Gem.find_files('cartage/plugins/*.rb')
+
+        if @files.nil? || rescan
+          @files = Gem.find_files('cartage/plugins/*.rb')
+        end
 
         @files.reverse_each do |path|
           name = File.basename(path, '.rb').to_sym

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cartage
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.1'
 platform: ruby
 authors:
 - Austin Ziegler
+- Kinetic Cafe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -30,42 +31,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: hoe-doofus
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +233,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
 description: |-
   Cartage provides a repeatable means to create a package for a server-side
   application that can be used in deployment with a configuration tool like
@@ -243,6 +250,7 @@ description: |-
   server(s).
 email:
 - aziegler@kineticcafe.com
+- dev@kineticcafe.com
 executables:
 - cartage
 extensions: []
@@ -310,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Cartage provides a repeatable means to create a package for a server-side