viewaide 0.3.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.DS_Store
+*.swp
+pkg
+doc
+coverage/*
+coverage.data

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Clayton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,31 @@
+MIT-LICENSE
+Manifest
+README.textile
+Rakefile
+lib/viewaide.rb
+lib/viewaide/helpers.rb
+lib/viewaide/helpers/date_helper.rb
+lib/viewaide/helpers/form_helper.rb
+lib/viewaide/helpers/grid_helper.rb
+lib/viewaide/helpers/jquery_helper.rb
+lib/viewaide/helpers/link_helper.rb
+lib/viewaide/helpers/message_helper.rb
+lib/viewaide/helpers/navigation_helper.rb
+lib/viewaide/helpers/rjs_helper.rb
+lib/viewaide/helpers/structure_helper.rb
+lib/viewaide/helpers/table_helper.rb
+lib/viewaide/rails_partial_caching.rb
+rails/init.rb
+tasks/viewaide_tasks.rake
+test/date_helper_test.rb
+test/form_helper_test.rb
+test/grid_helper_test.rb
+test/jquery_helper_test.rb
+test/link_helper_test.rb
+test/message_helper_test.rb
+test/navigation_helper_test.rb
+test/rjs_helper_test.rb
+test/structure_helper_test.rb
+test/table_helper_test.rb
+test/test_helper.rb
+viewaide.gemspec

data/README.textile

@@ -0,0 +1,3 @@
+h1. Viewaide
+
+Copyright (c) 2009 Josh Clayton, released under the MIT license

data/Rakefile

@@ -0,0 +1,20 @@
+require "rake"
+require "rake/testtask"
+require "rcov/rcovtask"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "viewaide"
+    gemspec.description = "Making your views easier"
+    gemspec.summary = "Making your views easier"
+    gemspec.email = "joshua.clayton@gmail.com"
+    gemspec.homepage = "http://github.com/joshuaclayton/viewaide"
+    gemspec.authors = ["Joshua Clayton"]
+    gemspec.add_dependency("actionview", ">= 2.1.0")
+    gemspec.add_dependency("activesupport", ">= 2.1.0")
+    gemspec.add_dependency("hpricot", ">= 0.8.1")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/viewaide/helpers/date_helper.rb

@@ -0,0 +1,15 @@
+module Viewaide
+  module Helpers
+    module DateHelper
+
+      def datetime(dt = nil, default_text = "", format_string = :long)
+        dt ? dt.to_time.to_s(format_string) : default_text
+      end
+
+      def date(dt = nil, default_text = "", format_string = :long)
+        dt ? dt.to_date.to_s(format_string) : default_text
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/form_helper.rb

@@ -0,0 +1,68 @@
+module Viewaide
+  module Helpers
+    module FormHelper
+
+      def submit_button(value, *args)
+        options = args.extract_options!
+        css_classes = ["btn"] << options.delete(:class) << args
+        css_classes = clean_css_classes(css_classes, {"last" => last_column})
+
+        content_tag :button,
+                    "<span>#{value}</span>",
+                    { :value => value,
+                      :type => "submit",
+                      :class => css_classes
+                    }.merge(options)
+      end
+
+      def set(*args, &block)
+        options = args.extract_options!
+        css_classes = [] << options.delete(:class) << args
+
+        if !other_than_grid?(args.map(&:to_s) - ["error", "last", last_column.to_s])
+          css_classes << "text"
+        end
+
+        if standardize_css_classes(css_classes).include?("textarea")
+          css_classes << "text"
+        end
+
+        css_classes = clean_css_classes(css_classes, {"last" => last_column})
+
+        html = clean_column(css_classes) do
+          content_tag :div,
+                      capture(&block),
+                      options.merge(:class => css_classes)
+        end
+
+        concat(html)
+      end
+
+      def fieldset(*args, &block)
+        options = args.extract_options!
+        css_classes = [] << options.delete(:class) << args
+        title = args.shift if args.first.is_a?(String)
+        legend = if title.blank?
+          ""
+        else
+          legend_opts = options.delete(:legend) || {}
+          legend_classes = clean_css_classes([legend_opts.delete(:class)] << "legend")
+          content_tag :h3,
+                      title,
+                      {:class => legend_classes}.merge(legend_opts)
+        end
+
+        css_classes = clean_css_classes(css_classes, {"last" => last_column})
+
+        html = clean_column(css_classes) do
+          content_tag :fieldset,
+                      legend + capture(&block),
+                      options.merge(:class => css_classes)
+        end
+
+        concat(html)
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/grid_helper.rb

@@ -0,0 +1,178 @@
+module Viewaide
+  module Helpers
+    module GridHelper
+      MULTIPLES = {
+        :one_twentyfourth =>          (1/24.to_f),
+        :one_twelfth =>               (1/12.to_f),
+        :one_eigth =>                 (1/8.to_f),
+        :one_sixth =>                 (1/6.to_f),
+        :five_twentyfourths =>        (5/24.to_f),
+        :one_fourth =>                (1/4.to_f),
+        :seven_twentyfourths =>       (7/24.to_f),
+        :one_third =>                 (1/3.to_f),
+        :three_eigths =>              (3/8.to_f),
+        :five_twelfths =>             (5/12.to_f),
+        :eleven_twentyfourths =>      (11/24.to_f),
+        :one_half =>                  (1/2.to_f),
+        :half =>                      (1/2.to_f),
+        :thirteen_twentyfourths =>    (13/24.to_f),
+        :seven_twelfths =>            (7/12.to_f),
+        :five_eigths =>               (5/8.to_f),
+        :two_thirds =>                (2/3.to_f),
+        :seventeen_twentyfourths =>   (17/24.to_f),
+        :three_fourths =>             (3/4.to_f),
+        :nineteen_twentyfourths =>    (19/24.to_f),
+        :five_sixths =>               (5/6.to_f),
+        :seven_eigths =>              (7/8.to_f),
+        :eleven_twelfths =>           (11/12.to_f),
+        :twentythree_twentyfourths => (23/24.to_f),
+        :full =>                      (1.to_f)
+      }.freeze
+      MULTIPLE_FRACTIONS = MULTIPLES.keys.map {|key| key.to_s }.freeze
+
+      def self.easel_grid!
+        @@last_column = "col-last"
+        @@column_prefix = "col"
+      end
+
+      def self.blueprint_grid!
+        @@last_column = "last"
+        @@column_prefix = "span"
+      end
+
+      easel_grid!
+
+      def last_column
+        @@last_column
+      end
+
+      def column(*args, &block)
+        @_viewaide_column_count ||= application_width
+        col(*args, &block)
+      end
+
+      def container(size=nil, *args, &block)
+        opts = args.extract_options!
+        opts.merge!(:suppress_col => true) if size.nil?
+        args = args.insert(0, :container)
+        column(size, *([args, opts].flatten), &block)
+      end
+
+      def clean_column(classes, &block)
+        size = classes.scan(/#{column_prefix}-(\d+)/).flatten.last
+
+        if size.nil?
+          html = capture(&block)
+          if block_given? && block_is_within_action_view?(block)
+            concat(html)
+          else
+            html
+          end
+        else
+          size = size.to_i
+          increase_depth(size)
+          html = capture(&block)
+
+          if block_given? && block_is_within_action_view?(block)
+            concat(html)
+            decrease_depth(size)
+          else
+            decrease_depth(size)
+            html
+          end
+        end
+      end
+
+      def method_missing_with_viewaide_widths(call, *args)
+        # filter out any initial helper calls
+        found = false
+        MULTIPLE_FRACTIONS.each do |fraction|
+          found = true and break if call.to_s.include?(fraction)
+        end
+
+        method_missing_without_viewaide_widths(call, *args) and return unless found
+
+        # one of the widths is somewhere in the helper call; let's find it
+        call.to_s =~ /^((append|prepend|#{column_prefix})_)?(.+)$/
+        class_name = $2 || column_prefix
+        class_width = $3
+
+        if MULTIPLES.keys.include?(class_width.to_sym)
+          width = @_viewaide_column_count || application_width
+          "#{class_name}-#{(width*MULTIPLES[class_width.to_sym]).to_i}"
+        else
+          method_missing_without_viewaide_widths(call, *args)
+        end
+      end
+
+      alias_method_chain :method_missing, :viewaide_widths
+
+      private
+
+      def application_width; 24; end
+
+      def increase_depth(size)
+        @_viewaide_current_width ||= [application_width.to_s]
+
+        if @_viewaide_column_count.present?
+          @_viewaide_current_width.push(@_viewaide_column_count.to_s)
+        end
+
+        @_viewaide_column_count = if size.to_s =~ /^\d+$/
+          size.to_s.to_i
+        else
+          (@_viewaide_column_count*MULTIPLES[size]).to_i
+        end
+      end
+
+      def decrease_depth(size)
+        @_viewaide_column_count = if size.is_a?(Integer)
+          @_viewaide_current_width.last.to_i
+        else
+          (@_viewaide_column_count/MULTIPLES[size]).to_i
+        end
+
+        @_viewaide_current_width.pop
+      end
+
+      def col(*args, &block)
+        fractional_width = MULTIPLE_FRACTIONS.include?(args.first.to_s)
+        explicit_column_width = args.first.is_a?(Integer)
+        size = (fractional_width || explicit_column_width) ? args.shift : :full
+
+        increase_depth(size)
+        output_tag = generate_output_tag(size, *args, &block)
+
+        if block_given? && block_is_within_action_view?(block)
+          concat(output_tag)
+          decrease_depth(size)
+        else
+          decrease_depth(size)
+          output_tag
+        end
+      end
+
+      def generate_output_tag(size, *args, &block)
+        options = args.extract_options!
+
+        css_classes = [] << options.delete(:class) << args
+        unless options.delete(:suppress_col)
+          css_classes << "#{column_prefix}-#{@_viewaide_column_count}"
+        end
+
+        if (size.to_sym rescue nil) == :full && @_viewaide_column_count != application_width
+          css_classes << last_column
+        end
+
+        css_classes = clean_css_classes(css_classes, {"last" => last_column})
+        content_tag(options.delete(:tag) || :div,
+                    capture(&block),
+                    {:class => css_classes}.merge(options))
+      end
+
+      def column_prefix
+        @@column_prefix
+      end
+    end
+  end
+end

data/lib/viewaide/helpers/jquery_helper.rb

@@ -0,0 +1,21 @@
+module Viewaide
+  module Helpers
+    module JqueryHelper
+
+      def document_ready(&block)
+        html = content_tag :script, :type => "text/javascript" do
+          %(
+            (function($) {
+              $(document).ready(function() {
+                #{capture(&block)}
+              });
+            })(jQuery);
+          )
+        end
+
+        concat(html)
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/link_helper.rb

@@ -0,0 +1,21 @@
+module Viewaide
+  module Helpers
+    module LinkHelper
+
+      def link_button(*args, &block)
+        doc = Hpricot(link_to(*args, &block))
+        doc.at("a").inner_html = "<span>#{doc.at("a").inner_html}</span>"
+        (doc/:a).add_class("btn")
+        doc.to_html
+      end
+
+      def link_to_email(email_address, *args)
+        options = args.extract_options!
+        link = args.first.is_a?(String) ? h(args.first) : email_address
+        return link if email_address.blank?
+        link_to link, "mailto:#{email_address}", options
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/message_helper.rb

@@ -0,0 +1,32 @@
+module Viewaide
+  module Helpers
+    module MessageHelper
+
+      def messages(messages, options = {})
+        except_keys = [options[:except]].flatten.compact
+        only_keys   = [options[:only]].flatten.compact
+
+        if except_keys.any? && only_keys.any?
+          raise ArgumentError, ":only and :except options conflict; use one"
+        end
+
+        keys = if except_keys.any?
+          messages.keys - except_keys
+        elsif only_keys.any?
+          messages.keys & only_keys
+        else
+          messages.keys
+        end
+
+        keys.map do |key|
+          if messages[key].present?
+            content_tag :p,
+                        messages[key],
+                        :class => [key, "box", "single-line"].join(" ")
+          end
+        end.join
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/navigation_helper.rb

@@ -0,0 +1,29 @@
+module Viewaide
+  module Helpers
+    module NavigationHelper
+      def tab(name, path, options = {}, li_options = {})
+        opts = parse_tab_options(name, li_options)
+
+        active = "active" if (opts[:active] == opts[:comparison]) || opts[:compare]
+        css_classes = [] << opts[:li_classes] << active
+        css_classes = clean_css_classes(css_classes)
+        li_options.merge!(:class => css_classes) if css_classes.present?
+
+        content_tag :li,
+                    link_to(name, path, options),
+                    li_options
+      end
+
+      private
+
+      def parse_tab_options(name, li_options = {})
+        returning({}) do |result|
+          result[:active]     = li_options.delete(:active)         || (name.gsub(/\s/, '').tableize || "")
+          result[:comparison] = li_options.delete(:active_compare) || controller.controller_name
+          result[:compare]    = li_options.delete(:compare)        || false
+          result[:li_classes] = li_options.delete(:class)
+        end
+      end
+    end
+  end
+end

data/lib/viewaide/helpers/rjs_helper.rb

@@ -0,0 +1,20 @@
+module Viewaide
+  module Helpers
+    module RjsHelper
+
+      def inline_flash(page, flash, options = {})
+        container_id = options[:container] || "flash-container"
+        current_flash = flash
+
+        flash.discard unless options[:keep_flash]
+
+        if options[:replace]
+          page.replace_html container_id, messages(current_flash)
+        else
+          page.insert_html :top, container_id, messages(current_flash)
+        end
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/structure_helper.rb

@@ -0,0 +1,43 @@
+module Viewaide
+  module Helpers
+    module StructureHelper
+
+      def blockquote(*args, &block)
+        options = args.extract_options!
+        author = options.delete(:author)
+        option_quote = textilize(options.delete(:quote))
+
+        bq =  content_tag :blockquote,
+                          option_quote.blank? ? capture(&block) : option_quote
+
+        html = if author
+          content_tag :div,
+                      bq + content_tag(:cite, author),
+                      :class => "quote-cited"
+        else
+          bq
+        end
+
+        concat(html)
+      end
+
+      def body(*args)
+        options = args.extract_options!
+        @_page_body_attributes ||= {}
+
+        css_classes = [] << @_page_body_attributes.delete(:class) << args
+
+        @_page_body_attributes = @_page_body_attributes.merge(options)
+        @_page_body_attributes[:class] = clean_css_classes(css_classes)
+
+        if block_given?
+          block = lambda { yield }
+
+          html = content_tag(:body, capture(&block), @_page_body_attributes)
+          concat(html)
+        end
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers/table_helper.rb

@@ -0,0 +1,61 @@
+module Viewaide
+  module Helpers
+    module TableHelper
+
+      def zebra_row(options = {}, &block)
+        cycle_list = options.delete(:cycle_list) || [nil, "alt"]
+        css_classes = [cycle(*cycle_list)] << options.delete(:class)
+        css_classes = clean_css_classes(css_classes)
+
+        html = content_tag :tr,
+                           capture(&block),
+                           options.merge(:class => css_classes)
+        concat(html)
+      end
+
+      def recordset(*args, &block)
+        options = args.extract_options!
+        options[:table] ||= {}
+
+        headers = []
+        (options[:headers] || []).each_with_index do |header, index|
+          head = [header].flatten
+          opts = head.extract_options!
+
+          css_classes = [] << opts.delete(:class) << case index
+            when 0 then "first"
+            when (options[:headers].size - 1) then "last"
+          end
+
+          headers << if head.first =~ /^\<th/
+            th = Hpricot(head.first)
+            th_classes = th.at("th")["class"].join
+            th_classes = clean_css_classes([th_classes, css_classes])
+            th.at("th")["class"] = th_classes
+            th.to_html
+          else
+            content_tag :th,
+                        head.first,
+                        opts.merge(:class => clean_css_classes(css_classes))
+          end
+        end
+
+        table_classes = ["recordset", args] << options[:table].delete(:class)
+        css_classes = clean_css_classes(table_classes, {"last" => last_column})
+
+        html =  clean_column(css_classes) do
+          table_options = options[:table]
+          table_options.merge!(:class => css_classes, :cellspacing => 0)
+          content_tag(:table,
+                      content_tag(:thead, content_tag(:tr, headers.join)) + \
+                        capture(&block),
+                      table_options)
+        end
+
+        reset_cycle
+        concat(html)
+      end
+
+    end
+  end
+end

data/lib/viewaide/helpers.rb

@@ -0,0 +1,81 @@
+require "viewaide/helpers/date_helper"
+require "viewaide/helpers/form_helper"
+require "viewaide/helpers/link_helper"
+require "viewaide/helpers/structure_helper"
+require "viewaide/helpers/table_helper"
+require "viewaide/helpers/grid_helper"
+require "viewaide/helpers/message_helper"
+require "viewaide/helpers/rjs_helper"
+require "viewaide/helpers/jquery_helper"
+require "viewaide/helpers/navigation_helper"
+
+module Viewaide
+  module Helpers
+    include DateHelper
+    include FormHelper
+    include LinkHelper
+    include StructureHelper
+    include TableHelper
+    include GridHelper
+    include MessageHelper
+    include RjsHelper
+    include JqueryHelper
+    include NavigationHelper
+
+    protected
+
+    def other_than_grid?(classes)
+      (standardize_css_classes(classes).map {|s| s.to_s } -
+       Viewaide::Helpers::GridHelper::MULTIPLE_FRACTIONS).any?
+    end
+
+    def clean_css_classes(string_or_array, replace = {})
+      css_classes = [] + standardize_css_classes(string_or_array)
+
+      if replace.any?
+        replace.keys.each do |k|
+          if css_classes.include? k
+            css_classes.delete(k)
+            css_classes << replace[k]
+          end
+        end
+      end
+
+      fractions = css_classes & Viewaide::Helpers::GridHelper::MULTIPLE_FRACTIONS
+      if css_classes.any? && fractions.any?
+        fractions.each do |fraction|
+          css_classes.delete(fraction)
+          css_classes << self.send(fraction)
+          if fraction == "full" && @_viewaide_column_count != application_width
+            css_classes << last_column
+          end
+        end
+      end
+
+      css_classes.map {|s| s.strip }.reject {|s| s.blank? }.uniq.join(" ").strip
+    end
+
+    private
+
+    def standardize_css_classes(string_or_array)
+      [string_or_array].flatten.join(" ").split(/ /)
+    end
+
+    BLOCK_CALLED_FROM_ERB = 'defined? __in_erb_template'
+
+    if RUBY_VERSION < '1.9.0'
+      # Check whether we're called from an erb template.
+      # We'd return a string in any other case, but erb <%= ... %>
+      # can't take an <% end %> later on, so we have to use <% ... %>
+      # and implicitly concat.
+      def block_is_within_action_view?(block)
+        block && eval(BLOCK_CALLED_FROM_ERB, block)
+      end
+    else
+      def block_is_within_action_view?(block)
+        block && eval(BLOCK_CALLED_FROM_ERB, block.binding)
+      end
+    end
+
+  end
+end