state_machines-activemodel-observers 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 421f37b35ee734f194f8dce74087808e4a23daa6
+  data.tar.gz: c44bbfa0a5bddd3ba52631e71cbee1fc141f6d71
+SHA512:
+  metadata.gz: d6a75ef16b999f667d30062320133b8a2ab43d707e11ffe2d06a3672ab3f54b5fa6529bc501a881ef6a655906112838c194e35a6255d06e60f8087f4e7099295
+  data.tar.gz: cf2d6ba7999a194438e76196cc30bd3489f699fcc1db74c81d125ce37832f18c847bfbcee9321a4d66a00231324e27e026ecfe81dcef25853a2e4a743f3c6c36

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+before_install:
+ - gem install bundler
+ - bundle install
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.2
+  - jruby-19mode
+  - rbx-2
+
+gemfile:
+  - gemfiles/active_model_4.1.gemfile
+  - gemfiles/active_model_4.2.gemfile

data/Appraisals

@@ -0,0 +1,9 @@
+appraise 'active_model_4.1' do
+    gem 'activemodel', '~> 4.1.0'
+    gem 'rails-observers'
+end
+
+appraise "active_model_4.2" do
+    gem "activemodel", "~> 4.2.0"
+    gem 'rails-observers'
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2006-2012 Aaron Pfeifer
+Copyright (c) 2014-2015 Abdelkader Boudih
+
+MIT License
+
+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.md

@@ -0,0 +1,32 @@
+[![Build Status](https://travis-ci.org/state-machines/state_machines-activemodel-observers.svg?branch=master)](https://travis-ci.org/state-machines/state_machines-activemodel-observers)
+[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-activemodel-observers.png)](https://codeclimate.com/github/state-machines/state_machines-activemodel-observers)
+# StateMachines: ActiveModel Observers
+
+ActiveModel Observers integration for State Machines
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state_machines-activemodel-observers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state_machines-activemodel-observers
+
+## Usage
+
+TODO: Write usage instructions here
+TODO: Import/Write tests
+
+## Contributing
+
+1. Fork it ( https://github.com/state-machines/state_machines-activemodel-observers/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

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Default: run all tests.'
+task default: :test

data/gemfiles/active_model_4.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", "~> 4.1.0"
+gem "rails-observers"
+
+gemspec :path => "../"

data/gemfiles/active_model_4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activemodel", "~> 4.2.0"
+gem "rails-observers"
+
+gemspec :path => "../"

data/lib/state_machines-activemodel-observers.rb

@@ -0,0 +1 @@
+require 'state_machines/integrations/active_model/observers'

data/lib/state_machines/integrations/active_model/observers.rb

@@ -0,0 +1,102 @@
+require 'state_machines/integrations/active_model'
+require 'rails/observers/active_model'
+require_relative 'observers/version'
+require_relative 'observers/observer_update'
+
+module StateMachines
+  module Integrations
+    module ActiveModel
+      # Classes that include ActiveModel::Observing
+      # will automatically use the ActiveModel integration.
+      def self.matching_ancestors
+        %w(ActiveModel ActiveModel::Observing ActiveModel::Validations)
+      end
+
+      # Adds a set of default callbacks that utilize the Observer extensions
+      def add_default_callbacks
+        callbacks[:before] << StateMachines::Callback.new(:before) { |object, transition| notify(:before, object, transition) }
+        callbacks[:after] << StateMachines::Callback.new(:after) { |object, transition| notify(:after, object, transition) }
+        callbacks[:failure] << StateMachines::Callback.new(:failure) { |object, transition| notify(:after_failure_to, object, transition) }
+      end
+
+      # Notifies observers on the given object that a callback occurred
+      # involving the given transition.  This will attempt to call the
+      # following methods on observers:
+      # * <tt>#{type}_#{qualified_event}_from_#{from}_to_#{to}</tt>
+      # * <tt>#{type}_#{qualified_event}_from_#{from}</tt>
+      # * <tt>#{type}_#{qualified_event}_to_#{to}</tt>
+      # * <tt>#{type}_#{qualified_event}</tt>
+      # * <tt>#{type}_transition_#{machine_name}_from_#{from}_to_#{to}</tt>
+      # * <tt>#{type}_transition_#{machine_name}_from_#{from}</tt>
+      # * <tt>#{type}_transition_#{machine_name}_to_#{to}</tt>
+      # * <tt>#{type}_transition_#{machine_name}</tt>
+      # * <tt>#{type}_transition</tt>
+      #
+      # This will always return true regardless of the results of the
+      # callbacks.
+      def notify(type, object, transition)
+        name = self.name
+        event = transition.qualified_event
+        from = transition.from_name || 'nil'
+        to = transition.to_name || 'nil'
+
+        # Machine-specific updates
+        ["#{type}_#{event}", "#{type}_transition_#{name}"].each do |event_segment|
+          ["_from_#{from}", nil].each do |from_segment|
+            ["_to_#{to}", nil].each do |to_segment|
+              object.class.changed if object.class.respond_to?(:changed)
+              object.class.notify_observers('update_with_transition', ObserverUpdate.new([event_segment, from_segment, to_segment].join, object, transition))
+            end
+          end
+        end
+
+        # Generic updates
+        object.class.changed if object.class.respond_to?(:changed)
+        object.class.notify_observers('update_with_transition', ObserverUpdate.new("#{type}_transition", object, transition))
+
+        true
+      end
+
+      def add_callback(type, options, &block)
+        options[:terminator] = callback_terminator
+        @callbacks[type == :around ? :before : type].insert(-2, callback = StateMachines::Callback.new(type, options, &block))
+        add_states(callback.known_states)
+        callback
+      end
+
+      # Initializes class-level extensions and defaults for this machine
+      def after_initialize
+        super()
+        add_default_callbacks
+      end
+
+      # Adds support for invoking callbacks on ActiveModel observers with more
+      # than one argument (e.g. the record *and* the state transition).  By
+      # default, ActiveModel only supports passing the record into the
+      # callbacks.
+      #
+      # For example:
+      #
+      #   class VehicleObserver < ActiveModel::Observer
+      #     # The default behavior: only pass in the record
+      #     def after_save(vehicle)
+      #     end
+      #
+      #     # Custom behavior: allow the transition to be passed in as well
+      #     def after_transition(vehicle, transition)
+      #       Audit.log(vehicle, transition)
+      #     end
+      #   end
+      module Observer
+        def update_with_transition(observer_update)
+          method = observer_update.method
+          send(method, *observer_update.args) if respond_to?(method)
+        end
+      end
+    end
+  end
+end
+
+ActiveModel::Observer.class_eval do
+  include StateMachines::Integrations::ActiveModel::Observer
+end

data/lib/state_machines/integrations/active_model/observers/observer_update.rb

@@ -0,0 +1,42 @@
+module StateMachines
+  module Integrations #:nodoc:
+    module ActiveModel
+      # Represents the encapsulation of all of the details to be included in an
+      # update to state machine observers.  This allows multiple arguments to
+      # get passed to an observer method (instead of just a single +object+)
+      # while still respecting the way in which ActiveModel checks for the
+      # object's list of observers.
+      class ObserverUpdate
+        # The method to invoke on the observer
+        attr_reader :method
+
+        # The object being transitioned
+        attr_reader :object
+
+        # The transition being run
+        attr_reader :transition
+
+        def initialize(method, object, transition) #:nodoc:
+          @method, @object, @transition = method, object, transition
+        end
+
+        # The arguments to pass into the method
+        def args
+          [object, transition]
+        end
+
+        # The class of the object being transitioned.  Normally the object
+        # getting passed into observer methods is the actual instance of the
+        # ActiveModel class.  ActiveModel uses that instance's class to check
+        # for enabled / disabled observers.
+        #
+        # Since state_machine is passing an ObserverUpdate instance into observer
+        # methods, +class+ needs to be overridden so that ActiveModel can still
+        # get access to the enabled / disabled observers.
+        def class
+          object.class
+        end
+      end
+    end
+  end
+end

data/lib/state_machines/integrations/active_model/observers/version.rb

@@ -0,0 +1,9 @@
+module StateMachines
+  module Integrations
+    module ActiveModel
+      module Observers
+        VERSION = '0.0.2'
+      end
+    end
+  end
+end

data/state_machines-activemodel-observers.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_machines/integrations/active_model/observers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'state_machines-activemodel-observers'
+  spec.version       = StateMachines::Integrations::ActiveModel::Observers::VERSION
+  spec.authors       = ['Abdelkader Boudih', 'Aaron Pfeifer']
+  spec.email         = %w(terminale@gmail.com aaron@pluginaweek.org)
+  spec.summary       = %q(ActiveModel Observers integration for State Machines)
+  spec.description   = %q(Adds support for ActiveModel Observers)
+  spec.homepage      = 'https://github.com/state-machines/state_machines-activemodel-observers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version     = '>= 1.9.3'
+
+  spec.add_dependency 'state_machines-activemodel'    , '>= 0.2.0'
+  spec.add_dependency 'rails-observers'
+
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'rake', '>= 10'
+  spec.add_development_dependency 'appraisal', '>= 2'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+begin
+  require 'pry-byebug'
+rescue LoadError
+end
+
+require 'state_machines-activemodel'
+require 'minitest/autorun'
+require 'minitest/reporters'

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: state_machines-activemodel-observers
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Abdelkader Boudih
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: state_machines-activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rails-observers
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds support for ActiveModel Observers
+email:
+- terminale@gmail.com
+- aaron@pluginaweek.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/active_model_4.1.gemfile
+- gemfiles/active_model_4.2.gemfile
+- lib/state_machines-activemodel-observers.rb
+- lib/state_machines/integrations/active_model/observers.rb
+- lib/state_machines/integrations/active_model/observers/observer_update.rb
+- lib/state_machines/integrations/active_model/observers/version.rb
+- state_machines-activemodel-observers.gemspec
+- test/test_helper.rb
+homepage: https://github.com/state-machines/state_machines-activemodel-observers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: ActiveModel Observers integration for State Machines
+test_files:
+- test/test_helper.rb