shakes 0.2.0 → 0.3.0

data/README.md

@@ -1,3 +1,6 @@
+__WARNING__ At this point I am making no attempt at maintaining backwards compatibility. Consider Shakes alpha
+level code and use at your own risk.
+
 Welcome to Shakes
 =================
 Using `script/generate scaffold` creates a bunch of boilerplate code that you then have to modify by hand every time you
@@ -24,21 +27,21 @@ Using Shakes is simple. If we were working with a new `Article` resource, we cou
 controller and instantly have default actions and views for our new resource:
 
     class ArticlesController < ApplicationController
-      by_convention
+      has_the_shakes
     end
 
-You can limit the actions that are implemented by default passing the `only` or `except` option to `by_convention`. For
+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:
 
     class ArticlesController < ApplicationController
-      by_convention :only => [:index, :show]
+      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:
 
     class ArticlesController < ApplicationController
-      by_convention
+      has_the_shakes
   
       def create
         # my custom create implementation

data/generators/shakes/shakes_generator.rb

@@ -5,6 +5,8 @@ class ShakesGenerator < Rails::Generator::Base
   
   def manifest
     record do |m|
+      m.directory 'config/initializers'
+      m.file 'initializer.rb', "config/initializers/shakes.rb"
       m.dependency 'shakes_layout', []
       m.dependency 'shakes_views', []
     end

data/generators/shakes/templates/initializer.rb

@@ -0,0 +1,20 @@
+# Set the default index action module. Default is Shakes::Actions::Index
+# Shakes::HasTheShakes::Configuration.index_action = Shakes::Actions::Index
+
+# Set the default new action module. Default is Shakes::Actions::New
+# Shakes::HasTheShakes::Configuration.new_action = Shakes::Actions::New
+
+# Set the default create action module. Default is Shakes::Actions::Create
+# Shakes::HasTheShakes::Configuration.create_action = Shakes::Actions::Create
+
+# Set the default show action module. Default is Shakes::Actions::Show
+# Shakes::HasTheShakes::Configuration.show_action = Shakes::Actions::Show
+
+# Set the default edit action module. Default is Shakes::Actions::Edit
+# Shakes::HasTheShakes::Configuration.edit_action = Shakes::Actions::Edit
+
+# Set the default update action module. Default is Shakes::Actions::Update
+# Shakes::HasTheShakes::Configuration.udpate_action = Shakes::Actions::Update
+
+# Set the default destroy action module. Default is Shakes::Actions::Destroy
+# Shakes::HasTheShakes::Configuration.destroy_action = Shakes::Actions::Destroy

data/generators/shakes_layout/shakes_layout_generator.rb

@@ -8,10 +8,8 @@ class ShakesLayoutGenerator < Rails::Generator::Base
     record do |m|
       m.directory 'app/views/layouts'
       m.directory 'public/stylesheets'
-      
       m.template 'layout.html.erb', "app/views/layouts/#{file_name}.html.erb"
       m.file 'stylesheet.css', "public/stylesheets/#{file_name}.css"
-      
       m.dependency 'formtastic', []
     end
   end

data/generators/shakes_views/shakes_views_generator.rb

@@ -6,7 +6,6 @@ class ShakesViewsGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       m.directory 'app/views/shakes'
-      
       m.file '../../../app/views/shakes/_form.html.erb', "app/views/shakes/_form.html.erb"
       m.file '../../../app/views/shakes/edit.html.erb', "app/views/shakes/edit.html.erb"
       m.file '../../../app/views/shakes/index.html.erb', "app/views/shakes/index.html.erb"

data/lib/shakes.rb

@@ -1,4 +1,5 @@
 module Shakes
-  autoload :ByConvention, 'shakes/by_convention'
+  autoload :Actions,      'shakes/actions'
+  autoload :HasTheShakes, 'shakes/has_the_shakes'
 end
-ActionController::Base.send :include, Shakes::ByConvention
+ActionController::Base.send :include, Shakes::HasTheShakes

data/lib/shakes/actions.rb

@@ -0,0 +1,11 @@
+module Shakes
+  module Actions
+    autoload :Index,    'shakes/actions/index'
+    autoload :New,      'shakes/actions/new'
+    autoload :Create,   'shakes/actions/create'
+    autoload :Show,     'shakes/actions/show'
+    autoload :Edit,     'shakes/actions/edit'
+    autoload :Update,   'shakes/actions/update'
+    autoload :Destroy,  'shakes/actions/destroy'
+  end
+end

data/lib/shakes/actions/create.rb

@@ -0,0 +1,21 @@
+module Shakes
+  module Actions
+    module Create
+      def create
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.new(params[resource_instance_name.to_sym]))
+
+        respond_to do |format|
+          if @resource.save
+            format.html { redirect_to(@resource, :notice => "#{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
+            format.html { render :action => "new" }
+            format.xml  { render :xml => @resource.errors, :status => :unprocessable_entity }
+            format.json { render :json => @resource.errors, :status => :unprocessable_entity }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shakes/actions/destroy.rb

@@ -0,0 +1,16 @@
+module Shakes
+  module Actions
+    module Destroy
+      def destroy
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
+        @resource.destroy
+
+        respond_to do |format|
+          format.html { redirect_to(method("#{resource_collection_name}_url".to_sym).call) }
+          format.xml  { head :ok }
+          format.json { head :ok }
+        end
+      end
+    end
+  end
+end

data/lib/shakes/actions/edit.rb

@@ -0,0 +1,9 @@
+module Shakes
+  module Actions
+    module Edit
+      def edit
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
+      end
+    end
+  end
+end

data/lib/shakes/actions/index.rb

@@ -0,0 +1,15 @@
+module Shakes
+  module Actions
+    module Index
+      def index
+        @resources = instance_variable_set("@#{resource_collection_name}", resource_class.all)
+
+        respond_to do |format|
+          format.html # index.html.erb
+          format.xml  { render :xml => @resources }
+          format.json { render :json => @resources }
+        end      
+      end
+    end
+  end
+end

data/lib/shakes/actions/new.rb

@@ -0,0 +1,15 @@
+module Shakes
+  module Actions
+    module New
+      def new
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.new)
+
+        respond_to do |format|
+          format.html # new.html.erb
+          format.xml  { render :xml => @resource }
+          format.json { render :json => @resource }
+        end
+      end
+    end
+  end
+end

data/lib/shakes/actions/show.rb

@@ -0,0 +1,15 @@
+module Shakes
+  module Actions
+    module Show
+      def show
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
+
+        respond_to do |format|
+          format.html # show.html.erb
+          format.xml  { render :xml => @resource }
+          format.json { render :json => @resource }
+        end
+      end
+    end
+  end
+end

data/lib/shakes/actions/update.rb

@@ -0,0 +1,21 @@
+module Shakes
+  module Actions
+    module Update
+      def update
+        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
+
+        respond_to do |format|
+          if @resource.update_attributes(params[resource_instance_name.to_sym])
+            format.html { redirect_to(@resource, :notice => "#{resource_class.to_s} was successfully updated.") }
+            format.xml  { head :ok }
+            format.json { head :ok }
+          else
+            format.html { render :action => "edit" }
+            format.xml  { render :xml => @resource.errors, :status => :unprocessable_entity }
+            format.json { render :json => @resource.errors, :status => :unprocessable_entity }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shakes/has_the_shakes.rb

@@ -0,0 +1,84 @@
+module Shakes
+  module HasTheShakes
+    class Configuration
+      cattr_accessor :index_action, :new_action, :create_action, :show_action, :edit_action, :update_action, :destroy_action
+      self.index_action   = Shakes::Actions::Index
+      self.new_action     = Shakes::Actions::New
+      self.create_action  = Shakes::Actions::Create
+      self.show_action    = Shakes::Actions::Show
+      self.edit_action    = Shakes::Actions::Edit
+      self.update_action  = Shakes::Actions::Update
+      self.destroy_action = Shakes::Actions::Destroy
+    end
+  
+    SHAKES_ACTIONS = [:index, :new, :create, :show, :edit, :update, :destroy]
+  
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+    
+    module ClassMethods
+      def has_the_shakes(options={})
+        cattr_accessor :shakes_resource
+        self.shakes_resource = options[:resource] ? options[:resource].to_s : self.name.sub!(/Controller$/,'')
+        send :include, InstanceMethods
+
+        cattr_accessor :shakes_actions
+        self.shakes_actions = (options[:only] || SHAKES_ACTIONS) - (options[:except] || [])
+        send :include, Configuration.index_action   if self.shakes_actions.include? :index
+        send :include, Configuration.new_action     if self.shakes_actions.include? :new
+        send :include, Configuration.create_action  if self.shakes_actions.include? :create
+        send :include, Configuration.show_action    if self.shakes_actions.include? :show
+        send :include, Configuration.edit_action    if self.shakes_actions.include? :edit
+        send :include, Configuration.update_action  if self.shakes_actions.include? :update
+        send :include, Configuration.destroy_action if self.shakes_actions.include? :destroy
+      end
+    end
+  
+    module InstanceMethods
+      def controller_class
+        @controller_class ||= Object::const_get(self.class.name.classify)
+      end
+
+      def resource_class
+        @resource_class ||= Object::const_get(self.class.shakes_resource.classify)
+      end
+    
+      def resource_collection_name
+        @resource_collection_name ||= self.class.shakes_resource.tableize.pluralize
+      end
+    
+      def resource_instance_name
+        @resource_instance_name ||= self.class.shakes_resource.tableize.singularize
+      end
+
+      def render(options = nil, extra_options = {}, &block)
+        begin
+          super
+        rescue ActionView::MissingTemplate
+          raise unless locate_resource?
+          
+          options ||= {}
+          options[:action] ||= params[:action]
+
+          raise unless self.shakes_actions.include? options[:action].to_sym
+
+          controller_class
+          resource_class
+          resource_collection_name
+          resource_instance_name
+
+          super "shakes/#{options[:action]}.html.erb"
+        end
+      end
+    
+      private
+    
+      def locate_resource?
+        @resources ||= instance_variable_get("@#{resource_collection_name}")
+        @resource ||= instance_variable_get("@#{resource_instance_name}")
+        (@resources || @resource)
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shakes
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jason Stahl
@@ -49,12 +49,21 @@ files:
 - app/views/shakes/new.html.erb
 - app/views/shakes/show.html.erb
 - generators/shakes/shakes_generator.rb
+- generators/shakes/templates/initializer.rb
 - generators/shakes_layout/shakes_layout_generator.rb
 - generators/shakes_layout/templates/layout.html.erb
 - generators/shakes_layout/templates/stylesheet.css
 - generators/shakes_views/shakes_views_generator.rb
 - generators/shakes_views/templates/touchfile
-- lib/shakes/by_convention.rb
+- lib/shakes/actions/create.rb
+- lib/shakes/actions/destroy.rb
+- lib/shakes/actions/edit.rb
+- lib/shakes/actions/index.rb
+- lib/shakes/actions/new.rb
+- lib/shakes/actions/show.rb
+- lib/shakes/actions/update.rb
+- lib/shakes/actions.rb
+- lib/shakes/has_the_shakes.rb
 - lib/shakes.rb
 - rails/init.rb
 - README.md
@@ -63,7 +72,7 @@ has_rdoc: true
 homepage: http://github.com/jfs/shakes
 licenses: []
 
-post_install_message: "\n  ========================================================================\n  Thanks for installing Shakes!\n  ------------------------------------------------------------------------\n  You can start using Shakes immedialy by adding Shakes to your\n  environment.rb configuration as a gem dependency:\n  \n      config.gem 'shakes'\n\n  Then tell Shakes which controllers to provide default implementations\n  for by adding `by_convention` to them:\n  \n      class ArticlesController < ApplicationController\n        by_convention\n      end\n\n  Find out more and get involved:\n  \n      http://github.com/jfs/shakes\n  ========================================================================\n  "
+post_install_message: "\n  ========================================================================\n  Thanks for installing Shakes!\n  ------------------------------------------------------------------------\n  You can start using Shakes immedialy by adding Shakes to your\n  environment.rb configuration as a gem dependency:\n  \n      config.gem 'shakes'\n\n  Then tell Shakes which controllers to provide default implementations\n  for by adding `has_the_shakes` to them:\n  \n      class ArticlesController < ApplicationController\n        has_the_shakes\n      end\n\n  Find out more and get involved:\n  \n      http://github.com/jfs/shakes\n  ========================================================================\n  "
 rdoc_options: []
 
 require_paths: 

data/lib/shakes/by_convention.rb

@@ -1,162 +0,0 @@
-module Shakes
-  module ByConvention
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
-  
-    CONVENTIONAL_ACTIONS = [:index, :new, :create, :show, :edit, :update, :destroy]
-  
-    module ClassMethods
-      def by_convention(options={})
-        cattr_accessor :resource_type
-        self.resource_type = options[:resource] ? options[:resource].to_s : self.name.sub!(/Controller$/,'')
-        send :include, InstanceMethods
-
-        cattr_accessor :conventional_actions
-        self.conventional_actions = (options[:only] || CONVENTIONAL_ACTIONS) - (options[:except] || [])
-        send :include, IndexInstanceMethods if self.conventional_actions.include? :index
-        send :include, NewInstanceMethods if self.conventional_actions.include? :new
-        send :include, CreateInstanceMethods if self.conventional_actions.include? :create
-        send :include, ShowInstanceMethods if self.conventional_actions.include? :show
-        send :include, EditInstanceMethods if self.conventional_actions.include? :edit
-        send :include, UpdateInstanceMethods if self.conventional_actions.include? :update
-        send :include, DestroyInstanceMethods if self.conventional_actions.include? :destroy
-      end
-    end
-  
-    module InstanceMethods
-      def controller_class
-        @controller_class ||= Object::const_get(self.class.name.classify)
-      end
-
-      def resource_class
-        @resource_class ||= Object::const_get(self.class.resource_type.classify)
-      end
-    
-      def resource_collection_name
-        @resource_collection_name ||= self.class.resource_type.tableize.pluralize
-      end
-    
-      def resource_instance_name
-        @resource_instance_name ||= self.class.resource_type.tableize.singularize
-      end
-
-      def render(options = nil, extra_options = {}, &block)
-        begin
-          super
-        rescue ActionView::MissingTemplate
-          raise unless locate_resource?
-          
-          options ||= {}
-          options[:action] ||= params[:action]
-
-          controller_class
-          resource_class
-          resource_collection_name
-          resource_instance_name
-
-          super "shakes/#{options[:action]}.html.erb"
-        end
-      end
-    
-      private
-    
-      def locate_resource?
-        @resources ||= instance_variable_get("@#{resource_collection_name}")
-        @resource ||= instance_variable_get("@#{resource_instance_name}")
-        (@resources || @resource)
-      end
-    end
-    
-    module IndexInstanceMethods
-      def index
-        @resources = instance_variable_set("@#{resource_collection_name}", resource_class.all)
-
-        respond_to do |format|
-          format.html # index.html.erb
-          format.xml  { render :xml => @resources }
-          format.json { render :json => @resources }
-        end      
-      end
-    end
-    
-    module NewInstanceMethods
-      def new
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.new)
-
-        respond_to do |format|
-          format.html # new.html.erb
-          format.xml  { render :xml => @resource }
-          format.json { render :json => @resource }
-        end
-      end
-    end
-    
-    module CreateInstanceMethods
-      def create
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.new(params[resource_instance_name.to_sym]))
-
-        respond_to do |format|
-          if @resource.save
-            format.html { redirect_to(@resource, :notice => "#{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
-            format.html { render :action => "new" }
-            format.xml  { render :xml => @resource.errors, :status => :unprocessable_entity }
-            format.json { render :json => @resource.errors, :status => :unprocessable_entity }
-          end
-        end
-      end
-    end
-    
-    module ShowInstanceMethods
-      def show
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
-
-        respond_to do |format|
-          format.html # show.html.erb
-          format.xml  { render :xml => @resource }
-          format.json { render :json => @resource }
-        end
-      end
-    end
-
-    module EditInstanceMethods
-      def edit
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
-      end
-    end
-    
-    module UpdateInstanceMethods
-      def update
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
-
-        respond_to do |format|
-          if @resource.update_attributes(params[resource_instance_name.to_sym])
-            format.html { redirect_to(@resource, :notice => "#{resource_class.to_s} was successfully updated.") }
-            format.xml  { head :ok }
-            format.json { head :ok }
-          else
-            format.html { render :action => "edit" }
-            format.xml  { render :xml => @resource.errors, :status => :unprocessable_entity }
-            format.json { render :json => @resource.errors, :status => :unprocessable_entity }
-          end
-        end
-      end
-    end
-    
-    module DestroyInstanceMethods
-      def destroy
-        @resource = instance_variable_set("@#{resource_instance_name}", resource_class.find(params[:id]))
-        @resource.destroy
-
-        respond_to do |format|
-          format.html { redirect_to(method("#{resource_collection_name}_url".to_sym).call) }
-          format.xml  { head :ok }
-          format.json { head :ok }
-        end
-      end
-    end
-  end
-end