ing 0.2.1 → 0.2.2

data/examples/rake_pipeline.rb

@@ -0,0 +1,98 @@
+require 'rake-pipeline'
+
+# This is Rake::Pipeline::CLI rewritten as an Ing task
+# instead of Thor
+# cf. https://github.com/livingsocial/rake-pipeline
+#
+# Stick this in your ing.rb and you can simply run
+#
+#   ing pipeline:build
+#
+# to build your project, or
+#
+#   ing pipeline
+#
+# to start the preview server (equivalent to +rakep+)
+#         
+module Pipeline
+
+  # default == server
+  def self.call(*args)
+    Ing.execute Server, *args
+  end
+
+  module Helpers
+
+    private
+    
+    def project
+      @project ||= Rake::Pipeline::Project.new(options[:assetfile])
+    end
+
+    # @param [FileWrapper|String] path
+    # @return [String] The path to the file with the current
+    #   directory stripped out.
+    def relative_path(path)
+      pathstr = path.respond_to?(:fullpath) ? path.fullpath : path
+      pathstr.sub(%r|#{Dir.pwd}/|, '')
+    end
+          
+  end
+ 
+  class Build < Ing::Task
+    include Helpers
+    
+    desc "Build the project."
+    usage "  ing pipeline build"
+    opt :assetfile, "Asset file", :default => "Assetfile", :short => "c"
+    opt :pretend
+    opt :clean, "Clean before building"
+    
+    # ing pipeline build
+    def call
+      if options[:pretend]
+        project.output_files.each do |file|
+          shell.say_status :create, relative_path(file)
+        end
+      else
+        options[:clean] ? Ing.invoke(Clean, options) : project.cleanup_tmpdir
+        project.invoke
+      end
+    end
+
+  end
+  
+  class Clean < Ing::Task
+    include Helpers
+  
+    desc "Remove the pipeline's temporary and output files."
+    usage "  ing pipeline clean"
+    opt :pretend
+          
+    # ing pipeline clean
+    def call
+      if options[:pretend]
+        project.files_to_clean.each do |file|
+          shell.say_status :remove, relative_path(file)
+        end
+      else
+        project.clean
+      end
+    end
+
+  end
+  
+  class Server < Ing::Task
+    
+    desc  "Run the Rake::Pipeline preview server (default task)."
+    usage "  ing pipeline server"
+    
+    # ing pipeline server
+    def call
+      require "rake-pipeline/server"
+      Rake::Pipeline::Server.new.start
+    end
+
+  end
+    
+end

data/ing.rb

@@ -1,102 +1,2 @@
-# Usage:
-# ing rspec:convert    which is equivalent to
-# ing rspec:convert files './{test,spec}/**/*.rb' --convert-dir 'converted'
-#
-module Rspec
-
-  class Convert
-    
-    GSUBS = \
-    [ 
-      [ /^(\s*)(.+)\.should\s+be_true/          , '\1assert \2'            ],
-      [ /^(\s*)(.+)\.should\s+be_false/         , '\1refute \2'            ],
-      [ /^(\s*)(.+)\.should\s*==\s*(.+)$/       , '\1assert_equal \3, \2'  ],
-      [ /^(\s*)(.+)\.should_not\s*==\s*(.+)$/   , '\1refute_equal \3, \2'  ],
-      [ /^(\s*)(.+)\.should\s*=~\s*(.+)$/       , '\1assert_match(\3, \2)' ],
-      [ /^(\s*)(.+)\.should_not\s*=~\s*(.+)$/   , '\1refute_match(\3, \2)' ],
-      [ /^(\s*)(.+)\.should\s+be_(.+)$/         , '\1assert \2.\3?'        ],
-      [ /^(\s*)(.+)\.should_not\s+be_(.+)$/     , '\1refute \2.\3?'        ],
-      [ /expect\s+\{(.+)\}\.to\s+raise_error\s*\((.*)\)\s*\Z/m, 
-        'assert_raises(\2) {\1}'                                      ],
-      [ /\{(.+)\}\.should raise_error\s*\((.*)\)\s*\Z/m,
-        'assert_raises(\2) {\1}'                                        ],
-    # these next aren't quite right because they need to wrap the next 
-    # lines as a lambda. Thus the FIXME notes.
-      [ /\.should_receive\(([^\)]+)\)\.and_return\((.+)\)/,  
-        '.stub(\1, \2) do |s|  # FIXME'                                 ],
-      [ /.stub\!\(([\w:]+)\)\.and_return\((.+)\)/,
-        '.stub(\1, \2) do |s|  # FIXME'                                 ]
-      
-    ]
-    
-    def self.specify_options(expect)
-      expect.banner "Convert rspec 'should/not' matchers to minitest 'assert/refute'"
-      expect.text "It's not magic, you still need to hand edit your test files after running this"
-      expect.text "\nUsage:"
-      expect.text "  ing rspec:convert    # which is equivalent to"
-      expect.text "  ing rspec:convert files './{test,spec}/**/*.rb' --convert-dir 'converted'"
-      expect.text "\nOptions:"
-      expect.opt :pattern, "Directory glob pattern for test files",
-                 :type => :string, :default => './{test,spec}/**/*.rb'
-      expect.opt :convert_dir, "Subdirectory to save converted files",
-                 :type => :string, :default => 'converted'
-    end
-    
-    include Ing::Files
-    
-    attr_accessor :shell, :options, :destination_root, :source_root
-    
-    def destination_root; @destination_root ||= Dir.pwd; end
-    def source_root;      @source_root ||= File.dirname(__FILE__); end
-    
-    def input_files
-      @input_files ||= Dir[ File.expand_path(options[:pattern], source_root) ]
-    end
-    
-    def converted_files
-      input_files.map {|f|
-        File.join( File.dirname(f), options[:convert_dir], File.basename(f) )
-      }
-    end
-    
-    def conversion_map
-      input_files.zip(converted_files)
-    end
-    
-    def initialize(options)
-      self.options = options
-    end
-    
-    def call(pattern=nil)
-      options[:pattern] = pattern || options[:pattern]
-      shell.say "Processing #{input_files.length} input files: #{options[:pattern]}" if verbose?
-      conversion_map.each do |input_f, output_f|
-        new_lines = convert_lines(input_f)
-        create_file output_f, new_lines.join
-      end
-    end
-    alias :files :call
-    
-    private
-    
-    def convert_lines(fname)
-      count = 0; accum = []
-      File.open(fname) do |f|
-        f.each_line do |line|
-          new_line = GSUBS.inject(line) do |str, (rx, replace)|
-            str = str.gsub(rx, replace)
-          end
-          count += 1 if line != new_line
-          accum << new_line
-        end
-      end
-      shell.say_status(:convert, 
-                       "#{relative_to_original_destination_root(fname)}: " +
-                         "#{count} changes", 
-                       :green) if verbose?
-      accum
-    end
-        
-  end
-  
-end
+require_relative 'examples/rspec_convert.rb'
+require_relative 'examples/rake_pipeline.rb'

data/lib/ing/commands/list.rb

@@ -9,11 +9,15 @@
       }
       
       def self.specify_options(parser)
-        parser.banner "List all tasks within specified namespace"
+        parser.banner "List all tasks by name or in specified namespace"
         parser.text "\nUsage:"
-        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 "  ing list                # list all built-in ing commands"
+        parser.text "  ing list -n rspec       # list all commands in rspec namespace"
+        parser.text "  ing list rspec          # search for commands that match /.*rspec/ (in any namespace)"
+        parser.text "  ing list rspec --all    # include modules that don't have a description in list (not recommended)"
+        parser.text "  ing list -n rspec conv  # search for commands that match /.*conv/ in rspec namespace"
+        parser.text "\nOptions:"
+        parser.opt :all, "List all tasks including modules that don't have a description", :default => false
       end
       
       include Ing::CommonOptions
@@ -36,32 +40,57 @@
         require_ing_file
       end
       
-      def call(ns=nil)
+      def call(s=nil)
         before
-        mod       = _namespace_class(ns)
-        data = mod.constants.map do |c|
-          klass = mod.const_get(c)
-          desc = (Command.new(klass).describe || '')[/.+$/]
-          [ "ing #{Ing::Util.encode_class(mod)}:#{Ing::Util.encode_class_names([c])}", 
-            (desc || '(no description)').chomp
-          ]
-        end.sort
-        shell.say desc_lines(mod, data).join("\n")
+        if s && !options[:namespace_given]
+          search_all s
+        else
+          search s
+        end
+      end
+      
+      def search(s)
+        _do_search(_namespace_class, %r|.*#{s}|, false)
+      end
+      
+      def search_all(s)
+        _do_search(::Object, %r|.*#{s}|, true)
       end
       
       private 
+      
       def _namespace_class(ns=options[:namespace])
-        return ::Ing::Commands unless ns
         Util.decode_class(ns)
       end      
-                  
-      def desc_lines(mod, data)
+            
+      def _do_search(mod, expr, recurse)
+        data = filtered_commands(mod, recurse, expr).map do |(cmd, klass)|
+          desc = (Command.new(klass).describe || '')[/.+$/]
+          cmd_and_description(cmd, desc) if options[:all] || desc 
+        end.compact.sort
+        title = "All tasks #{options[:all] ? '' : 'with description'}"
+        shell.say desc_lines(mod, data, title).join("\n")
+      end
+      
+      def filtered_commands(mod, recurse, expr)
+        Util.ing_commands(mod, recurse).select {|(cmd, klass)|
+          expr =~ cmd
+        }
+      end
+      
+      def cmd_and_description(cmd, desc)
+        [ "ing #{cmd}", 
+          (desc || '(no description)').chomp
+        ]      
+      end
+      
+      def desc_lines(mod, data, title="all tasks")
         colwidths = data.inject([0,0]) {|max, (line, desc)| 
           max[0] = line.length if line.length > max[0]
           max[1] = desc.length if desc.length > max[1]
           max
         }
-        ["#{mod}: all tasks",
+        ["#{mod}: #{title}",
          "-" * 80
         ] +
         data.map {|line, desc|

data/lib/ing/task.rb

@@ -13,8 +13,10 @@ module Ing
     
       attr_accessor :inherited_options
       
+      # On subclassing, deep copy the merge of current options into inherited
+      # options
       def inherited(subclass)
-        subclass.inherited_options = self.options.dup
+        subclass.inherited_options = Marshal.load(Marshal.dump(self.all_options))
       end
       
       def inherited_option?(name)
@@ -44,6 +46,7 @@ module Ing
       
       # Modify the default for option +name+ to +val+.
       # Option will be created if it doesn't exist.
+      #
       def default(name, val)
         modify_option name, {:default => val}
       end
@@ -66,7 +69,8 @@ module Ing
       alias option opt
       
       # Build option parser based on desc, usage, and options (including
-      # inherited options). This method is called by `Ing::Dispatcher`.
+      # inherited options). This method is called by `Ing::Command`.
+      # Note that this assumes the syntax of the Trollop parser.
       #
       def specify_options(parser)
         desc_lines.each do |line|
@@ -108,6 +112,12 @@ module Ing
         @options ||= {}
       end
       
+      # Options merged into inherited options. This is only used by the
+      # +inherited+ hook (on subclassing), and should not be used otherwise.
+      def all_options
+        (inherited_options || {}).merge(options)
+      end
+      
       protected
       
       def set_options(o)  #:nodoc:

data/lib/ing/util.rb

@@ -25,6 +25,22 @@
       list.inject(base) {|m, klass| m.const_get(klass, false)}
     end
     
+    # search for {modules, callables} under base
+    # note this does not pick up aliased constants right now
+    def ing_commands(base, recurse=false, init={})
+      base.constants(false).each do |c|
+        v = base.const_get(c)
+        next if init.values.include?(v)
+        if v.respond_to?(:constants)
+          init[ encode_class(v) ] = v
+          ing_commands(v,true,init) if recurse
+        elsif v.respond_to?(:call)
+          init[ encode_class_names(base.to_s.split('::') + [c]) ] = v
+        end
+      end
+      init
+    end
+    
     def option?(arg)
       !!(/^-{1,2}/ =~ arg)
     end

data/lib/ing/version.rb

@@ -1,3 +1,3 @@
 module Ing
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/test/acceptance/ing_task_tests.rb

@@ -51,4 +51,26 @@ describe Ing::Task do
     
   end
   
+  describe "triple inheritance" do
+  
+    subject { ["mega_task"] }
+    
+    it "help should display all the options defined by the task and its superclasses" do
+      output = capture_help(subject)
+      assert_match(/^\s*--fast/, output)
+      assert_match(/^\s*--altitude/, output)
+      assert_match(/^\s*--yards/, output)
+      assert_match(/^\s*--color/, output)
+      assert_match(/^\s*--gallons/, output)
+      assert_match(/^\s*--insurance/, output)
+    end
+    
+    it "run should reflect modifications to superclass options" do
+      output = capture_help(subject)
+      assert_match(/^\s*--fast:.+/, output)
+      assert_match(/^\s*--color.+\(default: blue\)/, output)      
+    end
+    
+  end
+  
 end

data/test/fixtures/task.ing.rb

@@ -59,4 +59,15 @@ class BigTask < SimpleTask
   default :fast, true
   modify_option :altitude, :short => 'l', :default => 2500
   
+end
+
+class MegaTask < BigTask
+
+  desc "Monsterous"
+  opt :gallons, "Gallons of paint", :type => :integer, :default => 45
+  opt :insurance, "Has insurance"
+  
+  default :fast, false
+  modify_option :color, :default => "blue"
+  
 end

data/todo.yml

@@ -1,5 +1,8 @@
 Ing todo
 ---
+- add tests for List, Help built-in commands
 - add Shell::Color
 - remove global Ing.shell_class, specify via color switch
 - incorporate gsub_file patch, patches to Shell
+- rewrite README centered on simplest usages and move the rest to MORE pages
+- nicer error handling for bad input

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ing
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000Z
+date: 2012-09-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &7756700 !ruby/object:Gem::Requirement
+  requirement: &9181600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7756700
+  version_requirements: *9181600
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &7756220 !ruby/object:Gem::Requirement
+  requirement: &9181100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7756220
+  version_requirements: *9181100
 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
@@ -52,6 +52,7 @@ files:
 - README.md
 - TASKS.md
 - bin/ing
+- examples/rake_pipeline.rb
 - examples/rspec_convert.rb
 - ing.gemspec
 - ing.rb