aktion_test 0.2.2 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.3.0
+  * New spec helper interface, more OOPish this time
+  * Modules receive the spec helper instance in their initialize to load dependencies
+  * Improve coverage
+  * AktionLab module now loads SimpleCov as it initializes
+
 # v0.2.2
   * More spec helper improvements
   * Update factory girl to 4.2

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

@@ -66,8 +66,6 @@ module AktionTest
               end
               if missing_files.any?
                 missing_files.map{|f| "#{f} was not found"}.join("\n")
-              else
-                "Unknown Problem"
               end
             end
           end

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

@@ -25,8 +25,6 @@ module AktionTest
             if File.exists? @subject
               unless File.directory? @subject
                 "#{@subject} is not a directory."
-              else
-                "Unknown"
               end
             else
               "#{@subject} does not exist."

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

@@ -59,8 +59,6 @@ module AktionTest
             if File.exists?(@subject)
               if File.directory?(@subject)
                 "#{@subject} is a directory."
-              else
-                "Unknown Problem"
               end
             else
               "#{@subject} does not exist."

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

@@ -25,8 +25,6 @@ module AktionTest
             if File.exists?(@subject)
               if File.directory?(@subject)
                 "#{@subject} is a directory."
-              else
-                "Unknown"
               end
             else
               "#{@subject} does not exist."

data/lib/aktion_test/module/aktion_test.rb

@@ -1,18 +1,21 @@
 module AktionTest
   module Module
-    module AktionTest
-      extend ActiveSupport::Concern
-      
-      included do |spec_helper|
+    class AktionTest < Base
+      def initialize(spec, options={})
+        super
+        spec.use :Simplecov
+      end
+
+      def prepare
         require 'aktion_test/matchers/base'
+      end
 
-        ::RSpec.configure do |config|
-          config.include Support::ClassBuilder
-          config.include Matchers::FileSystem::DirectoryExistance
-          config.include Matchers::FileSystem::FileExistance
-          config.include Matchers::FileSystem::DirectoryContains
-          config.include Matchers::FileSystem::FileContains
-        end
+      def configure
+        rspec.include Support::ClassBuilder
+        rspec.include Matchers::FileSystem::DirectoryExistance
+        rspec.include Matchers::FileSystem::FileExistance
+        rspec.include Matchers::FileSystem::DirectoryContains
+        rspec.include Matchers::FileSystem::FileContains
       end
     end
   end

data/lib/aktion_test/module/base.rb

@@ -0,0 +1,22 @@
+module AktionTest
+  module Module
+    class Base
+      def initialize(spec, options={})
+        @options, @spec = options, spec
+        @rspec = ::RSpec.configuration
+      end
+
+      def prepare
+      end
+
+      def configure
+      end
+
+      def cleanup
+      end
+
+    protected
+      attr_reader :rspec, :options
+    end
+  end
+end

data/lib/aktion_test/module/factory_girl.rb

@@ -1,14 +1,12 @@
 module AktionTest
   module Module
-    module FactoryGirl
-      extend ActiveSupport::Concern
-      
-      included do |spec_helper|
+    class FactoryGirl < Base
+      def prepare
         require 'factory_girl'
+      end
 
-        ::RSpec.configure do |config|
-          config.include ::FactoryGirl::Syntax::Methods
-        end
+      def configure
+        rspec.include ::FactoryGirl::Syntax::Methods
       end
     end
   end

data/lib/aktion_test/module/faker.rb

@@ -1,9 +1,7 @@
 module AktionTest
   module Module
-    module Faker
-      extend ActiveSupport::Concern
-      
-      included do |spec_helper|
+    class Faker < Base
+      def prepare
         require 'faker'
       end
     end

data/lib/aktion_test/module/rspec.rb

@@ -1,14 +1,10 @@
 module AktionTest
   module Module
-    module RSpec
-      extend ActiveSupport::Concern
-      
-      included do |spec_helper|
-        ::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
+    class RSpec < Base
+      def configure
+        rspec.treat_symbols_as_metadata_keys_with_true_values = true
+        rspec.run_all_when_everything_filtered = true
+        rspec.order = 'random'
       end
     end
   end

data/lib/aktion_test/module/simplecov.rb

@@ -1,8 +1,13 @@
 module AktionTest
   module Module
-    module Simplecov
-      require 'simplecov'
-      ::SimpleCov.start
+    class Simplecov < Base
+      def initialize(spec, options={})
+        super
+        require 'simplecov'
+        ::SimpleCov.start do
+          add_filter '/spec/'
+        end
+      end
     end
   end
 end

data/lib/aktion_test/module/timecop.rb

@@ -1,11 +1,13 @@
 module AktionTest
   module Module
-    module Timecop
-      extend ActiveSupport::Concern
-
-      included do |spec_helper|
+    class Timecop < Base
+      def prepare
         require 'timecop'
       end
+
+      def configure
+        rspec.after { ::Timecop.return }
+      end
     end
   end
 end

data/lib/aktion_test/spec_helper.rb

@@ -1,27 +1,18 @@
-require 'singleton'
+require 'aktion_test/module/base'
 
 module AktionTest
   class SpecHelper
-    include Singleton
-
-    attr_reader :modules, :options, :scope
+    attr_reader :modules, :options
+    attr_writer :scope
 
     class << self
-      def load(*names, &block)
-        if names.any?
-          instance.load(*names)
+      def build(&block)
+        new.tap do |sh|
+          if block_given?
+            sh.instance_eval(&block)
+            sh.compile!
+          end
         end
-
-        instance.instance_eval(&block) if block_given?
-
-        instance.modules.each{|mod| include mod}
-      end
-
-      def add_module(name, options={})
-      end
-
-      def add_modules(*names)
-        names.each{|name| add_module(name)}
       end
     end
 
@@ -31,41 +22,44 @@ module AktionTest
 
     def reset
       @modules = []
-      @options = {}
       @scope   = %w(AktionTest Module)
     end
 
-    def loaded?(name)
-      eval "defined? AktionTest::Module::#{name}"
-    end
-
-    def load(*names)
+    def use(*names)
       options = names.extract_options!
+      return names.each {|name| use name} if names.many?
 
-      names.each do |name|
-        unless options.nil? or options.empty?
-          self.options.merge! name => options
-        end
-        load_constant(name)
+      name = names.first
+
+      klass = case name
+      when Class then name
+      when /^::/ then name.constantize
+      else "#{@scope.join('::')}::#{name}".constantize
       end
-    end
 
-    def within(scope, &block)
-      self.scope << scope.to_s
-      yield
-      self.scope.pop
+      unless klass.ancestors.include? AktionTest::Module::Base
+        raise ArgumentError.new("#{klass.name} must inherit from AktionTest::Module::Base") 
+      end
+
+      modules << klass.new(self, options)
     end
 
-  private
+    def scope(name='')
+      return @scope if name.blank?
+      raise ArgumentError.new("A block is required when applying a temporary scope") unless block_given?
 
-    def load_constant(name)
-      name = "#{self.scope.join('::')}::#{name}"
       begin
-        const = name.constantize
-        self.modules << const
-      rescue NameError
-        puts "Unknown module #{name}."
+        scope << name
+        yield
+      ensure
+        scope.pop
       end
     end
+
+    def compile!
+      modules.each &:prepare
+      modules.each &:configure
+      modules.each &:cleanup
+    end
   end
 end

data/lib/aktion_test/support/class_builder.rb

@@ -9,11 +9,11 @@ module AktionTest
         end
       end
 
-      def define_class(class_name, base = Object, &block)
+      def define_class(class_name, base = Object, scope = Object, &block)
         class_name = class_name.to_s.camelize
 
         Class.new(base).tap do |constant_class|
-          Object.const_set(class_name, constant_class)
+          scope.const_set(class_name, constant_class)
           constant_class.unloadable
           constant_class.class_eval(&block) if block_given?
           constant_class.reset_column_information if constant_class.respond_to? :reset_column_information

data/lib/aktion_test/version.rb

@@ -1,3 +1,3 @@
 module AktionTest
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/aktion_test/spec_helper_spec.rb

@@ -1,36 +1,90 @@
 require 'spec_helper'
 
 describe AktionTest::SpecHelper do
-  subject { described_class.instance }
-  before { subject.reset }
-
-  its(:modules) { should be_a Array }
-  its(:options) { should be_a Hash }
-  its(:scope)   { should be_a Array }
-  its(:scope)   { should == %w(AktionTest Module) }
-
-  describe '#within' do
-    it 'allows a scope to be added' do
-      subject.within :Test do
-        subject.scope.should == %w(AktionTest Module Test)
+  describe '::build' do
+    it 'instance evals the given block within the context of a spec helper' do
+      be_kind_of_spec_helper = be_kind_of described_class
+      described_class.build { self.should be_kind_of_spec_helper }
+    end
+
+    it 'returns the spec helper instance used in the instance eval' do
+      sh1 = nil
+      sh2 = described_class.build {sh1 = self}
+      sh1.should == sh2
+    end
+  end
+
+  describe '::new' do
+    its(:modules) { should be_a Array }
+    its(:modules) { should be_empty }
+    its(:scope)   { should == %w(AktionTest Module) }
+  end
+
+  describe '#use' do
+    before do
+      define_class 'TestMod', AktionTest::Module::Base
+    end
+
+    it 'creates a new module of the given class' do
+      subject.use TestMod
+      subject.modules.first.should be_kind_of TestMod
+    end
+
+    it 'creates a new module of the given string without a scope' do
+      subject.use '::TestMod'
+      subject.modules.first.should be_kind_of TestMod
+    end
+
+    it 'creates a new module of the given symbol with a scope' do
+      module TestModule; end
+      define_class 'TestMod', AktionTest::Module::Base, TestModule
+      subject.scope = ['TestModule']
+      subject.use :TestMod
+      subject.modules.first.should be_kind_of TestModule::TestMod
+    end
+
+    it 'forwards any options to the new module' do
+      TestMod.should_receive(:new).with(kind_of(AktionTest::SpecHelper), :with => :options)
+      subject.use TestMod, :with => :options
+    end
+
+    it 'raises an ArgumentError if the class is not a base module' do
+      define_class 'NonMod'
+      expect { subject.use NonMod }.to raise_error(ArgumentError, /must inherit from AktionTest::Module::Base/)
+    end
+
+    it 'can load multiple modules at once' do
+      define_class 'AnotherMod', AktionTest::Module::Base
+      subject.use TestMod, AnotherMod
+      subject.modules.map(&:class).should include(TestMod, AnotherMod)
+    end
+  end
+
+  describe '#scope' do
+    it 'allows temporarily changing the scope' do
+      subject.scope 'TestScope' do
+        subject.scope.should == %w(AktionTest Module TestScope)
       end
       subject.scope.should == %w(AktionTest Module)
     end
-  end
 
-  describe '#load' do
-    it 'initializes the module, adds it to a set of loaded modules, and saves any options' do
-      subject.scope.pop(2)
-      subject.scope << 'Baz'
+    it 'returns the current scope with no arguments' do
+      subject.scope.should == %w(AktionTest Module)
+    end
 
-      Baz.autoload?(:Bar).should_not be_nil
+    it 'raises an ArgumentError if no block is given and a scope is named' do
+      expect { subject.scope 'TestScope' }.to raise_error(ArgumentError, /block is required/)
+    end
 
-      described_class.load :Bar, :test => :option
+    it 'resets the scope even if an error occurs in the block' do
+      begin
+        subject.scope 'TestScope' do
+          raise 'an error'
+        end
+      rescue
+      end
 
-      subject.modules.should == [Baz::Bar]
-      Baz.autoload?(:Bar).should be_nil
-      subject.options.should have_key(:Bar)
-      subject.options[:Bar].should == {:test => :option}
+      subject.scope.should == %w(AktionTest Module)
     end
   end
 end

data/spec/matchers/base_spec.rb

@@ -2,13 +2,27 @@ require 'spec_helper'
 
 describe AktionTest::Matchers::Base do
   before :each do
-    matcher_class = define_class('Matcher', described_class) do
-      def expectation;         "an expectation";               end
-      def problems_for_should; "\na problem\nanother problem"; end
+    define_class('Matcher', described_class) do
+      def expectation;             "an expectation";               end
+      def problems_for_should;     "\na problem\nanother problem"; end
       def problems_for_should_not; "\na problem\nanother problem"; end
     end
 
-    @matcher = matcher_class.new
+    define_class 'EmptyMatcher', described_class
+
+    @matcher = ::Matcher.new
+  end
+
+  it 'provides a warning that the expectation has not been set' do
+    matcher = EmptyMatcher.new
+    matcher.stub(:perform_match! => false)
+    matcher.matches? nil
+    matcher.failure_message.should =~ /Override expectation to provide expectation details/
+  end
+
+  it 'raises an error if perform_match! is not overriden' do
+    matcher = EmptyMatcher.new
+    expect { matcher.matches? nil }.to raise_error(/Override perform_match!/)
   end
     
   describe '#failure_message' do
@@ -32,6 +46,13 @@ describe AktionTest::Matchers::Base do
       @matcher.matches? nil
       expect { @matcher.failure_message }.to raise_error(RuntimeError, /failure message while/)
     end
+
+    it 'provides a warning the failure message has not been set' do
+      matcher = EmptyMatcher.new
+      matcher.stub(:perform_match! => false)
+      matcher.matches? nil
+      matcher.failure_message.should =~ /Override problem_for_should /
+    end
   end
 
   describe '#negative_failure_message' do
@@ -55,5 +76,12 @@ describe AktionTest::Matchers::Base do
       @matcher.matches? nil
       expect { @matcher.negative_failure_message }.to raise_error(RuntimeError, /negative failure message while/)
     end
+
+    it 'provides a warning the failure message has not been set' do
+      matcher = EmptyMatcher.new
+      matcher.stub(:perform_match! => true)
+      matcher.matches? nil
+      matcher.negative_failure_message.should =~ /Override problem_for_should_not/
+    end
   end
 end

data/spec/spec_helper.rb

@@ -2,4 +2,9 @@ $: << File.dirname(__FILE__)
 require 'aktion_test'
 require 'support/autoload'
 
-AktionTest::SpecHelper.load :Simplecov, :RSpec, :AktionTest, :Timecop, :FactoryGirl, :Faker
+AktionTest::SpecHelper.build do
+  use :AktionTest, :FactoryGirl, :Faker, :RSpec, :Timecop
+end
+
+SimpleCov.add_group 'Matchers', 'lib/aktion_test/matchers'
+SimpleCov.add_group 'Modules',  'lib/aktion_test/module'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aktion_test
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -116,6 +116,7 @@ files:
 - lib/aktion_test/matchers/file_system/file_contains.rb
 - lib/aktion_test/matchers/file_system/file_existance.rb
 - lib/aktion_test/module/aktion_test.rb
+- lib/aktion_test/module/base.rb
 - lib/aktion_test/module/factory_girl.rb
 - lib/aktion_test/module/faker.rb
 - lib/aktion_test/module/rspec.rb
@@ -153,9 +154,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -615248081
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Gems, libs, helpers for test suites.