aasm_ohm_persistence 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd98d5a84fbc31a12fe914ac93df689d5c4f00b8
+  data.tar.gz: 007a9c1fd0228530db036b6d58caddb5a30f2f95
+SHA512:
+  metadata.gz: 98a6a18978b4720d1cff88447304872f65c67ef4fda9e0d222833c7cb873532f29624db8bb6d3fbcf76cd2e7d944fdc2f9556f48d03a692ed689d9097e8f6139
+  data.tar.gz: 019a29385ddc590b6129790475c746686176b4a52ba14e1375cf616b13e2e8d4f95e8d0208d44bc443c424c6c29042ec26edf82b4e4bd8d2c2129fab5e8afcbc

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phuong Nguyen
+
+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,54 @@
+# AasmOhmPersistence
+
+Use AASM with Ohm
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aasm_ohm_persistence'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aasm_ohm_persistence
+
+## Usage
+
+So far this require ohm-contrib to work
+
+To enable AASM for Ohm:
+
+    class MyRedisModal < Ohm::Model
+      include AASM
+      include AASM::Persistence::OhmPersistence
+
+      aasm do
+        # Your aasm logic
+      end
+    end
+
+## Notice
+
+Unlike active record which use instance method of class to create
+callback, ohm-contrib use class method to create callbacks.
+
+Since OhmPersistence will declare before_create inside the modal, if you
+wish to include your own logic to the `before_create` callback, you need
+to write it like that:
+
+    def before_create
+      super
+      # your own code
+    end
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/aasm_ohm_persistence.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aasm_ohm_persistence/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aasm_ohm_persistence"
+  spec.version       = AasmOhmPersistence::VERSION
+  spec.authors       = ["Phuong Nguyen"]
+  spec.email         = ["phuongnd08@gmail.com"]
+  spec.description   = %q{Persistence adapter to use AASM with Ohm}
+  spec.summary       = %q{Persistence adapter to use AASM with Ohm}
+  spec.homepage      = "http://github.com/phuongnd08/aasm_ohm_persistence"
+  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_dependency "ohm-contrib"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/aasm/persistence/ohm_persistence.rb

@@ -0,0 +1,117 @@
+require "aasm/persistence/base"
+require "ohm/callbacks"
+
+module AASM
+  module Persistence
+    module OhmPersistence
+      # This method:
+      #
+      # * extends the model with ClassMethods
+      # * includes InstanceMethods
+      #
+      # Adds
+      #
+      #   def before_create
+      #     aasm_ensure_initial_state
+      #   end
+      #
+      # As a result, you need to call super if you are going to define before_create yourself
+      #
+      #   class Foo < Ohm::Model
+      #     include AASM
+      #     include AASM::Persistence::OhmPersistence
+      #
+      #     def before_create
+      #       super
+      #       # your code here
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.send(:include, AASM::Persistence::Base)
+        base.extend AASM::Persistence::OhmPersistence::ClassMethods
+        base.send(:include, Ohm::Callbacks)
+        base.send(:include, AASM::Persistence::OhmPersistence::InstanceMethods)
+      end
+
+      module ClassMethods
+        def find_in_state(id, state, *args)
+          find(aasm_column.to_sym => state)[id]
+        end
+
+        def count_in_state(state, *args)
+          find(aasm_column.to_sym => state).count
+        end
+      end
+
+      module InstanceMethods
+        def before_create
+          super
+          aasm_ensure_initial_state
+        end
+
+        # Writes <tt>state</tt> to the state column and persists it to the database
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm.current_state # => :opened
+        #   foo.close!
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+
+        def aasm_write_state(state)
+          old_value = self.send(self.class.aasm_column.to_sym)
+          aasm_write_state_without_persistence(state)
+
+          success = self.save
+
+          unless success
+            aasm_write_state_without_persistence(old_value)
+            return false
+          end
+
+          true
+        end
+
+        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm.current_state # => :opened
+        #   foo.close
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :opened
+        #   foo.save
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state_without_persistence(state)
+          self.send(:"#{self.class.aasm_column}=", state.to_s)
+        end
+
+      private
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          aasm.enter_initial_state if send(self.class.aasm_column).blank?
+        end
+      end # InstanceMethods
+    end
+  end
+end
+

data/lib/aasm_ohm_persistence.rb

@@ -0,0 +1 @@
+require "aasm/persistence/ohm_persistence"

data/lib/aasm_ohm_persistence/version.rb

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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: aasm_ohm_persistence
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phuong Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm-contrib
+  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: 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'
+description: Persistence adapter to use AASM with Ohm
+email:
+- phuongnd08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aasm_ohm_persistence.gemspec
+- lib/aasm/persistence/ohm_persistence.rb
+- lib/aasm_ohm_persistence.rb
+- lib/aasm_ohm_persistence/version.rb
+homepage: http://github.com/phuongnd08/aasm_ohm_persistence
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Persistence adapter to use AASM with Ohm
+test_files: []