aktion_test 0.1.1 → 0.1.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.*.swp

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.1.2
+  * Add a file contents matcher
+
 # v0.1.1
 
   * Add ClassBuilder to create classes on the fly

data/lib/aktion_test/matchers/file_system/file_contains.rb

@@ -0,0 +1,112 @@
+module AktionTest
+  module Matchers
+    module FileSystem
+      def match_lines(lines, options={})
+        FileContentMatcher.new(lines, options)
+      end
+
+      class FileContentMatcher < Matchers::Base
+        def initialize(lines, options={})
+          @original_lines = lines
+          @lines, @options = init_lines(lines), options
+          @options[:match_method] = :all
+          allow_any    if @options.delete(:allow_any)
+          sequentially if @options.delete(:sequentially)
+          @options[:after]  = regexp(@options[:after])  unless @options[:after].nil?
+          @options[:before] = regexp(@options[:before]) unless @options[:before].nil?
+        end
+
+        def init_lines(lines)
+          lines.map { |line| regexp(line) }.flatten
+        end
+
+        def matches?(file)
+          @file = file
+          file_exists? && file_has_contents?
+        end
+      
+        def allow_any
+          @options[:match_method] = :any
+          self
+        end
+
+        def after(match_after)
+          @options[:after] = regexp(match_after)
+          self
+        end
+
+        def before(match_before)
+          @options[:before] = regexp(match_before)
+          self
+        end
+
+        def sequentially
+          @options[:match_method] = :sequence
+          self
+        end
+
+      protected
+        
+        def expectation
+          "#{@file} to have contents:\n---\n#{print_lines}\n---"
+        end
+
+        def print_lines
+          @original_lines.join("\n")
+        end
+
+        def problem
+          if File.exists?(@file)
+            if File.directory?(@file)
+              "#{@file} is a directory."
+            else
+              "Unknown Problem"
+            end
+          else
+            "#{@file} does not exist."
+          end
+        end
+
+        def file_exists?
+          File.exists?(@file) && !File.directory?(@file)
+        end
+
+        def file_has_contents?
+          find  = -> lines, match { lines.find_index{|line| line =~ match} }
+          scope = -> lines, scope, default { find[lines, @options[scope]] || default }
+          lines = -> lines { lines.take(scope[lines, :before, lines.count]).drop(scope[lines, :after, -1] + 1) }
+
+
+          match_method[@lines.map{|line| find[lines[open(@file).readlines], line]}]
+        end
+
+        def match_method
+          case @options[:match_method]
+          when :sequence
+            -> result { !result.first.nil? && (result == ((result.first)..(result.first + @lines.count - 1)).to_a) }
+          when :any
+            -> result { !result.all?(&:nil?) }
+          when :all
+            -> result { result.none?(&:nil?) }
+          end
+        end
+
+        def regexp(object)
+          case object
+          when Regexp then object
+          when Array  then object.map {|item| regexp(item)} 
+          when String
+            if object.include? "\n"
+              object.split("\n").map{|item| %r(^#{item}$)}
+            else
+              %r(^#{object}$)
+            end
+          else
+            %r(^#{object.to_s}$)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/aktion_test/matchers/integrations/rspec.rb

@@ -1,6 +1,7 @@
 require 'aktion_test/matchers/file_system/be_a_file'
 require 'aktion_test/matchers/file_system/be_a_directory'
 require 'aktion_test/matchers/file_system/directory_contains'
+require 'aktion_test/matchers/file_system/file_contains'
 
 module RSpec::Matchers
   include AktionTest::Matchers::FileSystem

data/lib/aktion_test/version.rb

@@ -1,3 +1,3 @@
 module AktionTest
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/matchers/file_contains_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe AktionTest::Matchers::FileSystem::FileContentMatcher do
+  def create_file(file='tmp/test_file', &block)
+    FileUtils.mkdir('tmp') unless Dir.exists? 'tmp'
+    File.open(file, 'w') {|f| f << yield }
+  end
+
+  after(:each) do
+    Dir['tmp/*'].each {|f| FileUtils.rm f}
+  end
+
+  context 'a file that does not exist' do
+    it "will not be accepted" do
+      'tmp/test_file'.should_not match_lines(['anything'])
+    end
+
+    it 'explains that the file was not found' do
+      matcher = described_class.new(['anything'])
+      matcher.matches?('tmp/test_file')
+      matcher.failure_message.should == <<-MSG.strip_heredoc.strip
+        Expected tmp/test_file to have contents:
+        ---
+        anything
+        ---
+        tmp/test_file does not exist.
+      MSG
+    end
+  end
+
+  context 'a file that is actually a directory' do
+    it 'will not be accepted' do
+      File.dirname(__FILE__).should_not match_lines(['anything'])
+    end
+
+    it 'explains that the file is a directory' do
+      matcher = described_class.new(['anything'])
+      matcher.matches?(File.dirname(__FILE__))
+      matcher.failure_message.should == <<-MSG.strip_heredoc.strip
+        Expected #{File.dirname(__FILE__)} to have contents:
+        ---
+        anything
+        ---
+        #{File.dirname(__FILE__)} is a directory.
+      MSG
+    end
+  end
+
+  context 'a file that exists' do
+    before(:each) do
+      create_file do
+        <<-FILE.strip_heredoc
+          lorem
+          ipsum
+          dolar
+          amet
+        FILE
+      end
+    end
+
+    context 'with all matching content' do
+      it 'will be accpeted' do
+        'tmp/test_file'.should match_lines(['lorem'])
+      end
+
+      it 'will be accepted with a regex' do
+        'tmp/test_file'.should match_lines([/^ips/])
+      end
+
+      it 'will be accepted with a multiline match' do
+        match_content = <<-MATCH.strip_heredoc.strip
+          lorem
+          ipsum
+          dolar
+          amet
+        MATCH
+        'tmp/test_file'.should match_lines([match_content])
+      end
+    end
+
+    context 'with no matching content after a specified point' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(['lorem'], :after => 'ipsum')
+        'tmp/test_file'.should_not match_lines(['lorem']).after('ipsum')
+        'tmp/test_file'.should_not match_lines(['lorem'], :after => /sum$/)
+        'tmp/test_file'.should_not match_lines(['lorem']).after(/sum$/)
+      end
+    end
+
+    context 'with matching content after a specified point' do
+      it 'will be accepted' do
+        'tmp/test_file'.should match_lines(['dolar','amet']).after('ipsum')
+      end
+
+      context 'when the matching content includes the point' do
+        it 'will not be accepted' do
+          'tmp/test_file'.should_not match_lines(['dolar','amet']).after('dolar')
+        end
+      end
+    end
+
+    context 'with no matching content before a specified point' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(['amet'], :before => 'dolar')
+        'tmp/test_file'.should_not match_lines(['amet'], :before => /^dol/)
+        'tmp/test_file'.should_not match_lines(['amet']).before('dolar')
+        'tmp/test_file'.should_not match_lines(['amet']).before(/^dol/)
+      end
+    end
+
+    context 'with matching content before a specified point' do
+      it 'will be accepted' do
+        'tmp/test_file'.should match_lines(['lorem','ipsum']).before('dolar')
+      end
+
+      context 'when the matching content includes the point' do
+        it 'will not be accepted' do
+          'tmp/test_file'.should_not match_lines(['lorem','ipsum']).before('ipsum')
+        end
+      end
+    end
+
+    context 'with matching content before and after specified points' do
+      it 'will be accpeted' do
+        'tmp/test_file'.should match_lines(['dolar']).before('amet').after('ipsum')
+      end
+    end
+
+    context 'without matching content in order' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(['lorem','dolar'], :sequentially => true)
+        'tmp/test_file'.should_not match_lines(['lorem','dolar']).sequentially
+      end
+    end
+
+    context 'with matching content in order' do
+      it 'will be accepted' do
+        'tmp/test_file'.should match_lines(%w(ipsum dolar amet)).sequentially
+      end
+    end
+
+    context 'with no matching content in order after a specified point' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(%w(lorem ipsum dolar)).sequentially.after('ipsum')
+      end
+    end
+
+    context 'with no matching content in order before a specified point' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(%w(ipsum dolar amet)).sequentially.before('dolar')
+      end
+    end
+
+    context 'without any matching content' do
+      it 'will not be accepted' do
+        'tmp/test_file'.should_not match_lines(['nothing'])
+      end
+    end
+
+    context 'with partial matching content' do
+      context 'when matching all lines (default)' do
+        it 'will not be accepted' do
+          'tmp/test_file'.should_not match_lines(['some','thing'])
+        end
+      end
+
+      context 'when matching any lines' do
+        it 'will be accepted' do
+          'tmp/test_file'.should match_lines(['lorem','dolar'], allow_any: true)
+          'tmp/test_file'.should match_lines(['lorem','dolor']).allow_any
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -3,9 +3,10 @@ require 'simplecov'
 SimpleCov.start do
   add_filter '/spec/'
   refuse_coverage_drop
-  minimum_coverage 100
+  minimum_coverage 95
 end
 
+require 'active_support/core_ext/string'
 require 'aktion_test'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aktion_test
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -115,6 +115,7 @@ files:
 - lib/aktion_test/matchers/file_system/be_a_directory.rb
 - lib/aktion_test/matchers/file_system/be_a_file.rb
 - lib/aktion_test/matchers/file_system/directory_contains.rb
+- lib/aktion_test/matchers/file_system/file_contains.rb
 - lib/aktion_test/matchers/integrations/rspec.rb
 - lib/aktion_test/version.rb
 - spec/aktion_test/class_builder_spec.rb
@@ -122,6 +123,7 @@ files:
 - spec/matchers/be_a_directory_spec.rb
 - spec/matchers/be_a_file_spec.rb
 - spec/matchers/directory_contains_spec.rb
+- spec/matchers/file_contains_spec.rb
 - spec/spec_helper.rb
 homepage: http://aktionlab.com
 licenses:
@@ -154,4 +156,5 @@ test_files:
 - spec/matchers/be_a_directory_spec.rb
 - spec/matchers/be_a_file_spec.rb
 - spec/matchers/directory_contains_spec.rb
+- spec/matchers/file_contains_spec.rb
 - spec/spec_helper.rb