ing 0.1.1 → 0.1.2

data/README.md

@@ -3,7 +3,7 @@
 
 or gratuitous backronym: <b>I</b> <b>N</b>eed a <b>G</b>enerator! 
 
-Note this is a work-in-progress, not quite ready for use.
+(Note this is a work-in-progress. Expect some quirkiness.)
 
 The command-line syntax is similar to Thor's, and it incorporates Thor's 
 (Rails') generator methods and shell conventions like
@@ -22,8 +22,6 @@ Option parsing courtesy of the venerable and excellent
 
 ## Installation
 
-_Note: not yet gemified_
-
     gem install ing
     
 ## A quick tour

data/ing.gemspec

@@ -25,5 +25,7 @@ rest.
   
   s.requirements << "ruby >= 1.9"
     
+  s.add_development_dependency 'minitest'
   s.add_development_dependency 'fakeweb'
+  
 end

data/lib/ing.rb

@@ -4,8 +4,9 @@
  'ing/util',
  'ing/dispatcher',
  'ing/shell',
+ 'ing/common_options',
+ 'ing/boot',
  'ing/files',
- 'ing/commands/boot',
  'ing/commands/implicit',
  'ing/commands/list',
  'ing/commands/help',

data/lib/ing/boot.rb

@@ -0,0 +1,53 @@
+# Base implementation of boot dispatch
+# Mixed in to Commands::Implicit, Commands::Generate
+# Note this does NOT provide any options, only provides implementation.
+# Assumes target class will provide +namespace+ option, otherwise defaults to
+# global namespace (::Object).
+#
+module Ing
+  module Boot
+
+    # Configure the command prior to dispatch.
+    # Default behavior is to set the shell of the dispatched command.
+    # Override in target class as needed; if you want to keep the default 
+    # behavior then call +super+.
+    def configure_command(cmd)
+      cmd.shell = Ing.shell_class.new if cmd.respond_to?(:"shell=")
+    end
+    
+    # Main processing of arguments and dispatch from command line (+Ing.run+)
+    # Note that three hooks are provided for target classes, 
+    #   +before+::  runs before any processing of arguments or dispatch of command
+    #   +configure_command+::   configures the command prior to dispatch
+    #   +after+::   runs after command dispatched
+    #
+    def call(*args)
+      before *args if respond_to?(:before)
+      ns         = Ing::Util.to_class_names(options[:namespace] || 'object')
+      classes    = Ing::Util.to_class_names(args.shift)
+      Dispatcher.new(ns, classes, *args).dispatch do |cmd|
+        configure_command cmd
+      end
+      after if respond_to?(:after)
+    end    
+    
+    # Dispatch from +Ing.invoke+
+    def call_invoke(klass, meth, *args)
+      before *args if respond_to?(:before)
+      Dispatcher.invoke(klass, meth, *args) do |cmd|
+        configure_command cmd
+      end
+      after if respond_to?(:after)
+    end
+    
+    # Dispatch from +Ing.execute+
+    def call_execute(klass, meth, *args)
+      before *args if respond_to?(:before)
+      Dispatcher.execute(klass, meth, *args) do |cmd|
+        configure_command cmd
+      end
+      after if respond_to?(:after)
+    end
+        
+  end
+end

data/lib/ing/commands/generate.rb

@@ -3,7 +3,7 @@ module Ing
   module Commands
   
     # This is the boot command invoked from `ing generate ...`
-    class Generate < Boot
+    class Generate
 
       DEFAULTS = {
          namespace: 'object',
@@ -13,25 +13,25 @@ module Ing
     
       def self.specify_options(parser)
         parser.text "Run a generator task"
-        parser.opt :debug, "Display debug messages"
-        parser.opt :namespace, "Top-level namespace for generators",
-                   :type => :string, :default => DEFAULTS[:namespace]
         parser.opt :gen_root, "Generators root directory", 
                    :type => :string, :short => 'r', 
                    :default => DEFAULTS[:gen_root]
-        parser.opt :ing_file, "Default generator file (ruby)", 
-                   :type => :string, :short => 'f', 
-                   :default => DEFAULTS[:ing_file]
         parser.stop_on_unknown
       end
 
+      include Ing::Boot
+      include Ing::CommonOptions
+      
       def generator_root
         @generator_root ||= File.expand_path(options[:gen_root])
       end
       
-      # Locate and require the generator ruby file identified by the first arg,
+      # Require libs and ing_file, then
+      # locate and require the generator ruby file identified by the first arg,
       # before dispatching to it.
       def before(*args)
+        require_libs
+        require_ing_file      
         require_generator args.first
       end
       

data/lib/ing/commands/help.rb

@@ -14,17 +14,10 @@
         parser.text "  ing help generate               # help on built-in command generate"
         parser.text "  ing help --namespace test unit  # help on command within namespace"
         parser.text "  ing help                        # display this message"
-        parser.text "\nOptions:"
-        parser.opt :debug, "Display debug messages"
-        parser.opt :namespace, "Top-level namespace",
-                   :type => :string, :default => DEFAULTS[:namespace]   
-        parser.opt :require, "Require file or library before running (multi)", 
-                   :multi => true, :type => :string
-        parser.opt :ing_file, "Default task file (ruby)", 
-                   :type => :string, :short => 'f', 
-                   :default => DEFAULTS[:ing_file]
       end
       
+      include Ing::CommonOptions
+      
       attr_accessor :options 
       attr_writer :shell
       
@@ -34,51 +27,23 @@
       
       def initialize(options)
         self.options = options
-        debug "#{__FILE__}:#{__LINE__} :: options #{options.inspect}"
       end
       
       # Require each passed file or library before running
       # and require the ing file if it exists
-      def before(*args)
-        require_libs options[:require]
+      def before
+        require_libs
         require_ing_file
       end
     
       def call(cmd="help")
-        before(cmd)
+        before
         ns        = Ing::Util.to_class_names(options[:namespace] || 'object')
         cs        = Ing::Util.to_class_names(cmd)
         help = Dispatcher.new(ns, cs).help
         shell.say help.read
       end
       
-      private
-            
-      # require relative paths relative to the Dir.pwd
-      # otherwise, require as given (so gems can be required, etc.)
-      def require_libs(libs)
-        libs = Array(libs)
-        libs.each do |lib| 
-          f = if /\A\.{1,2}\// =~ lib
-              File.expand_path(lib)
-            else
-              lib
-            end
-          debug "#{__FILE__}:#{__LINE__} :: require #{f.inspect}"
-          require f
-        end
-      end
-
-      def require_ing_file
-        f = File.expand_path(options[:ing_file])
-        require_libs(f) if File.exists?(f)
-      end
-            
-      # Internal debugging
-      def debug(*args)
-        shell.debug(*args) if options[:debug]
-      end
-      
     end
     
     H = Help

data/lib/ing/commands/implicit.rb

@@ -4,7 +4,7 @@ module Ing
   
     # This is the default boot command when ARGV.first not recognized as
     # a built-in Ing command. For example, `ing some:task run` .
-    class Implicit < Boot
+    class Implicit
     
       DEFAULTS = {
          namespace: 'object',
@@ -13,46 +13,24 @@ module Ing
       
       def self.specify_options(parser)
         parser.text "(internal)"
-        parser.opt :debug, "Display debug messages"
-        parser.opt :namespace, "Top-level namespace for generators",
-                   :type => :string, :default => DEFAULTS[:namespace]
-        parser.opt :require, "Require file or library before running (multi)", 
-                   :multi => true, :type => :string
-        parser.opt :ing_file, "Default generator file (ruby)", 
-                   :type => :string, :short => 'f', 
-                   :default => DEFAULTS[:ing_file]
         parser.stop_on_unknown
       end
       
+      include Ing::Boot
+      include Ing::CommonOptions
+      
+      attr_accessor :options
+      def initialize(options)
+        self.options = options
+      end
+         
       # Require each passed file or library before running
       # and require the ing file if it exists
       def before(*args)
-        require_libs options[:require]
+        require_libs
         require_ing_file
       end
       
-      private
-            
-      # require relative paths relative to the Dir.pwd
-      # otherwise, require as given (so gems can be required, etc.)
-      def require_libs(libs)
-        libs = Array(libs)
-        libs.each do |lib| 
-          f = if /\A\.{1,2}\// =~ lib
-              File.expand_path(lib)
-            else
-              lib
-            end
-          debug "#{__FILE__}:#{__LINE__} :: require #{f.inspect}"
-          require f
-        end
-      end
-
-      def require_ing_file
-        f = File.expand_path(options[:ing_file])
-        require_libs(f) if File.exists?(f)
-      end
-      
     end
 
   end

data/lib/ing/commands/list.rb

@@ -14,17 +14,10 @@
         parser.text "  ing list        # list all built-in ing commands"
         parser.text "  ing list rspec  # list all ing commands in rspec namespace, or"
         parser.text "  ing list --namespace rspec"
-        parser.text "\nOptions:"
-        parser.opt :debug, "Display debug messages"
-        parser.opt :namespace, "Top-level namespace",
-                   :type => :string, :default => DEFAULTS[:namespace]   
-        parser.opt :require, "Require file or library before running (multi)", 
-                   :multi => true, :type => :string
-        parser.opt :ing_file, "Default task file (ruby)", 
-                   :type => :string, :short => 'f', 
-                   :default => DEFAULTS[:ing_file]
       end
       
+      include Ing::CommonOptions
+      
       attr_accessor :options 
       attr_writer :shell
       
@@ -34,19 +27,17 @@
       
       def initialize(options)
         self.options = options
-        debug "#{__FILE__}:#{__LINE__} :: options #{options.inspect}"
       end
       
       # Require each passed file or library before running
       # and require the ing file if it exists
-      def before(*args)
-        require_libs options[:require]
+      def before
+        require_libs
         require_ing_file
       end
-
       
       def call(namespace=options[:namespace])
-        before(namespace)
+        before
         ns        = Ing::Util.to_class_names(namespace)
         mod       = Ing::Util.namespaced_const_get(ns)
         data = mod.constants.map do |c|
@@ -59,27 +50,7 @@
       end
       
       private 
-            
-      # require relative paths relative to the Dir.pwd
-      # otherwise, require as given (so gems can be required, etc.)
-      def require_libs(libs)
-        libs = Array(libs)
-        libs.each do |lib| 
-          f = if /\A\.{1,2}\// =~ lib
-              File.expand_path(lib)
-            else
-              lib
-            end
-          debug "#{__FILE__}:#{__LINE__} :: require #{f.inspect}"
-          require f
-        end
-      end
-
-      def require_ing_file
-        f = File.expand_path(options[:ing_file])
-        require_libs(f) if File.exists?(f)
-      end
-      
+                  
       def desc_lines(ns, data)
         colwidths = data.inject([0,0]) {|max, (line, desc)| 
           max[0] = line.length if line.length > max[0]
@@ -95,11 +66,6 @@
           ].join(" # ")
         }
       end
-
-      # Internal debugging
-      def debug(*args)
-        shell.debug(*args) if options[:debug]
-      end
       
     end
    

data/lib/ing/common_options.rb

@@ -0,0 +1,65 @@
+# Common options for built-in Ing commands
+module Ing
+  module CommonOptions
+ 
+    # a bit of trickiness to change a singleton method...
+    def self.included(base)
+      meth = base.method(:specify_options) if base.respond_to?(:specify_options)
+      base.send(:define_singleton_method, :specify_options) do |expect|
+        meth.call(expect) if meth
+        expect.text "\nCommon Options:"
+        expect.opt :debug, "Display debug messages"        
+        expect.opt :namespace, "Top-level namespace",
+                   :type => :string, :default => base::DEFAULTS[:namespace]
+        expect.opt :require, "Require file or library before running (multi)", 
+                   :multi => true, :type => :string
+        expect.opt :ing_file, "Default task file (ruby)", 
+                   :type => :string, :short => 'f', 
+                   :default => base::DEFAULTS[:ing_file]
+      end
+    end
+    
+    def debug?
+      !!options[:debug]
+    end
+    
+    def requires
+      options[:require]
+    end
+    
+    def ing_file
+      options[:ing_file]
+    end
+    
+    def namespace
+      options[:namespace]
+    end
+    
+    # require relative paths relative to the Dir.pwd
+    # otherwise, require as given (so gems can be required, etc.)
+    def require_libs(libs=requires)
+      libs = Array(libs)
+      libs.each do |lib| 
+        f = if /\A\.{1,2}\// =~ lib
+            File.expand_path(lib)
+          else
+            lib
+          end
+        require f
+      end
+    end
+
+    def require_ing_file
+      f = File.expand_path(ing_file)
+      require_libs(f) if f && File.exists?(f)
+    end
+
+    # Internal debugging
+    def debug(*msgs)
+      if debug?
+        msgs.each do |msg| $stderr.puts "DEBUG :: #{msg}" end
+      end
+    end
+    
+  end
+end

data/lib/ing/version.rb

@@ -1,3 +1,3 @@
 module Ing
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/suite.rb

@@ -0,0 +1,6 @@
+Dir[ File.expand_path('{actions,acceptance}/*.rb',
+                      File.dirname(__FILE__))
+   ].each do |f| 
+    puts "Loading tests: #{f.gsub(Dir.pwd,'.')}"
+    require f 
+  end

data/todo.yml

@@ -3,5 +3,4 @@
 - add Shell::Color
 - remove global Ing.shell_class, specify via color switch
 - incorporate gsub_file patch, patches to Shell
-- refactor common functionality out of built-in commands 
 - add a generator base class for the common use-case

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,9 +11,20 @@ bindir: bin
 cert_chain: []
 date: 2012-09-16 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &17352160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *17352160
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &12266780 !ruby/object:Gem::Requirement
+  requirement: &17351600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12266780
+  version_requirements: *17351600
 description: ! "\nAn alternative to Rake and Thor, Ing has a command-line syntax similar
   to \nThor's, and it incorporates Thor's (Rails') generator methods and shell \nconventions.
   But unlike Thor or Rake, it does not define its own DSL. Your tasks\ncorrespond
@@ -51,11 +62,12 @@ files:
 - lib/ing/actions/empty_directory.rb
 - lib/ing/actions/file_manipulation.rb
 - lib/ing/actions/inject_into_file.rb
-- lib/ing/commands/boot.rb
+- lib/ing/boot.rb
 - lib/ing/commands/generate.rb
 - lib/ing/commands/help.rb
 - lib/ing/commands/implicit.rb
 - lib/ing/commands/list.rb
+- lib/ing/common_options.rb
 - lib/ing/dispatcher.rb
 - lib/ing/files.rb
 - lib/ing/lib_trollop.rb
@@ -90,6 +102,7 @@ files:
 - test/fixtures/task.ing.rb
 - test/fixtures/task.thor
 - test/spec_helper.rb
+- test/suite.rb
 - test/test_helper.rb
 - todo.yml
 homepage: https://github.com/ericgj/ing
@@ -143,5 +156,6 @@ test_files:
 - test/fixtures/task.ing.rb
 - test/fixtures/task.thor
 - test/spec_helper.rb
+- test/suite.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/ing/commands/boot.rb

@@ -1,76 +0,0 @@
-# Base class
-
-module Ing
-  module Commands
-    class Boot
-    
-      attr_accessor :options 
-      attr_writer :shell
-      
-      def shell
-        @shell ||= ::Ing.shell_class.new
-      end
-      
-      def initialize(options)
-        self.options = options
-        debug "#{__FILE__}:#{__LINE__} :: options #{options.inspect}"
-      end
-      
-      # Runs after options initialized but before any processing of arguments 
-      # or dispatching the command.
-      # Should be implemented in subclasses.
-      def before(*args)
-      end
-
-      # Configure the command prior to dispatch.
-      # Should be implemented in subclasses.
-      # If you want to keep this default behavior setting the shell, 
-      # call +super+ first.
-      def configure_command(cmd)
-        cmd.shell = self.shell if cmd.respond_to?(:"shell=")
-      end
-      
-      # Runs after dispatching the command.
-      # Should be implemented in subclasses.
-      def after
-      end
-      
-      # Main processing of arguments and dispatch from command line (+Ing.run+)
-      def call(*args)
-        before *args
-        ns         = Ing::Util.to_class_names(options[:namespace] || 'object')
-        classes    = Ing::Util.to_class_names(args.shift)
-        debug "#{__FILE__}:#{__LINE__} :: dispatch #{ns.inspect}, #{classes.inspect}, #{args.inspect}"
-        Dispatcher.new(ns, classes, *args).dispatch do |cmd|
-          configure_command cmd
-        end
-        after
-      end
-      
-      # Dispatch from +Ing.invoke+
-      def call_invoke(klass, meth, *args)
-        before *args
-        Dispatcher.invoke(klass, meth, *args) do |cmd|
-          configure_command cmd
-        end
-        after
-      end
-      
-      # Dispatch from +Ing.execute+
-      def call_execute(klass, meth, *args)
-        before *args
-        Dispatcher.execute(klass, meth, *args) do |cmd|
-          configure_command cmd
-        end
-        after
-      end
-      
-      # Internal debugging -- define a :debug option in subclass if you want this
-      def debug(*args)
-        shell.debug(*args) if options[:debug]
-      end
-
-    end
-
-  end
-end