shakes 0.5.0 → 0.6.0

data/README.md

@@ -33,13 +33,8 @@ This will create default implementations of `index`, `new`, `create`, `show`, `e
 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
-
+Limiting The Actions
+--------------------
 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:
@@ -48,12 +43,57 @@ the following code:
       has_the_shakes :only => [:index, :show]
     end
 
+Managing The Model
+------------------
+If you want to change the model that Shakes uses you can pass a `model` 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 :model => :post
+    end
+
+Managing Model 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:
+
+    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.
+
+Overriding The Default Action
+-----------------------------
 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:
+your controller as usual. If I wanted to change my `new` and `create` actions 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 new
+        @article = @current_user.articles.build
+
+        respond_to do |format|
+          format.html # new.html.erb
+          format.xml  { render :xml => @article }
+          format.json { render :json => @article }
+        end
+      end
   
       def create
         @article = @current_user.articles.build(params[:article])
@@ -72,6 +112,29 @@ current user, I could use the following code:
       end
     end
 
+All we changed in the example above is how the model was created. The bulk of the implementation is fundamentally
+identical to the default `new` and `create` actions. Shakes provides a better way.
+
+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:
+
+    class ArticlesController < ApplicationController
+      has_the_shakes
+
+      before_filter :create_article, :only => [:new, :create]
+  
+      private
+  
+      def create_article
+        @article = @current_user.articles.build(params[:article])
+      end
+    end
+
+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.
 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`:
@@ -92,29 +155,18 @@ If I wanted my `ArticlesController` to use a custom view for the `show` action,
       </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:
+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:
 
-    class ArticlesController < ApplicationController
-      has_the_shakes
-      resource_attributes :with => [:tag_list]
-    end
+    script/generate shakes_layout
 
-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`.
+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`:
 
-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.
+    script/generate shakes_layout article
 
 Changing The Default Actions
 ----------------------------
@@ -176,22 +228,9 @@ Than you can modify `config/initializers/shakes.rb` like so:
     # Should Shakes attempt to use markdown to display text fields. Default is false
     Shakes::Helpers::ViewsHelper::Configuration.use_markdown = true
 
-
-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
-
 TODO
 ----
 * Add validation error messages to forms
 * Style flash messages
+* Support custom actions and views
 * Support Rails 3

data/lib/shakes/actions/create.rb

@@ -2,11 +2,11 @@ module Shakes
   module Actions
     module Create
       def create
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.new(params[self.class.resource_name.to_sym]))
+        @resource ||= create_resource
 
         respond_to do |format|
           if @resource.save
-            format.html { redirect_to(controller_action_path(self, :show, @resource), :notice => "#{self.class.resource_class.to_s} was successfully created.") }
+            format.html { redirect_to(controller_action_path(self, :show, @resource), :notice => "#{self.class.model_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
@@ -16,6 +16,12 @@ module Shakes
           end
         end
       end
+      
+      private
+      
+      def create_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_class.new(params[self.class.model_name.to_sym])))
+      end
     end
   end
 end

data/lib/shakes/actions/destroy.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module Destroy
       def destroy
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
+        @resource ||= destroy_resource
         @resource.destroy
 
         respond_to do |format|
@@ -11,6 +11,12 @@ module Shakes
           format.json { head :ok }
         end
       end
+      
+      private
+      
+      def destroy_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_class.find(params[:id])))
+      end
     end
   end
 end

data/lib/shakes/actions/edit.rb

@@ -2,7 +2,13 @@ module Shakes
   module Actions
     module Edit
       def edit
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
+        @resource ||= edit_resource
+      end
+      
+      private
+      
+      def edit_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_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.resource_collection_name}", self.class.resource_class.all)
+        @resources ||= index_resources
 
         respond_to do |format|
           format.html # index.html.erb
@@ -10,6 +10,12 @@ module Shakes
           format.json { render :json => @resources }
         end      
       end
+      
+      private
+      
+      def index_resources
+        (instance_variable_get("@#{self.class.model_collection_name}") || instance_variable_set("@#{self.class.model_collection_name}", self.class.model_class.all))
+      end
     end
   end
 end

data/lib/shakes/actions/new.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module New
       def new
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.new)
+        @resource ||= new_resource
 
         respond_to do |format|
           format.html # new.html.erb
@@ -10,6 +10,12 @@ module Shakes
           format.json { render :json => @resource }
         end
       end
+
+      private
+
+      def new_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_class.new()))
+      end
     end
   end
 end

data/lib/shakes/actions/show.rb

@@ -2,7 +2,7 @@ module Shakes
   module Actions
     module Show
       def show
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
+        @resource ||= show_resource
 
         respond_to do |format|
           format.html # show.html.erb
@@ -10,6 +10,12 @@ module Shakes
           format.json { render :json => @resource }
         end
       end
+
+      private
+
+      def show_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_class.find(params[:id])))
+      end
     end
   end
 end

data/lib/shakes/actions/update.rb

@@ -2,11 +2,11 @@ module Shakes
   module Actions
     module Update
       def update
-        @resource = instance_variable_set("@#{self.class.resource_name}", self.class.resource_class.find(params[:id]))
+        @resource ||= update_resource
 
         respond_to do |format|
-          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.") }
+          if @resource.update_attributes(params[self.class.model_name.to_sym])
+            format.html { redirect_to(controller_action_path(self, :show, @resource), :notice => "#{self.class.model_class.to_s} was successfully updated.") }
             format.xml  { head :ok }
             format.json { head :ok }
           else
@@ -16,6 +16,12 @@ module Shakes
           end
         end
       end
+
+      private
+
+      def update_resource
+        (instance_variable_get("@#{self.class.model_name}") || instance_variable_set("@#{self.class.model_name}", self.class.model_class.find(params[:id])))
+      end
     end
   end
 end

data/lib/shakes/has_the_shakes.rb

@@ -20,16 +20,14 @@ module Shakes
     module ClassMethods
       def has_the_shakes(options={})
         
-        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)
+        cattr_accessor :model_name
+        self.model_name ||= options[:model] ? options[:model].to_s.singularize : self.controller_name.singularize
+        cattr_accessor :model_collection_name
+        self.model_collection_name ||= self.model_name.pluralize
+        cattr_accessor :model_class
+        self.model_class ||= Object::const_get(self.model_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
@@ -74,7 +72,7 @@ module Shakes
       protected
       
       def default_resource_attributes
-        (self.resource_class.column_names - %w{id created_at updated_at}).map { |f| f.to_sym }
+        (self.model_class.column_names - %w{id created_at updated_at}).map { |f| f.to_sym }
       end
     end
   
@@ -94,8 +92,8 @@ module Shakes
       private
     
       def locate_resource?
-        @resources ||= instance_variable_get("@#{self.class.resource_collection_name}")
-        @resource ||= instance_variable_get("@#{self.class.resource_name}")
+        @resources ||= instance_variable_get("@#{self.class.model_collection_name}")
+        @resource ||= instance_variable_get("@#{self.class.model_name}")
         (@resources || @resource)
       end
     end

data/lib/shakes/helpers/views_helper.rb

@@ -31,16 +31,16 @@ module Shakes
 
       
       def shakes_field_type_for(field)
-        columns_hash = controller.class.resource_class.columns_hash
+        columns_hash = controller.class.model_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.resource_class.human_attribute_name field
+        controller.class.model_class.human_attribute_name field
       end
       
       def shakes_human_name
-        controller.class.resource_class.human_name
+        controller.class.model_class.human_name
       end
       
       def shakes_link_to_for(actions=[], *args)

metadata

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