aktion_test 0.0.2 → 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+script: "bundle exec rake"
+

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# v0.1.0
+
+Addition of RSpec matchers
+  * Matcher to check for file existance
+  * Matcher to check for directory existance
+  * Matcher to check the contents of a directory tree
+
+# v0.0.2
+  * bump gem versions
+  * remove cucumber
+
+# v0.0.1
+  Initial Release
+
+* Provides some basic testing gem dependencies

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'rake', '~> 10.0.2'
 # Specify your gem's dependencies in aktion_test.gemspec
 gemspec

data/Rakefile

@@ -1,2 +1,15 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '--color --format progress'
+  t.verbose = false
+end
+
+task :all do
+  exec('rake spec')
+end
+
+task :default => [:all]

data/aktion_test.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Contains all required testing gems as well as some rake tasks and test helpers to make getting a test suite up and running easy and fast.}
   gem.summary       = %q{Gems, libs, helpers for test suites.}
   gem.homepage      = "http://aktionlab.com"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,6 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = AktionTest::VERSION
 
+  gem.required_ruby_version = '~> 1.9.2'
+
   # Don't add anything to this list that depends on Rails or any
   # other large frameworks/orms. This list should be suitable for
   # even the simplest gem.

data/lib/aktion_test/matchers/base.rb

@@ -0,0 +1,13 @@
+module AktionTest
+  module Matchers
+    class Base
+      def failure_message
+        "Expected #{expectation}\n#{problem}"
+      end
+
+      def negative_failure_message
+        "Did not expect #{expectation}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module AktionTest
+  module Matchers
+    module FileSystem
+      def be_a_directory
+        DirectoryExistanceMatcher.new
+      end
+
+      class DirectoryExistanceMatcher < Matchers::Base
+        def initialize
+        end
+
+        def matches?(subject)
+          @subject = subject
+          directory_exists?
+        end
+
+      protected
+        
+        def expectation
+          "#{@subject} to be a directory."
+        end
+
+        def problem
+          ""
+        end
+
+        def directory_exists?
+          Dir.exists? @subject
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module AktionTest
+  module Matchers
+    module FileSystem
+      def be_a_file
+        FileExistanceMatcher.new
+      end
+
+      class FileExistanceMatcher < Matchers::Base
+        def initialize
+        end
+
+        def matches?(subject)
+          @subject = subject
+          File.exists? @subject
+        end
+
+      protected
+        
+        def expectation
+          "#{@subject} to be a file"
+        end
+
+        def problem
+          ""
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,118 @@
+module AktionTest
+  module Matchers
+    module FileSystem
+      def have_file(path)
+        # 'some_file' : ['some_file']
+        # 'some_dir/some_file' : [{'some_dir' => ['some_file']}]
+        # '*/some_file' : [{'*' => ['some_file']}]
+        # '**/some_file' : [{'**' => ['some_file']}]
+        # 'some_dir/*/some_file' :
+        segments = path.split('/')
+        file = segments.pop
+        tree = segments.reverse.reduce([file]) {|a,b| [{b => a}] }
+        have_tree(tree)
+      end
+
+      def have_files(files)
+        # have_tree([{'**' => files}])
+        DirectoryContentMatcher.new(files)
+      end
+
+      def have_directory(dir)
+        # have_tree([{'**' => [{dir => []}]}])
+      end
+
+      def have_directories(dirs)
+        # have_tree([{'**' => [Hash[a.zip(a.size.times.map{[]})]]}])
+      end
+
+      def have_tree(tree)
+        DirectoryContentMatcher.new(tree)
+      end
+
+      class DirectoryContentMatcher < Matchers::Base
+        def initialize(tree)
+          @tree = tree
+        end
+
+        def matches?(subject)
+          @subject = subject
+          directory_exists? && matches_tree?(@tree)
+        end
+
+      protected
+
+        def matches_tree?(tree, directory='')
+          tree.all? do |entry|
+            if entry.is_a? String
+              Dir[File.join(@subject, directory, entry)].any?
+            elsif entry.is_a? Hash
+              entry.to_a.all?{|dir,subtree| matches_tree?(subtree, File.join(directory, dir))}
+            end
+          end
+        end
+
+        def directory_exists?
+          Dir.exists?(@subject)
+        end
+
+        def expectation
+          "#{@subject} to contain:\n#{print_tree}\n"
+        end
+
+        def flatten_tree(structure, directory='')
+          structure.map do |entry|
+            case entry
+            when Hash
+              entry.map{|dir,entries| flatten_tree(entries, "#{directory}#{dir}/")}
+            when String
+              "#{directory}#{entry}"
+            end
+          end.flatten
+        end
+
+        def problem
+          unless directory_exists?
+            if File.exists? @subject
+              "#{@subject} is not a directory."
+            else
+              "#{@subject} does not exist."
+            end
+          else
+            missing_files = flatten_tree(@tree).reject do |path|
+              Dir["#{@subject}/#{path}"].any?
+            end
+            if missing_files.any?
+              missing_files.map{|f| "#{f} was not found"}.join("\n")
+            else
+              "Unknown Problem"
+            end
+          end
+        end
+
+        def print_tree(tree=nil, depth=1)
+          tree ||= @tree
+          tree.map do |entry|
+            case entry
+            when String then
+              print_file(entry, depth)
+            when Hash
+              entry.map do |k,v|
+                print_directory(k, depth) + "\n" +
+                print_tree(v, depth + 1)
+              end.join("\n")
+            end
+          end.join("\n")
+        end
+
+        def print_file(file, depth)
+          "#{"  " * depth}#{file}"
+        end
+
+        def print_directory(directory, depth)
+          print_file(directory + '/', depth)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +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'
+
+module RSpec::Matchers
+  include AktionTest::Matchers::FileSystem
+end

data/lib/aktion_test/version.rb

@@ -1,3 +1,3 @@
 module AktionTest
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/aktion_test.rb

@@ -1,5 +1,4 @@
 require "aktion_test/version"
+require "aktion_test/matchers/base"
+require "aktion_test/matchers/integrations/rspec"
 
-module AktionTest
-  # Your code goes here...
-end

data/spec/matchers/be_a_directory_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AktionTest::Matchers::FileSystem::DirectoryExistanceMatcher do
+  it "accepts an existing directory" do
+    File.expand_path(File.join(__FILE__, '..')).should be_a_directory
+  end
+
+  it "does not accept a non-existant directory" do
+    File.expand_path(File.join(__FILE__, '..', 'foo')).should_not be_a_directory
+  end
+
+  it "does not accept a file" do
+    __FILE__.should_not be_a_directory
+  end
+end

data/spec/matchers/be_a_file_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AktionTest::Matchers::FileSystem::FileExistanceMatcher do
+  it "should accept an existing file" do
+    __FILE__.should be_a_file 
+  end
+
+  it "should not accept a non-existant file" do
+    File.join(__FILE__, '..', 'foo').should_not be_a_file
+  end
+
+  it "should not accept a directory" do
+    File.join(__FILE__, '..').should_not be_a_file
+  end
+end

data/spec/matchers/directory_contains_spec.rb

@@ -0,0 +1,233 @@
+require 'spec_helper'
+require 'active_support/core_ext/string'
+
+describe AktionTest::Matchers::FileSystem::DirectoryContentMatcher do
+  let(:test_root) { File.expand_path(File.join(__FILE__, '..', '..', 'tmp')) }
+
+  before(:each) do
+    FileUtils.rm_rf(test_root) if Dir.exists?(test_root)
+  end
+
+  def build(structure, root=test_root)
+    FileUtils.mkdir(root) unless Dir.exists?(root)
+
+    structure.each do |entry|
+      case entry
+      when String
+        FileUtils.touch("#{root}/#{entry}")
+      when Hash
+        entry.each{|k,v| build(v, "#{root}/#{k}")}
+      end
+    end
+  end
+
+  def matcher(*args)
+    @matcher ||= described_class.new(*args)
+  end
+
+  context "single file in the root" do
+    it "will accept if the file exists" do
+      build(['test_file'])
+      test_root.should have_tree(['test_file'])
+    end
+
+    it "will not accept if the file does not exist" do
+      test_root.should_not have_tree(['test_file'])
+    end
+
+    it "will not accept if the file is in a subdirectory" do
+      build([{'a' => ['test_file']}])
+      test_root.should_not have_tree(['test_file'])
+    end
+  end
+
+  context "single file in a specific directory" do
+    it "will accept if the file exists in the subdirectory" do
+      build([{'a' => ['test_file']}])
+      test_root.should have_tree([{'a' => ['test_file']}])
+    end
+
+    it "will not accept if the file does not exist" do
+      test_root.should_not have_tree([{'a' => ['test_file']}])
+    end
+
+    it "will not accept if the file exists in the root" do
+      build(['test_file'])
+      test_root.should_not have_tree([{'a' => ['test_file']}])
+    end
+
+    it "will not accept if the file exists in another directory" do
+      build([{'b' => ['test_file']}])
+      test_root.should_not have_tree([{'a' => ['test_file']}])
+    end
+  end
+
+  context "single file in a specific tree" do
+    let(:tree) { [{'a' => [{'b' => [{'c' => ['test_file']}]}]}] }
+    it "will accept if the file exists in the tree" do
+      build(tree)
+      test_root.should have_tree(tree)
+    end
+  end
+
+  context "single file in any subdirectory" do
+    let(:tree) { [{'*' => ['test_file']}]}
+
+    it "will accept if the file exists in a subdirectory" do
+      build([{'a' => ['test_file']}])
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if the file exists deeper in the tree" do
+      build([{'a' => [{'b' => ['test_file']}]}])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "single file in any tree" do
+    let(:tree) { [{'**' => ['test_file']}]}
+
+    it "will accept if the file exists in the tree" do
+      build([{'a' => [{'b' => [{'c' => ['test_file']}]}]}])
+      test_root.should have_tree(tree)
+    end
+  end
+
+  context "single file with mixed specific and any directory" do
+    let(:tree) { [{'a' => [{'*' => [{'c' => ['test_file']}]}]}]}
+
+    it "will accept if the file exists in search path" do
+      build([{'a' => [{'b' => [{'c' => ['test_file']}]}]}])
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if the file exists outside the search path" do
+      build([{
+        'a' => [{
+          'c' => ['test_file'],
+          'b' => [{
+            'd' => [{
+              'c' => ['test_file']
+              }]
+            }]
+          }]
+        }])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "single file with mixed specific directories and any tree" do
+    let(:tree) { [{'a' => [{'**' => [{'d' => ['test_file']}]}]}]}
+
+    it "will accept if the file exists in the search path" do
+      build([{'a' => [{'b' => [{'c' => [{'d' => ['test_file']}]}]}]}])
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if the file is outside the search path" do
+      build([{'a' => [{'b' => [{'c' => ['test_file']}]}]}])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "multiple files in the root directory" do
+    let(:tree) { %w(test_file_a test_file_b) }
+
+    it "will accept if all of the files exist" do
+      build(%w(test_file_a test_file_b))
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if not all of the files exist" do
+      build(['test_file_a'])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "multiple files a subdirectory" do
+    let(:tree) { [{'a' => %w(test_file_a test_file_b)}]}
+
+    it "will accept if all of the files exist" do
+      build(tree)
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if not all of the files exist" do
+      build([{'a' => %w(test_file_a)}])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "multiple files in multiple subdirectories" do
+    let(:tree) { [{'a' => %w(test_file_a test_file_b), 'b' => %w(test_file_a test_file_b)}]}
+
+    it "will accept if all of the files exist" do
+      build(tree)
+      test_root.should have_tree(tree)
+    end
+
+    it "will not accept if not all of the files exist" do
+      build([{'a' => %w(test_file_a test_file_b), 'b' => %w(test_file_b)}])
+      test_root.should_not have_tree(tree)
+    end
+  end
+
+  context "when files do not exist" do
+    it "lists the missing files" do
+      #build([{'a' => ['test_file_a', {'b' => [{'c' => ['test_file_b', 'test_file_c']}]}]}])
+      build([{'a' => ['test_file_a']}])
+      matcher(['test_file', {'a' => ['test_file_a', {'b' => [{'c' => ['test_file_b', 'test_file_c']}]}]}]).matches?(test_root)
+      matcher.failure_message.should == <<-FAIL.strip_heredoc.strip
+        Expected #{test_root} to contain:
+          test_file
+          a/
+            test_file_a
+            b/
+              c/
+                test_file_b
+                test_file_c
+
+        test_file was not found
+        a/b/c/test_file_b was not found
+        a/b/c/test_file_c was not found
+      FAIL
+    end
+  end
+
+  context "when the subject does not exist" do
+    let(:nx_root) { File.join(test_root, 'a') }
+
+    it "will not be accepeted" do
+      nx_root.should_not have_file('some_file')
+    end
+
+    it "specifies the problem as the subject not existing" do
+      matcher(['some_file']).matches?(nx_root)
+      matcher.failure_message.should == <<-FAIL.strip_heredoc.strip
+        Expected #{nx_root} to contain:
+          some_file
+
+        #{nx_root} does not exist.
+      FAIL
+    end
+  end
+
+  context "when the subject is not a directory" do
+    before(:each) { build(['test_file']) }
+
+    it "will not be accepted" do
+      File.join(test_root, 'test_file').should_not have_file('some_file')
+    end
+
+    it "specifies the problem as the subject not being a directory" do
+      bad_root = File.join(test_root, 'test_file')
+      matcher(['some_file']).matches?(bad_root)
+      matcher.failure_message.should == <<-FAIL.strip_heredoc.strip
+        Expected #{bad_root} to contain:
+          some_file
+
+        #{bad_root} is not a directory.
+      FAIL
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'aktion_test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aktion_test
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -100,16 +100,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - aktion_test.gemspec
 - lib/aktion_test.rb
+- lib/aktion_test/matchers/base.rb
+- 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/integrations/rspec.rb
 - lib/aktion_test/version.rb
+- spec/matchers/be_a_directory_spec.rb
+- spec/matchers/be_a_file_spec.rb
+- spec/matchers/directory_contains_spec.rb
+- spec/spec_helper.rb
 homepage: http://aktionlab.com
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -117,9 +130,9 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,4 +145,8 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Gems, libs, helpers for test suites.
-test_files: []
+test_files:
+- spec/matchers/be_a_directory_spec.rb
+- spec/matchers/be_a_file_spec.rb
+- spec/matchers/directory_contains_spec.rb
+- spec/spec_helper.rb