blunt_stub_factory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b28dedc5ea8959a845e8b1aadc8476d40c386ed0
+  data.tar.gz: e0e64b1248c8e3e98a0e8fc96857eb9bf1938ff7
+SHA512:
+  metadata.gz: e056ee77751634e4958a5c29be3cdb23afc5f6bf08e7a06ccbac632ee9ce4cfa1062e725276b758e2266d3624f4db980a423d5f59ca66d19c106620d2aa246e8
+  data.tar.gz: b4b26b7f052e4b9e91cc97553792b8d16462b7979be4b5c2055d05f092703dfb10fb0713abd3ab93311122db0a49079732f33e5cfb2f24a5b3c87f7ab09cabee

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stub_factory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LFDM
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# StubFactory
+
+A blunt StubFactory that helps to test tightly coupled code, but handle with care: This is not a best practice. If you find yourself relying on this a lot, you might have to rethink your design. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stub_factory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stub_factory
+
+## Usage
+
+```ruby
+require 'stub_factory'
+
+Class A
+  attr_reader :test, :test2
+  
+  def initialize
+    @test  = "a value"
+    @test2 = "another value"
+  end
+  
+  def a_method
+    "original return"
+  end
+end
+```
+
+StubFactory provides a method to bypass the constructor of an object and set it's instance variables by force.
+
+```ruby
+a = A.new_stub(vars: { test: "overwritten" })
+b = A.new
+
+a.test 
+# => "overwritten"
+b.test 
+# => "original value"
+```
+
+Default as well as custom templates to overwrite variables can be defined - StubFactory automatically looks for such statements
+in your spec/factories folder.
+```ruby
+StubFactory.define_template(:a) do
+  { test2 = "template value" }
+end
+
+StubFactory.define_template(:other) do
+  { test2 = "custom value" }
+end
+
+# a new stub tries to look up a template by his class name by default
+a = A.new_stub
+a.test2
+# => "template value"
+
+# default template overwritten with custom template
+b = A.new_stub(template: :custom)
+b.test2
+# => "custom value"
+
+# if template is passed with a value of nil, no template will be used
+c = A.new_stub(template: nil)
+c.test2
+# => "another value"
+```
+
+Method return values can be stubbed.
+```ruby
+a = A.new_stub(methods: { a_method: "overwritten method" }
+b = A.new
+
+a.a_method
+# => "overwritten method"
+b.a_method
+# => "original return"
+```
+
+For ease of use, helper methods can be defined when they are included in your RSpec configuarion. 
+Place define_helper statements in your spec/support/helpers folder.
+```ruby
+RSpec.configure do |config|
+  config.include StubFactory::Helpers
+end
+
+StubFactory.define_helper(:a, :A) do
+  { vars: { test: 1 }, methods: { a_method: 2 } }
+end
+# creates a method stub_a, which translates to A.new_stub(vars: { test: 1 }, methods: { a_method: 2 })
+
+# given a defined template, the helper will automatically refer to it
+StubFactory.define_template(:foo) do
+  { test: 1 }
+end
+
+StubFactory.define_helper(:foo, :A) do
+  { vars: { test2: 2 } }
+end
+
+a = stub_foo
+a.class
+# => A
+a.test
+# => 1
+a.test2
+# => 2
+
+# all default values can be overwritten
+a = stub_foo(vars: { test2: "bypassed" })
+a.test2
+# => "bypassed"
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '-f d --color'
+end
+
+task :default => :spec

data/lib/stub_factory/exceptions.rb

@@ -0,0 +1,4 @@
+module StubFactory
+  class TemplateError < ArgumentError; end
+  class HelperError < ArgumentError; end
+end

data/lib/stub_factory/helpers.rb

@@ -0,0 +1,10 @@
+module StubFactory
+  module Helpers
+    # Namespace for methods created by StubFactory.define_helper.
+    # Include this module in RSpec to make use of 'em, e.g:
+    #
+    # RSpec.configure do |config|
+    #   config.include StubFactory::Helpers
+    # end
+  end
+end

data/lib/stub_factory/version.rb

@@ -0,0 +1,3 @@
+module StubFactory
+  VERSION = "0.0.1"
+end

data/lib/stub_factory.rb

@@ -0,0 +1,121 @@
+require 'stub_factory/version'
+require 'stub_factory/exceptions'
+require 'stub_factory/helpers'
+
+module StubFactory
+  @stub_factory_paths = %w{ spec/factories }
+  @stub_factory_helpers_paths = %w{ spec/support/helpers }
+  @templates = {}
+  @helpers   = []
+
+  class << self
+
+####### Template Handing #######
+
+    def define_template(template_name)
+      tn = template_name.to_sym
+      raise TemplateError, "Template already defined" if template_defined?(tn)
+      raise TemplateError, "Templates need to be defined with a block" unless block_given?
+      values = yield
+      raise TemplateError, "Block must contain a Hash" unless values.kind_of?(Hash)
+      @templates[tn] = values
+    end
+
+    def template_defined?(template)
+      return unless template
+      @templates.has_key?(template.to_sym)
+    end
+
+    def template_for(template)
+      @templates[template.to_sym]
+    end
+
+####### Helper Handling #######
+
+    def define_helper(helper, klass)
+      raise HelperError, "A helper for #{helper} has already been defined" if helper_defined?(helper)
+      @helpers << helper.to_sym
+
+      Helpers.class_eval <<-STR
+        def stub_#{helper}(vars: {}, methods: {})
+          #{klass}.new_stub(vars: vars, methods: methods, template: :#{helper})
+        end
+      STR
+    end
+
+    def helper_defined?(helper)
+      @helpers.include?(helper.to_sym)
+    end
+
+####### Requiring Files #######
+
+    def recursive_require(rel_paths)
+      rel_paths.each do |rel_path|
+        require_path(rel_path)
+      end
+    end
+
+    def require_path(rel_path)
+      path = File.expand_path(rel_path)
+
+      if File.exists?(path)
+        require "#{path}" if File.file?(path)
+        Dir["#{path}/*"].each { |file| require_path(file) }
+      end
+    end
+  end
+
+####### Custom Load Paths - currently not enabled #######
+
+    #def add_factory_path(path)
+    #  @stub_factory_paths << path
+    #end
+
+    #def add_helpers_path(path)
+    #  @stub_factory_helpers_paths << path
+    #end
+
+  recursive_require(@stub_factory_paths)
+  recursive_require(@stub_factory_helpers_paths)
+
+####### Public Method #######
+
+  def new_stub(vars: {}, methods: {}, template: to_underscored_symbol(self.name))
+    obj = allocate
+
+    if StubFactory.template_defined?(template)
+      vars = StubFactory.template_for(template).merge(vars)
+    end
+
+    set_instance_variables(obj, vars)
+    override_methods(obj, methods)
+    obj
+  end
+
+  private
+
+  def set_instance_variables(obj, vars)
+    vars.each do |var, val|
+      obj.instance_variable_set("@#{var}", val)
+    end
+  end
+
+  def override_methods(obj, methods)
+    methods.each do |meth, val|
+      obj.send(:define_singleton_method, meth) do
+        val
+      end
+    end
+  end
+
+  def to_underscored_symbol(class_name)
+    # Namespace::TestClass to :namespace__test_class
+    res = class_name.to_s.dup
+    res.gsub!(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }
+    res.gsub!(/::/, "__")
+    res.downcase.to_sym
+  end
+  module_function :to_underscored_symbol
+end
+
+class Class; include StubFactory; end

data/spec/factories/template_test.rb

@@ -0,0 +1,3 @@
+StubFactory.define_template(:required_template) do
+  { test: 11 }
+end

data/spec/lib/stub_factory_spec.rb

@@ -0,0 +1,145 @@
+require 'stub_factory'
+
+# Methods defined by .define_helper will not work without this:
+RSpec.configure do |config|
+  config.include StubFactory::Helpers
+end
+
+describe StubFactory do
+  before :all do
+    # the attr reader is set for convenience
+    class A; attr_reader :test; end
+  end
+
+  describe ".define_template" do
+    after :each do
+      # delete the just created template because it would persist
+      StubFactory.instance_variable_get(:@templates).delete(:test)
+    end
+
+    it "defines a template" do
+      StubFactory.define_template(:test) { {} }
+      StubFactory.template_defined?(:test).should be_true
+    end
+
+    it "templates can only be defined once" do
+      StubFactory.define_template(:test) { {} }
+      expect { StubFactory.define_template(:test) { {} } }.to raise_error(StubFactory::TemplateError)
+    end
+
+    it "templates need to be defined with a block" do
+      expect { StubFactory.define_template(:test).to raise_error(StubFactory::TemplateError) }
+    end
+  end
+
+  describe ".define_helper" do
+    it 'defines helper methods - shortcuts #stub_#{helper} that use a specific template (first argument) on a new stub of a given class (second argument)' do
+      StubFactory.define_template(:helper) { { test: 13 } }
+      StubFactory.define_helper(:helper, :A)
+
+      stub_helper.should be_an_instance_of A
+      stub_helper.test.should == 13
+    end
+
+    it "helpers cannot be defined twice" do
+      StubFactory.define_helper(:helper2, :A)
+      expect { StubFactory.define_helper(:helper2, :A) }.to raise_error(StubFactory::HelperError)
+    end
+
+    it "helpers can be defined in files - default path is spec/support/helpers" do
+      # required_helper is defined in #spec/support/helper_test.rb
+      stub_required_helper.should be_an_instance_of A
+    end
+  end
+
+  describe "#new_stub" do
+    it "returns a new instance" do
+      A.new_stub.should be_an_instance_of A
+    end
+
+    it "takes variable hash and turns it to instance variables" do
+      o = A.new_stub(vars: { test: 1 })
+      o.test.should == 1
+    end
+
+    context "when a default template exists" do
+      StubFactory.define_template(:a) do
+        { test: 5 }
+      end
+
+      it "instantiates with default values of a template, deriving from class name" do
+        A.new_stub.test.should == 5
+      end
+
+      it "overrides template when instantiated with vars hash" do
+        o = A.new_stub(vars: { test: 2 })
+        o.test.should_not == 1
+        o.test.should     == 2
+      end
+
+      it "disables template set to nil" do
+        o = A.new_stub(template: nil)
+        o.test.should be_nil
+      end
+
+      it "templates can be defined in files - their default path is spec/factories" do
+        # required_template is defined in #spec/factories/template_test.rb
+        A.new_stub(template: :required_template).test.should == 11
+      end
+    end
+
+    context "when a custom template exists" do
+      StubFactory.define_template(:esse) do
+        { test: 12 }
+      end
+
+      it "takes custom template as argument" do
+        o = A.new_stub(template: :esse)
+        o.test.should == 12
+      end
+
+      it "custom templates can be overridden" do
+        o = A.new_stub(template: :esse, vars: { test: 1 })
+        o.test.should == 1
+      end
+    end
+
+    context "when methods need to be overridden" do
+      class A
+        def test_method
+          12
+        end
+      end
+
+      it "leaves methods intact when not overwritten by methods hash" do
+        A.new_stub.test_method.should == 12
+      end
+
+      it "overrides methods with methods hash" do
+        o = A.new_stub(methods: { test_method: 1 })
+        o.test_method.should == 1
+      end
+
+      it "other instances' methods are not overwritten by methods hash - it happens on a singleton level" do
+        a = A.new_stub(methods: { test_method: 1 })
+        b = A.new_stub(methods: { test_method: 2 })
+        c = A.new_stub
+
+        a.test_method.should == 1
+        b.test_method.should == 2
+        c.test_method.should == 12
+      end
+    end
+
+    context "how default template lookup works" do
+      it "takes class name of self and returns an underscored symobl, namespaces are marked with double underscore" do
+        module TestNamespace
+          class TestClass; end
+        end
+
+        class_name = TestNamespace::TestClass.new.class.name
+        StubFactory.to_underscored_symbol(class_name).should == :test_namespace__test_class
+      end
+    end
+  end
+end

data/spec/support/helpers/helper_test.rb

@@ -0,0 +1 @@
+StubFactory.define_helper(:required_helper, :A)

data/stub_factory.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stub_factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blunt_stub_factory"
+  spec.version       = StubFactory::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.description   = %q{Simple StubFactory for rspec}
+  spec.summary       = %q{Simple StubFactory for rspec, that can help with tightly coupled code}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: blunt_stub_factory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple StubFactory for rspec
+email:
+- 1986gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stub_factory.rb
+- lib/stub_factory/exceptions.rb
+- lib/stub_factory/helpers.rb
+- lib/stub_factory/version.rb
+- spec/factories/template_test.rb
+- spec/lib/stub_factory_spec.rb
+- spec/support/helpers/helper_test.rb
+- stub_factory.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple StubFactory for rspec, that can help with tightly coupled code
+test_files:
+- spec/factories/template_test.rb
+- spec/lib/stub_factory_spec.rb
+- spec/support/helpers/helper_test.rb
+has_rdoc: