enum_aasm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d64e7d22497c11c5427ee98ff34102743864f1cd
+  data.tar.gz: fde827f85411ce0e44f16aab64d4f1ab2d0b65ff
+SHA512:
+  metadata.gz: bbc68ee3f4bd005d77c37130e73d2931ccb0625acf3883eab17656cfec55909030acfa76c8c8092a23c762813f740da1140d4af9e2a57396867019a548306afc
+  data.tar.gz: 61d09fb0d2c9d0eb0709ce639eff70e79a3e61d9813d2bfdf634882e137012b698d18ec7001a456d96c8329cf4925f5f6bfcec52c7acb556758dc8ce18b3f495

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--profile
+--backtrace
+--format nested
+--tty

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.0.0@enum_state_machine --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Arthur Shagall
+
+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,55 @@
+# EnumAasm
+
+An extension to the [AASM](https://github.com/aasm/aasm) finite state machine that uses
+[PowerEnum](https://github.com/albertosaurus/power_enum_2) enumerated attributes
+for state transitions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enum_aasm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum_aasm
+
+## Usage
+
+Basically the same usage as the original AASM. The only difference is that the `:column` option is mandatory.
+Use this option to specify the name of the enumerated attribute. Note that scopes are not defined
+by the state machine as PowerEnum already handles this functionality.
+
+### Example
+
+```ruby
+require 'enum_aasm'
+
+class Fruit < ActiveRecord::Base
+  include AASM
+
+  has_enumerated :fruit_color
+
+  aasm :column => :fruit_color do
+    state :green, :initial => true
+  end
+end
+```
+
+## License
+
+Distributed under the MIT license. See LICENSE.txt for details.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+Copyright 2014 Arthur Shagall

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/enum_aasm.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_aasm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_aasm"
+  spec.version       = EnumAasm::VERSION
+  spec.authors       = ["Arthur Shagall"]
+  spec.email         = ["arthur.shagall@gmail.com"]
+  spec.description   = %q{This gem patches AASM to use PowerEnum enums for states.}
+  spec.summary       = %q{Use PowerEnum enums for AASM states.}
+  spec.homepage      = "https://github.com/albertosaurus/enum_aasm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'aasm'
+  spec.add_dependency 'power_enum', '~> 2.0'
+end

data/lib/enum_aasm.rb

@@ -0,0 +1,64 @@
+#
+# Copyright 2014 Arthur Shagall
+#
+
+require "enum_aasm/version"
+require 'power_enum'
+require 'aasm'
+require 'aasm/base'
+require 'aasm/persistence/active_record_persistence'
+require 'aasm/persistence/base'
+
+AASM::Persistence::ActiveRecordPersistence::InstanceMethods.module_eval do
+
+  # Patched to use the enumerated attribute
+  def aasm_write_state(state)
+    attr_name = self.class.aasm_column
+    old_value = self.__send__(attr_name)
+    self.__send__("#{attr_name}=", state)
+
+    success = if AASM::StateMachine[self.class].config.skip_validation_on_save
+                self.update_attribute(attr_name, state)
+              else
+                self.save
+              end
+    if success
+      true
+    else
+      self.__send__("#{attr_name}=", old_value)
+      false
+    end
+  end
+
+  # Patched to use the enumerated attribute
+  def aasm_write_state_without_persistence(state)
+    self.__send__("#{self.class.aasm_column}=", state)
+  end
+
+end
+
+AASM::Base.module_eval do
+
+  # Scopes need to be disabled. PowerEnum already provides this functionality
+  def state(name, *args)
+    state_without_scope(name, *args)
+  end
+
+end
+
+AASM::Persistence::ActiveRecordPersistence.module_eval do
+
+  def self.included(base)
+    base.send(:include, AASM::Persistence::Base)
+    base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
+
+    base.before_validation(:aasm_ensure_initial_state, :on => :create)
+
+    # ensure initial aasm state even when validations are skipped
+    base.before_create(:aasm_ensure_initial_state)
+
+    # ensure state is in the list of states
+    base.validate :aasm_validate_states
+  end
+
+end

data/lib/enum_aasm/version.rb

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

data/spec/enum_aasm_spec.rb

@@ -0,0 +1,101 @@
+#
+# Copyright 2014 Arthur Shagall
+#
+require 'spec_helper'
+
+class SpecModel
+  # Class methods
+  class << self
+    def aasm_column
+      :status
+    end
+
+    def transaction(args)
+      yield
+    end
+
+    [:before_validation, :before_create, :validate].each do |method|
+      module_eval( <<-end_eval, __FILE__, __LINE__ )
+def #{method}(*args)
+  true
+end
+      end_eval
+    end
+  end
+
+
+  include AASM
+  include AASM::Persistence::ActiveRecordPersistence
+
+  attr_accessor :status
+
+  def initialize
+    self.status = :foo
+  end
+
+  aasm :column => :status do
+
+    state :foo, :initial => true
+    state :bar
+    state :baz
+
+    event :start do
+      transitions :from => :foo, :to => :bar, :guard => :can_start?
+      transitions :from => :foo, :to => :baz
+    end
+
+  end
+
+  def can_start?
+    true
+  end
+
+  def save
+    true
+  end
+
+  def new_record?
+    true
+  end
+end
+
+describe "EnumAasm" do
+
+  let(:model) { SpecModel.new }
+
+  it 'basic transition' do
+    model.start!.should be_true
+
+    model.status.should eq(:bar)
+  end
+
+  it 'transition with guard' do
+    model.should_receive(:can_start?).and_return(false)
+
+    model.start!.should be_true
+
+    model.status.should eq(:baz)
+  end
+
+  it 'if save fails' do
+    model.should_receive(:save).and_return(false)
+
+    model.start!.should be_false
+
+    model.status.should eq(:foo)
+  end
+
+  it 'without saving' do
+    model.start.should be_true
+
+    model.status.should eq(:bar)
+  end
+
+  it 'invalid transition' do
+    model.status = :baz
+
+    expect {
+      model.start.should be_false
+    }.to raise_error(AASM::InvalidTransition)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+#
+# Copyright 2014 Arthur Shagall
+#
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'bundler/setup'
+
+require 'enum_aasm'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: enum_aasm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arthur Shagall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: simplecov
+  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: aasm
+  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'
+- !ruby/object:Gem::Dependency
+  name: power_enum
+  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'
+description: This gem patches AASM to use PowerEnum enums for states.
+email:
+- arthur.shagall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enum_aasm.gemspec
+- lib/enum_aasm.rb
+- lib/enum_aasm/version.rb
+- spec/enum_aasm_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/albertosaurus/enum_aasm
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Use PowerEnum enums for AASM states.
+test_files:
+- spec/enum_aasm_spec.rb
+- spec/spec_helper.rb