sections_rails 0.6.10 → 0.6.11

data/lib/sections_rails/section.rb

@@ -23,6 +23,12 @@ module SectionsRails
       @filename ||= File.basename @section_name, '.*'
     end
 
+    # Path to the folder for asset includes.
+    # Example: 'folder/section'
+    def folder_includepath
+      @folder_includepath ||= File.join directory_name, filename
+    end
+
     # Path of the folder on the file system.
     # Example: 'app/sections/folder/section'
     def folder_filepath
@@ -44,8 +50,14 @@ module SectionsRails
 
     # 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(/^\//, '')
+    def partial_renderpath partial_filename = nil
+      File.join(directory_name, filename, partial_filename || filename).gsub(/^\//, '')
+    end
+
+    # The path for accessing the partial on the filesystem.
+    # Example: '
+    def partial_filepath partial_filename = nil
+      File.join(SectionsRails.config.path, directory_name,filename, "_#{partial_filename or filename}").gsub(/^\//, '')
     end
 
     # For including the partial into views.
@@ -76,14 +88,24 @@ module SectionsRails
     end
 
     # Returns the filename of the partial of this section, or nil if this section has no partial.
-    def find_partial_filepath
+    # Uses the given custom partial name, or the default partial name if none is given.
+    def find_partial_filepath partial_filename = nil
       SectionsRails.config.partial_extensions.each do |ext|
-        path = "#{partial_filepath}.#{ext}"
+        path = "#{partial_filepath(filename)}.#{ext}"
         return path if File.exists? path
       end
       nil
     end
 
+    # Returns the path of the partial of this section for rendering, or nil if this section has no partial.
+    # Uses the given custom partial name, or the default partial name if none is given.
+    def find_partial_renderpath partial_filename = nil
+      SectionsRails.config.partial_extensions.each do |ext|
+        return partial_renderpath(partial_filename) if File.exists? "#{partial_filepath(filename)}.#{ext}"
+      end
+      nil
+    end
+
     # Returns a list of all section names in the given text.
     #
     # @param [ String ] text
@@ -123,54 +145,62 @@ module SectionsRails
       @view.lookup_context.template_exists? partial_includepath
     end
 
-    # TODO(SZ): missing specs.
     def render
       result = []
 
+      # Check if section exists.
+      raise "Section #{folder_filepath} doesn't exist." unless Dir.exists? folder_filepath
+
       # Include assets only for development mode.
       if Rails.env != 'production'
 
         # Include JS assets.
-        if @options[:js]
-          result << @view.javascript_include_tag(File.join(path, js))
-        elsif @options[:js] == false
-          # ":js => false" given --> don't include any JS.
+        if @options.has_key? :js
+          if @options[:js]
+            result << @view.javascript_include_tag(File.join(folder_includepath, @options[:js]))
+          else
+            # :js => (false|nil) given --> don't include any JS.
+          end
         else
+          # No :js configuration option given --> include the default script.
           js_includepath = find_js_includepath
           result << @view.javascript_include_tag(js_includepath) if js_includepath
         end
 
         # Include CSS assets.
-        if @options[:css]
-          result << @view.stylesheet_link_tag(File.join(path, css))
-        elsif @options[:css] == false
-          # ":css => false" given --> don't include any CSS.
+        if @options.has_key? :css
+          if @options[:css]
+            # Custom filename for :css given --> include the given CSS file.
+            result << @view.stylesheet_link_tag(File.join(folder_includepath, @options[:css]))
+          else
+            # ":css => false" given --> don't include any CSS.
+          end
         else
+          # No option for :css given --> include the default stylesheet.
           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 @options[:partial]
-        when :tag
+      if @options.has_key? :partial
+        if @options[:partial] == :tag
+          # :partial => :tag given --> render the empty tag even if there is a partial present.
           result << @view.content_tag(:div, '', :class => filename)
-
-        when false
-          # partial: false given --> render nothing
-
-        when nil
-          # partial: nil given --> render default partial
-          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
-
+        elsif @options[:partial]
+          # Custom partial name given --> render that partial.
+          result << @view.render(find_partial_renderpath(@options[:partial]), @options[:locals])
+        else
+          # :partial => (false|nil) given --> render nothing.
+        end
+      else
+        # No :partial option given --> render the default partial.
+        partial_filepath = find_partial_filepath
+        if partial_filepath
+          result << @view.render(:partial => partial_includepath, :locals => @options[:locals])
         else
-          # partial: custom path given --> render custom partial
-          result << @view.render("#{path}/#{partial}", @options[:locals])
+          result << @view.content_tag(:div, '', :class => filename)
+        end
       end
 
       result.join("\n").html_safe

data/lib/sections_rails/version.rb

@@ -1,3 +1,3 @@
 module SectionsRails
-  VERSION = "0.6.10"
+  VERSION = "0.6.11"
 end

data/spec/controllers/errors_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ErrorsController do
+  render_views
+
+  context "referenced section doesn't exist" do
+    it 'throws an exception' do
+      expect { get :missing_section; puts response.body }.to raise_error
+    end
+  end
+
+end
+
+
+

data/spec/controllers/partials_controller_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe PartialsController do
+  render_views
+
+  describe 'supported partial types' do
+    after :each do
+      response.should be_success
+    end
+
+    it 'allows to use ERB partials' do
+      get :erb_section
+      response.body.strip.should == 'ERB partial content'
+    end
+
+    it 'allows to use HAML partials' do
+      get :haml_section
+      response.body.strip.should == 'HAML partial content'
+    end
+  end
+
+  context 'no partial options given' do
+    it 'renders the default partial' do
+      get :no_options
+      response.body.strip.should == 'default partial content'
+    end
+  end
+
+  context 'providing a custom partial name' do
+    before :each do
+      get :custom_partial
+    end
+
+    it 'renders the given partial' do
+      response.body.should include 'custom partial content'
+    end
+
+    it "doesn't render the default partial" do
+      response.body.should_not include 'default partial content'
+    end
+  end
+
+  context 'disabling partials for a section' do
+    before :each do
+      get :disabled
+    end
+
+    it "doesn't render the partial tag" do
+      response.body.strip.should_not include '<div class="disabled">'
+    end
+
+    it "doesn't render the partial" do
+      response.body.strip.should_not include 'disabled partial content'
+    end
+  end
+
+  context 'production mode' do
+
+    before :each do
+      Rails.env = 'production'
+    end
+
+    after :each do
+      Rails.env = 'test'
+    end
+
+    it 'renders partials normally' do
+      get :production_mode
+      response.body.strip.should include 'partial content'
+    end
+  end
+end
+
+

data/spec/controllers/script_assets_controller_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe ScriptAssetsController do
+  render_views
+
+  before :each do
+    RSpec::Matchers.define :have_script_tag do |tag_name|
+      match do |body|
+        body =~ Regexp.new("<script.*src=\"#{tag_name}\".*<\/script>")
+      end
+    end
+  end
+
+  after :each do
+    response.should be_success
+  end
+
+  describe 'supported script languages' do
+    it 'allows to use JavaScript assets' do
+      get :javascript
+      response.body.should have_script_tag '/assets/script_assets/javascript/javascript.js'
+    end
+
+    it 'allows to use CoffeeScript assets' do
+      get :coffeescript
+      response.body.should have_script_tag '/assets/script_assets/coffeescript/coffeescript.js'
+    end
+  end
+
+  context 'setting a custom script filename' do
+    before :each do
+      get :custom_script
+    end
+
+    it 'includes the given script file into the page' do
+      response.body.should have_script_tag '/assets/script_assets/custom_script/different_name.js'
+    end
+
+    it "doesn't include the default script file into the page" do
+      response.body.should_not have_script_tag '/assets/script_assets/custom_script/custom_script.js'
+    end
+  end
+
+  context 'setting the script configuration option to false' do
+    it "doesn't include any script tag into the page" do
+      get :no_script
+      response.body.should_not match /<script/
+    end
+  end
+
+  context 'production mode' do
+    before :each do
+      Rails.env = 'production'
+    end
+
+    after :each do
+      Rails.env = 'test'
+    end
+
+    it "doesn't render script assets" do
+      get :production_mode
+      response.should_not have_script_tag '/assets/script_assets/production_mode/production_mode.js'
+    end
+  end
+end
+
+
+

data/spec/controllers/style_assets_controller_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe StyleAssetsController do
+  render_views
+
+  before :each do
+    RSpec::Matchers.define :have_style_tag do |tag_name|
+      match do |body|
+        body =~ Regexp.new("<link.*href=\"#{tag_name}\".*>")
+      end
+    end
+  end
+
+  after :each do
+    response.should be_success
+  end
+
+  describe 'supported style languages' do
+    it 'CSS assets' do
+      get :css
+      response.body.should have_style_tag '/assets/style_assets/css/css.css'
+    end
+
+    it 'SASS assets' do
+      get :sass
+      response.body.should have_style_tag '/assets/style_assets/sass/sass.css'
+    end
+
+    it 'CSS.SASS assets' do
+      get :css_sass
+      response.body.should have_style_tag '/assets/style_assets/css_sass/css_sass.css'
+    end
+
+    it 'SCSS assets' do
+      get :scss
+      response.body.should have_style_tag '/assets/style_assets/scss/scss.css'
+    end
+
+    it 'CSS.SCSS assets' do
+      get :css_scss
+      response.body.should have_style_tag '/assets/style_assets/css_scss/css_scss.css'
+    end
+  end
+
+  context 'setting a custom style filename' do
+    before :each do
+      get :custom_style
+    end
+
+    it 'includes the given style file into the page' do
+      response.body.should have_style_tag '/assets/style_assets/custom_style/different_name.css'
+    end
+
+    it "doesn't include the default script file into the page" do
+      response.body.should_not have_style_tag '/assets/style_assets/custom_style/custom_style.css'
+    end
+  end
+
+  context 'setting the script configuration option to false' do
+    it "doesn't include any script tag into the page" do
+      get :no_style
+      response.body.should_not have_style_tag '/assets/style_assets/no_style/no_style.css'
+    end
+  end
+
+  context 'production_mode' do
+
+    before :each do
+      Rails.env = "production"
+    end
+
+    after :each do
+      Rails.env = "test"
+    end
+
+    it "doesn't render style assets" do
+      get :production_mode
+      response.body.should_not have_style_tag '/assets/style_assets/production_mode/production_mode.css'
+    end
+  end
+end
+

data/spec/controllers/view_types_controller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ViewTypesController do
+  render_views
+
+  describe 'supported view types' do
+    after :each do
+      response.should be_success
+    end
+
+    it 'allows to use the section helper in ERB views' do
+      get :erb
+      response.body.strip.should == 'Foo partial content'
+    end
+
+    it 'allows to use the section helper in HAML views' do
+      get :haml
+      response.body.strip.should == 'Foo partial content'
+    end
+  end
+end
+

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */