enum_transitions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1163e05c0547bba40946136e8ed6e5816c044b1
+  data.tar.gz: da88b22cc6a7283c466a4d591596399f1f6f2dd0
+SHA512:
+  metadata.gz: ce52ae8544c71df04827ab5edb1b675844613cbc19bccd9673fa69b4420e4c23ea21aea7e9a5938a9064272d09cabb3728e6ab673ad855ed2e9d26ac9069fbab
+  data.tar.gz: a8162fec399773363224fe90f1762c867e8ef23e2f1ffce10cf4aadb99b1cbad16d3b0834d1c4f33d9458ce7f25918bf27dff0048fca76bfc6e6930a88f8d024

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--require byebug

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+before_install: gem install bundler
+rvm:
+  - 2.2.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby "2.2.6"
+#ruby-gemset=enum_transitions
+
+# Specify your gem's dependencies in enum_transitions.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# EnumTransitions
+
+Rails provides [ActiveRecord::Enum](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html) which is great for state machines. The only problem is that it doesn't provide built-in validations for transitions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_transitions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum_transitions
+
+## Usage
+
+For example, let's say you have a `Car` model:
+
+```ruby
+class Car < ApplicationRecord
+  enum state: [ :parked, :drive, :reverse ]
+
+  enum_transitions state: {
+    parked: [ :drive, :reverse ],
+    drive: :parked,
+    reverse: :parked
+  }
+end
+```
+
+Then when you call the transition methods (provided by `ActiveRecord::Enum`), an error will raise if the transition is invalid:
+
+```ruby
+car = Car.create!
+car.drive! #=> car.state == :drive
+car.reverse! #=> raises EnumTransitions::InvalidTransition
+
+car.transitions_to_reverse? #=> false
+car.transitions_to_parked? #=> true
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/listia/enum_transitions.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enum_transitions"
+
+# 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/enum_transitions.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_transitions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_transitions"
+  spec.version       = EnumTransitions::VERSION
+  spec.authors       = ["Ngan Pham", "Xenor Chang"]
+  spec.email         = ["ngan@listia.com", "xenor@listia.com"]
+
+  spec.summary       = %q{Add state maps to Rails Enums for validation on transitions.}
+  spec.description   = %q{Add state maps to Rails Enums for validation on transitions.}
+  spec.homepage      = "https://github.com/listia/enum_transitions"
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.1", "< 4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.5"
+  spec.add_development_dependency "byebug", "~> 9.0.6"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/enum_transitions.rb

@@ -0,0 +1,68 @@
+require "enum_transitions/version"
+
+module EnumTransitions
+  InvalidTransition = Class.new(StandardError)
+
+  def self.extended(base)
+    base.class_attribute(:defined_enum_transitions, instance_writer: false)
+    base.defined_enum_transitions = {}
+  end
+
+  def inherited(base)
+    base.defined_enum_transitions = defined_enum_transitions.deep_dup
+    super
+  end
+
+  def enum_transitions(definitions)
+    definitions.each do |name, values|
+      unless enum_definition = defined_enums[name.to_s]
+        raise "#{name} enum is not defined"
+      end
+
+      transition_values = ActiveSupport::HashWithIndifferentAccess.new
+
+      values.each do |origin, destinations|
+        origin = origin.to_s
+        destinations = Array.wrap(destinations).map(&:to_s)
+        states_diff = (destinations + [origin]) - enum_definition.keys
+
+        unless states_diff.empty?
+          raise "#{name} enum does not define: #{states_diff.to_sentence}"
+        end
+
+        transition_values[origin] = destinations
+      end
+
+      enum_definition.keys.each do |state|
+        _enum_transitions_methods_module.module_eval do
+          define_method("transitions_to_#{state}?") {
+            defined_enum_transitions[name.to_s].map do |origin, destination|
+              origin if destination.include?(state)
+            end.compact.include?(public_send(name))
+          }
+
+          define_method("#{state}!") { |*args|
+            unless public_send("transitions_to_#{state}?")
+              raise InvalidTransition, "Cannot transition #{name} from `#{public_send(name)}` to `#{state}`"
+            end
+            super(*args)
+          }
+        end
+      end
+
+      defined_enum_transitions[name.to_s] = transition_values
+    end
+  end
+
+  private
+
+  def _enum_transitions_methods_module
+    @_enum_transitions_methods_module ||= begin
+      mod = Module.new
+      include mod
+      mod
+    end
+  end
+end
+
+require "enum_transitions/railtie"

data/lib/enum_transitions/railtie.rb

@@ -0,0 +1,9 @@
+require "rails/railtie"
+
+module EnumTransitions
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load :active_record do
+      ::ActiveRecord::Base.extend EnumTransitions
+    end
+  end
+end

data/lib/enum_transitions/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: enum_transitions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ngan Pham
+- Xenor Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+- !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: Add state maps to Rails Enums for validation on transitions.
+email:
+- ngan@listia.com
+- xenor@listia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum_transitions.gemspec
+- lib/enum_transitions.rb
+- lib/enum_transitions/railtie.rb
+- lib/enum_transitions/version.rb
+homepage: https://github.com/listia/enum_transitions
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Add state maps to Rails Enums for validation on transitions.
+test_files: []