shakes 0.4.4 → 0.5.0

data/README.md

@@ -22,37 +22,102 @@ Tell Rails to install the required gems:
 
 Using Shakes
 ------------
-Using Shakes is simple. If we were working with a new `Article` resource, we could add the following code to our
-controller and instantly have default actions and views for our new resource:
+Using Shakes is simple. If we were working with a new `ArticlesController`, we could add the following code to our
+controller and instantly have default actions and views for our new controller:
 
     class ArticlesController < ApplicationController
       has_the_shakes
     end
 
-You can limit the actions that are implemented by default passing the `only` or `except` option to `has_the_shakes`. For
-example, if you just wanted to have default implementations for `index` and `show` you would use the following code:
+This will create default implementations of `index`, `new`, `create`, `show`, `edit`, `update` and `destroy` that expect
+to work with an `Article` model. Shakes determined the model by looking at the name of the controller, in this case
+`ArticlesController` because `Article`.
+
+If you want to change it you can pass a `resource` option to `has_the_shakes`. If we had a model named `Post`, but we
+want the resources to be served up by an `ArticlesController`, we could do the following:
+
+    class ArticlesController < ApplicationController
+      has_the_shakes :resource => :post
+    end
+
+If you want to limit the actions that are included by default, you can control this by passing the `only` or `except`
+options to `has_the_shakes`. For example, if you just wanted to use the defaults for `index` and `show` you would use
+the following code:
 
     class ArticlesController < ApplicationController
       has_the_shakes :only => [:index, :show]
     end
 
-Overriding the default implementation for a specific controller is simple. You can just add your custom action
-implementation to your controller as usual:
+Overriding the default implementation for a specific controller is simple. You add your custom action implementation to
+your controller as usual. If I wanted to change my create action to create my new `Article` within the scope of the
+current user, I could use the following code:
 
     class ArticlesController < ApplicationController
       has_the_shakes
   
       def create
-        # my custom create implementation
+        @article = @current_user.articles.build(params[:article])
+
+        respond_to do |format|
+          if @article.save
+            format.html { redirect_to(@article, :notice => "Article was successfully created.") }
+            format.xml  { render :xml => @article, :status => :created, :location => @article }
+            format.json { render :json => @article, :status => :created, :location => @article }
+          else
+            format.html { render :action => "new" }
+            format.xml  { render :xml => @article.errors, :status => :unprocessable_entity }
+            format.json { render :json => @article.errors, :status => :unprocessable_entity }
+          end
+        end
       end
     end
 
-Overriding the default views for a specific resource is just as simple. You just have to create your view as usual. If
-I wanted to change the view for `articles#show`, I could just create my custom view at `app/views/article/show.html.erb`
-and that view will be used.
+Overriding the default views for a specific resource is also simple. Like an action, you just create your view as usual.
+If I wanted my `ArticlesController` to use a custom view for the `show` action, I would just create my custom view at
+`app/views/article/show.html.erb`:
+
+    <div class="article">
+      <div class="section">
+        <%= content_tag :h1, h(@article.title) %>
+        <%= content_tag :p, h(@article.content) %>
+      </div>
+    </div>
+    <div class="aside">
+      <div class="section">
+        <h1>Related Links</h1>
+        <ul class="links">
+          <%= content_tag :li, link_to('Edit', edit_article_path(@article)) %>
+          <%= content_tag :li, link_to('Back', articles_path(@article)) %>
+        </ul>
+      </div>
+    </div>
+
+Managing Attributes
+-------------------
+Shakes does its best to automatically determine the attributes on your models. If left to its own devices, Shakes will
+use all of the attributes defined in your migrations with the exception of `id`, `created_at` and `updated_at`, but
+sometimes this just isn't enough.
+
+You can use the `resource_attributes` hint to help Shakes determine which attributes are available your model. You can
+pass the options `only`, `except` or `with`. The `only` and `except` options work as you would expect. The `with` option
+allows you to specify any additional attributes that are available. If you've defined a virtual attribute on your
+`Article` model named `tag_list`, you would tell Shakes about it like so:
 
-Change The Default Actions
---------------------------
+    class ArticlesController < ApplicationController
+      has_the_shakes
+      resource_attributes :with => [:tag_list]
+    end
+
+If you need to control which attributes should be used for a specific view, you can do this as well. The
+`index_attributes`, `show_attributes`, `new_attributes` and `edit_attributes` hints are all available. If you want to
+manage your `new` and `edit` views at the same time, there is a combined `form_attributes` hint as well. All of these
+additional hints take the options `only`, `except` and `with`.
+
+For all attribute hints, I recommend using `except` or `with` over `only`. This allows Shakes to pick up changes to your
+models at the migration level.
+
+Changing The Default Actions
+----------------------------
 You can change the default actions that Shakes uses. First you need to install the Shakes initializer at
 `config/initializers/shakes.rb`. Run the following command to install the initialization file (this will also generate a
 Shakes aware layout):
@@ -64,7 +129,7 @@ action I would create a module like so:
 
     module ShakesIndexOverride
       def index
-        # default index implementation goes here
+        # new default index implementation goes here
       end
     end
 
@@ -75,8 +140,8 @@ configuration to the following:
     # Set the default index action module. Default is Shakes::Actions::Index
     Shakes::HasTheShakes::Configuration.index_action = ShakesIndexOverride
     
-Change The Default Views
-------------------------
+Changing The Default Views
+--------------------------
 If you want to change the default views that Shakes uses, you can run the following command and editable files will be
 placed in `app/views/shakes`:
 
@@ -85,7 +150,7 @@ placed in `app/views/shakes`:
 Now, if I wanted the show view to render like the original scaffold markup, I could do that by modifying
 `app/views/shakes/show.html.erb` to the following:
 
-    <%- shakes_fields_for(:show).each do |field| -%>
+    <%- show_attributes.each do |field| -%>
       <% content_tag :p do %>
         <%= content_tag :b, shakes_human_attribute_name_for(field) %>
         <%= h @resource[field] %>
@@ -112,8 +177,8 @@ Than you can modify `config/initializers/shakes.rb` like so:
     Shakes::Helpers::ViewsHelper::Configuration.use_markdown = true
 
 
-Shakes Aware Layouts
---------------------
+Creating Shakes Aware Layouts
+-----------------------------
 To get the most out of Shakes, I suggest you install and use the stylesheets that are included in the gem. Run the
 following command to install the stylesheets and create a version of `app/views/layouts/application.html.erb` that
 includes them for you:
@@ -127,4 +192,6 @@ following command will create a new Shakes aware layout at `app/views/layouts/ar
 
 TODO
 ----
-* Test against Rails 3
+* Add validation error messages to forms
+* Style flash messages
+* Support Rails 3

data/app/views/shakes/_form.html.erb

@@ -1,8 +1,8 @@
 <%- unless Shakes::Helpers::ViewsHelper::Configuration.use_formtastic -%>
-<% form_for(@resource, :url => shakes_path_for(((action.eql? :new) ? :create : :update ), @resource)) do |form| %>
+<% form_for(@resource, :url => controller_action_path(controller, ((action.eql? :new) ? :create : :update ), @resource)) do |form| %>
   <fieldset class="fields">
     <ol>
-    <%- shakes_fields_for(action).each do |field| -%>
+    <%- form_attributes(action).each do |field| -%>
       <% content_tag :li, :class => ['field', shakes_field_type_for(field).to_s].join(' ') do -%>
         <%= shakes_render_field field, action, @resource, form %>
       <%- end %>
@@ -18,7 +18,7 @@
   </fieldset>
 <% end %>
 <%- else -%>
-<% semantic_form_for(@resource, :url => shakes_path_for(action, @resource)) do |form| %>
+<% semantic_form_for(@resource, :url => controller_action_path(controller, action, @resource)) do |form| %>
   <%= form.inputs %>
   <%= form.buttons %>
 <% end %>

data/app/views/shakes/index.html.erb

@@ -3,18 +3,24 @@
     <%= title "List #{shakes_human_name.pluralize}", :h1 %>
     <table class="collection">
       <tr class="headers">
-      <%- shakes_fields_for(:index).each do |field| -%>
+      <%- index_attributes.each do |field| -%>
         <%= content_tag :th, shakes_human_attribute_name_for(field).titleize %>
       <%- end -%>
         <%= content_tag :th, 'Actions', :class => 'actions' %>
       </tr>
     <%- @resources.each do |resource| -%>
       <tr class="fields">
-      <%- shakes_fields_for(:index).each do |field| -%>
+      <%- index_attributes.each do |field| -%>
         <%= content_tag :td, shakes_render_field(field, :index, resource),
             :class => ['field', shakes_field_type_for(field).to_s].join(' ') %>
       <%- end -%>
-        <%= content_tag :td, shakes_link_to_for([:show, :edit, :destroy], resource, :short_name => true).join(' | '), :class => 'actions' %>
+        <% content_tag :td, :class => 'actions' do %>
+          <ul class="links">
+          <% shakes_link_to_for([:show, :edit, :destroy], resource, :short_name => true).each do |link| %>
+            <%= content_tag :li, link %>
+          <% end %>
+          </ul>
+        <% end %>
       </tr>
     <%- end -%>
     </table>

data/app/views/shakes/show.html.erb

@@ -2,7 +2,7 @@
   <div class="section">
     <%= title "Show #{shakes_human_name}", :h1 %>
     <ol class="fields">
-    <%- shakes_fields_for(:show).each do |field| -%>
+    <%- show_attributes.each do |field| -%>
       <% content_tag :li, :class => ['field', shakes_field_type_for(field).to_s].join(' ') do -%>
         <%= shakes_render_field field, :show, @resource %>
       <%- end %>

data/lib/shakes/actions/create.rb

@@ -2,11 +2,11 @@ module Shakes
   module Actions
     module Create
       def create
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.new(params[self.class.shakes_resource_name.to_sym]))
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.new(params[self.class.resource_name.to_sym]))
 
         respond_to do |format|
           if @resource.save
-            format.html { redirect_to(shakes_path_for(:show, @resource), :notice => "#{self.class.shakes_resource.to_s} was successfully created.") }
+            format.html { redirect_to(controller_action_path(self, :show, @resource), :notice => "#{self.class.resource_class.to_s} was successfully created.") }
             format.xml  { render :xml => @resource, :status => :created, :location => @resource }
             format.json { render :json => @resource, :status => :created, :location => @resource }
           else

data/lib/shakes/actions/destroy.rb

@@ -2,11 +2,11 @@ module Shakes
   module Actions
     module Destroy
       def destroy
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.find(params[:id]))
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
         @resource.destroy
 
         respond_to do |format|
-          format.html { redirect_to(shakes_path_for(:index)) }
+          format.html { redirect_to(controller_action_path(self, :index)) }
           format.xml  { head :ok }
           format.json { head :ok }
         end

data/lib/shakes/actions/edit.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module Edit
       def edit
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.find(params[:id]))
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
       end
     end
   end

data/lib/shakes/actions/index.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module Index
       def index
-        @resources = instance_variable_set("@#{self.class.shakes_resource_collection_name}", self.class.shakes_resource.all)
+        @resources = instance_variable_set("@#{self.class.resource_collection_name}", self.class.resource_class.all)
 
         respond_to do |format|
           format.html # index.html.erb

data/lib/shakes/actions/new.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module New
       def new
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.new)
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.new)
 
         respond_to do |format|
           format.html # new.html.erb

data/lib/shakes/actions/show.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module Show
       def show
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.find(params[:id]))
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
 
         respond_to do |format|
           format.html # show.html.erb

data/lib/shakes/actions/update.rb

@@ -2,11 +2,11 @@ module Shakes
   module Actions
     module Update
       def update
-        @resource = instance_variable_set("@#{self.class.shakes_resource_name}", self.class.shakes_resource.find(params[:id]))
+        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
 
         respond_to do |format|
-          if @resource.update_attributes(params[self.class.shakes_resource_name.to_sym])
-            format.html { redirect_to(shakes_path_for(:show, @resource), :notice => "#{self.class.shakes_resource.to_s} was successfully updated.") }
+          if @resource.update_attributes(params[self.class.resource_name.to_sym])
+            format.html { redirect_to(controller_action_path(self, :show, @resource), :notice => "#{self.class.resource_class.to_s} was successfully updated.") }
             format.xml  { head :ok }
             format.json { head :ok }
           else

data/lib/shakes/has_the_shakes.rb

@@ -19,16 +19,17 @@ module Shakes
     
     module ClassMethods
       def has_the_shakes(options={})
-        cattr_accessor :shakes_controller_name
-        self.shakes_controller_name ||= self.name.sub!(/Controller$/,'').singularize.underscore
-        cattr_accessor :shakes_resource_name
-        self.shakes_resource_name ||= options[:resource] ? options[:resource].to_s.singularize : self.shakes_controller_name
-        cattr_accessor :shakes_resource_collection_name
-        self.shakes_resource_collection_name ||= self.shakes_resource_name.pluralize
-        cattr_accessor :shakes_resource
-        self.shakes_resource ||= Object::const_get(self.shakes_resource_name.classify)
+        
+        cattr_accessor :resource_name
+        self.resource_name ||= options[:resource] ? options[:resource].to_s.singularize : self.controller_name.singularize
+        cattr_accessor :resource_collection_name
+        self.resource_collection_name ||= self.resource_name.pluralize
+        cattr_accessor :resource_class
+        self.resource_class ||= Object::const_get(self.resource_name.classify)
         send :include, InstanceMethods
 
+        # puts "resource: #{self.method(:resource)}"
+
         cattr_accessor :shakes_actions
         self.shakes_actions = (options[:only] || SHAKES_ACTIONS) - (options[:except] || [])
         send :include, Configuration.index_action   if self.shakes_actions.include? :index
@@ -39,6 +40,42 @@ module Shakes
         send :include, Configuration.update_action  if self.shakes_actions.include? :update
         send :include, Configuration.destroy_action if self.shakes_actions.include? :destroy
       end
+      
+      def resource_attributes(options={})
+        @resource_attributes = (options[:only] || default_resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @resource_attributes || default_resource_attributes
+      end
+      
+      def index_attributes(options={})
+        @index_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @index_attributes || resource_attributes
+      end
+      
+      def show_attributes(options={})
+        @show_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @show_attributes || resource_attributes
+      end
+      
+      def form_attributes(options={})
+        @form_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @form_attributes || resource_attributes
+      end
+      
+      def new_attributes(options={})
+        @new_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @new_attributes || form_attributes
+      end
+      
+      def edit_attributes(options={})
+        @edit_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @edit_attributes || form_attributes
+      end
+      
+      protected
+      
+      def default_resource_attributes
+        (self.resource_class.column_names - %w{id created_at updated_at}).map { |f| f.to_sym }
+      end
     end
   
     module InstanceMethods
@@ -57,8 +94,8 @@ module Shakes
       private
     
       def locate_resource?
-        @resources ||= instance_variable_get("@#{self.class.shakes_resource_collection_name}")
-        @resource ||= instance_variable_get("@#{self.class.shakes_resource_name}")
+        @resources ||= instance_variable_get("@#{self.class.resource_collection_name}")
+        @resource ||= instance_variable_get("@#{self.class.resource_name}")
         (@resources || @resource)
       end
     end

data/lib/shakes/helpers/url_helper.rb

@@ -1,24 +1,18 @@
 module Shakes
   module Helpers
     module UrlHelper
-      def shakes_path_for(action, resource=nil)
+      def controller_action_path(controller, action, resource=nil)
         case action
         when :index, :create
-          method("#{shakes_controller_name.pluralize}_path".to_sym).call
+          method("#{controller.class.controller_name}_path".to_sym).call
         when :new
-          method("new_#{shakes_controller_name}_path".to_sym).call
+          method("new_#{controller.class.controller_name.singularize}_path".to_sym).call
         when :show, :update, :destroy
-          method("#{shakes_controller_name}_path".to_sym).call(resource)
+          method("#{controller.class.controller_name.singularize}_path".to_sym).call(resource)
         when :edit
-          method("edit_#{shakes_controller_name}_path".to_sym).call(resource)
+          method("edit_#{controller.class.controller_name.singularize}_path".to_sym).call(resource)
         end
       end
-      
-      private
-      
-      def shakes_controller_name
-        (controller || self).class.shakes_controller_name
-      end
     end
   end
 end

data/lib/shakes/helpers/views_helper.rb

@@ -12,24 +12,35 @@ module Shakes
         (args.empty?) ? @shakes_title : content_tag(args.shift, @shakes_title, (args.shift || {}))
       end
       
+      def index_attributes
+        controller.class.index_attributes
+      end
+      
+      def show_attributes
+        controller.class.show_attributes
+      end
+      
+      def form_attributes(action)
+        (action.eql? :new) ? controller.class.new_attributes : controller.class.edit_attributes
+      end
+
       def shakedown(content, options={})
         Configuration.use_markdown && options[:markdown] ? markdown(h(content)) : h(content)
       end
+
+
       
       def shakes_field_type_for(field)
-        controller.class.shakes_resource.columns_hash[field.to_s].type
-      end
-      
-      def shakes_fields_for(action)
-        (controller.class.shakes_resource.column_names - %w{id created_at updated_at}).map { |f| f.to_sym }
+        columns_hash = controller.class.resource_class.columns_hash
+        (columns_hash.has_key? field.to_s) ? columns_hash[field.to_s].type : 'string'
       end
       
       def shakes_human_attribute_name_for(field)
-        controller.class.shakes_resource.human_attribute_name field
+        controller.class.resource_class.human_attribute_name field
       end
       
       def shakes_human_name
-        controller.class.shakes_resource.human_name
+        controller.class.resource_class.human_name
       end
       
       def shakes_link_to_for(actions=[], *args)
@@ -40,15 +51,15 @@ module Shakes
         (actions.map { |action| action.to_sym }).each do |action|
           case action
           when :index
-            links << link_to((options[:short_name] ? 'List' : "List all #{shakes_human_name.pluralize}"), shakes_path_for(:index)) if controller.respond_to? :index
+            links << link_to((options[:short_name] ? 'List' : "List all #{shakes_human_name.pluralize}"), controller_action_path(controller, :index)) if controller.respond_to? :index
           when :new
-            links << link_to((options[:short_name] ? 'New' : "Create a new #{shakes_human_name}"), shakes_path_for(:new)) if controller.respond_to? :new
+            links << link_to((options[:short_name] ? 'New' : "Create a new #{shakes_human_name}"), controller_action_path(controller, :new)) if controller.respond_to? :new
           when :show
-            links << link_to((options[:short_name] ? 'Show' : "Show this #{shakes_human_name}"), shakes_path_for(:show, resource)) if controller.respond_to? :show
+            links << link_to((options[:short_name] ? 'Show' : "Show this #{shakes_human_name}"), controller_action_path(controller, :show, resource)) if controller.respond_to? :show
           when :edit
-            links << link_to((options[:short_name] ? 'Edit' : "Edit this #{shakes_human_name}"), shakes_path_for(:edit, resource)) if controller.respond_to? :edit
+            links << link_to((options[:short_name] ? 'Edit' : "Edit this #{shakes_human_name}"), controller_action_path(controller, :edit, resource)) if controller.respond_to? :edit
           when :destroy
-            links << link_to((options[:short_name] ? 'Delete' : "Delete this #{shakes_human_name}"), shakes_path_for(:destroy, resource), :confirm => 'Are you sure?', :method => :delete) if controller.respond_to? :destroy
+            links << link_to((options[:short_name] ? 'Delete' : "Delete this #{shakes_human_name}"), controller_action_path(controller, :destroy, resource), :confirm => 'Are you sure?', :method => :delete) if controller.respond_to? :destroy
           end
         end
         links
@@ -59,7 +70,7 @@ module Shakes
             :locals => { :action => action, :field => field, :resource => resource, :form => form }
       end
       
-      protected
+      private
       
       def partial_directory_for(action)
         case action.to_sym
@@ -71,8 +82,7 @@ module Shakes
       end
       
       def partial_name_for(field, action)
-        field_type = (shakes_field_type_for field).to_sym
-        
+        field_type = shakes_field_type_for(field).to_sym
         case action.to_sym
         when :new, :edit
           case field_type

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shakes
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 4
-  version: 0.4.4
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jason Stahl