sections_rails 0.6.1 → 0.6.2

data/lib/generators/section_generator.rb

@@ -1,5 +1,7 @@
 # Generates a new section.
 class SectionGenerator < Rails::Generators::Base
+  include SectionsRails::Helpers
+
   argument :name, :type => :string
 
   def create_folder
@@ -7,44 +9,36 @@ class SectionGenerator < Rails::Generators::Base
   end
 
   def create_partial
-    directory, filename = split_path
-    create_file "#{asset_base_path '_'}.html.haml",
+    filename = File.basename(name)
+    create_file "_#{asset_base_path '_'}.html.haml",
                 ".#{filename}\n  -# DOM content goes here.\n"
   end
 
   def create_coffee_file
-    directory, filename = split_path
+    filename = File.basename(name)
     create_file "#{asset_base_path}.coffee",
                 "class #{filename}\n  # Your CoffeeScript code goes here.\n"
   end
 
   def create_sass_file
-    directory, filename = split_path
+    filename = File.basename(name)
     create_file "#{asset_base_path}.sass",
                 ".#{filename}\n  /* Your SASS goes here. */\n"
   end
 
-
   private
 
-  # Returns an array [directory, filename] of the given filename.
-  def split_path
-    split_names = name.split '/'
-    filename = split_names[-1]
-    directory = split_names[0..-2].join '/'
-    directory += '/' if directory.size > 0
-    [directory, filename]
-  end
-
   # Returns the path for the directory of the section.
   def directory_path
-    directory, filename = split_path
-    "app/sections/#{directory}#{filename}"
+    @directory_path ||= begin
+      directory, filename = split_path(name)
+      "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
-    directory, filename = split_path
+    filename = File.basename(name)
     "#{directory_path}/#{file_prefix}#{filename}"
   end
 end

data/lib/sections_rails/config.rb

@@ -0,0 +1,35 @@
+# Configuration options for SectionsRails.
+# Set in an initializer file in /config/initializers/.
+#
+# Example:
+# SectionsRails.configure do |config|
+#   config.spec_dir  = "spec/javascripts"
+#   config.driver    = :webkit
+# end if defined?(Konacha)
+module SectionsRails
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :path, :js_extensions, :css_extensions, :partial_extensions
+
+    def initialize options = {}
+      options.reverse_merge!({ :path           => 'app/sections',
+                               :js_extensions  => ['js',  'js.coffee', 'coffee'],
+                               :css_extensions => ['css', 'css.scss', 'css.sass', 'sass', 'scss'],
+                               :partial_extensions => ['html.erb', 'html.haml'] })
+
+      options.each do |option, value|
+        if self.respond_to? option
+          send("#{option}=", value)
+        else
+          raise ArgumentError.new "Invalid option '#{option}' for #{self.class.name}"
+        end
+      end
+    end
+  end
+end

data/lib/sections_rails/helpers.rb

@@ -0,0 +1,29 @@
+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
+    # @return [ Array<String, String> ]
+    def split_path paths
+      dirname = File.dirname(paths)
+      dirname = '' if dirname == '.'
+      [dirname, File.basename(paths)]
+    end
+  end
+end

data/lib/sections_rails/railtie.rb

@@ -5,5 +5,9 @@ module SectionsRails
     rake_tasks do
       load "tasks/sections_rails_tasks.rake"
     end
+
+    config.after_initialize do
+      ActionController::Base.view_paths << SectionsRails.config.path
+    end
   end
 end

data/lib/sections_rails/section.rb

@@ -0,0 +1,106 @@
+module SectionsRails
+  require "sections_rails/config"
+  require "action_view"
+
+  class Section
+    include ActionView::Helpers::AssetTagHelper
+    include ActionView::Helpers::RenderingHelper
+
+    # TODO(KG): remove unnessessary.
+    attr_reader :asset_path, :css, :directory_name, :filename, :absolute_path, :js, :locals, :partial, :partial_path, :path # NOTE (SZ): too many? :)
+
+    def initialize section_name, rails_obj, options = {}
+
+      # Helpers for filenames.
+      @filename       = File.basename(section_name, '.*')
+      @directory_name = File.dirname(section_name)
+      @asset_path     = File.join(@directory_name, @filename, @filename)
+      @absolute_path  = File.join(Rails.root, SectionsRails.config.path, @directory_name, @filename, @filename)
+      @partial_path   = File.join(Rails.root, SectionsRails.config.path, @directory_name, @filename, "_#{@filename}")
+
+      # Options.
+      @js             = options[:js]
+      @css            = options[:css]
+      @partial        = options[:partial]
+      @locals         = options[:locals]
+
+      # For running view helper methods.
+      @rails_obj = rails_obj
+    end
+
+    def has_asset? *extensions
+      extensions.flatten.each do |ext|
+        return true if File.exists?("#{@absolute_path}.#{ext}")
+      end
+      false
+    end
+
+    def has_default_js_asset?
+      has_asset? SectionsRails.config.js_extensions
+    end
+
+    def has_default_style_asset?
+      has_asset? SectionsRails.config.css_extensions
+    end
+
+    # Returns whether this section has a template.
+    def has_template?
+      SectionsRails.config.partial_extensions.each do |ext|
+        return true if File.exists?("#{@partial_path}.#{ext}")
+      end
+      false
+    end
+
+    # TODO(SZ): missing specs.
+    def render
+      result = []
+
+      # Include assets only for development mode.
+      if Rails.env != 'production'
+
+        # Include JS assets.
+        if js
+          result << @rails_obj.javascript_include_tag(File.join(path, js))
+        elsif js == false
+          # ":js => false" given --> don't include any JS.
+        elsif has_default_js_asset?
+          result << @rails_obj.javascript_include_tag(asset_path)
+        end
+
+        # Include CSS assets.
+        if css
+          result << @rails_obj.stylesheet_link_tag(File.join(path, css))
+        elsif css == false
+          # ":css => false" given --> don't include any CSS.
+        elsif has_default_style_asset?
+          result << @rails_obj.stylesheet_link_tag(@asset_path)
+        end
+      end
+
+      # Render the section partial into the view.
+      case partial
+        when :tag
+          result << @rails_obj.content_tag(:div, '', :class => filename)
+
+        when false
+          # partial: false given --> render nothing
+
+        when nil
+          # partial: nil given --> render default partial
+
+          if self.has_template?
+            result << @rails_obj.render(:partial => asset_path, :locals => locals)
+          else
+            result << @rails_obj.content_tag(:div, '', :class => filename)
+          end
+
+        else
+          # partial: custom path given --> render custom partial
+
+          result << @rails_obj.render("#{path}/#{partial}", locals)
+      end
+
+      result.join("\n").html_safe
+    end
+  end
+end

data/lib/sections_rails/version.rb

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

data/lib/sections_rails.rb

@@ -1,74 +1,12 @@
-require 'sections_rails/string_tools'
+require 'sections_rails/helpers'
+require "sections_rails/section"
 
 module SectionsRails
-
   require "sections_rails/railtie" if defined?(Rails)
-  
-  def section combined_name, options = {}
-    result = []
-
-    # Split the parameter into file name and directory name.
-    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.
-    file_path = "#{directory_path}/#{filename}"                              # Base path of filename in section: /app/sections/admin/logo/logo
-    if Rails.env != 'production'
-
-      # Include JS assets.
-      if options.has_key? :js
-        if 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")
-          result << javascript_include_tag("#{directory}#{filename}/#{filename}")
-        end
-      end
-
-      # Include CSS assets.
-      if options.has_key? :css
-        if 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") 
-          result << stylesheet_link_tag("#{directory}#{filename}/#{filename}")
-        end
-      end
-    end
 
-    # Render the section partial into the view.
-    partial_path = "#{directory_path}/_#{filename}.html"
-    if options.has_key? :partial
-      if options[:partial] == :tag
-        # :partial => :tag given --> render the tag.
-        result << content_tag(:div, '', :class => filename)
-      elsif options[:partial]
-        # some value for :partial given --> render the given partial.
-        result << render(:partial => "/../sections/#{directory}#{filename}/#{options[:partial]}", :locals => options[:locals])
-      else
-        # 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")
-        result << render(:partial => "/../sections/#{directory}#{filename}/#{filename}", :locals => options[:locals])
-      else
-        result << content_tag(:div, '', :class => filename)
-      end
-    end
-    result.join("\n").html_safe
+  def section name, options = {}
+    SectionsRails::Section.new(name, self, options).render
   end
-  
 end
 
 ActionView::Base.send :include, SectionsRails

data/lib/tasks/sections_rails_tasks.rake

@@ -1,4 +1,5 @@
-namespace :sections do 
+namespace :sections do
+  include SectionsRails::Helpers
 
   desc "Prepares the assets for precompilation in a setup with a single application.js file"
   task :prepare do

data/spec/{lib/string_tools_spec.rb → sections_rails/helpers_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
-require 'sections_rails/string_tools'
+include SectionsRails::Helpers
 
-describe 'string_tools' do
+describe SectionsRails::Helpers do
 
-  describe 'find_sections' do
+  describe '#find_sections' do
     it 'finds ERB sections with symbols' do
       find_sections("one <%= section :alpha %> two").should == ['alpha']
     end
@@ -53,10 +53,10 @@ describe 'string_tools' do
     end
   end
 
-  describe 'split_path' do
+  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/'
+      directory.should == '/one/two'
       filename.should == 'three.js'
     end
 

data/spec/sections_rails/section_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+# TODO(SZ): missing specs.
+describe SectionsRails::Section do
+  before(:each) { Rails.stub(:root).and_return('/rails_root/') }
+  subject { SectionsRails::Section.new 'folder/section' }
+
+  describe 'initialize' do
+    its(:filename)       { should == 'section' }
+    its(:directory_name) { should == 'folder' }
+    its(:asset_path)     { should == 'folder/section/section' }
+    its(:absolute_path)  { should == '/rails_root/app/sections/folder/section/section' }
+    its(:partial_path)   { should == '/rails_root/app/sections/folder/section/_section' }
+  end
+
+  describe "#has_asset?" do
+
+    it "tries filename variations with all given extensions" do
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.one").and_return(false)
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.two").and_return(false)
+      subject.has_asset? ['one', 'two']
+    end
+
+    it "returns false if the files don't exist" do
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.one").and_return(false)
+      subject.has_asset?(['one']).should be_false
+    end
+
+    it "returns true if one of the given extensions matches a file" do
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.one").and_return(false)
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.two").and_return(true)
+      subject.has_asset?(['one', 'two']).should be_true
+    end
+  end
+
+  describe "#has_default_js_asset" do
+    it 'looks for all different types of JS file types' do
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.js").and_return(false)
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.coffee").and_return(false)
+      File.should_receive(:exists?).with("/rails_root/app/sections/folder/section/section.js.coffee").and_return(false)
+      subject.has_default_js_asset?.should be_false
+    end
+
+    it 'returns TRUE if it JS file types' do
+      File.stub!(:exists?).and_return(true)
+      subject.has_default_js_asset?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'rails'
 require 'rspec'
+require 'rspec-rails'
+require 'sections_rails'
 
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sections_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70244820224220 !ruby/object:Gem::Requirement
+  requirement: &70157100841340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70244820224220
+  version_requirements: *70157100841340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70244820223480 !ruby/object:Gem::Requirement
+  requirement: &70157100840720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244820223480
+  version_requirements: *70157100840720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70244820222620 !ruby/object:Gem::Requirement
+  requirement: &70157100839900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244820222620
+  version_requirements: *70157100839900
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70244820221720 !ruby/object:Gem::Requirement
+  requirement: &70157100838960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244820221720
+  version_requirements: *70157100838960
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70244820220540 !ruby/object:Gem::Requirement
+  requirement: &70157100837520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244820220540
+  version_requirements: *70157100837520
 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.
@@ -77,15 +77,18 @@ extra_rdoc_files: []
 files:
 - lib/generators/section_generator.rb
 - lib/generators/sections_generator.rb
+- lib/sections_rails/config.rb
+- lib/sections_rails/helpers.rb
 - lib/sections_rails/railtie.rb
-- lib/sections_rails/string_tools.rb
+- lib/sections_rails/section.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/sections_rails/helpers_spec.rb
+- spec/sections_rails/section_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kevgo/sections_rails
 licenses: []
@@ -113,5 +116,6 @@ 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/sections_rails/helpers_spec.rb
+- spec/sections_rails/section_spec.rb
 - spec/spec_helper.rb

data/lib/sections_rails/string_tools.rb

@@ -1,15 +0,0 @@
-# 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