storefront 0.3.2 → 0.5.0

data/Rakefile

@@ -5,14 +5,14 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name              = "storefront"
   s.authors           = ["Lance Pollard"]
-  s.version           = "0.3.2"
-  s.description       = "Semantic HTML5 for Rails"
-  s.summary           = "A simple and semantic FormBuilder, TableBuilder, Locale Interpolator, and Widget API for Rails 3"
+  s.version           = "0.5.0"
+  s.description       = "Opinionated Forms, Tables, and Widgets for Rails and Sinatra"
+  s.summary           = "A simple and semantic FormBuilder, TableBuilder, Locale Interpolator, and Widget API for Rails 3 and Sinatra"
   s.homepage          = "http://github.com/viatropos/storefront"
   s.email             = "lancejpollard@gmail.com"
   s.rubyforge_project = "storefront"
   s.platform          = Gem::Platform::RUBY
-  s.files             = %w(Rakefile) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.files             = %w(Rakefile) + Dir["{lib}/**/*"]
   s.require_path      = "lib"
 end
 

data/lib/storefront.rb

@@ -1,39 +1,26 @@
+require 'rubygems'
+require 'ostruct'
+require 'i18n'
+require 'active_support'
+require 'active_support/core_ext'
+# require 'deli'
+# require 'html-schema'
+# require 'user_agent'
+# require 'sanitize'
+# require 'stringex'
+# require 'kronic'
+# require 'htmlentities'
+# require 'smartypants'
+require 'haml'
 
-# This takes care of the rest of functionality you need
-# for an SEO and easy to build page.
-# It includes: metadata helpers, grid helpers (e.g. for photo gallerys),
-# navigation helpers (menus and breadcrumbs),
-# better render method so you can pass a block to partials
-# http://github.com/rpheath/navigation_helper.git
-# http://github.com/justinfrench/lovely-layouts.git
-# http://github.com/ianwhite/truncate_html
-# http://github.com/dekart/breadcrumbs.git
-# http://github.com/html/once/blob/master/lib/once.rb
-# http://github.com/fnando/breadcrumbs.git
-# http://github.com/semanticart/smart-meta
-base = "#{File.expand_path(File.dirname(__FILE__))}/storefront"
-Dir["#{base}/railtie"]
-Dir["#{base}/helpers/*"].each do |path|
-  require path unless ::File.directory?(path)
-end
+this = File.expand_path(File.dirname(__FILE__))
 
-require "#{base}/form/base"
-require "#{base}/form/input"
-require "#{base}/form/builder"
+$:.unshift this
 
-# make this more explicit
-Dir["#{base}/**/*"].each do |path|
-  require path unless ::File.directory?(path) || path =~ /helpers/
-end
+require "storefront/railtie"
+require "storefront/configuration"
 
-module Storefront
-  class << self
-    def configure(&block)
-      yield configuration
-    end
-    
-    def configuration
-      @configuration ||= Storefront::Configuration.new
-    end
-  end  
-end
+Dir["#{this}/storefront/helpers/**/*"].each { |path| require path unless ::File.directory?(path) }
+require "storefront/components/base"
+Dir["#{this}/storefront/components/**/*"].each { |path| require path unless ::File.directory?(path) }
+Dir["#{this}/storefront/models/**/*"].each { |path| require path unless ::File.directory?(path) }

data/lib/storefront/components/base.rb

@@ -0,0 +1,99 @@
+module Storefront
+  module Components
+    class << self
+      def pointer
+        @pointer ||= []
+      end
+    end
+    
+    class Base
+      include Storefront::Helpers::ContentHelper
+      
+      attr_reader :options, :template
+      
+      def initialize(template, *args)
+        @template = template
+        @options  = extract_options!(*args)
+      end
+      
+      # The +to_s+ actually renders the object to HAML.
+      # 
+      # This allows you to pass the widget into a variable the same way you would 
+      # actually render it in HAML.
+      def render(&block)
+        
+      end
+      
+      def render_with_pointer(&block)
+        pointer.push(component_name)
+        result = render(&block)  
+        pointer.pop
+        result
+      end
+      
+      def inside?(key)
+        index = pointer.index(key)
+        !!(index && index >= 0 && index < pointer.length - 1)
+      end
+      
+      def pointer
+        Storefront::Components.pointer
+      end
+      
+      def to_s
+        render
+      end
+      
+      def extract_options!(*args)
+        options       = args.extract_options!
+        key           = args.shift
+        
+        options[:title] ||= false
+        options[:key] ||= key
+        options[:outer_html] ||= {}
+        
+        options[:body_html] ||= {}
+        options[:footer_html] ||= {}
+        
+        unless options[:widget_class] == false
+          merge_class! options[:outer_html], *extract_classes!(component_name)
+        end
+        
+        options
+      end
+      
+      def component_name
+        @component_name ||= self.class.name.split("::").last.underscore
+      end
+    
+      def extract_classes!(type)
+        [
+          storefront_config.widget_class,
+          type.to_s.strip.gsub(/[\s|_]+/, storefront_config.separator).squeeze(storefront_config.separator)
+        ]
+      end
+      
+      protected
+      def config
+        Storefront.configuration
+      end
+      
+      def view_context
+        config.current_scope[:context].send(:view_context)
+      end
+      
+      def method_missing(method, *args, &block)
+        if view_context.respond_to?(method)
+          self.class.class_eval %{
+            def #{method}(*args, &block)
+              view_context.#{method}(*args, &block)
+            end
+          }
+          send method, *args, &block
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/storefront/components/breadcrumb.rb

@@ -0,0 +1,7 @@
+module Storefront
+  module Components
+    class Breadcrumb < Base
+    
+    end
+  end
+end

data/lib/storefront/components/button.rb

@@ -0,0 +1,37 @@
+module Storefront
+  module Components
+    class Button < Base
+      def initialize(*args, &block)
+        attributes = args.extract_options!
+        label      = args.shift
+        path       = args.shift
+        tag        = attributes.delete(:as)
+      
+        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
+            end
+            haml_concat result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/storefront/components/definition_list.rb

@@ -0,0 +1,34 @@
+module Storefront
+  module Components
+    class DefinitionList < Storefront::Components::Base
+      def render(&block)
+        template.capture_haml do
+          template.haml_tag options[:as], options[:outer_html] do
+            @separator = options.has_key?(:separator) ? options[:separator] : config.term_separator
+            header = template.header_widget(options)
+            template.haml_concat header.gsub(/\n$/, "") if header.present?
+          
+            template.haml_tag options[:tag], options[:content_html], &block
+            
+            if options[:footer_html].present?
+              template.haml_concat template.footer_widget(options[:footer_html])
+            end
+            @separator = nil
+          end
+        end
+      end
+      
+      def extract_options!(*args)
+        options = super(*args)
+        
+        options[:as] ||= :section
+        options[:tag] ||= config.terms_tag
+      
+        options[:content_html] ||= {}
+        merge_class! options[:content_html], config.content_class
+        
+        options
+      end
+    end
+  end
+end

data/lib/storefront/components/definition_list_item.rb

@@ -0,0 +1,63 @@
+module Storefront
+  module Components
+    class DefinitionListItem < Storefront::Components::Base
+      def render(&block)
+        template.capture_haml do
+          template.haml_tag :dt, options[:key], options[:key_html] unless options[:key].nil?
+          
+          if block_given? # i.e. multiple definitions for a term
+            template.haml_tag :dd, options[:value_html], &block
+          else
+            template.haml_tag :dd, options[:value], options[:value_html] unless options[:value].nil?
+          end
+        end
+      end
+      
+      def extract_options!(*args)
+        options        = args.extract_options!
+        key            = args.shift || options[:key]
+        value          = args.shift || options[:value]
+        
+        unless key.nil?
+          locale_options = options.delete(:locale_options) || {}
+          label          = t?(key, locale_options.reverse_merge(:scope => :"terms.labels"))
+          
+          if options[:auto_id] == true && !value.nil?
+            id_base        = label.underscore.strip.gsub(/[\s|_]+/, config.separator).squeeze(config.separator)
+          end
+      
+          key_html       = options.delete(:key_html) || {}
+          merge_class! key_html, config.term_key_class
+          
+          if id_base
+            key_html[:id] ||= "#{id_base}-key"
+          end
+          
+          separator      = options[:separator] || @separator
+
+          label.gsub!(/#{separator}?$/, separator) if separator.present?
+        end
+        
+        value_html     = options.delete(:value_html) || {}
+        merge_class! value_html, config.term_value_class
+        
+        if id_base
+          value_html[:id] ||= "#{id_base}-value"
+        end
+        
+        if config.include_aria
+          value_html[:role] ||= :definition
+          value_html[:"aria-labelledby"] = key_html[:id] if key_html && key_html[:id]
+          #value_html[:"aria-describedby"] = hint_html[:id]
+        end
+        
+        options.merge(
+          :key        => label,
+          :key_html   => key_html,
+          :value      => value,
+          :value_html => value_html
+        )
+      end
+    end
+  end
+end

data/lib/storefront/components/flash.rb

@@ -0,0 +1,12 @@
+module Storefront
+  module Components
+    class Flash < Base
+      def render
+        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
+    end
+  end
+end

data/lib/storefront/components/footer.rb

@@ -0,0 +1,19 @@
+module Storefront
+  module Components
+    class Footer < Base
+      def render(&block)
+        template.capture_haml do
+          if block_given?
+            template.haml_tag :footer, options[:outer_html], &block
+          else
+            template.haml_tag :footer, options[:outer_html]
+          end
+        end
+      end
+      
+      def extract_options!(*args)
+        super(*args).reverse_merge(:title => false)
+      end
+    end
+  end
+end

data/lib/storefront/components/form.rb

@@ -0,0 +1,82 @@
+require 'storefront/components/form/base'
+
+module Storefront
+  module Components
+    class Form < Base
+      attr_reader :model, :template, :tabindex, :access_keys, :attributes
+      delegate :object, :parent, :to => :model
+      
+      def initialize(template, *args)
+        options     = args.extract_options!
+        @template   = template
+        @model      = Storefront::Model.new(:object => extract_object!(args.shift))
+        @attributes = extract_attributes!(options)
+        @builder    = Storefront::Form::Builder.new(
+          :template    => template, 
+          :tabindex    => 1, 
+          :access_keys => {},
+          :model       => model
+        )
+      end
+      
+      def render(&block)
+        template.capture_haml do
+          template.haml_tag :form, attributes do
+            @builder.render(&block) if block_given?
+          
+            unless attributes[:"data-method"] == attributes[:method]
+              template.haml_tag :input, :type => :hidden, :name => :_method, :value => attributes[:"data-method"]
+            end
+          end
+        end
+      end
+  
+      protected
+      def extract_object!(object)
+        if (object.is_a?(::Symbol) || object.is_a?(::String))
+          begin
+            "::#{object.to_s.camelize}".constantize.new
+          rescue Exception => e
+            result = ::OpenStruct.new
+            result.klass = object.to_s.camelize
+            result
+          end
+        else
+          object
+        end
+      end
+  
+      def config
+        Storefront.configuration
+      end
+    
+      def extract_attributes!(options = {})
+        attributes                 = options[:html] || {}
+        attributes[:action]        = options[:url]
+        attributes[:class]         = options[:class] if options.has_key?(:class)
+        merge_class! attributes, config.form_class
+        attributes[:id]            = options[:id] if options.has_key?(:id)
+        #attributes[:id]            ||= 
+        attributes[:enctype]       = "multipart/form-data" if (options[:multipart] || attributes.delete(:multipart)).to_s == "true"
+        attributes[:role]          = :form
+        attributes[:novalidate]    = "true" # needs to be true b/c the error popups are horribly ugly!# if options[:validate] == false
+        attributes[:"data-validate"] = options[:validate].to_s if options.has_key?(:validate)
+      
+        method                     = attributes[:method] || options[:method]
+      
+        if method.blank?
+          if @model.new_record?
+            method                 = :put
+          else
+            method                 = :post
+          end
+        end
+      
+        attributes[:"data-method"] = method
+        attributes[:method]        = method == :get ? :get : :post
+    
+        attributes
+      end
+    end
+  end
+end