mergit 1.0.0 → 1.1.0

data/README.md

@@ -27,7 +27,7 @@ Mergit uses simple text processing, therefore it can be tripped up.  Some known
 
 Add this line to your application's Gemfile:
 
-    gem 'mergit', '~> 1.0'
+    gem 'mergit', '~> 1.1'
 
 And then execute:
 

data/lib/mergit/processor.rb

@@ -13,6 +13,10 @@ class Mergit
     # @return {Hash} A frozen hash with the rules for replacements.
     attr_reader :replacements
 
+    # All `require`d files will have 'MERGIT' start and end comments around them showing what file was included.
+    #
+    # The initial `:filename` or `:string` will not have 'MERGIT' comments.
+    #
     # @param [Array<Pathname, String>] search_path The list of directories to search.
     # @param [Hash] replacements A list of keywords to replace.
     # @param [Hash] options Either `:filename` or `:string` should be set.
@@ -24,7 +28,7 @@ class Mergit
       @output = StringIO.new
       begin
         if options.key?(:filename)
-          scan_file(Pathname.new(options[:filename]).realpath)
+          Pathname.new(options[:filename]).open('r') { |fp| scan(fp.read) }
         elsif options.key?(:string)
           scan(options[:string])
         end
@@ -35,32 +39,17 @@ class Mergit
 
     # Finds a library using the {#search_path}
     #
-    # @param [String] lib_name The name of the library to look for.
+    # @param [String, Pathname] filename The name of the library to look for.
     # @return [Nil, Pathname] Returns `nil` if it isn't found or a {http://rubydoc.info/stdlib/pathname/frames Pathname} if it is found.
-    def find_requirement lib_name
+    def find_requirement filename
+      filename = Pathname.new filename
       @search_path.each do |directory|
-        possible_path = directory + "#{lib_name}.rb"
+        possible_path = directory + filename.dirname + "#{filename.basename('.rb')}.rb"
         return possible_path.realpath if possible_path.file?
       end
       nil
     end
 
-
-    # Finds a library using the {#search_path}
-    #
-    # This is identical to {#find_requirement} except it raises {Mergit::RequirementNotFound} if
-    # it fails to find the library.
-    #
-    # @raise [Mergit::RequirementNotFound] if it can't find the library.
-    # @param (see #find_requirement)
-    # @return [Pathname] Returns the {http://rubydoc.info/stdlib/pathname/frames Pathname} of the library.
-    # @see #find_requirement
-    def find_requirement! lib_name
-      find_requirement(lib_name).tap do |retval|
-        raise Mergit::RequirementNotFound.new("Unabled to find require'd file: #{lib_name}") if retval.nil?
-      end
-    end
-
     ## Scans a single line of the file.
     #
     # It looks for things that need to be changed, and {#emit}s the resulting
@@ -72,13 +61,8 @@ class Mergit
       line.chomp!
       if line =~ /#\s*MERGIT:\s*skip\s*$/
         nil # do nothing
-      elsif line =~ /^\s*require\s+'([^']+)'\s*$/ or line =~ /^\s*require\s+"([^"]+)"\s*$/
-        requirement = find_requirement($1)
-        if requirement.nil?
-          emit line
-        else
-          scan_file requirement
-        end
+      elsif line =~ /^\s*require\s+'([^']+)'/ or line =~ /^\s*require\s+"([^"]+)"/
+        scan_file($1) or emit(line)
       else
         replacements.each_key do |string_to_replace|
           line.gsub!(string_to_replace, replacements[string_to_replace])
@@ -91,27 +75,27 @@ class Mergit
     #
     # It passes each line of the file to {#scan_line} for parsing.
     #
+    # If the `filename` was already scanned, it'll do nothing and return `true`.
+    #
+    # If the `filename` doesn't exist in the {#search_path}, then it'll return `false`.
+    #
     # @param [Pathname] filename The file to scan.
-    # @return [Nil]
+    # @return [FalseClass, TrueClass] Returns true if the file was emitted. Returns false if it cannot find the file in {#search_path}
     def scan_file filename
-      relative_filename = if filename.relative?
-                            filename
-                          else
-                            filename.relative_path_from(Pathname.pwd)
-                          end
-      if @visited_files.include? relative_filename
-        return
-      else
-        @visited_files << relative_filename
-      end
-      emit "### MERGIT: Start of '#{relative_filename}'"
-      filename.readlines.each { |line| scan_line line }
-      emit "### MERGIT: End of '#{relative_filename}'"
+      filename_path = find_requirement(filename)
+      return false if filename_path.nil?
+      return true if @visited_files.include? filename_path
+
+      @visited_files << filename_path
+      emit "### MERGIT: Start of '#{filename}'"
+      filename_path.readlines.each { |line| scan_line line }
+      emit "### MERGIT: End of '#{filename}'"
+      return true
     end
 
     ## Scans a string
     #
-    # It splits a string up into individual line via {#string_split} and
+    # It splits a string up into individual lines via {#string_split} and
     # passes them to {#scan_line}.
     #
     # @param [String] string The string to parse.

data/lib/mergit/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 class Mergit
   # The version of the Mergit Library.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/examples/has_requires.rb

@@ -0,0 +1,5 @@
+puts "I'm requiring the no require file."
+
+require 'no_requires'
+
+puts "See!"

data/spec/examples/no_requires.rb

@@ -0,0 +1,3 @@
+puts "Hi! I have no require lines."
+puts "But I have lots to say!"
+puts "Like 'supercalifragilisticexpialidocious'."

data/spec/examples/relative/path.rb

@@ -0,0 +1,2 @@
+puts "I'm a ruby file that has a parent directory."
+puts "I'm useful for testing relative paths."

data/spec/mergit/processor_spec.rb

@@ -2,87 +2,139 @@ require 'spec_helper'
 require 'mergit/processor'
 
 describe Mergit::Processor do
-  let(:search_path)  { [LIB_PATH] }
+  let(:search_path)  { [EXAMPLE_DIR] }
   let(:replacements)  { {} }
+  let(:do_not_close) { false }  # Setting this to true prevents the @output being closed (and preventing further calls of scan_*())
+  let(:mergit_options) { { :string => '', :do_not_close => do_not_close } }
+  subject { Mergit::Processor.new(search_path, replacements, mergit_options) }
+
+  let(:no_requires_file) { EXAMPLE_DIR + 'no_requires.rb' }
+  let(:has_requires_file) { EXAMPLE_DIR + 'has_requires.rb' }
+  let(:relative_path_file) { EXAMPLE_DIR + 'relative' + 'path.rb' }
+
+  describe "#new" do
+    context "when passed a filename" do
+      after { Mergit::Processor.new(search_path, replacements, :filename => no_requires_file) }
+
+      it "should not add MERGIT comments" do
+        Mergit::Processor.any_instance.should_not_receive(:emit).with(/MERGIT/)
+      end
+    end
+  end
 
   describe "find_requirement" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '') }
+    let(:expected_filename) { has_requires_file }
 
-    context "with a known lib-file" do
-      let(:lib_file) { Pathname.new File.expand_path('../../../lib/mergit.rb', __FILE__) }
-      let(:lib_name) { lib_file.basename '.rb' }
+    shared_examples "find requirement" do
+      it "should return an absolute path" do
+        subject.find_requirement(filename).should be_absolute
+      end
 
-      it "should find mergit.rb" do
-        subject.find_requirement(lib_name).should eq(lib_file)
+      it "should return the expected Pathname" do
+        subject.find_requirement(filename).should eq(expected_filename)
       end
     end
 
+    context "with relative string filename" do
+      let(:filename) { expected_filename.basename('.rb').to_s }
+      it_behaves_like "find requirement"
+    end
+
+    context "with absolute string filename" do
+      let(:filename) { expected_filename.to_s }
+      it_behaves_like "find requirement"
+    end
+
+    context "with relative Pathname filename" do
+      let(:filename) { expected_filename.basename('.rb') }
+      it_behaves_like "find requirement"
+    end
+
+    context "with absolute Pathname filename" do
+      let(:filename) { expected_filename }
+      it_behaves_like "find requirement"
+    end
+
     it "should return nil if it doesn't exist" do
       subject.find_requirement('does-not-exist').should be_nil
     end
   end
 
-  describe "find_requirement!" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '') }
+  describe "scan_file" do
+    let(:do_not_close) { true }
 
-    context "with a known lib-file" do
-      let(:lib_file) { Pathname.new File.expand_path('../../../lib/mergit.rb', __FILE__) }
-      let(:lib_name) { lib_file.basename '.rb' }
+    shared_examples "it emits a string that" do
+      before { subject.scan_file(path) }
 
-      it "should find mergit.rb" do
-        subject.find_requirement!(lib_name).should eq(lib_file)
+      it "should start with a MERGIT comment" do
+        subject.output.should =~ /\A### MERGIT: Start of '#{path}'$/
+      end
+
+      it "should end with a MERGIT comment" do
+        subject.output.should =~ /^### MERGIT: End of '#{path}'\Z/
       end
     end
 
-    it "should raise an exception when it doesn't exist" do
-      expect { subject.find_requirement!('does-not-exist') }.
-        to raise_error(Mergit::RequirementNotFound)
+    context "with an absolute path" do
+      let(:path) { no_requires_file }
+      it_behaves_like "it emits a string that"
     end
-  end
 
-  describe "scan_file" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '', :do_not_close => true) }
+    context "with a relative path" do
+      let(:path) { 'relative/path' }
+      it_behaves_like "it emits a string that"
+    end
 
     context "of an existing lib_file" do
-      let(:lib_file) { Pathname.new('../../../lib/mergit/version.rb').expand_path(__FILE__) }
-      let(:relative_lib_file) { 'lib/mergit/version.rb' }
-      let(:lib_name) { lib_file.basename '.rb' }
+      let(:lib_file) { no_requires_file }
 
       it "should call .scan_line multiple times" do
-        subject.should_receive(:scan_line).at_least(3).times
+        subject.should_receive(:scan_line).exactly(3).times
         subject.scan_file(lib_file)
       end
 
-      context "then the output" do
-        before { subject.scan_file(lib_file) }
-        it "should start with the merget header" do
-          subject.output.should =~ /\A### MERGIT: Start of '#{relative_lib_file}'$/
-        end
-
-        it "should end with the merget header" do
-          subject.output.should =~ /^### MERGIT: End of '#{relative_lib_file}'\Z/
-        end
+      it "should return true" do
+        subject.scan_file(lib_file).should be_true
+      end
 
-        it "contain the contents of lib_file" do
-          subject.output.should include(lib_file.read)
-        end
+      it "contain the contents of lib_file" do
+        subject.scan_file(lib_file)
+        subject.output.should include(lib_file.read)
       end
     end
 
-    context "with a lib_file that has a requires" do
-      let(:required_content) { Pathname.new('../../../lib/mergit/version.rb').expand_path(__FILE__).read }
-      let(:lib_file) { Pathname.new('../../../lib/mergit.rb').expand_path(__FILE__) }
-      subject { Mergit::Processor.new(search_path, replacements, :string => '', :do_not_close => true) }
-      before { subject.scan_file(lib_file) }
+    it "should call .find_requirement with the filename" do
+      subject.should_receive(:find_requirement).with('some_file_name')
+      subject.scan_file('some_file_name')
+    end
+
+    context "with a filename that contains a requires" do
+      let(:filename) { has_requires_file }
+      let(:required_file) { no_requires_file }
+      before { subject.scan_file(filename) }
 
       it "should contain the required file" do
-        subject.output.should include(required_content)
+        subject.output.should include(required_file.read)
+      end
+    end
+
+    context "called a second time with the same filename" do
+      before { subject.scan_file(no_requires_file) }
+
+      it "should return true" do
+        subject.scan_file(no_requires_file).should be_true
+      end
+    end
+
+    context "with a filename that doesn't exist" do
+      it "should return false" do
+        subject.scan_file('file-does-not-exist').should be_false
       end
     end
   end
 
   describe "scan" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '', :do_not_close => true) }
+    let(:do_not_close) { true }
 
     context "with a string" do
       let(:ruby_string) { "puts 'hello'\nrequire 'pathname'\n\nputs 'goodbye'\n" }
@@ -112,14 +164,22 @@ describe Mergit::Processor do
   end
 
   describe "scan_line" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '', :do_not_close => true) }
+    let(:do_not_close) { true }
 
     context "given a single requires" do
-      let(:ruby_string) { "require 'mergit/version'" }
+      let(:ruby_string) { "require 'no_requires'" }
       after { subject.scan_line ruby_string }
 
       it "should call scan_file()" do
-        subject.should_receive(:scan_file).with(Pathname.new('../../../lib/mergit/version.rb').expand_path(__FILE__)).once
+        subject.should_receive(:scan_file).with('no_requires').once
+      end
+
+      context "that has a comment after it" do
+        let(:ruby_string) { "require 'no_requires' # this is a comment" }
+
+        it "should call scan_file()" do
+          subject.should_receive(:scan_file).with('no_requires').once
+        end
       end
     end
 
@@ -163,7 +223,6 @@ describe Mergit::Processor do
   end
 
   describe "string_split" do
-    subject { Mergit::Processor.new(search_path, replacements, :string => '') }
     let(:example_parts) { [ 'one', '', 'two', 'three' ] }
 
     context "with unix newlines" do
@@ -182,15 +241,9 @@ describe Mergit::Processor do
   end
 
   context "with looping requires" do
+    let(:search_path) { [dir] }
+    let(:do_not_close) { true }
     let(:dir) { EXAMPLE_DIR + 'loop' }
-    subject do
-      Mergit::Processor.new(
-        [ dir ],
-        {},
-        :string => '',
-        :do_not_close => true
-      )
-    end
 
     it "should not go into an infinite loop" do
       subject.scan_file(dir + 'a.rb')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mergit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -243,9 +243,12 @@ files:
 - lib/mergit/processor.rb
 - lib/mergit/version.rb
 - mergit.gemspec
+- spec/examples/has_requires.rb
 - spec/examples/loop/a.rb
 - spec/examples/loop/b.rb
 - spec/examples/loop/c.rb
+- spec/examples/no_requires.rb
+- spec/examples/relative/path.rb
 - spec/mergit/processor_spec.rb
 - spec/mergit_spec.rb
 - spec/spec_helper.rb
@@ -264,7 +267,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3687644075462403820
+      hash: -3347449453804380460
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -273,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3687644075462403820
+      hash: -3347449453804380460
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -281,9 +284,12 @@ signing_key:
 specification_version: 3
 summary: Merge 'require'd files into one file.
 test_files:
+- spec/examples/has_requires.rb
 - spec/examples/loop/a.rb
 - spec/examples/loop/b.rb
 - spec/examples/loop/c.rb
+- spec/examples/no_requires.rb
+- spec/examples/relative/path.rb
 - spec/mergit/processor_spec.rb
 - spec/mergit_spec.rb
 - spec/spec_helper.rb