facades 0.0.2 → 0.0.3

data/README.md

@@ -35,6 +35,8 @@ Below is a list of available mixins
 	Interface
 	-----------------------
 	tool-tip
+	flash-message
+	flash-message-colors
 	
 	Forms
 	----------------------
@@ -61,10 +63,14 @@ Below is a list of available mixins
 	----------------------
 	leading (shortcut to Compass adjust-leading-to)
 	font-size (shortcut to Compass adjust-font-size-to)
+	inset-text (text-shadow text insetting)
 	
 	Utility
 	----------------------
 	position (shorthand position relative/fixed/absolute)
+	luminance ( return a colors lightness in terms of 'light' or 'dark' )
+	tint (tint a color with white)
+	shade (darken a color with black)
 	
 ##Helpers
 
@@ -104,3 +110,49 @@ To assign variables, pass their value to the method. To display, use the method
 
 	<%= button_link 'Link Text', some_path, icon: 'image.png' %>  #=> <a href='#' class='button'><img src='image.png' /></a>
 	
+###Pagination Helper
+
+Any model which responds to current_page and total_pages can utilize the pagination helper. 
+
+	<%= paginate(collection) %>
+	
+Will render a link based list with the current collection pagination. If `Facades.enable_html5` is set to `true` items will be wrapped in a HTMl5 `<nav>` tag, otherwise a div  will be used. The class 'pagination' is added to that top level element. 
+By default the included partial facades/pagination is rendered. To customize output simply override this in your application. See app/views/facades/_pagination.html.erb for more info.
+
+###Navigation Helper
+
+Facades provides a navigation helper for creating nested navigation lists. 
+
+	<%= nav do %>
+		<%= nav_link 'About Me', about_path %>
+		<%= nav_link 'Top Level', some_path do %>
+			<%= nav_link 'Sub Item', some_sub_path %>
+		<% end %>
+	<% end %>
+	
+Will output
+
+	<nav>
+		<ol>
+			<li><a href='/about-path'>About Me</a></li>
+			<li><a href='/some-path'>Top Level</a>
+				<ol>
+					<li><a href="/some-sub-path">Sub Item</a></li>
+				</ol>
+			</li>
+		</ol>
+	</nav>
+
+Note: The `<nav>` tag is only included if `Facades.enable_html5` is set to true.
+	
+As a convenience, the class `on` will be added to a link when the current url matches that link. This can be overridden by using the `matcher` or `proc` attributes when calling `nav_link`.
+When using a proc/lambda, returning true will set the `on` class.
+
+	# Current path /home
+	<%= nav_link 'Path', some_path, proc: lambda{ |current_path| true } %> #=> <a href='/anything' class='on'>Path</a>
+	
+When using `:matcher`, pass a string or regular expression in which the request.path should match to be `on`.
+	
+	# Current path /somewhere
+	<%= nav_link 'Path', '/something-else', matcher: /somewhere/ %> #=> <a href='/something-else' class='on'>Path</a>
+	

data/app/helpers/facades_helper.rb

@@ -1,29 +1,3 @@
 module FacadesHelper
-
   include Facades::Helpers
-  
-  def facade_assets
-    content = if_ie(8) do
-      javascript_include_tag("https://html5shim.googlecode.com/svn/trunk/html5.js")
-    end
-    content.to_s.html_safe
-  end
-  
-  ##
-  # Render an IE conditional statement. By default conditionals use a less-than-or-equal-to format. Use the `specific`
-  # param to force only that version.
-  # 
-  # @param version [Integer] The IE version to target
-  # @param specific [Boolean] optional Target the IE version specificially. 
-  # 
-  # 
-  def if_ie(version, specific = false, &block)
-    content = capture(&block)
-    condition = specific ? "IE #{version}" : "lte IE #{version}"
-    str = "<!--[if #{condition}]>"
-  	str << content.html_safe.lstrip
-  	str << "<![endif]-->"
-  	str.html_safe
-  end
-    
 end

data/app/views/facades/_pagination.html.erb

@@ -0,0 +1,20 @@
+<p class='pagination-detail'>Viewing Page <%= paginator.current_page %> of <%= paginator.total_pages %></p>
+<ol class='pagination-links'>
+	<li class='first'>
+		<%= paginator.first? ? "&larr;".html_safe : paginator.link(1, {}, "&larr;") %>
+	</li>
+	<li class='prev'>
+		<%= paginator.first? ? "&laquo; Previous".html_safe : paginator.link(paginator.previous, {}, "&laquo; Previous".html_safe) %>
+	</li>
+	<% paginator.links.each do |link| %>
+	<li<%= link.current? ? " class='current'" : "" %>>
+		<%= link.current? ? link.number : paginator.link(link.number) %>
+	</li>
+	<% end %>
+	<li class='next'>
+		<%= paginator.last? ? "Next &raquo;".html_safe : paginator.link(paginator.next, {}, "Next &raquo;".html_safe) %>
+	</li>
+	<li class='last'>
+		<%= paginator.last? ? "&rarr;".html_safe : paginator.link(paginator.total_pages, {}, "&rarr;") %>
+	</li>
+</ol>

data/facades.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Brent Kirby"]
   s.email       = ["brent@kurbmedia.com"]
   s.homepage    = "https://github.com/kurbmedia/facades"
-  s.summary     = %q{Mixins, utilities, and helpers for front-end design/development with Compass / Rails}
-  s.description = %q{Facades includes various helpers, methods, and compass/sass mixins for simplifying frontend development.}
+  s.summary     = %q{Front-end development awesome-ness}
+  s.description = %q{Facades is a front-end development framework which takes }
 
   s.rubyforge_project = "facades"
 
@@ -19,6 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency('sass', ['~> 3.1'])
-  s.add_dependency('compass', ['>= 0.11'])
   
 end

data/lib/facades/builders/sprite.rb

@@ -0,0 +1,50 @@
+require 'tilt'
+
+module Facades
+  module Builders
+    class Sprite < Tilt::Template
+
+      def prepare
+      end
+      
+      def evaluate(scope, locals, &block)
+        sprites = sprite_context(scope)
+        sprites.instance_eval data
+        sprites = sprites.send(:fetch!).uniq
+        File.open(sprites.first).read
+      end
+      
+      def locate_sprite_folder(scope)
+        paths, name = scope.environment.paths, File.basename(scope.logical_path)
+        paths.detect{ |p| File.directory?(File.join(p, name)) }
+      end
+      
+      def sprite_context(scope)
+        cxt = SpriteContext.new
+        cxt.root      = locate_sprite_folder(scope)
+        cxt.base_path = File.basename(scope.logical_path)
+        cxt
+      end
+    
+      class SpriteContext        
+        attr_accessor :base_path, :sprite_images, :root
+        def images(*args)
+          @sprite_images = args
+        end
+        private
+        def fetch!
+          @sprite_images ||= Dir.glob(File.join(root, base_path, '*.png'))
+        end        
+      end
+    
+    end
+    
+  end
+end
+
+begin
+  require 'sprockets'
+  Sprockets::Engines
+  Sprockets.register_engine '.sprite', Facades::Builders::Sprite
+rescue LoadError
+end

data/lib/facades/builders/table.rb

@@ -0,0 +1,76 @@
+module Facades
+  module Builders
+    class TableBuilder
+      attr_reader :template, :options, :resources, :buffer
+      
+      def initialize(resources, tpl, options)
+        @buffer = ""
+        @template, @options, @resources = tpl, options, resources
+      end
+      
+      delegate :content_tag, :to => :template
+      
+      ##
+      # Get a list of all headings for the table
+      # Use the resource class's table_headings method first, options hash next
+      # 
+      def headings
+        return resource_class.table_attributes if resource_class.respond_to?(:table_headings)
+        [options[:headings]].flatten.compact
+      end
+      
+      ##
+      # The class for this resource
+      def resource_class
+        resources.first.class
+      end
+      
+      ##
+      # Renders the table content immediately using the provided options
+      def inline!
+        [head, body].map(&:to_s).join("\n")
+      end
+      
+      def head
+        return content_tag(:thead, render_heading) unless block_given?        
+        content_tag(:thead) do
+          yield self
+        end
+      end
+      
+      def body
+        return content_tag(:tbody, render_body) unless block_given?        
+        content_tag(:tbody) do
+          yield self
+        end
+      end
+      
+      private
+      
+      # Render an entire body inline
+      def render_body
+        rows = []
+        resources.each_with_index do |res, index|
+          attrs = { :class => (ind.even? ? 'even' : 'odd') }
+          buff = content_tag(:tr, attrs) do
+            headings.collect do |hd|
+              content_tag(:td, res.send(:"#{hd}"))
+            end.to_s.join("\n")
+          end
+          rows << buff
+        end
+        rows.map(&:to_s).join("\n")
+      end
+      
+      # Render entire body inline
+      def render_heading
+        buffer << template.content_tag(:thead) do
+          headings.collect do |hd|
+            content_tag(:th, hd)
+          end.to_s.join("\n")
+        end
+      end
+      
+    end
+  end
+end

data/lib/facades/helpers/builders.rb

@@ -0,0 +1,24 @@
+require 'facades/builders/table'
+
+module Facades
+  module Helpers
+    module Builders
+
+      def table_for(resource_or_class, *args, &block)
+        options    = args.extract_options!
+        html_attrs = options.delete(:html)
+        builder    = options.delete(:builder) || TableBuilder
+        builder    = builder.new(resource_or_class, self, options)
+        
+        unless block_given?
+          content_tag(:table, builder.inline!, html_attrs)
+        else
+          content_tag(:table, html_attrs) do
+            yield builder
+          end
+        end        
+      end
+      
+    end
+  end
+end

data/lib/facades/helpers/elements.rb

@@ -59,11 +59,11 @@ module Facades
           closer ||= "<span>X</span>"
         end
         klasses = (attrs.delete(:class) || "").split(" ")
-        klasses << "flash_message"  
+        klasses << "flash-message"  
         content = ""    
         
         flash.each do |key, value|
-          klasses << "flash_message_#{key.to_s.underscore}"
+          klasses << "flash-message-#{key.to_s.underscore}"
           msg_attrs = attrs.merge(:class => [key.to_s, klasses].flatten.join(' '))
           content.concat content_tag(wrapper, "#{value} #{closer}".html_safe, msg_attrs).html_safe
         end    

data/lib/facades/helpers/layout.rb

@@ -20,6 +20,20 @@ module Facades
         content
       end
       
+      ##
+      # Create a script tag for activating google analytics
+      # @param [String] site_id The site ID provided by google analytics
+      # @return [String] script tag
+      # 
+      def google_analytics(site_id)
+        content_tag(:script) do
+          ["var _gaq=[['_setAccount','#{site_id}'],['_trackPageview'],['_trackPageLoadTime']];",
+           "(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.async=1;",
+           "g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';",
+           "s.parentNode.insertBefore(g,s)}(document,'script'));"].join("")
+        end
+      end
+      
       ##
       # 
       # Creates a page id to be used for identifying a page for CSS/design purposes. If a variable
@@ -38,11 +52,16 @@ module Facades
       # 
       # 
       def page_id(content = nil)
-        _create_variable(:__page_id, content, false) and return unless content.nil?
+        _create_variable(:__page_id, content, false) and return if content
         return _retrieve_variable(:__page_id) if content_for?(:__page_id)
-        cname = controller.class.to_s.gsub(/controller$/i,'').underscore.split("/").join('_')
-        aname = controller.action_name
-        "#{cname}_#{aname}"
+        result = if defined?(controller)
+          cname = controller.class.to_s.gsub(/controller$/i,'').underscore.split("/").join('_')
+          aname = controller.action_name          
+          "#{cname}_#{aname}"
+        elsif defined?(request) && request.respond_to?(:path_info)
+          ::File.basename(request.path_info).to_s
+        end
+        result
       end
       
       ##
@@ -58,7 +77,7 @@ module Facades
       #   <title><%= page_title %></title> #=> <title>This is my page title</title>
       # 
       def page_title(content = nil)
-        _create_variable(:__page_title, content, false) and return unless content.nil?
+        _create_variable(:__page_title, content, false) and return if content
         return _retrieve_variable(:__page_title) if content_for?(:__page_title)
         return ""
       end
@@ -96,9 +115,7 @@ module Facades
       private
       
       def _create_variable(var, content, create_method = true) #:nodoc:
-        content_for(var.to_sym) do
-          content
-        end
+        content_for(var.to_sym, content)
         return '' unless create_method
         class_eval <<-MAKE_VAR, __FILE__, __LINE__ + 1
           def #{var}

data/lib/facades/helpers/mobile.rb

@@ -0,0 +1,16 @@
+module Facades
+  module Helpers
+    ##
+    # Helper methods for mobile tags and attributes
+    module Mobile
+      
+      def mobile_meta_tags
+        [ tag(:meta, {"http-equiv" => 'cleartype', 'content' => 'on' }), # IE Cleartype
+          meta_tag('HandheldFriendly', 'True'),
+          meta_tag('viewport', "width=device-width, minimum-scale=1.0, initial-scale=1.0")
+        ].join("\n")        
+      end
+      
+    end
+  end
+end

data/lib/facades/helpers/navigation.rb

@@ -33,8 +33,9 @@ module Facades
         link_attrs    = update_link_attrs(path, attrs)
         wrapper_attrs = link_attrs.delete(:wrapper)      
         child_link    = link_to(text, path, link_attrs)
-        wrapper === false ? child_link : content_tag(wrapper, child_link, wrapper_attrs)
-        
+        built = (wrapper === false ? child_link : content_tag(wrapper, child_link, wrapper_attrs))
+        built = built.html_safe if built.respond_to?(:html_safe)
+        built
       end
       alias :nav_link_to :nav_link
       
@@ -43,9 +44,7 @@ module Facades
         link_attrs    = update_link_attrs(path, attrs.merge(:wrapper => (attrs.delete(:item) || {}) ))
         parent_link   = nav_link_to(text, path, attrs, false)
         child_links   = content_tag(container, capture(&block), wrapper_attrs)
-        content_tag(container) do
-          content_tag(wrapper, (parent_link << child_links), wrapper_attrs)
-        end
+        content_tag(wrapper, (parent_link << child_links), wrapper_attrs)
       end     
       private :sub_nav_link
       
@@ -75,17 +74,21 @@ module Facades
       #     </li>
       #   </ol>
       # 
-      def nav(container = :ol, html_attrs = {}, &block)
+      def nav(container = :ol, html_attrs = {}, heading = nil, &block)
         
         wrapper_attrs = html_attrs.delete(:wrapper) || {}
         
-        if Facades.enable_html5
+        built = if Facades.enable_html5
+          inner = content_tag(container, capture(&block), wrapper_attrs)
+          inner = (content_tag(:h3, heading) << inner) unless heading.nil?
           content_tag(:nav, html_attrs) do
-            content_tag(container, capture(&block), wrapper_attrs)
+            inner
           end          
         else
           content_tag(container, capture(&block), html_attrs)
         end
+        built = built.html_safe if built.respond_to?(:html_safe)
+        built
         
       end
       
@@ -110,10 +113,10 @@ module Facades
           when Proc then proc.call(path)
           when Regexp then request.path.match(regex)
           when String then (request.path == path || request.path.match(/#{path}\/\w/im))
-          else raise Motr::Errors::InvalidOptions.new('Proc, Regexp or String required... passed #{matcher.class}.')
+          else raise 'Proc, Regexp or String required... passed #{matcher.class}.'
         end
         
-        if active
+        if active === true
           klasses  << on_class
           wklasses << on_class
         end

data/lib/facades/helpers/pagination.rb

@@ -0,0 +1,83 @@
+module Facades
+  module Helpers
+
+    module Pagination
+      
+      class PageLink
+        attr_reader :number
+        attr_reader :current
+        
+        def initialize(num, curr)
+          @number   = num
+          @current = curr
+        end
+        
+        def current?
+          current === true
+        end
+    
+      end
+      
+      class Paginator
+        
+        attr_reader :current_page
+        attr_reader :total_pages
+        attr_reader :attributes
+        attr_reader :links        
+        
+        def initialize(collection, view, request)
+          @total_pages  = collection.total_pages
+          @current_page = collection.current_page
+          @links        = []
+          @template     = view
+          @request      = request
+        end
+        
+        def paginate!(window)
+          window.each do |page|            
+            @links << PageLink.new(page, (page == current_page))
+          end
+        end
+        
+        def first?
+          current_page == 1
+        end
+        
+        def last?
+          (current_page == total_pages)
+        end
+        
+        def next
+          links.detect{ |l| l.number == current_page + 1 }
+        end
+        
+        def previous
+          links.detect{ |l| l.number == current_page - 1 }          
+        end
+        
+        def link(page_number, attrs = {}, text = nil)
+          text ||= page_number
+          options = CGI.parse(@request.query_string).merge('page' => page_number)
+          @template.link_to(text.to_s.html_safe, "?#{options.to_query}", attrs)
+        end
+        
+      end
+      
+      def paginate(collection, html_attrs = {}, file = "facades/pagination")
+        
+        return "" if collection.total_count <= 0
+        paginator    = Paginator.new(collection, self, request)        
+        window_min   = [(paginator.current_page - 5), 1].max
+        window_max   = [(paginator.current_page + 5), paginator.total_pages].min
+        wrapper      = Facades.enable_html5 ? :nav : :div
+        
+        paginator.paginate!((window_min..window_max).to_a)
+        contents = render(partial: file, locals: { paginator: paginator })
+        
+        content_tag(wrapper, contents.html_safe, class: 'pagination')
+      end
+
+    end   
+      
+  end
+end

data/lib/facades/helpers/utility.rb

@@ -0,0 +1,31 @@
+module Facades
+  module Helpers
+    module Utility
+      
+      def facade_assets
+        content = if_ie(8) do
+          javascript_include_tag("https://html5shim.googlecode.com/svn/trunk/html5.js")
+        end
+        content.to_s.html_safe
+      end
+      
+      ##
+       # Render an IE conditional statement. By default conditionals use a less-than-or-equal-to format. Use the `specific`
+       # param to force only that version.
+       # 
+       # @param version [Integer] The IE version to target
+       # @param specific [Boolean] optional Target the IE version specificially. 
+       # 
+       # 
+       def if_ie(version, specific = false, &block)
+         content = capture(&block)
+         condition = specific ? "IE #{version}" : "lte IE #{version}"
+         str = "<!--[if #{condition}]>"
+       	str << content.html_safe.lstrip
+       	str << "<![endif]-->"
+       	str.html_safe
+       end
+      
+    end
+  end  
+end

data/lib/facades/helpers.rb

@@ -1,15 +1,23 @@
+require 'facades/helpers/layout'
+require 'facades/helpers/navigation'
+require 'facades/helpers/elements'
+require 'facades/helpers/pagination'
+require 'facades/helpers/utility'
+require 'facades/helpers/builders'
+require 'facades/helpers/mobile'
+
 module Facades
   module Helpers
     extend ActiveSupport::Concern
     
-    autoload :Layout,     'facades/helpers/layout'
-    autoload :Navigation, 'facades/helpers/navigation'
-    autoload :Elements,   'facades/helpers/elements'
-    
     included do
       include Facades::Helpers::Layout
       include Facades::Helpers::Navigation
       include Facades::Helpers::Elements
-    end    
+      include Facades::Helpers::Utility
+      include Facades::Helpers::Builders
+      include Facades::Helpers::Mobile
+    end
+    
   end
 end

data/lib/facades/sass_ext/color.rb

@@ -0,0 +1,30 @@
+module Facades
+  module SassExt
+    module Color
+      
+      # Check the luminance of color. This differs from lightness as it returns the actual values as 'light' and 'dark'
+      def luminance(color)
+        assert_type color, :Color
+        result = ((color.red * 299) + (color.green * 587) + (color.blue * 114) / 1000)
+        Sass::Script::String.new( result >= 160 ? 'light' : 'dark')
+      end
+      
+      # Tint a color by mixing it with white
+      def tint(color, dilution = Sass::Script::Number.new(50))
+        assert_type color, :Color
+        white = Sass::Script::Color.new([255, 255, 255, 1])
+        assert_type dilution, :Number
+        mix(color, white, Sass::Script::Number.new(100 - dilution.value))
+      end
+
+      # Shade a color by mixing it with black
+      def shade(color, dilution = Sass::Script::Number.new(50))
+        assert_type color, :Color
+        black = Sass::Script::Color.new([0, 0, 0, 1])
+        assert_type dilution, :Number
+        mix(color, black, Sass::Script::Number.new(100 - dilution.value))
+      end
+      
+    end
+  end
+end

data/lib/facades/sass_ext/form_elements.rb

@@ -15,6 +15,10 @@ module Facades
         [:checkbox, :password, :radio, :select, :string, :textarea].collect{ |t| send(:"#{t}_input_types") }.flatten.compact
       end
       
+      def button_input_types
+        "input[type=submit], input[type=reset], button[type=submit]"
+      end
+      
       def checkbox_input_types
         "input[type=checkbox]"
       end
@@ -31,9 +35,11 @@ module Facades
       def select_input_types
         "select"
       end
-      
+
       def string_input_types
-        %w{email password text}.collect{ |t| "input[type=#{t}]" }        
+        %w{email password text number search tel time url datetime date datetime-local week month}.collect do |type| 
+          "input[type=#{type}]"
+        end
       end
       
       def textarea_input_types

data/lib/facades/sass_ext.rb

@@ -1,13 +1,12 @@
 require 'sass'
-
 module Facades
   module SassExt
-    autoload :FormElements, 'facades/sass_ext/form_elements'
   end
 end
 
-module Sass::Script::Functions
-  include Facades::SassExt::FormElements
+['form_elements', 'color'].each do |req|
+  require "facades/sass_ext/#{req}"
+  Sass::Script::Functions.send(:include, Facades::SassExt.const_get(req.camelize))
 end
 
 class Sass::Script::Functions::EvaluationContext

data/lib/facades/stylesheets/facades/_common.scss

@@ -0,0 +1,7 @@
+// Includes modules generally used in most applications.
+
+@import 'facades/utilities';
+@import 'facades/ui';
+@import 'facades/layout';
+@import 'facades/typography/lists';
+@import 'facades/typography/shadow';