statesman-sequel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b05a7034b18e128887bc0f807e5cf35490b491d2
+  data.tar.gz: d7c34b49ec10e3ea435702b56e517f1ddc3bc3a0
+SHA512:
+  metadata.gz: 5f5b63f2d1686d0cdd2a6f8d346517fd6b2e17462dffba52f356ddf340ce62a2d52c682fba6982468fbcd5bc6b5bdde0ae43e72c713ad986824a28a64c40cc26
+  data.tar.gz: 5a6d02d9c16586da30e18cbae83af7ca373cfca99da847094564493d742b3b8cb634fa41a0e74f11738f872f08731d9b97fcb4ba3e99f7a0ac97daa1aeaa9bc2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    statesman-sequel (0.1.0)
+      sequel (~> 4.0)
+      statesman (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    minitest-hooks (1.4.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-readline (0.5.3)
+    sequel (4.41.0)
+    slop (3.6.0)
+    sqlite3 (1.3.12)
+    statesman (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  minitest (~> 5.0)
+  minitest-hooks
+  pry
+  rake (~> 10.0)
+  rb-readline
+  sqlite3 (~> 1.3)
+  statesman-sequel!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Amadeus Folego
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# Sequel Statesman
+
+Ships Sequel adapter and a Sequel plugin for Statesman
+
+## Regular Configuration
+
+Similar to the ActiveRecord configuration but with the changes required for
+Sequel:
+
+```ruby
+require 'sequel-statesman'
+
+Statesman.configure do
+  storage_adapter(Statesman::Adapters::Sequel)
+end
+
+class UserStateMachine
+  include Statesman::Machine
+
+  state :invited, initial: true
+  state :registered
+
+  transition from: :invited, to: :registered
+end
+
+class UserTransition < Sequel::Model
+  include Statesman::Adapters::SequelTransition
+
+  many_to_one :user
+end
+
+class User < Sequel::Model
+  include Statesman::Adapters::SequelQueries
+
+  one_to_many :user_transitions
+
+  def state_machine
+    @state_machine ||= UserStateMachine.new(self, transition_class: UserTransition)
+  end
+
+  def self.transition_class
+    UserTransition
+  end
+  private_class_method :transition_class
+
+  def self.initial_state
+    :invited
+  end
+  private_class_method :initial_state
+end
+```
+
+Create your transitions table:
+
+```ruby
+Sequel.migration do
+  up do
+    create_table(:user_transitions) do
+      primary_key :id
+
+      String :to_state, null: false, size: 255
+      String :metadata, default: "{}"
+      Integer :sort_key, null: false
+      TrueClass :most_recent, null: false
+      # Remove last argument above if your database does not support
+      # partial indexes
+
+      foreign_key :user_id, :users, null: false
+
+      index %i[user_id sort_key], unique: true
+      index %i[user_id most_recent], unique: true, where: 'most_recent'
+      # Remove last argument above if your database does not support
+      # partial indexes
+    end
+  end
+
+  down do
+    drop_table(:user_transitions)
+  end
+end
+```
+
+## JSON Column
+
+If you want to use your database support for json on the `metadata` column,
+just don't include `SequelTransition` on your transition model and also
+perform the adjusts on the migration
+
+## Sequel Plugin
+
+You will perform the same configuration above, except for the model:
+
+```ruby
+class User < Sequel::Model
+  plugin :statesman
+end
+```
+
+The following methods will be delegated to the state machine:
+
+- `#current_state`
+- `#state_history`
+- `#last_transition`
+
+The following methods will be defined on your model:
+
+- `.initial_state`
+- `#state_machine`
+- `#state_name?` method for each state on your state machine
+- `#state_name!(metadata={})` method for each state on your state machine.
+- `#transition_metadata` last metadata available
+- `#merge_transition_metadata(metadata)` update last metadata available
+- `#refresh` overriden to also reload your states
+
+### Configuration
+
+You may perform individual model configuration when the plugin is included:
+
+```ruby
+plugin :statesman, transition_class: UserEvent,
+                   state_machine_class: UserMachine
+```
+
+Or globally:
+
+```ruby
+require 'sequel/plugins/statesman'
+Sequel::Plugins::Statesman.configure!({
+  transition_class: ->(model) { "#{model.name}Event".constantize }
+  state_machine_class: ->(model) { "#{model.name}Machine".constantize }
+})
+```
+
+The defaults are:
+
+```ruby
+{
+  # Define #state! and #state? methods
+  define_state_methods: true,
+  # Transitions are automatically destroyed when the parent instance is destroyed
+  destroy_transitions: true,
+  # Include SequelQueries automatically
+  include_queries: true,
+  # The transition class for the model
+  transition_class: ->(model) { "#{model.name}Transition".constantize },
+  # The state machine for the model
+  state_machine_class: ->(model) { "#{model.name}StateMachine".constantize }
+}
+```
+
+### Sequel Timestamps
+
+If your transition classes use the timestamps plugin you may include
+the `statesman_timestamps` plugin to add the following `DatasetMethods`:
+
+- `.state_changed_after(date)` to filter records after the last transition
+- `.state_changed_before(date)` to filter records before the last transition
+
+You may configure the columns to be used, (default `created_at`):
+
+```ruby
+plugin :statesman_timestamps, created: :creation_date
+
+# or globally
+require 'sequel/plugins/statesman_timestamps'
+Sequel::Plugins::StatesmanTimestamps.configure! created: :creation_date
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/badosu/statesman-sequel
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task default: :spec

data/lib/sequel/plugins/statesman.rb

@@ -0,0 +1,108 @@
+require 'statesman-sequel'
+
+module Sequel
+  module Plugins
+    module Statesman
+      OPTS = {}.freeze
+
+      DEFAULTS = {
+        define_state_methods: true,
+        destroy_transitions: true,
+        include_queries: true,
+        transition_class: ->(model) { "#{model.name}Transition".constantize },
+        state_machine_class: ->(model) { "#{model.name}StateMachine".constantize }
+      }
+
+      def self.configure!(opts=OPTS)
+        DEFAULTS.merge!(opts)
+      end
+
+      def self.configure(model, opts=OPTS)
+        opts = DEFAULTS.merge(opts)
+
+        model.instance_eval do
+          if opts[:state_machine_class].respond_to? :to_proc
+            @state_machine_class = opts[:state_machine_class].call(self)
+          else
+            @state_machine_class = opts[:state_machine_class]
+          end
+
+          if opts[:transition_class].respond_to? :to_proc
+            @transition_class = opts[:transition_class].call(self)
+          else
+            @transition_class = opts[:transition_class]
+          end
+
+          if opts[:define_state_methods]
+            @state_machine_class.states.each do |state|
+              define_method(:"#{state}!") do |metadata = {}|
+                state_machine.transition_to!(state, metadata)
+              end
+
+              define_method(:"#{state}?") do
+                current_state == state
+              end
+            end
+          end
+
+          if opts[:include_queries]
+            include ::Statesman::Adapters::SequelQueries
+          end
+
+          if opts[:destroy_transitions]
+            plugin :association_dependencies
+            add_association_dependencies transition_name => :destroy
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_reader :transition_class
+        attr_reader :state_machine_class
+
+        def initial_state
+          state_machine_class.initial_state
+        end
+      end
+
+      module InstanceMethods
+        def transition_metadata
+          transition = last_transition(force_reload: true)
+
+          transition && transition.metadata
+        end
+
+        def merge_transition_metadata!(value)
+          metadata = transition_metadata
+
+          last_transition.update(metadata: metadata.merge(value))
+        end
+
+        def refresh
+          state_machine.last_transition(force_reload: true)
+
+          super
+        end
+
+        def current_state(*args)
+          state_machine.current_state(*args)
+        end
+
+        def last_transition(*args)
+          state_machine.last_transition(*args)
+        end
+
+        def state_history(*args)
+          state_machine.history(*args)
+        end
+
+        def state_machine
+          @state_machine ||= model.state_machine_class.new(
+            self,
+            transition_class: model.transition_class
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/statesman_timestamps.rb

@@ -0,0 +1,35 @@
+module Sequel
+  module Plugins
+    module StatesmanTimestamps
+      OPTS = {}.freeze
+
+      DEFAULTS = {
+        create: :created_at
+      }
+
+      def self.configure!(opts=OPTS)
+        DEFAULTS.merge!(opts)
+      end
+
+      def self.configure(model, opts=OPTS)
+        opts = DEFAULTS.merge(opts)
+
+        model.instance_eval do
+          @statesman_timestamp_options = opts
+        end
+      end
+
+      module DatasetMethods
+        def state_changed_after(date)
+          where(%["#{model.most_recent_transition_association_name
+                  }"."#{@statesman_timestamp_options[:create]}" > ?], date)
+        end
+
+        def state_changed_before(date)
+          where(%["#{model.most_recent_transition_association_name
+                  }"."#{@statesman_timestamp_options[:create]}" < ?], date)
+        end
+      end
+    end
+  end
+end

data/lib/statesman/adapters/sequel.rb

@@ -0,0 +1,84 @@
+module Statesman
+  module Adapters
+    class Sequel
+      attr_reader :transition_class, :parent_model, :observer
+
+      def initialize(transition_class, parent_model, observer, options={})
+        @transition_class = transition_class
+        @parent_model = parent_model
+        @observer = observer
+      end
+
+      def create(from, to, metadata = {})
+        create_transition(from.to_s, to.to_s, metadata)
+      ensure
+        @last_transition = nil
+      end
+
+      def history
+        history_dataset.all
+      end
+
+      def last(force_reload: false)
+        @last_transition = nil if force_reload
+        @last_transition ||= history_dataset.last
+      end
+
+      private
+
+      def history_dataset
+        transitions_for_parent.order(:sort_key)
+      end
+
+      def transitions_for_parent
+        @parent_model.send("#{transition_table_name}_dataset")
+      end
+
+      def next_sort_key
+        (last && last.sort_key + 10) || 10
+      end
+
+      def create_transition(from, to, metadata)
+        transition = transition_class.new(
+          to_state: to,
+          sort_key: next_sort_key,
+          metadata: metadata,
+          most_recent: true,
+          parent_model_foreign_key => @parent_model.pk
+        )
+
+        parent_model_class.db.transaction do
+          @observer.execute(:before, from, to, transition)
+          unset_old_most_recent
+          transition.save
+          @last_transition = transition
+          @observer.execute(:after, from, to, transition)
+        end
+
+        @observer.execute(:after_commit, from, to, transition)
+
+        transition
+      end
+
+      def transition_table_name
+        @transition_table_name ||= @transition_class.table_name
+      end
+
+      def parent_model_class
+        @parent_model_class ||= @parent_model.class
+      end
+
+      def parent_association_name
+        parent_model_class.table_name.to_s.singularize.to_sym
+      end
+
+      def parent_model_foreign_key
+        @transition_class.association_reflection(parent_association_name)[:key]
+      end
+
+      def unset_old_most_recent
+        transitions_for_parent.update(most_recent: false)
+      end
+    end
+  end
+end

data/lib/statesman/adapters/sequel_queries.rb

@@ -0,0 +1,57 @@
+module Statesman
+  module Adapters
+    module SequelQueries
+      def self.included(base)
+        base.instance_eval do
+          extend(ClassMethods)
+
+          one_to_many(transition_name)
+
+          one_to_one(most_recent_transition_association_name,
+                     class: transition_class,
+                     conditions: { most_recent: true })
+
+          dataset_module(DatasetMethods)
+        end
+      end
+
+      def self.states_where(model, states)
+        if states.include? model.initial_state.to_s
+          "#{model.most_recent_transition_association_name}.to_state IN ? OR #{
+             model.most_recent_transition_association_name}.to_state IS NULL"
+        else
+          "#{model.most_recent_transition_association_name}.to_state IN ? AND #{
+             model.most_recent_transition_association_name}.to_state IS NOT NULL"
+        end
+      end
+
+      module DatasetMethods
+        def in_state(*states)
+          association_left_join(model.most_recent_transition_association_name).
+          where(SequelQueries.states_where(model, states.map!(&:to_s)), states)
+        end
+
+        def not_in_state(*states)
+          association_left_join(model.most_recent_transition_association_name).
+          exclude(SequelQueries.states_where(model, states.map!(&:to_s)), states)
+        end
+
+        def order_by_activity
+          most_recent_transition = model.most_recent_transition_association_name
+          association_left_join(model.most_recent_transition_association_name).
+            order(::Sequel.desc("#{most_recent_transition}__updated_at".to_sym))
+        end
+      end
+
+      module ClassMethods
+        def transition_name
+          @transition_name ||= transition_class.name.underscore.pluralize.to_sym
+        end
+
+        def most_recent_transition_association_name
+          @most_recent_transition_association_name ||= :"most_recent_#{transition_name.to_s.singularize}"
+        end
+      end
+    end
+  end
+end

data/lib/statesman/adapters/sequel_transition.rb

@@ -0,0 +1,13 @@
+module Statesman
+  module Adapters
+    module SequelTransition
+      def self.included(base)
+        base.instance_eval do
+          plugin :serialization
+
+          serialize_attributes :json, :metadata
+        end
+      end
+    end
+  end
+end

data/lib/statesman-sequel/version.rb

@@ -0,0 +1,3 @@
+module StatesmanSequel
+  VERSION = "0.1.0"
+end

data/lib/statesman-sequel.rb

@@ -0,0 +1,13 @@
+require 'sequel'
+require 'statesman'
+require 'statesman-sequel/version'
+
+module Statesman
+  module Adapters
+    autoload :Sequel,           'statesman/adapters/sequel'
+    autoload :SequelQueries,    'statesman/adapters/sequel_queries'
+    autoload :SequelTransition, 'statesman/adapters/sequel_transition'
+  end
+end
+
+Sequel.extension :inflector

data/statesman-sequel.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'statesman-sequel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "statesman-sequel"
+  spec.version       = StatesmanSequel::VERSION
+  spec.authors       = ["Amadeus Folego"]
+  spec.email         = ["amadeusfolego@gmail.com"]
+
+  spec.summary       = %q{Statesman adapter and plugin for Sequel}
+  spec.description   = %q{Statesman adapter and plugin for Sequel}
+  spec.homepage      = "https://github.com/badosu/statesman-sequel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sequel", "~> 4.0"
+  spec.add_dependency "statesman", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "minitest-hooks"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: statesman-sequel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amadeus Folego
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: statesman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Statesman adapter and plugin for Sequel
+email:
+- amadeusfolego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel/plugins/statesman.rb
+- lib/sequel/plugins/statesman_timestamps.rb
+- lib/statesman-sequel.rb
+- lib/statesman-sequel/version.rb
+- lib/statesman/adapters/sequel.rb
+- lib/statesman/adapters/sequel_queries.rb
+- lib/statesman/adapters/sequel_transition.rb
+- statesman-sequel.gemspec
+homepage: https://github.com/badosu/statesman-sequel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Statesman adapter and plugin for Sequel
+test_files: []