aasm_history 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d753fc692e9678444789c357d0abcde9a976409
+  data.tar.gz: 3279159e3145247d579781d6318326e1cf5eb518
+SHA512:
+  metadata.gz: 198b91dd1785f2d6b5cd91ae9a7ddac077493a7f01ea629122417fcd3fbaf9120e0ac8565be566e2e76937ec0016ec78106e82dd8186228d4a6ba52b1cdf644d
+  data.tar.gz: 635b3a36f2367456e7f037f249c1bbbde62f22d512ea66a57df3d391e6e02f0a47b7fbe16d02c04824f1ca4a3ce5452b386ac776e92955270699fa500653bcb6

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jan Jedrychowski
+
+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,36 @@
+# AasmHistory
+
+Track and persist AASM state history.
+
+Currently only ActiveRecord is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aasm_history'
+
+## Usage
+
+Add migration:
+
+    create_table :state_histories do |t|
+      t.string   :state
+      t.string   :previous_state
+      t.integer  :stateable_id
+      t.string   :stateable_type
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+It will create state history table - common for all classes.
+
+Inside aasm block insert
+
+    has_history
+
+And that's all!
+
+## Contributing
+
+You are welcome to contribute with Github's Pull Requests!

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/aasm_history.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aasm_history/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aasm_history'
+  spec.version       = AasmHistory::VERSION
+  spec.authors       = ['Jan Jedrychowski']
+  spec.email         = ['jan@jedrychowski.org']
+  spec.summary       = %q{Track and persist AASM state history}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0' # due to Module#prepend
+
+  spec.add_dependency 'aasm', '~> 3.3'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'activerecord', '~> 4.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.9'
+
+end

data/lib/aasm_history.rb

@@ -0,0 +1,6 @@
+require "aasm_history/version"
+require 'aasm_history/aasm_ext/base'
+
+module AasmHistory
+  autoload :HistoryCreator, 'aasm_history/history_creator'
+end

data/lib/aasm_history/aasm_ext/base.rb

@@ -0,0 +1,24 @@
+module AASM
+  class Base
+    module HistoryMethods
+      def aasm_write_state state
+        previous_state = read_attribute(self.class.aasm_column)
+        success = super state
+        store_aasm_history state, previous_state if success
+        success
+      end
+
+      private
+
+      def store_aasm_history state, previous_state
+        AasmHistory::HistoryCreator.new(self, state, previous_state).create
+      end
+    end
+
+    def has_history
+      configure 'history_class', 'StateHistory'
+      @klass.send :prepend, HistoryMethods
+    end
+
+  end
+end

data/lib/aasm_history/history_creator.rb

@@ -0,0 +1,21 @@
+module AasmHistory
+  class HistoryCreator
+    def initialize object, state, previous_state
+      @object = object
+      @state = state
+      @previous_state = previous_state
+    end
+
+    def create
+      klass.create! attributes
+    end
+
+    def klass
+      @klass ||= AASM::StateMachine[@object.class].config.history_class.constantize
+    end
+
+    def attributes
+      {state: @state, previous_state: @previous_state, stateable: @object}
+    end
+  end
+end

data/lib/aasm_history/version.rb

@@ -0,0 +1,3 @@
+module AasmHistory
+  VERSION = "0.0.1"
+end

data/spec/aasm_history_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'AASM History' do
+  it 'creates history entry on state change' do
+    object = Dummy.create!
+    object.a_to_b!
+    expect(StateHistory.count).to eq 1
+    history = StateHistory.first
+    expect(history.stateable).to eq object
+    expect(history.state).to eq 'b'
+    expect(history.previous_state).to eq 'a'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'aasm_history'
+require 'active_record'
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require_relative f }
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+create_ar_schema

data/spec/support/active_record/models.rb

@@ -0,0 +1,21 @@
+require 'aasm'
+
+class Dummy < ActiveRecord::Base
+  include AASM
+
+  aasm column: 'state' do
+    has_history
+
+    state :a, initial: true
+    state :b
+    state :c
+
+    event :a_to_b do
+      transitions from: :a, to: :b
+    end
+  end
+end
+
+class StateHistory < ActiveRecord::Base
+  belongs_to :stateable, polymorphic: true
+end

data/spec/support/active_record/schema.rb

@@ -0,0 +1,20 @@
+def create_ar_schema
+  ActiveRecord::Schema.define do
+    self.verbose = false
+
+    create_table :dummies, force: true do |t|
+      t.string :state
+      t.timestamps
+    end
+
+    create_table :state_histories, force: true do |t|
+      t.string   :state
+      t.string   :previous_state
+      t.integer  :stateable_id
+      t.string   :stateable_type
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: aasm_history
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan Jedrychowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+description: 
+email:
+- jan@jedrychowski.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aasm_history.gemspec
+- lib/aasm_history.rb
+- lib/aasm_history/aasm_ext/base.rb
+- lib/aasm_history/history_creator.rb
+- lib/aasm_history/version.rb
+- spec/aasm_history_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record/models.rb
+- spec/support/active_record/schema.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Track and persist AASM state history
+test_files:
+- spec/aasm_history_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record/models.rb
+- spec/support/active_record/schema.rb