hands_engine 1.2.0 → 1.2.1

data/README.rdoc

@@ -6,8 +6,8 @@ Engines will be available on Rails 3.1 as the new plugin generator and invoked a
 
 == Usage
 
-  $ hands path/ENGINE_NAME  Ex: hands_engine sites/vwvarejo
-  $ hands path/ENGINE_NAME -t themes Ex: hands_engine sites/vwvarejo -t themes
+  $ hands path/ENGINE_NAME  Ex: hands sites/vwvarejo
+  $ hands path/ENGINE_NAME -t themes Ex: hands sites/vwvarejo -t themes
 
 Give --help to see supported options.
 

data/lib/hands_engine/version.rb

@@ -1,3 +1,3 @@
 module HandsEngine
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/lib/hands_engine.rb

@@ -6,14 +6,27 @@ require "active_support/core_ext/string"
 require "rails/generators"
 require "rails/generators/rails/app/app_generator"
 
+# Interact with Hands Engine by using:
+#
+# *Default*
+#   $ hands path/ENGINE_NAME  Ex: hands sites/vwvarejo
+#
+# *Themes*
+#   $ hands path/ENGINE_NAME -t themes Ex: hands sites/vwvarejo -t themes
+#
 class HandsEngine < Thor::Group
   include Thor::Actions
   check_unknown_options!
 
+
+  # Load template (_root_ or _themes_), _root_ is default option
   def self.source_root
     @_source_root ||= File.expand_path('../templates', __FILE__)
   end
 
+  # Show the current step and the message of the task
+  #
+  # Ex: "STEP #{@step}", #{message.inspect}
   def self.say_step(message)
     @step = (@step || 0) + 1
     class_eval <<-METHOD, __FILE__, __LINE__ + 1
@@ -33,6 +46,7 @@ class HandsEngine < Thor::Group
 
   say_step "Vendoring Rails 3 application at #{name.underscore}"
 
+  # Invoke rails generator and creates a rails 3.1 app
   def invoke_rails_app_generator
     invoke Rails::Generators::AppGenerator,
       [ File.expand_path(path, destination_root) ]
@@ -40,6 +54,8 @@ class HandsEngine < Thor::Group
 
   say_step "Removing unneeded files #{name.underscore}"
 
+  # Removes unnecessary files,
+  # If themes removes extra files
   def remove_uneeded_rails_files
     inside path do
       remove_file ".gitignore"
@@ -88,6 +104,8 @@ class HandsEngine < Thor::Group
 
   say_step "Creating site engine #{name.underscore}"
 
+  # If the argument is _-t_ _themes_ uses /themes template,
+  # If not uses /root template
   def create_root
     self.destination_root = File.expand_path(path, destination_root)
     set_accessors!
@@ -103,7 +121,7 @@ class HandsEngine < Thor::Group
 
   protected
 
-    # if themes site return true
+    # Returns true if argument options is _-t_ _themes_" in command line
     def themes?
       options[:themes] == "themes"
     end
@@ -114,14 +132,16 @@ class HandsEngine < Thor::Group
       self.class.source_root
     end
 
+    # App name Ex: vwvarejo
     def name
       @name ||= File.basename(destination_root)
     end
-
+    # Ex: MyApp
     def camelized
       @camelized ||= name.camelize
     end
 
+    # Ex: my_app
     def underscored
       @underscored ||= name.underscore
     end

metadata

@@ -2,7 +2,7 @@
 name: hands_engine
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Bruno S. Barros (Hands Mobile)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -03:00
+date: 2011-05-17 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency