snepo-dm-machinist 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Cameron Barrie
+
+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

@@ -0,0 +1,9 @@
+dm-machinist
+=========
+
+DataMapper plugin for Pete Yandell's(http://notahat.com/) excellent Machinist library.
+
+require 'dm-machinist' in your spec_helper.rb and you can use it in your specs.
+
+See Tim Lucus's sweet write up for usage details on Machinist.
+http://toolmantim.com/article/2008/10/27/fixtureless_datas_with_machinist_and_sham

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-machinist'
+  s.version          = '0.1.0'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin for machinist'
+  s.description      = s.summary
+  s.author           = 'Cameron Barrie'
+  s.email            = 'cameron@snepo'
+  s.homepage         = 'http://github.com/snepo/dm-machinist/tree/master'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core')
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Generate GemSpec for github"
+task :gemspec do
+    spec_text = <<EOF
+Gem::Specification.new do |s|
+  s.name             = #{spec.name.inspect}
+  s.version          = '#{spec.version}'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = #{spec.has_rdoc.inspect}
+  s.extra_rdoc_files = #{spec.extra_rdoc_files.inspect}
+  s.summary          = #{spec.summary.inspect}
+  s.description      = #{spec.description.inspect}
+  s.author           = #{spec.author.inspect}
+  s.email            = #{spec.email.inspect}
+  s.homepage         = #{spec.homepage.inspect}
+  s.require_path     = #{spec.require_path.inspect}
+  s.files            = #{spec.files.inspect}
+  s.add_dependency('dm-core')
+end
+EOF
+  File.open("dm-machinist.gemspec", "w") do |f|
+    f.write(spec_text)
+  end
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO
+====
+Lots of stuff... 
+1. Specing and completing of the Sham class
+2. ...

data/lib/dm-machinist.rb

@@ -0,0 +1,30 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+ 
+# Add all external dependencies for the plugin here
+gem 'dm-core', '>=0.9.6'
+gem 'dm-aggregates', '>=0.9.6'
+require 'dm-core'
+require 'dm-aggregates'
+ 
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-machinist' / 'machinist.rb'
+require Pathname(__FILE__).dirname.expand_path / 'dm-machinist' / 'sham.rb'
+
+# From ActiveSupport
+class Object
+  def returning(value)
+    yield(value)
+    value
+  end
+end
+ 
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Machinist::DataMapperExtentions
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/lib/dm-machinist/machinist.rb

@@ -0,0 +1,72 @@
+module DataMapper
+  module Machinist
+    def self.with_save_nerfed
+      begin
+        @@nerfed = true
+        yield
+      ensure
+        @@nerfed = false
+      end
+    end
+
+    @@nerfed = false
+    def self.nerfed?
+      @@nerfed
+    end
+    
+    module DataMapperExtentions
+      def blueprint(&blueprint)
+        @blueprint = blueprint
+      end
+  
+      def make(attributes = {})
+        raise "No blueprint for class #{self}" if @blueprint.nil?
+        lathe = Lathe.new(self, attributes)
+        lathe.instance_eval(&@blueprint)
+        unless Machinist.nerfed?
+          lathe.object.save
+          lathe.object.reload
+        end
+        returning(lathe.object) do |object|
+          yield object if block_given?
+        end
+      end
+    
+      def make_unsaved(attributes = {})
+        returning(Machinist.with_save_nerfed { make(attributes) }) do |object|
+          yield object if block_given?
+        end
+      end
+      
+      class Lathe
+        def initialize(object, attributes)
+          @object = object.new
+          @assigned_attributes = []
+          attributes.each do |key, value|
+            @object.send("#{key}=", value)
+            @assigned_attributes << key
+          end
+        end
+
+        attr_reader :object
+
+        def method_missing(symbol, *args, &block)
+          if @assigned_attributes.include?(symbol)
+            @object.send(symbol)
+          else
+            value = if block
+              block.call
+            elsif args.first.is_a?(Hash) || args.empty?
+              symbol.to_s.camelize.constantize.make(args.first || {})
+            else
+              args.first
+            end
+            @object.send("#{symbol}=", value)
+            @assigned_attributes << symbol
+          end
+        end
+      end #Lathe
+      
+    end #DataMapperExtentions
+  end #Machinist
+end #DataMapper

data/lib/dm-machinist/sham.rb

@@ -0,0 +1,63 @@
+class Sham
+  @@shams = {}
+  
+  # Over-ride module's built-in name method, so we can re-use it for
+  # generating names. This is a bit of a no-no, but we get away with
+  # it in this context.
+  def self.name(*args, &block)
+    method_missing(:name, *args, &block)
+  end
+  
+  def self.method_missing(symbol, *args, &block)
+    if block_given?
+      @@shams[symbol] = Sham.new(symbol, args.pop || {}, &block)
+    else
+      sham = @@shams[symbol]
+      raise "No sham defined for #{symbol}" if sham.nil?
+      sham.fetch_value
+    end
+  end
+
+  def self.reset
+    @@shams.values.each{ |v| v.reset }
+  end
+  
+  def initialize(name, options = {}, &block)
+    @name      = name
+    @generator = block
+    @offset    = 0
+    @unique    = options.has_key?(:unique) ? options[:unique] : true
+    generate_values(12)
+  end
+  
+  def reset
+    @offset = 0
+  end
+  
+  def fetch_value
+    # Generate more values if we need them.
+    if @offset >= @values.length
+      generate_values(2 * @values.length)
+      raise "Can't generate more unique values for Sham.#{@name}" if @offset >= @values.length
+    end
+    returning @values[@offset] do
+      @offset += 1
+    end
+  end
+    
+private
+  
+  def generate_values(count)
+    @values = seeded { (1..count).map(&@generator) }
+    @values.uniq! if @unique
+  end
+  
+  def seeded
+    begin
+      srand(1)
+      yield
+    ensure
+      srand
+    end
+  end
+end

data/spec/data/comment.rb

@@ -0,0 +1,7 @@
+class Comment
+  include DataMapper::Resource
+  property :id, Serial
+  property :author, String
+  property :body, Text
+  belongs_to :post
+end

data/spec/data/post.rb

@@ -0,0 +1,7 @@
+class Post
+  include DataMapper::Resource
+  property :id, Serial
+  property :title, String
+  property :body, Text
+  has n, :comments
+end

data/spec/dm_machinist_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + "/../lib/" + 'dm-machinist'
+
+Post.blueprint do
+  title "An Example Post"
+  body  { "The quick brown fox." }
+end
+
+Comment.blueprint do
+  post
+  author "Fred Bloggs"
+  body   "Just a comment."
+end
+  
+
+
+
+describe "Machinist" do
+  
+  class BeSaved
+
+    def matches?(target)
+      @target = target
+      !@target.dirty?
+    end
+
+    def failure_message
+      "expected the object to be saved but it's not"
+    end
+
+    def negative_failure_message
+      "expected the object not to be saved but is is"
+    end
+  end
+  
+  def be_saved
+    BeSaved.new
+  end
+  
+  # class BeReloaded
+  #   def matches?(target)
+  #     @target = target
+  #     @target.methods.each{|m| p m}
+  #   end
+  #   
+  #   def failure_message
+  #     "expected the object to be reloaded but it's not"
+  #   end
+  #   
+  #   def negative_failure_message
+  #     "expected the object to not be reloaded but it has been"
+  #   end
+  # end
+  # 
+  # def be_reloaded
+  #   BeReloaded.new
+  # end
+  
+  describe "make methd" do
+    before do
+      @post = Post.make
+    end
+    
+    it "should set a field from a constant in the blueprint" do
+      @post.title.should == "An Example Post"
+    end
+  
+    it "should set a field from a block in the blueprint" do
+      @post.body.should == "The quick brown fox."
+    end
+    
+    it "should save the object" do
+      @post.should be_saved
+    end
+
+    # There doesn't seem to be a way to do this with DataMapper. 
+    #We can reload but not test that it's been done(without hacking at least)
+    # I'll leave it pending    
+    it "should reload the object" #do
+    #    @post.should be_reloaded
+    # end
+  end
+  
+  describe "make_unsaved method" do
+    before do
+      @comment = Comment.make_unsaved
+    end
+    
+    it "should not save the object" do
+      @comment.should_not be_saved
+    end
+    
+    # Pending till I work out how to do this with DataMapper
+    it "should not reload the object" #do
+    #   @comment.should_not be_reloaded
+    # end
+    
+    it "should not save associated objects" do
+      @comment.post.should_not be_saved
+    end
+    
+    # Pending till I work out how to do this with DataMapper
+    it "should not reload associated objects" #do
+    #   @comment.post.should_not be_reloaded
+    # end
+  end
+  
+  it "should override a field from the blueprint with a parameter" do
+    post = Post.make(:title => "A Different Title")
+    post.title.should == "A Different Title"
+  end
+  
+  it "should create an associated object for a field with no arguments in the blueprint" do
+    comment = Comment.make
+    comment.post.should_not be_nil
+  end
+  
+  it "should allow passing a block to make" do
+    comments = nil
+    post = Post.make do |post|
+      comments = (1..3).map { Comment.make(:post => post) }
+    end
+    post.should be_an_instance_of(Post)
+    comments.should_not be_nil
+    comments.each {|comment| comment.post.should == post }
+  end
+  
+  it "should not nerf make within a block passed to make_unsaved" do
+    comment = nil
+    post = Post.make_unsaved do |post|
+      comment = Comment.make(:post => post)
+    end
+    post.should_not be_saved
+    comment.should  be_saved
+    comment.post.should == post
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,46 @@
+class String
+  # Ripped from Rails Inflectors
+  def camelize(first_letter_in_uppercase = true)
+    lower_case_and_underscored_word = self
+    if first_letter_in_uppercase
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      lower_case_and_underscored_word.first.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+    end
+  end
+  
+  # Ripped from Rails Inflectors
+  def constantize
+    camel_cased_word = self
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end
+module CustomMatchers
+  class DataMapperBeSaved
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(target)
+      @target = target
+      p @target
+      p @expected
+      #satisfy expectation here
+    end
+
+    def failure_message
+      "expected #{@expected} but got #{@target}"
+    end
+
+    def negative_failure_message
+      "expected #{@expected} to not be #{@target}"
+    end
+  end
+end

data/spec/sham_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+Sham.random { rand }
+Sham.half_index {|index| index/2 }
+Sham.coin_toss(:unique => false) {|index| index % 2 == 1 ? 'heads' : 'tails' }
+Sham.limited {|index| index%10 }
+Sham.index {|index| index }
+Sham.name  {|index| index }
+
+describe Sham do
+  it "should ensure generated values are unique" do
+    values = (1..10).map { Sham.half_index }
+    values.should == (0..9).to_a
+  end
+
+  it "should generate non-unique values when asked" do
+    values = (1..4).map { Sham.coin_toss }
+    values.should == ['heads', 'tails', 'heads', 'tails']
+  end
+  
+  it "should generate more than a dozen values" do
+    values = (1..25).map { Sham.index }
+    values.should == (1..25).to_a
+  end
+    
+  it "should generate the same sequence of values after a reset" do
+    values1 = (1..10).map { Sham.random }
+    Sham.reset
+    values2 = (1..10).map { Sham.random }
+    values2.should == values1
+  end
+  
+  it "should die when it runs out of unique values" do
+    lambda {
+      (1..100).map { Sham.limited }
+    }.should raise_error(RuntimeError)
+  end
+  
+  it "should allow over-riding the name method" do
+    Sham.name.should == 1
+  end    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-machinist'
+require Pathname(__FILE__).dirname.expand_path / 'helpers'
+
+Spec::Runner.configure do |config|
+  config.include(CustomMatchers)
+end
+
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+ 
+  lib = "do_#{name}"
+ 
+  begin
+    gem lib, '>=0.9.5'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+ 
+ENV['ADAPTER'] ||= 'sqlite3'
+ 
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+ 
+require "dm-types"
+require "dm-aggregates"
+
+# Create models
+require Pathname(__FILE__).dirname.expand_path / 'data' / 'comment' 
+require Pathname(__FILE__).dirname.expand_path / 'data' / 'post'
+
+# Migrate to sqlite3 in memory
+DataMapper.auto_migrate!

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: snepo-dm-machinist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cameron Barrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: DataMapper plugin for machinist
+email: cameron@snepo
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-machinist/machinist.rb
+- lib/dm-machinist/sham.rb
+- lib/dm-machinist.rb
+- spec/data/comment.rb
+- spec/data/post.rb
+- spec/dm_machinist_spec.rb
+- spec/helpers.rb
+- spec/sham_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/snepo/dm-machinist/tree/master
+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.2.0
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin for machinist
+test_files: []
+