rails_contrib 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Mattways
+
+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.rdoc

@@ -0,0 +1,43 @@
+{<img src="https://codeclimate.com/github/mattways/rails_contrib.png" />}[https://codeclimate.com/github/mattways/rails_contrib] {<img src="https://travis-ci.org/mattways/rails_contrib.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/rails_contrib] {<img src="https://gemnasium.com/mattways/rails_contrib.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/rails_contrib]
+
+= Rails Contrib
+
+Adds contributions to the core of Rails.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'rails_contrib'
+  
+Then bundle:
+  $ bundle
+
+= Sweepers
+
+Use increment_cache_namespace if you're using memcache client and a namespace to invalidate in your sweeper:
+  increment_cache_namespace :key
+
+= Controllers
+
+(This plugin will create an error method to force debug information on exceptions in development env)
+
+Use not_found method to show 404.html in your controller:
+  not_found
+
+Use forbidden method to show 422.html in your controller:
+  forbidden
+
+Use redirect_with_flash to directly redirect with flash inside your controller:
+  redirect_with_flash home_path, :success, 'success message'
+  
+Use flash_errors method to directly flash models errors inside your controller:
+  flash_errors model
+
+= Views
+
+Use conditional_tag if you want wrap content into some tag if certain condition it's true in your views:
+  - conditional_tag :h1, request.path == home_path do
+    %a#logo{ :href => home_path }= Home
+
+User active_menu? if you want to add an active class to some tag in your views:
+  %li{ :class => active_menu?(some_path) }

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsContrib'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails_contrib.rb

@@ -0,0 +1,8 @@
+require 'rails_contrib/action_controller/caching/sweeper'
+require 'rails_contrib/action_controller/base'
+require 'rails_contrib/action_view/base'
+require 'rails_contrib/railtie'
+require 'rails_contrib/version'
+
+module RailsContrib
+end

data/lib/rails_contrib/action_controller/base.rb

@@ -0,0 +1,48 @@
+module RailsContrib
+  module ActionController
+    module Base
+
+      def self.included(base)
+        base.class_eval do
+          if Rails.env == 'development'
+            rescue_from Exception, :with => :error
+          end
+        end
+      end
+
+      protected
+      
+      def error(exception)
+        logger.error exception.message
+        exception.backtrace.each { |line| logger.error line }
+        render :file => Rails.root.join('public', '500.html'), :status => 500, :layout => false
+      end
+
+      def not_found
+        render :file => Rails.root.join('public', '404.html'), :status => 404, :layout => false
+      end  
+      
+      def forbidden
+        render :file => Rails.root.join('public', '422.html'), :status => 422, :layout => false
+      end
+
+      def redirect_with_flash(path, type, flash, params=nil)
+        path = (params.nil? ? path : (params[:back].present? ? params[:back] : path))
+        redirect_to path, { :flash => { type => (flash.is_a?(Array) ? flash : [flash]) } }
+      end
+
+      def flash_errors(source)
+        flash[:error] = [] unless flash[:error].is_a? Array
+        case source
+        when String
+          flash[:error] << source
+        when Array
+          source.each { |error| flash[:errors] << error }
+        else
+          source.errors.full_messages.each { |error| flash[:error] << error }
+        end
+      end
+
+    end
+  end
+end

data/lib/rails_contrib/action_controller/caching/sweeper.rb

@@ -0,0 +1,17 @@
+module RailsContrib
+  module ActionController
+    module Caching
+      module Sweeper
+
+        protected
+
+        def increment_cache_namespace(namespace)
+          key = "namespaces/#{namespace}"
+          value = Rails.cache.read(key)
+          Rails.cache.write(key, value.to_i+1)
+        end
+
+      end
+    end
+  end
+end

data/lib/rails_contrib/action_view/base.rb

@@ -0,0 +1,19 @@
+module RailsContrib
+  module ActionView
+    module Base
+
+      def conditional_tag(tag, condition, options=nil, &block)
+        condition ? content_tag(tag, options, &block) : capture(&block)
+      end
+
+      def active_menu?(path)
+        if path == '/'
+          request.path == path ? 'active' : ''
+        else
+          request.path.start_with?(path) ? 'active' : ''
+        end
+      end
+
+    end
+  end
+end

data/lib/rails_contrib/railtie.rb

@@ -0,0 +1,11 @@
+module RailsContrib
+  class Railtie < Rails::Railtie
+
+    initializer 'rails_contrib' do
+      ::ActionController::Caching::Sweeper.send :include, RailsContrib::ActionController::Caching::Sweeper
+      ::ActionController::Base.send :include, RailsContrib::ActionController::Base
+      ::ActionView::Base.send :include, RailsContrib::ActionView::Base
+    end
+
+  end
+end

data/lib/rails_contrib/version.rb

@@ -0,0 +1,5 @@
+module RailsContrib
+  
+  VERSION = '0.0.2'
+
+end

data/test/action_controller_base_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class ActionControllerBaseTest < ActiveSupport::TestCase
+
+  setup :set_instance
+
+  test 'should have not_found method' do
+    assert @instance.respond_to?(:not_found)
+  end
+
+  test 'should have forbidden method' do
+    assert @instance.respond_to?(:forbidden)
+  end
+
+  test 'should have redirect_with_flash method' do
+    assert @instance.respond_to?(:redirect_with_flash)
+  end
+
+  test 'should have flash_errors method' do
+    assert @instance.respond_to?(:flash_errors)
+  end
+
+  protected
+
+  def set_instance
+    @instance = ApplicationController.new
+  end
+
+end

data/test/action_controller_caching_sweeper_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ActionControllerCachingSweeperTest < ActiveSupport::TestCase
+
+  setup :set_instance
+
+  test 'should have not_found method' do
+    assert @instance.respond_to?(:increment_cache_namespace)
+  end
+
+  protected
+
+  def set_instance
+    @instance = ActionController::Caching::Sweeper.instance
+  end
+
+end

data/test/action_view_base_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ActionVewBaseTest < ActiveSupport::TestCase
+
+  setup :set_instance 
+
+  test 'should have conditional_tag method' do
+    assert @instance.respond_to?(:conditional_tag)
+  end
+
+  test 'should have active_menu? method' do
+    assert @instance.respond_to?(:active_menu?)
+  end
+
+  protected
+
+  def set_instance
+    @instance = ActionView::Base.new
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.