workflow-activerecord 4.1.5 → 4.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a4bccdfa2fe6eb48d3739e46b3c14f963aa9ecf60a1545e4458a53e4e7c0843
-  data.tar.gz: 48b16a9667b22e093e1072229be4c7f22f5e35655e89b47ded3bdb2b160a6f28
+  metadata.gz: fc4264f2db70995956591e3b1f241332df5e7f0717d7829a091138c149269755
+  data.tar.gz: f6847f4bb4039ce931fdd38efccb4b18241af15a8c45ffdbff377edb781d6fb1
 SHA512:
-  metadata.gz: f51e23b756c42bf88c2c20bb5a762713d865e3dfa85fc140dd39971917cb0cf7d052bf37c3f6cd9074518c39ffeff7f0ee238402b91d418caa63d2e357b15c4e
-  data.tar.gz: af0cb7a874652ccea06c0375a0ad3321efc10169008dd6e346373c63844ab8c34e36946044433b1cd6928502b3ca47adb8cb83d56cccd4e4166b91778fb357d1
+  metadata.gz: b0a7089c9de2dcaf624d914c6e37748e11bb0367f0398d3173d557420c3e329493e61f28c65332230c5fd5ebb0433079aedb51507ac4e2cc827215ab35e25513
+  data.tar.gz: 80c0c8fa5b22d407c45837ad603fb9d7adde4ae70070fee745367636502615f5b15e026c7ddd7bab3239b6d9fb6a02cbf1d485ba3beb5a5f74e1dd4b2a2950f4

data/README.md

@@ -1,7 +1,5 @@
-[![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)
+[![Version](https://img.shields.io/gem/v/workflow-activerecord.svg)](https://rubygems.org/gems/workflow-activerecord)
+[![Test](https://github.com/geekq/workflow-activerecord/actions/workflows/test.yml/badge.svg)](https://github.com/geekq/workflow-activerecord/actions/workflows/test.yml)
 [![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)
 
@@ -11,15 +9,15 @@
 
 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][]!
 
@@ -190,6 +188,24 @@ You can have a look at an advanced [`on_transition`][] example in
 Changelog
 ---------
 
+### New in the version 4.1.9
+
+* gh-13 Switch CI (continuous integration) from travis-CI to GitHub
+* Tested Rails 7.0 support
+
+### 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

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

@@ -1,3 +1,3 @@
 module WorkflowActiverecord
-  VERSION = "4.1.5"
+  VERSION = "4.1.9"
 end

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.rb

@@ -1,11 +1,11 @@
-require 'rubygems'
-require 'workflow'
-require 'workflow/specification'
-require 'workflow_activerecord/adapters/active_record'
+warn <<HERE
 
-module WorkflowActiverecord
-  def self.included(klass)
-    klass.send :include, ::Workflow
-    klass.send :include, Adapter::ActiveRecord
-  end
-end
+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."
+
+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.5
+  version: 4.1.9
 platform: ruby
 authors:
 - Vladimir Dobriakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workflow
@@ -31,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -141,9 +135,9 @@ 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: https://github.com/geekq/workflow-activerecord
 licenses:
 - MIT
@@ -163,8 +157,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