easel_helpers 0.3.0

data/lib/easel_helpers/helpers/jquery_helper.rb

@@ -0,0 +1,21 @@
+module EaselHelpers
+  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/easel_helpers/helpers/link_helper.rb

@@ -0,0 +1,21 @@
+module EaselHelpers
+  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/easel_helpers/helpers/message_helper.rb

@@ -0,0 +1,32 @@
+module EaselHelpers
+  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/easel_helpers/helpers/navigation_helper.rb

@@ -0,0 +1,29 @@
+module EaselHelpers
+  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/easel_helpers/helpers/rjs_helper.rb

@@ -0,0 +1,20 @@
+module EaselHelpers
+  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/easel_helpers/helpers/structure_helper.rb

@@ -0,0 +1,43 @@
+module EaselHelpers
+  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/easel_helpers/helpers/table_helper.rb

@@ -0,0 +1,61 @@
+module EaselHelpers
+  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/easel_helpers/rails_partial_caching.rb

@@ -0,0 +1,40 @@
+module ActionView
+  module Partials
+    private
+
+    def render_partial_with_easel(*args)
+      path = args.first[:partial]
+      locals = args.last || {}
+
+      easel_cached_column_counts = session[:easel_cached_column_counts] ||= {}
+
+      if easel_cached_column_counts.keys.include?(path)
+        @_easel_column_count = locals[:easel_width] || easel_cached_column_counts[path]
+        easel_cached_column_counts[path] = @_easel_column_count
+      else
+        if @_easel_column_count.is_a?(Fixnum) && path !~ /^layout/
+          easel_cached_column_counts[path] = @_easel_column_count
+        end
+      end
+
+      render_partial_without_easel(*args)
+    end
+
+    alias_method_chain :render_partial, :easel
+  end
+end
+
+module EaselHelpers
+  module PartialCaching
+    def self.included(base)
+      base.send :include, EaselHelpers::PartialCaching::InstanceMethods
+      base.before_filter :clear_easel_cache
+    end
+
+    module InstanceMethods
+      def clear_easel_cache
+        session[:easel_cached_column_counts] = nil unless request.xhr?
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require "easel_helpers"
+
+ActionView::Base.send :include, EaselHelpers::Helpers
+ActionController::Base.send :include, EaselHelpers::PartialCaching

data/tasks/easel_helpers_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :easel_helpers do
+#   # Task goes here
+# end

data/test/date_helper_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class DateHelperTest < ActiveSupport::TestCase
+  include EaselHelpers::Helpers::DateHelper
+
+  context "datetime helper" do
+    should "default to an empty string if date is not supplied" do
+      assert_equal "", datetime(nil)
+    end
+
+    should "default to passed default text if date is not supplied" do
+      assert_equal "default text", datetime(nil, "default text")
+    end
+
+    should "default to :long format for date" do
+      timestamp = Time.now
+      assert_equal timestamp.to_s(:long), datetime(timestamp)
+    end
+
+    should "use passed format if applicable" do
+      timestamp = Time.now
+      assert_equal timestamp.to_s(:short), datetime(timestamp, "", :short)
+    end
+
+    should "convert passed data to a time" do
+      datestamp = Date.today
+      timestamp = datestamp.to_time
+      assert_equal timestamp.to_s(:long), datetime(datestamp)
+    end
+  end
+
+  context "date helper" do
+    should "default to an empty string if date is not supplied" do
+      assert_equal "", date(nil)
+    end
+
+    should "default to passed default text if date is not supplied" do
+      assert_equal "default text", date(nil, "default text")
+    end
+
+    should "default to :long format for date" do
+      datestamp = Date.today
+      assert_equal datestamp.to_s(:long), date(datestamp)
+    end
+
+    should "use passed format if applicable" do
+      datestamp = Date.today
+      assert_equal datestamp.to_s(:short), date(datestamp, "", :short)
+    end
+
+    should "convert passed data to a time" do
+      timestamp = Time.now
+      datestamp = timestamp.to_date
+
+      assert_equal datestamp.to_s(:long), date(timestamp)
+    end
+  end
+
+end

data/test/form_helper_test.rb

@@ -0,0 +1,135 @@
+require 'test_helper'
+
+class FormHelperTest < EaselHelpers::ViewTestCase
+
+  context "submit_button" do
+
+    should "default with the correct structure" do
+      show_view "<%= submit_button 'Create' %>" do
+        assert_select "button.btn[type=submit][value=Create]" do
+          assert_select "span", "Create"
+        end
+      end
+    end
+
+    should "allow adding additional classes" do
+      show_view "<%= submit_button 'Create', 'adtl-class', :dumb %>" do
+        assert_select "button.btn.adtl-class.dumb[type=submit][value=Create]" do
+          assert_select "span", "Create"
+        end
+      end
+    end
+
+    should "handle additional attributes set" do
+      show_view "<%= submit_button 'Create', :kls, :id => 'my-id', :type => 'image' %>" do
+        assert_select "button.btn.kls#my-id[type=image][value=Create]" do
+          assert_select "span", "Create"
+        end
+      end
+    end
+
+    should "allow overriding of value" do
+      show_view "<%= submit_button 'Create', :value => 'override' %>" do
+        assert_select "button.btn[type=submit][value=override]" do
+          assert_select "span", "Create"
+        end
+      end
+    end
+
+  end
+
+  context "set" do
+
+    should "default with the correct structure" do
+      show_view "<% set do %>words<% end %>" do
+        assert_select "div.text", "words"
+      end
+    end
+
+    should "allow adding/overriding classes" do
+      show_view "<% set :checkbox do %>words<% end %>" do
+        assert_select "div.checkbox", "words"
+      end
+    end
+
+    should "handle additional attributes set" do
+      show_view "<% set :id => 'custom-id' do %>words<% end %>" do
+        assert_select "div.text#custom-id", "words"
+      end
+    end
+
+    should "assign default class if width class is passed as the only class" do
+      show_view "<% set :half do %>words<% end %>" do
+        assert_select "div.text.col-12", "words"
+      end
+    end
+
+    should "assign default class if last class is passed as the only class" do
+      show_view "<% set :half, :last do %>words<% end %>" do
+        assert_select "div.col-12.text.col-last", "words"
+      end
+    end
+
+    should "assign default class if error class is passed" do
+      show_view "<% set :half, :last, :error do %>words<% end %>" do
+        assert_select "div.col-12.text.col-last.error", "words"
+      end
+    end
+
+    should "assign default class if the class textarea is present" do
+      show_view "<% set :textarea do %>words<% end %>" do
+        assert_select "div.textarea.text", "words"
+      end
+    end
+
+  end
+
+  context "fieldset" do
+
+    should "default with the correct structure" do
+      show_view "<% fieldset do %>words<% end %>" do
+        assert_select "fieldset", "words"
+      end
+    end
+
+    should "assign the first argument as the legend if it is a string" do
+      show_view "<% fieldset 'User Information' do %>words<% end %>" do
+        assert_select "fieldset", /words/ do
+          assert_select "h3.legend", "User Information"
+        end
+      end
+    end
+
+    should "allow adding fieldset classes" do
+      show_view "<% fieldset :hform, 'col-last' do %>words<% end %>" do
+        assert_select "fieldset.hform.col-last", "words"
+      end
+    end
+
+    should "allow adding fieldset classes and a legend" do
+      show_view "<% fieldset 'User Information', :hform, 'col-last' do %>words<% end %>" do
+        assert_select "fieldset.hform.col-last", /words/ do
+          assert_select "h3.legend", "User Information"
+        end
+      end
+    end
+
+    should "allow assignment of legend attributes" do
+      show_view "<% fieldset 'User Information', :hform, :legend => {:class => 'lgnd', :id => 'legend-id'} do %>words<% end %>" do
+        assert_select "fieldset.hform", /words/ do
+          assert_select "h3.legend.lgnd#legend-id", "User Information"
+        end
+      end
+    end
+
+    should "allow assignment of fieldset attributes" do
+      show_view "<% fieldset 'User Information', :hform, :id => 'my-fieldset' do %>words<% end %>" do
+        assert_select "fieldset.hform#my-fieldset", /words/ do
+          assert_select "h3.legend", "User Information"
+        end
+      end
+    end
+
+  end
+
+end