short_circuit 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82ba9bf7e740eb2c2d50b767e63025893c51c11f
+  data.tar.gz: 75510a972b29489923a5fbe7b25285afd57dce0b
+SHA512:
+  metadata.gz: 172e84d9ae5b7c5c8965061ab49048e2a16f8266cf65cf38daee8e74d1e045867112b30b2b6242f2192fdcb4473b0b95c615dbe4bf74f3f0ea2f58a0e58a90dc
+  data.tar.gz: 48fba1a87f641240f4e8aafb6b07d42d2a01694252b6f3d13b25c5d48010020a526072696f4ba8d0b6fd853a7fc2eb2dce7e39fb7c9510d7c03b64d365e48124

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2014 Jim Pruetting
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,86 +4,109 @@ short_circuit [![Build Status](https://travis-ci.org/jpruetting/short_circuit.pn
 Short Circuit adds simple presenters for Rails views.
 
 
-Installation
-=============
+Usage
+======
 
-Include the gem in your Gemfile:
+Install the gem in your Gemfile:
 
 ```ruby
 gem 'short_circuit'
 ```
 
-Usage
-=============
-
-Model:
+Include short_circuit in your model:
 
 ```ruby
+# app/models/user.rb
+ 
 class User < ActiveRecord::Base
+  include ShortCircuit::Presentable
+
   attr_accessible :first_name, :last_name, :job_title, :member_since
 end
 ```
 
-Presenter:
+Create a presenter:
 
 ```ruby
+# app/presenters/user_presenter.rb
+ 
 class UserPresenter < ShortCircuit::Presenter
   def first_name
     @user.first_name.titleize
   end
-
+ 
   def full_name
     "#{first_name} #{last_name}"
   end
-
+ 
   def job_title
     @user.job_title || 'not listed'
   end
-
+ 
   def member_since
     @user.member_since.to_formatted_s(:long) 
   end
-
+ 
   def error_response(method, *args, &block)
     link_to 'N/A', root_path
   end
 end
 ```
 
-Examples:
+No additional controller code is necessary. Retrieve the model as you normally would:
 
 ```ruby
-@user = User.new(
-  first_name: 'john',
-  last_name: 'smith',
-  job_title: nil,
-  member_since: 3.months.ago
-)
+# app/controllers/users_controller.rb
+ 
+class UsersController < ApplicationController
+  def show
+    @user = User.find(params['id'])
+  end
+end
+```
+
+In the view, you don't need to instantiate any presenter/decorator objects, just use the model:
 
+```ruby
+# Normal method vs presenter method:
 @user.first_name # john
 @user.present :first_name # John
-
+ 
+ 
+# Missing presenter method is delegated to model:
 @user.last_name # smith
 @user.present :last_name # smith
-
+ 
+ 
+# Method defined on presenter object:
 @user.full_name # NoMethodError
 @user.present :full_name # John smith
-
+ 
+ 
+# Formatted data returned by presenter method:
 @user.member_since # 2013-02-28 20:46:32 UTC
 @user.present :member_since # February 28, 2013 20:46
-
+ 
+ 
+# Presenter method prevents nil error by returning default data:
 @user.job_title.upcase # undefined method 'upcase' for nil:NilClass
 @user.present(:job_title).upcase # NOT LISTED
-
+ 
+ 
+# Presenter method silences nil error and returns alternative content:
 @user.not_a_real_method # NoMethodError
 @user.present :not_a_real_method # <a href="/">N/A</a>
-
+ 
+ 
+# Present! method does not silence errors:
 @user.present! :not_a_real_method # NoMethodError
 ```
 
-Design Decisions
-=============
-* All presenter methods are accessed via 'present' and 'present!'. This helps identify whether the output is coming from the presenter or directly from the model. It also keeps intact the familiar and direct access to a model's attributes.
-* The 'present' method will fail silently. This keeps minor accessor errors from breaking an entire page. Errors can still be logged/handled via the 'error_response' method.
-* If you do not want a particular method call to fail silently, the 'present!' method will throw errors as usual.
-* If a method is not found on the presenter, it will delegate the call to the model.
+Design goals for short_circuit
+===============================
+* Minimize project size and scope
+* Preserve direct access to model attributes
+* Create a separate access point for presenter methods
+* Integrate with ActiveRecord models by default
+* Silence accessor errors by default
+* Delegate missing presenter methods to the model object

data/lib/short_circuit.rb

@@ -1,5 +1,7 @@
 module ShortCircuit
-  require "short_circuit/version"
-  require "short_circuit/presenter"
-  require "active_record_extension"
+  require 'active_support/all'
+  
+  require 'short_circuit/version'
+  require 'short_circuit/presenter'
+  require 'short_circuit/presentable'
 end

data/lib/short_circuit/presentable.rb

@@ -21,6 +21,7 @@ module ShortCircuit
     def find_presenter
       presenter_class_name = "#{self.class.name}Presenter"
       presenter_class = Object.const_get(presenter_class_name)
+      
       presenter_class.new(self)
     end
   end

data/lib/short_circuit/presenter.rb

@@ -5,12 +5,9 @@ module ShortCircuit
     delegate :url_helpers, to: 'Rails.application.routes'
 
     def initialize(presentable_object)
-      instance_variable_set("@#{presentable_object.class.to_s.downcase}", presentable_object)
-      super(presentable_object)
-    end
+      instance_variable_set("@#{presentable_object.class.to_s.underscore}", presentable_object)
 
-    def helpers
-      ApplicationController.helpers
+      super(presentable_object)
     end
 
     def error_response(error, method, *args, &block)
@@ -19,9 +16,13 @@ module ShortCircuit
     
     private
 
+    def controller_helpers
+      ApplicationController.helpers
+    end
+
     def method_missing(method, *args, &block)
-      if helpers.respond_to?(method)
-        helpers.send(method, *args, &block)  
+      if controller_helpers.respond_to?(method)
+        controller_helpers.send(method, *args, &block)  
       elsif url_helpers.respond_to?(method)
         url_helpers.send(method, *args, &block)
       else

data/lib/short_circuit/version.rb

@@ -1,3 +1,3 @@
 module ShortCircuit
-  VERSION = "0.1.0"
+  VERSION = '1.0.0'
 end

data/spec/dummy/README.rdoc

@@ -1,261 +1,28 @@
-== Welcome to Rails
+== README
 
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
+This README would normally document whatever steps are necessary to get the
+application up and running.
 
-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.
+Things you may want to cover:
 
-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.
+* Ruby version
 
-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.
+* System dependencies
 
+* Configuration
 
-== Getting Started
+* Database creation
 
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+* Database initialization
 
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
+* How to run the test suite
 
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
+* Services (job queues, cache servers, search engines, etc.)
 
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
+* Deployment instructions
 
-* 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.
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.