clintegracon 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25fcbf3498d6a95409593f24de5d6885bf1d7e33
-  data.tar.gz: a6e78918b216994abe40dba9c275fba234f903d0
+  metadata.gz: cd5f7726a433dc1feba13bbe11a573bffd341122
+  data.tar.gz: 75ff10a192573273b4a09d0d5052c1510f4b51bd
 SHA512:
-  metadata.gz: 32aa4fc119befca2f816fa6566c525de80a05dbaadf870b687021ae80549c2ef688437d020771d297eedeec8687b12443d4a65b5ba9a7130a2a2b1245226eb35
-  data.tar.gz: 6a8ae5276a8eecbeff4e024820de3f9098d2f1f0e2f21e1c5664e23dd9d47fd6c9bea2bf6d9d8fd0541c3482523b294b310abb73719e9b5c74735d61554a21bc
+  metadata.gz: d49ed2a50832e23ba62d59d96bc96b18d1d22e9b8af5d95ad35e3bd446cbd171d8a7a71385cb5d235bea5ded61573889f19732e3d88519bc7257f588526d0bc2
+  data.tar.gz: ac8a342022a0f022ff1c35feea8459be9560ade8b5f3e5175933bb2b57723d43f3504d351c6d8fd98148bad01e71c9d7be6e2ebf1fd60d72f4276a6a7b4581f6

data/README.md

@@ -146,6 +146,14 @@ This is not fixed, but if yours differ, you have to change paths accordingly.
   ![Bacon Example Terminal Output](/../assets/term-output-bacon.png?raw=true)
 
 
+## Acknowledgement
+
+This gem was inspired by the idea behind the integration tests of the
+[CocoaPods](cp-main)'s main project and was integrated there.  
+See [the integration in CocoaPods][cp-integration] for a real-world example with
+very extensive usage of all features.
+
+
 ## Contributing
 
 1. Fork it
@@ -153,3 +161,6 @@ This is not fixed, but if yours differ, you have to change paths accordingly.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[cp-main]: https://github.com/CocoaPods/CocoaPods
+[cp-integration]: https://github.com/CocoaPods/CocoaPods/blob/master/spec/integration.rb

data/lib/CLIntegracon/adapter/bacon.rb

@@ -119,13 +119,15 @@ module CLIntegracon::Adapter::Bacon
         file_tree_spec_context.spec(spec_dir).run do |spec|
           instance_eval &block
 
+          formatter = spec.formatter.lazy
+
           spec.compare do |diff|
             it diff.relative_path.to_s do
-              diff.produced.should.satisfy(spec.formatter.describe_missing_file(diff.relative_path)) do
+              diff.produced.should.satisfy(formatter.describe_missing_file(diff.relative_path)) do
                 diff.produced.exist?
               end
 
-              diff.produced.should.satisfy(spec.formatter.describe_file_diff(diff)) do
+              diff.produced.should.satisfy(formatter.describe_file_diff(diff)) do
                 diff.is_equal?
               end
             end
@@ -133,7 +135,7 @@ module CLIntegracon::Adapter::Bacon
 
           spec.check_unexpected_files do |files|
             it "should not produce unexpected files" do
-              files.should.satisfy(spec.formatter.describe_unexpected_files(files)) do
+              files.should.satisfy(formatter.describe_unexpected_files(files)) do
                 files.size == 0
               end
             end

data/lib/CLIntegracon/formatter.rb

@@ -1,6 +1,82 @@
 require 'colored'
 
 module CLIntegracon
+
+  # A LazyString is constructed by a block, but only evaluated when needed
+  class LazyString
+
+    # @return  [Proc]
+    #          the closure which will be used to build the string
+    attr_reader :proc
+
+    # Initialize a LazyString
+    #
+    # @param  [Block () -> (String)] block
+    #         the block which returns a string, called by #to_s
+    #
+    def initialize(&block)
+      @proc = block
+    end
+
+    # Calls the underlying proc to build the string. The result will be
+    # memorized, so subsequent calls of this method will not cause that the
+    # proc will be called again.
+    #
+    # @return [String]
+    #
+    def to_str
+      @string ||= proc.call().to_s
+    end
+
+    alias :to_s :to_str
+
+  end
+
+  # A LazyStringProxy returns a LazyString for each call, which delegates the
+  # call as soon as the result is needed to the underlying formatter.
+  class LazyStringProxy
+
+    # @return  [Formatter]
+    #          the formatter used to build the string
+    attr_reader :formatter
+
+    # Initialize a LazyStringProxy, which returns for each call to an
+    # underlying formatter a new LazyString, whose #to_s method will evaluate
+    # to the result of the original call delegated to the formatter.
+    #
+    # @param  [Formatter] formatter
+    #         the formatter
+    #
+    def initialize(formatter)
+      @formatter = formatter
+    end
+
+    # Remember the call delegated to #formatter in a closure on an anonymous
+    # object, defined as method :to_s.
+    #
+    # @return [#to_s]
+    #
+    def method_missing(method, *args, &block)
+      return LazyString.new do
+        @formatter.send(method, *args, &block)
+      end
+    end
+
+    # Respond to all methods, which are beginning with `describe_` to
+    # which the #formatter also responds.
+    #
+    # @return [Bool]
+    #
+    def respond_to?(method)
+      if /^describe_/.match(method) && @formatter.respond_to?(method)
+        true
+      else
+        super
+      end
+    end
+
+  end
+
   class Formatter
 
     # @return  [FileTreeSpec]
@@ -17,6 +93,15 @@ module CLIntegracon
       @spec = spec
     end
 
+    # Return a proxy, which returns formatted string, evaluated first
+    # if #to_s is called on this instance.
+    #
+    # @return  [LazyStringProxy]
+    #
+    def lazy
+      LazyStringProxy.new(self)
+    end
+
     # Return a description text for an expectation that a file path
     # was expected to exist, but is missing.
     #

data/lib/CLIntegracon/version.rb

@@ -1,3 +1,3 @@
 module CLIntegracon
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/unit/adapter/bacon_spec.rb

@@ -1,5 +1,4 @@
-require 'CLIntegracon'
-require 'mocha-on-bacon'
+require File.expand_path('../../spec_helper', __FILE__)
 
 describe 'CLIntegracon::Adapter::Bacon' do
 

data/spec/unit/configuration_spec.rb

@@ -1,5 +1,4 @@
-require 'CLIntegracon'
-require 'mocha-on-bacon'
+require File.expand_path('../spec_helper', __FILE__)
 
 describe CLIntegracon do
 

data/spec/unit/formatter_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe CLIntegracon::Formatter do
+
+  def subject
+    CLIntegracon::Formatter
+  end
+
+  before do
+    @spec = stub('Spec', spec_folder: '$spec_folder')
+  end
+
+  describe "#initialize" do
+    it 'should set given spec as attribute' do
+      @formatter = subject.new(@spec)
+      @formatter.spec.should.should.eql?(@spec)
+    end
+  end
+
+  shared 'has_formatting_methods' do
+    describe '#respond_to?' do
+      it 'should respond to #describe_missing_file' do
+        @formatter.respond_to?(:describe_missing_file).should.be.true?
+      end
+
+      it 'should respond to #describe_unexpected_files' do
+        @formatter.respond_to?(:describe_unexpected_files).should.be.true?
+      end
+
+      it 'should respond to #describe_file_diff' do
+        @formatter.respond_to?(:describe_file_diff).should.be.true?
+      end
+    end
+
+    describe "#describe_missing_file" do
+      it 'should match the expected return value' do
+        @formatter.describe_missing_file('$missing').to_s.should.be.eql?  <<-EOS.chomp
+Missing file for $spec_folder:
+  * \e[31m$missing\e[0m
+EOS
+      end
+    end
+
+    describe "#describe_unexpected_files" do
+      it 'should match the expected return value' do
+        @formatter.describe_unexpected_files(['$a', '$b']).to_s.should.be.eql? <<-EOS.chomp
+Unexpected files for $spec_folder:
+  * \e[32m$a\e[0m
+  * \e[32m$b\e[0m
+EOS
+      end
+    end
+
+    describe "#describe_file_diff" do
+      it 'should match the expected return value' do
+        diff = ['$before', '+ $add', '- $removed', '$after']
+        diff.stubs(relative_path: '$relative_path')
+        @formatter.describe_file_diff(diff, 20).to_s.should.be.eql? <<-EOS
+File comparison error `$relative_path` for $spec_folder:
+--- DIFF -----------
+$before
+\e[32m+ $add\e[0m
+\e[31m- $removed\e[0m
+$after
+--- END ------------
+EOS
+      end
+    end
+  end
+
+  describe 'has formatting methods' do
+    before do
+      @formatter = subject.new(@spec)
+    end
+
+    behaves_like 'has_formatting_methods'
+  end
+
+  describe "#lazy" do
+    before do
+      @formatter = subject.new(@spec)
+    end
+
+    describe '#respond_to?' do
+      it 'should not respond to additional methods' do
+        @formatter.lazy.respond_to?(:describe_foo).should.be.false?
+        @formatter.lazy.respond_to?(:lazy).should.be.false?
+      end
+    end
+
+    describe 'delegates to formatting methods' do
+      before do
+        @formatter = subject.new(@spec).lazy
+      end
+
+      behaves_like 'has_formatting_methods'
+    end
+
+    describe '#describe_missing_file' do
+      it 'should not call the method immediately' do
+        @formatter.expects(:describe_missing_file).never
+        @formatter.lazy.describe_missing_file('a')
+          .should.be.an.instance_of?(CLIntegracon::LazyString)
+      end
+    end
+
+    describe "#describe_unexpected_files" do
+      it 'should not call the method immediately' do
+        @formatter.expects(:describe_unexpected_files).never
+        @formatter.lazy.describe_unexpected_files(['a', 'b'])
+          .should.be.an.instance_of?(CLIntegracon::LazyString)
+      end
+    end
+
+    describe "#describe_file_diff" do
+      it 'should not call the method immediately' do
+        @formatter.expects(:describe_missing_file).never
+        @formatter.lazy.describe_file_diff(stub('Diff'))
+          .should.be.an.instance_of?(CLIntegracon::LazyString)
+      end
+    end
+  end
+
+end

data/spec/unit/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'CLIntegracon'
+require 'mocha-on-bacon'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clintegracon
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Marius Rackwitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,6 +166,8 @@ files:
 - spec/integration/coffeemaker_sweetner_honey/before/Coffeemakerfile.yml
 - spec/unit/adapter/bacon_spec.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/formatter_spec.rb
+- spec/unit/spec_helper.rb
 homepage: https://github.com/mrackwitz/CLIntegracon
 licenses:
 - MIT
@@ -210,3 +212,5 @@ test_files:
 - spec/integration/coffeemaker_sweetner_honey/before/Coffeemakerfile.yml
 - spec/unit/adapter/bacon_spec.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/formatter_spec.rb
+- spec/unit/spec_helper.rb