controller_support 0.2

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7-p352@controller_support --create

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    Controller Support (0.0.1)
+      active_support
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.1.3)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Controller Support!
+  rake
+  rspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,85 @@
+# ControllerSupport [![Build Status](https://travis-ci.org/yonbergman/controller_support.png?branch=master)](https://travis-ci.org/yonbergman/controller_support)
+
+Controller Supports are controller oriented mixins (modules) for Rails that can help you extract behaviour from controllers into shared resources.
+
+## Why?
+Controller Supports lets you extract common behaviour or non-core controller knowledge into it's seperate resource which makes it easier to test and maintain.
+Some example of ControllerSupports:
+
+* **UserSupport** - Authentication and current_user
+* **ErrorSupport** - Global error methods and a before filter to catch uncaught exceptions
+* **EventSupport** - Used to load the event resource based on the `params[:id]`
+* **LocalizationSupport** - Helper methods to build hashes that will be passed to I18n
+* **MobileSupport** - Check if in a mobile session and change the layout
+
+ControllerSupports are just an extension of `ActiveSupport::Concern` so they supply all of the behaviours that you'd get from `ActiveSupport::Concern`.  
+What Controller Supports adds on top of ActiveSupport::Concern is an easier way to define methods as `helper_methods` and `before_filters`. It does so in such a way that will enable you to `include` the support in controllers but also into other objects like test stubs or Mailers.
+
+If you don't know `ActiveSupport::Concern` there are several links to reading material in the bottom of this README.
+ 
+ 
+## Installation
+ Just add the `controller_support` gem to your Gemfile
+ 
+ ```ruby
+ 	gem 'controller_support'
+ ```
+ 
+## Usage
+
+To define a module as a controller support you just need to extend it with `ControllerSupport::Base` it can then act as a mixin which you can `include` into Controllers or any other object.
+
+```ruby
+module UserSupport
+	extend ControllerSupport::Base
+	
+	helper_method :current_user, :user_signed_in
+	before_filter :must_be_signed_in
+	# ControllerSupport also support after_filter and around_filter
+	
+	def current_user
+		User.find(session[:user_id])
+	end
+	
+	def user_signed_in?
+		current_user.present?
+	end
+	
+	def must_be_signed_in
+		redirect_to sign_up_path unless user_signed_in?
+	end
+	
+end
+```
+
+To use the support just `include` it in the controller of your choice
+
+```ruby
+class ItemController < ApplicationController
+	include UserSupport
+	
+	skip_before_filter :must_be_signed_in, :only => :new
+
+	def new
+		render :inline => "this is just an example"
+	end	
+	
+	def show
+		current_user.item.find(params[:id])
+	end
+end
+```
+## ActiveSupport::Concern reading material
+
+If you don't know about ActiveSupport::Concern and why it's an awesome thing you should read these stuff
+
+* [The offical documentation](http://api.rubyonrails.org/classes/ActiveSupport/Concern.html)
+* [Concerning yourself with ActiveSupport::Concern](http://www.fakingfantastic.com/2010/09/20/concerning-yourself-with-active-support-concern/) - This blog post covers everything you need to know
+* [Concerning ActiveSupport::Concern](http://opensoul.org/blog/archives/2011/02/07/concerning-activesupportconcern/)
+* [Extending ActiveModel via ActiveSupport::Concern](http://chris-schmitz.com/extending-activemodel-via-activesupportconcern/)
+* [Trimming the fat from your controllers](http://notninjas.com/2012/12/03/trimming-the-fat-from-your-controllers/) - A blog post I wrote that led to the creation of this gem.
+
+ 
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/controller_support.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "controller_support/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "controller_support"
+  s.version     = ControllerSupport::VERSION
+  s.authors     = ["Yonatan Bergman"]
+  s.email       = ["yonbergman@gmail.com"]
+  s.homepage    = "https://github.com/yonbergman/controller_support"
+  s.summary     = "An extension of ActiveSupport::Concern to create smart and beautiful controller mixins"
+  s.description = "An extension of ActiveSupport::Concern to create smart and beautiful controller mixins"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_path  = "lib"
+  s.test_files = Dir.glob('spec/lib/*_spec.rb')
+
+  s.add_dependency "active_support"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end

data/lib/controller_support/base.rb

@@ -0,0 +1,31 @@
+require 'active_support/concern'
+
+module ControllerSupport
+  module Base
+
+    include ActiveSupport::Concern
+
+    def self.extended(base)
+      base.instance_variable_set("@_dependencies", [])
+    end
+
+    def append_features(base)
+      super(base)
+      unless base.instance_variable_defined?("@_dependencies")
+        if instance_variable_defined?("@_custom_blocks")
+          @_custom_blocks.each do |block|
+            base.class_eval(&block)
+          end
+        end
+      end
+    end
+
+    [:before_filter, :after_filter, :around_filter, :helper_method].each do |method_name|
+      define_method method_name do |*names|
+        @_custom_blocks ||= []
+        @_custom_blocks << Proc.new { send(method_name,*names) if respond_to? method_name }
+      end
+    end
+
+  end
+end

data/lib/controller_support/version.rb

@@ -0,0 +1,3 @@
+module ControllerSupport
+  VERSION = "0.2"
+end

data/lib/controller_support.rb

@@ -0,0 +1,4 @@
+require "controller_support/base"
+
+module ControllerSupport
+end

data/spec/lib/support_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'spec_helpers/dummy_classes'
+require 'spec_helpers/example_controller_supports'
+require 'spec_helpers/mixed_helpers'
+
+describe ControllerSupport::Base do
+
+  subject { create_mixed_instance(DummyMailer, FooSupport) }
+
+  describe "Basic ActiveSupport::Concern behaviours" do
+    it "should mix in methods into class" do
+      should respond_to :foo
+    end
+
+    it "should run the included block" do
+      should respond_to :dynamic_foo
+    end
+
+    it "should support dependencies" do
+      foobar_instance = create_mixed_instance(DummyMailer, FoobarSupport)
+      foobar_instance.should respond_to :foobar
+      foobar_instance.should respond_to :bar
+    end
+
+    it "should support the ClassMethod submodule" do
+      subject.class.should respond_to :class_foo
+    end
+
+  end
+
+  describe "extended Controller Support behaviour" do
+    let(:foo_controller) { create_mixed_class(DummyController, FooSupport) }
+    let(:wrapped_foo_controller) { create_mixed_class(DummyController, WrapFooSupport) }
+
+    it "can set before_filters" do
+      foo_controller.before_filters.should eq([:foo])
+    end
+
+    it "can set helper_methods" do
+      foo_controller.helper_methods.should eq([:dynamic_foo])
+    end
+
+    it "can set before_filters even via inheritance" do
+      wrapped_foo_controller.before_filters.should eq([:foo])
+    end
+
+    it "doesn't override any after_filters already set on the controller" do
+
+      class ControllerWithAfterFilter < DummyController
+        after_filter :original
+        include FooSupport
+      end
+
+      ControllerWithAfterFilter.after_filters.should eq([:original, :extended])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require 'rubygems'
+require 'bundler/setup'
+require 'controller_support'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/spec_helpers/dummy_classes.rb

@@ -0,0 +1,34 @@
+#
+# A dummy controller - has the following class methods
+#  * before_filter
+#  * around_filter
+#  * after_filter
+#  * helper_method
+#
+# for each of the methods it also has matching getter method
+#  * before_filters
+#  * around_filters
+#  * after_filters
+#  * helper_methods
+#
+class DummyController
+
+  [:before_filter, :after_filter, :around_filter, :helper_method].each do |controller_func|
+    getter = "#{controller_func}s"
+
+    self.class.send :define_method, getter do
+      @_symbols ||= {}
+      @_symbols[controller_func] ||= []
+    end
+
+    self.class.send :define_method, controller_func do |*symbols|
+      send(getter).concat symbols
+    end
+  end
+
+end
+
+# A DummyMailer - does nothing :)
+class DummyMailer
+
+end

data/spec/spec_helpers/example_controller_supports.rb

@@ -0,0 +1,50 @@
+module FooSupport # a complex support
+  extend ControllerSupport::Base
+
+  before_filter :foo
+  helper_method :dynamic_foo
+  after_filter :extended
+
+  included do
+    define_method :dynamic_foo do
+      "dynamic_foo"
+    end
+  end
+
+  def foo
+    "foo"
+  end
+
+  module ClassMethods
+    def class_foo
+      "class_foo"
+    end
+  end
+
+end
+
+
+module BarSupport # simple support
+  extend ControllerSupport::Base
+
+  def bar
+    "bar"
+  end
+end
+
+
+module FoobarSupport  # example for inheritance of simple support
+  extend ControllerSupport::Base
+
+  include BarSupport
+
+  def foobar
+    "foobar"
+  end
+end
+
+module WrapFooSupport # example for inheritance of complex support
+  extend ControllerSupport::Base
+
+  include FooSupport
+end

data/spec/spec_helpers/mixed_helpers.rb

@@ -0,0 +1,12 @@
+# A bunch of helpers to help mix in modules for test cases
+# to make sure each test is contained
+
+def create_mixed_class(base_class, support)
+  klass = Class.new(base_class)
+  klass.send :include, support
+  klass
+end
+
+def create_mixed_instance(base_class, support)
+  create_mixed_class(base_class, support).new
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: controller_support
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Yonatan Bergman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: An extension of ActiveSupport::Concern to create smart and beautiful controller mixins
+email: 
+- yonbergman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- controller_support.gemspec
+- lib/controller_support.rb
+- lib/controller_support/base.rb
+- lib/controller_support/version.rb
+- spec/lib/support_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/dummy_classes.rb
+- spec/spec_helpers/example_controller_supports.rb
+- spec/spec_helpers/mixed_helpers.rb
+homepage: https://github.com/yonbergman/controller_support
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An extension of ActiveSupport::Concern to create smart and beautiful controller mixins
+test_files: 
+- spec/lib/support_spec.rb