shakes 0.3.0 → 0.3.1

data/README.md

@@ -1,6 +1,3 @@
-__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
@@ -11,6 +8,8 @@ Shakes provides default implementations for your Rails controller actions and vi
 once place for all controllers. You can add the boilerplate by adding just a single line to your controller. By
 necessity, Shakes views are dynamic so as you make changes to your models those changes are reflected in the views.
 
+Shakes also provides a collection of generators that are designed to help you better take advantage of Shakes.
+
 Installing Shakes
 -----------------
 Add it to your environment.rb configuration as a gem dependency:
@@ -52,35 +51,41 @@ Overriding the default views for a specific resource is just as simple. You just
 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.
 
-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
+Change 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:
 
-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_actions
 
-    script/generate shakes_layout
+Then you can create your new default implementation for you custom default action. For example, to change the index
+action I would create a module like so:
 
-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`:
+    module ShakesIndexOverride
+      def index
+        # default index implementation goes here
+      end
+    end
 
-    script/generate shakes_layout article
+Finally, you need to change the Shakes configuration in `config/initializers/shakes.rb` to tell Shakes to use your
+new default action implementation. For example, to use the index action in the previous example I would change to
+configuration to the following:
 
-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:
+    # Set the default index action module. Default is Shakes::Actions::Index
+    Shakes::HasTheShakes::Configuration.index_action = ShakesIndexOverride
+    
+Change 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`:
 
-    script/generate shakes
+    script/generate shakes_views
 
-Formtastic
-----------
+Formtastic Aware Layouts
+------------------------
 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. See the section on Generators
-above to see how this can be done automatically for you.
+Formtastic, I suggest you install and use the stylesheets that are included in the gem. See the section on Formtastic
+Aware Layouts above to see how this can be done automatically for you.
 
 Run the following command to install the stylesheets (and the Formtastic initializer):
 
@@ -94,9 +99,25 @@ Then add the following code to your layout to include the stylesheets:
       ...
     </head>
 
+Because this is likely to be common, Shakes provides a generator that will install the Formtastic stylesheets and create
+a version of `app/views/layout/application.html.erb` that includes them for you. Just 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 Formtastic aware layout at `app/views/layouts/article.html.erb`:
+
+    script/generate shakes_layout article
+
 See the [Formtastic](http://github.com/justinfrench/formtastic) project page for more information.
 
+You Can Have It All
+-------------------
+You can create the customizable default views and actions and the application layout in one easy step. Just run the
+following command and it will run the `shakes_actions`, `shakes_views` and `shakes_layout` generators all at once:
+
+    script/generate shakes
+
 TODO
 ----
 * Test against Rails 3 (needs GA'ed Formtastic support for Rails 3)
-* Allow for application specific overrides of default action implementations

data/generators/shakes/shakes_generator.rb

@@ -5,10 +5,9 @@ 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', []
+      m.dependency 'shakes_actions', []
     end
   end
   

data/generators/shakes_actions/shakes_actions_generator.rb

@@ -0,0 +1,22 @@
+class ShakesActionsGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory 'config/initializers'
+      m.file 'initializer.rb', "config/initializers/shakes.rb"
+    end
+  end
+  
+  def file_name
+    @name.underscore
+  end
+  
+  protected
+ 
+  def banner
+    "Usage: #{$0} #{spec.name}"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shakes
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jason Stahl
@@ -49,7 +49,8 @@ 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_actions/shakes_actions_generator.rb
+- generators/shakes_actions/templates/initializer.rb
 - generators/shakes_layout/shakes_layout_generator.rb
 - generators/shakes_layout/templates/layout.html.erb
 - generators/shakes_layout/templates/stylesheet.css