aasm_history 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d753fc692e9678444789c357d0abcde9a976409
-  data.tar.gz: 3279159e3145247d579781d6318326e1cf5eb518
+  metadata.gz: 403df6b0e2e4c41c78a9c9f99f22729a54ec1d78
+  data.tar.gz: 59594bd1ddcaf37ae6370f9a4009e4dcadafa80a
 SHA512:
-  metadata.gz: 198b91dd1785f2d6b5cd91ae9a7ddac077493a7f01ea629122417fcd3fbaf9120e0ac8565be566e2e76937ec0016ec78106e82dd8186228d4a6ba52b1cdf644d
-  data.tar.gz: 635b3a36f2367456e7f037f249c1bbbde62f22d512ea66a57df3d391e6e02f0a47b7fbe16d02c04824f1ca4a3ce5452b386ac776e92955270699fa500653bcb6
+  metadata.gz: ca3e98942fefe4ac69eea1e42e92fc9a1a73f87bb78c22ffaabd06f8ed43768dcff9ccbb3775debea227a3be9fcb6a5eb980a090980db0233d72adbe3532ddf1
+  data.tar.gz: 203d472f453728ceb7a5189989ca92ae4f26afd168727589c8ec469138a73e1c17b1c92aa5e038fca5709e48001dba210c616ec69440b45273c0d7fba63f0971

data/.gitignore

@@ -1,22 +1,4 @@
 *.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/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.0
+  - 2.0.0
+script:
+ - bundle exec rake

data/README.md

@@ -1,8 +1,10 @@
+[![Build Status](https://travis-ci.org/gogiel/aasm_history.svg?branch=master)](https://travis-ci.org/gogiel/aasm_history)
+
 # AasmHistory
 
 Track and persist AASM state history.
 
-Currently only ActiveRecord is supported.
+This gem depends on Ruby >= 2.0.0.
 
 ## Installation
 
@@ -10,7 +12,9 @@ Add this line to your application's Gemfile:
 
     gem 'aasm_history'
 
-## Usage
+## Installation
+
+### Active Record
 
 Add migration:
 
@@ -22,15 +26,52 @@ Add migration:
       t.datetime :created_at
       t.datetime :updated_at
     end
-
+    
 It will create state history table - common for all classes.
 
-Inside aasm block insert
+Create StateHistory class
+
+    class StateHistory < ActiveRecord::Base
+      belongs_to :stateable, polymorphic: true
+    end
+
+### Sequel, Mongoid and others
+
+Not supported.
+
+## Usage
+
+Inside `aasm` block call `has_history`.
+
+    aasm do 
+        has_history
+        # ...
+    end
+    
+You can also call `has_state_history` in your model to create `state_histories` relation.
+   
+## Example:
+
+### Definition
+
+    class Order
+        aasm do
+            has_history
+            # ...
+        end
+        
+        has_state_history
+    end
+    
+### Usage
+    
+    #> Order.last.state_histories
+     [#<StateHistory id: 2, state: "in_production", previous_state: "new", stateable_id: 2, stateable_type: "Order", created_at: "2014-09-27 22:34:00", updated_at: "2014-09-27 22:34:00">]
 
-    has_history
+## Extending
 
-And that's all!
+Gem is highly extendable and configurable.
 
 ## Contributing
 
-You are welcome to contribute with Github's Pull Requests!
+You are welcome to contribute with Pull Requests and new Issues!

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/aasm_history.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jan Jedrychowski']
   spec.email         = ['jan@jedrychowski.org']
   spec.summary       = %q{Track and persist AASM state history}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/gogiel/aasm_history'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0' # due to Module#prepend
 
   spec.add_dependency 'aasm', '~> 3.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'activerecord', '~> 4.1'

data/lib/aasm_history.rb

@@ -1,6 +1,20 @@
-require "aasm_history/version"
-require 'aasm_history/aasm_ext/base'
+require 'aasm'
 
 module AasmHistory
-  autoload :HistoryCreator, 'aasm_history/history_creator'
+  autoload :PersistanceDeterminator,  'aasm_history/persistance_determinator'
+  autoload :UnknownPersistanceLayer,  'aasm_history/persistance_determinator'
+
+  module Persistance
+    autoload :ActiveRecord,           'aasm_history/persistance/active_record'
+    autoload :ActiveRecordCreator,    'aasm_history/persistance/active_record_creator'
+  end
+
+  module Ext
+    autoload :ActiveRecord,           'aasm_history/ext/active_record'
+  end
+
 end
+
+require 'aasm_history/version'
+require 'aasm_history/aasm_ext/base'
+require 'aasm_history/load_extensions'

data/lib/aasm_history/aasm_ext/base.rb

@@ -1,24 +1,14 @@
 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
+      case AasmHistory::PersistanceDeterminator.determine(@klass)
+        when :active_record
+          configure :history_class, 'StateHistory'
+          configure :creator_class, 'AasmHistory::Persistance::ActiveRecordCreator'
+          @klass.send :prepend, AasmHistory::Persistance::ActiveRecord
+        else
+          raise AasmHistory::UnknownPersistanceLayer
+      end
     end
-
   end
 end

data/lib/aasm_history/ext/active_record.rb

@@ -0,0 +1,15 @@
+module AasmHistory
+  module Ext
+    module ActiveRecord
+      def self.included base
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def has_state_history
+          has_many :state_histories, as: :stateable
+        end
+      end
+    end
+  end
+end

data/lib/aasm_history/load_extensions.rb

@@ -0,0 +1,3 @@
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.include AasmHistory::Ext::ActiveRecord
+end

data/lib/aasm_history/persistance/active_record.rb

@@ -0,0 +1,19 @@
+module AasmHistory
+  module Persistance
+    module ActiveRecord
+
+      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
+        AASM::StateMachine[self.class].config.creator_class.constantize.new(self, state, previous_state).create
+      end
+    end
+  end
+end

data/lib/aasm_history/persistance/active_record_creator.rb

@@ -0,0 +1,23 @@
+module AasmHistory
+  module Persistance
+    class ActiveRecordCreator
+      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
+end

data/lib/aasm_history/persistance_determinator.rb

@@ -0,0 +1,26 @@
+module AasmHistory
+  class UnknownPersistanceLayer < StandardError
+    def message
+      'Persistance layer is not supported.'
+    end
+  end
+
+  class PersistanceDeterminator
+    def initialize base
+      @base = base
+    end
+
+    def determine
+      hierarchy = @base.ancestors.map {|klass| klass.to_s}
+
+      if hierarchy.include?('ActiveRecord::Base')
+        :active_record
+      end
+    end
+
+    def self.determine base
+      new(base).determine
+    end
+
+  end
+end

data/lib/aasm_history/version.rb

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

data/spec/aasm_history_spec.rb

@@ -1,13 +1,37 @@
 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'
+describe 'determining persistance layer' do
+  class NoPersistence
+    include AASM
+  end
+
+  it 'fails if persistance layer is unknown' do
+    expect {
+      NoPersistence.aasm do
+        has_history
+      end
+    }.to raise_exception AasmHistory::UnknownPersistanceLayer
+  end
+end
+
+describe 'saving history' do
+  describe 'active record' do
+    subject! do
+      object = Dummy.create!
+      object.a_to_b!
+      object
+    end
+
+    it 'creates history entry on state change' do
+      expect(StateHistory.count).to eq 1
+      history = StateHistory.first
+      expect(history.stateable).to eq subject
+      expect(history.state).to eq 'b'
+      expect(history.previous_state).to eq 'a'
+    end
+
+    it 'is possible to acess history using relation from helper' do
+      expect(subject.state_histories.count).to eq 1
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'aasm_history'
 require 'active_record'
+require 'aasm_history'
 
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require_relative f }
 

data/spec/support/active_record/models.rb

@@ -1,5 +1,3 @@
-require 'aasm'
-
 class Dummy < ActiveRecord::Base
   include AASM
 
@@ -14,6 +12,8 @@ class Dummy < ActiveRecord::Base
       transitions from: :a, to: :b
     end
   end
+
+  has_state_history
 end
 
 class StateHistory < ActiveRecord::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm_history
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Jan Jedrychowski
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,13 +116,17 @@ files:
 - aasm_history.gemspec
 - lib/aasm_history.rb
 - lib/aasm_history/aasm_ext/base.rb
-- lib/aasm_history/history_creator.rb
+- lib/aasm_history/ext/active_record.rb
+- lib/aasm_history/load_extensions.rb
+- lib/aasm_history/persistance/active_record.rb
+- lib/aasm_history/persistance/active_record_creator.rb
+- lib/aasm_history/persistance_determinator.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: ''
+homepage: https://github.com/gogiel/aasm_history
 licenses:
 - MIT
 metadata: {}

data/lib/aasm_history/history_creator.rb

@@ -1,21 +0,0 @@
-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