sections_rails 0.0.5 → 0.0.6

data/README.md

@@ -0,0 +1,86 @@
+_Sections_rails_ adds a component-oriented infrastructure to the view layer of Ruby on Rails.
+This allows to define and use the HTML, CSS, and JavaScript code of dedicated 
+sections of web pages together in one place.
+
+
+# Example
+
+Let's take the navigation menu within a web site as an example section.
+It consists of certain HTML, CSS, and JavaScript code as well as image resources. 
+These assets must be loaded on every page that this navigation menu is visible on,
+and should be removed when the navigation menu is removed from the site.
+
+_Sections_rails_ allows to define these assets together, as a _section_ inside the _/app_ folder:
+
+    /app/sections/menu/_menu.html.erb
+                       menu.css
+                       menu.js
+
+To display this menu, simply do this in your view:
+
+```erb
+<%= section :menu %>
+```
+
+The _section_ helper inserts the partial as well as the JS and CSS files from _/app/sections/menu_ at this location.
+It does the right thing in all circumstances: In development mode, it inserts the individual assets. 
+In production mode, it inserts the assets to the main _application.js_ bundle.
+
+
+# Installation
+
+In your Gemfile:
+
+```ruby
+gem 'sections_rails'
+```
+
+Then set up the directory structure:
+
+```bash
+$ rails generate sections
+```
+
+The generator does the following things:
+
+1.  It creates a new folder __/app/sections__,
+    in which you put the source code for the different sections.
+
+2.  It adds the folder _/app/sections_ to the asset pipeline by inserting this line into your _application.rb_ file:
+
+        config.assets.paths << 'app/sections'
+
+3.  It optionally creates a demo section called _hello_world_ that you can try out as described below.
+
+
+In it's current prototypical implementation, _Sections_rails_ also creates empty asset container files:
+__application_sections.js__ and __application_sections.css__.
+Make sure you require them from your main _application.js_ and _application.css_ files. 
+They are used only when running _rake assets:precompile_ during deployment, and should be checked in and stay the way they are. 
+
+
+# Usage
+
+To use the "hello_world" section created by the sections generator, simply add it to the view:
+
+```erb
+<%= section :hello_world %>
+```
+
+If your section renders itself completely in JavaScript, you can omit its partial file.
+In this case, the _sections_ helper creates an empty div in the view.
+
+```html
+<div class="hello_world"></div>
+```
+
+
+# Missing features
+
+_Sections_rails_ is in prototypical development and far from complete. Missing features are:
+
+* Support for multiple application assets, for example page-specific compiled asset files instead of one global one.
+* Support for assets in different formats like CoffeeScript, Haml, Sass etc.
+* Support for serverside controller logic for sections, for example by integrating with https://github.com/apotonick/cells.
+* More natural integration into the asset pipeline.
+

data/lib/sections_rails/version.rb

@@ -1,3 +1,3 @@
 module SectionsRails
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/tasks/sections_rails_tasks.rake

@@ -14,9 +14,6 @@ namespace :sections do
     
     # Create the require file for application.js.
     File.open "app/assets/javascripts/application_sections.js", 'w' do |file|
-      file.write "// THIS FILE IS AUTOMATICALLY CREATED BY THE SECTIONS PLUGIN.\n"
-      file.write "// PLEASE DO NOT MODIFY MANUALLY.\n"
-      file.write "//\n"
       sections.each do |section|
         if File.exists? "app/sections/#{section}/#{section}.js"
           file.write "//= require ../../sections/#{section}/#{section} \n"
@@ -27,15 +24,12 @@ namespace :sections do
     # Create the require file for application.css.
     File.open "app/assets/stylesheets/application_sections.css", 'w' do |file|
       file.write "/* \n"
-      file.write " * THIS FILE IS AUTOMATICALLY CREATED BY THE SECTIONS PLUGIN.\n"
-      file.write " * PLEASE DO NOT MODIFY MANUALLY.\n"
-      file.write " *\n"
       sections.each do |section|
         if File.exists? "app/sections/#{section}/#{section}.css"
           file.write " *= require ../../sections/#{section}/#{section}\n" 
         end
       end
-      file.write "*/"
+      file.write " */"
     end
     
     puts "Preparing section assets done.\n\n"
@@ -61,6 +55,33 @@ namespace :sections do
     end
   end  
 
+  desc 'Creates empty asset containers'
+  task :reset_asset_containers do
+    puts "Cleaning up section asset containers."
+
+    # Clean up JS asset container.
+    File.open "app/assets/javascripts/application_sections.js", 'w' do |file|
+      file.write <<-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
+    end
+
+    # Clean up CSS asset container.
+    File.open "app/assets/stylesheets/application_sections.css", 'w' do |file|
+      file.write <<-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
+    end
+  end
+
+
   # Returns an array with the file name of all views in the given directory.
   # Views are all files that end in .html.erb
   def find_all_views root
@@ -99,4 +120,7 @@ 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']
+Rake::Task['assets:precompile'].enhance ['sections:prepare'] do
+  Rake::Task["sections:reset_asset_containers"].invoke
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sections_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70240732445780 !ruby/object:Gem::Requirement
+  requirement: &70230652581660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70240732445780
+  version_requirements: *70230652581660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70240732445360 !ruby/object:Gem::Requirement
+  requirement: &70230652581240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70240732445360
+  version_requirements: *70230652581240
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70240732444900 !ruby/object:Gem::Requirement
+  requirement: &70230652580780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70240732444900
+  version_requirements: *70230652580780
 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.
@@ -60,7 +60,7 @@ files:
 - lib/tasks/sections_rails_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.markdown
+- README.md
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb

data/README.markdown

@@ -1,97 +0,0 @@
-Ruby on Rails provides an amazing infrastructure and conventions for well structured server-side code. 
-It falls, however, short for the view layer. 
-
-_Partials_ provide a nice way to represent the HTML code of individual sections within complex web pages, 
-but no such facilities are available for the corresponding CSS and JavaScript. 
-This leaves the task of organizing the JS and CSS completely up to the user.
-
-_Sections_rails_ fills this gap by adding 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.
-
-
-# Example
-
-Let's assume a web page has amongst other things a navigation menu.
-This menu requires certain HTML, CSS, and JavaScript code that is specific to it.
-_Sections_rails_ allows to define this code as a _section_ inside the _/app_ folder:
-
-    /app/sections/menu/_menu.html.erb
-                       menu.css
-                       menu.js
-
-To display this menu, simply do this in your view:
-
-    <%= section :menu %>
-
-This inserts the partial as well as the JS and CSS files from _/app/sections/menu_ at this location.
-
-
-# Installation
-
-In your Gemfile:
-
-    gem 'sections_rails'
-
-Then set up the directory structure:
-
-    $ rails generate sections
-
-The generator does the following things:
-
-1.  It creates a new folder __/app/sections__,
-    in which you put the source code for the different sections.
-
-2.  It adds the folder _/app/sections_ to the asset pipeline by inserting this line into your _application.rb_ file:
-
-        config.assets.paths << 'app/sections'
-
-3.  It optionally creates a demo section called _hello_world_.
-
-
-# Usage
-
-To use the "hello_world" section created by the sections generator, simply add it to the view:
-
-    <%= section :hello_world %>
-
-If your section renders itself completely in JavaScript, you can omit its partial file.
-In this case, the _sections_ command creates an empty div in the view.
-
-    <div class="hello_world"></div>
-
-
-## Asset precompilation
-
-_Sections_rails_ provides facilities to include the assets of sections in the global asset
-bundles for production mode.
-
-1.  Run __rake sections:prepare__
-    
-    This rake task creates helper files that tell the asset pipeline about the assets of the different sections.
-
-    * _/app/assets/javascripts/application_sections.js_ links to all JS files of all sections.
-    * _/app/assets/stylesheets/application_sections.js_ links to all CSS files of all sections.
-
-2.  Include the generated helper files into your _application.js_ and _application.css_ files.
-
-    In application.js:
-    
-        //= require application_sections
-
-    In application.css:
-    
-        /*= require application_sections */    
-
-3.  Run __rake assets:precompile__ as usual.
-
-
-# Missing features
-
-_Sections_rails_ is in early development and far from complete. Missing features are:
-
-* Support for multiple assets, and assets per section
-* support for assets in different formats like CoffeeScript, Haml, Sass etc.
-* Support for page-specific compiled asset files instead of one global one
-* Better integration into the asset precompilation workflow.
-* Include serverside controller logic for sections by integrating with https://github.com/apotonick/cells or something comparable