thor 0.11.5 → 0.11.6

data/Thorfile

@@ -34,7 +34,6 @@ class Default < Thor
     require 'jeweler'
     Jeweler::Tasks.new do |s|
       s.name = GEM_NAME
-      s.version = "0.11.4"
       s.rubyforge_project = "textmate"
       s.platform = Gem::Platform::RUBY
       s.summary = "A scripting framework that replaces rake, sake and rubigen"

data/VERSION

@@ -1 +1 @@
-0.11.5
+0.11.6

data/lib/thor.rb

@@ -135,7 +135,7 @@ class Thor
           args, opts = given_args, {}
         end
 
-        task ||= Task.dynamic(meth)
+        task ||= Thor::Task::Dynamic.new(meth)
         trailing = args[Range.new(arguments.size, -1)]
         new(args, opts, config).invoke(task, trailing || [])
       end

data/lib/thor/actions.rb

@@ -8,23 +8,8 @@ class Thor
   module Actions
     attr_accessor :behavior
 
-    # On inclusion, add some options to base.
-    #
     def self.included(base) #:nodoc:
       base.extend ClassMethods
-      return unless base.respond_to?(:class_option)
-
-      base.class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
-                                  :desc => "Run but do not make any changes"
-
-      base.class_option :force, :type => :boolean, :aliases => "-f", :group => :runtime,
-                                :desc => "Overwrite files that already exist"
-
-      base.class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
-                               :desc => "Skip files that already exist"
-
-      base.class_option :quiet, :type => :boolean, :aliases => "-q", :group => :runtime,
-                                :desc => "Supress status output"
     end
 
     module ClassMethods
@@ -49,6 +34,22 @@ class Thor
         paths += from_superclass(:source_paths, [])
         paths
       end
+
+      # Add runtime options that help actions execution.
+      #
+      def add_runtime_options!
+        class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
+                               :desc => "Run but do not make any changes"
+
+        class_option :force, :type => :boolean, :aliases => "-f", :group => :runtime,
+                             :desc => "Overwrite files that already exist"
+
+        class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
+                            :desc => "Skip files that already exist"
+
+        class_option :quiet, :type => :boolean, :aliases => "-q", :group => :runtime,
+                             :desc => "Supress status output"
+      end
     end
 
     # Extends initializer to add more configuration options.

data/lib/thor/actions/file_manipulation.rb

@@ -100,7 +100,7 @@ class Thor
       FileUtils.chmod_R(mode, path) unless options[:pretend]
     end
 
-    # Prepend text to a file.
+    # Prepend text to a file. Since it depends on inject_into_file, it's reversible.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -111,19 +111,17 @@ class Thor
     #
     #   prepend_file 'config/environments/test.rb', 'config.gem "rspec"'
     #
-    def prepend_file(path, data=nil, config={}, &block)
-      return unless behavior == :invoke
-      path = File.expand_path(path, destination_root)
-      say_status :prepend, relative_to_original_destination_root(path), config.fetch(:verbose, true)
-
-      unless options[:pretend]
-        content = data || block.call
-        content << File.read(path)
-        File.open(path, 'wb') { |file| file.write(content) }
-      end
+    #   prepend_file 'config/environments/test.rb' do
+    #     'config.gem "rspec"'
+    #   end
+    #
+    def prepend_file(path, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      config.merge!(:after => /\A/)
+      inject_into_file(path, *(args << config), &block)
     end
 
-    # Append text to a file.
+    # Append text to a file. Since it depends on inject_into_file, it's reversible.
     #
     # ==== Parameters
     # path<String>:: path of the file to be changed
@@ -134,11 +132,37 @@ class Thor
     #
     #   append_file 'config/environments/test.rb', 'config.gem "rspec"'
     #
-    def append_file(path, data=nil, config={}, &block)
-      return unless behavior == :invoke
-      path = File.expand_path(path, destination_root)
-      say_status :append, relative_to_original_destination_root(path), config.fetch(:verbose, true)
-      File.open(path, 'ab') { |file| file.write(data || block.call) } unless options[:pretend]
+    #   append_file 'config/environments/test.rb' do
+    #     'config.gem "rspec"'
+    #   end
+    #
+    def append_file(path, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      config.merge!(:before => /\z/)
+      inject_into_file(path, *(args << config), &block)
+    end
+
+    # Injects text right after the class definition. Since it depends on
+    # inject_into_file, it's reversible.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # klass<String|Class>:: the class to be manipulated
+    # data<String>:: the data to append to the class, can be also given as a block.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   inject_into_class "app/controllers/application_controller.rb", "  filter_parameter :password\n"
+    #
+    #   inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+    #     "  filter_parameter :password\n"
+    #   end
+    #
+    def inject_into_class(path, klass, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      config.merge!(:after => /class #{klass}\n|class #{klass} .*\n/)
+      inject_into_file(path, *(args << config), &block)
     end
 
     # Run a regular expression replacement on a file.

data/lib/thor/actions/inject_into_file.rb

@@ -3,10 +3,8 @@ require 'thor/actions/empty_directory'
 class Thor
   module Actions
 
-    # Injects the given content into a file. Different from append_file,
-    # prepend_file and gsub_file, this method is reversible. By this reason,
-    # the flag can only be strings. gsub_file is your friend if you need to
-    # deal with more complex cases.
+    # Injects the given content into a file. Different from gsub_file, this
+    # method is reversible.
     #
     # ==== Parameters
     # destination<String>:: Relative path to the destination root
@@ -16,11 +14,11 @@ class Thor
     # 
     # ==== Examples
     #
-    #   inject_into_file "config/environment.rb", "config.gem thor", :after => "Rails::Initializer.run do |config|\n"
+    #   inject_into_file "config/environment.rb", "config.gem :thor", :after => "Rails::Initializer.run do |config|\n"
     #
     #   inject_into_file "config/environment.rb", :after => "Rails::Initializer.run do |config|\n" do
     #     gems = ask "Which gems would you like to add?"
-    #     gems.split(" ").map{ |gem| "  config.gem #{gem}" }.join("\n")
+    #     gems.split(" ").map{ |gem| "  config.gem :#{gem}" }.join("\n")
     #   end
     #
     def inject_into_file(destination, *args, &block)
@@ -29,40 +27,65 @@ class Thor
       else
         data, config = args.shift, args.shift
       end
-
-      log_status = args.empty? || args.pop
       action InjectIntoFile.new(self, destination, data, config)
     end
 
     class InjectIntoFile < EmptyDirectory #:nodoc:
-      attr_reader :flag, :replacement
+      attr_reader :replacement, :flag, :behavior
 
       def initialize(base, destination, data, config)
         super(base, destination, { :verbose => true }.merge(config))
 
-        data = data.call if data.is_a?(Proc)
-
-        @replacement = if @config.key?(:after)
-          @flag = @config.delete(:after)
-          @flag + data
+        @behavior, @flag = if @config.key?(:after)
+          [:after, @config.delete(:after)]
         else
-          @flag = @config.delete(:before)
-          data + @flag
+          [:before, @config.delete(:before)]
         end
+
+        @replacement = data.is_a?(Proc) ? data.call : data
+        @flag = Regexp.escape(@flag) unless @flag.is_a?(Regexp)
       end
 
       def invoke!
-        say_status :inject, config[:verbose]
-        replace!(flag, replacement)
+        say_status :invoke
+
+        content = if @behavior == :after
+          '\0' + replacement
+        else
+          replacement + '\0'
+        end
+
+        replace!(/#{flag}/, content)
       end
 
       def revoke!
-        say_status :deinject, config[:verbose]
-        replace!(replacement, flag)
+        say_status :revoke
+
+        regexp = if @behavior == :after
+          content = '\1\2'
+          /(#{flag})(.*)(#{Regexp.escape(replacement)})/m
+        else
+          content = '\2\3'
+          /(#{Regexp.escape(replacement)})(.*)(#{flag})/m
+        end
+
+        replace!(regexp, content)
       end
 
       protected
 
+        def say_status(behavior)
+          status = if flag == /\A/
+            behavior == :invoke ? :prepend : :unprepend
+          elsif flag == /\z/
+            behavior == :invoke ? :append : :unappend
+          else
+            behavior == :invoke ? :inject : :deinject
+          end
+
+          super(status, config[:verbose])
+        end
+
         # Adds the content to the file.
         #
         def replace!(regexp, string)

data/lib/thor/base.rb

@@ -355,6 +355,7 @@ class Thor
         else
           config[:shell].error e.message
         end
+        exit(1) if exit_on_failure?
       end
 
       protected
@@ -491,6 +492,12 @@ class Thor
           end
         end
 
+        # A flag that makes the process exit with status 1 if any error happens.
+        #
+        def exit_on_failure?
+          false
+        end
+
         # SIGNATURE: Sets the baseclass. This is where the superclass lookup
         # finishes.
         def baseclass #:nodoc:

data/lib/thor/invocation.rb

@@ -153,7 +153,7 @@ class Thor
         raise "Expected Thor class, got #{klass}" unless klass <= Thor::Base
 
         task ||= klass.default_task if klass <= Thor
-        task = klass.all_tasks[task.to_s] || Task.dynamic(task) if task && !task.is_a?(Thor::Task)
+        task = klass.all_tasks[task.to_s] || Thor::Task::Dynamic.new(task) if task && !task.is_a?(Thor::Task)
         task
       end
 

data/lib/thor/runner.rb

@@ -175,6 +175,10 @@ class Thor::Runner < Thor #:nodoc:
       File.open(yaml_file, "w") { |f| f.puts yaml.to_yaml }
     end
 
+    def self.exit_on_failure?
+      true
+    end
+
     # Load the thorfiles. If relevant_to is supplied, looks for specific files
     # in the thor_root instead of loading them all.
     #

data/lib/thor/shell/basic.rb

@@ -34,12 +34,11 @@ class Thor
       # ==== Example
       # say("I know you knew that.")
       #
-      def say(message="", color=nil, force_new_line=false)
+      def say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)$/))
         message  = message.to_s
-        new_line = force_new_line || !(message[-1, 1] == " " || message[-1, 1] == "\t")
         message  = set_color(message, color) if color
 
-        if new_line
+        if force_new_line
           $stdout.puts(message)
         else
           $stdout.print(message)

data/lib/thor/task.rb

@@ -1,11 +1,19 @@
 class Thor
   class Task < Struct.new(:name, :description, :usage, :options)
 
-    # Creates a dynamic task. Dynamic tasks are created on demand to allow method
-    # missing calls (since a method missing does not have a task object for it).
+    # A dynamic task that handles method missing scenarios.
     #
-    def self.dynamic(name)
-      new(name, "A dynamically-generated task", name.to_s)
+    class Dynamic < Task
+      def initialize(name)
+        super(name.to_s, "A dynamically-generated task", name.to_s)
+      end
+
+      def run(instance, args=[])
+        unless (instance.methods & [name.to_s, name.to_sym]).empty?
+          raise Error, "could not find Thor class or task '#{name}'"
+        end
+        super
+      end
     end
 
     def initialize(name, description, usage, options=nil)
@@ -37,8 +45,6 @@ class Thor
     # injected in the usage.
     #
     def formatted_usage(klass=nil, namespace=false, show_options=true)
-      formatted = ''
-
       formatted = if namespace.is_a?(String)
         "#{namespace}:"
       elsif klass && namespace
@@ -77,7 +83,7 @@ class Thor
       #
       def public_method?(instance) #:nodoc:
         collection = instance.private_methods + instance.protected_methods
-        !(collection).include?(name.to_s) && !(collection).include?(name.to_sym) # For Ruby 1.9
+        (collection & [name.to_s, name.to_sym]).empty?
       end
 
       # Clean everything that comes from the Thor gempath and remove the caller.

data/lib/thor/util.rb

@@ -137,17 +137,18 @@ class Thor
     #               inherit from Thor or Thor::Group.
     #
     def self.namespace_to_thor_class_and_task(namespace, raise_if_nil=true)
-      klass, task_name = Thor::Util.find_by_namespace(namespace), nil
+      if namespace.include?(?:)
+        pieces = namespace.split(":")
+        task   = pieces.pop
+        klass  = Thor::Util.find_by_namespace(pieces.join(":"))
+      end
 
-      if klass.nil? && namespace.include?(?:)
-        namespace = namespace.split(":")
-        task_name = namespace.pop
-        klass     = Thor::Util.find_by_namespace(namespace.join(":"))
+      unless klass
+        klass, task = Thor::Util.find_by_namespace(namespace), nil
       end
 
       raise Error, "could not find Thor class or task '#{namespace}'" if raise_if_nil && klass.nil?
-
-      return klass, task_name
+      return klass, task
     end
 
     # Receives a path and load the thor file in the path. The file is evaluated

data/spec/actions/file_manipulation_spec.rb

@@ -1,5 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
+class Application; end
+
 describe Thor::Actions do
   def runner(options={})
     @runner ||= MyCounter.new([1], options, { :destination_root => destination_root })
@@ -193,12 +195,6 @@ describe Thor::Actions do
         File.open(file).read.must == "__start__\nREADME\n__end__\nEND\n"
       end
 
-      it "does not append if pretending" do
-        runner(:pretend => true)
-        action :append_file, "doc/README", "END\n"
-        File.open(file).read.must == "__start__\nREADME\n__end__\n"
-      end
-
       it "accepts a block" do
         action(:append_file, "doc/README"){ "END\n" }
         File.open(file).read.must == "__start__\nREADME\n__end__\nEND\n"
@@ -207,10 +203,6 @@ describe Thor::Actions do
       it "logs status" do
         action(:append_file, "doc/README", "END").must == "      append  doc/README\n"
       end
-
-      it "does not log status if required" do
-        action(:append_file, "doc/README", nil, :verbose => false){ "END" }.must be_empty
-      end
     end
 
     describe "#prepend_file" do
@@ -219,12 +211,6 @@ describe Thor::Actions do
         File.open(file).read.must == "START\n__start__\nREADME\n__end__\n"
       end
 
-      it "does not prepend if pretending" do
-        runner(:pretend => true)
-        action :prepend_file, "doc/README", "START\n"
-        File.open(file).read.must == "__start__\nREADME\n__end__\n"
-      end
-
       it "accepts a block" do
         action(:prepend_file, "doc/README"){ "START\n" }
         File.open(file).read.must == "START\n__start__\nREADME\n__end__\n"
@@ -233,9 +219,30 @@ describe Thor::Actions do
       it "logs status" do
         action(:prepend_file, "doc/README", "START").must == "     prepend  doc/README\n"
       end
+    end
 
-      it "does not log status if required" do
-        action(:prepend_file, "doc/README", "START", :verbose => false).must be_empty
+    describe "#inject_into_class" do
+      def file
+        File.join(destination_root, "application.rb")
+      end
+
+      it "appends content to a class" do
+        action :inject_into_class, "application.rb", Application, "  filter_parameters :password\n"
+        File.open(file).read.must == "class Application < Base\n  filter_parameters :password\nend\n"
+      end
+
+      it "accepts a block" do
+        action(:inject_into_class, "application.rb", Application){ "  filter_parameters :password\n" }
+        File.open(file).read.must == "class Application < Base\n  filter_parameters :password\nend\n"
+      end
+
+      it "logs status" do
+        action(:inject_into_class, "application.rb", Application, "  filter_parameters :password\n").must == "      inject  application.rb\n"
+      end
+
+      it "does not append if class name does not match" do
+        action :inject_into_class, "application.rb", "App", "  filter_parameters :password\n"
+        File.open(file).read.must == "class Application < Base\nend\n"
       end
     end
   end

data/spec/actions/inject_into_file_spec.rb

@@ -61,17 +61,43 @@ describe Thor::Actions::InjectIntoFile do
     it "deinjects the destination file after injection" do
       invoke! "doc/README", "\nmore content", :after => "__start__"
       revoke! "doc/README", "\nmore content", :after => "__start__"
-
       File.read(file).must == "__start__\nREADME\n__end__\n"
     end
 
     it "deinjects the destination file before injection" do
-      invoke! "doc/README", "\nmore content", :before => "__start__"
-      revoke! "doc/README", "\nmore content", :before => "__start__"
-
+      invoke! "doc/README", "more content\n", :before => "__start__"
+      revoke! "doc/README", "more content\n", :before => "__start__"
       File.read(file).must == "__start__\nREADME\n__end__\n"
     end
 
+    it "deinjects even with double after injection" do
+      invoke! "doc/README", "\nmore content", :after => "__start__"
+      invoke! "doc/README", "\nanother stuff", :after => "__start__"
+      revoke! "doc/README", "\nmore content", :after => "__start__"
+      File.read(file).must == "__start__\nanother stuff\nREADME\n__end__\n"
+    end
+
+    it "deinjects even with double before injection" do
+      invoke! "doc/README", "more content\n", :before => "__start__"
+      invoke! "doc/README", "another stuff\n", :before => "__start__"
+      revoke! "doc/README", "more content\n", :before => "__start__"
+      File.read(file).must == "another stuff\n__start__\nREADME\n__end__\n"
+    end
+
+    it "deinjects when prepending" do
+      invoke! "doc/README", "more content\n", :after => /\A/
+      invoke! "doc/README", "another stuff\n", :after => /\A/
+      revoke! "doc/README", "more content\n", :after => /\A/
+      File.read(file).must == "another stuff\n__start__\nREADME\n__end__\n"
+    end
+
+    it "deinjects when appending" do
+      invoke! "doc/README", "more content\n", :before => /\z/
+      invoke! "doc/README", "another stuff\n", :before => /\z/
+      revoke! "doc/README", "more content\n", :before => /\z/
+      File.read(file).must == "__start__\nREADME\n__end__\nanother stuff\n"
+    end
+
     it "shows progress information to the user" do
       invoke!("doc/README", "\nmore content", :after => "__start__")
       revoke!("doc/README", "\nmore content", :after => "__start__").must == "    deinject  doc/README\n"

data/spec/fixtures/application.rb

@@ -0,0 +1,2 @@
+class Application < Base
+end

data/spec/runner_spec.rb

@@ -30,6 +30,7 @@ describe Thor::Runner do
     end
 
     it "raises error if a class/task cannot be found" do
+      mock(Thor::Runner).exit(1)
       content = capture(:stderr){ Thor::Runner.start(["help", "unknown"]) }
       content.must =~ /could not find Thor class or task 'unknown'/
     end
@@ -67,6 +68,7 @@ describe Thor::Runner do
     end
 
     it "raises an error if class/task can't be found" do
+      mock(Thor::Runner).exit(1)
       ARGV.replace ["unknown"]
       capture(:stderr){ Thor::Runner.start }.must =~ /could not find Thor class or task 'unknown'/
     end
@@ -180,10 +182,8 @@ describe Thor::Runner do
 
       it "displays the modules installed in a pretty way" do
         stdout = capture(:stdout) { Thor::Runner.start(["installed"]) }
-
         stdout.must =~ /random\s*amazing/
         stdout.must =~ /amazing:describe NAME \[\-\-forcefully\]\s+# say that someone is amazing/m
-        stdout.must =~ /amazing:hello\s+# say hello/m
       end
     end
 

data/spec/shell/basic_spec.rb

@@ -57,6 +57,11 @@ describe Thor::Shell::Basic do
       mock($stdout).print("Running... ")
       shell.say("Running... ")
     end
+
+    it "prints a message to the user without new line" do
+      mock($stdout).print("Running...")
+      shell.say("Running...", nil, false)
+    end
   end
 
   describe "#say_status" do

data/spec/task_spec.rb

@@ -41,10 +41,16 @@ describe Thor::Task do
 
   describe "#dynamic" do
     it "creates a dynamic task with the given name" do
-      Thor::Task.dynamic('task').name.must == 'task'
-      Thor::Task.dynamic('task').description.must == 'A dynamically-generated task'
-      Thor::Task.dynamic('task').usage.must == 'task'
-      Thor::Task.dynamic('task').options.must == {}
+      Thor::Task::Dynamic.new('task').name.must == 'task'
+      Thor::Task::Dynamic.new('task').description.must == 'A dynamically-generated task'
+      Thor::Task::Dynamic.new('task').usage.must == 'task'
+      Thor::Task::Dynamic.new('task').options.must == {}
+    end
+
+    it "does not invoke an existing method" do
+      lambda {
+        Thor::Task::Dynamic.new('to_s').run([])
+      }.must raise_error(Thor::Error, "could not find Thor class or task 'to_s'")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thor
 version: !ruby/object:Gem::Version 
-  version: 0.11.5
+  version: 0.11.6
 platform: ruby
 authors: 
 - Yehuda Katz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 +02:00
+date: 2009-09-09 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: textmate
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A scripting framework that replaces rake, sake and rubigen
@@ -105,6 +105,7 @@ test_files:
 - spec/shell/color_spec.rb
 - spec/group_spec.rb
 - spec/thor_spec.rb
+- spec/fixtures/application.rb
 - spec/fixtures/doc/config.rb
 - spec/fixtures/bundle/execute.rb
 - spec/util_spec.rb