transitionable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 933fdeae6a75c7c493a085742ae3beae2743a188
+  data.tar.gz: 12a92da1cdf7e2d9e55bdcbb0f1922f88036a9c0
+SHA512:
+  metadata.gz: aa9d445044fb373bd20ac7bc2e65c0a3cf2a3d1200e3c51c4b4b44acd5dd001e5f160c37f3fc03e4b591271f43faaee7cf3b9dd2a6f617dd6a381a15204d73a3
+  data.tar.gz: 1a064aef3e18dc2632c145d39abd84908b29e5ac53137c51d804eba47cb42d26fecd53504c3aca754ca2a2c50595232e1c9ba1dda02d660d0296accef059c2c0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.2
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in transitionable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    transitionable (0.1.1)
+      activesupport (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  transitionable!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zino
+
+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,76 @@
+# Transitionable
+
+A convention-based state machine that complements your models without stealing the show.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transitionable'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+class Event
+
+  # Requires including class to define the following constants BEFORE including this module:
+  #
+  #  * STATES
+  #  * TRANSITIONS
+
+  STATES = {
+    STAGED:    'staged',
+    STARTED:   'started',
+    COMPLETED: 'completed'
+  }.freeze
+
+  TRANSITIONS = [
+    { from: STATES[:STAGED], to: STATES[:STARTED] },
+    { from: STATES[:STARTED], to: STATES[:COMPLETED] }
+  ].freeze
+
+  include Transitionable
+
+  # specifies the column that needs to be transitioned
+  transition :some_state
+
+end
+```
+
+Provides the following helpers
+
+```ruby
+event.staged?
+event.started?
+event.completed?
+```
+
+Provides 2 validation methods
+
+```ruby
+event.validate_transition(target_state: 'new_state')
+# => returns true or false
+
+event.validate_transition!(target_state: 'new_state')
+# => returns true or raises Transitionable::InvalidStateTransition exception
+```
+
+## 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/[USERNAME]/transitionable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "transitionable"
+
+# 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(__FILE__)

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/transitionable.rb

@@ -0,0 +1,46 @@
+require 'transitionable/version'
+require 'active_support/concern'
+require 'active_support/core_ext/object'
+
+module Transitionable
+
+  extend ActiveSupport::Concern
+
+  class InvalidStateTransition < StandardError
+    def initialize(from_state, to_state)
+      msg = "Can't transition from #{from_state} to #{to_state}."
+      super(msg)
+    end
+  end
+
+  module ClassMethods
+    attr_accessor :trans_column
+
+    def transition(column)
+      self.trans_column = column
+      self::STATES.values.each do |this_state|
+        define_method "#{this_state}?" do
+          transitionable_state == this_state
+        end
+      end
+    end
+  end
+
+  def transitionable_state
+    self.send(self.class.trans_column)
+  end
+
+  def validate_transition!(target_state:)
+    unless validate_transition(target_state: target_state)
+      raise InvalidStateTransition.new(transitionable_state, target_state)
+    end
+    true
+  end
+
+  def validate_transition(target_state:)
+    self.class::TRANSITIONS.detect do |transition|
+      transition[:from] == transitionable_state && transition[:to] == target_state
+    end.present? ? true : false
+  end
+
+end

data/lib/transitionable/version.rb

@@ -0,0 +1,3 @@
+module Transitionable
+  VERSION = "0.1.1"
+end

data/transitionable.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "transitionable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "transitionable"
+  spec.version       = Transitionable::VERSION
+  spec.authors       = ["zino"]
+  spec.email         = ["zinocodes@gmail.com"]
+
+  spec.summary       = %q{Simple state machine from Chowbus}
+  spec.description   = %q{A convention-based state machine that complements your models without stealing the show}
+  spec.homepage      = "https://github.com/zinosama/transitionable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_dependency "activesupport", "~>5.2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: transitionable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- zino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: A convention-based state machine that complements your models without
+  stealing the show
+email:
+- zinocodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transitionable.rb
+- lib/transitionable/version.rb
+- transitionable.gemspec
+homepage: https://github.com/zinosama/transitionable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.14
+signing_key: 
+specification_version: 4
+summary: Simple state machine from Chowbus
+test_files: []