stepstepstep 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Blake Taylor
+
+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/README.markdown

@@ -0,0 +1,52 @@
+Stepstepstep
+=================================================
+Rails before_filters don't take it far enough. What stepstepstep allows you to do is define before_filters's dependecies in the same way you do with rake tasks.
+
+Install
+-------------------------------------------------
+Stick this in your Gemfile.
+```ruby
+gem 'stepstepstep'
+```
+
+Usage
+-------------------------------------------------
+
+#### Include the DSL && Defining steps
+
+```ruby
+class FooController < ApplicationController
+  include Stepstepstep
+
+  step :two => [:one_point_three, :one_point_seven] do
+    @a << 2
+  end
+  step :one_point_three => :one do
+    @a << 1.3
+  end
+  step :one do
+    @a = [1]
+  end
+  step :one_point_seven => :one_point_three, :only => :index do
+    @a << 1.7
+  end
+
+  def index
+    render :inline => @a.inspect # => [1, 1.3, 1.7, 2].inspect
+  end
+
+  def another
+    render :inline => @a.inspect # => [1, 1.3, 2].inspect
+  end
+end
+```
+
+Why does stepstepstep.gem exists?
+-------------------------------------------------
+A few months ago, I was writing a single page application about learning mobile development technology at http://learn.eoe.cn. This page contains lessons, a video, classes, teachers, students, reference material, question-to-answers, exams, chat messages, and their current all learning statuses and dependencies. In brief, there are fifteen steps to load this page, including privileges to judge, fourteen illegal `redirect_to` , etc. So I need to write a step dependencies management tool, like rake tasks.
+
+At first, I thought maybe I could define several `proc`s in a single before_filter, but the execution context is really complicated. Then one day, I found action_jackson.gem, which was written by [Blake Taylor](https://github.com/blakefrost/action_jackson) two years ago. The core implementation of this gem is to define each action as a method, and at last call a class method `register_filters` to register all these methods as `before_filter` independently. Of course, they're ordered by the earlier declarations. This implementation is not elegant, but the idea is really awesome, it doesn't break Rails's rules.
+
+Then I got a deep understanding of the Rails controllers filters's implementation mechanism. Maybe `skip_before_filter` helped. In each `step`, I insert it first, extract all the inserted steps by `skip_before_filter`, then sort them by TSort(a topological sorting algorithm provided by Ruby standard library), and at last append them again to before_filters. It works, and all rspecs are passed.
+
+I renamed it from action_jackson to stepstepstep, because the DSL is only a `step` class method, which handles all the details. Most of the implementations were rewritten, and I added rspecs . Thanks Blake Taylor :)

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/stepstepstep.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+module Stepstepstep
+  extend ActiveSupport::Concern
+
+  # Topological sorting using Tarjan's algorithm for strongly connected components.
+  require 'tsort'
+  class StepsInTSort < Hash
+    include TSort
+    alias tsort_each_node each_key
+    def tsort_each_child(node, &block)
+      (self[node] || []).each(&block)
+    end
+  end
+
+  included do
+    cattr_accessor :_steps_set, :_step_to_deps, :_before_filter_opts_hash
+    self._steps_set ||= Set.new
+    self._step_to_deps ||= StepsInTSort.new
+    self._before_filter_opts_hash ||= Hash.new { Hash.new }
+  end
+
+  module ClassMethods
+    def step(opts, opts2 = nil, &blk)
+      # adjust params
+      opts = opts2.merge(opts => nil) if opts2.is_a?(Hash)
+
+      # prepare data
+      __opts = {}
+      if opts.is_a?(Hash)
+        [:only, :except, :if].each do |symbol|
+          __opts[symbol] = opts.delete(symbol) if opts[symbol]
+        end
+        step_name, __deps = opts.first
+        step_name = step_name.to_sym
+        add_step_to_dep step_name, __deps
+        self._before_filter_opts_hash[step_name] = __opts
+      elsif opts.is_a?(Symbol) || opts.is_a?(String)
+        step_name = opts.to_sym
+        add_step_to_dep step_name
+      else
+        raise "Please use Hash, Symbol, String for opts"
+      end
+
+      # define method
+      if self._steps_set.include?(step_name)
+        if not self.instance_methods.include?(step_name)
+          blk ||= (Proc.new {})
+          define_method(step_name, blk)
+        else
+          Rails.logger.info "#{self.class.name}##{step_name} is already defined!"
+        end
+      end
+
+      # 1. append first
+      send(:before_filter, step_name, self._before_filter_opts_hash[step_name])
+
+      # 2. extract all
+      self._steps_set.each {|n1| self.skip_before_filter n1 }
+
+      # 3. resort
+      _steps = self._step_to_deps.tsort
+      _steps.each do |n1|
+        # 4. reappend all
+        if self.instance_methods.include?(n1)
+          puts "filter to opts: #{n1}, #{self._before_filter_opts_hash}" if ENV['DEBUG_STEPSTEPSTE']
+          self.send(:before_filter, n1, self._before_filter_opts_hash[n1])
+        end
+      end
+    end
+
+    private
+    def add_step_to_dep n1, deps = nil
+      self._steps_set.add n1
+
+      deps = Array(deps).compact
+      deps.each {|i| self._steps_set.add i }
+
+      self._step_to_deps[n1] = deps
+    end
+  end
+
+end

data/spec/controllers/foo_controller_spec.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+
+describe FooController do
+  it "@a is sort correctly" do
+    callbacks = FooController.new._process_action_callbacks
+    puts "FooController.new._process_action_callbacks.size is #{callbacks.size}, filters are #{callbacks.map(&:filter)}"
+
+    get :index
+    response.body.should == [1, 1.3, 1.7, 2].inspect
+  end
+
+  it "@a should skip 1.7" do
+    get :another
+    response.body.should == [1, 1.3, 2, "another"].inspect
+  end
+end
+
+describe NextController do
+  it "skip if next in step method" do
+    get :index
+    response.body.should == [1, 1.3, 1.7, 2].inspect
+  end
+end
+
+describe RemoveController do
+  it "remove one step" do
+    get :index
+    response.body.should == [1, 1.7, 2].inspect
+  end
+end
+describe AfterRemoveController do
+  it "after remove one step" do
+    get :index
+    response.body.should == [1, 1.3, 1.7, 2].inspect
+  end
+end
+
+describe InsertController do
+  it "Insert one step" do
+    get :index
+    response.body.should == [1, 1.1, 1.3, 1.7, 2].inspect
+  end
+end
+
+describe SubController do
+  it "only should be skiped" do
+    get :index
+    response.body.should == [1, 1.3, 1.7, 2].inspect
+  end
+  it "only another" do
+    get :another
+    response.body.should == [1, 1.3, 2, 3, "another"].inspect
+  end
+end
+
+describe Sub2Controller do
+  it "one_point_three should be excepted" do
+    get :index
+    response.body.should == [1, 1.7, 2].inspect
+  end
+end
+
+
+describe RedirectToController do
+  it "support redirect_to" do
+    get :index
+    response.should redirect_to("/redirect_to")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+
+require 'active_support/core_ext'
+require 'action_controller'
+require 'active_model'
+require 'rails/all'
+
+
+require 'rspec/rails'
+require 'pry-debugger'
+require File.join(ENV['HOME'], 'utils/ruby/irb.rb') rescue nil
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'stepstepstep'
+
+Rails.logger ||= Logger.new($stderr)
+ENV['DEBUG_STEPSTEPSTE'] = 'true' if `whoami`.strip == 'mvj3'
+
+
+# https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/engine-routes-for-controllers
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+
+class BarController < ActionController::Base
+  # Fix In order to use #url_for, you must include routing helpers explicitly. For instance, `include Rails.application.routes.url_helpers
+  # thx https://github.com/apotonick/apotomo/issues/35#issuecomment-3936941
+  # TODO blankslate.rails_engine.rspec.gem
+  include Rails.application.routes.url_helpers
+  def _routes; ::Rails.application.routes end
+  def controller; parent_controller end
+
+end
+
+class FooController < BarController
+  include Stepstepstep
+
+  step :two => [:one_point_three, :one_point_seven] do
+    @a << 2
+  end
+  step :one_point_three => :one do
+    @a << 1.3
+  end
+  step :one do
+    @a = [1]
+  end
+  step :one_point_seven => :one_point_three, :only => :index do
+    @a << 1.7
+  end
+
+  def index
+    render :inline => @a.inspect
+  end
+
+  def another
+    @a << 'another'
+    render :inline => @a.inspect
+  end
+end
+
+
+class NextController < FooController
+  step :test_next_with_three => :two do
+    next if true
+    @a << 3
+  end
+end
+
+class RemoveController < FooController
+  skip_filter :one_point_three
+end
+class AfterRemoveController < FooController
+end
+class InsertController < FooController
+  step :one_point_one => :one do
+    @a << 1.1
+  end
+  step :one_point_three => :one_point_one
+end
+class SubController < FooController
+  step :only_action => :two, :only => :another do
+    @a << 3
+  end
+
+  def another
+    @a << 'another'
+    render :inline => @a.inspect
+  end
+end
+class Sub2Controller < SubController
+  step :one_point_three, :except => [:index]
+  step :two => [:one, :one_point_seven] # remember to connect the broken edges
+end
+
+class RedirectToController < FooController
+  def index
+    redirect_to "/redirect_to" and return
+  end
+end
+
+Dummy::Application.routes.draw do
+  [:bar, :remove, :after_remove, :insert, :sub2, :redirect_to, :next].each do |s|
+    resources s
+  end
+  [:foo, :sub].each do |r|
+    resources r do
+      collection do
+        get :another
+      end
+    end
+  end
+end
+
+

data/stepstepstep.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "stepstepstep"
+  s.version     = "0.0.1"
+  s.authors     = ["Blake Taylor", "David Chen"]
+  s.email       = ["blakefrost@gmail.com", "mvjome@gmail.com"]
+  s.homepage    = "https://github.com/eoecn/stepstepstep"
+  s.summary     = %q{DSL for defining before_filters's dependencies like rake tasks.}
+  s.description = File.read("README.markdown").split(/===+/)[0].strip
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rake"
+  s.add_dependency "rails"
+  s.add_dependency "actionpack"
+  s.add_dependency "activesupport"
+
+  s.add_development_dependency 'pry-debugger'
+  s.add_development_dependency 'rspec-rails', '~> 2.0'
+  s.add_development_dependency 'guard-rspec'
+
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: stepstepstep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Blake Taylor
+- David Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stepstepstep
+email:
+- blakefrost@gmail.com
+- mvjome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- License.txt
+- README.markdown
+- Rakefile
+- lib/stepstepstep.rb
+- spec/controllers/foo_controller_spec.rb
+- spec/spec_helper.rb
+- stepstepstep.gemspec
+homepage: https://github.com/eoecn/stepstepstep
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: DSL for defining before_filters's dependencies like rake tasks.
+test_files:
+- spec/controllers/foo_controller_spec.rb
+- spec/spec_helper.rb