state_machines-audit_trail 1.0.0

data/spec/lib/state_machines/audit_trail/backend/mongoid_spec.rb

@@ -0,0 +1,98 @@
+# reset integrations so that something like ActiveRecord is not loaded and conflicting
+require 'state_machines'
+StateMachines::Integrations.reset
+
+require 'spec_helper'
+require 'state_machines-mongoid'
+require 'helpers/mongoid'
+
+describe StateMachines::AuditTrail::Backend::Mongoid do
+
+  context '#create_for' do
+    it 'should create a Mongoid backend' do
+      backend = StateMachines::AuditTrail::Backend.create_for(MongoidTestModelStateTransition, MongoidTestModel)
+      expect(backend).to be_instance_of(StateMachines::AuditTrail::Backend::Mongoid)
+    end
+  end
+
+  context 'single state machine' do
+    let!(:target) { MongoidTestModel.create! }
+
+    it 'should populate all fields' do
+      target.start!
+      last_transition = MongoidTestModelStateTransition.where(:mongoid_test_model_id => target.id).last
+
+      expect(last_transition.event).to eq 'start'
+      expect(last_transition.from).to eq 'waiting'
+      expect(last_transition.to).to eq 'started'
+      expect(last_transition.created_at).to be_within(10.seconds).of(DateTime.now)
+    end
+
+    it 'should log multiple events' do
+      expect { target.start && target.stop && target.start }.to change(MongoidTestModelStateTransition, :count).by(3)
+    end
+
+    it 'do nothing on failed transition' do
+      expect { target.stop }.not_to change(MongoidTestModelStateTransition, :count)
+    end
+  end
+
+  context 'multiple state machines' do
+    let!(:target) { MongoidTestModelWithMultipleStateMachines.create! }
+
+    it 'should log a state transition for the affected state machine' do
+      expect { target.begin_first! }.to change(MongoidTestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
+    end
+
+    it 'should not log a state transition for the unaffected state machine' do
+      expect { target.begin_first! }.not_to change(MongoidTestModelWithMultipleStateMachinesSecondTransition, :count)
+    end
+  end
+
+  context 'on an object with a state machine having an initial state' do
+    let(:target_class) { MongoidTestModelWithMultipleStateMachines }
+    let(:state_transition_class) { MongoidTestModelWithMultipleStateMachinesFirstTransition }
+
+    it 'should log a state transition for the inital state' do
+      expect { target_class.create! }.to change(state_transition_class, :count).by(1)
+    end
+
+    it 'should only set the :to state for the initial transition' do
+      target_class.create!
+      initial_transition = state_transition_class.last
+      expect(initial_transition.event).to be_nil
+      expect(initial_transition.from).to be_nil
+      expect(initial_transition.to).to eq 'beginning'
+      expect(initial_transition.created_at).to be_within(10.seconds).of(DateTime.now)
+    end
+  end
+
+  context 'on an object with a state machine not having an initial state' do
+    let(:target_class) { MongoidTestModelWithMultipleStateMachines }
+    let(:state_transition_class) { MongoidTestModelWithMultipleStateMachinesSecondTransition }
+
+    it 'should not log a transition when the object is created' do
+      expect { target_class.create! }.not_to change(state_transition_class, :count)
+    end
+
+    it 'should log a transition for the first event' do
+      expect { target_class.create.begin_second! }.to change(state_transition_class, :count).by(1)
+    end
+
+    it 'should not set a value for the :from state on the first transition' do
+      target_class.create.begin_second!
+      first_transition = state_transition_class.last
+      expect(first_transition.event).to eq 'begin_second'
+      expect(first_transition.from).to be_nil
+      expect(first_transition.to).to eq 'beginning_second'
+      expect(first_transition.created_at).to be_within(10.seconds).of(DateTime.now)
+    end
+  end
+
+  context 'on a class using STI' do
+    it 'should properly grab the class name from STI models' do
+      m = MongoidTestModelDescendant.create!
+      expect { m.start! }.not_to raise_error
+    end
+  end
+end

data/spec/lib/state_machines/audit_trail_generator_spec.rb

@@ -0,0 +1,54 @@
+# FIXME: Unable to get this test to run, though the generator does work.  Someone fix me please.
+#
+# require 'rails'
+# require 'spec_helper'
+# require 'state_machines-activerecord'
+# require 'rails/generators/active_model'
+# require 'state_machines/audit_trail_generator'
+# require 'generator_spec'
+#
+# describe StateMachines::AuditTrailGenerator, type: :generator do
+#
+#   destination File.expand_path('../../../../tmp', __FILE__)
+#   arguments %w(SomeNamespace::Subscription state)
+#
+#   before(:all) do
+#     prepare_destination
+#   end
+#
+#   # create    db/migrate/20150326190913_create_some_namespace_subscription_state_transitions.rb
+#   # create    app/models/some_namespace/subscription_state_transition.rb
+#   # create    app/models/some_namespace.rb
+#   # invoke    test_unit
+#   # create      test/models/some_namespace/subscription_state_transition_test.rb
+#   # invoke      factory_girl
+#   # create        test/factories/af_core_subscription_state_transitions.rb
+#
+#
+#   specify do
+#     run_generator
+#     expect(destination_root).to have_structure {
+#                                   # no_file 'test.rb'
+#                                   directory 'app' do
+#                                     directory 'models' do
+#                                       file 'some_namespace.rb' do
+#                                         contains 'def self.table_name_prefix'
+#                                       end
+#                                       directory 'some_namespace' do
+#                                         file 'subscription_state_transition.rb' do
+#                                           contains 'class SomeNamespace::SubscriptionStateTransition'
+#                                         end
+#                                       end
+#                                     end
+#                                   end
+#                                   directory 'db' do
+#                                     directory 'migrate' do
+#                                       file '123_create_some_namespace_subscription_state_transitions.rb'
+#                                       migration 'create_tests' do
+#                                         contains 'class TestMigration'
+#                                       end
+#                                     end
+#                                   end
+#                                 }
+#   end
+# end

data/spec/lib/state_machines/audit_trail_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe StateMachines::AuditTrail do
+  
+  it 'should include the auditing module into StateMachines::Machine' do
+    expect(StateMachines::Machine.included_modules).to include(StateMachines::AuditTrail::TransitionAuditing)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'state_machines/audit_trail'
+
+RSpec.configure do |config|
+end

data/state_machines-audit_trail.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_machines/audit_trail/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'state_machines-audit_trail'
+  s.version     = StateMachines::AuditTrail::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Kevin Ross', 'Willem van Bergen', 'Jesse Storimer']
+  s.email       = ['kevin.ross@alienfast.com', 'willem@shopify.com', 'jesse@shopify.com']
+
+  s.homepage    = 'https://github.com/state-machines/state_machines-audit_trail'
+  s.summary     = %q{Log transitions on a state_machines to support auditing and business process analytics.}
+  s.description = %q{Log transitions on a state_machines to support auditing and business process analytics.}
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency('state_machines')
+
+  s.add_development_dependency('state_machines-activerecord')
+  s.add_development_dependency('state_machines-mongoid')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '>= 3.0.0')
+  s.add_development_dependency('activerecord', '>= 4.0.0')
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('mongoid', '>= 4.0.0')
+  s.add_development_dependency('bson_ext')
+  s.add_development_dependency('generator_spec')
+  s.add_development_dependency('rails', '>= 4.0.0')
+
+  s.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: state_machines-audit_trail
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Ross
+- Willem van Bergen
+- Jesse Storimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: state_machines
+  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: state_machines-activerecord
+  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: state_machines-mongoid
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  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: generator_spec
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Log transitions on a state_machines to support auditing and business
+  process analytics.
+email:
+- kevin.ross@alienfast.com
+- willem@shopify.com
+- jesse@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/state_machines-audit_trail.rb
+- lib/state_machines/audit_trail.rb
+- lib/state_machines/audit_trail/backend.rb
+- lib/state_machines/audit_trail/backend/active_record.rb
+- lib/state_machines/audit_trail/backend/mongoid.rb
+- lib/state_machines/audit_trail/railtie.rb
+- lib/state_machines/audit_trail/transition_auditing.rb
+- lib/state_machines/audit_trail/version.rb
+- lib/state_machines/audit_trail_generator.rb
+- spec/helpers/active_record.rb
+- spec/helpers/mongoid.rb
+- spec/helpers/mongoid.yml
+- spec/lib/state_machines/audit_trail/backend/active_record_spec.rb
+- spec/lib/state_machines/audit_trail/backend/mongoid_spec.rb
+- spec/lib/state_machines/audit_trail_generator_spec.rb
+- spec/lib/state_machines/audit_trail_spec.rb
+- spec/spec_helper.rb
+- state_machines-audit_trail.gemspec
+homepage: https://github.com/state-machines/state_machines-audit_trail
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Log transitions on a state_machines to support auditing and business process
+  analytics.
+test_files:
+- spec/helpers/active_record.rb
+- spec/helpers/mongoid.rb
+- spec/helpers/mongoid.yml
+- spec/lib/state_machines/audit_trail/backend/active_record_spec.rb
+- spec/lib/state_machines/audit_trail/backend/mongoid_spec.rb
+- spec/lib/state_machines/audit_trail_generator_spec.rb
+- spec/lib/state_machines/audit_trail_spec.rb
+- spec/spec_helper.rb