can_has_fixtures 0.1.0

data/HISTORY

@@ -0,0 +1,4 @@
+can_has_fixtures Release History
+
+Version 0.1.0 (16 March 2008)
+  * Initial release.

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2008 Ben Burkert <ben@benburkert.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of this project nor the names of its contributors may be
+      used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,78 @@
+= can_has_fixtures
+
+Easily create fixtures.
+
+Author::      Ben Burkert (mailto:ben@benburkert.com)
+Version::     0.1.0
+Copyright::   Copyright (c) 2008 Ben Burkert. All rights reserved.
+License::     New BSD License (http://opensource.org/licenses/bsd-license.php)
+Website::     http://canhasgems.rubyforge.org/can_has_fixtures/
+Repository::  git://github.com/benburkert/can_has_fixtures.git
+
+== Dependencies
+
+== Basic Usage
+
+can_has_fixtures works with any ORM that provides a +create+ method that accepts an attribute
+hash on the model classes.
+
+can_has_fixtures works best with RSpec, but can be used from irb as well:
+
+  require 'can_has_fixtures'
+  
+First create a fixture for the model, in this case it's Post:
+
+  Post.fixture {{
+    :title        => 3.random.words * ' ',
+    :created_at   => Time.now,
+    :body         => 5.random.paragraphs * '\n',
+    :author       => User.gen
+  }}
+
+If the a nested fixture is used (author, in this case), make sure to create add the fixture:
+
+  User.fixture {{
+    :first_name   => Random.word,
+    :last_name    => Random.word,
+    :user_name    => Random.word,
+    :email        => Random.email,
+    :password     => Random.word
+  }}
+
+Finally, call model class' +gen+ method to create the fixture:
+
+  @post = Post.gen
+
+Fixtures can also be named by supplying the +fixture+ method a paramater:
+
+  Post.fixture(:short_post) {{
+    :title        => 3.random.words * ' ',
+    :created_at   => Time.now,
+    :body         => Random.sentence,
+    :author       => User.gen
+  }}
+  
+  @post = Post.gen(:short_post)
+
+can_has_fixtures is great for specing models.  By using the model's class for the describe target,
+simply call +fixture+ within the body of the spec:
+
+  describe Post do
+    fixture {{
+      :title        => 3.random.words * ' ',
+      :created_at   => Time.now,
+      :body         => Random.sentence
+    }}
+    
+    before(:each) do
+      @post = Post.gen
+    end
+    
+    it "should not be valid without a body" do
+      @post.body = nil
+      @post.save
+      
+      @post.should_not be_valid
+    end
+  end
+        

data/Rakefile

@@ -0,0 +1,76 @@
+# -*- ruby -*-
+
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require 'rake/rdoctask'
+require "spec"
+require "spec/rake/spectask"
+
+DIR = File.dirname(__FILE__)
+NAME = 'can_has_fixtures'
+SUMMARY =<<-EOS
+Library for generating fixtures.
+EOS
+
+require "lib/can_has_fixtures/version"
+
+spec = Gem::Specification.new do |s|
+  s.name         = NAME
+  s.summary      = SUMMARY
+
+  s.version      = CanHasFixtures::VERSION
+  s.platform     = Gem::Platform::RUBY
+
+  s.require_path = "lib"
+  s.files        = %w(Rakefile LICENSE HISTORY README) + Dir["lib/**/*"]
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+  package.gem_spec = spec
+  package.need_zip = true
+  package.need_tar = true
+end
+
+##############################################################################
+# Documentation
+##############################################################################
+task :doc => "doc:rerdoc"
+namespace :doc do
+
+  Rake::RDocTask.new do |rdoc|
+    files = ['README', 'LICENSE', 'HISTORY',
+             'lib/**/*.rb', 'doc/**/*.rdoc', 'spec/**/*.rb']
+    rdoc.rdoc_files.add(files)
+    rdoc.main = 'README'
+    rdoc.title = 'I CAN HAS "CAN HAS FIXTURES?" DOCS? '
+    rdoc.template = 'tools/allison-2.0.3/lib/allison'
+    rdoc.rdoc_dir = 'doc/can_has_fixtures/rdoc'
+    rdoc.options << '--line-numbers' << '--inline-source'
+  end
+
+  desc "rdoc to rubyforge"
+  task :rubyforge => :doc do
+    sh %{chmod -R 755 doc}
+    sh %{/usr/bin/scp -r -p doc/can_has_fixtures/rdoc/* benburkert@rubyforge.org:/var/www/gforge-projects/canhasgems/can_has_fixtures}
+  end
+end
+
+##############################################################################
+# rSpec & rcov
+##############################################################################
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+end
+
+##############################################################################
+# release
+##############################################################################
+task :release => [:specs, "doc:rubyforge", :package] do
+  sh %{rubyforge add_release canhasgems can_has_fixtures "#{CanHasFixtures::VERSION}" pkg/#{NAME}-#{CanHasFixtures::VERSION}.gem}
+  %w[zip tgz].each do |ext|
+    sh %{rubyforge add_file canhasgems can_has_fixtures #{CanHasFixtures::VERSION} pkg/can_has_fixtures-#{CanHasFixtures::VERSION}.#{ext}}
+  end
+end

data/lib/can_has_fixtures/core_ext/class.rb

@@ -0,0 +1,49 @@
+class Class # :nodoc:
+  include FixturizeMixin
+  
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def cattr_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        #{"
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+        " unless options[:instance_writer] == false }
+      EOS
+    end
+  end
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

data/lib/can_has_fixtures/core_ext/fixnum.rb

@@ -0,0 +1,5 @@
+class Fixnum
+  def random
+    Random.chain(self)
+  end
+end

data/lib/can_has_fixtures/core_ext.rb

@@ -0,0 +1,2 @@
+require "can_has_fixtures/core_ext/class"
+require "can_has_fixtures/core_ext/fixnum"

data/lib/can_has_fixtures/fixturize_mixin.rb

@@ -0,0 +1,75 @@
+module FixturizeMixin
+  def self.included(base)
+    unless method_defined? :method_missing
+      def method_missing(meth, *args, &block); super; end
+    end
+    
+    base.class_eval do
+      alias_method :method_missing_without_fixture_check, :method_missing
+      alias_method :method_missing, :method_missing_with_fixture_check
+    end
+  end
+  
+  def method_missing_with_fixture_check(meth, *args, &block)
+    if meth.to_s == "fixture"
+      if respond_to?(:description_args)
+        fixturize_description_args(*args, &block)
+      else
+        fixturize!
+        fixture(*args, &block)
+      end
+    else
+      method_missing_without_fixture_check(meth, *args, &block)
+    end
+  end
+  
+  def fixturize_description_args(*args, &block)
+    klass = description_args.first
+    
+    case klass
+    when Class then fixturize!(klass) unless klass.respond_to?(:fixture)
+    end
+    
+    klass.fixture(args.first || :default, &block)
+  end
+  
+  def fixturize!(klass = self)
+    klass.cattr_accessor :fixture_procs
+
+    klass.fixture_procs = {}
+
+    class << klass
+      def fixture(identifier = :default, &block)
+        case identifier
+        when Class then add_fixture(identifier.to_s.snake_case.to_sym, &block)
+        when String then add_fixture(identifier.snake_case.to_sym, &block)
+        when Symbol then add_fixture(identifier, &block)
+        end
+      end
+
+      def add_fixture(sym, &block)
+        fixture_procs[sym] = fixture_procs[sym] ? fixture_procs[sym] << block : [block]
+      end
+
+      def generate(*args, &block)
+        args, attributes = args_and_options(*args)
+        identifier = args.first || :default
+
+        attr_procs = fixture_procs[identifier.to_s.snake_case.to_sym]
+
+        raise "#{identifier} fixture was not found" if attr_procs.nil? || attr_procs.empty?
+
+        proc = attr_procs[rand(attr_procs.size)]
+
+        values = proc.call(*args)
+
+        case values
+        when Hash then create(values.merge(attributes))
+        else raise "#{identifier.to_s.camel_case} fixture's attributes were not recognized"
+        end
+      end
+      
+      alias_method :gen, :generate
+    end
+  end
+end

data/lib/can_has_fixtures/random.rb

@@ -0,0 +1,51 @@
+class Random
+  WORDS_PER_SENTENCE = 3..20
+  SENTENCES_PER_PARAGRAPH = 3..8
+  
+  attr_accessor :count
+  
+  def self.chain(target)
+    Random.new(target)
+  end
+    
+  def initialize(count = 1)
+    @count = count
+  end
+  
+  def dictionary
+    @@dictionary ||= File.read("/usr/share/dict/words").split
+  end
+  
+  def word
+    dictionary[rand(dictionary.size)]
+  end
+  
+  def words
+    (1..count).collect { word }
+  end
+  
+  def sentence(punctuate = true)
+    (1..WORDS_PER_SENTENCE.to_a[rand(WORDS_PER_SENTENCE.to_a.size)]).collect{ word }.join(' ') + (punctuate ? '.' : '')
+  end
+  
+  
+  def sentences(punctuate = true)
+    (1..count).collect { sentence(punctuate) }
+  end
+  
+  def paragraph(end_with_newline = true)
+    (1..SENTENCES_PER_PARAGRAPH.to_a[rand(SENTENCES_PER_PARAGRAPH.to_a.size)]).collect{ sentence }.join('  ') + (end_with_newline ? '\n' : '')
+  end
+  
+  def paragraphs(end_with_newline = true)
+    (1..count).collect { paragraph(end_with_newline) }
+  end
+  
+  def email
+    "#{word}@#{word}.#{%w[com net org biz info gov][rand(6)]}"
+  end
+  
+  def emails
+    (1..count).collect { email }
+  end
+end

data/lib/can_has_fixtures/util.rb

@@ -0,0 +1,16 @@
+class Object
+  def args_and_options(*args)
+    options = Hash === args.last ? args.pop : {}
+    return args, options
+  end
+end
+
+class String
+  def snake_case
+    gsub(/\B[A-Z]/, '_\&').downcase
+  end
+
+  def camel_case
+    split('_').map{|e| e.capitalize}.join
+  end
+end

data/lib/can_has_fixtures/version.rb

@@ -0,0 +1,3 @@
+module CanHasFixtures
+  VERSION = "0.1.0"
+end

data/lib/can_has_fixtures.rb

@@ -0,0 +1,41 @@
+require "can_has_fixtures/util"
+require "can_has_fixtures/fixturize_mixin"
+require "can_has_fixtures/core_ext"
+
+require "can_has_fixtures/random"
+
+module CanHasFixtures
+  
+  module ClassMethods
+    attr_accessor :fixture_procs
+  end
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+    
+    unless method_defined? :method_missing
+      def method_missing(meth, *args, &block); super; end
+    end
+    
+    base.class_eval do
+      alias_method :method_missing_without_fixture_check, :method_missing
+      alias_method :method_missing, :method_missing_missing_with_fixture_check
+    end
+  end
+  
+  def method_missing_missing_with_fixture_check(meth, *args, &block)
+    if meth.to_s == "fixture"
+      fixturize_description($1.to_sym, *args, &block)
+    else
+      method_missing_without_fixture_check(meth, *args, &block)
+    end
+  end
+  
+  def fixture(*args, &block)
+    p "here"
+  end
+  
+  def fixturize_description
+    p description_args
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: can_has_fixtures
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-17 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- LICENSE
+- HISTORY
+- README
+- lib/can_has_fixtures
+- lib/can_has_fixtures/core_ext
+- lib/can_has_fixtures/core_ext/class.rb
+- lib/can_has_fixtures/core_ext/fixnum.rb
+- lib/can_has_fixtures/core_ext.rb
+- lib/can_has_fixtures/fixturize_mixin.rb
+- lib/can_has_fixtures/random.rb
+- lib/can_has_fixtures/util.rb
+- lib/can_has_fixtures/version.rb
+- lib/can_has_fixtures.rb
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Library for generating fixtures.
+test_files: []
+