focused_controller 0.1.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - rbx-18mode
+  # - rbx-19mode # Seems to hang, try again another day
+  # Add JRuby support when poltergeist handles JRuby
+gemfile:
+  - gemfiles/rails-3-2.gemfile
+  - gemfiles/rails-3-1.gemfile
+  - gemfiles/rails-3-0.gemfile
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-3-2' do
+  gem 'rails', '~> 3.2.0'
+end
+
+appraise 'rails-3-1' do
+  gem 'rails', '~> 3.1.0'
+end
+
+appraise 'rails-3-0' do
+  gem 'rails', '~> 3.0.0'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in focused_controller.gemspec
+gemspec

data/README.md

@@ -0,0 +1 @@
+[![Build Status](https://secure.travis-ci.org/jonleighton/focused_controller.png?branch=master)](http://travis-ci.org/jonleighton/focused_controller)

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+require 'appraisal'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:acceptance) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/acceptance/*_test.rb']
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/unit/*_test.rb']
+    t.verbose = true
+  end
+end
+
+task :test => ['test:unit', 'test:acceptance']
+task :default => :test

data/focused_controller.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "focused_controller/version"
+
+Gem::Specification.new do |s|
+  s.name        = "focused_controller"
+  s.version     = FocusedController::VERSION
+  s.authors     = ["Jon Leighton"]
+  s.email       = ["j@jonathanleighton.com"]
+  s.homepage    = "http://github.com/jonleighton/focused_controller"
+  s.summary     = %q{Write Rails controllers that don't violate SRP}
+  s.description = %q{Write Rails controllers that don't violate SRP}
+
+  s.rubyforge_project = "focused_controller"
+
+  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 'actionpack', '~> 3.0'
+
+  s.add_development_dependency 'minitest', '~> 2.11.2'
+  s.add_development_dependency 'capybara', '~> 1.1.2'
+  s.add_development_dependency 'capybara_minitest_spec', '~> 0.2.1'
+  s.add_development_dependency 'poltergeist', '~> 0.4.0'
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'rspec-rails', '~> 2.8.0'
+  s.add_development_dependency 'appraisal', '~> 0.4.1'
+end

data/gemfiles/rails-3-0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3-1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3-2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/lib/focused_controller.rb

@@ -0,0 +1,4 @@
+require 'focused_controller/version'
+require 'focused_controller/route'
+require 'focused_controller/mixin'
+require 'focused_controller/route_mapper'

data/lib/focused_controller/action_name.rb

@@ -0,0 +1,6 @@
+module FocusedController
+  class << self
+    attr_accessor :action_name
+  end
+  self.action_name = 'run'
+end

data/lib/focused_controller/functional_test_helper.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+
+module FocusedController
+  module FunctionalTestHelper
+    def get(*args)
+      super(FocusedController.action_name, *args)
+    end
+
+    def post(*args)
+      super(FocusedController.action_name, *args)
+    end
+
+    def put(*args)
+      super(FocusedController.action_name, *args)
+    end
+
+    def delete(*args)
+      super(FocusedController.action_name, *args)
+    end
+
+    def head(*args)
+      super(FocusedController.action_name, *args)
+    end
+  end
+end

data/lib/focused_controller/mixin.rb

@@ -0,0 +1,44 @@
+require 'focused_controller/action_name'
+require 'active_support/concern'
+require 'active_support/core_ext/string/conversions'
+require 'active_support/core_ext/class/attribute'
+
+module FocusedController
+  module Mixin
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :allow_view_assigns
+      self.allow_view_assigns = false
+    end
+
+    module ClassMethods
+      def controller_path
+        @focused_controller_path ||= name && name.sub(/\:\:[^\:]+$/, '').sub(/Controller$/, '').underscore
+      end
+
+      def call(env)
+        action(FocusedController.action_name).call(env)
+      end
+    end
+
+    def action_name
+      self.class.name.demodulize.underscore
+    end
+
+    def method_for_action(name)
+      FocusedController.action_name
+    end
+
+    def view_assigns
+      if self.class.allow_view_assigns
+        super
+      else
+        {}
+      end
+    end
+
+    def run
+    end
+  end
+end

data/lib/focused_controller/route.rb

@@ -0,0 +1,15 @@
+module FocusedController
+  class Route
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def call(env)
+      name.constantize.call(env)
+    end
+
+    alias to_s name
+  end
+end

data/lib/focused_controller/route_mapper.rb

@@ -0,0 +1,58 @@
+require 'focused_controller/action_name'
+require 'action_dispatch'
+
+module FocusedController
+  # The monkey-patching in this file makes me sadface but I can't see
+  # another way ;(
+  class RouteMapper
+    def initialize(scope, options)
+      @scope, @options = scope, options
+    end
+
+    def options
+      options = @options.dup
+
+      if to = to_option
+        options[:to]     = FocusedController::Route.new(to)
+        options[:action] = FocusedController.action_name # necessary for rails <= 3.1
+      end
+
+      options
+    end
+
+    private
+
+    def to_option
+      if @options[:to] && !@options[:to].respond_to?(:call)
+        @options[:to]
+      elsif @options[:action] && @scope[:controller]
+        name = ''
+        name << @scope[:module].camelize << '::' if @scope[:module]
+        name << @scope[:controller].camelize << 'Controller::'
+        name << @options[:action].to_s.camelize
+        name
+      end
+    end
+  end
+
+  class ActionDispatch::Routing::Mapper
+    def focused_controller_routes(&block)
+      prev, @scope[:focused_controller_routes] = @scope[:focused_controller_routes], true
+      yield
+    ensure
+      @scope[:focused_controller_routes] = false
+    end
+
+    class Mapping
+      def initialize_with_focused_controller(set, scope, path, options)
+        if scope[:focused_controller_routes]
+          options = FocusedController::RouteMapper.new(scope, options).options
+        end
+
+        initialize_without_focused_controller(set, scope, path, options)
+      end
+
+      alias_method_chain :initialize, :focused_controller
+    end
+  end
+end

data/lib/focused_controller/rspec_controller_class.rb

@@ -0,0 +1,15 @@
+module FocusedController
+  module RSpecControllerClass
+    def controller_class
+      metadata = self.metadata[:example_group]
+      klass    = nil
+
+      until metadata.nil? || klass.respond_to?(:new)
+        klass    = metadata[:description_args].first
+        metadata = metadata[:example_group]
+      end
+
+      klass.respond_to?(:new) ? klass : super
+    end
+  end
+end

data/lib/focused_controller/rspec_functional_helper.rb

@@ -0,0 +1,25 @@
+require 'action_controller'
+require 'action_view'
+require 'action_dispatch'
+require 'rspec/rails'
+require 'focused_controller/functional_test_helper'
+require 'focused_controller/rspec_controller_class'
+
+module FocusedController
+  module RSpecFunctionalHelper
+    def self.append_features(base)
+      base.class_eval do
+        # This must be included first
+        include RSpec::Rails::ControllerExampleGroup
+        extend ClassMethods
+        include FocusedController::FunctionalTestHelper
+      end
+
+      super
+    end
+
+    module ClassMethods
+      include FocusedController::RSpecControllerClass
+    end
+  end
+end

data/lib/focused_controller/rspec_helper.rb

@@ -0,0 +1,42 @@
+require 'focused_controller/test_helper'
+require 'focused_controller/rspec_controller_class'
+
+begin
+  # Requiring specific files rather than just 'rspec/rails' because I don't
+  # want to force the configuration that 'rspec/rails' adds on people if they
+  # haven't specifically chosen to receive it.
+  require 'rspec/rails/matchers'
+  require 'rspec/rails/adapters'
+  require 'rspec/rails/example/rails_example_group'
+rescue LoadError
+end
+
+module FocusedController
+  module RSpecHelper
+    def self.append_features(base)
+      base.class_eval do
+        # This must get included higher in the ancestor chain than
+        # this module so that inheritance works as desired
+        include FocusedController::TestHelper
+        extend ClassMethods
+        subject { controller }
+      end
+
+      super
+    end
+
+    if defined?(RSpec::Rails)
+      include RSpec::Rails::RailsExampleGroup
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+    end
+
+    module ClassMethods
+      include FocusedController::RSpecControllerClass
+
+      def stub_url(*helper_names)
+        before { stub_url(*helper_names) }
+      end
+    end
+  end
+end

data/lib/focused_controller/test_helper.rb

@@ -0,0 +1,183 @@
+require 'action_dispatch'
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/hash_with_indifferent_access'
+
+module FocusedController
+  module TestHooks
+    attr_reader :_render_options
+
+    def render_to_body(options = {})
+      _process_options(options)
+      @_render_options = options
+    end
+
+    def url_for(options = nil)
+      if options.is_a?(StubbedURL)
+        options
+      else
+        super
+      end
+    end
+  end
+
+  class TestRequest < ActionDispatch::TestRequest
+    def initialize(env = {})
+      super
+      self.session = HashWithIndifferentAccess.new
+    end
+
+    def cookie_jar
+      @cookie_jar ||= ActionDispatch::Cookies::CookieJar.new
+    end
+
+    def flash
+      session['flash'] ||= ActionDispatch::Flash::FlashHash.new
+    end
+  end
+
+  class TestResponse < ActionDispatch::TestResponse
+  end
+
+  class StubbedURL
+    attr_reader :helper_name, :args
+
+    def initialize(helper_name, args)
+      @helper_name = helper_name.to_s
+      @args        = args
+    end
+
+    def ==(other)
+      other.is_a?(self.class) &&
+        helper_name == other.helper_name &&
+        args        == other.args
+    end
+
+    # Deals with _compute_redirect_to_location in action_controller/metal/redirecting
+    # (I don't feel proud about this...)
+    def gsub(*)
+      self
+    end
+
+    def to_s
+      "#{helper_name}(#{args.each(&:to_s).join(', ')})"
+    end
+  end
+
+  module TestHelper
+    extend ActiveSupport::Concern
+    include ActionDispatch::Assertions::ResponseAssertions
+
+    included do
+      class_attribute :_controller_class, :instance_reader => false, :instance_writer => false
+    end
+
+    module ClassMethods
+      def controller_class=(klass)
+        self._controller_class = klass
+      end
+
+      def controller_class
+        _controller_class || name.sub(/Test$/, '').constantize
+      end
+
+      def include_routes
+        if controller_class.respond_to?(:_routes) && controller_class._routes
+          include controller_class._routes.named_routes.module
+        end
+      end
+
+      def stub_url(*names)
+        setup { stub_url(*names) }
+      end
+    end
+
+    def controller
+      @controller ||= begin
+        controller = self.class.controller_class.new
+        controller.singleton_class.send :include, TestHooks
+        controller.request  = request
+        controller.response = response
+        controller
+      end
+    end
+
+    def request
+      @request ||= TestRequest.new
+    end
+
+    def response
+      @response ||= TestResponse.new
+    end
+
+    def req(params = nil, session = nil, flash = nil)
+      controller.params = params        if params
+      controller.session.update session if session
+      controller.flash.update flash     if flash
+      controller.run
+    end
+
+    def session
+      controller.session
+    end
+
+    def flash
+      controller.flash
+    end
+
+    def cookies
+      request.cookie_jar
+    end
+
+    def assert_template(template, message = nil)
+      assert_equal template.to_s, controller._render_options[:template], message
+    end
+
+    def assert_response(type, message = nil)
+      controller # make sure controller is initialized
+      super
+    end
+
+    def assert_redirected_to(location, message = nil)
+      controller # make sure controller is initialized
+      super
+    end
+
+    def url_for(*args)
+      controller.url_for(*args)
+    end
+
+    def respond_to?(method_name)
+      unless defined?(@_routes_included) && @_routes_included
+        self.class.include_routes
+        @_routes_included = true
+      end
+
+      super
+    end
+
+    def method_missing(method_name, *args, &block)
+      if respond_to?(method_name)
+        send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def stub_url(*names)
+      [self, controller].each do |host|
+        host.singleton_class.class_eval do
+          names.each do |name|
+            define_method("#{name}_url") do |*args|
+              StubbedURL.new("#{name}_url", args)
+            end
+
+            define_method("#{name}_path") do |*args|
+              StubbedURL.new("#{name}_path", args)
+            end
+          end
+        end
+      end
+    end
+  end
+end