stateful_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5b8fa0430831e495e52e5fad80462db2100a9a8
+  data.tar.gz: ace6e802d2fa0abd9b047c23215dd0e2b8a70033
+SHA512:
+  metadata.gz: c2b6c81796a16ded357ff40cac7c2cfc37eb6570516d685ef59afe897a8d34cb270ace9e5e3b514aeface34072f5c3186e26cb69b8320acdbdc6cef039431093
+  data.tar.gz: 43019bdc355a9352af8a674f42a10b4d12f4fe64776c17089e731ea15109f0ab5b7c95ff476fbc3c493ba601e4570f00f51aa28514b3d9ff14ad1adc97de3715

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+/test/dummy/log/
+
+.byebug_history

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stateful_enum.gemspec
+gemspec
+
+gem 'byebug'

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Akira Matsuda
+
+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,119 @@
+# StatefulEnum
+
+stateful_enum is a state machine gem built on top of ActiveRecord's built-in ActiveRecord::Enum.
+
+
+## Installation
+
+Add this line to your Rails app's Gemfile:
+
+```ruby
+gem 'stateful_enum'
+```
+
+And bundle.
+
+
+## Motivation
+
+### You Ain't Gonna Need Abstraction
+
+stateful_enum depends on ActiveRecord. If you prefer a well-abstracted state machine library that supports multiple datastores, or Plain Old Ruby Objects (who needs that feature?), I'm sorry but this gem is not for you.
+
+### I Hate Saving States in a VARCHAR Column
+
+From a database design point of view, I prefer to save state data in an INTEGER column rather than saving the state name directly in a VARCHAR column.
+
+### :heart: ActiveRecord::Enum
+
+ActiveRecord 4.1+ has a very simple and useful built-in Enum DSL that provides human-friendly API over integer values in DB.
+
+### Method Names Should be Verbs
+
+AR::Enum automatically defines Ruby methods per each label. However, Enum labels are in most cases adjectives or past participle, which often creates weird method names.
+What we really want to define as methods are the transition events between states, and not the states themselves.
+
+
+## Usage
+
+The stateful_enum gem extends AR::Enum definition to take a block with a similar DSL to the [state_machine](https://github.com/pluginaweek/state_machine) gem.
+
+Example:
+```ruby
+class Bug < ApplicationRecord
+  enum status: {unassigned: 0, assigned: 1, resolved: 2} do
+    event :assign do
+      transition :unassigned => :assigned
+    end
+    event :resolve do
+      transition [:unassigned, :assigned] => :resolved
+    end
+  end
+end
+```
+
+### Defining the States
+
+Just call the AR::Enum's `enum` method.  The only difference from the original `enum` method is that our `enum` call takes a block.
+Please see the full API documentation of [AR::Enum](http://edgeapi.rubyonrails.org/classes/ActiveRecord/Enum.html) for more information.
+
+### Defining the Events
+
+You can declare events through `event` method inside of an `enum` block. Then stateful_enum defines the following methods per each event:
+
+**An instance method to fire the event**
+
+```ruby
+@bug.assign  # does nothing if a valid transition for the current state is not defined
+```
+
+**An instance method with `!` to fire the event**
+```ruby
+@bug.assign!  # raises if a valid transition for the current state is not defined
+```
+
+**A predicate method that returns if the event is fireable**
+```ruby
+@bug.can_assign?  # returns if the `assign` event can be called on this bug or not
+```
+
+**An instance method that returns the state name after an event**
+```ruby
+@bug.assign_transition  #=> :assigned
+```
+
+### Defining the Transitions
+
+You can define state transitions through `transition` method inside of an `event` block.
+
+There are a few important details to note regarding this feature:
+
+* The `transition` method takes a Hash each key of which is state "from" transitions to the Hash value.
+* The "from" states and the "to" states should both be given in Symbols.
+* The "from" state can be multiple states, in which case the key can be given as an Array of states, as shown in the usage example.
+
+### Error handling
+
+**TODO**
+
+### Event hooks
+
+**TODO**
+
+### Guards (:if and :unless options)
+
+**TODO**
+
+### Transition from "all"
+
+**TODO**
+
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/stateful_enum.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stateful_enum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stateful_enum.rb

@@ -0,0 +1,2 @@
+require 'stateful_enum/version'
+require 'stateful_enum/railtie'

data/lib/stateful_enum/active_record_extension.rb

@@ -0,0 +1,20 @@
+require 'stateful_enum/machine'
+
+module StatefulEnum
+  module ActiveRecordEnumExtension
+    #   enum status: {unassigned: 0, assigned: 1, resolved: 2, closed: 3} do
+    #     event :assign do
+    #       transition :unassigned => :assigned
+    #     end
+    #   end
+    def enum(definitions, &block)
+      enum = super definitions
+
+      if block
+        definitions.each_key do |column|
+          StatefulEnum::Machine.new self, column, enum[column], &block
+        end
+      end
+    end
+  end
+end

data/lib/stateful_enum/machine.rb

@@ -0,0 +1,64 @@
+module StatefulEnum
+  class Machine
+    def initialize(model, column, states, &block)
+      @model, @column, @states, @event_names = model, column, states, []
+
+      # undef non-verb methods e.g. Model#active!
+      states.each_key do |state|
+        @model.send :undef_method, "#{state}!"
+      end
+
+      instance_eval(&block) if block
+    end
+
+    def event(name, &block)
+      raise "event: :#{name} has already been defined." if @event_names.include? name
+      Event.new @model, @column, @states, name, &block
+      @event_names << name
+    end
+
+    class Event
+      def initialize(model, column, states, name, &block)
+        @model, @column, @states, @name, @transitions = model, column, states, name, {}
+
+        instance_eval(&block) if block
+
+        define_transition_methods
+      end
+
+      def define_transition_methods
+        column, name, transitions = @column, @name, @transitions
+
+        @model.send(:define_method, name) do
+          if (to = transitions[self.send(column).to_sym])
+            self.class.instance_variable_get(:@_enum_methods_module).instance_method("#{to}!").bind(self).call
+          else
+            false
+          end
+        end
+
+        @model.send(:define_method, "#{name}!") do
+          send(name) || raise('Invalid transition')
+        end
+
+        @model.send(:define_method, "can_#{name}?") do
+          transitions.has_key? self.send(column).to_sym
+        end
+
+        @model.send(:define_method, "#{name}_transition") do
+          transitions[self.send(column).to_sym]
+        end
+      end
+
+      def transition(transitions)
+        transitions.each_pair do |from, to|
+          raise "Undefined state #{to}" unless @states.has_key? to
+          Array(from).each do |f|
+            raise "Undefined state #{f}" unless @states.has_key? f
+            @transitions[f] = to
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stateful_enum/railtie.rb

@@ -0,0 +1,9 @@
+require 'stateful_enum/active_record_extension'
+
+module StatefulEnum
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load :active_record do
+      ::ActiveRecord::Base.extend StatefulEnum::ActiveRecordEnumExtension
+    end
+  end
+end

data/lib/stateful_enum/version.rb

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

data/stateful_enum.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stateful_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stateful_enum"
+  spec.version       = StatefulEnum::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'A state machine plugin on top of ActiveRecord::Enum'
+  spec.description   = 'A state machine plugin on top of ActiveRecord::Enum'
+  spec.homepage      = 'https://github.com/amatsuda/stateful_enum'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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 'rails'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: stateful_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !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: rails
+  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: sqlite3
+  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: A state machine plugin on top of ActiveRecord::Enum
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stateful_enum.rb
+- lib/stateful_enum/active_record_extension.rb
+- lib/stateful_enum/machine.rb
+- lib/stateful_enum/railtie.rb
+- lib/stateful_enum/version.rb
+- stateful_enum.gemspec
+homepage: https://github.com/amatsuda/stateful_enum
+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.6.1
+signing_key: 
+specification_version: 4
+summary: A state machine plugin on top of ActiveRecord::Enum
+test_files: []