aasm_history 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 986a38cd9d39bfefdeaa4af53ce353301f5ceb7b
-  data.tar.gz: f0e76e7de9d93f3a501f727f23099ee7a7a66fdf
+  metadata.gz: 8fb0db21a3554b04441443e5c89f047e498d4dc0
+  data.tar.gz: 1e28227d0d95e9b93ea21126502bbff4454dd849
 SHA512:
-  metadata.gz: 70fa7b9646b8e9f8e8294a9c0990e259cf8ee802af76e2fa2b7357838aded26c156fa0485faa932598d0122a594108122bacfb12f5b032e532ce6fb92af03825
-  data.tar.gz: a0d5c1f54d1e400ed73852626cbc964429101688f49d9a9cdedd72579f8252a51519c8caddb847ac04233aac3c0ebc96ba53ec18f0e10edca5781e699abd86a9
+  metadata.gz: 6b39cd5c6b03be420f8f13172659cf5bfdf6d50557d1db759f7948577e701ab6c0ba5644ad2276f0b50173e1dc9357cc57de2bc4398ab7e9caab2b2f1aa56bcf
+  data.tar.gz: 7aff72b3c13fe2166eacb6d40e266a9d4d45adb073789fc26a93f6d9a7727f28c32826b75a5c95df62e55677e8ce83987cb1ea4223dfa8516619efbbeeecdaa5

data/README.md

@@ -68,6 +68,11 @@ You can also call `has_state_history` in your model to create `state_histories`
     #> 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">]
 
+## Configuration
+
+In initializer you can set `AasmHistory.enabled_by_default = true` to make all AASM instances have history support by default (in other words no need to call `has_history`).
+To make exception call `has_history(false)` in `aasm` block.
+
 ## Extending
 
 Gem is highly extendable and configurable.

data/aasm_history.gemspec

@@ -6,10 +6,10 @@ 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.authors       = ['Jan Jedrychowski', 'brogoz']
+  spec.email         = ['hello@infiniteloop.eu']
   spec.summary       = %q{Track and persist AASM state history}
-  spec.homepage      = 'https://github.com/gogiel/aasm_history'
+  spec.homepage      = 'https://github.com/infiniteloopeu/aasm_history'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0' # due to Module#prepend
 
-  spec.add_dependency 'aasm', '~> 3.3'
+  spec.add_dependency 'aasm', '~> 4.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rspec', '~> 3.1'

data/lib/aasm_history.rb

@@ -1,6 +1,12 @@
 require 'aasm'
 
 module AasmHistory
+  class << self
+    attr_accessor :enabled_by_default
+  end
+
+  self.enabled_by_default = false
+
   autoload :PersistanceDeterminator,  'aasm_history/persistance_determinator'
   autoload :UnknownPersistanceLayer,  'aasm_history/persistance_determinator'
 
@@ -17,4 +23,5 @@ end
 
 require 'aasm_history/version'
 require 'aasm_history/aasm_ext/base'
+require 'aasm_history/aasm_ext/configuration'
 require 'aasm_history/load_extensions'

data/lib/aasm_history/aasm_ext/base.rb

@@ -1,14 +1,34 @@
 module AASM
   class Base
-    def has_history
-      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
+    def has_history enabled = true
+      @options[:history_enabled] = enabled
+      if enabled
+        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
+
+    def history_enabled?
+      @options[:history_enabled]
+    end
+  end
+
+  module ClassMethods
+    def aasm(options={}, &block)
+      @aasm ||= AASM::Base.new(self, options)
+      if block
+        @aasm.instance_eval(&block)
+        if AasmHistory.enabled_by_default && @aasm.history_enabled? == nil
+          @aasm.has_history
+        end
+      end
+      @aasm
+    end
   end
 end

data/lib/aasm_history/aasm_ext/configuration.rb

@@ -0,0 +1,6 @@
+module AASM
+  class Configuration
+    attr_accessor :history_class
+    attr_accessor :creator_class
+  end
+end

data/lib/aasm_history/version.rb

@@ -1,3 +1,3 @@
 module AasmHistory
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/spec/aasm_history_spec.rb

@@ -14,6 +14,40 @@ describe 'determining persistance layer' do
   end
 end
 
+describe 'configuration' do
+  context 'default' do
+    it 'has enabled_by_default set to false by default' do
+      expect(AasmHistory.enabled_by_default).to eq false
+      aasm = DummyNotConfigured.aasm
+      allow(aasm).to receive(:has_history)
+      DummyNotConfigured.aasm {}
+      expect(aasm).not_to have_received(:has_history)
+    end
+  end
+
+  context 'enabled_by_default set to true' do
+    after do
+      AasmHistory.enabled_by_default = false # change back to default
+    end
+    it 'adds history to class with aasm' do
+      AasmHistory.enabled_by_default = true
+      aasm = DummyNotConfigured.aasm
+      allow(aasm).to receive(:has_history)
+      DummyNotConfigured.aasm {}
+      expect(aasm).to have_received(:has_history)
+    end
+
+    it 'can be disabled' do
+      AasmHistory.enabled_by_default = true
+      aasm = DummyNotConfigured.aasm
+      DummyNotConfigured.aasm {
+        has_history false
+      }
+      expect(aasm.history_enabled?).to eq false
+    end
+  end
+end
+
 describe 'saving history' do
   describe 'active record' do
     subject! do

data/spec/support/active_record/models.rb

@@ -19,3 +19,7 @@ end
 class StateHistory < ActiveRecord::Base
   belongs_to :stateable, polymorphic: true
 end
+
+class DummyNotConfigured < ActiveRecord::Base
+  include AASM
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aasm_history
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jan Jedrychowski
+- brogoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +103,7 @@ dependencies:
         version: 1.3.9
 description: 
 email:
-- jan@jedrychowski.org
+- hello@infiniteloop.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -116,6 +117,7 @@ files:
 - aasm_history.gemspec
 - lib/aasm_history.rb
 - lib/aasm_history/aasm_ext/base.rb
+- lib/aasm_history/aasm_ext/configuration.rb
 - lib/aasm_history/ext/active_record.rb
 - lib/aasm_history/load_extensions.rb
 - lib/aasm_history/persistance/active_record.rb
@@ -126,7 +128,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/active_record/models.rb
 - spec/support/active_record/schema.rb
-homepage: https://github.com/gogiel/aasm_history
+homepage: https://github.com/infiniteloopeu/aasm_history
 licenses:
 - MIT
 metadata: {}
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Track and persist AASM state history