sections_rails 0.0.2 → 0.0.3

data/lib/generators/sections_generator.rb

@@ -1,6 +1,9 @@
 class SectionsGenerator < Rails::Generators::Base
 
   def create_sections_folder
+    say ''
+    say ' STEP 1: Creating sections folder'
+    say ''
     empty_directory "app/sections"
     inject_into_file 'config/application.rb',
                      "    config.assets.paths << 'app/sections'\n",
@@ -12,7 +15,45 @@ class SectionsGenerator < Rails::Generators::Base
     say ''
   end
   
+  def create_section_assets
+    say ''
+    say 'STEP 2: Creating asset manifests.'
+    say ''
+    create_file 'app/assets/javascripts/application_sections.js', <<-END_STR
+// THIS FILE IS AUTOMATICALLY CREATED BY THE SECTIONS PLUGIN
+// AND MUST BE LOADED BY YOUR PAGE.
+// PLEASE DO NOT MODIFY IT MANUALLY.
+//
+    END_STR
+
+    create_file 'app/assets/stylesheets/application_sections.css', <<-END_STR
+/*
+ * THIS FILE IS AUTOMATICALLY CREATED BY THE SECTIONS PLUGIN.
+ * AND MUST BE LOADED BY YOUR PAGE.
+ * PLEASE DO NOT MODIFY MANUALLY.
+ */
+    END_STR
+
+    say ''
+    say ' I have created two files to reference the assets from the sections.'
+    say ' * '
+    say 'app/assets/javascripts/application_sections.js', Thor::Shell::Color::BOLD
+    say ' * '
+    say 'app/assets/stylesheets/application_sections.css', Thor::Shell::Color::BOLD
+    say ''
+    say ' They should be checked into your code repository the way they are, and remain that way.'
+    say ' When running "rake assets:precompile" during deployment,'
+    say ' they will be updated with the actually used assets for proper operation in production mode.'
+    say ''
+    say ' You must make sure they are loaded into the asset pipeline, for example by'
+    say ' requiring them in application.js and application.css.'
+    say ''
+  end
+
   def create_sample_section
+    say ''
+    say 'STEP 3: Creating a sample section.'
+    say ''
     
     # Ask the user.
     return unless ['', 'y', 'yes'].include? ask('Do you want to create a sample section? [Yn]').downcase
@@ -22,11 +63,15 @@ class SectionsGenerator < Rails::Generators::Base
 
     # Create the partial.
     create_file "app/sections/hello_world/_hello_world.html.erb", <<-END_STR
-<!-- This file contains the HTML for the 'hello world' section. -->
+<%# This file contains the HTML for the 'hello world' section. %>
 
 <div class="hello_world">
   <h2>Hello World!</h2>
-  This is content inside the hello world section!
+  This is content defined by the hello world section.<br>
+  It is styled by CSS from the section. <br>
+  <br>
+  Click on this section.<br>
+  The behavior comes from the section's JavaScript file.<br>
 </div>
     END_STR
 
@@ -39,7 +84,7 @@ class SectionsGenerator < Rails::Generators::Base
  * in this case the ".hello" class.
  */
 
-.hello_world { width: 300px; padding: 0 2ex 2ex; border: 2px dotted red; background-color: yellow; }
+.hello_world { width: 350px; padding: 0 2ex 2ex; border: 2px dotted red; background-color: yellow; }
 .hello_world .h2 { font-size: 1em; margin: 0 0 1ex; padding: 0; }
     END_STR
     
@@ -52,17 +97,19 @@ class SectionsGenerator < Rails::Generators::Base
  * i.e. the <div> with the class 'hello_world'.
  */
 
-$('.hello_world').click(function() {
-  alert('The Hello World section says hello to the world! :)');
+$(function() {
+  $('.hello_world').click(function() {
+    alert('The Hello World section says hello to the world!');
+  });
 });
     END_STR
 
     say ''
     say ' A sample section has been created in '
-    say 'app/sections/sample_section', Thor::Shell::Color::BOLD
+    say 'app/sections/hello_world', Thor::Shell::Color::BOLD
     say ' To use it, simply put '
-    say '<%= section :sample %>', Thor::Shell::Color::BOLD
-    say ' in your view file.'
+    say '<%= section :hello_world %>', Thor::Shell::Color::BOLD
+    say ' into a view file.'
     say ''
     say ' Happy coding! :)'
     say ''

data/lib/sections_rails/version.rb

@@ -1,3 +1,3 @@
 module SectionsRails
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/tasks/sections_rails_tasks.rake

@@ -2,6 +2,7 @@ namespace :sections do
 
   desc "Prepares the assets for precompilation in a setup with a single application.js file"
   task :prepare do
+    puts "\nPreparing sections assets ..."
 
     # Find all views in this app.
     views = find_all_views 'app/views'
@@ -37,13 +38,7 @@ namespace :sections do
       file.write "*/"
     end
     
-    # Make sure the require files are properly linked.
-    unless file_contains 'app/assets/javascripts/application.js', /application_sections/
-      puts "Please add the 'require' statement to 'application_sections.js' to 'application.js'."
-    end
-    unless file_contains 'app/assets/stylesheets/application.css', /application_sections/
-      puts "Please add the 'require' statement to 'application_sections.css' to 'application.css'."
-    end
+    puts "Preparing section assets done.\n\n"
   end
 
   desc "Prepares the assets for precompilation in a setup with multiple files per page."
@@ -74,6 +69,7 @@ namespace :sections do
       next if ['.', '..', 'layouts'].include? dir      
       Dir.entries(File.join(root, dir)).each do |view_file|
         next if ['.', '..'].include? view_file
+        next if view_file[-4..-1] == '.swp'
         result << File.join(dir, view_file)
       end
     end
@@ -91,7 +87,7 @@ namespace :sections do
   
   # Returns an array with the name of all sections in the given view source.
   def find_sections_in_view view_text
-    view_text.scan(/<%= section\s+['"](.*?)['"]\s*%>/).flatten.sort.uniq
+    view_text.scan(/<%=\s*section\s+['":](.*?)['"]?\s*%>/).flatten.sort.uniq
   end
   
   # Returns whether the given file contains the given text somewhere in its content.
@@ -100,3 +96,7 @@ namespace :sections do
   end
   
 end
+
+# Run the 'sections:prepare' rake task automatically before the 'assets:precompile' rake task
+# when the latter is called.
+Rake::Task['assets:precompile'].enhance ['sections:prepare']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sections_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70259722045160 !ruby/object:Gem::Requirement
+  requirement: &70256958176400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70259722045160
+  version_requirements: *70256958176400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70259722044520 !ruby/object:Gem::Requirement
+  requirement: &70256958175980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70259722044520
+  version_requirements: *70256958175980
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70259722043800 !ruby/object:Gem::Requirement
+  requirement: &70256958175520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70259722043800
+  version_requirements: *70256958175520
 description: Sections_rails adds infrastructure to the view layer of Ruby on Rails.
   It allows to define and use the HTML, CSS, and JavaScript code of dedicated sections
   of pages together in one place.
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A rails plugin that allows to define the HTML, CSS, and JS for individual
@@ -189,4 +189,3 @@ test_files:
 - spec/dummy/tmp/cache/assets/D94/460/sprockets%2Fd4ba18ed6ca55f732dba192d4b6036a8
 - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - spec/spec_helper.rb
-has_rdoc: