solidstate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10ee93a954561985d002e7f8db5ffe186a792bba
+  data.tar.gz: e979280cea908e17a924718f7f20a247d79c11b9
+SHA512:
+  metadata.gz: 3480386e65adfdd682c7bd05a4a67d49a50660ac102b16fc7cbe7c334d50ab3829989b0e710af6a6e6f8d54d7b1ec352736727adb2f7955a2664a4103c70ce01
+  data.tar.gz: 1ccbbca8ab19e933ff4894036fdf46f9c48daa1c264d37d573917303848f1b34d90e269f2de771a451e508028d697ebf381c8d3cacabf497701e61c41f0c9ace

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# specified in tuktuk.gemspec
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+SolidState
+==========
+
+Minuscule but solid state machine for Ruby classes. The only dependency is that your model responds to a getter and setter for `state`.
+
+``` ruby
+
+  # simplest example, using just an accessor
+  class Post
+    include SolidState
+
+    attr_accessor :state
+    states :draft, :published
+  end
+
+  # in its simplest form you just declare the possible states.
+  # if it's a simple class you just get boolean methods for checking
+  # whether the current status is X or Y.
+
+  p = Post.new
+  p.state      # => 'draft'
+  p.draft?     # true
+  p.published? # => false
+  p.state = 'published'
+  p.published? # => true
+
+  # now, if the model class responds to validates_inclusion_of, it will
+  # mark the record invalid if an unknown state is set.
+
+  # let's assume this is actually an ActiveRecord class, and the
+  # table contains a column named 'state'.
+
+  class Post < ActiveRecord::Base
+    include SolidState
+
+    states :draft, :published
+  end
+
+  p = Post.new
+  p.state = 'published'
+  p.valid?  # => true
+  p.state = 'deleted'
+  p.valid?  # => false
+
+  # ok, now let's gets get fancier. we're going to declare transitions
+  # which will govern the possible directions in which an object's state
+  # can move to.
+
+  class Subscriber < ActiveRecord::Base
+    include SolidState
+
+    states :inactive, :active, :unsubscribed, :disabled do
+      transitions :from => :inactive, :to => :active
+      transitions :from => :active, :to => [:unsubscribed, :disabled]
+      transitions :from => :unsubscribed, :to => :active
+    end
+  end
+
+  s = Subscriber.new
+  s.state     # => 'inactive'
+
+  # since we declared transitions, we can now call #{state}! which
+  # checks whether the instance can transition to that state and
+  # if so, sets the new state and optionally saves the record.
+
+  s.active!   # => true
+
+  s.inactive! # => raises InvalidTransitionError
+
+  # this also works outside transition methods, of course.
+  s.reload    # => true
+  s.active?   # => true
+
+  s.state = 'inactive'
+  s.valid?    # => false
+
+  # the last trick this library does is that it optionally lets you
+  # declare callback methods that are called whenever a transition
+  # method succeeds. just define a method called #once_[state] in
+  # your model.
+
+  class Subscriber
+    def once_unsubscribed
+      puts "Sorry to see you go!"
+    end
+  end
+
+  # ...
+  s.unsubscribed! # => prints "Sorry to see you go!"
+```
+
+That's about it. For examples check the `examples` directory in this repo.
+
+# Contributions
+
+You're more than welcome. Send a pull request, including tests, and make sure you don't break anything. That's it.
+
+# Author
+
+Tomás Pollak
+
+# Copyright
+
+(c) Fork Limited. MIT license.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/solidstate.rb

@@ -0,0 +1,92 @@
+module SolidState
+  extend ActiveSupport::Concern
+
+  class InvalidTransitionError < ArgumentError; end
+
+  STATE_ATTRIBUTE = :state.freeze
+
+  module ClassMethods
+
+    def states(*list, &block)
+      raise "This is not a list of names" unless list.first.is_a?(String)
+      list = list.collect(&:to_s)
+
+      @@states = list
+      @@state_transitions = {}
+
+      def self.states
+        @@states
+      end
+
+      def self.state_transitions
+        @@state_transitions
+      end
+
+      if respond_to?(:validates_inclusion_of)
+        validates_inclusion_of STATE_ATTRIBUTE, in: list
+      end
+
+      scope :with_state, lambda { |state|
+        return query if state.blank?
+        where(STATE_ATTRIBUTE => state)
+      } if respond_to?(:scope)
+
+      list.each do |s|
+        scope(s, lambda { where(STATE_ATTRIBUTE => s) }) if respond_to?(:scope)
+
+        define_method "#{s}?" do
+          state.to_sym == s.to_sym
+        end
+      end
+
+      yield if block_given?
+    end
+
+    def transitions(opts)
+      validate :ensure_valid_transition if respond_to?(:validate)
+
+      from = opts.delete(:from) or raise ":from required"
+      to   = opts.delete(:to)   or raise ":to required"
+      to   = [to] unless to.is_a?(Array)
+
+      # puts "From #{from} to #{to.join(' or ')}"
+      to.each do |dest|
+
+        state_transitions[from.to_sym] ||= []
+        state_transitions[from.to_sym].push(dest.to_sym)
+
+        define_method("#{dest}!") do
+          unless set_state(dest.to_sym)
+            raise InvalidTransition.new("Cannot transition from #{state} to #{dest}")
+          end
+
+          if !respond_to?(:valid?) or (valid? && save)
+            send("once_#{dest}", from) if respond_to?("once_#{dest}")
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+
+  def set_state(new_state)
+    return false unless can_transition_to?(new_state)
+    self.state = new_state
+  end
+
+  def ensure_valid_transition
+    if send("#{STATE_ATTRIBUTE}_changed?") and !can_transition_to?(state)
+      errors.add(STATE_ATTRIBUTE, "can't transition from current state to #{state}")
+    end
+  end
+
+  def can_transition_to?(new_state)
+    return true if state.to_sym == new_state.to_sym
+
+    possible = self.class.state_transitions[state.to_sym] || []
+    possible.include?(new_state.to_sym)
+  end
+
+end

data/solidstate.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "solidstate"
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Tomás Pollak']
+  s.email       = ['tomas@forkhq.com']
+  s.homepage    = "https://github.com/tomas/solidstate"
+  s.summary     = "Minuscule state machine."
+  s.description = "Minuscule state machine."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", '~> 3.0', '>= 3.0.0'
+  s.add_development_dependency "activerecord" #, ">= 4.0.0"
+  s.add_development_dependency "sqlite3" #, ">= 4.0.0"
+  s.add_development_dependency "mongo_mapper" #, ">= 4.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: solidstate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomás Pollak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: mongo_mapper
+  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: Minuscule state machine.
+email:
+- tomas@forkhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/solidstate.rb
+- solidstate.gemspec
+homepage: https://github.com/tomas/solidstate
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Minuscule state machine.
+test_files: []
+has_rdoc: