sections_rails 0.6.7 → 0.6.8

data/lib/generators/section_generator.rb

@@ -4,41 +4,26 @@ class SectionGenerator < Rails::Generators::Base
 
   argument :name, :type => :string
 
+  def parse_arguments
+    @section = SectionsRails::Section.new name
+  end
+
   def create_folder
-    empty_directory directory_path
+    empty_directory @section.folder_filepath
   end
 
   def create_partial
-    filename = File.basename(name)
-    create_file "_#{asset_base_path '_'}.html.haml",
-                ".#{filename}\n  -# DOM content goes here.\n"
+    create_file "#{@section.partial_filepath}.html.haml",
+                ".#{@section.filename}\n  -# DOM content goes here.\n"
   end
 
   def create_coffee_file
-    filename = File.basename(name)
-    create_file "#{asset_base_path}.coffee",
-                "class #{filename}\n  # Your CoffeeScript code goes here.\n"
+    create_file "#{@section.asset_filepath}.coffee",
+                "class #{@section.filename}\n  # Your CoffeeScript code goes here.\n"
   end
 
   def create_sass_file
-    filename = File.basename(name)
-    create_file "#{asset_base_path}.sass",
-                ".#{filename}\n  /* Your SASS goes here. */\n"
-  end
-
-  private
-
-  # Returns the path for the directory of the section.
-  def directory_path
-    @directory_path ||= begin
-      directory, filename = split_path(name)
-      File.join 'app/sections', directory, filename
-    end
-  end
-
-  # Returns the base path of the file, i.e. '/app/sections/admin/foo/foo'.
-  def asset_base_path file_prefix = nil
-    filename = File.basename(name)
-    "#{directory_path}/#{file_prefix}#{filename}"
+    create_file "#{@section.asset_filepath}.sass",
+                ".#{@section.filename}\n  /* Your SASS goes here. */\n"
   end
 end

data/lib/sections_rails/helpers.rb

@@ -1,21 +1,6 @@
 module SectionsRails
   module Helpers
 
-    # Returns a list of all section names in the given text.
-    #
-    # @param [ String ] text
-    # @return [ Array<String> ]
-    def find_sections text
-
-      # Find sections in ERB templates.
-      result = text.scan(/<%=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
-
-      # Find sections in HAML templates.
-      result.concat text.scan(/^\s*\=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
-
-      result
-    end
-
     # Returns directory and filename portion of the given path.
     #
     # @param [ String ] paths

data/lib/sections_rails/section.rb

@@ -2,63 +2,107 @@ module SectionsRails
   require "sections_rails/config"
 
   class Section
-    attr_reader :asset_path, :css, :directory_name, :filename, :absolute_asset_path, :js, :locals, :partial, :partial_path
 
     def initialize section_name, view = nil, options = {}
-      section_name = section_name.to_s
-
-      # Helpers for filenames.
-      @filename            = File.basename section_name, '.*'
-      @directory_name      = File.dirname(section_name).gsub(/^\.$/, '')
-      @asset_path          = File.join(@directory_name, @filename, @filename).gsub(/^\//, '')
-      @absolute_asset_path = File.join SectionsRails.config.path, @asset_path
-      @partial_path        = File.join(@directory_name, @filename, "_#{@filename}").gsub(/^\//, '')
-
-      # Options.
-      @js      = options[:js]
-      @css     = options[:css]
-      @partial = options[:partial]
-      @locals  = options[:locals]
-
-      # For running view helper methods.
+      @section_name = section_name.to_s
+      @options = options
+
+      # This is necessary for running view helper methods.
       @view = view
     end
 
-    # Returns the asset_path of asset with the given extensions.
+    # Returns the names of any subdirectories that the section is in.
+    # Example: the section named 'folder1/folder2/section' has the directory_name 'folder1/folder2'.
+    def directory_name
+      @directory_name ||= File.dirname(@section_name).gsub(/^\.$/, '')
+    end
+
+    # Returns the file name of the section.
+    # Example 'section'
+    def filename
+      @filename ||= File.basename @section_name, '.*'
+    end
+
+    # Path of the folder on the file system.
+    # Example: 'app/sections/folder/section'
+    def folder_filepath
+      @folder_filepath ||= File.join SectionsRails.config.path, directory_name, filename
+    end
+
+    # Path to access assets on the file system.
+    # Includes only the base name of assets, without extensions.
+    # Example: 'app/sections/folder/section/section'
+    def asset_filepath
+      @asset_filepath ||= File.join SectionsRails.config.path, asset_includepath
+    end
+
+    # Path for including assets into the web page.
+    #
+    def asset_includepath
+      @asset_includepath ||= File.join(directory_name, filename, filename).gsub(/^\//, '')
+    end
+
+    # The path for accessing the partial on the filesystem.
+    # Example: '
+    def partial_filepath
+      @partial_filepath ||= File.join(SectionsRails.config.path, directory_name,filename, "_#{filename}").gsub(/^\//, '')
+    end
+
+    # For including the partial into views.
+    def partial_includepath
+      @partial_includepath ||= File.join(directory_name, filename, "#{filename}").gsub(/^\//, '')
+    end
+
+    # Returns the asset path of asset with the given extensions.
     # Helper method.
-    def find_asset_path asset_option, extensions
+    def find_asset_includepath asset_option, extensions
       return nil if asset_option == false
       return asset_option if asset_option
       extensions.each do |ext|
-        file_path = "#{@absolute_asset_path}.#{ext}"
-        return @asset_path if File.exists? file_path
+        file_path = "#{asset_filepath}.#{ext}"
+        return asset_includepath if File.exists? file_path
       end
       nil
     end
 
     # Returns the path to the JS asset of this section, or nil if the section doesn't have one.
-    def find_css_asset_path
-      find_asset_path @css, SectionsRails.config.css_extensions
+    def find_css_includepath
+      @find_css_includepath ||= find_asset_includepath @options[:css], SectionsRails.config.css_extensions
     end
 
     # Returns the path to the JS asset of this section, or nil if the section doesn't have one.
-    def find_js_asset_path
-      find_asset_path @js, SectionsRails.config.js_extensions
+    def find_js_includepath
+      @find_js_includepath ||= find_asset_includepath @options[:js], SectionsRails.config.js_extensions
     end
 
     # Returns the filename of the partial of this section, or nil if this section has no partial.
-    def find_partial_filename
+    def find_partial_filepath
       SectionsRails.config.partial_extensions.each do |ext|
-        path = File.join SectionsRails.config.path, "#{@partial_path}.#{ext}"
+        path = "#{partial_filepath}.#{ext}"
         return path if File.exists? path
       end
       nil
     end
 
+    # Returns a list of all section names in the given text.
+    #
+    # @param [ String ] text
+    # @return [ Array<String> ]
+    def self.find_sections text
+
+      # Find sections in ERB templates.
+      result = text.scan(/<%=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
+
+      # Find sections in HAML templates.
+      result.concat text.scan(/^\s*\=\s*section\s+['":]([^'",\s]+)/).flatten.sort.uniq
+
+      result
+    end
+
     # TODO: replace this with find_asset.
     def has_asset? *extensions
       extensions.flatten.each do |ext|
-        return true if File.exists?("#{@absolute_asset_path}.#{ext}")
+        return true if File.exists?("#{asset_filepath}.#{ext}")
       end
       false
     end
@@ -76,7 +120,7 @@ module SectionsRails
     # Returns whether this section has a template.
     # Deprecated.
     def has_partial?
-      @view.lookup_context.template_exists? @partial_path
+      @view.lookup_context.template_exists? partial_includepath
     end
 
     # TODO(SZ): missing specs.
@@ -87,26 +131,28 @@ module SectionsRails
       if Rails.env != 'production'
 
         # Include JS assets.
-        if js
+        if @options[:js]
           result << @view.javascript_include_tag(File.join(path, js))
-        elsif js == false
+        elsif @options[:js] == false
           # ":js => false" given --> don't include any JS.
-        elsif has_default_js_asset?
-          result << @view.javascript_include_tag(asset_path)
+        else
+          js_includepath = find_js_includepath
+          result << @view.javascript_include_tag(js_includepath) if js_includepath
         end
 
         # Include CSS assets.
-        if css
+        if @options[:css]
           result << @view.stylesheet_link_tag(File.join(path, css))
-        elsif css == false
+        elsif @options[:css] == false
           # ":css => false" given --> don't include any CSS.
-        elsif has_default_style_asset?
-          result << @view.stylesheet_link_tag(@asset_path)
+        else
+          css_includepath = find_css_includepath
+          result << @view.stylesheet_link_tag(css_includepath) if css_includepath
         end
       end
 
       # Render the section partial into the view.
-      case partial
+      case @options[:partial]
         when :tag
           result << @view.content_tag(:div, '', :class => filename)
 
@@ -115,17 +161,16 @@ module SectionsRails
 
         when nil
           # partial: nil given --> render default partial
-
-          if self.has_partial?
-            result << @view.render(:partial => asset_path, :locals => locals)
+          partial_filepath = find_partial_filepath
+          if partial_filepath
+            result << @view.render(:partial => partial_includepath, :locals => @options[:locals])
           else
             result << @view.content_tag(:div, '', :class => filename)
           end
 
         else
           # partial: custom path given --> render custom partial
-
-          result << @view.render("#{path}/#{partial}", locals)
+          result << @view.render("#{path}/#{partial}", @options[:locals])
       end
 
       result.join("\n").html_safe

data/lib/sections_rails/version.rb

@@ -1,3 +1,3 @@
 module SectionsRails
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

data/lib/tasks/sections_rails_tasks.rake

@@ -7,7 +7,7 @@ namespace :sections do
 
     # Find all sections used in the views.
     sections = find_all_views('app/views').map do |view|
-      find_sections IO.read "app/views/#{view}"
+      SectionsRails::Section.find_sections IO.read "app/views/#{view}"
     end.flatten.sort.uniq
     
     # Find all sections within the already known sections.
@@ -26,7 +26,7 @@ namespace :sections do
     File.open "app/assets/javascripts/application_sections.js", 'w' do |file|
       sections.each do |section_name|
         section = SectionsRails::Section.new section_name
-        js_asset = section.find_js_asset_path
+        js_asset = section.find_js_includepath
         file.write "//= require #{js_asset}\n" if js_asset
       end
     end
@@ -36,7 +36,7 @@ namespace :sections do
       file.write "/*\n"
       sections.each do |section_name|
         section = SectionsRails::Section.new section_name
-        js_asset = section.find_css_asset_path
+        js_asset = section.find_css_includepath
         file.write "*= require #{js_asset}\n" if js_asset
       end
       file.write " */"
@@ -121,9 +121,9 @@ namespace :sections do
 
   def find_sections_in_section section_name
     section = SectionsRails::Section.new section_name
-    partial_path = section.find_partial_filename
+    partial_path = section.find_partial_filepath
     if partial_path
-      find_sections IO.read partial_path
+      SectionsRails::Section.find_sections IO.read partial_path
     else
       []
     end

data/spec/sections_rails/helpers_spec.rb

@@ -3,56 +3,6 @@ include SectionsRails::Helpers
 
 describe SectionsRails::Helpers 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'

data/spec/sections_rails/section_spec.rb

@@ -10,71 +10,137 @@ describe SectionsRails::Section do
     context 'with section in folder' do
       its(:filename)            { should == 'section' }
       its(:directory_name)      { should == 'folder' }
-      its(:asset_path)          { should == 'folder/section/section' }
-      its(:absolute_asset_path) { should == 'app/sections/folder/section/section' }
-      its(:partial_path)        { should == 'folder/section/_section' }
     end
 
     context 'without folder' do
       subject { SectionsRails::Section.new 'section', nil }
       its(:filename)            { should == 'section' }
       its(:directory_name)      { should == '' }
-      its(:asset_path)          { should == 'section/section' }
-      its(:absolute_asset_path) { should == 'app/sections/section/section' }
-      its(:partial_path)        { should == 'section/_section' }
     end
   end
 
-  describe 'find_js_asset_path' do
+  describe 'path helper methods' do
+
+    context 'section in a folder' do
+      its(:folder_filepath) { should == 'app/sections/folder/section' }
+      its(:asset_filepath)  { should == 'app/sections/folder/section/section' }
+      its(:asset_includepath)  { should == 'folder/section/section' }
+      its(:partial_filepath)  { should == 'app/sections/folder/section/_section' }
+      its(:partial_includepath)  { should == 'folder/section/section' }
+    end
+
+    context 'section in root sections directory' do
+      subject { SectionsRails::Section.new 'section' }
+      its(:folder_filepath) { should == 'app/sections/section' }
+      its(:asset_filepath)  { should == 'app/sections/section/section' }
+      its(:asset_includepath)  { should == 'section/section' }
+      its(:partial_filepath)  { should == 'app/sections/section/_section' }
+      its(:partial_includepath)  { should == 'section/section' }
+    end
+  end
+
+  describe 'find_js_includepath' do
+
     it 'tries all different JS asset file types for sections' do
       SectionsRails.config.js_extensions.each do |ext|
         File.should_receive(:exists?).with("app/sections/folder/section/section.#{ext}").and_return(false)
       end
-      subject.find_js_asset_path
+      subject.find_js_includepath
     end
 
     it 'returns nil if there is no known JS asset file' do
       SectionsRails.config.js_extensions.each do |ext|
         File.should_receive(:exists?).with("app/sections/folder/section/section.#{ext}").and_return(false)
       end
-      subject.find_js_asset_path.should be_false
+      subject.find_js_includepath.should be_nil
     end
 
     it 'returns the asset path of the JS asset' do
       File.stub(:exists?).and_return(true)
-      subject.find_js_asset_path.should == 'folder/section/section'
+      subject.find_js_includepath.should == 'folder/section/section'
     end
 
     it 'returns nil if the file exists but the section has JS assets disabled' do
       File.stub(:exists?).and_return(true)
       section = SectionsRails::Section.new 'folder/section', nil, js: false
-      section.find_js_asset_path.should be_false
+      section.find_js_includepath.should be_nil
     end
 
     it 'returns the custom JS asset path if one is set' do
       section = SectionsRails::Section.new 'folder/section', nil, js: 'custom'
-      section.find_js_asset_path.should == 'custom'
+      section.find_js_includepath.should == 'custom'
     end
   end
 
 
-  describe 'find_partial_filename' do
+  describe 'find_partial_filepath' do
 
     it 'looks for all known types of partials' do
       File.should_receive(:exists?).with("app/sections/folder/section/_section.html.erb").and_return(false)
       File.should_receive(:exists?).with("app/sections/folder/section/_section.html.haml").and_return(false)
-      subject.find_partial_filename
+      subject.find_partial_filepath
     end
 
     it "returns nil if it doesn't find any assets" do
       File.should_receive(:exists?).with("app/sections/folder/section/_section.html.erb").and_return(false)
       File.should_receive(:exists?).with("app/sections/folder/section/_section.html.haml").and_return(false)
-      subject.find_partial_filename.should be_false
+      subject.find_partial_filepath.should be_false
     end
 
     it "returns the absolute path to the asset if it finds one" do
       File.stub(:exists?).and_return(true)
-      subject.find_partial_filename.should == 'app/sections/folder/section/_section.html.erb'
+      subject.find_partial_filepath.should == 'app/sections/folder/section/_section.html.erb'
+    end
+  end
+
+
+  describe '#find_sections' do
+    it 'finds ERB sections with symbols' do
+      SectionsRails::Section.find_sections("one <%= section :alpha %> two").should == ['alpha']
+    end
+
+    it 'finds ERB sections with single quotes' do
+      SectionsRails::Section.find_sections("one <%= section 'alpha' %> two").should == ['alpha']
+    end
+
+    it 'finds ERB sections with double quotes' do
+      SectionsRails::Section.find_sections('one <%= section "alpha" %> two').should == ['alpha']
+    end
+
+    it 'finds ERB sections with parameters' do
+      SectionsRails::Section.find_sections('one <%= section "alpha", css: false %> two').should == ['alpha']
+    end
+
+    it 'finds HAML sections with symbols' do
+      SectionsRails::Section.find_sections("= section :alpha").should == ['alpha']
+    end
+
+    it 'finds HAML sections with single quotes' do
+      SectionsRails::Section.find_sections("= section 'alpha'").should == ['alpha']
+    end
+
+    it 'finds HAML sections with double quotes' do
+      SectionsRails::Section.find_sections('= section "alpha"').should == ['alpha']
+    end
+
+    it 'finds indented HAML sections' do
+      SectionsRails::Section.find_sections('    = section "alpha"').should == ['alpha']
+    end
+
+    it 'finds HAML sections with parameters' do
+      SectionsRails::Section.find_sections('= section "alpha", css: false').should == ['alpha']
+    end
+
+    it 'finds all results in the text' do
+      SectionsRails::Section.find_sections("one <%= section 'alpha' \ntwo <%= section 'beta'").should == ['alpha', 'beta']
+    end
+
+    it 'sorts the results' do
+      SectionsRails::Section.find_sections("one <%= section 'beta' \ntwo <%= section 'alpha'").should == ['alpha', 'beta']
+    end
+
+    it 'removes duplicates' do
+      SectionsRails::Section.find_sections("one <%= section 'alpha' \ntwo <%= section 'alpha'").should == ['alpha']
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sections_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70275409137460 !ruby/object:Gem::Requirement
+  requirement: &70203401926000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70275409137460
+  version_requirements: *70203401926000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70275409136460 !ruby/object:Gem::Requirement
+  requirement: &70203401925460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275409136460
+  version_requirements: *70203401925460
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70275409135640 !ruby/object:Gem::Requirement
+  requirement: &70203401924800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275409135640
+  version_requirements: *70203401924800
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70275409134400 !ruby/object:Gem::Requirement
+  requirement: &70203401924300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275409134400
+  version_requirements: *70203401924300
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70275409133660 !ruby/object:Gem::Requirement
+  requirement: &70203401918100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275409133660
+  version_requirements: *70203401918100
 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.