bluff 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Jan 11 2012
+
+* Added initial implementation with a small set of built-in data bluffs

data/README.md

@@ -0,0 +1,134 @@
+= bluff
+
+* https://github.com/islandr/bluff
+
+== DESCRIPTION:
+
+A single source of lies for all your testing needs.
+
+== FEATURES/PROBLEMS:
+
+* TODO
+
+== CONTRIBUTING:
+
+Pull requests are welcome!  See the DEVELOPERS section at the bottom of this page for more information.
+
+== SYNOPSIS:
+
+My original intentions for bluff are focused on rails/activerecord but I'm open
+to other libraries if it doesn't pollute the API.
+
+The goal is to minimize the amount of mocking/faking pollution in your test suits,
+and to do so via an API that feels natural to rails/activerecord users.  I favor
+a slightly more wordy API for defining bluffs that offers the full power and flexibility
+of Ruby over a cute DSL that limits customization.
+
+=== MODEL AND DATA BLUFFS
+
+Bluff comes with a small set of predefined data bluffs (see lib/bluff/bluffs/data_bluffs.rb) 
+but its easy to add your own.
+
+The standard practice is to define your bluffs within spec/bluffs.  If you are
+bluffing a model, name the file *_model_\_bluff.rb*.  If you need to bluff custom
+data, do so in *data_bluffs.rb*.
+
+A bluff is a bluff, whether it's just a piece of data or a full blown model.  All bluffs
+share the same namespace (the root namespace is the *only* namespace) so choose your bluff 
+names accordingly.
+
+```
+# spec/bluffs/user_bluff.rb
+Bluff.for(:user) do |attributes|
+  attributes[:name] ||= Bluff.name
+  attributes[:email] ||= Bluff.email(attributes[:name])
+  
+  # return your bluffed instance
+  User.new(attributes)
+end
+
+# spec/bluffs/data_bluffs.rb
+Bluff.for(:name) { Faker::Name.name } # Call via Bluff.name
+Bluff.for(:company_name) { Faker::Company.name }
+```
+
+==== CALLING YOUR BLUFFS
+```
+User.bluff  # returns an unsaved instance -- could also use Bluff.user
+User.bluff! # returns a saved instance -- could also use Bluff.user!
+User.bluff({:name => 'Ryan'}) # supply overrides in the attributes hash
+```
+
+=== METHOD BLUFFS (MOCKS / STUBS)
+
+All objects and classes are given a `bluff()` method, which is
+used for bluffing both models and methods.  If given a symbol, the 
+`bluff()` method can be used to define method stubs as follows:
+
+```
+User.bluff(:find) { |id| :value }
+User.bluff(:save) { true }
+
+user = Bluff.mock
+user.bluff(:name).as(:value)
+```
+
+The mocking abilities of bluff are no more than a thin wrapper around
+rspec-mocks.  Calling `Bluff.mock('account')` is identical to calling `double('account')`
+
+== REQUIREMENTS:
+
+* rspec-mocks
+* faker
+
+== INSTALL:
+
+* `gem install bluff`
+* or simply add bluff to your Gemfile and run `bundle install`
+
+```
+group :test do
+  gem 'bluff'
+end
+```
+
+== FURTHER READING:
+
+http://faker.rubyforge.org/
+
+https://www.relishapp.com/rspec/rspec-mocks/
+https://www.relishapp.com/rspec/rspec-mocks/docs/method-stubs/stub-on-any-instance-of-a-class
+https://www.relishapp.com/rspec/rspec-mocks/docs/outside-rspec/configure-any-test-framework-to-use-rspec-mocks
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake setup
+
+This task will install any missing dependencies and run the tests/specs.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Ryan Mohr (github.com/islandr)
+
+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/bluff.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "bluff/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'bluff/version'
 
 Gem::Specification.new do |s|
-  s.name        = "bluff"
+  s.name        = 'bluff'
   s.version     = Bluff::VERSION
-  s.authors     = ["Ryan Mohr"]
-  s.email       = ["ryan.mohr@gmail.com"]
-  s.homepage    = ""
+  s.authors     = ['Ryan Mohr']
+  s.email       = ['ryan.mohr@gmail.com']
+  s.homepage    = 'https://github.com/islandr/bluff'
   s.summary     = %q{A single source of lies for all your testing needs}
   s.description = %q{}
 
-  s.rubyforge_project = "bluff"
+  s.rubyforge_project = 'bluff'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths = ["lib"]
-
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  
+  s.add_development_dependency 'activesupport', '~> 3.0'
+  s.add_development_dependency 'rspec', '~> 2.8'
+  s.add_development_dependency 'faker', '~> 1.0'
 end

data/lib/bluff.rb

@@ -1,4 +1,13 @@
-require "bluff/version"
+require 'active_support'
+require 'active_support/inflector'
+
+require 'bluff/version'
+require 'bluff/configuration'
+require 'bluff/builder'
 
 module Bluff
+  extend Bluff::Configuration::ClassMethods
+  extend Bluff::Builder::ClassMethods
 end
+
+require 'bluff/bluffs/data_bluffs'

data/lib/bluff/bluffs/data_bluffs.rb

@@ -0,0 +1,16 @@
+require 'faker'
+
+# people
+Bluff.for(:name) { Faker::Name.name }
+Bluff.for(:username) {|name = nil| (name ||= Bluff.name).parameterize }
+Bluff.for(:email) {|name = nil| Faker::Internet.email(name) }
+
+# companies
+Bluff.for(:company_name) { Faker::Company.name }
+
+# internet
+Bluff.for(:domain) { Faker::Internet.domain_name }
+
+# words
+Bluff.for(:words) {|count = 3| Faker::Lorem.words(count) }
+Bluff.for(:phrase) { Faker::Company.bs }

data/lib/bluff/builder.rb

@@ -0,0 +1,74 @@
+module Bluff
+  module Builder
+    module ClassMethods
+        # def insist(field)
+      #   raise ArgumentError, "#{field} cannot be bluffed for #{target}"
+      # end
+  
+      # options: class_name
+      def for(field, options = {}, &block)
+        options = {:bang => true}.merge(options)
+    
+        extend_bluff(field, options, &block)
+        extend_target(field, options)
+      end
+  
+      private
+      def extend_bluff(field, options, &block)      
+        define_bluff(field, &block)
+        define_bluff_bang(field) if options[:bang]
+      end
+  
+      def define_bluff(field, &block)
+        define_singleton_method(field) do |*args|
+          bluffed_object = nil
+      
+          config.max_attempts.times do
+            bluffed_object = block.call(*args)
+            break if !bluffed_object.respond_to?(:valid?) || bluffed_object.valid?
+            puts "!!!! FAILED BLUFF -- REATTEMPTING"
+          end
+      
+          bluffed_object
+        end
+      end
+  
+      def define_bluff_bang(field)
+        define_singleton_method "#{field}!" do |*args|
+          send(field, *args).tap do |record|
+            ActiveRecord::Base.transaction do
+              record.class.reflect_on_all_associations(:belongs_to).each do |reflection|
+                association = record.send(reflection.name)
+                association.save! if association && association.new_record?
+              end
+          
+              record.save!
+            end
+          end
+        end
+      end
+  
+      def extend_target(field, options)
+        class_name = options[:class_name] || field.to_s.classify
+      
+        if Kernel.const_defined?(class_name)
+          klass = Kernel.const_get(class_name)
+        
+          # just forward the calls back to Bluff
+          klass.define_singleton_method :bluff do |*args|
+            Bluff.send(field, *args)
+          end
+
+          if options[:bang]
+            klass.define_singleton_method :bluff! do |*args|
+              Bluff.send("#{field}!", *args)
+            end
+          end
+        else
+          # not a big deal. bluff might be data instead of a model.
+          # puts "Bluff class not found: #{class_name}"
+        end
+      end
+    end
+  end
+end

data/lib/bluff/configuration.rb

@@ -0,0 +1,20 @@
+module Bluff
+  module Configuration    
+    class Base
+      attr_accessor :max_attempts
+    
+      def initialize
+        # since we're faking the data but using real objects, there may be times where
+        # an object fails to validate due to duplicates etc. Bluff will retry up to
+        # max_attempts times before calling it quits
+        @max_attempts = 10
+      end
+    end
+  
+    module ClassMethods
+      def config
+        @config ||= Configuration::Base.new
+      end
+    end
+  end
+end

data/lib/bluff/version.rb

@@ -1,3 +1,3 @@
 module Bluff
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/models/api_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Bluff do
+  # define the basic data API
+  describe '.for' do
+    context 'at the basic level' do
+      it 'accepts a target and a block and returns the value of the block' do
+        Bluff.for(:foo) { 'bar' }
+        Bluff.foo.should eq('bar')
+      end
+    end
+  end
+  
+  describe 'data' do    
+    context 'when requesting a defined data bluff' do
+      bluffs = [
+        #
+        # alright to add to these but DO NOT REMOVE them without 
+        # good reason and without bumping the major version
+        #
+        
+        # people
+        :name,
+        :username,
+        :email,
+        
+        # companies
+        :company_name,
+        
+        # words
+        :words,
+        :phrase
+      ]
+    
+      bluffs.each do |target|
+        specify { should bluff_for(target) }
+      end
+    end
+  
+    context 'when requesting an undefined data bluff' do
+      it 'should raise an exception' do
+        lambda{ Bluff.missing }.should raise_error
+      end
+    end
+  end
+end

data/spec/models/data_bluffs_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Bluff do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+SPEC_ROOT = File.expand_path(File.dirname(__FILE__)) # ENV["RAILS_ENV"] ||= 'test'
+# 
+# require_relative '../../config/environment'
+# require 'rspec/rails'
+
+require_relative '../lib/bluff.rb'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+%w(support bluffs).each do |dir|
+  Dir[File.join(SPEC_ROOT, dir, '**', '*.rb')].each {|f| require f}
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/matchers/bluff.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :bluff_for do |expected|
+  match do
+    begin
+      Bluff.send(expected)
+    rescue
+      false
+    end
+  end
+end

data/spec/support/matchers/bluff_instance_of.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :bluff_instance_of do |expected|
+  match do |actual|
+    actual.should be_an_instance_of(ActiveRecord::Relation)
+  end
+end

metadata

@@ -1,73 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bluff
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ryan Mohr
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-27 00:00:00 -10:00
-default_executable: 
-dependencies: []
-
-description: ""
-email: 
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2160674180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160674180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160673400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *2160673400
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &2160672460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160672460
+description: ''
+email:
 - ryan.mohr@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- README.md
 - Rakefile
 - bluff.gemspec
 - lib/bluff.rb
+- lib/bluff/bluffs/data_bluffs.rb
+- lib/bluff/builder.rb
+- lib/bluff/configuration.rb
 - lib/bluff/version.rb
-has_rdoc: true
-homepage: ""
+- spec/models/api_spec.rb
+- spec/models/data_bluffs_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/bluff.rb
+- spec/support/matchers/bluff_instance_of.rb
+homepage: https://github.com/islandr/bluff
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: bluff
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A single source of lies for all your testing needs
-test_files: []
-
+test_files:
+- spec/models/api_spec.rb
+- spec/models/data_bluffs_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/bluff.rb
+- spec/support/matchers/bluff_instance_of.rb