action-hero 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33c72992fb39f78faad1dfd830fdb08727163293
+  data.tar.gz: deab7549b395659d3517c827be52c74b542f60e6
+SHA512:
+  metadata.gz: 58d2b25fffb2ecad60810d066b69ca362d5b8ccd189baabe5773ce17bba06dea9fd10c2888d73c0bc47e9772772834bf4c3e97bbb261e4d4ba8edfe6d402483b
+  data.tar.gz: fe08fc4bc67513626538a34c699d9abdf755ab7ec249dfb88836d82096fdff78e354f6f368fd2f6d673e0bbaba6643b9464757384458dd2f99a4baf0736a70fb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action-hero.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Harrelson
+
+MIT License
+
+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.md

@@ -0,0 +1,162 @@
+# ActionHero
+
+Move actions from methods in Rails controllers to action classes.
+
+
+## Motiviation
+
+Simple Rails controllers implementing all of the REST actions get crowded enough with at least seven methods.  Add any
+helper methods, etc and things get much worse.  In addition, the spec file is even more crowded.  All of these concerns
+jammed into a single class provide many opportunities for bugs.  Why should you risk breaking your already implemented and
+tested index action just because you are adding a show action?
+
+Finally, controller specs are painfully slow.  When ActionHero is used to implement your actions as classes you can achieve
+full coverage without writing a single controller spec.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action-hero'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action-hero
+
+
+## Usage
+
+### Simplest Case
+
+Include the ActionHero::Controller module in a controller.
+
+    # app/controllers/things_controller.rb
+    class ThingsController < ApplicationController
+      include ActionHero::Controller
+    end
+
+Define the action class.
+
+    # app/actions/things/index.rb
+    module Things
+      class Index
+        include ActionHero::Action
+
+        def call
+          expose :things, Thing.all
+          respond_with @things
+        end
+
+      end
+    end
+
+Use the exposed object in the view.
+
+    <%= things.each do |thing| %>
+      ...
+    <% end %>
+
+### Exposure
+
+Unlike controller instance variables, the instance variables set in the action class will not automatically be available 
+in the view.  This is just as well, as blindly making all instance variables in the controller available to the view is
+arguably a bad idea.  In order to solve this problem, ActionHero provides the #expose method.  
+
+The expose method does the following:
+
+* Sets an instance variable in the action class with the same name as provided in the first argument to expose
+* Returns the value passed in the second parameter so that you can set a local variable 
+* Stores the value in a data store held on the controller
+* Implements a helper method on the controller to access the exposed value
+* Makes the helper method available in the view
+
+Example of usage:
+
+    # in the action class
+    count = expose( :count, 1 ) 
+    count  # => 1
+    @count # => 1
+
+    #in the controller
+    count  # => 1
+    @count # => nil
+
+    #in the view
+    count  # => 1
+    @count # => nil
+
+
+### Implicit Controller
+
+Because controller actions can now be defined outside of the controller, defining the controller is optional.  If you
+do not expcitily define a controller, ActionHero will fall back to the ImplicitController.
+
+Ensure an implicit controller is defined.  Without configuration, the implicit controller defaults to ImplicitController.
+
+    # app/controllers/implicit_controller.rb
+    class ImplicitController < ApplicationController
+      include ActionHero::Controller
+    end
+
+
+### Define Several Implicit Controllers and Configure Usage
+
+In the case you want several implicit controllers due to different use cases, such as web app controller vs API you can
+define several implicit controllers and configure the usage.
+
+Define the implicit controllers.
+
+    # app/controllers/implicit_controller.rb
+    class ImplicitController < ApplicationController
+      include ActionHero::Controller
+    end
+
+    # app/controllers/api/v1/implicit_controller.rb
+    class Api::V1::ImplicitController < ApplicationController
+      include ActionHero::Controller
+    end
+
+Configure the usage.  The configuration uses regexs to match against the #controller_name and will use the first one 
+matched, so order matters.
+
+    # config/initializers/action_hero.rb
+    ActionHero.configure do |config|
+      config.implicit_controllers = [
+        [/^\/api\/.*/, Api::ImplicitController],
+        [/^\/.*/, ImplicitController]
+      ]
+    end
+
+### Mix and Match
+
+You can mix and match usage of ActionHero action classes and standard Rails controller action methods.
+
+In order to unobtrusively tie in to the controller, ActionHero::Controller implements the #action_missing 
+method.  Thus, if you implement both an aciton class and an action method, the action method will win.
+
+Define a controller with a show action method and define an action class for the index action.
+
+    # app/controllers/things_controller.rb
+    class ThingsController < ApplicationController
+      include ActionHero::Controller
+
+      def show
+        ...
+      end
+    end
+
+    # app/actions/things/index.rb
+    module Things
+      class Index
+        include ActionHero::action
+
+        def call
+          ...
+        end
+      end
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/action-hero.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_hero/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action-hero"
+  spec.version       = ActionHero::VERSION
+  spec.authors       = ["C. Jason Harrelson"]
+  spec.email         = ["jason@lookforwardenterprises.com"]
+  spec.description   = %q{Move actions from methods in Rails controllers to action classes.}
+  spec.summary       = %q{Move actions from methods in Rails controllers to action classes.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "rails"
+end

data/lib/action-hero.rb

@@ -0,0 +1 @@
+require "action_hero"

data/lib/action_hero.rb

@@ -0,0 +1,25 @@
+require "action_hero/version"
+require "dispatcher_ext"
+
+module ActionHero
+
+  class ActionNotFound < StandardError #:nodoc:
+  end
+
+  autoload :Action,         'action_hero/action'
+  autoload :ActionResolver, 'action_hero/action_resolver'
+  autoload :Configuration,  'action_hero/configuration'
+  autoload :Controller,     'action_hero/controller'
+  autoload :LogSubscriber,  'action_hero/log_subscriber'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield( configuration ) if block_given?
+  end
+
+end
+
+ActionHero::LogSubscriber.attach_to :action_controller

data/lib/action_hero/action.rb

@@ -0,0 +1,50 @@
+require 'active_support/concern'
+require 'forwardable'
+
+module ActionHero
+  module Action
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      extend Forwardable
+
+      attr_reader :controller
+      protected :controller
+
+      def_delegators :controller, :action_name,
+                                  :env,
+                                  :flash,
+                                  :formats,
+                                  :head,
+                                  :headers,
+                                  :params,
+                                  :redirect_to,
+                                  :render,
+                                  :render_to_string,
+                                  :request,
+                                  :reset_session,
+                                  :respond_with,
+                                  :response,
+                                  :session,
+                                  :url_for,
+                                  :url_options
+
+    end
+
+    def initialize( controller )
+      @controller = controller
+    end
+
+  protected
+
+    def expose( *args )
+      name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+      value = args.last
+      instance_variable_set "@#{name}", value
+      controller.send :expose, *args
+    end
+
+  end
+end

data/lib/action_hero/action_resolver.rb

@@ -0,0 +1,38 @@
+module ActionHero
+  class ActionResolver
+
+    attr_reader :module_name,
+                :action_name
+
+    def initialize( options )
+      @module_name = normalize_controller( options )
+      @action_name = options[:action_name]
+    end
+
+    def action_class
+      @action_class ||= action_class_name.constantize
+    end
+
+    def action_class_name
+      @action_class_name ||= [
+        module_name,
+        action_name.camelize
+      ].join( '::' )
+    end
+
+    def action_class_file_exists?
+      File.exists?( Rails.root.join( 'app', 'actions', "#{action_class_name.underscore}.rb" ))
+    end
+
+  protected
+
+    def normalize_controller( options )
+      if options[:controller_const]
+        options[:controller_const].gsub( /Controller$/, '' )
+      elsif options[:controller]
+        options[:controller].classify
+      end
+    end
+
+  end
+end

data/lib/action_hero/configuration.rb

@@ -0,0 +1,15 @@
+module ActionHero
+
+  class Configuration
+
+    def implicit_controllers
+      @implicit_controllers ||= []
+    end
+
+    def implicit_controllers=( value )
+      @implicit_controllers = value
+    end
+
+  end
+
+end

data/lib/action_hero/controller.rb

@@ -0,0 +1,68 @@
+require 'active_support/concern'
+
+module ActionHero
+  module Controller
+
+    extend ActiveSupport::Concern
+
+  protected
+
+    def expose( *args )
+      name = args.first.is_a?( Symbol ) ? args.first : (raise NotImplementedError)
+      value = args.last
+      data.merge!( name => value )
+      self.class.send( :define_method, name, lambda { data[name] } )
+      self.class.helper_method name
+      value
+    end
+
+    def action_missing( name, *args, &block )
+      begin
+        action_class
+      rescue NoMethodError
+        # protect against misidentification due to
+        # NoMethodError being descendent of NameError
+        raise
+      rescue NameError => ex
+        raise ActionNotFound,
+              "The action #{action_class_name} nor #{self.class.name}##{name} could be found",
+              ex.backtrace
+      end
+      prepend_view_path "#{Rails.root}/app/views/#{params[:controller]}"
+      execute_action
+    end
+
+    # override _normalize_render in order to insert implied controller's view prefix
+    def _normalize_render(*args, &block)
+      options = _normalize_args(*args, &block)
+      _normalize_options(options)
+      unless options[:prefixes].include?( params[:controller] )
+        options[:prefixes].insert( 0, params[:controller] )
+      end
+      options
+    end
+
+    def data
+      @data ||= {}.with_indifferent_access
+    end
+
+    def execute_action
+      action = action_class.new( self )
+      action.call
+    end
+
+    def resolver
+      @resolver ||= ActionResolver.new( :controller_const => "#{params[:controller].classify}Controller",
+                                        :action_name => action_name )
+    end
+
+    def action_class
+      resolver.action_class
+    end
+
+    def action_class_name
+      resolver.action_class_name
+    end
+
+  end
+end

data/lib/action_hero/log_subscriber.rb

@@ -0,0 +1,12 @@
+module ActionHero
+  class LogSubscriber < ActiveSupport::LogSubscriber
+
+    def start_processing( event )
+      controller_name = "#{event.payload[:params]['controller'].camelize}Controller"
+      unless event.payload[:controller] == controller_name
+        info "[ActionHero] No explicit #{controller_name} falling back to #{event.payload[:controller]}"
+      end
+    end
+
+  end
+end

data/lib/action_hero/version.rb

@@ -0,0 +1,5 @@
+module ActionHero
+
+  VERSION = "0.1.0"
+
+end

data/lib/dispatcher_ext.rb

@@ -0,0 +1,47 @@
+module ActionDispatch
+  module Routing
+    class RouteSet
+      class Dispatcher
+
+      private
+
+        def controller(params, default_controller=true)
+          if params && params.key?(:controller)
+            controller_param = params[:controller]
+            action_param = params[:action]
+            controller_reference(controller_param, action_param)
+          end
+        rescue NameError => e
+          raise ActionController::RoutingError, e.message, e.backtrace if default_controller
+        end
+
+        def controller_reference(controller_param, action_param)
+          const_name = @controller_class_names[controller_param] ||= "#{controller_param.camelize}Controller"
+          ActiveSupport::Dependencies.constantize(const_name)
+        rescue NoMethodError
+          # protect against misidentification due to
+          # NoMethodError being descendent of NameError
+          raise
+        rescue NameError
+          action_hero_resolver = ActionHero::ActionResolver.new( :controller => controller_param,
+                                                                 :action_name => action_param )
+          unless action_hero_resolver.action_class_file_exists?
+            raise
+          end
+
+          controller_const = nil
+          ActionHero.configuration.implicit_controllers.each do |regex, controller|
+            if regex.match( "/#{controller_param}" )
+              controller_const = controller
+              break
+            end
+          end
+
+          raise NameError unless controller_const
+          controller_const
+        end
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: action-hero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Move actions from methods in Rails controllers to action classes.
+email:
+- jason@lookforwardenterprises.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action-hero.gemspec
+- lib/action-hero.rb
+- lib/action_hero.rb
+- lib/action_hero/action.rb
+- lib/action_hero/action_resolver.rb
+- lib/action_hero/configuration.rb
+- lib/action_hero/controller.rb
+- lib/action_hero/log_subscriber.rb
+- lib/action_hero/version.rb
+- lib/dispatcher_ext.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Move actions from methods in Rails controllers to action classes.
+test_files: []