mutator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d69e47c148240cf6a7f6000f259980b0ef39caa6
-  data.tar.gz: b1aa0ed144d14bd76ab91a1884f7d005519afbb3
+  metadata.gz: 0df3406ff9b500ebbec5794cc2c69271567cbb87
+  data.tar.gz: da50d33014377da65646a4b2af574361be31a575
 SHA512:
-  metadata.gz: ae7fdbe701040f8116984b8ed5222231f97333dfa1b62068eec392b3aa9ea5f05cf40ed60d3a33b5ab3616f1175ef910e5b9d6ddeeb268b22806f4d7f2865fc5
-  data.tar.gz: 94afab94f0b66e4b76d1c6f5086fb5080db2040eab6215dc55254ee0b365932a133f0fcdc7597497ba659eead9d185c19d6591e6c39ca117498a2028cc3572c9
+  metadata.gz: 9d7f981148e536e969f4e51ba1d5406c61e3949c678303ca08def21a7382891c49de38dd09c9880eeb466826169bcea7c12e0594235453e667e4c240a3c356d2
+  data.tar.gz: 3dac9b17bbc154dac16f4a7185b5762f6e2a68c0f5962e7e78817d95c6b71b1d59b47600ac2e6a2a3662b1710d4eed3cde49c39bd93f3ae66de8f6dfbf18165a

data/.hound.yml

@@ -3,3 +3,22 @@ StringLiterals:
 
 AccessModifierIndentation:
   EnforcedStyle: outdent
+
+MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Documentation:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+Blocks:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'mutator.gemspec'

data/README.md

@@ -40,15 +40,24 @@ module Mutator
   class Wonder < Machine
     def self.transitions
       [
-        { to: :sealed, from: [:signed] },
-        { to: :delivered, from: [:sealed] },
-        { to: :yours, from: [:delivered] }
+        { to: :sealed, from: :signed },
+        { to: :delivered, from: :sealed },
+        { to: :yours, from: :delivered }
       ]
     end
   end
 end
 ```
 
+You can add multiple states to transition from like so:
+
+``` ruby
+def self.transitions
+  [
+    { to: :yours, from: [:signed, :sealed, :delivered] }
+  ]
+```
+
 ### So how do I use it?
 
 Transitions look like this:

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/mutator/helpers.rb

@@ -4,10 +4,10 @@ module Mutator
       @machine ||= machine_class.new(self)
     end
 
-    def self.included(base)
+    def self.included base
       Mutator.const_get(base.name, false).states.each do |state|
         base.send(:define_singleton_method, state) do
-          self.where(state: state)
+          where state: state
         end
       end
     end
@@ -15,7 +15,7 @@ module Mutator
   protected
 
     def machine_class
-      Mutator.const_get(self.class.name, false)
+      Mutator.const_get self.class.name, false
     end
   end
 end

data/lib/mutator/machine.rb

@@ -2,7 +2,7 @@ module Mutator
   class Machine
     attr_reader :stateholder
 
-    def initialize(stateholder)
+    def initialize stateholder
       @stateholder = stateholder
     end
 
@@ -14,21 +14,21 @@ module Mutator
       stateholder.state
     end
 
-    def transition(options)
-      options = extract(options)
-      success, failure, transition = options.values
+    def transition options
+      options = extract options
+      transition, success, failure = options.values
 
       if transition.call
-        success.call(transition)
+        success.call transition
         true
       else
-        failure.call(transition)
+        failure.call transition
         false
       end
     end
 
     def self.states
-      self.transitions.map do |transition|
+      transitions.map do |transition|
         to, from = transition[:to], transition[:from]
         [to, from]
       end.flatten.uniq
@@ -44,19 +44,14 @@ module Mutator
 
   protected
 
-    def extract(options)
-      to = options[:to]
-      fail ArgumentError, 'must provide state to transition to' unless to
+    def extract options
+      to = options.fetch(:to)
 
       {
+        transition: Transition.new(to: to, from: current_state, machine: self),
         success: lambda { |_| },
-        failure: lambda { |_| },
-        transition: Transition.new(
-          to: to,
-          from: current_state,
-          machine: self
-        )
-      }.merge(options)
+        failure: lambda { |_| }
+      }.merge options
     end
   end
 end

data/lib/mutator/transition.rb

@@ -2,9 +2,10 @@ module Mutator
   class Transition
     attr_reader :to, :from, :machine
 
-    def initialize(opts)
-      require_parameters!(opts)
-      @to, @from, @machine = opts[:to], opts[:from], opts[:machine]
+    def initialize opts
+      @to = opts.fetch(:to)
+      @from = opts.fetch(:from)
+      @machine = opts.fetch(:machine)
     end
 
     def call
@@ -19,25 +20,19 @@ module Mutator
       machine.stateholder
     end
 
-    def ==(other)
+    def == other
       to == other.to && from == other.from && machine == other.machine
     end
 
-    def eql?(other)
-      public_send(:==, other)
+    def eql? other
+      public_send :==, other
     end
 
   protected
 
     def transitions
       machine.transitions.select do |transition|
-        transition[:to] == to && transition[:from].include?(from)
-      end
-    end
-
-    def require_parameters!(opts)
-      [:to, :from, :machine].each do |attr|
-        fail ArgumentError, "must provide #{attr}" unless opts[attr]
+        transition[:to] == to && Array(transition[:from]).include?(from)
       end
     end
   end

data/lib/mutator/version.rb

@@ -1,3 +1,3 @@
 module Mutator
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/mutator.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Mutator::VERSION
   spec.authors       = ["Eric Roberts"]
   spec.email         = ["ericroberts@gmail.com"]
-  spec.summary       = %q{Mutator is just another state machine gem.}
-  spec.description   = %q{Yet another state machine gem. I didn't find one I liked, so I made one. I probably didn't look hard enough.}
+  spec.summary       = "Mutator is just another state machine gem."
+  spec.description   = "Yet another state machine gem. I didn't find one I liked, so I made one. I probably didn't look hard enough."
   spec.homepage      = "https://github.com/ericroberts/mutator"
   spec.license       = "MIT"
 

data/spec/lib/mutator/machine_spec.rb

@@ -41,10 +41,16 @@ describe Mutator::Stateholder do
     end
 
     context 'arguments' do
-      it 'should raise an exception if you do not provide to' do
+      it 'should raise an exception if you do not provide any arguments' do
         expect { subject.transition }.to raise_error ArgumentError
       end
 
+      it 'should raise a specific key error if you provide an arg but not to' do
+        expect {
+          subject.transition success: 'something'
+        }.to raise_error KeyError
+      end
+
       it 'should not raise if to is provided' do
         expect { subject.transition to: :any_state }.to_not raise_error
       end
@@ -138,7 +144,9 @@ describe Mutator::Stateholder do
           before { expect(failure).to receive(:call).and_raise(Exception) }
 
           it 'should raise an exception' do
-            expect { subject.transition(to: to, failure: failure) }.to raise_error Exception
+            expect {
+              subject.transition(to: to, failure: failure)
+            }.to raise_error Exception
           end
         end
       end

data/spec/lib/mutator/transition_spec.rb

@@ -18,7 +18,9 @@ describe Mutator::Transition do
         it "should require you to pass #{attr}" do
           args = { to: :something, from: :something, machine: :something }
           args.delete attr
-          expect { subject.class.new(args) }.to raise_error ArgumentError, "must provide #{attr}"
+          expect {
+            subject.class.new(args)
+          }.to raise_error KeyError
         end
       end
     end

data/spec/support/test_classes.rb

@@ -2,7 +2,7 @@ module Mutator
   class Stateholder < Machine
     def self.transitions
       [
-        { from: [:initial_state], to: :second_state },
+        { from: :initial_state, to: :second_state },
         { from: [:second_state], to: :third_state }
       ]
     end
@@ -18,6 +18,6 @@ class Stateholder
     @state ||= :initial_state
   end
 
-  def self.where(*)
+  def self.where *_
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler