opal-aasm 0.7.0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opal-aasm.gemspec
+gemspec
+gem 'opal-react', path: "../react.rb"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mitch VanDuyn
+
+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,111 @@
+# Acts-As-State-Machine for Opal
+
+Allows the [Acts As State Machine (aasm)](https://github.com/aasm/aasm) gem to be used with the [Opal Ruby Transpiler](http://opalrb.org/).  Its also ready to work right along side [react.rb](https://github.com/zetachang/react.rb) UI components.  For detailed documentation on Acts As State Machine, refer the to [AASM](https://github.com/aasm/aasm) github page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opal-aasm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install opal-aasm
+
+## Usage
+
+```ruby
+class StateMachine
+  
+  include Opal::StateMachine
+  
+  state_machine_options :state_name => :component_state, :whiny_transitions => true
+  
+  state :cleaning
+  state :sleeping, :initial => true
+  state :running
+
+  event(:run, after: -> () {puts "started running!!!!!!"}) do
+    transitions :from => :sleeping, :to => :running
+  end
+
+  event(:clean, error: -> () {puts "don't clean now!!!!!!!"}) do
+    transitions :from => :running, :to => :cleaning
+  end
+
+  event :sleep do
+    transitions :from => [:running, :cleaning], :to => :sleeping
+  end
+  
+  # AASM will automatically define methods may_run?, run!, may_sleep?, sleep! etc
+  
+  # to access these from the javascript console you would type 
+  # machine = Opal.StateMachine.$new()
+  # machine["$may_run?"]()
+  # machine["$run"]()
+  # machine["$component_state"]()
+
+end
+```
+
+Note that you do not need to wrap the state and event directives with the normal `aasm do ... end`, but you 
+may still do so if desired. If you have a name conflict with `state` or `event` simply do the include of Opal::StateMachine after you define your state or event methods, and use the normal `aasm` dsl wrapper.
+
+To send options to AASM use the `state_machine_options` directive as shown above.
+
+Opal-aasm will define a method called `current_state` that can be used to get the current state.  You may override
+the method name by using the `state_name` option in the `state_machine_options` directive as shown above. 
+
+## Using with [React.rb](https://github.com/zetachang/react.rb) 
+
+The opal-aasm gem is "React" aware.  Adding a state machine to a react component gives a very easy and powerful way to manage component state.   For example consider turning the above into a react component:
+
+```ruby
+class StateMachine
+  
+  include React::Component
+  
+  def render
+    div do
+      span { "current state: #{component_state}"}
+      button {"run"  }.on(:click) {run!}   if may_run?
+      button {"sleep"}.on(:click) {sleep!} if may_sleep?
+      button {"clean"}.on(:click) {clean!} # we will check this in the state call back 
+    end
+  end
+  
+end
+```
+
+When both `React::Component` and `Opal::StateMachine` are included in the same class a hidden react state is updated whenever there is a state transition.  The rest is handled by the magic of React.
+
+## Summary of additional features 
+
+The opal-aasm gem is intended to be upwards compatible with the standard AASM.  The following are the additional features added by opal-aasm.
+
+* No need to wrap `state` and `event` directives in an aasm block.
+* AASM options may be provided using the `state_machine_options` directive.
+* The `current_state` method may be used to access the current state.  The name can be changed using the `state_name` option.
+* Will persist the current state as a react state variable if the `React::Component` mixin is present in the same class.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/catprintlabs/opal-aasm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,16 @@
+#require "bundler/gem_tasks"
+#require "rspec/core/rake_task"
+
+#RSpec::Core::RakeTask.new(:spec)
+
+#task :default => :spec
+# Rakefile
+require 'opal/rspec/rake_task'
+require 'bundler'
+Bundler.require
+
+# Add our opal/ directory to the load path
+Opal.append_path File.expand_path('../lib', __FILE__)
+
+
+Opal::RSpec::RakeTask.new(:default)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opal/aasm"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/opal-aasm.rb

@@ -0,0 +1,12 @@
+if RUBY_ENGINE == 'opal'
+  require_relative 'opal/aasm/version.rb'
+  require_relative 'opal/aasm.rb'
+  require_relative 'opal-aasm.rb'
+else
+  require 'opal'
+  require 'opal-jquery'
+  require 'opal-react'
+  Opal.use_gem 'aasm'
+  Opal.use_gem 'react-source'
+  Opal.append_path File.expand_path('..', __FILE__).untaint
+end

data/lib/opal/aasm.rb

@@ -0,0 +1,160 @@
+require "opal/aasm/version"
+require "aasm"
+require "aasm/persistence/plain_persistence"
+
+module Opal
+  module StateMachine
+    
+    # the following method adds the hidden react state variable to React::Component, by adding our 
+    # own self.included method to React::Component.
+    # Because we want to allow the modules to be required and included in any order extend_react_component
+    # will be called twice.  Once when Opal::StateMachine is included, and once when this file is required.
+    # The instance variable @original_included_method_for_state_machine protects us from infinite recursion.
+    
+    # 1 we are required first, we are included first     
+    # 2 we are required first, we are included second    
+    # 3 we are required second, we are included first
+    # 4 we are required second, we are included second
+    # 5 we are required, but they are not
+    
+    def self.extend_react_component(where, klass = nil)
+      return if klass and klass.respond_to? :aasm_event_fired # case 4 already handled when we were required.
+      if klass and klass.respond_to? :define_state
+        # case 2
+        klass.define_state :protected_current_react_state_var
+        klass.define_method :aasm_event_fired do |event, from, to|
+          protected_current_react_state_var! to.to_s if from != to
+        end
+      elsif defined? React::Component
+        # case 3 + 4 (second call from include will be ignored)
+        # case 1 (first call from require will be ignored)
+        React::Component.module_eval do
+          # alias_method does not work on :included so we do it the hard way
+          unless @original_included_method_for_state_machine
+            @original_included_method_for_state_machine = self.method(:included) 
+            def self.included(base)
+              @original_included_method_for_state_machine.call(base)
+              base.define_state :protected_current_react_state_var
+              base.define_method :aasm_event_fired do |event, from, to|
+                protected_current_react_state_var! to.to_s if from != to
+              end
+            end
+          end 
+        end
+      end
+    end
+    
+    def current_state
+      protected_current_react_state_var if respond_to? :render
+      aasm.current_state.to_s
+    end
+    
+    module AASMAPI
+      
+      # add the event and state methods to the class so we don't have to wrap with the aasm block
+
+      ["event", "state"].each do |method_name|
+        define_method(method_name)  do |*args, &block|
+          aasm do
+            send(method_name, *args, &block)
+          end
+        end
+      end
+      
+      # add the state_machine_options directive and the new :state_name option
+
+      def state_machine_options(opts={})
+        define_method(opts.delete(:state_name)) do 
+          protected_current_react_state_var if respond_to? :render
+          aasm.current_state.to_s
+        end if opts[:state_name]
+        aasm opts
+      end
+
+    end
+    
+    def self.included(base)
+      
+      Opal::StateMachine.extend_react_component("StateMachine included", base)
+
+      base.include AASM
+      base.extend AASMAPI
+
+    end
+
+  end
+end
+
+# Work around a couple of incompatibilities with Opal and AASM
+
+module AASM
+
+  # redefine because of opal breaks when doing a super in this case
+  def self.included(base)
+    base.extend AASM::ClassMethods
+    AASM::StateMachine[base] ||= AASM::StateMachine.new
+    AASM::Persistence.load_persistence(base)  
+    super rescue nil #<--------------------------------added because of bug in opal
+  end
+
+  module Persistence
+
+    # override normal AASM load_persisentence method as it uses various features not supported by opal
+
+    def self.load_persistence(base)
+      base.send(:include, AASM::Persistence::PlainPersistence)
+    end
+
+  end
+
+  # redefine the initialize method because it was was doing a very expensive
+  # (for Opal) class_eval with a string (instead of a block).  While we are redefining this
+  # the unnecessary options have been removed.
+
+  class Base
+
+    attr_reader :state_machine
+
+    def initialize(klass, options={}, &block)
+      @klass = klass
+      @state_machine = AASM::StateMachine[@klass]
+      @options = options
+
+      # let's cry if the transition is invalid
+      configure :whiny_transitions, true
+      
+    end
+  end
+end
+
+Opal::StateMachine.extend_react_component("StateMachine file loaded")
+
+# Last but not least add catch/throw to Opal as these are currently missing (as of version 8.beta)
+# There is a PR to bring these into Opal properly.
+
+class Object
+
+  def catch(sym)
+    yield
+  rescue CatchThrow => e
+    return e.arg if e.sym == sym
+    raise e
+  end
+
+  def throw(*args)
+    raise CatchThrow.new(args)
+  end
+
+  protected
+
+  class CatchThrow < Exception 
+    attr_reader :sym
+    attr_reader :arg
+    def initialize(args)
+      @sym = args[0]
+      @arg = args[1] if args.count > 1
+    end
+  end
+
+end
+

data/lib/opal/aasm/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module StateMachine
+    VERSION = "0.7.0"
+  end
+end

data/opal-aasm.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opal/aasm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opal-aasm"
+  spec.version       = Opal::StateMachine::VERSION
+  spec.authors       = ["Mitch VanDuyn"]
+  spec.email         = ["mitch@catprint.com"]
+
+  spec.summary       = "Acts-As-State-Machine for Opal"
+  spec.description   = <<DESCRIPTION
+Allows the Acts As State Machine (aasm) gem to be used with the Opal Ruby Transpiler.
+Its also ready to work right along side react.rb UI components.  For detailed documentation on Acts As State Machine, 
+refer the to AASM github page at https://github.com/aasm/aasm.
+DESCRIPTION
+  spec.homepage      = "https://github.com/catprintlabs/opal-aasm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "opal-rspec"
+  spec.add_development_dependency "opal-jquery"
+  spec.add_development_dependency 'react-source', '~> 0.12'
+  spec.add_development_dependency 'opal-react'
+  spec.add_runtime_dependency 'opal'
+  spec.add_runtime_dependency 'aasm'
+  
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: opal-aasm
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
+platform: ruby
+authors:
+- Mitch VanDuyn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: opal-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal-jquery
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: react-source
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: opal-react
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Allows the Acts As State Machine (aasm) gem to be used with the Opal
+  Ruby Transpiler.\nIts also ready to work right along side react.rb UI components.
+  \ For detailed documentation on Acts As State Machine, \nrefer the to AASM github
+  page at https://github.com/aasm/aasm.\n"
+email:
+- mitch@catprint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opal-aasm.rb
+- lib/opal/aasm.rb
+- lib/opal/aasm/version.rb
+- opal-aasm.gemspec
+homepage: https://github.com/catprintlabs/opal-aasm
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Acts-As-State-Machine for Opal
+test_files: []