bluff 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Jan 12 2012 - v0.0.4
+
+* Bluff calls are stricter now to give us more control in the bluff definitions. A bluff call accepts a single hash argument and default block values can no longer be defined in the block signatures.
+* Added initial DSL support for **requires()**, **default()**, and **defaults()**
+
 ## Jan 11 2012 - v0.0.3
 
 * Added architecture for multiple backend/orm support (only activerecord provided so far)

data/README.md

@@ -1,20 +1,20 @@
-= bluff
+# bluff
 
 * https://github.com/islandr/bluff
 
-== DESCRIPTION:
+## DESCRIPTION:
 
 A single source of lies for all your testing needs.
 
-== FEATURES/PROBLEMS:
+## FEATURES/PROBLEMS:
 
 * TODO
 
-== CONTRIBUTING:
+## CONTRIBUTING:
 
 Pull requests are welcome!  See the DEVELOPERS section at the bottom of this page for more information.
 
-== SYNOPSIS:
+## OVERVIEW:
 
 My original intentions for bluff are focused on rails/activerecord but I'm open
 to other libraries if it doesn't pollute the API.
@@ -24,14 +24,14 @@ 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
+### MODEL AND DATA BLUFFS
 
-Bluff comes with a small set of predefined data bluffs (see lib/bluff/bluffs/data_bluffs.rb) 
+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*.
+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 
@@ -52,14 +52,45 @@ Bluff.for(:name) { Faker::Name.name } # Call via Bluff.name
 Bluff.for(:company_name) { Faker::Company.name }
 ```
 
-==== CALLING YOUR BLUFFS
+#### HELPERS
+
+There is a very tiny DSL built into Bluff to help you out.  Three methods are available:
+`requires()`, `default()`, and `defaults()`.
+
+**requires(:attribute, :attribute, ...)** takes a list of required attributes. If any of those attributes were not
+provided an ArgumentError will be thrown.
+
+**default(:attribute, :value)** takes an attribute and a default value. If the attribute was not previously defined
+it will be assigned the given value.  If you have multiple defaults to set, use the hash version instead **defaults({:attribute => :value, :attribute => value, ...})**
+
+Here's an example of how you might put these two little guys to work:
+
+```
+Bluff.for(:workspace) do |attributes|
+  requires(:account)
+  
+  defaults({
+    :name => Bluff.name
+  })
+
+  User.new(attributes).tap do |user|
+    # sometimes it's easier to define the default values down here instead
+    user.email ||= Bluff.email({:name => user.name})
+  end
+end
+```
+
+Feel free to use them or huck em to the curb and just work directly with the attributes hash.
+
+#### 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
+User.bluff({:name => 'Ryan'}) # supply overrides/defaults in the attributes hash
 ```
 
-=== METHOD BLUFFS (MOCKS / STUBS)
+### 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 
@@ -76,12 +107,12 @@ 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:
+## REQUIREMENTS:
 
 * rspec-mocks
 * faker
 
-== INSTALL:
+## INSTALL:
 
 * `gem install bluff`
 * or simply add bluff to your Gemfile and run `bundle install`
@@ -92,7 +123,7 @@ group :test do
 end
 ```
 
-== FURTHER READING:
+## FURTHER READING:
 
 http://faker.rubyforge.org/
 
@@ -100,7 +131,7 @@ 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:
+## DEVELOPERS:
 
 After checking out the source, run:
 
@@ -108,7 +139,7 @@ After checking out the source, run:
 
 This task will install any missing dependencies and run the tests/specs.
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 

data/lib/bluff/bluffs/data_bluffs.rb

@@ -2,8 +2,8 @@ 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) }
+Bluff.for(:username) { (params[:name] ||= Bluff.name).parameterize }
+Bluff.for(:email) { Faker::Internet.email( params[:name] || Bluff.name ) }
 
 # companies
 Bluff.for(:company_name) { Faker::Company.name }
@@ -12,5 +12,5 @@ Bluff.for(:company_name) { Faker::Company.name }
 Bluff.for(:domain) { Faker::Internet.domain_name }
 
 # words
-Bluff.for(:words) {|count = 3| Faker::Lorem.words(count) }
+Bluff.for(:words) { Faker::Lorem.words(params[:count] || 3) }
 Bluff.for(:phrase) { Faker::Company.bs }

data/lib/bluff/builder.rb

@@ -1,12 +1,72 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/array/conversions'
+require 'active_support/core_ext/hash/indifferent_access'
+
 require 'bluff/support/backend'
+require 'bluff/support/backend/active_record'
 
 module Bluff
   module Builder
+    class Definition
+      def initialize(target, attributes = {})
+        @target = target
+        @attributes = attributes
+        
+        if @attributes.is_a?(Hash)
+          @attributes = @attributes.with_indifferent_access
+        else
+          raise ArgumentError, 'Bluff argument must be a single hash'
+        end
+      end
+      
+      def attributes
+        @attributes
+      end
+      
+      def attributes=(hash)
+        @attributes = hash
+      end
+      
+      # can use whatever fits the situation
+      alias :params :attributes
+      alias :params= :attributes=
+      
+      def execute(&block)
+        self.instance_exec(@attributes, &block)
+      end
+      
+      def requires(attributes)
+        missing = []
+        
+        Array.wrap(attributes).each do |attribute|
+          missing << attribute unless provided?(attribute)
+        end
+        
+        raise ArgumentError, "#{missing.to_sentence} cannot be bluffed for #{@target}" unless missing.empty?
+      end
+      
+      def default(attribute, value)
+        @attributes[attribute] = value if @attributes[attribute].blank?
+      end
+      
+      def defaults(hash)
+        hash.each {|key, value| default(key, value)}
+      end
+      
+      private
+      # returns true if attributes contains attribute or attribute_id
+      def provided?(attribute)
+        @attributes.is_a?(Hash) && !(@attributes[attribute].blank? && @attributes["#{attribute}_id"].blank?)
+      end
+    end
+    
     module ClassMethods
-        # def insist(field)
-      #   raise ArgumentError, "#{field} cannot be bluffed for #{target}"
-      # end
-  
+      # bluffs for all!
+      # Object.define_singleton_method :bluff do puts 'bluff on class'; end # defines class method
+      # Object.send :define_method, :bluff do puts 'bluff on instance'; end # defines instance method
+      # can pass lambda
+      
       # options: class_name
       def for(field, options = {}, &block)
         options = {:bang => true}.merge(options)
@@ -22,13 +82,12 @@ module Bluff
       end
   
       def define_bluff(field, &block)
-        define_singleton_method(field) do |*args|
+        define_singleton_method(field) do |*arguments|
           bluffed_object = nil
       
           config.max_attempts.times do
-            bluffed_object = block.call(*args)
+            bluffed_object = Definition.new(field, *arguments).execute(&block) #DSL.instance_exec(*args, &block)
             break if !bluffed_object.respond_to?(:valid?) || bluffed_object.valid?
-            puts "!!!! FAILED BLUFF -- REATTEMPTING"
           end
       
           bluffed_object
@@ -36,8 +95,8 @@ module Bluff
       end
   
       def define_bluff_bang(field)
-        define_singleton_method "#{field}!" do |*args|
-          send(field, *args).tap do |record|
+        define_singleton_method "#{field}!" do |*arguments|
+          send(field, *arguments).tap do |record|
             Bluff::Support::Backend.save!(record, field)
           end
         end
@@ -46,19 +105,43 @@ module Bluff
       def extend_target(field, options)
         class_name = options[:class_name] || field.to_s.camelize
         
-        if Kernel.const_defined?(class_name)
-          klass = Kernel.const_get(class_name)
+        # need to find a way to autoload existing classes that haven't been loaded yet
+        begin
+          klass = class_name.constantize
+        rescue NameError
+          # alright if it doesn't exist
+        end
         
+        if klass        
           # just forward the calls back to Bluff
-          klass.define_singleton_method :bluff do |*args|
-            Bluff.send(field, *args)
+          bluff = lambda {|*args| Bluff.send(field, *args)}
+          bluff_bang = lambda {|*args| Bluff.send("#{field}!", *args)}
+          
+          klass.singleton_class.instance_eval do
+            # define_method(:bluff) {|*args| dsl.instance_exec(*args, &bluff) }
+            # define_method(:bluff!) {|*args| dsl.instance_exec(*args, &bluff_bang) } if options[:bang]
+            # 
+            define_method(:bluff) {|*args| bluff.call(*args) }
+            define_method(:bluff!) {|*args| bluff_bang.call(*args) } if options[:bang]
           end
+            
+          # puts "def bluff(*args); Bluff.send(:#{field}, *args); end"
+          # klass.instance_eval { "def bluff(*args); Bluff.send(:#{field}, *args); end" }
+          # 
+          # .instance_eval { "def bluff(*args); Bluff.send(:account, *args); end" }
+          # klass.define_singleton_method :bluff do |*args|
+          #             Bluff.send(field, *args)
+          #           end
+          
+          #puts "bluff method is #{klass.bluff}"
 
-          if options[:bang]
-            klass.define_singleton_method :bluff! do |*args|
-              Bluff.send("#{field}!", *args)
-            end
-          end
+          # if options[:bang]
+          #   klass.define_singleton_method :bluff! do |*args|
+          #     Bluff.send("#{field}!", *args)
+          #   end
+          #   
+          #   #puts "bluff bang method is #{klass.bluff!}"
+          # end
         else
           # not a big deal. bluff might be data instead of a model.
           # puts "Bluff class not found: #{class_name}"

data/lib/bluff/support/{active_record.rb → backend/active_record.rb}

@@ -1,4 +1,6 @@
-class ActiveRecord::Base
+module ActiveRecord
+  class Base
+  end
 end
 
 module Bluff::Support::ActiveRecord

data/lib/bluff/version.rb

@@ -1,3 +1,3 @@
 module Bluff
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/models/api_spec.rb

@@ -9,6 +9,67 @@ describe Bluff do
         Bluff.foo.should eq('bar')
       end
     end
+    
+    context 'when given additional arguments' do
+      it 'passes the arguments for use in the bluff' do
+        Bluff.for(:foo) {|attributes| attributes[:value]}
+        Bluff.foo({:value => 'override'}).should eq('override')
+      end
+    end
+    
+    it 'executes within the DSL context' do
+      Bluff.for(:foo) { self.class.should == Bluff::Builder::Definition } # matchers not defined on self ??
+      Bluff.foo
+    end
+    
+    describe 'block' do
+      # context 'when an argument is required' do
+      #   Bluff.for(:foo) {|value| value}
+      #   
+      #   describe 'calling the bluff without an argument should raise an error' do
+      #     Bluff.foo
+      #     # lambda{ Bluff.foo }.should raise_error
+      #   end
+      #   
+      #   describe 'calling the bluff with an argument should pass the argument to the block' do
+      #     Bluff.foo(99).should eq(99)
+      #   end
+      # end
+      
+      describe 'DSL' do
+        describe '.requires' do
+          it 'raises an error if the required attribute is missing' do
+            Bluff.for(:foo) {|attributes| requires(:bar) }
+            lambda{ Bluff.foo }.should raise_error(ArgumentError, /bar cannot be bluffed for foo/)
+          end
+        
+          it 'does nothing if the attribute is present' do
+            Bluff.for(:foo) {|attributes| requires(:bar) }
+            lambda{ Bluff.foo({:bar => :red}) }.should_not raise_error
+          end
+        
+          it 'checks for the foreign key if the association is missing' do
+            Bluff.for(:foo) {|attributes| requires(:bar) }
+            lambda{ Bluff.foo({:bar_id => :red}) }.should_not raise_error
+          end
+        end
+
+        # attributes.requires(:).defaults(:)
+
+        describe '.default' do
+          it 'assigns the given value to the attributes hash if blank' do
+            Bluff.for(:foo) {|attributes|
+              default(:bar, :red)
+              attributes[:bar]
+            }
+            
+            Bluff.foo.should eq(:red)
+            Bluff.foo({:bar => ''}).should eq(:red)
+            Bluff.foo({:bar => :blue}).should eq(:blue)
+          end
+        end
+      end
+    end
   end
   
   describe '.bluff' do

data/spec/support/matchers/bluff_for.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bluff
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164883740 !ruby/object:Gem::Requirement
+  requirement: &2166846800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2164883740
+  version_requirements: *2166846800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164880180 !ruby/object:Gem::Requirement
+  requirement: &2166845760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *2164880180
+  version_requirements: *2166845760
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &2164878820 !ruby/object:Gem::Requirement
+  requirement: &2166844480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2164878820
+  version_requirements: *2166844480
 description: ''
 email:
 - ryan.mohr@gmail.com
@@ -61,8 +61,8 @@ files:
 - lib/bluff/bluffs/data_bluffs.rb
 - lib/bluff/builder.rb
 - lib/bluff/configuration.rb
-- lib/bluff/support/active_record.rb
 - lib/bluff/support/backend.rb
+- lib/bluff/support/backend/active_record.rb
 - lib/bluff/support/support.rb
 - lib/bluff/version.rb
 - spec/models/api_spec.rb