sections_rails 0.6.0 → 0.6.1

data/README.md

@@ -97,12 +97,18 @@ In this case, the _sections_ helper creates an empty div in the view.
 ## Options
 
 By default, a section automatically includes partials, css, and js files with the section name if they exist. 
-This convention can be overridden by the options __:partial__, __:css__, and __:js__ the `section` command.
-Providing `false` disables the respective functionality, while a filename makes the section use the given file instead of the default one.
+This convention can be overridden. The following example renders the _hello_world_ section with a different partial, with no stylesheet,
+and it uses the custom _foobar.js_ instead of _hello_world.js_.
 
-The command ```erb <%= section :hello_world, css: false, js: 'foobar.js' %>``` renders the _hello_world_ section without styling and using
-_foobar.js_ instead of _hello_world.js_.
+```erb
+<%= section :hello_world, partial: 'hello_new', css: false, js: 'foobar.js' %>
+```
 
+It is also possible to provide parameters to the rendered partial.
+
+```erb
+<%= section :hello_world, locals: { message: 'Greetings!' } %>
+```
 
 ## Creating new sections.
 
@@ -127,6 +133,20 @@ _This feature is still under development._
 To test them for example using [Konacha](https://github.com/jfirebaugh/konacha), create a symlink to _app/sections_ in _spec/javascript_.
 
 
+# Development
+
+## Unit tests
+
+```bash
+$ rake
+```
+
+To automatically run unit tests when files change, run
+
+```bash
+$ bundle exec guard -c
+```
+
 # Missing features
 
 _Sections_rails_ is in prototypical development and far from complete. Missing features are:

data/Rakefile

@@ -22,18 +22,6 @@ end
 
 Bundler::GemHelper.install_tasks
 
-desc 'Default: run the specs and features.'
-task :default => 'spec:unit' do
-  system("bundle exec rake spec")
-end
-
-namespace :spec do
-
-  desc "Run unit specs"
-  RSpec::Core::RakeTask.new('unit') do |t|
-    t.pattern = 'spec/{*_spec.rb}'
-  end
-end
-
-desc "Run the unit tests"
-task :spec => ['spec:unit']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+task :default => :spec

data/lib/sections_rails/string_tools.rb

@@ -0,0 +1,15 @@
+# Returns a list of all section names in the given text.
+def find_sections text
+  result = text.scan(/<%=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
+  result.concat text.scan(/^\s*\=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
+  result
+end
+
+
+# Returns directory and filename portion of the given path.
+def split_path paths
+  segments = paths.split '/'
+  directory = segments[0..-2].join('/')
+  directory += '/' if directory.size > 0
+  [directory, segments[-1]]
+end

data/lib/sections_rails/version.rb

@@ -1,3 +1,3 @@
 module SectionsRails
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/sections_rails.rb

@@ -1,15 +1,14 @@
+require 'sections_rails/string_tools'
+
 module SectionsRails
 
   require "sections_rails/railtie" if defined?(Rails)
   
   def section combined_name, options = {}
-    out = []
+    result = []
 
     # Split the parameter into file name and directory name.
-    split_names = combined_name.to_s.split '/'
-    filename = split_names[-1]
-    directory = (split_names.size > 1 ? split_names[0..-2] : []).join '/'
-    directory += '/' if directory.size > 0
+    directory, filename = split_path combined_name
     directory_path = "#{Rails.root}/app/sections/#{directory}#{filename}"    # Directory of section: /app/sections/admin/logo
 
     # Add assets of section when in dev mode.
@@ -19,22 +18,30 @@ module SectionsRails
       # Include JS assets.
       if options.has_key? :js
         if options[:js]
-          out << javascript_include_tag("#{directory}#{filename}/#{options[:js]}")
+          # Custom :js filename given --> load the given JS file.
+          result << javascript_include_tag("#{directory}#{filename}/#{options[:js]}")
+        else
+          # js: false given --> don't do anything here.
         end
       else
+        # No :js option given --> load the default JS file.
         if File.exists?("#{file_path}.js") || File.exists?("#{file_path}.js.coffee") || File.exists?("#{file_path}.coffee")
-          out << javascript_include_tag("#{directory}#{filename}/#{filename}")
+          result << javascript_include_tag("#{directory}#{filename}/#{filename}")
         end
       end
 
       # Include CSS assets.
       if options.has_key? :css
         if options[:css]
-          out << stylesheet_link_tag("#{directory}#{filename}/#{options[:css]}")
+          # Custom :css option given --> render the given file.
+          result << stylesheet_link_tag("#{directory}#{filename}/#{options[:css]}")
+        else
+          # css: false given --> don't render any css.
         end
       else
+        # No :css option given --> render the default :css file.
         if File.exists?("#{file_path}.css") || File.exists?("#{file_path}.css.scss") || File.exists?("#{file_path}.css.sass") || File.exists?("#{file_path}.scss") || File.exists?("#{file_path}.sass") 
-          out << stylesheet_link_tag("#{directory}#{filename}/#{filename}")
+          result << stylesheet_link_tag("#{directory}#{filename}/#{filename}")
         end
       end
     end
@@ -44,22 +51,22 @@ module SectionsRails
     if options.has_key? :partial
       if options[:partial] == :tag
         # :partial => :tag given --> render the tag.
-        out << content_tag(:div, '', :class => filename)
+        result << content_tag(:div, '', :class => filename)
       elsif options[:partial]
         # some value for :partial given --> render the given partial.
-        out << render(:partial => "/../sections/#{directory}#{filename}/#{filename}", :locals => options[:locals])
+        result << render(:partial => "/../sections/#{directory}#{filename}/#{options[:partial]}", :locals => options[:locals])
       else
-        # :partial => false or nil given --> render nothing
+        # partial: false or nil given --> render nothing
       end
     else
       # No :partial option given --> render the file or tag per convention.
       if File.exists?("#{partial_path}.erb") || File.exists?("#{partial_path}.haml")
-        out << render(:partial => "/../sections/#{directory}#{filename}/#{filename}", :locals => options[:locals])
+        result << render(:partial => "/../sections/#{directory}#{filename}/#{filename}", :locals => options[:locals])
       else
-        out << content_tag(:div, '', :class => filename)
+        result << content_tag(:div, '', :class => filename)
       end
     end
-    out.join("\n").html_safe
+    result.join("\n").html_safe
   end
   
 end

data/lib/tasks/sections_rails_tasks.rake

@@ -4,18 +4,26 @@ namespace :sections do
   task :prepare do
     puts "\nPreparing sections assets ..."
 
-    # Find all views in this app.
-    views = find_all_views 'app/views'
-    
-    # Get all sections used in the views.
-    sections = views.map do |view|
-      find_sections_in_view IO.read "app/views/#{view}"
+    # Find all sections used in the views.
+    sections = find_all_views('app/views').map do |view|
+      find_sections IO.read"app/views/#{view}"
     end.flatten
     
+    # Find all sections within the already known sections.
+    i = 0
+    while i < sections.size
+      section = sections[i]
+      referenced_sections = find_sections_in_section section
+      referenced_sections.each do |referenced_section|
+        sections << referenced_section unless sections.include? referenced_section
+      end
+      i += 1
+    end
+    sections.sort!
+    
     # Create the require file for application.js.
     File.open "app/assets/javascripts/application_sections.js", 'w' do |file|
       sections.each do |section|
-
         if File.exists?(asset_path section, '.js') || File.exists?(asset_path section, '.js.coffee') || File.exists?(asset_path section, '.coffee')
           file.write "//= require #{require_path section}\n"
         end
@@ -100,42 +108,32 @@ namespace :sections do
     result
   end
 
+  # Used for :prepare_pages. Not used right now.
   def parse_views views
     result = {}
     views_to_parse.each do |view_to_parse|
       view_text = IO.read(File.join root, view_to_parse)
-      result[view_to_parse] = find_sections_in_view view_text
+      result[view_to_parse] = find_sections_in_text view_text
     end
     result
   end
   
-  # Returns an array with the name of all sections in the given view source.
-  def find_sections_in_view view_text
-    erb_sections = view_text.scan(/<%=\s*section\s+['":](.*?)['"]?\s*%>/).flatten.sort.uniq
-    haml_sections = view_text.scan(/\=\s*section\s+['":](.*?)['"]?$/).flatten.sort.uniq
-    erb_sections + haml_sections
-  end
-  
-  # Returns whether the given file contains the given text somewhere in its content.
-  def file_contains file_name, text
-    IO.read(file_name) =~ text
+
+  def find_sections_in_section section_name
+    directory, filename = split_path section_name
+    section_content = IO.read "app/sections/#{directory}#{filename}/_#{filename}.html.haml"
+    find_sections section_content
   end
-  
+
   # Returns the path to the asset in the given section.
   def asset_path section_name, asset_extension = nil, asset_prefix = nil
-    split_names = section_name.split '/'
-    filename = split_names[-1]
-    directory = split_names[0..-2].join '/'
-    directory += '/' if directory.size > 0
+    directory, filename = split_path section_name
     "app/sections/#{directory}#{filename}/#{asset_prefix}#{filename}#{asset_extension}"
   end
 
   # Returns the relative path to the asset for the asset pipeline.
   def require_path section_name
-    split_names = section_name.split '/'
-    filename = split_names[-1]
-    directory = split_names[0..-2].join '/'
-    directory += '/' if directory.size > 0
+    directory, filename = split_path section_name
     "../../sections/#{directory}#{filename}/#{filename}"
   end
 end

data/spec/lib/string_tools_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'sections_rails/string_tools'
+
+describe 'string_tools' do
+
+  describe 'find_sections' do
+    it 'finds ERB sections with symbols' do
+      find_sections("one <%= section :alpha %> two").should == ['alpha']
+    end
+
+    it 'finds ERB sections with single quotes' do
+      find_sections("one <%= section 'alpha' %> two").should == ['alpha']
+    end
+
+    it 'finds ERB sections with double quotes' do
+      find_sections('one <%= section "alpha" %> two').should == ['alpha']
+    end
+
+    it 'finds ERB sections with parameters' do
+      find_sections('one <%= section "alpha", css: false %> two').should == ['alpha']
+    end
+
+    it 'finds HAML sections with symbols' do
+      find_sections("= section :alpha").should == ['alpha']
+    end
+
+    it 'finds HAML sections with single quotes' do
+      find_sections("= section 'alpha'").should == ['alpha']
+    end
+
+    it 'finds HAML sections with double quotes' do
+      find_sections('= section "alpha"').should == ['alpha']
+    end
+
+    it 'finds indented HAML sections' do
+      find_sections('    = section "alpha"').should == ['alpha']
+    end
+
+    it 'finds HAML sections with parameters' do
+      find_sections('= section "alpha", css: false').should == ['alpha']
+    end
+
+    it 'finds all results in the text' do
+      find_sections("one <%= section 'alpha' \ntwo <%= section 'beta'").should == ['alpha', 'beta']
+    end
+
+    it 'sorts the results' do
+      find_sections("one <%= section 'beta' \ntwo <%= section 'alpha'").should == ['alpha', 'beta']
+    end
+
+    it 'removes duplicates' do
+      find_sections("one <%= section 'alpha' \ntwo <%= section 'alpha'").should == ['alpha']
+    end
+  end
+
+  describe 'split_path' do
+    it 'returns the directory and filename of the given path' do
+      directory, filename = split_path '/one/two/three.js'
+      directory.should == '/one/two/'
+      filename.should == 'three.js'
+    end
+
+    it "returns '' if there is no directory" do
+      directory, filename = split_path 'three.js'
+      directory.should == ''
+      filename.should == 'three.js'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,15 +1,11 @@
 require 'rubygems'
 require 'bundler/setup'
-#require "lib/sections_rails"
 require 'rspec'
 
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 #Rails = Hashie::Mash.new({:env => 'test'})
 
-require 'sections_rails' # and any other gems you need
-
-
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sections_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70274490604960 !ruby/object:Gem::Requirement
+  requirement: &70244820224220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70274490604960
+  version_requirements: *70244820224220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70274490604500 !ruby/object:Gem::Requirement
+  requirement: &70244820223480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274490604500
+  version_requirements: *70244820223480
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70274490600400 !ruby/object:Gem::Requirement
+  requirement: &70244820222620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274490600400
+  version_requirements: *70244820222620
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70244820221720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70244820221720
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70244820220540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70244820220540
 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.
@@ -56,12 +78,14 @@ files:
 - lib/generators/section_generator.rb
 - lib/generators/sections_generator.rb
 - lib/sections_rails/railtie.rb
+- lib/sections_rails/string_tools.rb
 - lib/sections_rails/version.rb
 - lib/sections_rails.rb
 - lib/tasks/sections_rails_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.md
+- spec/lib/string_tools_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kevgo/sections_rails
 licenses: []
@@ -89,4 +113,5 @@ specification_version: 3
 summary: A rails plugin that allows to define the HTML, CSS, and JS for individual
   sections of pages as one unit.
 test_files:
+- spec/lib/string_tools_spec.rb
 - spec/spec_helper.rb