state_machines-mongoid 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b01953c4a574ca151ab27f9a4735b2a4f18a2c3a
-  data.tar.gz: b3ab34e806e69375051f8029b092240167bec4f9
+  metadata.gz: fedf8d86a63fa90c27d8b53ec06b1931a546eef6
+  data.tar.gz: ef44e18220ddea7b4ce97150c9c6a4bce212a07d
 SHA512:
-  metadata.gz: c1ce30e55acd3d37f9143b71e1f768867e057836e767ad0b56fd26e6972a20811104322e76328125edb8e046fb7e671a25f8c68d15eb845ee4d176514c2ee63f
-  data.tar.gz: f720b7bfa5b6360ad8e042e52a147761ff55e331d4f45e0b7db7e7cec836b1f0bd78ecd13bf1873060817b6fc699959bb16a24a5c26031ad267b4f05712ca2fc
+  metadata.gz: d032c0f6a64c07d57890d1a41aa3b050d4321805b859cec4f04d0b57014b4e1fef1765f7559519ed8c7b1eabb825f5f823aa4907f01b2a7e5b5d4a414121e224
+  data.tar.gz: 809fb648a49257d2340498ac8dd7eb43ba292ba1075450326c6365ea33a71cc4cf8cf06fdd93d82e1006284e41f040c046ed2682e15f133301496e830085f6f7

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage
@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.idea

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+sudo: false
+cache: bundler
+
+services:
+  - mongodb
+rvm:
+  - 2.2
+  - 2.1
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2
+
+gemfile:
+  - gemfiles/active_model_4.1.gemfile
+  - gemfiles/active_model_4.2.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,8 @@
+# ActiveModel integrations
+appraise 'active_model_4.1' do
+    gem 'activemodel', github: 'rails/rails', branch: '4-1-stable'
+end
+
+appraise 'active_model_4.2' do
+    gem 'activemodel', github: 'rails/rails', branch: '4-2-stable'
+end

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in state_machines-mongoid.gemspec
 gemspec

data/LICENSE.txt

@@ -1,3 +1,4 @@
+Copyright (c) 2006-2012 Aaron Pfeifer
 Copyright (c) 2014 Abdelkader Boudih
 
 MIT License

data/README.md

@@ -1,6 +1,10 @@
-# StateMachines::Mongoid
+[![Build Status](https://travis-ci.org/state-machines/state_machines-mongoid.svg?branch=master)](https://travis-ci.org/state-machines/state_machines-mongoid)
+[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-mongoid.png)](https://codeclimate.com/github/state-machines/state_machines-mongoid)
 
-TODO: Write a gem description
+# StateMachines Mongoid Integration
+
+The Mongoid integration adds support for automatically
+saving the record, named scopes, validation errors.
 
 ## Installation
 
@@ -18,12 +22,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class Vehicle
+  include Mongoid::Document
+
+  state_machine :initial => :parked do
+    before_transition :parked => any - :parked, :do => :put_on_seatbelt
+    after_transition any => :parked do |vehicle, transition|
+      vehicle.seatbelt_on = 'off'
+    end
+    around_transition :benchmark
+
+    event :ignite do
+      transition :parked => :idling
+    end
+
+    state :first_gear, :second_gear do
+      validates_presence_of :seatbelt_on
+    end
+  end
+
+  def put_on_seatbelt
+    self.seatbelt_on = 'on'
+  end
+
+  def benchmark
+    #...
+    yield
+    #...
+  end
+end
+```
+
+Dependencies
+
+Mongoid 4.0+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/state_machines-mongoid/fork )
+1. Fork it ( https://github.com/state-machines/state_machines-mongoid/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+

data/Rakefile

@@ -1,2 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+end
+
+desc 'Default: run all tests.'
+task :default => :test

data/gemfiles/active_model_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", :github => "rails/rails", :branch => "4-1-stable"
+
+gemspec :path => "../"

data/gemfiles/active_model_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", :github => "rails/rails", :branch => "4-2-stable"
+
+gemspec :path => "../"

data/lib/state_machines-mongoid.rb

@@ -0,0 +1 @@
+require 'state_machines/integrations/mongoid'

data/lib/state_machines/integrations/mongoid.rb

@@ -0,0 +1,401 @@
+require 'state_machines'
+require 'state_machines-activemodel'
+require 'mongoid'
+
+module StateMachines
+  module Integrations #:nodoc:
+    # Adds support for integrating state machines with Mongoid models.
+    #
+    # == Examples
+    #
+    # Below is an example of a simple state machine defined within a
+    # Mongoid model:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #     end
+    #   end
+    #
+    # The examples in the sections below will use the above class as a
+    # reference.
+    #
+    # == Actions
+    #
+    # By default, the action that will be invoked when a state is transitioned
+    # is the +save+ action.  This will cause the record to save the changes
+    # made to the state machine's attribute.  *Note* that if any other changes
+    # were made to the record prior to transition, then those changes will
+    # be saved as well.
+    #
+    # For example,
+    #
+    #   vehicle = Vehicle.create          # => #<Vehicle _id: 4d70e028b876bb54d9000003, name: nil, state: "parked">
+    #   vehicle.name = 'Ford Explorer'
+    #   vehicle.ignite                    # => true
+    #   vehicle.reload                    # => #<Vehicle _id: 4d70e028b876bb54d9000003, name: "Ford Explorer", state: "idling">
+    #
+    # == Events
+    #
+    # As described in StateMachines::InstanceMethods#state_machine, event
+    # attributes are created for every machine that allow transitions to be
+    # performed automatically when the object's action (in this case, :save)
+    # is called.
+    #
+    # In Mongoid, these automated events are run in the following order:
+    # * before validation - Run before callbacks and persist new states, then validate
+    # * before save - If validation was skipped, run before callbacks and persist new states, then save
+    # * after save - Run after callbacks
+    #
+    # For example,
+    #
+    #   vehicle = Vehicle.create          # => #<Vehicle _id: 4d70e028b876bb54d9000003, name: nil, state: "parked">
+    #   vehicle.state_event               # => nil
+    #   vehicle.state_event = 'invalid'
+    #   vehicle.valid?                    # => false
+    #   vehicle.errors.full_messages      # => ["State event is invalid"]
+    #
+    #   vehicle.state_event = 'ignite'
+    #   vehicle.valid?                    # => true
+    #   vehicle.save                      # => true
+    #   vehicle.state                     # => "idling"
+    #   vehicle.state_event               # => nil
+    #
+    # Note that this can also be done on a mass-assignment basis:
+    #
+    #   vehicle = Vehicle.create(:state_event => 'ignite')  # => #<Vehicle _id: 4d70e028b876bb54d9000003, name: nil, state: "idling">
+    #   vehicle.state                                       # => "idling"
+    #
+    # This technique is always used for transitioning states when the +save+
+    # action (which is the default) is configured for the machine.
+    #
+    # === Security implications
+    #
+    # Beware that public event attributes mean that events can be fired
+    # whenever mass-assignment is being used.  If you want to prevent malicious
+    # users from tampering with events through URLs / forms, the attribute
+    # should be protected like so:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     attr_protected :state_event
+    #     # attr_accessible ... # Alternative technique
+    #
+    #     state_machine do
+    #       ...
+    #     end
+    #   end
+    #
+    # If you want to only have *some* events be able to fire via mass-assignment,
+    # you can build two state machines (one public and one protected) like so:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     attr_protected :state_event # Prevent access to events in the first machine
+    #
+    #     state_machine do
+    #       # Define private events here
+    #     end
+    #
+    #     # Public machine targets the same state as the private machine
+    #     state_machine :public_state, :attribute => :state do
+    #       # Define public events here
+    #     end
+    #   end
+    #
+    # == Validations
+    #
+    # As mentioned in StateMachines::Machine#state, you can define behaviors,
+    # like validations, that only execute for certain states. One *important*
+    # caveat here is that, due to a constraint in Mongoid's validation
+    # framework, custom validators will not work as expected when defined to run
+    # in multiple states.  For example:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     state_machine do
+    #       ...
+    #       state :first_gear, :second_gear do
+    #         validate :speed_is_legal
+    #       end
+    #     end
+    #   end
+    #
+    # In this case, the <tt>:speed_is_legal</tt> validation will only get run
+    # for the <tt>:second_gear</tt> state.  To avoid this, you can define your
+    # custom validation like so:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     state_machine do
+    #       ...
+    #       state :first_gear, :second_gear do
+    #         validate {|vehicle| vehicle.speed_is_legal}
+    #       end
+    #     end
+    #   end
+    #
+    # == Validation errors
+    #
+    # If an event fails to successfully fire because there are no matching
+    # transitions for the current record, a validation error is added to the
+    # record's state attribute to help in determining why it failed and for
+    # reporting via the UI.
+    #
+    # For example,
+    #
+    #   vehicle = Vehicle.create(:state => 'idling')  # => #<Vehicle _id: 4d70e028b876bb54d9000003, name: nil, state: "idling">
+    #   vehicle.ignite                                # => false
+    #   vehicle.errors.full_messages                  # => ["State cannot transition via \"ignite\""]
+    #
+    # If an event fails to fire because of a validation error on the record and
+    # *not* because a matching transition was not available, no error messages
+    # will be added to the state attribute.
+    #
+    # In addition, if you're using the <tt>ignite!</tt> version of the event,
+    # then the failure reason (such as the current validation errors) will be
+    # included in the exception that gets raised when the event fails.  For
+    # example, assuming there's a validation on a field called +name+ on the class:
+    #
+    #   vehicle = Vehicle.new
+    #   vehicle.ignite!       # => StateMachines::InvalidTransition: Cannot transition state via :ignite from :parked (Reason(s): Name cannot be blank)
+    #
+    # == Scopes
+    #
+    # To assist in filtering models with specific states, a series of basic
+    # scopes are defined on the model for finding records with or without a
+    # particular set of states.
+    #
+    # These scopes are essentially the functional equivalent of the following
+    # definitions:
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     scope :with_states, lambda {|*states| where(:state => {'$in' => states})}
+    #     # with_states also aliased to with_state
+    #
+    #     scope :without_states, lambda {|*states| where(:state => {'$nin' => states})}
+    #     # without_states also aliased to without_state
+    #   end
+    #
+    # *Note*, however, that the states are converted to their stored values
+    # before being passed into the query.
+    #
+    # Because of the way named scopes work in Mongoid, they *cannot* be
+    # chained.
+    #
+    # Note that states can also be referenced by the string version of their
+    # name:
+    #
+    #   Vehicle.with_state('parked')
+    #
+    # == Callbacks
+    #
+    # All before/after transition callbacks defined for Mongoid models
+    # behave in the same way that other Mongoid callbacks behave.  The
+    # object involved in the transition is passed in as an argument.
+    #
+    # For example,
+    #
+    #   class Vehicle
+    #     include Mongoid::Document
+    #
+    #     state_machine :initial => :parked do
+    #       before_transition any => :idling do |vehicle|
+    #         vehicle.put_on_seatbelt
+    #       end
+    #
+    #       before_transition do |vehicle, transition|
+    #         # log message
+    #       end
+    #
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #     end
+    #
+    #     def put_on_seatbelt
+    #       ...
+    #     end
+    #   end
+    #
+    # Note, also, that the transition can be accessed by simply defining
+    # additional arguments in the callback block.
+    #
+    # == Observers
+    #
+    # Have been removed in Rails 4 and therefore are no longer supported.
+    #
+    # == Internationalization
+    #
+    # Any error message that is generated from performing invalid transitions
+    # can be localized.  The following default translations are used:
+    #
+    #   en:
+    #     mongoid:
+    #       errors:
+    #         messages:
+    #           invalid: "is invalid"
+    #           # %{value} = attribute value, %{state} = Human state name
+    #           invalid_event: "cannot transition when %{state}"
+    #           # %{value} = attribute value, %{event} = Human event name, %{state} = Human current state name
+    #           invalid_transition: "cannot transition via %{event}"
+    #
+    # You can override these for a specific model like so:
+    #
+    #   en:
+    #     mongoid:
+    #       errors:
+    #         models:
+    #           user:
+    #             invalid: "is not valid"
+    #
+    # In addition to the above, you can also provide translations for the
+    # various states / events in each state machine.  Using the Vehicle example,
+    # state translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +state_name+ = "parked":
+    # * <tt>mongoid.state_machines.#{model_name}.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>mongoid.state_machines.#{model_name}.states.#{state_name}</tt>
+    # * <tt>mongoid.state_machines.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>mongoid.state_machines.states.#{state_name}</tt>
+    #
+    # Event translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +event_name+ = "ignite":
+    # * <tt>mongoid.state_machines.#{model_name}.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>mongoid.state_machines.#{model_name}.events.#{event_name}</tt>
+    # * <tt>mongoid.state_machines.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>mongoid.state_machines.events.#{event_name}</tt>
+    #
+    # An example translation configuration might look like so:
+    #
+    #   es:
+    #     mongoid:
+    #       state_machines:
+    #         states:
+    #           parked: 'estacionado'
+    #         events:
+    #           park: 'estacionarse'
+    module Mongoid
+      include Base
+      include ActiveModel
+
+      # The default options to use for state machines using this integration
+      @defaults = { action: :save, use_transactions: false }
+
+      # Classes that include Mongoid::Document will automatically use the
+      # Mongoid integration.
+      def self.matching_ancestors
+        %w(Mongoid::Document)
+      end
+
+      def self.locale_path
+        "#{File.dirname(__FILE__)}/mongoid/locale.rb"
+      end
+
+      protected
+
+      # Only runs validations on the action if using <tt>:save</tt>
+      def runs_validations_on_action?
+        action == :save
+      end
+
+      # Gets the db default for the machine's attribute
+      def owner_class_attribute_default
+        attribute_field && attribute_field.default_val
+      end
+
+      # Gets the field for this machine's attribute (if it exists)
+      def attribute_field
+        owner_class.fields[attribute.to_s] || owner_class.fields[owner_class.aliased_fields[attribute.to_s]]
+      end
+
+      # Defines an initialization hook into the owner class for setting the
+      # initial state of the machine *before* any attributes are set on the
+      # object
+      def define_state_initializer
+        define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+            def initialize(*)
+              super do |*args|
+                self.class.state_machines.initialize_states(self, :static => false)
+                yield(*args) if block_given?
+              end
+            end
+
+            def apply_pre_processed_defaults
+              defaults = {}
+              self.class.state_machines.initialize_states(self, :static => :force, :dynamic => false, :to => defaults)
+              defaults.each do |attr, value|
+                send(:"\#{attr}=", value) unless attributes.include?(attr)
+              end
+              super
+            end
+        end_eval
+      end
+
+      # Skips defining reader/writer methods since this is done automatically
+      def define_state_accessor
+        owner_class.field(attribute, type: String) unless attribute_field
+        super
+      end
+
+      # Uses around callbacks to run state events if using the :save hook
+      def define_action_hook
+        if action_hook == :save
+          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+              def insert(*)
+                self.class.state_machine(#{name.inspect}).send(:around_save, self) { super.persisted? }
+                self
+              end
+
+              def update(*)
+                self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
+              end
+
+              def upsert(*)
+                self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
+              end
+          end_eval
+        else
+          super
+        end
+      end
+
+      # Runs state events around the machine's :save action
+      def around_save(object)
+        object.class.state_machines.transitions(object, action).perform { yield }
+      end
+
+      # Creates a scope for finding records *with* a particular state or
+      # states for the attribute
+      def create_with_scope(name)
+        define_scope(name, lambda { |values| { attribute => { '$in' => values } } })
+      end
+
+      # Creates a scope for finding records *without* a particular state or
+      # states for the attribute
+      def create_without_scope(name)
+        define_scope(name, lambda { |values| { attribute => { '$nin' => values } } })
+      end
+
+      # Defines a new scope with the given name
+      def define_scope(_name, scope)
+        lambda { |model, values| model.criteria.where(scope.call(values)) }
+      end
+
+      def locale_path
+        "#{File.dirname(__FILE__)}/mongoid/locale.rb"
+      end
+    end
+    register(Mongoid)
+
+  end
+end