workflow-activerecord 4.1.6 → 4.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc0778e2f9db691ae5cc166939ac6f989cde65a6c29cc530f4c9347ca0f9e2ec
-  data.tar.gz: 30346dc259a8159dd8ee5930e4f711683ea7244afa82ab7f094f16f2931a3b1d
+  metadata.gz: 410db62b32e62adf3377dcecdbf9d6c42dda109a1fbb63a0cabc379ba8291bc1
+  data.tar.gz: ad1b249687e8b7f082a213b19e229eee2bd7e6530e4696aa8f253029d68e273a
 SHA512:
-  metadata.gz: ac3d0dd3d4a17491e392ba1deb7935a3dad8130af5ce3814eee6be8c611732c788a957016fe6fe7a60c38e3cc0e0216e026f7cb5c36e5ed54c854ba1b864ab7d
-  data.tar.gz: 903ed98a7b0a344021a4a71bfb5cb3c5150edb2ae39ea9f991402f822b6a82f554eec44f7eefee96e07697ed9e9568cf7f3bcb33f564674bd14c8d99739e8629
+  metadata.gz: 836f6c60d6db535c399567ec63c4193bf5bb57c7e366d64489d4fb3c3d51de369e8803131a7eb78f5ef14b48a996893c200a8e8d0aaf42e781d9eb05b75d4f01
+  data.tar.gz: b3680f266639313d3c2ffa8861730cf2f975ee022b1c6a385593270a4029c0eafdf9d689e614620881075f96a5045e6f13b28c0b3abacd978e9c76a009ee3cca

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)
+[![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)
 
@@ -190,6 +188,11 @@ You can have a look at an advanced [`on_transition`][] example in
 Changelog
 ---------
 
+### 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

data/lib/workflow-activerecord.rb

@@ -1 +1,72 @@
-require_relative 'workflow_activerecord'
+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.6"
+  VERSION = "4.1.7"
 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.6
+  version: 4.1.7
 platform: ruby
 authors:
 - Vladimir Dobriakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workflow
@@ -142,9 +142,8 @@ 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

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