viewaide 0.3.0

data/lib/viewaide/rails_partial_caching.rb

@@ -0,0 +1,40 @@
+module ActionView
+  module Partials
+    private
+
+    def render_partial_with_viewaide(*args)
+      path = args.first[:partial]
+      locals = args.last || {}
+
+      viewaide_cached_column_counts = session[:viewaide_cached_column_counts] ||= {}
+
+      if viewaide_cached_column_counts.keys.include?(path)
+        @_viewaide_column_count = locals[:viewaide_width] || viewaide_cached_column_counts[path]
+        viewaide_cached_column_counts[path] = @_viewaide_column_count
+      else
+        if @_viewaide_column_count.is_a?(Fixnum) && path !~ /^layout/
+          viewaide_cached_column_counts[path] = @_viewaide_column_count
+        end
+      end
+
+      render_partial_without_viewaide(*args)
+    end
+
+    alias_method_chain :render_partial, :viewaide
+  end
+end
+
+module Viewaide
+  module PartialCaching
+    def self.included(base)
+      base.send :include, Viewaide::PartialCaching::InstanceMethods
+      base.before_filter :clear_viewaide_cache
+    end
+
+    module InstanceMethods
+      def clear_viewaide_cache
+        session[:viewaide_cached_column_counts] = nil unless request.xhr?
+      end
+    end
+  end
+end

data/lib/viewaide.rb

@@ -0,0 +1,3 @@
+require "hpricot"
+require "viewaide/helpers"
+require "viewaide/rails_partial_caching"

data/rails/init.rb

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

data/test/date_helper_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+
+class DateHelperTest < ActiveSupport::TestCase
+  include Viewaide::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 < Viewaide::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

data/test/grid_helper_test.rb

@@ -0,0 +1,226 @@
+require "test_helper"
+
+class GridHelperTest < Viewaide::ViewTestCase
+
+  context "advanced grid structures" do
+
+    should "properly assign classes for a simple column layout" do
+      template = %(
+        <% container do %>
+          <% column do %>
+            <% column :half, :id => "primary" do %>
+              <% column :one_third do %>
+                one third of one half of 24 is 4
+              <% end %>
+              <% column :one_third, :last, prepend_one_third do %>
+                one third of one half of 24 is 4 (but prepended 4 as well)
+              <% end %>
+              <hr/>
+              more text
+            <% end %>
+            <% column :half, :last, :id => "secondary" do %>
+              second column
+            <% end %>
+            <hr/>
+            text
+          <% end %>
+        <% end %>
+      )
+
+      show_view template do
+        assert_select ".container", 1
+        assert_select ".container.col-24", 0
+        assert_select ".col-24", 1
+        assert_select ".col-12", 2
+        assert_select ".col-12#primary", 1
+        assert_select ".col-12#secondary", 1
+        assert_select ".col-4", 2
+        assert_select ".prepend-4", 1
+        assert_select ".col-24.col-last", 0
+        assert_select ".col-12.col-last", 1
+        assert_select ".col-4.col-last", 1
+        assert_select "hr", 2
+      end
+    end
+
+    should "properly assign classes for generic helpers" do
+      template = %(
+        <% column do %>
+          <% fieldset :hform, :half do %>
+            <% set :one_third do %>text<% end %>
+            <% set :two_thirds, :last do %>more text<% end %>
+          <% end %>
+          <% recordset :half, :last do %>table<% end %>
+        <% end %>
+      )
+
+      show_view template do
+        assert_select "div.col-24" do
+          assert_select "fieldset.hform.col-12" do
+            assert_select "div.col-4", "text"
+            assert_select "div.col-8.col-last", "more text"
+          end
+          assert_select "table.col-12.col-last", "table"
+        end
+      end
+    end
+
+    should "properly assign classes for generic helpers without column wrappers" do
+      template = %(
+        <% fieldset :hform, :half do %>
+          <% set :one_third do %>text<% end %>
+          <% set :two_thirds, :last do %>more text<% end %>
+          <% column do %>
+            <% column :one_third do %>one third<% end %>
+            <% column :two_thirds, :last do %>
+              <% column :half do %>half<% end %>
+              <% column :half, :last do %>last half<% end %>
+            <% end %>
+          <% end %>
+        <% end %>
+        <% column :one_third do %>
+          <% column :one_fourth do %>two wide<% end %>
+          <% column :half do %>four wide<% end %>
+          <% column :one_fourth, :last do %>two more wide<% end %>
+        <% end %>
+        <% recordset :one_sixth, :last do %>table<% end %>
+      )
+
+      show_view template do
+        assert_select "fieldset.hform.col-12" do
+          assert_select "div.col-4", "text"
+          assert_select "div.col-8.col-last", "more text"
+
+          assert_select "div.col-12.col-last" do
+            assert_select "div.col-4", "one third"
+            assert_select "div.col-8.col-last" do
+              assert_select "div.col-4", "half"
+              assert_select "div.col-4.col-last", "last half"
+            end
+          end
+        end
+        assert_select "div.col-8" do
+          assert_select "div.col-2", "two wide"
+          assert_select "div.col-4", "four wide"
+          assert_select "div.col-2.col-last", "two more wide"
+        end
+        assert_select "table.col-4.col-last", "table"
+      end
+    end
+
+    should "properly assign classes for a deeply-nested view" do
+      template = %(
+        <% container :full do %>
+          <% column :half do %>
+            <% fieldset :hform, :half do %>
+              <% set :one_third do %>text<% end %>
+              <% set :two_thirds, :last do %>more text<% end %>
+            <% end %>
+            <% recordset :half, :last do %>table<% end %>
+          <% end %>
+          <% column :one_third do %>one third!<% end %>
+          <% column :one_sixth, :last do %>
+            <% fieldset :vform, :full do %>
+              <% set do %>text<% end %>
+            <% end %>
+          <% end %>
+        <% end %>
+      )
+
+      show_view template do
+        assert_select "div.container.col-24", 1
+        assert_select "div.container" do
+          assert_select "div.col-12" do
+            assert_select "fieldset.hform.col-6" do
+              assert_select "div.col-2", "text"
+              assert_select "div.col-4.col-last", "more text"
+            end
+            assert_select "table.col-6.col-last", "table"
+          end
+
+          assert_select "div.col-8", "one third!"
+
+          assert_select "div.col-4.col-last" do
+            assert_select "fieldset.vform.col-4.col-last" do
+              assert_select "div", "text"
+            end
+          end
+        end
+      end
+    end
+
+    should "properly assign classes when using Blueprint grid" do
+      template = %(
+        <% container do %>
+          <% column do %>
+            <% column :half, :id => "primary" do %>
+              <% column :one_third do %>
+                one third of one half of 24 is 4
+              <% end %>
+              <% column :one_third, :last, prepend_one_third do %>
+                one third of one half of 24 is 4 (but prepended 4 as well)
+              <% end %>
+              <hr/>
+              more text
+            <% end %>
+            <% column :half, :last, :id => "secondary" do %>
+              second column
+            <% end %>
+            <hr/>
+            text
+          <% end %>
+        <% end %>
+      )
+      Viewaide::Helpers::GridHelper.blueprint_grid!
+      show_view template do
+        assert_select ".container", 1
+        assert_select ".span-24", 1
+        assert_select ".span-12", 2
+        assert_select ".span-12#primary", 1
+        assert_select ".span-12#secondary", 1
+        assert_select ".span-4", 2
+        assert_select ".prepend-4", 1
+        assert_select ".span-24.last", 0
+        assert_select ".span-12.last", 1
+        assert_select ".span-4.last", 1
+        assert_select "hr", 2
+      end
+      Viewaide::Helpers::GridHelper.easel_grid!
+    end
+  end
+
+  context "column" do
+
+    should "allow assigning options hash without having to define a width" do
+      show_view %(
+        <% column :id => "my-custom-id", :class => "content" do %>words<% end %>
+      ) do
+        assert_select "div.col-24.content#my-custom-id", "words"
+      end
+    end
+
+    should "allow explicit column assignment" do
+      show_view %(
+        <% column 6, :sidebar do %>
+          <% column :id => "main" do %>main sidebar<% end %>
+          <% column :half do %>three<% end %>
+          <% column :one_third do %>two<% end %>
+          <% column 1, :last do %>one<% end %>
+        <% end %>
+      ) do
+        assert_select "div.col-6.sidebar" do
+          assert_select "div.col-6.col-last#main", "main sidebar"
+          assert_select "div.col-3", "three"
+          assert_select "div.col-2", "two"
+          assert_select "div.col-1.col-last", "one"
+        end
+      end
+    end
+
+    should "allow tag overriding" do
+      show_view %(<% column :tag => :section do %>content<% end %>) do
+        assert_select "section.col-24:not([tag=section])", "content"
+      end
+    end
+  end
+end

data/test/jquery_helper_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class JqueryHelperTest < Viewaide::ViewTestCase
+
+  context "document_ready" do
+
+    setup do
+      @whitespace = '\s+?'
+      @anything =   '(.|\s)+?'
+
+      @anon_function_start_regex  = Regexp.escape "(function($) {"
+      @document_ready_start_regex = Regexp.escape   "$(document).ready(function() {"
+
+      @document_ready_end_regex   = Regexp.escape   "});"
+      @anon_function_end_regex    = Regexp.escape "})(jQuery);"
+    end
+
+    should "properly build the document ready script tag" do
+      show_view %(
+        <% document_ready do %>
+          alert("hello!");
+        <% end %>
+      ) do
+        assert_select "script[type=?]", "text/javascript", /#{@anon_function_start_regex}#{@whitespace}#{@document_ready_start_regex}#{@whitespace}alert#{@anything}#{@document_ready_end_regex}#{@whitespace}#{@anon_function_end_regex}/
+      end
+    end
+
+  end
+
+end

data/test/link_helper_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class LinkHelperTest < Viewaide::ViewTestCase
+  context "link_button" do
+
+    should "default with the correct structure" do
+      show_view "<%= link_button 'Link Text', '#' %>" do
+        assert_select "a.btn[href=#]" do
+          assert_select "span", "Link Text"
+        end
+      end
+    end
+
+    should "allow the same assignment as link_to" do
+      show_view "<%= link_button 'Link Text', '#', :class => 'my-button', :id => 'link-text' %>" do
+        assert_select "a.btn.my-button#link-text[href=#]" do
+          assert_select "span", "Link Text"
+        end
+      end
+    end
+
+  end
+
+  context "link_to_email" do
+    should "default with the correct structure" do
+      show_view "<%= link_to_email 'test@example.com' %>" do
+        assert_select "a[href=mailto:test@example.com]", "test@example.com"
+      end
+    end
+
+    should "allow override of link text as the first argument after email" do
+      show_view "<%= link_to_email 'test@example.com', 'Send an email to Test User' %>" do
+        assert_select "a[href=mailto:test@example.com]", "Send an email to Test User"
+      end
+    end
+
+    should "allow the same assignment as link_to" do
+      show_view "<%= link_to_email 'test@example.com', :class => 'test-user-email', :id => 'user_1_email' %>" do
+        assert_select "a.test-user-email#user_1_email[href=mailto:test@example.com]", "test@example.com"
+      end
+    end
+
+  end
+end

data/test/message_helper_test.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+
+class MessageHelperTest < Viewaide::ViewTestCase
+
+  context "messages" do
+
+    should "default with the correct structure" do
+      show_view %(<%= messages(:structure => "Flash message") %>) do
+        assert_select "p.structure.box.single-line", "Flash message"
+      end
+    end
+
+    should "display all flash messages present" do
+      show_view %(<%= messages(:structure => "Flash message", :error => "Warning message") %>) do
+        assert_select "p.structure", "Flash message"
+        assert_select "p.error", "Warning message"
+      end
+    end
+
+    should "not display a flash if it is blank" do
+      show_view %(<%= messages(:structure => "", :error => nil) %>) do
+        assert_select "p.structure", false
+        assert_select "p.error", false
+      end
+    end
+
+    should "filter by the :only option" do
+      show_view %(<%= messages({:structure => "Flash message", :error => "Warning message", :notice => "Notice!"}, {:only => [:structure, :error]}) %>) do
+        assert_select "p.structure", "Flash message"
+        assert_select "p.error", "Warning message"
+        assert_select "p.notice", false
+      end
+    end
+
+    should "filter by the :except option" do
+      show_view %(<%= messages({:structure => "Flash message", :error => "Warning message", :notice => "Notice!"}, {:except => [:structure, :error]}) %>) do
+        assert_select "p.structure", false
+        assert_select "p.error", false
+        assert_select "p.notice", "Notice!"
+      end
+    end
+
+    should "raise an error of :only and :except are both passed" do
+      assert_raise ArgumentError, /conflict/ do
+        show_view %(<%= messages({:structure => "Flash message"}, {:except => [:structure, :error], :only => :structure}) %>)
+      end
+    end
+  end
+
+end