storefront 0.3.2 → 0.5.0

data/lib/storefront/components/table.rb

@@ -0,0 +1,232 @@
+module Storefront
+  module Components
+    class Table < Base
+    
+      attr_reader :content, :template, :key
+    
+      def initialize(template, *args)
+        @template         = template
+        options           = args.extract_options!
+        record_or_key     = args.shift
+        @key              = record_key(record_or_key)
+        @row_index        = 0
+        @cell_index       = 0
+        @scope            = :table
+        @headers          = []
+        options[:summary] ||= "Table for #{key.titleize}"
+        options[:class]   = ["data-table", options[:class]].compact.uniq.join(" ")
+        options[:role]    = :grid
+        data              = options.delete(:data) || {}
+        data[:url]        = options[:url] || @template.controller.request.path
+        data[:for]        = options[:for] || options[:model] || @key
+        data[:total]      = options[:total] if options[:total]
+        data[:page]       = options[:page] if options[:page]
+        data[:count]      = options[:count] if options[:count]
+        aria              = options.delete(:aria) || {}
+        aria[:"aria-multiselectable"] = false unless aria.has_key?(:"aria-multiselectable") || options[:multiselect] == true
+        options[:data]    = data
+        options[:id]      ||= "#{record_or_key.to_s}-table"
+      end
+      
+      def render(&block)
+        template.capture_haml do
+          template.haml_tag :table, options do
+            yield(self)
+          end
+        end
+      end
+    
+      def table_query_row_class
+        ["search-row", query_params.except("page", "sort").blank? ? nil : "search-results"].compact.join(" ")
+      end
+    
+      def link_to_sort(title, attribute, options = {})
+        sort_param = sort_value(attribute, opposite_sort_direction(attribute))
+        link_to title, with_params(request.path, :sort => sort_param), options
+      end
+  
+      def next_page_path(collection)
+        with_params(request.path, :page => collection.next_page)
+      end
+    
+      def prev_page_path(collection)
+        with_params(request.path, :page => collection.prev_page)
+      end
+    
+      def first_page_path(collection)
+        with_params(request.path, :page => 1)
+      end
+  
+      def last_page_path(collection)
+        with_params(request.path, :page => collection.last_page)
+      end
+  
+      def current_page_num
+        page = params[:page] ? params[:page].to_i : 1
+        page = 1 if page < 1
+        page
+      end
+  
+      def caption
+    
+      end
+  
+      # scope='col'
+      def head(attributes = {}, &block)
+        @hide_header = attributes.delete(:visible) == false
+        template.capture_haml do
+          @row_index = 0
+          @scope     = :head
+          template.haml_tag :thead, attributes, &block
+          @row_index = 0
+          @scope     = :table
+        end
+      end
+      
+      # scope='row'
+      # <td headers='x'/>
+      def body(attributes = {}, &block)
+        template.capture_haml do
+          @row_index = 0
+          @scope     = :body
+          template.haml_tag :tbody, attributes, &block
+          @row_index = 0
+          @scope     = :table
+        end
+      end
+  
+      def foot(attributes = {}, &block)
+        template.capture_haml do
+          @row_index = 0
+          @scope     = :foot
+          template.haml_tag :tfoot, attributes, &block
+          @row_index = 0
+          @scope     = :table
+        end
+      end
+  
+      def row(*args, &block)
+        attributes = args.extract_options!
+        if @scope == :body
+          attributes[:class] = [template.cycle("odd", "even"), attributes[:class]].compact.uniq.join(" ")
+        end
+        attributes[:role] = :row
+        attributes[:scope] = :row
+        template.capture_haml do
+          @row_index += 1
+          @cell_index = 0
+          template.haml_tag :tr, attributes, &block
+          @cell_index = 0
+        end
+      end
+  
+      def column(*args, &block)
+        attributes = args.extract_options!
+        value   = args.shift
+        attributes[:id]   ||= id_for(:header, key, value, @row_index, @cell_index) if config.id_enabled_on.include?("table")
+        [:width, :height].each do |size|
+          attributes[size] = pixelate(attributes[size]) unless attributes[size].nil?
+        end
+        @headers.push(attributes[:id])
+      
+        template.capture_haml do
+          template.haml_tag :col, attributes
+          @cell_index += 1
+        end
+      end
+    
+      # direction => "ascending"
+      # valid directions: ascending, descending, none, other
+      # abbr is what the header controls (for sorting)
+      def header(*args, &block)
+        attributes = args.extract_options!
+        value   = args.shift
+        if value.is_a?(::Symbol)
+          attributes[:abbr] ||= value.to_s
+        end
+        # aria-selected if sorted
+        attributes[:role] = :columnheader
+        attributes[:id]   ||= id_for(:header, key, value, @row_index, @cell_index) if config.id_enabled_on.include?("table")
+        attributes[:scope] = :col
+        attributes[:abbr] ||= attributes.delete(:for) if attributes.has_key?(:for)
+        [:width, :height].each do |size|
+          attributes[size] = pixelate(attributes[size]) unless attributes[size].nil?
+        end
+        sort = attributes.delete(:sort) == true
+        label = attributes.delete(:label) || (value.is_a?(::String) ? value.strip : value.to_s.titleize)
+    
+        if sort
+          attributes[:class] = [attributes[:class], attributes.delete(:sort_class) || "sortable"].compact.uniq.join(" ")
+          attributes[:direction] ||= template.sort_class(value)
+        end
+    
+        direction = attributes.delete(:direction)
+        if direction.present?
+          attributes[:"aria-sort"] = direction
+          attributes[:class] = [attributes[:class], direction].join(" ")
+          attributes[:"aria-selected"] = true
+        else
+          attributes[:"aria-sort"] = "none"
+          attributes[:"aria-selected"] = false
+        end
+    
+        @headers.push(attributes[:id])
+        template.capture_haml do
+          if block_given?
+            template.haml_tag :th, attributes, &block
+          else
+            if sort
+              template.haml_tag :th, attributes do
+                template.haml_concat template.link_to_sort(label, value)
+              end
+            else
+              template.haml_tag :th, attributes do
+                template.haml_tag :span, label
+              end
+            end
+          end
+          @cell_index += 1
+        end
+      end
+  
+      def cell(*args, &block)
+        attributes                      = args.extract_options!
+        value                           = args.shift
+        attributes[:role]               = :gridcell
+        attributes[:id]                 ||= id_for(:cell, key, value, @row_index, @cell_index) if config.id_enabled_on.include?("table")
+        #attributes[:"aria-describedby"] = @headers[@cell_index]
+        attributes[:headers]            = @headers[@cell_index]
+        [:width, :height].each do |size|
+          attributes[size] = pixelate(attributes[size]) unless attributes[size].nil?
+        end
+        template.capture_haml do
+          if block_given?
+            template.haml_tag :td, attributes, &block
+          else
+            template.haml_tag :td, value.to_s.strip, attributes
+          end
+          @cell_index                     += 1
+        end
+      end
+    
+      def record_key(record_or_key)
+        if record_or_key.is_a?(String) || record_or_key.is_a?(Symbol)
+          record_or_key.to_s
+        else
+          record_or_key.class.name
+        end
+      end
+  
+      def id_for(type, key, value, row_index = @row_index, column_index = @column_index)
+        [key, type, row_index, column_index].compact.map do |node|
+          node.to_s.gsub(/[\s_]/, "-")
+        end.join("-")
+      end
+  
+      private
+      def pixelate(value)
+        value.is_a?(::String) ? value : "#{value}px"
+      end
+    end
+  end
+end

data/lib/storefront/components/text.rb

@@ -0,0 +1,29 @@
+module Storefront
+  module Components
+    class Text < Base
+      def render(&block)
+        template.capture_haml do
+          template.haml_tag :article, options[:outer_html] do
+            header = template.header_widget(options)
+            template.haml_concat header.gsub(/\n$/, "") if header.present?
+            content = options[:body] || options[:content]
+            content ||= template.capture(&block) if block_given?
+            template.haml_tag options[:tag], content, options[:content_html]
+          end
+        end
+      end
+      
+      def extract_options!(*args)
+        options = super(*args)
+        
+        options[:content_html] ||= {}
+        
+        merge_class! options[:content_html], config.content_class
+        
+        options[:tag] ||= :p
+        
+        options
+      end
+    end
+  end
+end

data/lib/storefront/configuration.rb

@@ -1,11 +1,24 @@
 module Storefront
+  class << self
+    def configure(&block)
+      yield configuration
+    end
+    
+    def configuration
+      @configuration ||= Storefront::Configuration.new
+    end
+  end
+  
   class Configuration
     attr_accessor :field,
+      :component_suffix,
       :hint_class,
       :hint_tag,
       :label_class,
       :error_class,
       :error_tag,
+      :auto_id_nav, 
+      :auto_id_form,
       :valid_class,
       :required_class,
       :required_abbr,
@@ -65,12 +78,15 @@ module Storefront
       :always_include_error_tag,
       :cycle_fields,
       :require_if_validates_presence,
+      :default_component_header_level, 
       # localization
       :localize_with_inheritance,
       :localize_with_namespace,
-      :localize_with_nested_model
+      :localize_with_nested_model,
+      :meta_tags
     
     def initialize
+      @component_suffix                         = "widget"
       @hint_class                               = "hint"
       @hint_tag                                 = :figure
       @label_class                              = "label"
@@ -99,12 +115,13 @@ module Storefront
       @escape_html_entities_in_hints_and_labels = false
       @rename_nested_attributes                 = true
       @inline_validations                       = true
+      @auto_id_form                             = true
       @fieldset_class                           = "fieldset"
       @field_class                              = "field"
       @validate_class                           = "validate"
       @legend_class                             = "legend"
       @form_class                               = "form"
-      @id_enabled_on                            = [] # %w(field label error hint)
+      @id_enabled_on                            = ["input"] # %w(field label error hint)
       @widgets_path                             = "shared/widgets"
       @nav_class                                = "list-item"
       @include_aria                             = true
@@ -118,6 +135,7 @@ module Storefront
       @list_tag                                 = :ul
       @page_header_id                           = "header"
       @page_title_id                            = "title"
+      @auto_id_nav                              = false
       @page_subtitle_id                         = "subtitle"
       @widget_class                             = "widget"
       @header_class                             = "header"
@@ -126,7 +144,7 @@ module Storefront
       @content_class                            = "content"
       @default_header_level                     = 3
       @term_separator                           = ":"
-      @rich_input                               = true
+      @rich_input                               = false
       @submit_fieldset_class                    = "submit-fieldset"
       @add_label                                = "+"
       @remove_label                             = "-"
@@ -137,6 +155,15 @@ module Storefront
       @localize_with_namespace                  = false
       @localize_with_nested_model               = false
       @localize_with_inheritance                = true
+      @default_component_header_level           = 3
+      @meta_tags                                = [
+        :description,
+        :keywords,
+        :author,
+        :copyright,
+        :category,
+        :robots
+      ]
     end
     
     def get(key)
@@ -144,11 +171,32 @@ module Storefront
     end
     
     def current_scope
-      Thread.current[:storefront_config]
+      Thread.current[:storefront]
     end
     
     def current_scope=(value)
-      Thread.current[:storefront_config] = value
+      Thread.current[:storefront] = value
+    end
+    
+    def configure_action_view
+      base = "#{File.expand_path(File.dirname(__FILE__))}/helpers"
+      Dir["#{base}/*"].each do |path|
+        next if File.directory?(path)
+        constant_name = File.basename(path, File.extname(path)).gsub("/", "::").camelize
+        ActionView::Base.send :include, "Storefront::Helpers::#{constant_name}".constantize
+      end
+    end
+    
+    def configure_action_controller
+      base = "#{File.expand_path(File.dirname(__FILE__))}/helpers"
+      Dir["#{base}/*"].each do |path|
+        next if File.directory?(path) || File.basename(path) =~ /(form|table|dashboard)/
+        # need to do these as traditional helper declarations somehow
+        constant_name = File.basename(path, File.extname(path)).gsub("/", "::").camelize
+        ActionController::Base.send :include, "Storefront::Helpers::#{constant_name}".constantize
+      end
+      
+      ActionController::Base.send :before_filter, :configure_storefront
     end
   end
 end

data/lib/storefront/helpers/cache_helper.rb

@@ -1,24 +1,42 @@
 module Storefront
-  module CacheHelper
-    def optional_cache(key, &block)
-      cache(key, &block) unless session[:disable_caching]
-    end
-  
-    def conditional_cache(key, options = {}, &block)
-      condition = true
-      condition = false if options.has_key?(:if) && options[:if] != true
-      if condition
-        cache(key, &block)
-      else
-        haml_concat capture_haml(&block)
+  module Helpers
+    module CacheHelper      
+      def cached_partial(path, locals = {})
+        if Rails.env.development?
+          render(:partial => path, :locals => locals)
+        else
+          fragment_for path do
+            concat render(:partial => path, :locals => locals)
+          end
+        end
       end
-    end
-  
-    def set_cache_buster
-      if request.xhr?
-        response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
-        response.headers["Pragma"] = "no-cache"
-        response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+      
+      def cached_content(key, &block)
+        if Rails.env.development?
+          yield
+        else
+          fragment_for key do
+            concat yield
+          end
+        end
+      end
+      
+      def conditional_cache(key, options = {}, &block)
+        condition = true
+        condition = false if options.has_key?(:if) && options[:if] != true
+        if condition
+          cache(key, &block)
+        else
+          haml_concat capture_haml(&block)
+        end
+      end
+
+      def set_cache_buster
+        if request.xhr?
+          response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
+          response.headers["Pragma"] = "no-cache"
+          response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+        end
       end
     end
   end

data/lib/storefront/helpers/component_helper.rb

@@ -1,50 +1,89 @@
 module Storefront
-  # Encapsulates common browser hacks
-  module ComponentHelper
-    def rich_image_tag(label, path, options = {})
-      capture_haml do
-        haml_tag :span
-        haml_concat image_tag(label, path, options)
+  module Helpers
+    module ComponentHelper
+      def render_flash
+        flash_to_render = [:success, :failure, :notice, :error]
+        flash.select { |type, _| flash_to_render.include?(type) }.map do |type, content|
+          content_tag(:output, content, :class => "flash-#{type}")
+        end.join
+      end
+      
+      def flash?
+        flash.present?
       end
-    end
-    
-    def rich_button(*args, &block)
-      attributes = args.extract_options!
-      label = args.shift
-      path  = args.shift
-      tag   = attributes.delete(:as)
-    
-      #locale_options = attributes.delete(:locale_options) || {}
-      #label          = t?(label, locale_options.reverse_merge(:scope => :"buttons"))
-    
-      inner_html     = attributes.delete(:inner_html) || {}
-      outer_html     = attributes.delete(:outer_html) || {}
-    
-      inner_html.merge! clone_attributes(attributes)
-      outer_html.merge! clone_attributes(attributes.except(:rel, :target))
     
-      merge_class! outer_html, "button"
-      
-      capture_haml do
-        haml_tag :div, :<, outer_html do
-          result = succeed "<span></span>".html_safe do
-            if block_given?
-              haml_concat capture_haml(&block).gsub("\n", "").strip
-            else
-              if tag
-                haml_tag tag, :>, :<, inner_html
-              else
-                haml_concat link_to(label, path, inner_html)
-              end
-            end
+      def form(*args, &block)
+        Storefront::Components::Form.new(self, *args).render_with_pointer(&block)
+      end
+      alias_method :form_for, :form
+      
+      def table(*args, &block)
+        Storefront::Components::Table.new(self, *args).render_with_pointer(&block)
+      end
+      alias_method :table_for, :table
+      
+      def sidebar(*args, &block)
+        Storefront::Components::Sidebar.new(self, *args).render_with_pointer(&block)
+      end
+      alias_method :sidebar_for, :sidebar
+      
+      %w(address breadcrumb button definition_list definition_list_item footer header javascript_template list menu nav slider text video).each do |name|
+        class_eval %{
+          def #{name}_widget(*args, &block)
+            Storefront::Components::#{name.camelize}.new(self, *args).render_with_pointer(&block)
           end
-          haml_concat result
+          alias_method :#{name}, :#{name}_widget
+        }
+      end
+      
+      alias_method :terms, :definition_list
+      alias_method :term, :definition_list_item
+      
+      def cached_widget(*args, &block)
+        options = args.extract_options!
+        
+        unless options[:cache_key]
+          raise ArgumentError.new("Specify the :cache_key option with a unique id for fragment caching this widget.")
+        end
+        
+        cached_content widget_cache_key(args[0], options[:cache_key]) do
+          widget(*(args << options), &block)
         end
       end
-    end
-  
-    def rich_input(*args, &block)
-    
+      
+      # Core widget method
+      # 
+      # You can automatically cache this based on some fragment cache key, 
+      # and it will invalidate the cache automatically
+      # If the widget is given a record, it will use that.
+      def widget(*args, &block)
+        options = args.extract_options!
+        path    = args.shift
+        name    = path.to_s.gsub("/", "_")
+        
+        if self.respond_to?("#{name}_widget")
+          send("#{name}_widget", name, options, &block)
+        else
+          raise "Please define a helper method 'def #{name}_widget(*args)'"
+        end
+      end
+      alias_method :component, :widget
+      alias_method :cell, :widget
+      
+      def widget_cache_key(name, cache_key)
+        key = []
+        key << "storefront/widget"
+        key << "#{name}" # name of widget
+        key << cache_key.to_s
+        key.join("/")
+      end
+      
+      protected
+      def render_widget_partial(name, *args)
+        path   = name.is_a?(::Symbol) ? ::File.join(storefront_config.widgets_path, name.to_s) : name.to_s
+        locals = args.extract_options!.merge(:yielded_content => block_given? ? capture(&block) : nil)
+        render :partial => path, :locals => locals
+      end
     end
   end
 end