mattock 0.4.1 → 0.5.0

data/lib/mattock/configurable/field-processor.rb

@@ -0,0 +1,54 @@
+module Mattock
+  module Configurable
+    class FieldProcessor
+      def initialize(source)
+        @source = source
+        @field_names = filter(source.class.field_names)
+      end
+      attr_accessor :field_names
+      attr_reader :source
+
+      def filter_attribute
+        raise NotImplementedError
+      end
+
+      def filter(field_names)
+        field_names.find_all do |name|
+          source.class.field_metadata(name).is?(filter_attribute)
+        end
+      end
+
+      def value(field)
+        source.__send__(field.reader_method)
+      end
+
+      def to(target)
+        field_names.each do |name|
+          field = source.class.field_metadata(name)
+          next unless target.respond_to?(field.writer_method)
+          target.__send__(field.writer_method, value(field))
+        end
+      end
+    end
+
+    class SettingsCopier < FieldProcessor
+      def filter_attribute
+        :copiable
+      end
+
+      def value(field)
+        field.immediate_value_on(source)
+      end
+    end
+
+    class SettingsProxier < FieldProcessor
+      def filter_attribute
+        :proxiable
+      end
+
+      def value(field)
+        ProxyValue.new(source, field)
+      end
+    end
+  end
+end

data/lib/mattock/configurable/instance-methods.rb

@@ -0,0 +1,75 @@
+module Mattock
+  module Configurable
+    def copy_settings
+      SettingsCopier.new(self)
+    end
+
+    def copy_settings_to(other)
+      copy_settings.to(other)
+      self
+    end
+
+    def proxy_settings
+      SettingsProxier.new(self)
+    end
+
+    def proxy_settings_to(other)
+      proxy_settings.to(other)
+    end
+
+    def to_hash
+      self.class.to_hash(self)
+    end
+
+    def unset_defaults_guard
+      raise "Tried to check required settings before running setup_defaults"
+    end
+
+    #Call during initialize to set default values on settings - if you're using
+    #Configurable outside of Mattock, be sure this gets called.
+    def setup_defaults
+      def self.unset_defaults_guard
+      end
+
+      self.class.set_defaults_on(self)
+      self
+    end
+
+    #Checks that all required fields have be set, otherwise raises an error
+    #@raise RuntimeError if any required fields are unset
+    def check_required
+      unset_defaults_guard
+      missing = self.class.missing_required_fields_on(self)
+      unless missing.empty?
+        raise "Required field#{missing.length > 1 ? "s" : ""} #{missing.map{|field| field.to_s.inspect}.join(", ")} unset on #{self.inspect}"
+      end
+      self
+    end
+
+    def proxy_value
+      ProxyDecorator.new(self)
+    end
+
+    #XXX deprecate
+    def unset?(value)
+      value.nil?
+    end
+
+    def field_unset?(name)
+      self.class.field_metadata(name).unset_on?(self)
+    end
+
+    #Requires that a named field be set
+    def fail_unless_set(name)
+      if field_unset?(name)
+        raise "Assertion failed: Field #{name} unset"
+      end
+      true
+    end
+    alias fail_if_unset fail_unless_set
+
+    class Struct
+      include Configurable
+    end
+  end
+end

data/lib/mattock/configurable/proxy-value.rb

@@ -0,0 +1,30 @@
+module Mattock
+  module Configurable
+    class ProxyValue
+      def initialize(source, field)
+        @source, @field = source, field
+      end
+      attr_reader :source, :field
+
+      def inspect
+        "#{self.class.name.split(':').last}: #{source.class.name}.#{field.inspect}"
+      end
+    end
+
+    class ProxyDecorator
+      def initialize(configurable)
+        @configurable = configurable
+      end
+
+      def method_missing(name, *args, &block)
+        unless block.nil? and args.empty?
+          raise NoMethodError, "method `#{name}' not defined with arguments or block when proxied"
+        end
+        unless @configurable.respond_to?(name)
+          raise NoMethodError, "cannot proxy `#{name}' - undefined on #{@configurable}"
+        end
+        return ProxyValue.new(@configurable, @configurable.class.field_metadata(name))
+      end
+    end
+  end
+end

data/lib/mattock/remote-command-task.rb

@@ -2,18 +2,15 @@ require 'mattock/command-task'
 module Mattock
   module Rake
     class RemoteCommandTask < CommandTask
-      runtime_setting(:remote_server, nested(
-        :address => nil,
-        :user => nil
-      ))
+      setting(:remote_server, nested{
+        setting :address
+        setting :port, 22
+        setting :user, nil
+      })
+
       setting(:ssh_options, [])
+      setting(:verbose, 0)
       nil_fields(:id_file, :free_arguments)
-      runtime_setting(:remote_target)
-
-      def resolve_runtime_configuration
-        super
-        self.remote_target ||= [remote_server.user, remote_server.address].compact.join('@') unless remote_server.address.nil?
-      end
 
       def ssh_option(name, value)
         ssh_options << "\"#{name}=#{value}\""
@@ -26,12 +23,16 @@ module Mattock
         Mattock::WrappingChain.new do |cmd|
           cmd.add Mattock::CommandLine.new("ssh") do |cmd|
             cmd.options << "-i #{id_file}" if id_file
+            cmd.options << "-l #{remote_server.user}" unless remote_server.user.nil?
+            cmd.options << remote_server.address
+            cmd.options << "-p #{remote_server.port}" #ok
+            cmd.options << "-n"
+            cmd.options << "-#{'v'*verbose}" if verbose > 0
             unless ssh_options.empty?
               ssh_options.each do |opt|
                 cmd.options << "-o #{opt}"
               end
             end
-            cmd.options << remote_target
           end
           cmd.add Mattock::ShellEscaped.new(command_on_remote)
         end

data/lib/mattock/task.rb

@@ -13,6 +13,7 @@ module Mattock
     include Configurable
     include CascadingDefinition
     include DeferredDefinition
+    include Configurable::DirectoryStructure
 
     module ClassMethods
       def default_taskname(name)
@@ -35,6 +36,9 @@ module Mattock
           task.action(args)
         end
 
+        #XXX ?? Dilemma: this prevents an existing task action from being
+        #enriched with this one, but not v/v - it also doesn't prevent double
+        #-definition of this task...
         unless self === task
           raise "Task already defined for #{task.name} - attempted to redefine with #{self.name}"
         end
@@ -53,6 +57,7 @@ module Mattock
     def self.included(sub)
       sub.extend ClassMethods
       Configurable.included(sub)
+      Configurable::DirectoryStructure.included(sub)
       DeferredDefinition.add_settings(sub)
     end
 

data/lib/mattock/tasklib.rb

@@ -39,6 +39,7 @@ module Mattock
   #configuration options are built using {Configurable}
   class TaskLib < ::Rake::TaskLib
     include CascadingDefinition
+    include Configurable::DirectoryStructure
 
     attr_writer :namespace_name
 
@@ -67,8 +68,8 @@ module Mattock
     #  task after => name
     #Which ensures that if "after" is ever invoked,
     #the execution will be before, name, then after
-    def bracket_task(before, name, after)
-      task self[name] => before
+    def bracket_task(before, name, after, &block)
+      task self[name] => before, &block
       task after => self[name]
     end
 
@@ -112,6 +113,25 @@ module Mattock
       nil
     end
 
+    #Default define defines some tasks related to debugging Rakefiles -
+    #subclasses can get these just by remembering to call 'super' in their
+    #define
+    def define
+      debug_settings_task
+    end
+
+    def debug_settings_task
+      in_namespace do
+        task :debug_settings do
+          require 'pp'
+          puts self.class.name
+          pp self.to_hash
+        end
+      end
+
+      task :debug_settings => self[:debug_settings]
+    end
+
     #Wraps a single task in lib's namespace
     def [](taskname)
       in_namespace(taskname).first

data/lib/mattock/template-host.rb

@@ -14,6 +14,7 @@ module Mattock
     public :rel_dir, :default_valise
   end
 
+  #@deprecated Use {Valise::Set#templates} instead
   module TemplateHost
     attr_accessor :valise
 
@@ -44,9 +45,11 @@ module Mattock
     end
   end
 
+  #@deprecated Use {Valise::Set#templates} instead
   module TemplateTaskLib
     include TemplateHost
 
+    #@deprecated Use {Valise::Set#templates} instead
     def template_task(template_source, destination_path, template_options = nil)
       unless template_options.nil?
         valise.add_serialization_handler(template_source, :tilt, :template_options => template_options)

data/lib/mattock/testing/mock-command-line.rb

@@ -1,7 +1,7 @@
 require 'mattock/command-line'
 
 module Mattock
-  class MockCommandResult < CommandRunResult
+  class MockCommandResult < CommandLine::CommandRunResult
     def self.create(*args)
       if args.length == 1
         args = [args[0], {1 => ""}]

data/spec/command-line.rb

@@ -31,7 +31,7 @@ describe Mattock::CommandLine do
     end.to_not raise_error
   end
 
-  describe Mattock::CommandRunResult do
+  describe Mattock::CommandLine::CommandRunResult do
     let :result do
       commandline.run
     end

data/spec/command-task.rb

@@ -27,6 +27,10 @@ describe Mattock::RemoteCommandTask do
     end
   end
 
+  it "should inspect cleanly" do
+    rake["test:run"].inspect.should be_a(String)
+  end
+
   describe "when verification indicates command should proceed" do
     it "should run both commands" do
       expect_command(/should_do/, 1)

data/spec/configurable.rb

@@ -6,11 +6,16 @@ describe Mattock::Configurable do
 
     setting(:three, 3)
     required_field(:four)
+    required_field(:override)
   end
 
   class TestStruct < TestSuperStruct
     settings(:one => 1, :two => nested(:a => "a"){ required_field(:b)} )
     nil_field(:five)
+
+    def override
+      17
+    end
   end
 
   subject do
@@ -49,6 +54,11 @@ describe Mattock::Configurable do
     expect do
       subject.check_required
     end.to_not raise_error
+    subject.override.should == 17
+  end
+
+  it "should inspect cleanly" do
+    subject.inspect.should be_a(String)
   end
 
   describe "with DirectoryStructure" do
@@ -66,6 +76,10 @@ describe Mattock::Configurable do
                  )
              )
          )
+
+      dir(:next_to_me, "rainbow", dir(:in_there, "a_place", path(:nearby, "a.file")))
+
+      path(:loose_path, "here")
     end
 
     def subject
@@ -80,6 +94,10 @@ describe Mattock::Configurable do
       end.to raise_error /Required field/
     end
 
+    it "should inspect cleanly" do
+      subject.inspect.should be_a(String)
+    end
+
     describe "with root path configured, but missing a relative path" do
       def subject
         DirectoryThing.new.tap do |thing|
@@ -112,6 +130,9 @@ describe Mattock::Configurable do
         end.not_to raise_error
       end
 
+      its("nearby.absolute_path"){ should =~ %r"rainbow/a_place/a.file$"}
+      its("nearby.absolute_path"){ should =~ %r"^#{subject.absolute_path}"}
+
       its("certificate_file.absolute_path"){ should == "/tmp/bundle_workdir/aws-creds/cert.pem" }
       its("bundle_manifest.absolute_path"){ should == "/tmp/bundle_workdir/image.manifest.xml" }
       its("credentials_dir.absolute_path"){ should == "/tmp/bundle_workdir/aws-creds" }
@@ -184,7 +205,7 @@ describe Mattock::Configurable do
     end
 
     it "should not copy no_copy" do
-      left.copy_settings.to(right)
+      left.copy_settings_to(right)
       right.unset?(right.normal).should be_false
       right.normal.should == 1
       right.unset?(right.no_copy).should be_true

data/spec/template-host.rb

@@ -9,7 +9,7 @@ describe Mattock::TemplateHost do
   end
 
   it "should handle relative paths nicely" do
-    Mattock::ValiseManager.rel_dir(__FILE__, "spec").should =~ /.*spec$/
+    Mattock::ValiseManager.rel_dir(__FILE__, "spec").to_s.should =~ /.*spec$/
   end
 
   it "should be able to do easy templating" do

data/spec_help/spec_helper.rb

@@ -1,2 +1,9 @@
 require 'rspec'
 require 'file-sandbox'
+require 'cadre/rspec'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.add_formatter(Cadre::RSpec::NotifyOnCompleteFormatter)
+  config.add_formatter(Cadre::RSpec::QuickfixFormatter)
+end

metadata

@@ -1,68 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: mattock
 version: !ruby/object:Gem::Version
-  version: 0.4.1
   prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-31 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
   name: corundum
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :runtime
   name: valise
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.1
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :runtime
   name: tilt
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '0'
-        segments:
-        - 0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '0'
-        segments:
-        - 0
+    none: false
 description: ! "  If Rake won't do it by itself, you oughtta Mattock.\n\n  If you
   survived the pun, you might enjoy this gem.\n\n  Features:\n\n  * Extensions to
   Tasklibs to support powerful deerpaths.\n  * A commandline library that supports
@@ -82,6 +78,7 @@ files:
 - yard_templates/default/layout/html/setup.rb
 - yard_templates/default/layout/html/tasklib_list.erb
 - lib/mattock/command-line.rb
+- lib/mattock/command-line/command-run-result.rb
 - lib/mattock/command-task.rb
 - lib/mattock/testing/rake-example-group.rb
 - lib/mattock/testing/mock-command-line.rb
@@ -93,6 +90,12 @@ files:
 - lib/mattock/tasklib.rb
 - lib/mattock/task.rb
 - lib/mattock/configurable.rb
+- lib/mattock/configurable/field-processor.rb
+- lib/mattock/configurable/proxy-value.rb
+- lib/mattock/configurable/instance-methods.rb
+- lib/mattock/configurable/class-methods.rb
+- lib/mattock/configurable/directory-structure.rb
+- lib/mattock/configurable/field-metadata.rb
 - lib/mattock/configuration-store.rb
 - lib/mattock/cascading-definition.rb
 - lib/mattock.rb
@@ -116,24 +119,24 @@ rdoc_options:
 - --main
 - doc/README
 - --title
-- mattock-0.4.1 RDoc
+- mattock-0.5.0 RDoc
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -492969553
-required_rubygems_version: !ruby/object:Gem::Requirement
+      hash: -700278895
+      version: '0'
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: mattock
 rubygems_version: 1.8.24