thor 0.12.3 → 0.13.0

data/CHANGELOG.rdoc

@@ -1,5 +1,7 @@
 == 0.12, released 2010-01-02
 
+* Methods generated by attr_* are automatically not marked as tasks
+* inject_into_file does not add the same content twice, unless :force is set
 * Removed rr in favor to rspec mock framework
 * Improved output for thor -T
 * [#7] Do not force white color on status

data/README.rdoc

@@ -145,7 +145,7 @@ When invoking the task one:
 
 The output is "1 2 3", which means that the three task was invoked only once.
 You can even invoke tasks from another class, so be sure to check the
-documentation.
+documentation[http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor.html].
 
 == Thor::Group
 
@@ -227,7 +227,70 @@ To use them, you just need to include Thor::Actions in your Thor classes:
 
 Some actions like copy file requires that a class method called source_root is
 defined in your class. This is the directory where your templates should be
-placed. Be sure to check the documentation.
+placed. Be sure to check the documentation on actions[http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor/Actions.html].
+
+== Generators
+
+A great use for Thor is creating custom generators. Combining Thor::Group,
+Thor::Actions and ERB templates makes this very easy. Here is an example:
+
+    class Newgem < Thor::Group
+      include Thor::Actions
+
+      # Define arguments and options
+      argument :name
+      class_option :test_framework, :default => :test_unit
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      def create_lib_file
+        template('templates/newgem.tt', "#{name}/lib/#{name}.rb")
+      end
+
+      def create_test_file
+        test = options[:test_framework] == "rspec" ? :spec : :test
+        create_file "#{name}/#{test}/#{name}_#{test}.rb"
+      end
+
+      def copy_licence
+        if yes?("Use MIT license?")
+          # Make a copy of the MITLICENSE file at the source root
+          copy_file "MITLICENSE", "#{name}/MITLICENSE"
+        else
+          say "Shame on you…", :red
+        end
+      end
+    end
+
+Doing a <tt>thor -T</tt> will show how to run our generator. It should read:
+<tt>thor newgem NAME</tt>. This shows that we have to supply a NAME
+argument for our generator to run.
+
+The <tt>create_lib_file</tt> uses an ERB template. This is what it looks like:
+
+    class <%= name.camelize %>
+    end
+
+The arguments that you set in your generator will automatically be passed in
+when <tt>template</tt> gets called. Be sure to read the documentation[http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor/Actions.html] for
+more options.
+
+Running the generator with <tt>thor newgem devise</tt> will
+create two files: "devise/lib/devise.rb",
+"devise/test/devise_test.rb". The user will then be prompt (with the
+use of the method <tt>yes?</tt>) if he wants to copy the MITLICENSE. If you
+want to change the test framework, you can add the option:
+<tt>thor newgem devise --test-framework=rspec</tt>
+This will generate: "devise/lib/devise.rb" and
+"devise/spec/devise_spec.rb".
+
+== Further Reading
+
+Thor has many scripting possibilities beyond these examples. Be sure to read
+through the documentation[http://rdoc.info/rdoc/wycats/thor/blob/f939a3e8a854616784cac1dcff04ef4f3ee5f7ff/Thor.html] and specs[http://github.com/wycats/thor/tree/master/spec/] to get a better understanding of all the
+options Thor offers.
 
 == License
 

data/Thorfile

@@ -4,7 +4,10 @@ require File.join(File.dirname(__FILE__), "lib", "thor", "version")
 require 'rubygems'
 require 'thor/rake_compat'
 require 'spec/rake/spectask'
-require 'rdoc/task'
+begin
+  require 'rdoc/task'
+rescue LoadError
+end
 
 GEM_NAME = 'thor'
 EXTRA_RDOC_FILES = ["README.rdoc", "LICENSE", "CHANGELOG.rdoc", "VERSION", "Thorfile"]
@@ -26,13 +29,15 @@ class Default < Thor
     t.rcov_dir = "rcov"
   end
 
-  RDoc::Task.new do |rdoc|
-    rdoc.main     = "README.rdoc"
-    rdoc.rdoc_dir = "rdoc"
-    rdoc.title    = GEM_NAME
-    rdoc.rdoc_files.include(*EXTRA_RDOC_FILES)
-    rdoc.rdoc_files.include('lib/**/*.rb')
-    rdoc.options << '--line-numbers' << '--inline-source'
+  if defined?(RDoc)
+    RDoc::Task.new do |rdoc|
+      rdoc.main     = "README.rdoc"
+      rdoc.rdoc_dir = "rdoc"
+      rdoc.title    = GEM_NAME
+      rdoc.rdoc_files.include(*EXTRA_RDOC_FILES)
+      rdoc.rdoc_files.include('lib/**/*.rb')
+      rdoc.options << '--line-numbers' << '--inline-source'
+    end
   end
 
   begin

data/lib/thor.rb

@@ -1,6 +1,4 @@
 require 'thor/base'
-require 'thor/group'
-require 'thor/actions'
 
 # TODO: Update thor to allow for git-style CLI (git bisect run)
 class Thor

data/lib/thor/actions/inject_into_file.rb

@@ -10,7 +10,8 @@ class Thor
     # destination<String>:: Relative path to the destination root
     # data<String>:: Data to add to the file. Can be given as a block.
     # config<Hash>:: give :verbose => false to not log the status and the flag
-    #                for injection (:after or :before).
+    #                for injection (:after or :before) or :force => true for 
+    #                insert two or more times the same content.
     # 
     # ==== Examples
     #
@@ -55,7 +56,7 @@ class Thor
           replacement + '\0'
         end
 
-        replace!(/#{flag}/, content)
+        replace!(/#{flag}/, content, config[:force])
       end
 
       def revoke!
@@ -69,7 +70,7 @@ class Thor
           /(#{Regexp.escape(replacement)})(.*)(#{flag})/m
         end
 
-        replace!(regexp, content)
+        replace!(regexp, content, true)
       end
 
       protected
@@ -88,11 +89,13 @@ class Thor
 
         # Adds the content to the file.
         #
-        def replace!(regexp, string)
+        def replace!(regexp, string, force)
           unless base.options[:pretend]
             content = File.binread(destination)
-            content.gsub!(regexp, string)
-            File.open(destination, 'wb') { |file| file.write(content) }
+            if force || !content.include?(replacement)
+              content.gsub!(regexp, string)
+              File.open(destination, 'wb') { |file| file.write(content) }
+            end
           end
         end
 

data/lib/thor/base.rb

@@ -8,6 +8,9 @@ require 'thor/task'
 require 'thor/util'
 
 class Thor
+  autoload :Actions,    'thor/actions'
+  autoload :RakeCompat, 'thor/rake_compat'
+
   # Shortcuts for help.
   HELP_MAPPINGS       = %w(-h -? --help -D)
 
@@ -94,6 +97,18 @@ class Thor
     module ClassMethods
       attr_accessor :debugging
 
+      def attr_reader(*) #:nodoc:
+        no_tasks { super }
+      end
+
+      def attr_writer(*) #:nodoc:
+        no_tasks { super }
+      end
+
+      def attr_accessor(*) #:nodoc:
+        no_tasks { super }
+      end
+
       # Adds an argument to the class and creates an attr_accessor for it.
       #
       # Arguments are different from options in several aspects. The first one

data/lib/thor/group.rb

@@ -1,8 +1,9 @@
+require 'thor/base'
+
 # Thor has a special class called Thor::Group. The main difference to Thor class
 # is that it invokes all tasks at once. It also include some methods that allows
 # invocations to be done at the class method, which are not available to Thor
 # tasks.
-#
 class Thor::Group
   class << self
     # The descrition for this Thor::Group. If none is provided, but a source root

data/lib/thor/runner.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'thor/core_ext/file_binary_read'
 require 'open-uri'
 require 'yaml'
 require 'digest/md5'
@@ -32,7 +33,7 @@ class Thor::Runner < Thor #:nodoc:
   end
 
   desc "install NAME", "Install an optionally named Thor file into your system tasks"
-  method_options :as => :string, :relative => :boolean
+  method_options :as => :string, :relative => :boolean, :force => :boolean
   def install(name)
     initialize_thorfiles
 
@@ -55,7 +56,9 @@ class Thor::Runner < Thor #:nodoc:
     say "Your Thorfile contains:"
     say contents
 
-    return false if no?("Do you wish to continue [y/N]?")
+    unless options["force"]
+      return false if no?("Do you wish to continue [y/N]?")
+    end
 
     as = options["as"] || begin
       first_line = contents.split("\n")[0]

data/lib/thor/task.rb

@@ -1,6 +1,6 @@
 class Thor
   class Task < Struct.new(:name, :description, :usage, :options)
-    FILE_REGEXP = /^#{Regexp.escape(File.expand_path(__FILE__))}:[\w:]+ `run'$/
+    FILE_REGEXP = /^#{Regexp.escape(File.dirname(__FILE__))}/
 
     # A dynamic task that handles method missing scenarios.
     class Dynamic < Task
@@ -78,15 +78,15 @@ class Thor
         (collection & [name.to_s, name.to_sym]).empty?
       end
 
-      # For Ruby <= 1.8.7, we have to match the method name that we are trying to call.
-      # In Ruby >= 1.9.1, we have to match the method run in this file.
-      def backtrace_match?(backtrace) #:nodoc:
-        method_name = /`#{Regexp.escape(name.split(':').last)}'/
-        backtrace =~ method_name || backtrace =~ FILE_REGEXP
+      def sans_backtrace(backtrace, caller) #:nodoc:
+        saned  = backtrace.reject { |frame| frame =~ FILE_REGEXP }
+        saned -= caller
       end
 
       def parse_argument_error(instance, e, caller) #:nodoc:
-        if e.message =~ /wrong number of arguments/ && backtrace_match?(e.backtrace.first.to_s)
+        backtrace = sans_backtrace(e.backtrace, caller)
+
+        if backtrace.empty? && e.message =~ /wrong number of arguments/
           if instance.is_a?(Thor::Group)
             raise e, "'#{name}' was called incorrectly. Are you sure it has arity equals to 0?"
           else

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.12.3".freeze
+  VERSION = "0.13.0".freeze
 end

data/spec/actions/inject_into_file_spec.rb

@@ -55,6 +55,35 @@ describe Thor::Actions::InjectIntoFile do
       invoke! "doc/README", "\nmore content", :after => "__start__"
       File.read(file).must == "__start__\nREADME\n__end__\n"
     end
+
+    it "does not change the file if already include content" do
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+    end
+
+    it "does change the file if already include content and :force == true" do
+      invoke! "doc/README", :before => "__end__" do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\n__end__\n"
+
+      invoke! "doc/README", :before => "__end__", :force => true do
+        "more content\n"
+      end
+
+      File.read(file).must == "__start__\nREADME\nmore content\nmore content\n__end__\n"
+    end
+
   end
 
   describe "#revoke!" do

data/spec/base_spec.rb

@@ -233,4 +233,19 @@ describe Thor::Base do
       }.must raise_error(Thor::UndefinedTaskError, /the 'what' task of MyScript is private/)
     end
   end
+
+  describe "attr_*" do
+    it "should not add attr_reader as a task" do
+      capture(:stderr){ MyScript.start(["another_attribute"]) }.must =~ /could not find/
+    end
+
+    it "should not add attr_writer as a task" do
+      capture(:stderr){ MyScript.start(["another_attribute=", "foo"]) }.must =~ /could not find/
+    end
+
+    it "should not add attr_accessor as a task" do
+      capture(:stderr){ MyScript.start(["some_attribute"]) }.must =~ /could not find/
+      capture(:stderr){ MyScript.start(["some_attribute=", "foo"]) }.must =~ /could not find/
+    end
+  end
 end

data/spec/fixtures/script.thor

@@ -1,4 +1,8 @@
 class MyScript < Thor
+  attr_accessor :some_attribute
+  attr_writer :another_attribute
+  attr_reader :another_attribute
+
   group :script
   default_task :example_default_task
 

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $TESTING=true
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'thor'
+require 'thor/group'
 require 'stringio'
 
 require 'rubygems'

data/spec/thor_spec.rb

@@ -133,7 +133,7 @@ describe Thor do
     end
 
     it "raises when an exception happens within the task call" do
-      lambda { MyScript.start(["call_myself_with_wrong_arity", "--debug"]) }.must raise_error
+      lambda { MyScript.start(["call_myself_with_wrong_arity"]) }.must raise_error(ArgumentError)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thor
 version: !ruby/object:Gem::Version 
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors: 
 - Yehuda Katz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 +01:00
+date: 2010-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: []