storefront 0.2.0

data/lib/storefront/helpers/body_helper.rb

@@ -0,0 +1,18 @@
+module Storefront
+  module BodyHelper
+    def body_id(string)
+      @body_id = string
+    end
+
+    def body_class(string)
+      @body_class = string
+    end
+
+    def body_attributes(options = {})
+      options[:class] = @body_class if @body_class
+      options[:id] = @body_id if @body_id
+      
+      options
+    end
+  end
+end

data/lib/storefront/helpers/browser_helper.rb

@@ -0,0 +1,54 @@
+module Storefront
+  module BrowserHelper  
+    # check the current browser (via user agent) for the following:
+    # :mozilla / :firefox
+    # :ie6
+    # :ie7
+    # :ie
+    # :iphone
+    # :safari
+    def browser_is? name
+      name = name.to_s.strip
+
+      return true if browser_name == name
+      return true if (name == 'mozilla' or name == "firefox") && browser_name == 'gecko'
+      return true if name == 'ie6' && browser_name.index('ie6')
+      return true if name == 'ie7' && browser_name.index('ie7')
+      return true if name == 'ie' && browser_name.index('ie')
+      return true if name == 'iphone' && browser_name == 'iphone'
+      return true if name == 'webkit' && browser_name == 'safari'
+    end
+
+    # find the current browser name
+    def browser_name
+      @browser_name ||= begin
+        ua = request.user_agent.to_s.downcase
+        if ua.index('msie') && !ua.index('opera') && !ua.index('webtv')
+          'ie'+ua[ua.index('msie')+5].chr
+        elsif ua.index('gecko/') 
+          'gecko'
+        elsif ua.index('opera')
+          'opera'
+        elsif ua.index('konqueror') 
+          'konqueror'
+        elsif ua.index('iphone')
+          'iphone'
+        elsif ua.index('applewebkit/')
+          'safari'
+        elsif ua.index('mozilla/')
+          'gecko'
+        else
+          ""
+        end
+      end
+    end
+
+    def ip_address
+      request.env['REMOTE_ADDR']
+    end
+
+    def user_agent
+      request.user_agent
+    end
+  end
+end

data/lib/storefront/helpers/cache_helper.rb

@@ -0,0 +1,25 @@
+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)
+      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/collection_helper.rb

@@ -0,0 +1,14 @@
+module Storefront
+  module CollectionHelper
+    def collection_class(index, length)
+      length = length.length if length.is_a?(::Array)
+      if index == 0
+        "first"
+      elsif index == length - 1
+        "last"
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/storefront/helpers/component_helper.rb

@@ -0,0 +1,35 @@
+module Storefront
+  # Encapsulates common browser hacks
+  module ComponentHelper
+    def component_image_tag
+      capture_haml do
+        haml_tag :span
+        haml_concat image_tag()
+      end
+    end
+    
+    def popup_button(label, path, message, subtitle, submit = nil, kind = :group)
+      link_to "<span>#{label}</span>", path, :class => "delete", "data-message" => message, "data-subtitle" => subtitle, "data-model" => kind.to_s, "data-submit" => submit.to_s
+    end
+    
+    def component_button(*args, &block)
+      options = args.extract_options!
+      button_options = options.delete(:button_options) || {}
+      
+      if block_given?
+        content = capture(&block)
+      else
+        label = args.shift
+        path  = args.shift
+        content = link_to(label, path, button_options)
+      end
+      
+      capture_haml do
+        haml_tag :button, options.merge(:class => ["button", options[:class]].compact.uniq.join(" ")) do
+          haml_concat content
+          haml_tag :span
+        end
+      end
+    end
+  end
+end

data/lib/storefront/helpers/dashboard_helper.rb

@@ -0,0 +1,37 @@
+module Storefront
+  module DashboardHelper
+    def dashboard_for(*args, &block)
+      record            = args.shift
+      options           = args.extract_options!
+      condition         = extract_condition!(options)
+      @dashboard_record = record
+      concat(capture(&block)) if record && condition != false
+      @dashboard_record = nil
+    end
+    
+    def dashboard(key, locals = {})
+      render :partial => key, :locals => locals.reverse_merge(:figures => [])
+    end
+    
+    def figure(*names, &block)
+      locals = names.extract_options!
+      condition = extract_condition!(locals)
+
+      if condition != false
+        locals.reverse_merge(:locale => nil)
+        locals.merge!(:yielded_content => capture(&block)) if block_given?
+        result = capture_haml do
+          names.each do |name|
+            haml_concat render(:partial => "shared/dashboard/#{name}", :locals => locals)
+          end
+        end
+      end
+
+      result
+    end
+    
+    def report_for(record_or_key, hash, options = {}, &block)
+      Semantic::Dashboard.new(self, record_or_key, hash, options, &block).content
+    end
+  end
+end

data/lib/storefront/helpers/debug_helper.rb

@@ -0,0 +1,11 @@
+module Storefront
+  module DebugHelper
+    def inspecting?
+      params[:inspect] == "true"
+    end
+
+    def editing?
+      params[:edit] == "true"
+    end
+  end
+end

data/lib/storefront/helpers/definition_list_helper.rb

@@ -0,0 +1,29 @@
+module Storefront
+  module DefinitionListHelper    
+    def term(key, value, options = {})
+      return if value.blank?
+      condition = extract_condition!(options)
+
+      if condition != false
+        result = capture_haml do
+          haml_tag :tr, :class => "term" do
+            text = key.is_a?(String) ? key : t("widgets.details.#{key}")
+            haml_tag :td, text.gsub(/:?$/, ":"), :class => "key first"
+            haml_tag :td, value, :class => "value"
+          end
+        end
+      end
+      
+      result
+    end
+    
+    def terms(&block)
+      capture_haml do
+        haml_tag :dl do
+          yield
+        end
+      end
+    end
+    alias definition_list terms
+  end
+end

data/lib/storefront/helpers/error_helper.rb

@@ -0,0 +1,11 @@
+module Storefront
+  module ErrorHelper    
+    def render_not_found(exception)
+      Exceptional::Catcher.handle_with_controller(exception, self, request) if defined?(::Exceptional)
+      logger.error(exception)
+      puts exception.inspect
+      puts exception.backtrace.join("\n")
+      render :template => "/error/404.html", :status => 404, :layout => false
+    end
+  end
+end

data/lib/storefront/helpers/flash_helper.rb

@@ -0,0 +1,14 @@
+module Storefront
+  module FlashHelper
+    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
+end

data/lib/storefront/helpers/form_helper.rb

@@ -0,0 +1,8 @@
+module Storefront
+  module FormHelper
+    def form_for(*args, &block)
+      Storefront::Form.new(self, *args, &block).content
+    end
+  end
+end
+

data/lib/storefront/helpers/format_helper.rb

@@ -0,0 +1,59 @@
+module Storefront
+  module FormatHelper
+    def rendered_text(string)
+      string.to_s.
+        gsub(/<\/?[^>]*>/, '').
+        gsub(/\n/, " ").
+        gsub("\r", " ").
+        squeeze(" ").
+        gsub(/\"/, "&Prime;"). # convert quotes to inches
+        gsub(/\'/, "&prime;"). # single quote to feet
+        gsub(/\$0?0*\.(\d+)/, "\\1&cent;").html_safe
+    end
+    
+    def format_money(value)
+      value.present? ? ("$" + number_with_precision(value.to_s.gsub("$", ""), :precision => 2)) : nil
+    end
+    
+    def format_percent(value)
+      value.present? ? (number_with_precision(value.to_s.gsub("%", ""), :precision => 0) + "%") : nil
+    end
+    
+    def sanitize(text)
+      text.gsub(/<\/?[^>]*>/, '').gsub(/\n/, " ").gsub("\r", " ").squeeze(" ")
+    end
+    
+    def n(value)
+      if value.respond_to?(:nan?) && value.nan?
+        0
+      else
+        value
+      end
+    end
+    
+    def s(string, default = "N/A")
+      string.present? ? string : default
+    end
+
+    def num(num, default = "N/A")
+      result = number_with_precision(num, :precision => 1)
+      result.blank? ? default : result
+    end
+
+    def money(value)
+      value ? value.to_s.gsub(/^\$?/, "$") : "$0"
+    end
+    
+    def read_binary_file(path)
+      File.open(path, 'rb') {|f| f.read }
+    end
+
+    def encoded_contents(path)
+      Base64.encode64(read_binary_file(path)).gsub(/\n/, '')
+    end
+
+    def font_face_data_uri(path)
+      "url(\"data:font/truetype;base64,#{encoded_contents(path)}\")"
+    end
+  end
+end

data/lib/storefront/helpers/head_helper.rb

@@ -0,0 +1,229 @@
+module Storefront
+  module HeadHelper
+    def meta_for(post)
+      result = ""
+      unless post.title.blank?
+        result << title(post.title)
+        result << "\n"
+      end
+      unless post.tags.blank?
+        result << keywords(post.tags.join(", "))
+        result << "\n"
+      end
+      unless post.description.blank?
+        result << description(post.description)
+        result << "\n"
+      end
+      result
+    end
+    
+    def meta(options = {})
+      title(options[:title]) if options.has_key?(:title)
+      description(options[:description]) if options.has_key?(:description)
+      keywords(options[:keywords]) if options.has_key?(:keywords)
+      copyright(options[:copyright]) if options.has_key?(:copyright)
+    end
+  
+    def meta_tags(*args)
+      options = args.extract_options!
+      site = options[:site] || args.first
+      result = title_tag(site, options[:title])
+      result << "\n"
+      result << content_type_tag
+      result << "\n"
+      result << description_tag(options[:description])
+      result << "\n"
+      result << keywords_tag(options[:keywords])
+      result << "\n"
+      result << copyright_tag(options[:copyright])
+      result
+    end
+    
+    # country
+    # classification
+    # author
+    # apple-mobile-web-app-capable
+    # apple-touch-fullscreen
+    # google-analytics
+    # Revisit-After
+    # category
+    def meta_tag(name, content = '')
+      tag(:meta, :name => name, :content => content)
+    end
+  
+    def title(string)
+      @content_for_title = string
+    end
+  
+    def title_tag(*args)
+      options = args.extract_options!
+    
+      site = options[:site] || args.first
+      # Prefix (leading space)
+      if options[:prefix]
+        prefix = options[:prefix]
+      elsif options[:prefix] === false
+        prefix = ''
+      else
+        prefix = ' '
+      end
+    
+      # Separator
+      unless options[:separator].blank?
+        separator = options[:separator]
+      else
+        separator = '|'
+      end
+  
+      # Suffix (trailing space)
+      if options[:suffix]
+        suffix = options[:suffix]
+      elsif options[:suffix] === false
+        suffix = ''
+      else
+        suffix = ' '
+      end
+
+      # Title
+      title = @content_for_title
+      if options[:lowercase] === true
+        title = title.downcase unless title.blank?
+      end
+    
+      # title
+      if title.blank?
+        result = content_tag :title, site
+      else
+        title = normalize_title(title)
+        title = [site] + title
+        title.reverse! unless options[:reverse] === false
+        sep = prefix + separator + suffix
+        result = content_tag(:title, title.join(sep))
+      end
+      result
+    end
+  
+    def description(string)
+      @content_for_description = string
+    end
+
+    def description_tag(default='')
+      content = normalize_description(@content_for_description || default)
+      tag(:meta, :name => :description, :content => content) unless content.blank?
+    end
+
+    def keywords(string)
+      @content_for_keywords = string
+    end
+
+    def keywords_tag(default = '')
+      content = normalize_keywords(@content_for_keywords || default)
+      tag(:meta, :name => :keywords, :content => content) unless content.blank?
+    end
+  
+    def copyright(string)
+      @content_for_copyright = string
+    end
+
+    def copyright_tag(default='')
+      content = @content_for_copyright || default
+      tag(:meta, :name => :copyright, :content => content) unless content.blank?
+    end
+  
+    def robots(*args)
+      content_for(:robots, args.join(", "))
+    end
+  
+    def robots_tag(*args)
+      options = args.extract_options!
+    
+      noindex_name = tags[:noindex].is_a?(String) ? tags[:noindex] : 'robots'
+      nofollow_name = tags[:nofollow].is_a?(String) ? tags[:nofollow] : 'robots'
+
+      if noindex_name == nofollow_name
+        content = [(tags[:noindex] ? 'noindex' : nil), (tags[:nofollow] ? 'nofollow' : nil)].compact.join(', ')
+        unless content.blank?
+          result << "\n"
+          result << tag(:meta, :name => noindex_name, :content => content)
+        end
+      else
+        if tags[:noindex]
+          result << "\n"
+          result << tag(:meta, :name => noindex_name, :content => 'noindex')
+        end
+        if tags[:nofollow]
+          result << "\n"
+          result << tag(:meta, :name => nofollow_name, :content => 'nofollow')
+        end
+      end
+      # canonical
+      unless tags[:canonical].blank?
+        result << "\n"
+        result << tag(:link, :rel => :canonical, :href => tags[:canonical]) 
+      end
+
+      return result
+    end
+  
+    def copyright(from)
+      now = Time.now.year
+      now.eql?(from) ? now : "#{from} - #{now}"
+    end
+  
+    # Apple
+    # http://developer.apple.com/safari/library/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html
+  
+    # Facebook (and opengraph)
+    # http://developers.facebook.com/docs/opengraph#types
+  
+    # http://wiki.developers.facebook.com/index.php/Facebook_Share/Specifying_Meta_Tags
+    def snapshot_tag(href)
+      tag(:link, :rel => "image_src", :href => href)
+    end
+  
+    # http://wiki.developers.facebook.com/index.php/Facebook_Share/Specifying_Meta_Tags
+    def medium(type)
+      tag(:meta, :name => :medium, :content => type)
+    end
+  
+    def classification(type)
+      tag(:meta, :name => "og:type", :content => type)
+    end
+  
+    def content_type_tag(type = "text/html", charset = "UTF-8")
+      meta_tag("Content-Type", "#{type}; charset=#{charset}")
+    end
+  
+    def search_link_tag(href, title)
+      link_tag({:rel => "search", :type => "application/opensearchdescription+xml", :href => href, :title => title})
+    end  
+  
+    def favicon_link_tag(favicon = "/favicon.ico")
+      link_tag({:rel => "shortcut icon", :href => favicon, :type => "image/x-icon"})
+    end
+  
+    def link_tag(options = {})
+      tag(:link, options)
+    end
+  
+    private
+
+      def normalize_title(title)
+        if title.is_a? String
+          title = [title]
+        end
+        title.map { |t| h(strip_tags(t)) }
+      end
+  
+      def normalize_description(description)
+        return '' unless description
+        truncate(strip_tags(description).gsub(/\s+/, ' '), :length => 200)
+      end
+  
+      def normalize_keywords(keywords)
+        return '' unless keywords
+        keywords = keywords.flatten.join(', ') if keywords.is_a?(Array)
+        strip_tags(keywords).mb_chars.downcase
+      end
+  end
+end