big_machine 1.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 649fb8587b32627fa3ca4eff827629c607dd6938
+  data.tar.gz: c18ecd4816fef1e342ec3bc735b8f3f07b74d78d
+SHA512:
+  metadata.gz: 95f53b5a31fb1b42693bbb99c04007f3368a3ebadc8f293bb0c4ff29a332ca978d3e9e13697c35518bda641c71e897de5177ee6f0f44d38df9d3176603cbf7ee
+  data.tar.gz: bc40ad97a54d263ed57a0ae76ed1b37ade44246a10bbd44dae63ac260d04713bab07b329b71a2428c7ebae95c7b044032ea3036252feeb4fb5222411ed431883

data/README.md

@@ -27,13 +27,16 @@ Source
 
 Add this to your Gemfile
 ``` ruby
+
   gem 'big_machine'
+
 ```
 
 ## Usage
 
-Create your first states
+Create your first state
 ``` ruby
+
   class Draft < BigMachine::State
     def publish
       transition_to Online
@@ -42,23 +45,45 @@ Create your first states
 
   class Online < BigMachine::State
   end
+
+```
+
+All methods you override in you state can takes args and block
+``` ruby
+
+  class Draft < BigMachine::State
+    def publish(now = Time.now)
+      transition_to Online, now
+    end
+  end
+
+  class Online < BigMachine::State
+    def enter(*args)
+      stateful.publish_at args.first
+    end
+  end
+
 ```
 
 Make your object stateful
 ``` ruby
+
   class Car
     include BigMachine
 
     big_machine initial_state: :draft
   end
+
 ```
 
 Now it's possible to publish your car object:
 ``` ruby
+
   car = Car.new
   car.current_state # => Draft
   car.publish
   car.current_state # => Online
+
 ```
 
 Of course your object can be an ActiveRecord::Base object. In this case, the object must have a state column. ( if not, see the next section )
@@ -71,20 +96,23 @@ big_machine method can take several options:
 * workflow if you want to change the normal worklow
 It's possible to call workflow_is method in your different states
 
-###example
+
+## Example
 
 ``` ruby
+
   big_machine initial_state: :dradt, state_attribute: :big_state, workflow: small
 
   class Draft < BigMachine::State
 
     def publish
       return if workflow_is :small
-      
+
       transition_to Online
     end
 
   end
+
 ```
 
 ## Lock module
@@ -93,6 +121,7 @@ A state can include lock module, it will lock the state of your object when your
 The unlock method should be call to unlock the module
 
 ``` ruby
+
   class Draft < BigMachine::State
     include BigMachine::Lock
 
@@ -114,8 +143,13 @@ The unlock method should be call to unlock the module
   article.unlock
   article.publish
   article.current_state # => Online
+
 ```
 
 ## Contributors
 
-*Anthony Laibe
+*Anthony Laibe
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/alaibe/big_machine/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -1,38 +1,9 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'BigMachine'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
 end
 
-
 task :default => :test

data/lib/big_machine.rb

@@ -1,8 +1,8 @@
-require "active_support"
+require "active_support/all"
 require "forwardable"
 require "big_machine/state"
 require "big_machine/active_record"
-require "big_machine/transition_methods"
+require "big_machine/available_methods"
 require "big_machine/lock"
 
 module BigMachine
@@ -34,7 +34,7 @@ module BigMachine
 
     def set_initial_state_class
       @initial_state_class = self.initial_state.to_s.camelize.constantize
-      include ::BigMachine::TransitionMethods
+      include ::BigMachine::AvailableMethods
     end
   end
 
@@ -52,7 +52,7 @@ module BigMachine
 
   def forward_current_state
     extend SingleForwardable
-    def_delegators :current_state, *current_state.class.transition_methods
+    def_delegators :current_state, *current_state.class.available_methods
   end
 
   def transition_to(next_state_class, *args, &block)

data/lib/big_machine/available_methods.rb

@@ -0,0 +1,9 @@
+module BigMachine
+  module AvailableMethods
+    extend Forwardable
+
+    def self.included(base)
+      def_delegators :current_state, *base.initial_state_class.available_methods
+    end
+  end
+end

data/lib/big_machine/lock.rb

@@ -9,6 +9,10 @@ module BigMachine
       def transition_methods
         public_instance_methods - State.public_instance_methods - [:unlock, :locked?]
       end
+
+      def available_methods
+        public_instance_methods - State.public_instance_methods
+      end
     end
 
     def locked?

data/lib/big_machine/state.rb

@@ -11,6 +11,10 @@ module BigMachine
       public_instance_methods - State.public_instance_methods
     end
 
+    def self.available_methods
+      public_instance_methods - State.public_instance_methods
+    end
+
     def self.human_name
       self.to_s.split('::').last.underscore
     end

data/lib/big_machine/version.rb

@@ -1,3 +1,3 @@
 module BigMachine
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/test/big_machine_test.rb

@@ -104,88 +104,88 @@ class DummyWithActiveRecordAndOtherState < ActiveRecord::Base
   end
 end
 
-class BigMachineTest < ActiveSupport::TestCase
-  setup do
+class BigMachineTest < Test::Unit::TestCase
+  def setup
     @dummy   = DummyMachine.new
     @dummyAR = DummyWithActiveRecord.new('Online')
   end
 
-  test "big_machine set initial state" do
+  def test_big_machine_set_initial_state
     assert_equal 'Draft', @dummy.current_state.class.name
   end
 
-  test "big_machine create new state when start transition" do
+  def test_big_machine_create_new_state_when_start_transition
     @dummy.publish
     assert_equal 'Online', @dummy.current_state.class.name
     @dummy.back_to_draft
     assert_equal 'Draft', @dummy.current_state.class.name
   end
 
-  test "big machine must refuse unavailable action" do
+  def test_big_machine_must_refuse_unavailable_action
     @dummy.publish
     assert_raise NoMethodError do
       @dummy.publish
     end
   end
 
-  test "big machine can lock state" do
+  def test_big_machine_can_lock_state
     @dummy.lock
-    assert @dummy.current_state.locked?
+    assert @dummy.locked?
     @dummy.back_to_draft
     assert_equal 'LockState', @dummy.current_state.class.name
-    assert @dummy.current_state.locked?
-    @dummy.current_state.unlock
-    assert !@dummy.current_state.locked?
+    assert @dummy.locked?
+    @dummy.unlock
+    assert !@dummy.locked?
     assert_equal 'LockState', @dummy.current_state.class.name
     @dummy.back_to_draft
     assert_equal 'Draft', @dummy.current_state.class.name
   end
 
-  test "big_machine can have workflow to refuse some action" do
+  def test_big_machine_can_have_workflow_to_refuse_some_action
     @dummyW = DummyWithWorkflow.new
     @dummyW.publish
     assert_equal 'Draft', @dummyW.current_state.class.name
   end
 
-  test "big_machine read state from database" do
+  def test_big_machine_read_state_from_database
     assert_equal 'Online', @dummyAR.current_state.class.name
   end
 
-  test "big_machine read state from specify column in database" do
+  def test_big_machine_read_state_from_specify_column_in_database
     @dummyAROS = DummyWithActiveRecordAndOtherState.new
     assert_equal 'Online', @dummyAROS.current_state.class.name
   end
 
-  test "big_machine must update attribute when state change" do
+  def test_big_machine_must_update_attribute_when_state_change
     @dummyAR.back_to_draft
     assert_equal 'Draft', @dummyAR.current_state.class.name
     assert_equal 'Draft', @dummyAR.state
   end
 
-  test "big_machine must set initial state even if active record object" do
+  def test_big_machine_must_set_initial_state_even_if_active_record_object
     @dummyWS = DummyWithActiveRecord.new(nil)
     assert_equal 'Draft', @dummyWS.current_state.class.name
   end
 
-  test "big machine does not transtion if it's not possible to exit" do
+  def test_big_machine_does_not_transtion_if_it_s_not_possible_to_exit
     @dummyCE = DummyWithActiveRecord.new('CannotExit')
     @dummyCE.publish
     assert_equal 'CannotExit', @dummyCE.current_state.class.name
   end
 
-  test "big machine does not transtion if it's not possible to enter" do
+  def test_big_machine_does_not_transtion_if_it_s_not_possible_to_enter
     @dummyCE = DummyWithActiveRecord.new('Draft')
     @dummyCE.cannot_enter
     assert_equal 'Draft', @dummyCE.current_state.class.name
   end
 
-  test "big machine can take args into transition" do
+  def test_big_machine_can_take_args_into_transition
     @dummyArgs = DummyWithActiveRecord.new('Args')
     @dummyArgs.publish
     assert_equal 'args', @dummyArgs.args
   end
 
-  test "big machine can take block into transition" do
+  def test_big_machine_can_take_block_into_transition
     @dummyArgs = DummyWithActiveRecord.new('Args')
     @dummyArgs.back_to_draft
     assert_equal 'block', @dummyArgs.block

data/test/test_helper.rb

@@ -1,18 +1,5 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
-
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
-
-Rails.backtrace_cleaner.remove_silencers!
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-# Load fixtures from the engine
-if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-end
+require 'big_machine'
+require 'test/unit'
 
 module ActiveRecord
   class Base

metadata

@@ -1,32 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: big_machine
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Anthony Laibe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add support for creating state machine on any ruby object
 email:
 - anthony.laibe@gmail.com
@@ -34,98 +45,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/big_machine.rb
-- lib/big_machine/version.rb
 - lib/big_machine/active_record.rb
+- lib/big_machine/available_methods.rb
 - lib/big_machine/lock.rb
 - lib/big_machine/state.rb
-- lib/big_machine/transition_methods.rb
+- lib/big_machine/version.rb
 - lib/tasks/big_machine_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
-- test/dummy/README.rdoc
-- test/dummy/log/test.log
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/Rakefile
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/script/rails
-- test/dummy/config.ru
-- test/test_helper.rb
 - test/big_machine_test.rb
+- test/test_helper.rb
 homepage: https://github.com/alaibe/big_machine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: State machine for any ruby object
 test_files:
-- test/dummy/README.rdoc
-- test/dummy/log/test.log
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/Rakefile
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/script/rails
-- test/dummy/config.ru
-- test/test_helper.rb
 - test/big_machine_test.rb
+- test/test_helper.rb