shakes 0.1.1 → 0.2.0

data/README.md

@@ -13,22 +13,29 @@ Installing Shakes
 Add it to your environment.rb configuration as a gem dependency:
 
     config.gem 'shakes'
-    
+
 Tell Rails to install the required gems:
 
     rake gems:install
 
 Using Shakes
 ------------
-Using shakes is simple. If we were working with a new Article resource, we could add the following code to our
+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:
 
     class ArticlesController < ApplicationController
       by_convention
     end
 
-Overriding the default implementation is simple. You can just add your custom action implementation to your controller
-as usual:
+You can limit the actions that are implemented by default passing the `only` or `except` option to `by_convention`. 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]
+    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
@@ -38,26 +45,41 @@ as usual:
       end
     end
 
-You can also limit the actions that are implemented by default passing the `only` or `except` option to `by_convention`.
-For example, if you just wanted to have default implementations for `index` and `show` you would use the following code:
+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.
 
-    class ArticlesController < ApplicationController
-      by_convention :only => [:index, :show]
-    end
+Generators
+----------
+Shakes provides a collection of generators that are designed to help you better take advantage of Shakes.
+
+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`:
+
+    script/generate shakes_views
+
+If you want to install the Formtastic stylesheets and create a version of `app/views/layout/application.html.erb` that
+includes them for you, run the following command:
+
+    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 layout at `app/views/layouts/article.html.erb`:
+
+    script/generate shakes_layout article
 
-Override the default views is just as simple. If I wanted to change the view for show, I could just create my custom
-view at `app/views/article/show.html.erb` and Shakes use that view. For example, my `app/views/article/show.html.erb`
-could be:
+You can create the customizable default views and the application layout in one easy step. Just run the following
+command and both generators will execute for you:
 
-    <h1><%=h @article.title %></h1>
-    <p><%=h @article.content%></p>
+    script/generate shakes
 
 Formtastic
 ----------
 The default `new` and `edit` view implementations use Formtastic to create the form HTML. To get the most out of
-Formtastic, I suggest you install and use the stylesheets that are included in the gem.
+Formtastic, I suggest you install and use the stylesheets that are included in the gem. See the section on Generators
+above to see how this can be done automatically for you.
 
-Run the following command to install the stylesheets:
+Run the following command to install the stylesheets (and the Formtastic initializer):
 
     script/generate formtastic
 
@@ -74,5 +96,4 @@ See the [Formtastic](http://github.com/justinfrench/formtastic) project page for
 TODO
 ----
 * Test against Rails 3 (needs GA'ed Formtastic support for Rails 3)
-* Allow for application specific overrides of default implementations
-* Support Haml
+* Allow for application specific overrides of default action implementations

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

@@ -0,0 +1,12 @@
+<h1>Editing <%= @resource_class.human_name.downcase %></h1>
+<%= render :partial => 'shakes/form' %>
+
+<%- if @controller_class.new.respond_to? :show %>
+  <%= link_to 'Show', @resource %>
+<% end -%>
+<%- if @controller_class.new.respond_to? :show and @controller_class.new.respond_to? :index %>
+  |
+<% end -%>
+<%- if @controller_class.new.respond_to? :index %>
+  <%= link_to "Back", method("#{@resource_collection_name}_path".to_sym).call %>
+<% end -%>

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

@@ -0,0 +1,39 @@
+<h1>Listing <%= @resource_class.human_name.downcase.pluralize %></h1>
+
+<table>
+  <tr>
+    <%- @resource_class.column_names.each do |column_name| %>
+      <%- unless %W{id created_at updated_at}.include? column_name %>
+        <th><%= @resource_class.human_attribute_name column_name.to_sym %></th>
+      <% end -%>
+    <% end -%>
+  </tr>
+  <% @resources.each do |resource| %>
+    <tr>
+      <%- @resource_class.column_names.each do |column_name| %>
+        <%- unless %W{id created_at updated_at}.include? column_name %>
+          <td><%=h resource[column_name.to_sym]%></td>
+        <% end -%>
+      <% end -%>
+      <td>
+        <%- if @controller_class.new.respond_to? :show %>
+          <%= link_to 'Show', resource %>
+        <% end -%>
+      </td>
+      <td>
+        <%- if @controller_class.new.respond_to? :edit %>
+          <%= link_to 'Edit', method("edit_#{@resource_instance_name}_path".to_sym).call(resource) %>
+        <% end -%>
+      </td>
+      <td>
+        <%- if @controller_class.new.respond_to? :destroy %>
+          <%= link_to 'Destroy', resource, :confirm => 'Are you sure?', :method => :delete %>
+        <% end -%>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
+<%- if @controller_class.new.respond_to? :new %>
+  <%= link_to "New #{@resource_class.human_name.downcase}", method("new_#{@resource_instance_name}_path".to_sym).call %>
+<% end -%>

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

@@ -0,0 +1,6 @@
+<h1>New <%= @resource_class.human_name.downcase %></h1>
+<%= render :partial => 'shakes/form' %>
+
+<%- if @controller_class.new.respond_to? :index %>
+  <%= link_to "Back", method("#{@resource_collection_name}_path".to_sym).call %>
+<% end -%>

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

@@ -0,0 +1,18 @@
+<%- @resource_class.column_names.each do |column_name| %>
+  <%- unless %W{id created_at updated_at}.include? column_name %>
+    <p>
+      <b><%= @resource_class.human_attribute_name column_name.to_sym %>:</b>
+      <%=h @resource[column_name.to_sym]%>
+    </p>
+  <% end -%>
+<% end -%>
+
+<%- if @controller_class.new.respond_to? :edit %>
+  <%= link_to 'Edit', method("edit_#{@resource_instance_name}_path".to_sym).call(@resource) %>
+<% end -%>
+<%- if @controller_class.new.respond_to? :edit and @controller_class.new.respond_to? :index %>
+  |
+<% end -%>
+<%- if @controller_class.new.respond_to? :index %>
+  <%= link_to "Back", method("#{@resource_collection_name}_path".to_sym).call %>
+<% end -%>

data/generators/shakes/shakes_generator.rb

@@ -0,0 +1,22 @@
+class ShakesGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.dependency 'shakes_layout', []
+      m.dependency 'shakes_views', []
+    end
+  end
+  
+  def file_name
+    @name.underscore
+  end
+  
+  protected
+ 
+  def banner
+    "Usage: #{$0} #{spec.name}"
+  end
+end

data/generators/shakes_layout/shakes_layout_generator.rb

@@ -0,0 +1,28 @@
+class ShakesLayoutGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || 'application'
+  end
+  
+  def manifest
+    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
+  
+  def file_name
+    @name.underscore
+  end
+  
+  protected
+ 
+  def banner
+    "Usage: #{$0} #{spec.name} [layout_name]"
+  end
+end

data/generators/shakes_layout/templates/layout.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title><%%= "#{controller.controller_name}##{controller.action_name}" %></title>
+  <%%= formtastic_stylesheet_link_tag %>
+  <%%= stylesheet_link_tag '<%= file_name %>' %>
+  <%%= yield :head %>
+</head>
+<body>
+  <%%- flash.each do |name, message| -%>
+    <%%= content_tag :p, message, :id => "flash_#{name}" %>
+  <%%- end -%>
+  <%%= yield %>
+</body>
+</html>

data/generators/shakes_layout/templates/stylesheet.css

@@ -0,0 +1,17 @@
+body {
+	background-color: #fff;
+	color: #666;
+	font-family: Tahoma,Arial,Helvetica,sans-serif;
+	margin: 1em auto;
+	width: 940px;
+}
+a {
+	color: #000;
+	font-weight: bold;
+}
+h1, h2, h3, h4, h5, h6 {
+	color: #696;
+	font-family: Georgia,Utopia,Palatino,'Palatino Linotype',serif;
+	font-variant: small-caps;
+	letter-spacing: 0.1em;
+}

data/generators/shakes_views/shakes_views_generator.rb

@@ -0,0 +1,27 @@
+class ShakesViewsGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  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"
+      m.file '../../../app/views/shakes/new.html.erb', "app/views/shakes/new.html.erb"
+      m.file '../../../app/views/shakes/show.html.erb', "app/views/shakes/show.html.erb"
+    end
+  end
+  
+  def file_name
+    @name.underscore
+  end
+  
+  protected
+ 
+  def banner
+    "Usage: #{$0} #{spec.name}"
+  end
+end

data/generators/shakes_views/templates/touchfile

@@ -0,0 +1,3 @@
+*** DO NOT REMOVE**
+
+This file causes the templates directory to be included in the gem...

data/lib/shakes.rb

@@ -1,6 +1,4 @@
 module Shakes
   autoload :ByConvention, 'shakes/by_convention'
-  autoload :Helpers,      'shakes/helpers'
 end
 ActionController::Base.send :include, Shakes::ByConvention
-ActionView::Base.send :include, Shakes::Helpers

data/lib/shakes/by_convention.rb

@@ -55,18 +55,7 @@ module Shakes
           resource_collection_name
           resource_instance_name
 
-          case options[:action]
-          when 'index'
-            super 'shakes/by_convention/index.html.erb'
-          when 'new'
-            super 'shakes/by_convention/new.html.erb'
-          when 'show'
-            super 'shakes/by_convention/show.html.erb'
-          when 'edit'
-            super 'shakes/by_convention/edit.html.erb'
-          else
-            raise
-          end
+          super "shakes/#{options[:action]}.html.erb"
         end
       end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shakes
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason Stahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-25 00:00:00 -05:00
+date: 2010-05-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,13 +43,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- app/views/shakes/by_convention/_form.html.erb
-- app/views/shakes/by_convention/edit.html.erb
-- app/views/shakes/by_convention/index.html.erb
-- app/views/shakes/by_convention/new.html.erb
-- app/views/shakes/by_convention/show.html.erb
+- app/views/shakes/_form.html.erb
+- app/views/shakes/edit.html.erb
+- app/views/shakes/index.html.erb
+- app/views/shakes/new.html.erb
+- app/views/shakes/show.html.erb
+- generators/shakes/shakes_generator.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/helpers.rb
 - lib/shakes.rb
 - rails/init.rb
 - README.md
@@ -58,7 +63,7 @@ has_rdoc: true
 homepage: http://github.com/jfs/shakes
 licenses: []
 
-post_install_message: 
+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  "
 rdoc_options: []
 
 require_paths: 

data/app/views/shakes/by_convention/edit.html.erb

@@ -1,4 +0,0 @@
-<h1>Editing <%= @resource_class.human_name.downcase %></h1>
-<%= render :partial => 'shakes/by_convention/form' %>
-
-<%= link_to_show_resource_path(@resource) %> | <%= link_to_index_resources_path %>

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

@@ -1,27 +0,0 @@
-<h1>Listing <%= @resource_class.human_name.downcase.pluralize %></h1>
-
-<table>
-  <tr>
-    <%- @resource_class.column_names.each do |column_name| %>
-      <%- unless %W{id created_at updated_at}.include? column_name %>
-        <th><%= @resource_class.human_attribute_name column_name.to_sym %></th>
-      <% end -%>
-    <% end -%>
-  </tr>
-  <% @resources.each do |resource| %>
-    <tr>
-      <%- @resource_class.column_names.each do |column_name| %>
-        <%- unless %W{id created_at updated_at}.include? column_name %>
-          <td><%=h resource[column_name.to_sym]%></td>
-        <% end -%>
-      <% end -%>
-      <td><%= link_to_show_resource_path(resource) %></td>
-      <td><%= link_to_edit_resource_path(resource) %></td>
-      <td><%= link_to_destroy_resource_path(resource) %></td>
-    </tr>
-  <% end %>
-</table>
-
-<br />
-
-<%= link_to_new_resource_path %>

data/app/views/shakes/by_convention/new.html.erb

@@ -1,4 +0,0 @@
-<h1>New <%= @resource_class.human_name.downcase %></h1>
-<%= render :partial => 'shakes/by_convention/form' %>
-
-<%= link_to_index_resources_path %>

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

@@ -1,11 +0,0 @@
-<%- @resource_class.column_names.each do |column_name| %>
-  <%- unless %W{id created_at updated_at}.include? column_name %>
-    <p>
-      <b><%= @resource_class.human_attribute_name column_name.to_sym %>:</b>
-      <%=h @resource[column_name.to_sym]%>
-    </p>
-  <% end -%>
-<% end -%>
-
-
-<%= link_to_edit_resource_path(@resource) %> | <%= link_to_index_resources_path %>

data/lib/shakes/helpers.rb

@@ -1,33 +0,0 @@
-module Shakes
-  module Helpers
-    def link_to_index_resources_path
-      if @controller_class.new.respond_to? :index
-        link_to "Back", method("#{@resource_collection_name}_path".to_sym).call
-      end
-    end
-
-    def link_to_new_resource_path
-      if @controller_class.new.respond_to? :new
-        link_to "New #{@resource_class.human_name.downcase}", method("new_#{@resource_instance_name}_path".to_sym).call
-      end
-    end
-
-    def link_to_show_resource_path(resource)
-      if @controller_class.new.respond_to? :show
-        link_to 'Show', resource
-      end
-    end
-
-    def link_to_edit_resource_path(resource)
-      if @controller_class.new.respond_to? :edit
-        link_to 'Edit', method("edit_#{@resource_instance_name}_path".to_sym).call(resource)
-      end
-    end
-
-    def link_to_destroy_resource_path(resource)
-      if @controller_class.new.respond_to? :destroy
-        link_to 'Destroy', resource, :confirm => 'Are you sure?', :method => :delete
-      end
-    end
-  end
-end