lawrencepit-machinery 0.3 → 0.3.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lawrence Pit
+
+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.markdown

@@ -0,0 +1,132 @@
+Machinery
+=========
+
+*Machinery to create object graphs.*
+
+Machinery helps to create object graphs for use in tests without needing fixtures.
+These object graphs are easily re-usable in Test::Unit, RSpec, Cucumber and
+in rake tasks to populate a database.
+
+Why write stuff like:
+
+    users(:admin).should be_nil
+    
+when you can just as well write:
+
+    @user_admin.should be_nil
+
+Use less magic. Less code. Makes software softer.
+
+
+Usage
+-----
+
+In /spec/scenarios.rb
+
+    scenario :earth_ships do
+      @titanic = Ship.create!(:name => "Titanic")
+      @pirates = Ship.create!(:name => "Pirate")
+    end
+
+    scenario :space_ships do
+      @apollo = Ship.create!(:name => "Apollo")
+      @uss_enterprise = Ship.create!(:name => "USS Enterprise")
+    end
+
+    scenario :all_ships do
+      scenarios :earth_ships, :space_ships
+      @sunken_ship = Ship.create!(:name => "Sunk")
+    end
+
+
+In /spec/spec_helper.rb
+
+    require 'machinery'
+    Machinery.load(File.dirname(__FILE__) + '/scenarios.rb')
+
+
+In /spec/models/ship_spec.rb
+
+    describe Ship do
+      scenarios :all_ships
+
+      it "should create a pirates ship" do
+        @pirates.should_not be_nil
+      end
+
+      it "should have 5 ships" do
+        Ship.count.should == 5
+      end
+    end
+
+
+
+Installation
+------------
+
+### Rails installation (Test::Unit)
+
+#### As a Gem
+
+Use this if you prefer to use versioned releases of Machinery.
+Specify the gem dependency in your config/environment.rb file:
+
+    Rails::Initializer.run do |config|
+      config.gem "lawrencepit-machinery", :lib => "machinery", :source => "http://gems.github.com"
+    end
+
+Then:
+
+    $ rake gems:install
+    $ rake gems:unpack
+
+#### As a Plugin
+
+Use this if you prefer to use the edge version of Machinery:
+
+    $ script/plugin install git://github.com/lawrencepit/machinery.git
+
+### Rails installation (RSpec)
+
+If you're using Machinery with RSpec, it is recommended that you add config.gem lines
+for RSpec and Machinery in your config/environment/test.rb file, but do not ask
+Rails to load the RSpec and Machinery libraries:
+
+    config.gem 'rspec', :lib => false
+    config.gem 'rspec-rails', :lib => false
+    config.gem 'lawrencepit-machinery', :lib => false, :source => 'http://gems.github.com'
+
+Then require machinery from your spec/spec_helper.rb file, before Spec::Runner is
+configured:
+
+    # requires for RSpec
+    require 'machinery'
+    Spec::Runner.configure do |config|
+    # ...
+
+You should not need to require anything besides the top-level machinery library.
+
+
+
+Credits
+-------
+
+Written by [Lawrence Pit](http://lawrencepit.com).
+
+Thanks to
+[Machinist](http://github.com/notahat/machinist),
+[ModelStubbing](http://github.com/technoweenie/model_stubbing),
+[Shoulda](http://github.com/thoughtbot/shoulda) and
+[FixtureScenarios](http://errtheblog.com/posts/61-fixin-fixtures)
+for inspiration.
+
+After using model_stubbing on a relatively large project for over a year I decided
+a simpler solution was needed. Object graphs need to be easily re-usable by specs,
+unit tests, cucumber stories and ad-hoc database loading.
+
+Machinery works especially great in combination with Machinist.
+
+
+
+----
+Copyright (c) 2009 Lawrence Pit, released under the MIT license

data/lib/machinery/active_record.rb

@@ -0,0 +1,43 @@
+module Machinery
+
+  module ActiveRecord
+    @@toys = []
+    @@recording = false
+
+    def self.record
+      @@recording = true
+      yield
+      @@recording = false
+    end
+
+    def self.clear
+      @@toys.each { |toy| toy.destroy }
+      @@toys = []
+    end
+
+    def self.created_with_machinery(obj)
+      @@toys << obj if @@recording
+    end
+
+    module Extensions
+      private
+
+      def self.included(base)
+        base.class_eval do
+          alias_method :create_without_machinery, :create
+          alias_method :create, :create_with_machinery
+        end
+      end
+
+      def create_with_machinery
+        id = create_without_machinery
+        Machinery::ActiveRecord.created_with_machinery(self)
+        id
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, Machinery::ActiveRecord::Extensions)
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lawrencepit-machinery
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.1
 platform: ruby
 authors: 
 - Lawrence Pit
@@ -22,7 +22,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.markdown
+- MIT-LICENSE
 - lib/machinery.rb
+- lib/machinery/active_record.rb
 has_rdoc: false
 homepage: http://github.com/lawrencepit/machinery
 post_install_message: