stair_master 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile.lock

@@ -1,56 +1,102 @@
 PATH
   remote: .
   specs:
-    stair_master (0.0.1)
+    stair_master (0.0.2)
       activesupport (>= 3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.1)
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
+    arel (4.0.1)
     atomic (1.1.14)
+    builder (3.1.4)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    erubis (2.7.0)
     ffi (1.9.3)
     formatador (0.2.4)
-    guard (2.2.3)
+    guard (2.2.5)
       formatador (>= 0.2.4)
       listen (~> 2.1)
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
-    guard-rspec (4.0.3)
-      guard (>= 2.1.1)
-      rspec (~> 2.14)
+    guard-rspec (2.3.3)
+      guard (>= 1.1)
+      rspec (~> 2.11)
     guard-spork (1.5.1)
       childprocess (>= 0.2.3)
       guard (>= 1.1)
       spork (>= 0.8.4)
+    hike (1.2.3)
     i18n (0.6.9)
-    listen (2.2.0)
+    listen (2.4.0)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.4)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.2)
     method_source (0.8.2)
+    mime-types (1.25.1)
     minitest (4.7.5)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
     multi_json (1.8.4)
-    pry (0.9.12.3)
+    polyglot (0.3.3)
+    pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.1.1)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
       ffi (>= 0.5.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -60,12 +106,34 @@ GEM
     rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
-    slop (3.4.6)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    slop (3.4.7)
     spork (0.9.2)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
     thor (0.18.1)
     thread_safe (0.1.3)
       atomic
+    tilt (1.4.1)
     timers (1.1.0)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
     tzinfo (0.3.38)
 
 PLATFORMS
@@ -73,8 +141,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
-  guard-rspec
+  guard-rspec (~> 2.3.3)
   guard-spork (~> 1.5.0)
-  rake
-  rspec
+  mocha (~> 0.13.1)
+  rails (~> 4.0.0)
+  rake (~> 10.1.0)
+  rspec (~> 2.14.1)
+  rspec-rails (~> 2.14.1)
+  sqlite3
   stair_master!

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'spork', :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('Gemfile')
+  watch('Guardfile')
+  watch('Gemfile.lock')
+  watch('lib/stair_master.rb')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard :rspec, :all_after_pass => false, :all_on_start => false, :cli => '--drb' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/digital_opera/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/Rakefile

@@ -1 +1,29 @@
-require "bundler/gem_tasks"
+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    = 'StairMaster'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Dir[File.join(File.dirname(__FILE__), 'lib/tasks/**/*.rake')].each {|f| load f }
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/concerns/stair_master/controller.rb

@@ -13,12 +13,23 @@ module StairMaster
 
     included do
       helper_method :workflow_map
+      before_filter :check_step_availability
     end
 
     def workflow_map
       @stair_master_workflow_map ||= self.class.workflow_map.new
     end
 
+    private # ---------------------------------------------
+
+    def check_step_availability
+      if is_available_step?
+        redirect_to next_step.url_for if step_should_be_skipped?
+      else
+        redirect_to first_step.url_for
+      end
+    end
+
     module ClassMethods
       def workflow_map(map_class=nil)
         return (@@stair_master_workflow_map || ::StairMaster::WorkflowMap) if map_class.nil?

data/lib/stair_master/concerns/getters.rb

@@ -7,6 +7,8 @@ module StairMaster
     module Getters
       extend ActiveSupport::Concern
 
+      private # -------------------------------------------
+
       def get_step_index_by_name(step_name)
         available_steps.find_index step_name
       end
@@ -23,39 +25,47 @@ module StairMaster
         workflow_map.steps[step_name]
       end
 
+      ## NEXT STEP ----------------------------------------
       def get_next_step_index
         on_last_step? ? nil : find_next_step_index
       end
 
-      def get_previous_step_index(step_index=nil)
-        on_first_step? ? nil : find_previous_step_index
-      end
-
-      private # -------------------------------------------
-
-      def find_previous_step_index(step_index=nil)
-        previous_index  = step_index.nil? ? current_step_index.pred : step_index.pred
-        step            = get_step_by_index previous_index
+      def find_next_step_index(step_index=nil)
+        next_index  = step_index.nil? ? current_step_index.next : step_index.next
+        step        = get_step_by_index next_index
 
         if step.nil?
           nil
         elsif step.skip?(self)
-          find_previous_step_index(previous_index)
+          if is_last_step?(step.key)
+            return nil
+          else
+            find_next_step_index(next_index)
+          end
         else
-          previous_index
+          next_index
         end
       end
 
-      def find_next_step_index(step_index=nil)
-        next_index  = step_index.nil? ? current_step_index.next : step_index.next
-        step        = get_step_by_index next_index
+      ## GET PREVIOIUS STEP INDEX -------------------------
+      def get_previous_step_index(step_index=nil)
+        on_first_step? ? nil : find_previous_step_index
+      end
+
+      def find_previous_step_index(step_index=nil)
+        previous_index  = step_index.nil? ? current_step_index.pred : step_index.pred
+        step            = get_step_by_index previous_index
 
         if step.nil?
           nil
         elsif step.skip?(self)
-          find_next_step_index(next_index)
+          if is_first_step?(step.key)
+            return nil
+          else
+            find_previous_step_index(previous_index)
+          end
         else
-          next_index
+          previous_index
         end
       end
     end

data/lib/stair_master/concerns/tests.rb

@@ -14,11 +14,11 @@ module StairMaster
 
       ## Methods ------------------------------------------
       def on_last_step?
-        @stair_master_on_last_step ||= current_step_name == available_steps.last
+        @stair_master_on_last_step ||= is_last_step?(current_step_name)
       end
 
       def on_first_step?
-        @stair_master_on_first_step ||= current_step_name == available_steps.first
+        @stair_master_on_first_step ||= is_first_step?(current_step_name)
       end
 
       def is_last_step?(step_name)
@@ -28,6 +28,16 @@ module StairMaster
       def is_first_step?(step_name)
         step_name == available_steps.first
       end
+
+      def is_available_step?(step=nil)
+        step_name = step.nil? ? controller_name.to_sym : step.key
+        available_steps.include? step_name
+      end
+
+      def step_should_be_skipped?(step=nil)
+        step = step.nil? ? current_step : step
+        step.skip?(self)
+      end
     end
   end
 end

data/lib/stair_master/concerns/traversal.rb

@@ -19,6 +19,14 @@ module StairMaster
                       :previous_step_name
       end
 
+      def first_step
+        @stair_master_first_step ||= get_step_by_name available_steps.first
+      end
+
+      def last_step
+        @stair_master_last_step ||= get_step_by_name available_steps.last
+      end
+
       ## Current Step -------------------------------------
       def current_step_index
         @stair_master_current_step_index ||= get_step_index_by_name current_step_name

data/lib/stair_master/engine.rb

@@ -2,5 +2,8 @@
 
 module StairMaster
   class Engine < Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/stair_master/step.rb

@@ -2,8 +2,10 @@
 module StairMaster
   class Step
     attr_accessor :label, :path, :conditions
+    attr_reader   :key
 
-    def initialize(label, path, conditions)
+    def initialize(key, label, path, conditions)
+      @key        = key
       @label      = label
       @path       = path
       @conditions = build_conditions conditions
@@ -12,7 +14,7 @@ module StairMaster
     ## Methods --------------------------------------------
 
     def available?(context)
-      rules   = @conditions[:availability]
+      rules = @conditions[:availability]
       ( rules.empty? ? [true] : test_rules(rules, context) ).all?
     end
 
@@ -35,6 +37,10 @@ module StairMaster
       end
     end
 
+    def to_s
+      label
+    end
+
     private # ---------------------------------------------
 
     def build_conditions(conditions)

data/lib/stair_master/version.rb

@@ -1,3 +1,3 @@
 module StairMaster
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/stair_master/workflow_map.rb

@@ -19,7 +19,7 @@ module StairMaster
     end
 
     def add_step(controller_name, label, named_path, *conditions)
-      @steps[controller_name] = ::StairMaster::Step.new(label, named_path, conditions)
+      @steps[controller_name] = ::StairMaster::Step.new(controller_name, label, named_path, conditions)
     end
 
     def set_order(*steps)

data/spec/controllers/base/getters_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'getter methods' do
+  describe '#get_step_index_by_name' do
+    before(:all){
+      @controller = Base::StepOneController.new
+    }
+  end
+end

data/spec/controllers/base/ordering_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'ordering methods' do
+  describe '#available_steps' do
+    before(:all){
+      @controller = Base::StepOneController.new
+    }
+
+    describe '#available_steps' do
+      it 'should contain all steps' do
+        get :show
+
+        subject.available_steps.should eq [:step_one, :step_two, :step_three]
+      end
+    end
+
+    describe '#step_is_available?' do
+      it 'should return true if in list' do
+        get :show
+
+        subject.should be_step_is_available(:step_one)
+        subject.should be_step_is_available(:step_two)
+        subject.should be_step_is_available(:step_three)
+      end
+
+      it 'should return false if not available' do
+        StairMaster::Step.any_instance.stubs(:available?).returns(false)
+        get :show
+
+        subject.should_not be_step_is_available(:step_one)
+      end
+
+      it 'should throw error if not apart of inital list' do
+        get :show
+
+        expect{ subject.step_is_available?(:step_four) }.to raise_error
+      end
+    end
+  end
+end

data/spec/controllers/base/tests_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe 'test methods' do
+  describe '#on_last_step?' do
+    context 'if first item' do
+      before(:all){
+        @controller = Base::StepOneController.new
+      }
+
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_on_last_step
+      end
+    end
+
+    context 'if middle item' do
+      before(:all){
+        @controller = Base::StepTwoController.new
+      }
+
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_on_last_step
+      end
+    end
+
+    context 'if last item' do
+      before(:all){
+        @controller = Base::StepThreeController.new
+      }
+
+      it 'should return true' do
+        get :show
+
+        subject.should be_on_last_step
+      end
+    end
+  end
+
+  describe '#on_first_step?' do
+    context 'if first item' do
+      before(:all){
+        @controller = Base::StepOneController.new
+      }
+
+      it 'should return true' do
+        get :show
+
+        subject.should be_on_first_step
+      end
+    end
+
+    context 'if middle item' do
+      before(:all){
+        @controller = Base::StepTwoController.new
+      }
+
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_on_first_step
+      end
+    end
+
+    context 'if last item' do
+      before(:all){
+        @controller = Base::StepTwoController.new
+      }
+
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_on_first_step
+      end
+    end
+  end
+
+  describe '#is_last_step?' do
+    before(:all){
+      @controller = Base::StepOneController.new
+    }
+
+    context 'if first item' do
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_is_last_step(:step_one)
+      end
+    end
+
+    context 'if middle item' do
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_is_last_step(:step_two)
+      end
+    end
+
+    context 'if last item' do
+      it 'should return true' do
+        get :show
+
+        subject.should be_is_last_step(:step_three)
+      end
+    end
+  end
+
+  describe '#is_first_step?' do
+    before(:all){
+      @controller = Base::StepOneController.new
+    }
+
+    context 'if first item' do
+      it 'should return true' do
+        get :show
+
+        subject.should be_is_first_step(:step_one)
+      end
+    end
+
+    context 'if middle item' do
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_is_first_step(:step_two)
+      end
+    end
+
+    context 'if last item' do
+      it 'should return false' do
+        get :show
+
+        subject.should_not be_is_first_step(:step_three)
+      end
+    end
+  end
+end