pretends_like_state_machine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4df10f03539a19ff773334aebc84ec9c80a3106f
+  data.tar.gz: f8f4c44aed38a5b0ac7c778f023de1b1d466a5ff
+SHA512:
+  metadata.gz: 82fe345a840cc7194bb7685cb84c343375f9d516817fafc9db087e0f474bdcd2f823196f91d4f8d733da982dba848cd71536042e46fea09213ce4561c9b12e80
+  data.tar.gz: 8767d8e965240cd8ed46d4d13c538039aaa2e588566c8b013cb6f9d51f2d9f0f48db81e72340ee92a166328f3545d6c118a68725f2828f838f00046578b0a8bb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Pablo Torrecilla
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PretendsLikeStateMachine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/pretends_like_state_machine.rb

@@ -0,0 +1,4 @@
+require 'pretends_like_state_machine/mongoid/pretends_like_state_machine' if defined?(::Mongoid)
+
+module PretendsLikeStateMachine
+end

data/lib/pretends_like_state_machine/mongoid/pretends_like_state_machine.rb

@@ -0,0 +1,23 @@
+module PretendsLikeStateMachine
+  module Mongoid
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def pretends_like_state_machine(options = {})
+        field :state, type: Symbol
+
+        options[:states].each do |state|
+          define_method("#{state}!") do
+            update_attribute(:state, state)
+          end
+
+          define_method("#{state}?") do
+            self.state == state
+          end
+        end
+      end
+    end
+  end
+end
+
+Mongoid::Document.send :include, PretendsLikeStateMachine::Mongoid

data/lib/pretends_like_state_machine/version.rb

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

data/lib/tasks/pretends_like_state_machine_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pretends_like_state_machine do
+#   # Task goes here
+# end

data/test/mongoid.yml

@@ -0,0 +1,69 @@
+development:
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: wtg_development
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change the default write concern. (default = { w: 1 })
+        # write:
+        # w: 1
+
+        # Change the default consistency model to primary, secondary.
+        # 'secondary' will send reads to secondaries, 'primary' sends everything
+        # to master. (default: primary)
+        # read: secondary_preferred
+
+        # How many times Moped should attempt to retry an operation after
+        # failure. (default: 30)
+        # max_retries: 30
+
+        # The time in seconds that Moped should wait before retrying an
+        # operation on failure. (default: 1)
+        # retry_interval: 1
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serializaion. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Use Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+test:
+  sessions:
+    default:
+      database: wtg_test
+      hosts:
+        - localhost:27017
+      options:
+        read: primary
+        # In the test environment we lower the retries and retry interval to
+        # low amounts for fast failures.
+        max_retries: 1
+        retry_interval: 0

data/test/pretends_like_state_machine_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class MyProcess
+  include Mongoid::Document
+
+  pretends_like_state_machine states: [:waiting, :processing, :processed]
+end
+
+describe PretendsLikeStateMachine do
+  it 'state defaults to nil' do
+    MyProcess.new.state.must_be_nil
+  end
+
+  it 'transition to a valid state must perform a transition to the state' do
+    my_process = MyProcess.new
+    my_process.waiting!
+    my_process.state.must_equal :waiting
+  end
+
+  it 'the `state?` operation must return true if the machine is in `state` and false in other case' do
+    my_process = MyProcess.new
+    my_process.waiting!
+    my_process.waiting?.must_equal true
+    my_process.processing?.must_equal false
+  end
+
+  it 'transition to an invalid state must throw a NoMethodError exception' do
+    my_process = MyProcess.new
+    assert_raises NoMethodError do
+      my_process.meow!
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+ENV["MONGOID_ENV"] = "test"
+
+require 'test_helper'
+require 'mongoid'
+require 'pretends_like_state_machine'
+require 'minitest/autorun'
+
+Mongoid.load!('./test/mongoid.yml')

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: pretends_like_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pablo Torrecilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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: A minimal, trivial, deadly simple state machine for Mongoid
+email:
+- pau@nosolopau.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/pretends_like_state_machine.rb
+- lib/pretends_like_state_machine/mongoid/pretends_like_state_machine.rb
+- lib/pretends_like_state_machine/version.rb
+- lib/tasks/pretends_like_state_machine_tasks.rake
+- test/mongoid.yml
+- test/pretends_like_state_machine_test.rb
+- test/test_helper.rb
+homepage: http://nosolopau.com
+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: A minimal, trivial, deadly simple state machine for Mongoid
+test_files:
+- test/mongoid.yml
+- test/pretends_like_state_machine_test.rb
+- test/test_helper.rb