shakes 0.6.0 → 0.7.0

data/README.md

@@ -58,14 +58,14 @@ Shakes does its best to automatically determine the attributes on your models. I
 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
+You can use the `model_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:
 
     class ArticlesController < ApplicationController
       has_the_shakes
-      resource_attributes :with => [:tag_list]
+      model_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
@@ -118,21 +118,76 @@ identical to the default `new` and `create` actions. Shakes provides a better wa
 Overriding Model Instance Creation
 ----------------------------------
 Shakes will only create an instance of your model or model collection if it doesn't already exist. We can create our new
-`Article` in the scope of the current user using a before filter and not have to override the default create action at
-all. We could achieve the same result as above with the following code:
+`Article` in the scope of the current user using a before filter and not have to override the default `new` and `create`
+actions at all. We could achieve the same result as above with the following code:
 
     class ArticlesController < ApplicationController
       has_the_shakes
 
-      before_filter :create_article, :only => [:new, :create]
-  
+      before_filter :new_article, :only => [:new, :create]
+
       private
-  
-      def create_article
+
+      def new_article
         @article = @current_user.articles.build(params[:article])
       end
     end
 
+If I wanted work exclusively with the `Article` model under the scope of the current user for all actions, my code would
+look like the following:
+
+    class ArticlesController < ApplicationController
+      has_the_shakes
+
+      before_filter :find_articles, :only => [:index]
+      before_filter :new_article, :only => [:new, :create]
+      before_filter :find_article, :except => [:index, :new, :create]
+
+      private
+
+      def find_articles
+        @articles = @current_user.articles
+      end
+
+      def new_article
+        @article = @current_user.articles.build(params[:article])
+      end
+  
+      def find_article
+        @article = @current_user.articles.find(params[:id])
+      end
+    end
+
+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:
+
+    script/generate shakes_layout
+
+Additionally, you can create more named layouts by running the command and passing the layout name. For example, the
+following command will create a new Shakes aware layout at `app/views/layouts/article.html.erb`:
+
+    script/generate shakes_layout article
+
+Configuring The Views
+---------------------
+There are two configuration options available when rendering Shakes views. They tell Shakes to use
+[Formtastic](http://github.com/justinfrench/formtastic/) to render forms and Markdown to render text fields
+respectively. They both default to `false`. To change one or both to `true` you need to install the Shakes initializer.
+You can do that by running the following command (this will also generate a Shakes aware layout):
+
+    script/generate shakes
+    
+Than you can modify `config/initializers/shakes.rb` like so:
+
+    # Should Shakes attempt to use formtastic to render forms. Default is false
+    Shakes::Helpers::ViewsHelper::Configuration.use_formtastic = true
+
+    # Should Shakes attempt to use markdown to display text fields. Default is false
+    Shakes::Helpers::ViewsHelper::Configuration.use_markdown = true
+
 Overriding The Default View
 ---------------------------
 Overriding the default views for a specific resource is also simple. Like an action, you just create your view as usual.
@@ -155,19 +210,6 @@ If I wanted my `ArticlesController` to use a custom view for the `show` action,
       </div>
     </div>
 
-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:
-
-    script/generate shakes_layout
-
-Additionally, you can create more named layouts by running the command and passing the layout name. For example, the
-following command will create a new Shakes aware layout at `app/views/layouts/article.html.erb`:
-
-    script/generate shakes_layout article
-
 Changing The Default Actions
 ----------------------------
 You can change the default actions that Shakes uses. First you need to install the Shakes initializer at
@@ -213,24 +255,13 @@ Now, if I wanted the show view to render like the original scaffold markup, I co
 Alternatively, I could have just created `app/views/shakes/show.html.erb` without running the generator if that's all I
 wanted to change.
 
-Finally, there are two configuration options available when rendering Shakes views. They tell Shakes to use
-[Formtastic](http://github.com/justinfrench/formtastic/) to render forms and Markdown to render text fields
-respectively. They both default to `false`. To change one or both to `true` you need to install the Shakes initializer.
-You can do that by running the following command (this will also generate a Shakes aware layout):
-
-    script/generate shakes
-    
-Than you can modify `config/initializers/shakes.rb` like so:
-
-    # Should Shakes attempt to use formtastic to render forms. Default is false
-    Shakes::Helpers::ViewsHelper::Configuration.use_formtastic = true
-
-    # Should Shakes attempt to use markdown to display text fields. Default is false
-    Shakes::Helpers::ViewsHelper::Configuration.use_markdown = true
-
 TODO
 ----
 * Add validation error messages to forms
 * Style flash messages
 * Support custom actions and views
 * Support Rails 3
+
+Copyright
+---------
+Copyright (c) 2010 Jason Stahl. See LICENSE for details.

data/lib/shakes/has_the_shakes.rb

@@ -39,39 +39,39 @@ module Shakes
         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
+      def model_attributes(options={})
+        @model_attributes = (options[:only] || default_model_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @model_attributes || default_model_attributes
       end
       
       def index_attributes(options={})
-        @index_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
-        @index_attributes || resource_attributes
+        @index_attributes = (options[:only] || model_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @index_attributes || model_attributes
       end
       
       def show_attributes(options={})
-        @show_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
-        @show_attributes || resource_attributes
+        @show_attributes = (options[:only] || model_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @show_attributes || model_attributes
       end
       
       def form_attributes(options={})
-        @form_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
-        @form_attributes || resource_attributes
+        @form_attributes = (options[:only] || model_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @form_attributes || model_attributes
       end
       
       def new_attributes(options={})
-        @new_attributes = (options[:only] || resource_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
+        @new_attributes = (options[:only] || model_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 = (options[:only] || model_attributes) + (options[:with] || []) - (options[:except] || []) unless options.empty?
         @edit_attributes || form_attributes
       end
       
       protected
       
-      def default_resource_attributes
+      def default_model_attributes
         (self.model_class.column_names - %w{id created_at updated_at}).map { |f| f.to_sym }
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shakes
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Jason Stahl