workflow-activerecord 4.1.3 → 4.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71df1c88832b6becc3a4c594a60a0f42a474200bb74675d3f715c8b042c92a3
-  data.tar.gz: e192a5ce46f271798c928c3c6202e06516f96a754d960631fc4fff5662d3e03b
+  metadata.gz: 5974a889346ecc0b4d47a333a9ce5c2cf9a71073f59dcd2ae7698b38a8e6e1e2
+  data.tar.gz: 669f86b67930aa0b140dbf201fb5049d2b3bbe662b4dbb517c50042ae43b8999
 SHA512:
-  metadata.gz: 6c1bbe329aa90e5d03c1b82f6664aff19f1dd4e1a44527ff07876155bca04ae8593d5656b99fea77ffd123f157e6de63d880f4bcb5e3d21eb61e411917d2e37a
-  data.tar.gz: b406b370be0b87830a5e9d5e106f16032e1d03889ec0a3af9b637073768d122a6dbdf77e11b76cb221b74a775f3d3dcd57b0c9a6a726a4976e5d8464ca49e07d
+  metadata.gz: 5086caf826c24e788f704738e3bcb297c9edd903638fe4d0bc6a7307bb0ef63731ee5bcad5d6e9a38493c21e988da985fa215b6411a0617efaa61c897c2cff9c
+  data.tar.gz: b5b1e5f5f6e446b430fd995fcd5e759e894da22b600af1d0e33e1ae067b8efe803e4120aa46a0dbf8d90d5236634c42b5998d186ea0ab2ef5c4e5a0fdaecab67

data/README.md

@@ -1,13 +1,7 @@
-[![Version
-](https://img.shields.io/gem/v/workflow-activerecord.svg?maxAge=2592000)](https://rubygems.org/gems/workflow-activerecord)
-[![Build Status
-](https://travis-ci.org/geekq/workflow-activerecord.svg)](https://travis-ci.org/geekq/workflow-activerecord)
-<!-- TODO find out how to add this repository without giving cloudclimate write access to the repo
-[![Code Climate
-](https://codeclimate.com/github/geekq/workflow-activerecord/badges/gpa.svg)](https://codeclimate.com/github/geekq/workflow-activerecord)
-[![Test
-Coverage](https://codeclimate.com/github/geekq/workflow-activerecord/badges/coverage.svg)](https://codeclimate.com/github/geekq/workflow-activerecord/coverage)
--->
+[![Version](https://img.shields.io/gem/v/workflow-activerecord.svg)](https://rubygems.org/gems/workflow-activerecord)
+[![Build Status](https://travis-ci.org/geekq/workflow-activerecord.svg)](https://travis-ci.org/geekq/workflow-activerecord)
+[![Code Climate](https://codeclimate.com/github/geekq/workflow-activerecord/badges/gpa.svg)](https://codeclimate.com/github/geekq/workflow-activerecord)
+[![Test Coverage](https://codeclimate.com/github/geekq/workflow-activerecord/badges/coverage.svg)](https://codeclimate.com/github/geekq/workflow-activerecord/coverage)
 
 # workflow-activerecord
 
@@ -15,15 +9,15 @@ Coverage](https://codeclimate.com/github/geekq/workflow-activerecord/badges/cove
 
 Major+minor versions of workflow-activerecord are based on the oldest
 compatible ActiveRecord API. To use [`workflow`][workflow] with
-Rails/ActiveRecord 4.1, 4.2, 5.0, 5.1, 5.2 please use:
+Rails/ActiveRecord 4.1, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1 please use:
 
-    gem 'workflow-activerecord', '>= 4.1', '< 6.0'
+    gem 'workflow-activerecord', '~> 4.1'
 
 This will also automatically include the newest compatible version of
 the core 'workflow' gem. But you can also choose a specific version:
 
     gem 'workflow', '~> 2.0'
-    gem 'workflow-activerecord', '>= 4.1pre', '< 6.0'
+    gem 'workflow-activerecord', '~> 4.1'
 
 Please also have a look at [the sample application][]!
 
@@ -180,14 +174,38 @@ You can also encapsulate this in a class method or even put in some
 ActiveRecord callback. Please also have a look at [the full working
 example][multiple_workflow_test]!
 
+### on_transition
+
+You can have a look at an advanced [`on_transition`][] example in
+[this test file][advanced_hooks_and_validation_test].
+
 [STI]: http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
 [ActiveRecord]: http://api.rubyonrails.org/classes/ActiveRecord/Base.html
 [multiple_workflow_test]: https://github.com/geekq/workflow-activerecord/blob/develop/test/multiple_workflows_test.rb
-
+[`on_transition`]: https://github.com/geekq/workflow#on_transition
+[advanced_hooks_and_validation_test]: http://github.com/geekq/workflow-activerecord/blob/develop/test/advanced_hooks_and_validation_test.rb
 
 Changelog
 ---------
 
+### New in the version 4.1.8
+
+* gh-11 Rails 6.1 support
+
+### New in the version 4.1.7
+
+* gh-9 refactor the implementation to a single file, deprecate `require
+  'workflow_activerecord'` (with the underscore)
+
+### New in the version 4.1.6
+
+* gh-3, gh-5 allow automatic require of workflow-activerecord - no need for explicit `require` anymore
+
+### New in the version 4.1.5
+
+* gh-2 Show code coverage on codeclimate
+* gh-7 Improve require for base `workflow`
+
 ### New in the version 4.1.3
 
 * retire Ruby 2.3 and Rails 4.1 since this Ruby version has reached end of life

data/lib/workflow-activerecord.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'workflow'
+require 'workflow/specification'
+
+module WorkflowActiverecord
+  def self.included(klass)
+    klass.send :include, ::Workflow
+    klass.send :include, InstanceMethods
+    klass.send :extend, Scopes
+    klass.before_validation :write_initial_state
+  end
+
+  module InstanceMethods
+    def load_workflow_state
+      read_attribute(self.class.workflow_column)
+    end
+
+    # On transition the new workflow state is immediately saved in the
+    # database.
+    def persist_workflow_state(new_value)
+      # Rails 3.1 or newer
+      update_column self.class.workflow_column, new_value
+    end
+
+    private
+
+    # Motivation: even if NULL is stored in the workflow_state database column,
+    # the current_state is correctly recognized in the Ruby code. The problem
+    # arises when you want to SELECT records filtering by the value of initial
+    # state. That's why it is important to save the string with the name of the
+    # initial state in all the new records.
+    def write_initial_state
+      write_attribute self.class.workflow_column, current_state.to_s
+    end
+  end
+
+  # This module will automatically generate ActiveRecord scopes based on workflow states.
+  # The name of each generated scope will be something like `with_<state_name>_state`
+  #
+  # Examples:
+  #
+  # Article.with_pending_state # => ActiveRecord::Relation
+  # Payment.without_refunded_state # => ActiveRecord::Relation
+  #`
+  # Example above just adds `where(:state_column_name => 'pending')` or
+  # `where.not(:state_column_name => 'pending')` to AR query and returns
+  # ActiveRecord::Relation.
+  module Scopes
+    def self.extended(object)
+      class << object
+        alias_method :workflow_without_scopes, :workflow unless method_defined?(:workflow_without_scopes)
+        alias_method :workflow, :workflow_with_scopes
+      end
+    end
+
+    def workflow_with_scopes(&specification)
+      workflow_without_scopes(&specification)
+      states = workflow_spec.states.values
+
+      states.each do |state|
+        define_singleton_method("with_#{state}_state") do
+          where("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
+        end
+
+        define_singleton_method("without_#{state}_state") do
+          where.not("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
+        end
+      end
+    end
+
+  end
+end

data/lib/{workflow_activerecord → workflow-activerecord}/version.rb

@@ -1,3 +1,3 @@
 module WorkflowActiverecord
-  VERSION = "4.1.3"
+  VERSION = "4.1.8"
 end

data/lib/workflow_activerecord.rb

@@ -1,11 +1,11 @@
-require 'rubygems'
+warn <<HERE
 
-require 'workflow/specification'
-require 'workflow_activerecord/adapters/active_record'
+DEPRECATED: `require 'workflow_activerecord'` is obsolete. Usually you can just
+remove the require line. In Rails, adding gem to Gemfile should be enough.
+`bundle.require` will take care. If you need to require explicitely, use
+workflow-activerecord (with dash) instead. The module with underscore will be
+deleted on 4.2 release."
 
-module WorkflowActiverecord
-  def self.included(klass)
-    klass.send :include, ::Workflow
-    klass.send :include, Adapter::ActiveRecord
-  end
-end
+HERE
+
+require_relative 'workflow-activerecord'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workflow-activerecord
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.8
 platform: ruby
 authors:
 - Vladimir Dobriakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2021-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workflow
@@ -33,7 +33,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -128,9 +128,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: "ActiveRecord/Rails Integration for the Workflow library. \nWorkflow
-  is a finite-state-machine-inspired API for modeling and interacting\n    with what
-  we tend to refer to as 'workflow'."
+description: |
+  ActiveRecord/Rails Integration for the Workflow library.
+  Workflow is a finite-state-machine-inspired API for modeling and interacting
+  with what we tend to refer to as 'workflow'.
 email:
 - vladimir@geekq.net
 executables: []
@@ -140,10 +141,10 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
+- lib/workflow-activerecord.rb
+- lib/workflow-activerecord/version.rb
 - lib/workflow_activerecord.rb
-- lib/workflow_activerecord/adapters/active_record.rb
-- lib/workflow_activerecord/version.rb
-homepage: http://www.geekq.net/workflow/
+homepage: https://github.com/geekq/workflow-activerecord
 licenses:
 - MIT
 metadata: {}
@@ -162,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ActiveRecord/Rails Integration for the Workflow library.

data/lib/workflow_activerecord/adapters/active_record.rb

@@ -1,71 +0,0 @@
-module WorkflowActiverecord
-  module Adapter
-    module ActiveRecord
-      def self.included(klass)
-        klass.send :include, Adapter::ActiveRecord::InstanceMethods
-        klass.send :extend, Adapter::ActiveRecord::Scopes
-        klass.before_validation :write_initial_state
-      end
-
-      module InstanceMethods
-        def load_workflow_state
-          read_attribute(self.class.workflow_column)
-        end
-
-        # On transition the new workflow state is immediately saved in the
-        # database.
-        def persist_workflow_state(new_value)
-          # Rails 3.1 or newer
-          update_column self.class.workflow_column, new_value
-        end
-
-        private
-
-        # Motivation: even if NULL is stored in the workflow_state database column,
-        # the current_state is correctly recognized in the Ruby code. The problem
-        # arises when you want to SELECT records filtering by the value of initial
-        # state. That's why it is important to save the string with the name of the
-        # initial state in all the new records.
-        def write_initial_state
-          write_attribute self.class.workflow_column, current_state.to_s
-        end
-      end
-
-      # This module will automatically generate ActiveRecord scopes based on workflow states.
-      # The name of each generated scope will be something like `with_<state_name>_state`
-      #
-      # Examples:
-      #
-      # Article.with_pending_state # => ActiveRecord::Relation
-      # Payment.without_refunded_state # => ActiveRecord::Relation
-      #`
-      # Example above just adds `where(:state_column_name => 'pending')` or
-      # `where.not(:state_column_name => 'pending')` to AR query and returns
-      # ActiveRecord::Relation.
-      module Scopes
-        def self.extended(object)
-          class << object
-            alias_method :workflow_without_scopes, :workflow unless method_defined?(:workflow_without_scopes)
-            alias_method :workflow, :workflow_with_scopes
-          end
-        end
-
-        def workflow_with_scopes(&specification)
-          workflow_without_scopes(&specification)
-          states = workflow_spec.states.values
-
-          states.each do |state|
-            define_singleton_method("with_#{state}_state") do
-              where("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
-            end
-
-            define_singleton_method("without_#{state}_state") do
-              where.not("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
-            end
-          end
-        end
-
-      end
-    end
-  end
-end