sham 1.0.0 → 1.0.1

data/.gitignore

@@ -1,3 +1,4 @@
+bin/
 pkg/*
 *.gem
 *.swp

data/README.markdown

@@ -1,6 +1,6 @@
 # Sham
 
-Lightweight flexible factories for Ruby on Rails testing.
+Lightweight flexible factories for Ruby and Rails testing.
 
 ## Installation
 
@@ -26,6 +26,13 @@ your application.rb or test.rb file:
       Sham::Config.activate!
     end
 
+If you are not using Rails you can activate all of your shams by specifying a
+path under which your shams are defined. For instance, this command will load
+all Ruby files under the `/my/project/path/sham` directory and and all
+subdirectories.
+
+    Sham::Config.activate!('/my/project/path')
+
 To enable all Shams in cucumber, add the following to your
 features/support/env.rb file:
 

data/lib/sham.rb

@@ -1,103 +1,8 @@
-module Sham
-  class Base
-    attr_accessor :klass, :options
+module Sham; end
 
-    def initialize klass, options = {}
-      @klass = klass
-      @options = options
-    end
+require 'sham/data'
+require 'sham/util'
+require 'sham/base'
+require 'sham/config'
+require 'sham/shammable'
 
-    def sham!
-      @klass.sham! @options
-    end
-  end
-
-  class Config
-    def self.activate!
-      Dir["#{Rails.root}/sham/**/*.rb"].each do |f|
-        load f
-      end
-    end
-
-    attr_accessor :klass, :name
-
-    def initialize klass, name
-      self.klass = klass
-      self.name = name
-    end
-
-    def attributes &attributes
-      klass.add_sham_attributes(name, attributes)
-    end
-
-    def empty
-      klass.add_sham_attributes(name, Proc.new{ Hash.new() })
-    end
-  end
-
-  def self.config klass, name = :default
-    unless klass.include?(Sham::Shammable)
-      klass.send(:include, Sham::Shammable)
-    end
-    yield(Sham::Config.new(klass, name))
-  end
-
-  def self.string!
-    ActiveSupport::SecureRandom.hex(5)
-  end
-
-  def self.parse! value
-    if value.is_a?(Array)
-      value.map{ |k| parse! k }
-    elsif value.is_a?(Hash)
-      Hash.new value.map{ |k,v| [k, parse!(v)] }
-    elsif value.is_a?(Sham::Base)
-      value.sham!
-    else
-      value
-    end
-  end
-
-  def self.add_options! klass, options = {}, attributes
-    attributes.call.each do |key, value|
-      options[key] = self.parse!(value) unless options.has_key?(key)
-    end
-  end
-
-  module Shammable
-    def self.included(klass)
-      klass.extend(ClassMethods)
-
-      klass.class_eval <<-EVAL
-        def self.add_sham_attributes name, attributes
-          @@sham_attributes ||= {}
-          @@sham_attributes[name] = attributes
-        end
-
-        def self.sham_attributes
-          @@sham_attributes
-        end
-      EVAL
-    end
-
-    module ClassMethods
-      def sham! *args
-        options = (args.extract_options! || {})
-        type = (args[0] == :build ? args[1] : args[0]) || :default
-        build = args[0] == :build || args[1] == :build
-
-        ::Sham.add_options! self.name, options, sham_attributes[type]
-        klass = (options.delete(:type) || self.name).constantize
-        if build
-          klass.new(options)
-        else
-          klass.create(options)
-        end
-      end
-
-      def sham_alternate! type, *args
-        sham!(type, *args)
-      end
-    end
-  end
-end

data/lib/sham/base.rb

@@ -0,0 +1,14 @@
+module Sham
+  class Base
+    attr_accessor :klass, :options
+
+    def initialize klass, options = {}
+      @klass = klass
+      @options = options
+    end
+
+    def sham!
+      @klass.sham!(@options)
+    end
+  end
+end

data/lib/sham/config.rb

@@ -0,0 +1,33 @@
+module Sham
+  class << self
+    def config klass, name = :default
+      unless klass.include?(Sham::Shammable)
+        klass.send(:include, Sham::Shammable)
+      end
+      yield(Sham::Config.new(klass, name))
+    end
+  end
+
+  class Config
+    def self.activate! root = nil
+      root = Rails.root if root.nil? && defined?(Rails.root)
+      root = File.join(root, 'sham', '**', '*.rb')
+      Dir[root].each{ |f| load(f) }
+    end
+
+    attr_accessor :klass, :name
+
+    def initialize klass, name
+      self.klass = klass
+      self.name = name
+    end
+
+    def attributes &config
+      klass.add_sham_config(name, config)
+    end
+
+    def empty
+      klass.add_sham_config(name, Proc.new{ Hash.new() })
+    end
+  end
+end

data/lib/sham/data.rb

@@ -0,0 +1,13 @@
+require 'securerandom'
+
+module Sham
+  class << self
+    def string! len = 5
+      ::SecureRandom.hex(len)
+    end
+
+    def integer! top = 100
+      ::SecureRandom.random_number(top)
+    end
+  end
+end

data/lib/sham/shammable.rb

@@ -0,0 +1,62 @@
+module Sham
+  class << self
+    def parse! value
+      if value.is_a?(Array)
+        value.map{ |k| parse!(k) }
+      elsif value.is_a?(Hash)
+        Hash.new value.map{ |k,v| [k, parse!(v)] }
+      elsif value.is_a?(Sham::Base)
+        value.sham!
+      else
+        value
+      end
+    end
+
+    def add_options! klass, options = {}, attributes
+      attributes.call.each do |key, value|
+        options[key] = parse!(value) unless options.has_key?(key)
+      end
+    end
+  end
+
+  module Shammable
+    def self.included(klass)
+      klass.extend(ClassMethods)
+
+      (class << klass; self; end).instance_eval do
+        attr_accessor :sham_configs
+
+        define_method(:add_sham_config) do |name, config|
+          self.sham_configs ||= {}
+          self.sham_configs[name] = config
+        end
+
+        define_method(:sham_config) do |name|
+          if sham_configs && sham_configs.has_key?(name)
+            sham_configs[name]
+          else
+            superclass.sham_config(name)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def sham! *args
+        options = Sham::Util.extract_options!(args)
+        type = (args[0] == :build ? args[1] : args[0]) || :default
+        build = args[0] == :build || args[1] == :build
+
+        ::Sham.add_options!(name, options, sham_config(type))
+        klass = Sham::Util.constantize(options.delete(:type) || self.name)
+        if build || !klass.respond_to?(:create)
+          klass.new(options)
+        else
+          klass.create(options)
+        end
+      end
+
+      alias :sham_alternate! :sham!
+    end
+  end
+end

data/lib/sham/util.rb

@@ -0,0 +1,15 @@
+module Sham
+  module Util
+    def self.extract_options!(ary)
+      ary.last.is_a?(::Hash) ? ary.pop : {}
+    end
+
+    def self.constantize(word)
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ word
+        raise NameError, "#{word.inspect} is not a valid constant name!"
+      end
+
+      Object.module_eval("::#{$1}", __FILE__, __LINE__)
+    end
+  end
+end

data/lib/sham/version.rb

@@ -1,3 +1,3 @@
 module Sham
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/sham.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["pan.thomakos@gmail.com"]
   s.homepage    = "http://github.com/panthomakos/sham"
   s.summary     = "sham-#{Sham::VERSION}"
-  s.description = %q{Lightweight flexible factories for Ruby on Rails testing.}
+  s.description = %q{Lightweight flexible factories for Ruby and Rails testing.}
 
   s.rubyforge_project = "sham"
 
@@ -20,5 +20,6 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.markdown", "License.txt"]
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.add_development_dependency('rails', '>= 3.0.1')
+
+  s.add_development_dependency('rspec')
 end

data/spec/root/sham/employee.rb

@@ -0,0 +1,11 @@
+class Employee < User
+end
+
+Sham.config(Employee) do |c|
+  c.attributes do
+    {
+      name: "Employee #{Sham.string!}",
+      email: "#{Sham.string!}@company.com"
+    }
+  end
+end

data/spec/sham/base_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Sham::Base do
+  let(:base){ Sham::Base.new(User, name: Sham.string!) }
+
+  it 'should call sham! on the klass' do
+    User.should_receive(:sham!)
+    base.sham!
+  end
+
+  it 'should properly set the attributes' do
+    user = base.sham!
+    user[:name].should == base.options[:name]
+  end
+end

data/spec/sham/config_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+class Company < Object; end
+
+describe Sham::Config do
+  it 'should activate shams in the root directory' do
+    begin
+      expect {
+        described_class.activate!(SPEC_DIR)
+      }.to change{ defined?(Employee) }.from(nil).to('constant')
+    ensure
+      Object.send(:remove_const, :Employee) rescue nil
+    end
+  end
+
+  it 'should include Sham::Shammable when configured' do
+    expect {
+      Sham.config(Company){ |c| c.empty }
+    }.to change{ Company.include?(Sham::Shammable) }.from(false).to(true)
+  end
+
+  it 'should only include Sham::Shammable once when configured' do
+    Company.should_receive(:include).never
+
+    Sham.config(Company, :alternate){ |c| c.empty }
+  end
+
+  it 'should define sham! on the class' do
+    class BiggerCompany < Object; end
+
+    expect {
+      Sham.config(BiggerCompany){ |c| c.empty }
+    }.to change{ BiggerCompany.respond_to?(:sham!) }.from(false).to(true)
+  end
+
+  it 'should define sham_alternate! on the class' do
+    class BiggestCompany < Object; end
+
+    expect {
+      Sham.config(BiggestCompany){ |c| c.empty }
+    }.to change{ BiggestCompany.respond_to?(:sham_alternate!) }
+      .from(false).to(true)
+  end
+
+  context 'shams' do
+    it 'should carry shams over to subclasses' do
+      class SuperUser < User; end
+
+      SuperUser.should respond_to(:sham!)
+      SuperUser.sham![:identifier].should == User.sham![:identifier]
+    end
+
+    it 'should allow subclasses to define their own shams' do
+      class PowerUser < User; end
+
+      Sham.config(PowerUser){ |c| c.empty }
+
+      User.sham_config(:default)
+        .should_not == PowerUser.sham_config(:default)
+    end
+
+    it 'should default to calling #new when #create is not present' do
+      class SimpleUser
+        def initialize(options = {}); end
+      end
+
+      Sham.config(SimpleUser){ |c| c.empty }
+
+      SimpleUser.should_receive(:new).once
+
+      SimpleUser.sham!
+    end
+
+    it 'should allow shams to be built instead of created' do
+      User.should_receive(:create).never
+
+      User.sham!(:build)
+    end
+
+    it 'should create shams by default' do
+      User.should_receive(:create).once
+
+      User.sham!
+    end
+
+    it 'should allow alternate shams to be built' do
+      User.should_receive(:create).never
+
+      User.sham!(:build, :super)
+    end
+
+    it 'should allow alternate shams to be created' do
+      User.should_receive(:create).once
+
+      User.sham!(:super)
+    end
+
+    it 'should sham alternatives with alternative options' do
+      User.sham!(:super)[:identifier]
+        .should_not == User.sham![:identifier]
+    end
+
+    it 'should perform nested shams' do
+      Profile.should_receive(:sham!).once
+
+      User.sham!(:with_profile)
+    end
+
+    it 'should allow nested shams to be overwritten' do
+      profile = Profile.new
+
+      User.sham!(:with_profile, profile: profile)[:profile]
+        .should == profile
+
+      User.sham!(:with_profile)[:profile]
+        .should_not == profile
+    end
+  end
+end

data/spec/sham/data_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Sham do
+  context '#string!' do
+    it 'should be a string' do
+      described_class.string!.should be_an_instance_of(String)
+    end
+
+    it 'should have a length of 10' do
+      described_class.string!.length.should == 10
+    end
+
+    it 'should allow different lengths' do
+      described_class.string!(10).length.should == 20
+    end
+  end
+
+  context '#integer!' do
+    it 'should be an integer' do
+      described_class.integer!.should \
+        be_an_instance_of(Fixnum)
+    end
+
+    it 'should be between 0 and 100' do
+      10.times do
+        described_class.integer!.should satisfy{ |x| x >= 0 && x < 100 }
+      end
+    end
+
+    it 'should allow a differnet top' do
+      10.times do
+        described_class.integer!(10).should satisfy{ |x| x >= 0 && x < 10 }
+      end
+    end
+  end
+end

data/spec/sham/util_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Sham::Util do
+  context '#extract_options!' do
+    let(:ary){ [1, 2, 3, 4, opt: 'arg', opt2: 'arg'] }
+
+    it 'should alter the original array' do
+      expect {
+        described_class.extract_options!(ary)
+      }.to change{ ary.count }.from(5).to(4)
+    end
+
+    it 'should return the hash' do
+      described_class.extract_options!(ary).keys.should include(:opt, :opt2)
+    end
+
+    it 'should succeed when there are no options to extract' do
+      described_class.extract_options!([1,2,3]).should == {}
+    end
+
+    it 'should succeed when the array is empty' do
+      described_class.extract_options!([]).should == {}
+    end
+
+    it 'should fail if the argument is not an array' do
+      expect {
+        described_class.extract_options!(10)
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  context '#constantize' do
+    it 'should raise a NameError when the constant is not valid' do
+      expect {
+        described_class.constantize('user')
+      }.to raise_error(NameError)
+    end
+
+    it 'should raise a NameError when the constant is undefined' do
+      expect {
+        described_class.constantize("U#{Sham.string!}")
+      }.to raise_error(NameError)
+    end
+
+    it 'should return the constant' do
+      described_class.constantize('User').should == User
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'bundler'
+Bundler.require(:default)
+
+SPEC_DIR = File.join(File.dirname(File.expand_path(__FILE__)), 'root')
+
+class User
+  attr_accessor :attributes
+
+  def initialize attributes = {}
+    self.attributes = attributes
+  end
+
+  def self.create attributes = {}
+    new(attributes)
+  end
+
+  def [] attribute
+    attributes[attribute]
+  end
+end
+
+Sham.config(User) do |c|
+  c.attributes do
+    {
+      name: Sham.string!,
+      email: "#{Sham.string!}@gmail.com",
+      identifier: 100
+    }
+  end
+end
+
+Sham.config(User, :super) do |c|
+  c.attributes do
+    { identifier: 200 }
+  end
+end
+
+class Profile < User; end
+
+Sham.config(User, :with_profile) do |c|
+  c.attributes do
+    { profile: Sham::Base.new(Profile) }
+  end
+end
+Sham.config(Profile){ |c| c.empty }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sham
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000Z
+date: 2011-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70123949484060 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70284343539020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70123949484060
-description: Lightweight flexible factories for Ruby on Rails testing.
+  version_requirements: *70284343539020
+description: Lightweight flexible factories for Ruby and Rails testing.
 email:
 - pan.thomakos@gmail.com
 executables: []
@@ -38,8 +38,19 @@ files:
 - README.markdown
 - Rakefile
 - lib/sham.rb
+- lib/sham/base.rb
+- lib/sham/config.rb
+- lib/sham/data.rb
+- lib/sham/shammable.rb
+- lib/sham/util.rb
 - lib/sham/version.rb
 - sham.gemspec
+- spec/root/sham/employee.rb
+- spec/sham/base_spec.rb
+- spec/sham/config_spec.rb
+- spec/sham/data_spec.rb
+- spec/sham/util_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/panthomakos/sham
 licenses: []
 post_install_message: 
@@ -64,5 +75,11 @@ rubyforge_project: sham
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: sham-1.0.0
-test_files: []
+summary: sham-1.0.1
+test_files:
+- spec/root/sham/employee.rb
+- spec/sham/base_spec.rb
+- spec/sham/config_spec.rb
+- spec/sham/data_spec.rb
+- spec/sham/util_spec.rb
+- spec/spec_helper.rb