thor 0.9.9 → 0.11.5

data/lib/thor/util.rb

@@ -1,75 +1,250 @@
-require 'thor/error'
+require 'rbconfig'
 
-module ObjectSpace
-  
-  class << self
-
-    # @return <Array[Class]> All the classes in the object space.
-    def classes
-      klasses = []
-      ObjectSpace.each_object(Class) {|o| klasses << o}
-      klasses
-    end
+class Thor
+  module Sandbox #:nodoc:
   end
-  
-end
 
-class Thor
-  module Tasks; end
-  
+  # This module holds several utilities:
+  #
+  # 1) Methods to convert thor namespaces to constants and vice-versa.
+  #
+  #   Thor::Utils.namespace_from_thor_class(Foo::Bar::Baz) #=> "foo:bar:baz"
+  #
+  # 2) Loading thor files and sandboxing:
+  #
+  #   Thor::Utils.load_thorfile("~/.thor/foo")
+  #
   module Util
-    
-    def self.full_const_get(obj, name)
-      list = name.split("::")
-      list.shift if list.first.empty?
-      list.each do |x| 
-        # This is required because const_get tries to look for constants in the 
-        # ancestor chain, but we only want constants that are HERE
-        obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
+
+    # Receives a namespace and search for it in the Thor::Base subclasses.
+    #
+    # ==== Parameters
+    # namespace<String>:: The namespace to search for.
+    #
+    def self.find_by_namespace(namespace)
+      namespace = "default#{namespace}" if namespace.empty? || namespace =~ /^:/
+
+      Thor::Base.subclasses.find do |klass|
+        klass.namespace == namespace
       end
-      obj
-    end
-    
-    def self.constant_to_thor_path(str, remove_default = true)
-      str = str.to_s.gsub(/^Thor::Tasks::/, "")
-      str = snake_case(str).squeeze(":")
-      str.gsub!(/^default/, '') if remove_default
-      str
     end
 
-    def self.constant_from_thor_path(str)
-      make_constant(to_constant(str))
-    rescue NameError => e
-      raise e unless e.message =~ /^uninitialized constant (.*)$/
-      raise Error, "There was no available namespace `#{str}'."
+    # Receives a constant and converts it to a Thor namespace. Since Thor tasks
+    # can be added to a sandbox, this method is also responsable for removing
+    # the sandbox namespace.
+    #
+    # This method should not be used in general because it's used to deal with
+    # older versions of Thor. On current versions, if you need to get the
+    # namespace from a class, just call namespace on it.
+    #
+    # ==== Parameters
+    # constant<Object>:: The constant to be converted to the thor path.
+    #
+    # ==== Returns
+    # String:: If we receive Foo::Bar::Baz it returns "foo:bar:baz"
+    #
+    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
 
-    def self.to_constant(str)
-      str = 'default' if str.empty?
-      str.gsub(/:(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-    end
+    # Given the contents, evaluate it inside the sandbox and returns the
+    # namespaces defined in the sandbox.
+    #
+    # ==== Parameters
+    # contents<String>
+    #
+    # ==== Returns
+    # Array[Object]
+    #
+    def self.namespaces_in_content(contents, file=__FILE__)
+      old_constants = Thor::Base.subclasses.dup
+      Thor::Base.subclasses.clear
 
-    def self.constants_in_contents(str, file = __FILE__)
-      klasses = ObjectSpace.classes.dup
-      Module.new.class_eval(str, file)
-      klasses = ObjectSpace.classes - klasses
-      klasses = klasses.select {|k| k < Thor }
-      klasses.map! {|k| k.to_s.gsub(/#<Module:\w+>::/, '')}
+      load_thorfile(file, contents)
+
+      new_constants = Thor::Base.subclasses.dup
+      Thor::Base.subclasses.replace(old_constants)
+
+      new_constants.map!{ |c| c.namespace }
+      new_constants.compact!
+      new_constants
     end
 
-    def self.make_constant(str, base = [Thor::Tasks, Object])
-      which = base.find do |obj|
-        full_const_get(obj, str) rescue nil
+    # 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
-      return full_const_get(which, str) if which
-      raise NameError, "uninitialized constant #{str}"
     end
-    
+
+    # Receives a string and convert it to snake case. SnakeCase returns snake_case.
+    #
+    # ==== Parameters
+    # String
+    #
+    # ==== Returns
+    # String
+    #
     def self.snake_case(str)
       return str.downcase if str =~ /^[A-Z_]+$/
       str.gsub(/\B[A-Z]/, '_\&').squeeze('_') =~ /_*(.*)/
       return $+.downcase
-    end  
-    
+    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
+    # again. If found, returns the highest entry as the class name.
+    #
+    # ==== Examples
+    #
+    #   class Foo::Bar < Thor
+    #     def baz
+    #     end
+    #   end
+    #
+    #   class Baz::Foo < Thor::Group
+    #   end
+    #
+    #   Thor::Util.namespace_to_thor_class("foo:bar")     #=> Foo::Bar, nil # will invoke default task
+    #   Thor::Util.namespace_to_thor_class("baz:foo")     #=> Baz::Foo, nil
+    #   Thor::Util.namespace_to_thor_class("foo:bar:baz") #=> Foo::Bar, "baz"
+    #
+    # ==== Parameters
+    # namespace<String>
+    #
+    # ==== Errors
+    # Thor::Error:: raised if the namespace cannot be found.
+    #
+    # 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_and_task(namespace, raise_if_nil=true)
+      klass, task_name = Thor::Util.find_by_namespace(namespace), nil
+
+      if klass.nil? && namespace.include?(?:)
+        namespace = namespace.split(":")
+        task_name = namespace.pop
+        klass     = Thor::Util.find_by_namespace(namespace.join(":"))
+      end
+
+      raise Error, "could not find Thor class or task '#{namespace}'" if raise_if_nil && klass.nil?
+
+      return klass, task_name
+    end
+
+    # Receives a path and load the thor file in the path. The file is evaluated
+    # inside the sandbox to avoid namespacing conflicts.
+    #
+    def self.load_thorfile(path, content=nil)
+      content ||= File.read(path)
+
+      begin
+        Thor::Sandbox.class_eval(content, path)
+      rescue Exception => e
+        $stderr.puts "WARNING: unable to load thorfile #{path.inspect}: #{e.message}"
+      end
+    end
+
+    # Receives a yaml (hash) and updates all constants entries to namespace.
+    # This was added to deal with deprecated versions of Thor.
+    #
+    # TODO Deprecate this method in the future.
+    #
+    # ==== Returns
+    # TrueClass|FalseClass:: Returns true if any change to the yaml file was made.
+    #
+    def self.convert_constants_to_namespaces(yaml)
+      yaml_changed = false
+
+      yaml.each do |k, v|
+        next unless v[:constants] && v[:namespaces].nil?
+        yaml_changed = true
+        yaml[k][:namespaces] = v[:constants].map{|c| Thor::Util.namespace_from_thor_class(c)}
+      end
+
+      yaml_changed
+    end
+
+    def self.user_home
+      @@user_home ||= if ENV["HOME"]
+        ENV["HOME"]
+      elsif ENV["USERPROFILE"]
+        ENV["USERPROFILE"]
+      elsif ENV["HOMEDRIVE"] && ENV["HOMEPATH"]
+        File.join(ENV["HOMEDRIVE"], ENV["HOMEPATH"])
+      elsif ENV["APPDATA"]
+        ENV["APPDATA"]
+      else
+        begin
+          File.expand_path("~")
+        rescue
+          if File::ALT_SEPARATOR
+            "C:/"
+          else
+            "/"
+          end
+        end
+      end
+    end
+
+    # Returns the root where thor files are located, dependending on the OS.
+    #
+    def self.thor_root
+      File.join(user_home, ".thor")
+    end
+
+    # Returns the files in the thor root. On Windows thor_root will be something
+    # like this:
+    #
+    #   C:\Documents and Settings\james\.thor
+    #
+    # If we don't #gsub the \ character, Dir.glob will fail.
+    #
+    def self.thor_root_glob
+      files = Dir["#{thor_root.gsub(/\\/, '/')}/*"]
+
+      files.map! do |file|
+        File.directory?(file) ? File.join(file, "main.thor") : file
+      end
+    end
+
+    # Where to look for Thor files.
+    #
+    def self.globs_for(path)
+      ["#{path}/Thorfile", "#{path}/*.thor", "#{path}/tasks/*.thor", "#{path}/lib/tasks/*.thor"]
+    end
+
+    # Return the path to the ruby interpreter taking into account multiple
+    # installations and windows extensions.
+    #
+    def self.ruby_command
+      @ruby_command ||= begin
+        ruby = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+        ruby << Config::CONFIG['EXEEXT']
+
+        # escape string in case path to ruby executable contain spaces.
+        ruby.sub!(/.*\s.*/m, '"\&"')
+        ruby
+      end
+    end
+
   end
 end

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