wycats-thor 0.11.4 → 0.11.5

data/CHANGELOG.rdoc

@@ -1,9 +1,11 @@
 == TODO
 
 * Improve spec coverage for Thor::Runner
-* Improve help output to list shorthand switches, too
 
-== Current
+== 0.11.x, released 2009-07-01
+
+* Added a rake compatibility layer. It allows you to use spec and rdoc tasks on
+  Thor classes.
 
 * BACKWARDS INCOMPATIBLE: aliases are not generated automatically anymore
   since it wrong behavior to the invocation system.

data/Thorfile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'thor/rake_compat'
+require 'spec/rake/spectask'
+require 'rdoc/task'
+
+GEM_NAME = 'thor'
+EXTRA_RDOC_FILES = ["README.rdoc", "LICENSE", "CHANGELOG.rdoc", "VERSION", "Thorfile"]
+
+class Default < Thor
+  include Thor::RakeCompat
+
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    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'
+  end
+
+  begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |s|
+      s.name = GEM_NAME
+      s.version = "0.11.4"
+      s.rubyforge_project = "thor"
+      s.platform = Gem::Platform::RUBY
+      s.summary = "A scripting framework that replaces rake, sake and rubigen"
+      s.email = "ruby-thor@googlegroups.com"
+      s.homepage = "http://yehudakatz.com"
+      s.description = "A scripting framework that replaces rake, sake and rubigen"
+      s.authors = ['Yehuda Katz', 'José Valim']
+      s.has_rdoc = true
+      s.extra_rdoc_files = EXTRA_RDOC_FILES
+      s.require_path = 'lib'
+      s.bindir = "bin"
+      s.executables = %w( thor rake2thor )
+      s.files = s.extra_rdoc_files + Dir.glob("{bin,lib}/**/*")
+      s.files.exclude 'spec/sandbox/**/*'
+      s.test_files.exclude 'spec/sandbox/**/*'
+    end
+  rescue LoadError
+    puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.11.5

data/lib/thor.rb

@@ -165,18 +165,25 @@ class Thor
         shell.say task.description
       else
         list = (options[:short] ? tasks : all_tasks).map do |_, task|
-          item = [ banner(task, options[:namespace]), "\n" ]
-          item.last << "# #{task.short_description}\n" if task.short_description
-          item
+          item = [ banner(task, options[:namespace]) ]
+          item << "# #{task.short_description}" if task.short_description
+          item << " "
         end
 
+        options[:ident] ||= 2
         if options[:short]
-          shell.print_table(list)
+          shell.print_list(list, :ident => options[:ident])
         else
           shell.say "Tasks:"
-          shell.print_table(list)
-          class_options_help(shell, "Class")
+          shell.print_list(list, :ident => options[:ident])
         end
+
+        Thor::Util.thor_classes_in(self).each do |subclass|
+          namespace = options[:namespace] == true || subclass.namespace.gsub(/^#{self.namespace}:/, '')
+          subclass.help(shell, options.merge(:short => true, :namespace => namespace))
+        end
+
+        class_options_help(shell, "Class") unless options[:short]
       end
     end
 

data/lib/thor/base.rb

@@ -8,7 +8,10 @@ require 'thor/task'
 require 'thor/util'
 
 class Thor
+  # Shortcuts for help.
   HELP_MAPPINGS       = %w(-h -? --help -D)
+
+  # Thor methods that should not be overwritten by the user.
   THOR_RESERVED_WORDS = %w(invoke shell options behavior root destination_root relative_root
                            action add_file create_file in_root inside run run_ruby_script)
 
@@ -335,7 +338,7 @@ class Thor
       def namespace(name=nil)
         case name
           when nil
-            @namespace ||= Thor::Util.constant_to_namespace(self, false)
+            @namespace ||= Thor::Util.namespace_from_thor_class(self, false)
           else
             @namespace = name.to_s
         end

data/lib/thor/invocation.rb

@@ -11,7 +11,7 @@ class Thor
       def prepare_for_invocation(key, name) #:nodoc:
         case name
           when Symbol, String
-            Thor::Util.namespace_to_thor_class(name.to_s, false)
+            Thor::Util.namespace_to_thor_class_and_task(name.to_s, false)
           else
             name
         end

data/lib/thor/rake_compat.rb

@@ -0,0 +1,67 @@
+require 'rake'
+
+class Thor
+  # Adds a compatibility layer to your Thor classes which allows you to use
+  # rake package tasks. For example, to use rspec rake tasks, one can do:
+  #
+  #   require 'thor/rake_compat'
+  #
+  #   class Default < Thor
+  #     include Thor::RakeCompat
+  #
+  #     Spec::Rake::SpecTask.new(:spec) do |t|
+  #       t.spec_opts = ['--options', "spec/spec.opts"]
+  #       t.spec_files = FileList['spec/**/*_spec.rb']
+  #     end
+  #   end
+  #
+  module RakeCompat
+    def self.rake_classes
+      @rake_classes ||= []
+    end
+
+    def self.included(base)
+      # Hack. Make rakefile point to invoker, so rdoc task is generated properly.
+      Rake.application.instance_variable_set(:@rakefile, caller[0].match(/(.*):\d+/)[1])
+      self.rake_classes << base
+    end
+  end
+end
+
+class Object #:nodoc:
+  alias :rake_task :task
+  alias :rake_namespace :namespace
+
+  def task(*args, &block)
+    task = rake_task(*args, &block)
+
+    if klass = Thor::RakeCompat.rake_classes.last
+      non_namespaced_name = task.name.split(':').last
+
+      description = non_namespaced_name
+      description << task.arg_names.map{ |n| n.to_s.upcase }.join(' ')
+      description.strip!
+
+      klass.desc description, task.comment || non_namespaced_name
+      klass.class_eval <<-METHOD
+        def #{non_namespaced_name}(#{task.arg_names.join(', ')})
+          Rake::Task[#{task.name.to_sym.inspect}].invoke(#{task.arg_names.join(', ')})
+        end
+      METHOD
+    end
+
+    task
+  end
+
+  def namespace(name, &block)
+    if klass = Thor::RakeCompat.rake_classes.last
+      const_name = Thor::Util.camel_case(name.to_s).to_sym
+      klass.const_set(const_name, Class.new(Thor))
+      new_klass = klass.const_get(const_name)
+      Thor::RakeCompat.rake_classes << new_klass
+    end
+
+    rake_namespace(name, &block)
+    Thor::RakeCompat.rake_classes.pop
+  end
+end

data/lib/thor/runner.rb

@@ -12,8 +12,9 @@ class Thor::Runner < Thor #:nodoc:
   def help(meth=nil)
     if meth && !self.respond_to?(meth)
       initialize_thorfiles(meth)
-      klass, task = Thor::Util.namespace_to_thor_class(meth)
-      klass.start(["-h", task].compact, :shell => self.shell) # send mapping -h because it works with Thor::Group too
+      klass, task = Thor::Util.namespace_to_thor_class_and_task(meth)
+      # Send mapping -h because it works with Thor::Group too
+      klass.start(["-h", task].compact, :shell => self.shell)
     else
       super
     end
@@ -25,12 +26,12 @@ class Thor::Runner < Thor #:nodoc:
   def method_missing(meth, *args)
     meth = meth.to_s
     initialize_thorfiles(meth)
-    klass, task = Thor::Util.namespace_to_thor_class(meth)
+    klass, task = Thor::Util.namespace_to_thor_class_and_task(meth)
     args.unshift(task) if task
     klass.start(args, :shell => shell)
   end
 
-  desc "install NAME", "Install a Thor file into your system tasks, optionally named for future updates"
+  desc "install NAME", "Install an optionally named Thor file into your system tasks"
   method_options :as => :string, :relative => :boolean
   def install(name)
     initialize_thorfiles
@@ -76,7 +77,7 @@ class Thor::Runner < Thor #:nodoc:
     thor_yaml[as] = {
       :filename   => Digest::MD5.hexdigest(name + as),
       :location   => location,
-      :namespaces => Thor::Util.namespaces_in_contents(contents, base)
+      :namespaces => Thor::Util.namespaces_in_content(contents, base)
     }
 
     save_yaml(thor_yaml)
@@ -130,8 +131,7 @@ class Thor::Runner < Thor #:nodoc:
     display_klasses(true, klasses)
   end
 
-  desc "list [SEARCH]",
-       "List the available thor tasks (--substring means SEARCH anywhere in the namespace)"
+  desc "list [SEARCH]", "List the available thor tasks (--substring means .*SEARCH)"
   method_options :substring => :boolean, :group => :string, :all => :boolean
   def list(search="")
     initialize_thorfiles
@@ -269,6 +269,10 @@ class Thor::Runner < Thor #:nodoc:
       end
 
       unless klasses.empty?
+        klasses.dup.each do |klass|
+          klasses -= Thor::Util.thor_classes_in(klass)
+        end
+
         klasses.each { |k| display_tasks(k) }
       else
         say "\033[1;34mNo Thor tasks available\033[0m"
@@ -285,7 +289,7 @@ class Thor::Runner < Thor #:nodoc:
         say shell.set_color(base, color, true)
         say "-" * base.length
 
-        klass.help(shell, :short => true, :namespace => true)
+        klass.help(shell, :short => true, :ident => 0, :namespace => true)
       end
     end
 end

data/lib/thor/shell/basic.rb

@@ -80,17 +80,21 @@ class Thor
       #
       # ==== Parameters
       # list<Array[String, String, ...]>
-      # mode<Symbol>:: Can be :rows or :inline. Defaults to :rows.
       #
-      def print_list(list, mode=:rows)
+      # ==== Options
+      # mode:: Can be :rows or :inline. Defaults to :rows.
+      # ident:: Ident each item with the value given.
+      #
+      def print_list(list, options={})
         return if list.empty?
 
-        content = case mode
+        ident   = " " * (options[:ident] || 0)
+        content = case options[:mode]
           when :inline
             last = list.pop
             "#{list.join(", ")}, and #{last}"
           else # rows
-            list.join("\n")
+            ident + list.join("\n#{ident}")
         end
 
         $stdout.puts content

data/lib/thor/task.rb

@@ -38,7 +38,15 @@ class Thor
     #
     def formatted_usage(klass=nil, namespace=false, show_options=true)
       formatted = ''
-      formatted << "#{klass.namespace.gsub(/^default/,'')}:" if klass && namespace
+
+      formatted = if namespace.is_a?(String)
+        "#{namespace}:"
+      elsif klass && namespace
+        "#{klass.namespace.gsub(/^default/,'')}:"
+      else
+        ""
+      end
+
       formatted << formatted_arguments(klass)
       formatted << " #{formatted_options}" if show_options
       formatted.strip!

data/lib/thor/util.rb

@@ -8,8 +8,7 @@ class Thor
   #
   # 1) Methods to convert thor namespaces to constants and vice-versa.
   #
-  #   Thor::Utils.constant_to_namespace(Foo::Bar::Baz) #=> "foo:bar:baz"
-  #   Thor::Utils.namespace_to_constant("foo:bar:baz") #=> Foo::Bar::Baz
+  #   Thor::Utils.namespace_from_thor_class(Foo::Bar::Baz) #=> "foo:bar:baz"
   #
   # 2) Loading thor files and sandboxing:
   #
@@ -44,15 +43,15 @@ class Thor
     # ==== Returns
     # String:: If we receive Foo::Bar::Baz it returns "foo:bar:baz"
     #
-    def self.constant_to_namespace(constant, remove_default=true)
+    def self.namespace_from_thor_class(constant, remove_default=true)
       constant = constant.to_s.gsub(/^Thor::Sandbox::/, "")
       constant = snake_case(constant).squeeze(":")
       constant.gsub!(/^default/, '') if remove_default
       constant
     end
 
-    # Given the contents, evaluate it inside the sandbox and returns the thor
-    # classes defined in the sandbox.
+    # Given the contents, evaluate it inside the sandbox and returns the
+    # namespaces defined in the sandbox.
     #
     # ==== Parameters
     # contents<String>
@@ -60,7 +59,7 @@ class Thor
     # ==== Returns
     # Array[Object]
     #
-    def self.namespaces_in_contents(contents, file=__FILE__)
+    def self.namespaces_in_content(contents, file=__FILE__)
       old_constants = Thor::Base.subclasses.dup
       Thor::Base.subclasses.clear
 
@@ -74,6 +73,14 @@ class Thor
       new_constants
     end
 
+    # Returns the thor classes declared inside the given class.
+    #
+    def self.thor_classes_in(klass)
+      Thor::Base.subclasses.select do |subclass|
+        klass.constants.include?(subclass.name.gsub("#{klass.name}::", ''))
+      end
+    end
+
     # Receives a string and convert it to snake case. SnakeCase returns snake_case.
     #
     # ==== Parameters
@@ -88,6 +95,19 @@ class Thor
       return $+.downcase
     end
 
+    # Receives a string and convert it to camel case. camel_case returns CamelCase.
+    #
+    # ==== Parameters
+    # String
+    #
+    # ==== Returns
+    # String
+    #
+    def self.camel_case(str)
+      return str if str !~ /_/ && str =~ /[A-Z]+.*/
+      str.split('_').map { |i| i.capitalize }.join
+    end
+
     # Receives a namespace and tries to retrieve a Thor or Thor::Group class
     # from it. It first searches for a class using the all the given namespace,
     # if it's not found, removes the highest entry and searches for the class
@@ -116,7 +136,7 @@ class Thor
     # Thor::Error:: raised if the namespace evals to a class which does not
     #               inherit from Thor or Thor::Group.
     #
-    def self.namespace_to_thor_class(namespace, raise_if_nil=true)
+    def self.namespace_to_thor_class_and_task(namespace, raise_if_nil=true)
       klass, task_name = Thor::Util.find_by_namespace(namespace), nil
 
       if klass.nil? && namespace.include?(?:)
@@ -157,7 +177,7 @@ class Thor
       yaml.each do |k, v|
         next unless v[:constants] && v[:namespaces].nil?
         yaml_changed = true
-        yaml[k][:namespaces] = v[:constants].map{|c| Thor::Util.constant_to_namespace(c)}
+        yaml[k][:namespaces] = v[:constants].map{|c| Thor::Util.namespace_from_thor_class(c)}
       end
 
       yaml_changed

data/spec/actions/create_file_spec.rb

@@ -0,0 +1,170 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'thor/actions'
+
+describe Thor::Actions::CreateFile do
+  before(:each) do
+    ::FileUtils.rm_rf(destination_root)
+  end
+
+  def create_file(destination=nil, config={}, options={})
+    @base = MyCounter.new([1,2], options, { :destination_root => destination_root })
+    stub(@base).file_name { 'rdoc' }
+
+    @action = Thor::Actions::CreateFile.new(@base, destination, "CONFIGURATION",
+                                            { :verbose => !@silence }.merge(config))
+  end
+
+  def invoke!
+    capture(:stdout){ @action.invoke! }
+  end
+
+  def revoke!
+    capture(:stdout){ @action.revoke! }
+  end
+
+  def silence!
+    @silence = true
+  end
+
+  describe "#invoke!" do
+    it "creates a file" do
+      create_file("doc/config.rb")
+      invoke!
+      File.exists?(File.join(destination_root, "doc/config.rb")).must be_true
+    end
+
+    it "does not create a file if pretending" do
+      create_file("doc/config.rb", {}, :pretend => true)
+      invoke!
+      File.exists?(File.join(destination_root, "doc/config.rb")).must be_false
+    end
+
+    it "shows created status to the user" do
+      create_file("doc/config.rb")
+      invoke!.must == "      create  doc/config.rb\n"
+    end
+
+    it "does not show any information if log status is false" do
+      silence!
+      create_file("doc/config.rb")
+      invoke!.must be_empty
+    end
+
+    it "returns the destination" do
+      capture(:stdout) do
+        create_file("doc/config.rb").invoke!.must == File.join(destination_root, "doc/config.rb")
+      end
+    end
+
+    it "converts encoded instructions" do
+      create_file("doc/%file_name%.rb.tt")
+      invoke!
+      File.exists?(File.join(destination_root, "doc/rdoc.rb.tt")).must be_true
+    end
+
+    describe "when file exists" do
+      before(:each) do
+        create_file("doc/config.rb")
+        invoke!
+      end
+
+      describe "and is identical" do
+        it "shows identical status" do
+          create_file("doc/config.rb")
+          invoke!
+          invoke!.must == "   identical  doc/config.rb\n"
+        end
+      end
+
+      describe "and is not identical" do
+        before(:each) do
+          File.open(File.join(destination_root, 'doc/config.rb'), 'w'){ |f| f.write("FOO = 3") }
+        end
+
+        it "shows forced status to the user if force is given" do
+          create_file("doc/config.rb", {}, :force => true).must_not be_identical
+          invoke!.must == "       force  doc/config.rb\n"
+        end
+
+        it "shows skipped status to the user if skip is given" do
+          create_file("doc/config.rb", {}, :skip => true).must_not be_identical
+          invoke!.must == "        skip  doc/config.rb\n"
+        end
+
+        it "shows forced status to the user if force is configured" do
+          create_file("doc/config.rb", :force => true).must_not be_identical
+          invoke!.must == "       force  doc/config.rb\n"
+        end
+
+        it "shows skipped status to the user if skip is configured" do
+          create_file("doc/config.rb", :skip => true).must_not be_identical
+          invoke!.must == "        skip  doc/config.rb\n"
+        end
+
+        it "shows conflict status to ther user" do
+          create_file("doc/config.rb").must_not be_identical
+          mock($stdin).gets{ 's' }
+          file = File.join(destination_root, 'doc/config.rb')
+
+          content = invoke!
+          content.must =~ /conflict  doc\/config\.rb/
+          content.must =~ /Overwrite #{file}\? \(enter "h" for help\) \[Ynaqdh\]/
+          content.must =~ /skip  doc\/config\.rb/
+        end
+
+        it "creates the file if the file collision menu returns true" do
+          create_file("doc/config.rb")
+          mock($stdin).gets{ 'y' }
+          invoke!.must =~ /force  doc\/config\.rb/
+        end
+
+        it "skips the file if the file collision menu returns false" do
+          create_file("doc/config.rb")
+          mock($stdin).gets{ 'n' }
+          invoke!.must =~ /skip  doc\/config\.rb/
+        end
+
+        it "executes the block given to show file content" do
+          create_file("doc/config.rb")
+          mock($stdin).gets{ 'd' }
+          mock($stdin).gets{ 'n' }
+          mock(@base.shell).system(/diff -u/)
+          invoke!
+        end
+      end
+    end
+  end
+
+  describe "#revoke!" do
+    it "removes the destination file" do
+      create_file("doc/config.rb")
+      invoke!
+      revoke!
+      File.exists?(@action.destination).must be_false
+    end
+
+    it "does not raise an error if the file does not exist" do
+      create_file("doc/config.rb")
+      revoke!
+      File.exists?(@action.destination).must be_false
+    end
+  end
+
+  describe "#exists?" do
+    it "returns true if the destination file exists" do
+      create_file("doc/config.rb")
+      @action.exists?.must be_false
+      invoke!
+      @action.exists?.must be_true
+    end
+  end
+
+  describe "#identical?" do
+    it "returns true if the destination file and is identical" do
+      create_file("doc/config.rb")
+      @action.identical?.must be_false
+      invoke!
+      @action.identical?.must be_true
+    end
+  end
+end