huwahuwa_state 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a88a9b7bfe339222b625f4cd9563ffb04a2500e
+  data.tar.gz: 7103948a62a3e756c8c912237c5c59367bbd8ddb
+SHA512:
+  metadata.gz: 9266eba4cf50dee3ae2f482990bbe6074e2d5830558e19152befe92a58a3c140243670d645419da28204d99db7186dffa0a44e6557fc2dfa880c28cca30e1aad
+  data.tar.gz: f46f1d27adc30667520bceb0dd624c5873220e05fb39a766785c8ecdb68b1082a462bfe0d88d547fe1511cbd3d0a811b1c3ea41d2660f960d867c0c18d7d92d8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jiikko
+
+MIT License
+
+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,58 @@
+
+# HuwahuwaState - Ruby simple state machines
+[![Build Status](https://travis-ci.org/jiikko/huwahuwa_state.svg?branch=master)](https://travis-ci.org/jiikko/huwahuwa_state)
+
+using ActiveRecord::Enum.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'huwahuwa_state', github: 'jiikko/huwahuwa_state'
+
+
+And then execute:
+
+    $ bundle
+
+## Requirements
+-  "activerecord", ">= 4.1"
+
+## Example
+```ruby
+class User < ActiveRecord::Base
+  enum state: [:state_active, :state_freeze, :state_rock, :state_pending]
+  huwahuwa_state column_name: :state
+  
+  huwahuwa_state :state_active, from: [:state_pending, :state_freeze, :state_pending] do |record|
+    # something
+    record.state_active!
+    # something
+  end
+
+  huwahuwa_state :state_rock, from: [:state_active] do |record|
+    record.state_rock!
+  end
+end
+```
+
+```ruby
+# success
+user = User.create(state: User.states["state_pending"])
+user.update_state!(:state_active)
+user.can_state_active? # => true
+user.state # => 'state_active'
+
+# failure
+user = User.create(state: User.states["state_freeze"])
+user.can_state_rock? # => false
+user.update_state!(:state_rock) # => HuwahuwaState::NotAcceptedUpdate
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/huwahuwa_state/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/huwahuwa_state.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'huwahuwa_state/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "huwahuwa_state"
+  spec.version       = HuwahuwaState::VERSION
+  spec.authors       = ["jiikko"]
+  spec.email         = ["n905i.1214@gmail.com"]
+  spec.summary       = %q{State machines for Ruby.}
+  spec.description   = %q{State machines for Ruby.}
+  spec.homepage      = "https://github.com/jiikko/huwahuwa_state"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "activerecord", ">= 4.1"
+  spec.add_dependency 'activesupport'
+end

data/lib/huwahuwa_state.rb

@@ -0,0 +1,14 @@
+require "huwahuwa_state/version"
+require 'huwahuwa_state/main'
+
+if defined?(Rails)
+  class Railtie < Rails::Railtie
+    initializer 'initialize huwahuwa_state' do
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.send(:include, HuwahuwaState::Main)
+      end
+    end
+  end
+else
+  ::ActiveRecord::Base.send(:include, HuwahuwaState::Main)
+end

data/lib/huwahuwa_state/main.rb

@@ -0,0 +1,32 @@
+module HuwahuwaState
+  class NotAcceptedUpdate < StandardError; end
+
+  module Main
+    extend ActiveSupport::Concern
+
+    included do
+      def self.huwahuwa_state(state_name = nil, column_name: nil, from: nil, options: [], &block)
+        if state_name.nil?
+          @@column_name = column_name || :name
+          return
+        end
+
+        raise(ArgumentError, 'missing keyword: from') if from.nil?
+        define_method "can_#{state_name}?" do |and_options: []| # can_hoge?が定義される
+          valid_optionsed = true
+          if options.present?
+            valid_optionsed = and_options.map { |x| options.include?(x) }.any?
+          end
+          valid_state = from.map(&:to_s).include?(self.send(@@column_name))
+          valid_state && valid_optionsed
+        end
+        self.class_variable_set("@@_block_#{state_name}", block)
+      end
+    end
+
+    def update_state!(state_name, and_options: [])
+      raise(NotAcceptedUpdate) unless send("can_#{state_name}?", and_options: and_options)
+      self.class.class_variable_get("@@_block_#{state_name}").call(self)
+    end
+  end
+end

data/lib/huwahuwa_state/version.rb

@@ -0,0 +1,3 @@
+module HuwahuwaState
+  VERSION = "0.0.1"
+end

data/spec/huwahuwa_state/main_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe HuwahuwaState::Main do
+  context '正しい遷移する時' do
+    it "pendingからactiveに遷移すること" do
+      user = User.create(state: User.states["state_pending"])
+      user.update_state!(:state_active)
+      expect(user.state).to eq('state_active')
+    end
+
+    it "activeからlockへ遷移すること" do
+      user = User.create(state: User.states["state_active"])
+      user.update_state!(:state_rock)
+      expect(user.state).to eq('state_rock')
+    end
+  end
+
+  context '想定していない遷移をする時' do
+    it "catch exception" do
+      user = User.create(state: User.states["state_active"])
+      expect {
+        user.update_state!(:state_pending)
+      }.to raise_error(HuwahuwaState::NotAcceptedUpdate)
+    end
+  end
+
+  context 'optionsに値が設定されている時' do
+    context '正しい遷移する時' do
+      it 'untouchedからworkingへ遷移すること' do
+        issue = Issue.create(state: Issue.states["untouched"])
+        issue.update_state!(:working, and_options: [:worker])
+        expect(issue.state).to eq('working')
+      end
+
+      it 'resolvedからfinishedになること' do
+        issue = Issue.create(state: Issue.states["resolved"])
+        issue.update_state!(:finished, and_options: [:manager])
+        expect(issue.state).to eq('finished')
+      end
+    end
+
+    context '想定していない遷移をする時' do
+      it "catch exception" do
+        issue = Issue.create(state: Issue.states["untouched"])
+        expect {
+          issue.update_state!(:working, and_options: [:other_user])
+        }.to raise_error(HuwahuwaState::NotAcceptedUpdate)
+      end
+    end
+  end
+end

data/spec/huwahuwa_state_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe HuwahuwaState do
+  it 'has a version number' do
+    expect(HuwahuwaState::VERSION).not_to be nil
+  end
+end

data/spec/migrations/001_create_users.rb

@@ -0,0 +1,8 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.integer :state
+    end
+  end
+end

data/spec/migrations/002_create_issues.rb

@@ -0,0 +1,8 @@
+class CreateIssues < ActiveRecord::Migration
+  def change
+    create_table :issues do |t|
+      t.string :name
+      t.integer :state
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+require "active_record"
+require 'huwahuwa_state'
+require 'support/models/user'
+require 'support/models/issue'
+
+ActiveRecord::Base.establish_connection(
+  adapter:   'sqlite3',
+  database:  ':memory:'
+)
+ActiveRecord::Migrator.migrate(File.expand_path('../migrations', __FILE__))

data/spec/support/models/issue.rb

@@ -0,0 +1,12 @@
+class Issue < ActiveRecord::Base
+  enum state: [:untouched, :working, :pending_review, :resolved, :finished]
+  huwahuwa_state column_name: :state
+
+  huwahuwa_state :working, from: [:untouched, :pending_review, :resolved], options: [:worker] do |record|
+    record.working!
+  end
+
+  huwahuwa_state :finished, from: [:resolved], options: [:manager] do |record|
+    record.finished!
+  end
+end

data/spec/support/models/user.rb

@@ -0,0 +1,18 @@
+class User < ActiveRecord::Base
+  enum state: [:state_active, :state_freeze, :state_rock, :state_pending]
+  huwahuwa_state column_name: :state
+
+  huwahuwa_state :state_active, from: [:state_pending, :state_freeze, :state_pending] do |record|
+    # some
+    record.state_active!
+    # some
+  end
+
+  huwahuwa_state :state_rock, from: [:state_active] do |record|
+    record.state_rock!
+  end
+
+  huwahuwa_state :state_pending, from: [] do |record|
+    # do nothing
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: huwahuwa_state
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jiikko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: State machines for Ruby.
+email:
+- n905i.1214@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- huwahuwa_state.gemspec
+- lib/huwahuwa_state.rb
+- lib/huwahuwa_state/main.rb
+- lib/huwahuwa_state/version.rb
+- spec/huwahuwa_state/main_spec.rb
+- spec/huwahuwa_state_spec.rb
+- spec/migrations/001_create_users.rb
+- spec/migrations/002_create_issues.rb
+- spec/spec_helper.rb
+- spec/support/models/issue.rb
+- spec/support/models/user.rb
+homepage: https://github.com/jiikko/huwahuwa_state
+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.2.0
+signing_key: 
+specification_version: 4
+summary: State machines for Ruby.
+test_files:
+- spec/huwahuwa_state/main_spec.rb
+- spec/huwahuwa_state_spec.rb
+- spec/migrations/001_create_users.rb
+- spec/migrations/002_create_issues.rb
+- spec/spec_helper.rb
+- spec/support/models/issue.rb
+- spec/support/models/user.rb