state-handler 0.0.3 → 0.1.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    state-handler (0.0.2)
+    state-handler (0.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -0,0 +1,32 @@
+[![Build Status](https://secure.travis-ci.org/fatum/state-handler.png)](http://travis-ci.org/fatum/state-handler)
+
+# StateHandler
+
+This is a gem for adding state-based behavior for objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state-handler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state-handler
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/response.rb

@@ -5,11 +5,17 @@ require 'ostruct'
 require 'state-handler'
 
 class ResponseHandler
-  include StateHandler::Mixin
+  include StateHandler::Mixing
 
-  code 200 => :success
-  code 404 => :not_found
-  code 401 => :unauthorized
+  group :success do
+    code 200 => :success
+    code 302 => :already_added
+  end
+
+  group :pass do
+    code 404 => :not_found
+    code 401 => :unauthorized
+  end
 
   match /5\d\d/ => :error
 end

data/lib/state-handler.rb

@@ -1,5 +1,5 @@
 require 'state-handler/version'
-require 'state-handler/mixin'
+require 'state-handler/mixing'
 
 module StateHandler
   class UnexpectedState < Exception

data/lib/state-handler/{mixin.rb → mixing.rb}

@@ -1,16 +1,18 @@
 module StateHandler
-  module Mixin
+  module Mixing
     def self.included(base)
       base.extend ClassMethods
-      base.class_attribute :mapping, :patterns
-      base.mapping, base.patterns = {}, {}
+      %w{mapping patterns groups}.each do |attr|
+        base.class_attribute attr.to_sym
+        base.send "#{attr}=", {}
+      end
     end
 
     attr_reader :response
 
     def initialize(response, &block)
       raise ArgumentError unless response.respond_to?(:code)
-      @response, @blocks = response, {}
+      @response, @blocks, @excludes = response, {}, {}
       exec(&block) if block_given?
     end
 
@@ -18,19 +20,33 @@ module StateHandler
       # map blocks
       yield(self)
 
-      if state
+      if state && @blocks[state]
         @blocks[state].call
-      else
+      end
+
+      if self.class.patterns
         self.class.patterns.each do |s, regex|
           @blocks[s].call if @response.code.to_s =~ regex
         end
       end
+
+      if self.class.groups
+        self.class.groups.each do |group, states|
+          @blocks[group].call if states.include?(state) && @blocks[group]
+        end
+      end
+
+      @excludes.each { |s, callback| callback.call unless s == state }
     end
 
     def at(*args, &block)
       args.each { |s| @blocks[s.to_sym] = block }
     end
 
+    def ex(*args, &block)
+      args.each { |s| @excludes[s.to_sym] = block }
+    end
+
     def state
       self.class.mapping.keys.each.find { |state| find_mapped(state) }
     end
@@ -54,6 +70,7 @@ module StateHandler
       end
     end
 
+  private
     module ClassMethods
       def class_attribute(*attrs)
         attrs.each do |name|
@@ -72,6 +89,8 @@ module StateHandler
       end
 
       def map(&block)
+        # TODO: refactor
+        # Create Dsl class
         class_eval(&block)
       end
 
@@ -79,11 +98,30 @@ module StateHandler
         self.patterns[regexp.values.first] = regexp.keys.first
       end
 
+      def method_missing
+      end
+
       def code(*codes, &block)
         if codes.first.kind_of?(Hash)
-          self.mapping[codes.first.values.first] = codes.first.keys.first
+          create(codes.first.values.first, codes.first.keys.first)
         elsif block_given?
-          self.mapping[yield] = codes
+          create(yield, codes)
+        end
+      end
+
+      def group(name, &block)
+        @current_group = name.to_sym
+        class_eval(&block)
+        @current_group = nil
+      end
+
+    private
+      def create(state, value)
+        raise ArgumentError, "State '#{state}' already defined" if self.mapping[state]
+        self.mapping[state] = value
+        if @current_group
+          self.groups[@current_group] ||= []
+          self.groups[@current_group] << state
         end
       end
     end

data/lib/state-handler/version.rb

@@ -1,3 +1,3 @@
 module StateHandler
-  VERSION = '0.0.3'
+  VERSION = '0.1.1'
 end

data/spec/lib/state-handler/mixing_spec.rb

@@ -6,13 +6,16 @@ describe StateHandler::Mixing do
       include StateHandler::Mixing
 
       map do
-        code 200 => :enabled
-        code 400 => :false
-
-        match /5\d\d/ => :error
+        group :success do
+          code 200 => :enabled
+          code 400 => :false
+        end
 
-        code 401, 402 do
-          :bad_params
+        group :errors do
+          match /5\d\d/ => :error
+          code 401, 402 do
+            :bad_params
+          end
         end
       end
     end
@@ -24,6 +27,47 @@ describe StateHandler::Mixing do
       end
     end
   end
+
+  describe "#exclude" do
+    it "should call valid block" do
+      expect {
+        DummyResponse.new(OpenStruct.new(:code => 400)) do |r|
+          r.ex :bad_params do
+            raise ArgumentError
+          end
+        end
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should not call block" do
+      expect {
+        DummyResponse.new(OpenStruct.new(:code => 401)) do |r|
+          r.ex :bad_params do
+            raise ArgumentError
+          end
+        end
+      }.should_not raise_error
+    end
+  end
+
+  describe "fails" do
+    context "when handler not matched" do
+      it "should do nothing" do
+        expect {
+          DummyResponse.new(OpenStruct.new(:code => 4001)) {  }
+        }.should_not raise_error
+      end
+    end
+
+    context "when no handlers" do
+      it "should do nothing" do
+        expect {
+          DummyResponse.new(OpenStruct.new(:code => 401)) {  }
+        }.should_not raise_error
+      end
+    end
+  end
+
   subject {
     DuplicateDeclarationResponse.new(response_struct)
     DummyResponse.new(response_struct)
@@ -45,6 +89,30 @@ describe StateHandler::Mixing do
       }.should raise_error(ExecException)
     end
 
+    describe "#group" do
+      let(:response_struct) { OpenStruct.new(:code => 200) }
+
+      it "should call block from excluded group :errors" do
+        expect {
+          subject.exec do |r|
+            r.ex :errors do
+              raise ExecException
+            end
+          end
+        }.should raise_error(ExecException)
+      end
+
+      it "should call block mapped to group :success" do
+        expect {
+          subject.exec do |r|
+            r.success do
+              raise ExecException
+            end
+          end
+        }.should raise_error(ExecException)
+      end
+    end
+
     describe "#match" do
      let(:response_struct) { OpenStruct.new(:code => 500) }
      it "should call matched block" do
@@ -80,7 +148,6 @@ describe StateHandler::Mixing do
 
   describe "#codes" do
     let(:response_struct) { OpenStruct.new(:code => 401) }
-
     its(:bad_params?) { should be_true }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state-handler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70195101020240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70195101020240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70195101018660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70195101018660
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70195101006480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,12 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70195101006480
 description: State handler per object params
 email: fatumka@gmail.com
 executables: []
@@ -67,12 +52,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
+- Rakefile
 - examples/response.rb
 - lib/state-handler.rb
-- lib/state-handler/mixin.rb
+- lib/state-handler/mixing.rb
 - lib/state-handler/version.rb
 - spec/lib/state-handler/mixing_spec.rb
 - spec/spec_helper.rb
@@ -97,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: State handler per object params