thor-exclude_pattern 0.18.0

data/lib/thor/version.rb

@@ -0,0 +1,3 @@
+class Thor
+  VERSION = "0.17.0"
+end

data/spec/actions/create_file_spec.rb

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

data/spec/actions/create_link_spec.rb

@@ -0,0 +1,95 @@
+require 'helper'
+require 'thor/actions'
+require 'tempfile'
+
+describe Thor::Actions::CreateLink do
+  before do
+    @hardlink_to = File.join(Dir.tmpdir, 'linkdest.rb')
+    ::FileUtils.rm_rf(destination_root)
+    ::FileUtils.rm_rf(@hardlink_to)
+  end
+
+  def create_link(destination=nil, config={}, options={})
+    @base = MyCounter.new([1,2], options, { :destination_root => destination_root })
+    @base.stub!(:file_name).and_return('rdoc')
+
+    @tempfile = Tempfile.new("config.rb")
+
+    @action = Thor::Actions::CreateLink.new(@base, destination, @tempfile.path,
+                                            { :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 symbolic link for :symbolic => true" do
+      create_link("doc/config.rb", :symbolic => true)
+      invoke!
+      destination_path = File.join(destination_root, "doc/config.rb")
+      expect(File.exists?(destination_path)).to be_true
+      expect(File.symlink?(destination_path)).to be_true
+    end
+
+    it "creates a hard link for :symbolic => false" do
+      create_link(@hardlink_to, :symbolic => false)
+      invoke!
+      destination_path = @hardlink_to
+      expect(File.exists?(destination_path)).to be_true
+      expect(File.symlink?(destination_path)).to be_false
+    end
+
+    it "creates a symbolic link by default" do
+      create_link("doc/config.rb")
+      invoke!
+      destination_path = File.join(destination_root, "doc/config.rb")
+      expect(File.exists?(destination_path)).to be_true
+      expect(File.symlink?(destination_path)).to be_true
+    end
+
+    it "does not create a link if pretending" do
+      create_link("doc/config.rb", {}, :pretend => true)
+      invoke!
+      expect(File.exists?(File.join(destination_root, "doc/config.rb"))).to be_false
+    end
+
+    it "shows created status to the user" do
+      create_link("doc/config.rb")
+      expect(invoke!).to eq("      create  doc/config.rb\n")
+    end
+
+    it "does not show any information if log status is false" do
+      silence!
+      create_link("doc/config.rb")
+      expect(invoke!).to be_empty
+    end
+  end
+
+  describe "#identical?" do
+    it "returns true if the destination link exists and is identical" do
+      create_link("doc/config.rb")
+      expect(@action.identical?).to be_false
+      invoke!
+      expect(@action.identical?).to be_true
+    end
+  end
+
+  describe "#revoke!" do
+    it "removes the symbolic link of non-existent destination" do
+      create_link("doc/config.rb")
+      invoke!
+      File.delete(@tempfile.path)
+      revoke!
+      expect(File.symlink?(@action.destination)).to be_false
+    end
+  end
+end

data/spec/actions/directory_spec.rb

@@ -0,0 +1,169 @@
+require 'helper'
+require 'thor/actions'
+
+describe Thor::Actions::Directory do
+  before do
+    ::FileUtils.rm_rf(destination_root)
+    invoker.stub!(:file_name).and_return("rdoc")
+  end
+
+  def invoker
+    @invoker ||= WhinyGenerator.new([1,2], {}, { :destination_root => destination_root })
+  end
+
+  def revoker
+    @revoker ||= WhinyGenerator.new([1,2], {}, { :destination_root => destination_root, :behavior => :revoke })
+  end
+
+  def invoke!(*args, &block)
+    capture(:stdout){ invoker.directory(*args, &block) }
+  end
+
+  def revoke!(*args, &block)
+    capture(:stdout){ revoker.directory(*args, &block) }
+  end
+
+  def exists_and_identical?(source_path, destination_path)
+    %w(config.rb README).each do |file|
+      source      = File.join(source_root, source_path, file)
+      destination = File.join(destination_root, destination_path, file)
+
+      expect(File.exists?(destination)).to be_true
+      expect(FileUtils.identical?(source, destination)).to be_true
+    end
+  end
+
+  describe "#invoke!" do
+    it "raises an error if the source does not exist" do
+      expect {
+        invoke! "unknown"
+      }.to raise_error(Thor::Error, /Could not find "unknown" in any of your source paths/)
+    end
+
+    it "does not create a directory in pretend mode" do
+      invoke! "doc", "ghost", :pretend => true
+      expect(File.exists?("ghost")).to be_false
+    end
+
+    it "copies the whole directory recursively to the default destination" do
+      invoke! "doc"
+      exists_and_identical?("doc", "doc")
+    end
+
+    it "copies the whole directory recursively to the specified destination" do
+      invoke! "doc", "docs"
+      exists_and_identical?("doc", "docs")
+    end
+
+    it "copies only the first level files if recursive" do
+      invoke! ".", "commands", :recursive => false
+
+      file = File.join(destination_root, "commands", "group.thor")
+      expect(File.exists?(file)).to be_true
+
+      file = File.join(destination_root, "commands", "doc")
+      expect(File.exists?(file)).to be_false
+
+      file = File.join(destination_root, "commands", "doc", "README")
+      expect(File.exists?(file)).to be_false
+    end
+
+    it "ignores files within excluding/ directories when exclude_pattern is provided" do
+      invoke! "doc", "docs", :exclude_pattern => /excluding\//
+      file = File.join(destination_root, "docs", "excluding", "rdoc.rb")
+      expect(File.exists?(file)).to be_false
+    end
+
+    it "copies and evalutes files within excluding/ directory when no exclude_pattern is present" do
+      invoke! "doc", "docs"
+      file = File.join(destination_root, "docs", "excluding", "rdoc.rb")
+      expect(File.exists?(file)).to be_true
+      expect(File.read(file)).to eq("BAR = BAR\n")
+    end
+
+    it "copies files from the source relative to the current path" do
+      invoker.inside "doc" do
+        invoke! "."
+      end
+      exists_and_identical?("doc", "doc")
+    end
+
+    it "copies and evaluates templates" do
+      invoke! "doc", "docs"
+      file = File.join(destination_root, "docs", "rdoc.rb")
+      expect(File.exists?(file)).to be_true
+      expect(File.read(file)).to eq("FOO = FOO\n")
+    end
+
+    it "copies directories and preserved file mode" do
+      invoke! "preserve", "preserved", :mode => :preserve
+      original = File.join(source_root, "preserve", "script.sh")
+      copy = File.join(destination_root, "preserved", "script.sh")
+      expect(File.stat(original).mode).to eq(File.stat(copy).mode)
+    end
+
+    it "copies directories" do
+      invoke! "doc", "docs"
+      file = File.join(destination_root, "docs", "components")
+      expect(File.exists?(file)).to be_true
+      expect(File.directory?(file)).to be_true
+    end
+
+    it "does not copy .empty_directory files" do
+      invoke! "doc", "docs"
+      file = File.join(destination_root, "docs", "components", ".empty_directory")
+      expect(File.exists?(file)).to be_false
+    end
+
+    it "copies directories even if they are empty" do
+      invoke! "doc/components", "docs/components"
+      file = File.join(destination_root, "docs", "components")
+      expect(File.exists?(file)).to be_true
+    end
+
+    it "does not copy empty directories twice" do
+      content = invoke!("doc/components", "docs/components")
+      expect(content).not_to match(/exist/)
+    end
+
+    it "logs status" do
+      content = invoke!("doc")
+      expect(content).to match(/create  doc\/README/)
+      expect(content).to match(/create  doc\/config\.rb/)
+      expect(content).to match(/create  doc\/rdoc\.rb/)
+      expect(content).to match(/create  doc\/components/)
+    end
+
+    it "yields a block" do
+      checked = false
+      invoke!("doc") do |content|
+        checked ||= !!(content =~ /FOO/)
+      end
+      expect(checked).to be_true
+    end
+
+    it "works with glob characters in the path" do
+      content = invoke!("app{1}")
+      expect(content).to match(/create  app\{1\}\/README/)
+    end
+  end
+
+  describe "#revoke!" do
+    it "removes the destination file" do
+      invoke! "doc"
+      revoke! "doc"
+
+      expect(File.exists?(File.join(destination_root, "doc", "README"))).to be_false
+      expect(File.exists?(File.join(destination_root, "doc", "config.rb"))).to be_false
+      expect(File.exists?(File.join(destination_root, "doc", "components"))).to be_false
+    end
+
+    it "works with glob characters in the path" do
+      invoke! "app{1}"
+      expect(File.exists?(File.join(destination_root, "app{1}", "README"))).to be_true
+
+      revoke! "app{1}"
+      expect(File.exists?(File.join(destination_root, "app{1}", "README"))).to be_false
+    end
+  end
+end

data/spec/actions/empty_directory_spec.rb

@@ -0,0 +1,130 @@
+require 'helper'
+require 'thor/actions'
+
+describe Thor::Actions::EmptyDirectory do
+  before do
+    ::FileUtils.rm_rf(destination_root)
+  end
+
+  def empty_directory(destination, options={})
+    @action = Thor::Actions::EmptyDirectory.new(base, destination)
+  end
+
+  def invoke!
+    capture(:stdout) { @action.invoke! }
+  end
+
+  def revoke!
+    capture(:stdout) { @action.revoke! }
+  end
+
+  def base
+    @base ||= MyCounter.new([1,2], {}, { :destination_root => destination_root })
+  end
+
+  describe "#destination" do
+    it "returns the full destination with the destination_root" do
+      expect(empty_directory('doc').destination).to eq(File.join(destination_root, 'doc'))
+    end
+
+    it "takes relative root into account" do
+      base.inside('doc') do
+        expect(empty_directory('contents').destination).to eq(File.join(destination_root, 'doc', 'contents'))
+      end
+    end
+  end
+
+  describe "#relative_destination" do
+    it "returns the relative destination to the original destination root" do
+      base.inside('doc') do
+        expect(empty_directory('contents').relative_destination).to eq('doc/contents')
+      end
+    end
+  end
+
+  describe "#given_destination" do
+    it "returns the destination supplied by the user" do
+      base.inside('doc') do
+        expect(empty_directory('contents').given_destination).to eq('contents')
+      end
+    end
+  end
+
+  describe "#invoke!" do
+    it "copies the file to the specified destination" do
+      empty_directory("doc")
+      invoke!
+      expect(File.exists?(File.join(destination_root, "doc"))).to be_true
+    end
+
+    it "shows created status to the user" do
+      empty_directory("doc")
+      expect(invoke!).to eq("      create  doc\n")
+    end
+
+    it "does not create a directory if pretending" do
+      base.inside("foo", :pretend => true) do
+        empty_directory("ghost")
+      end
+      expect(File.exists?(File.join(base.destination_root, "ghost"))).to be_false
+    end
+
+    describe "when directory exists" do
+      it "shows exist status" do
+        empty_directory("doc")
+        invoke!
+        expect(invoke!).to eq("       exist  doc\n")
+      end
+    end
+  end
+
+  describe "#revoke!" do
+    it "removes the destination file" do
+      empty_directory("doc")
+      invoke!
+      revoke!
+      expect(File.exists?(@action.destination)).to be_false
+    end
+  end
+
+  describe "#exists?" do
+    it "returns true if the destination file exists" do
+      empty_directory("doc")
+      expect(@action.exists?).to be_false
+      invoke!
+      expect(@action.exists?).to be_true
+    end
+  end
+
+  context "protected methods" do
+    describe "#convert_encoded_instructions" do
+      before do
+        empty_directory("test_dir")
+        @action.base.stub!(:file_name).and_return("expected")
+      end
+
+      it "accepts and executes a 'legal' %\w+% encoded instruction" do
+        expect(@action.send(:convert_encoded_instructions, "%file_name%.txt")).to eq("expected.txt")
+      end
+
+      it "ignores an 'illegal' %\w+% encoded instruction" do
+        expect(@action.send(:convert_encoded_instructions, "%some_name%.txt")).to eq("%some_name%.txt")
+      end
+
+      it "ignores incorrectly encoded instruction" do
+        expect(@action.send(:convert_encoded_instructions, "%some.name%.txt")).to eq("%some.name%.txt")
+      end
+
+      it "raises an error if the instruction refers to a private method" do
+        module PrivExt
+          private
+          def private_file_name
+            "something_hidden"
+          end
+        end
+        @action.base.extend(PrivExt)
+        expect { @action.send(:convert_encoded_instructions, "%private_file_name%.txt") }.to raise_error Thor::PrivateMethodEncodedError
+      end
+    end
+  end
+end