validating-workflow 0.7.7 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01c79cb96bb6f3ae9887854cf9f4e8be7a5cf834
-  data.tar.gz: 5012d899c8754622b4d009b0fd9aa179fa5c5a2a
+  metadata.gz: d130757849316ba07bb518d99578f4184f59dbb3
+  data.tar.gz: 8b8fae7c226937dd0a5029ea9ae53cd05dd7688c
 SHA512:
-  metadata.gz: bc7c0ca5b4b9aee56f8ea791c4b89443fedf9d17f746c42c8a6308a52e50bbbc162f3e2c1bcacfd8923d121c823a15cd3c94c8a050265b692029dfa2976dfd84
-  data.tar.gz: ab4a4a86a5d65a0f359470f89d0a659173348e7594b990a556f338b0ceba72a8c7e1f50736b3bc367b2ec24a6b4e1204a561dff78e1d6b48e19e36d45f4743f3
+  metadata.gz: d2df156fe39c4a35538e4ee5d9d2ba42684f808357257e16b3c814f781ac24b69f46696f3ae56ad4066c49020b9d41202b7cc4f1bab74a3cfa35d55b1e3af08b
+  data.tar.gz: bfcfbc6ba0c6c45e8db8119180f21dcdeeeddcfb22a74d1b85e97fb70e859977bbbae10172dd076ebb0d427a5e3e229388caeef06bdfb5a6ca7889c89da6902d

data/Rakefile

@@ -16,29 +16,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.options << "-S"
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = 'workflow'
-    gemspec.rubyforge_project = 'workflow'
-    gemspec.email = 'vladimir@geekq.net'
-    gemspec.homepage = 'http://www.geekq.net/workflow/'
-    gemspec.authors = ['Vladimir Dobriakov', 'Willem van Kerkhof']
-    gemspec.summary = 'A replacement for acts_as_state_machine.'
-    gemspec.description = <<-EOS
-    Workflow is a finite-state-machine-inspired API for modeling and interacting
-    with what we tend to refer to as 'workflow'.
-
-    * nice DSL to describe your states, events and transitions
-    * robust integration with ActiveRecord and non relational data stores
-    * various hooks for single transitions, entering state etc.
-    * convenient access to the workflow specification: list states, possible events
-      for particular state
-    EOS
-
-    Jeweler::GemcutterTasks.new
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-

data/VERSION

@@ -1 +1 @@
-0.7.6
+0.7.9

data/lib/workflow/active_model_persistence.rb

@@ -0,0 +1,34 @@
+module Workflow
+  module ActiveModelPersistence
+
+    def self.happy_to_be_included_in?(klass)
+      Object.const_defined?(:ActiveRecord) and klass.is_a? ActiveRecord::Base
+    end
+
+    def self.included(klass)
+      klass.before_validation :write_initial_state
+    end
+
+    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)
+      update_attribute 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
+end
+

data/lib/workflow/mongoid_persistence.rb

@@ -0,0 +1,35 @@
+module Workflow
+  module MongoidPersistence
+
+    def self.happy_to_be_included_in?(klass)
+      Object.const_defined?(:Mongoid) and klass.include? Mongoid::Document
+    end
+
+    def self.included(klass)
+      klass.after_initialize :write_initial_state
+    end
+
+    def load_workflow_state
+      read_attribute(self.class.workflow_column)
+    end
+
+    # implementation of abstract method: saves new workflow state to DB
+    def persist_workflow_state(new_value)
+      self.write_attribute(self.class.workflow_column, new_value.to_s)
+      self.save!
+    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
+end
+

data/lib/workflow/remodel_persistence.rb

@@ -0,0 +1,17 @@
+module Workflow
+  module RemodelPersistence
+
+    def self.happy_to_be_included_in?(klass)
+      Object.const_defined?(:Remodel) and klass < Remodel::Entity
+    end
+
+    def load_workflow_state
+      send(self.class.workflow_column)
+    end
+
+    def persist_workflow_state(new_value)
+      update(self.class.workflow_column => new_value)
+    end
+  end
+end
+

data/lib/workflow/transactional.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+# Provides transaction rollback on halt. For now, you can choose between
+# normal halt without any change to ordinary persistence (halt) or halt
+# with transaction rollback (halt_with_rollback!), which will raise an
+# ActiveRecord::Rollback exception.
+# So this only works with ActiveRecord atm.
+
+module Workflow
+  module Transactional
+    def new_transaction
+      self.class.transaction(:requires_new => true) do
+        yield
+      end
+    end
+
+    def halt_with_rollback!(reason = nil)
+      halt reason
+      raise ActiveRecord::Rollback
+    end
+
+    def process_event!(*args)
+      return_value = :unprocessed
+      self.new_transaction do
+        return_value = super(*args)
+#         raise ActiveRecord::Rollback if self.halted?
+      end
+      return return_value == :unprocessed ? false : return_value
+    end
+
+  end # module Transactional
+end # module Workflow

data/lib/workflow.rb

@@ -2,10 +2,11 @@ require 'rubygems'
 
 # See also README.markdown for documentation
 module Workflow
-  autoload :ActiveModelPersistence, 'workflow/active_model_persistence'
-  autoload :MongoidPersistence,     'workflow/mongoid_persistence'
-  autoload :RemodelPersistence,     'workflow/remodel_persistence'
-  autoload :Transactional,          'workflow/transactional'
+  autoload :ActiveModelPersistence,    'workflow/active_model_persistence'
+  autoload :MongoidPersistence,        'workflow/mongoid_persistence'
+  autoload :RemodelPersistence,        'workflow/remodel_persistence'
+  autoload :Transactional,             'workflow/transactional'
+  autoload :StateDependentValidations, 'workflow/state_dependent_validations'
 
   class Specification
 
@@ -21,6 +22,10 @@ module Workflow
       states.keys
     end
 
+    def event_names
+      states.values.map{|e|  e.events.keys }.uniq
+    end
+
     private
 
     def state(name, meta = {:meta => {}}, &events_and_etc)

data/validating-workflow.rb

@@ -0,0 +1 @@
+require 'workflow'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validating-workflow
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.9
 platform: ruby
 authors:
 - Vladimir Dobriakov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies: []
 description: |
   Validating-Workflow is a finite-state-machine-inspired API for modeling and interacting
@@ -27,41 +27,47 @@ extensions: []
 extra_rdoc_files:
 - README.markdown
 files:
-- .gitignore
+- ".gitignore"
 - MIT-LICENSE
 - README.markdown
 - Rakefile
 - VERSION
 - lib/workflow.rb
+- lib/workflow/active_model_persistence.rb
+- lib/workflow/mongoid_persistence.rb
+- lib/workflow/remodel_persistence.rb
+- lib/workflow/state_dependent_validations.rb
+- lib/workflow/transactional.rb
 - test/couchtiny_example.rb
 - test/main_test.rb
 - test/multiple_workflows_test.rb
 - test/readme_example.rb
 - test/test_helper.rb
 - test/without_active_record_test.rb
+- validating-workflow.rb
 - workflow.rb
-- lib/workflow/state_dependent_validations.rb
 homepage: http://www.geekq.net/workflow/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 3
 summary: A replacement for acts_as_state_machine, an enhancement of workflow.
@@ -72,4 +78,3 @@ test_files:
 - test/without_active_record_test.rb
 - test/multiple_workflows_test.rb
 - test/readme_example.rb
-has_rdoc: