lrd_view_tools 0.1.1 → 0.1.3

data/README.rdoc

@@ -1,48 +1,58 @@
-=LRD ViewTools
+=LRD::ViewTools
 
 Standard view helpers and stylesheet defaults for Logical Reality Design
 Projects.
 
 == Installing
 
-Add to Gemfile:
+Add to Gemfile:
   gem 'lrd_view_tools'
 
 and run 'bundle install'.
 
-Also, 'rails generate lrd_view_tools:install' will copy in default images,
-stylesheets, and helper partials to the rails app.
-
 == Simple labeled inputs for forms:
 
-  labeled_input(form, field)
+  form.labeled_input(field)
 
   Produces a <label> <input> pair for a text field in a standard form helper.
-  The included stylesheet forms.sass will format the label as an 8-em wide
-  float to the left of the input.
+  The default LRD stylesheet (forms.sass) in all LRD projects will format the
+  label as an 8-em wide float to the left of the input (or may have been modified
+  on a per-project basis).
 
   Usage example:
-    form_for(@user) do |form
-      = labeled_input(form, :name)
-      = labeled_input(form, :email)
-      = labeled_input(form, nil, :input => form.submit("Save Changes"))
+    form_for(@user) do |f|
+      = f.labeled_input(:name)
+      = f.labeled_input(:email)
+      = f.labeled_input(:country) do
+        = f.select(:country, [ 'option 1', 'option 2'])
+      = f.unlabeled_submit
     end
 
   Options:
     The output defaults to <input type="text" name="#{field}"> for the
     but can be overridden in a number of ways:
 
-    #Override the form element:
-    labeled_input(form, :boolean_field, :input => form.checkbox(:boolean_field))
+    #Override the input element by passing a block:
+    f.labeled_input(:boolean_field) do
+      f.checkbox(:boolean_field))
+
+    #Alter label text:
+    f.labeled_input(:fieldname, :text => "Other Text")
 
     #Force a blank label:
-    labeled_input(form, :fieldname, :nolabel => true )
+    f.labeled_input(:fieldname, :text => '' )
 
-    #Alter label text:
-    labeled_input(form, :fieldname, :text => "Other Text")
+    #Set to required - appends class 'required' to both the div and the input:
+    f.labeled_input(:fieldname, :required => 'true' )
 
     #Add a comment after the input:
-    labeled_input(form, :password_confirmation, :comment => "Re-enter password")
+    f.labeled_input(:password_confirmation, :comment => "Re-enter password")
+
+    #Change the input type to a textarea:
+    f.labeled_input(:description, :input_type => :text_area)    # or :textarea, both work
+
+    #Create a telephone input:
+    f.labeled_input(:description, :input_type => :tel)    # or :telephone, both work
 
 == Pass a block to partial:
 

data/lib/app/helpers/lrd_form_helper.rb

@@ -3,7 +3,6 @@ module LRD
   module FormHelper
 
     def self.included(arg)
-      p "LRD::FormHelper included in  #{arg}"
       ActionView::Helpers::FormBuilder.send(:include, LRD::FormBuilder)
     end
 
@@ -11,11 +10,11 @@ module LRD
     # block, pre-styled in LRD style.
     #
     # pass  :label => false  to suppress the label text.  (A label tag is still emitted.)
-    # pass  :required => true  to dispay as a required field
+    # pass  :required => true  to dispay as a required field (class required set on both the div and the input)
     # pass  :text => "foo"  to override the label text
-    # pass  :class => 'foo' to add 'foo' to the CSS class of the <div>
+    # pass  :divclass => 'foo' to add 'foo' to the CSS class of the <div>
     # pass  :comment => "text"  to append a span.comment with text after the input
-    # pass  :input_type => 'password' } to use a password_field instead of a text_field
+    # pass  :type => 'password' } to use a password_field instead of a text_field
     #    (also supported: text, passsword, hidden, file, text_area, search, telephone, url
     #     email, range, submit)
     #
@@ -27,23 +26,24 @@ module LRD
     #   # =>   <input type='text' name='user[login]' id='user_login' value="#{@user.login}" />
     #   # => </div>
     def labeled_input(object_name, method, options = {}, &block)
-      divclass = labeled_input_divclass(options)
+      divclass = options.delete(:divclass)
+      div_final_class = labeled_input_div_class(options, divclass)
       comment = comment_for_labeled_input(options.delete(:comment))
+      label_text = options.delete(:text)
       if block_given?
         input = capture(&block)
       else
         input = input_for_labeled_input(object_name, method, options)
       end
 
-
       if object_name.blank? or method.blank?
         label = "<label>&nbsp;</label>".html_safe
-      elsif text = options.delete(:text)
-        label = label(object_name, method, text, options)
+      elsif label_text =
+        label = label(object_name, method, label_text, options)
       else
         label = label(object_name, method, options)
       end
-      content_tag(:div, (label + input + comment), { :class => divclass })
+      content_tag(:div, (label + input + comment), { :class => div_final_class })
     end
 
     def comment_for_labeled_input(text)
@@ -55,15 +55,20 @@ module LRD
     end
 
 
-    def labeled_input_divclass(options)
+    def labeled_input_div_class(options, divclass = nil)
       cssclass = "labeled_input"
       cssclass += " required" if options[:required]
-      cssclass += " #{options[:class]}" if options[:class]
+      cssclass += " #{divclass}" if divclass
       cssclass
     end
 
     def input_for_labeled_input(object_name, method, options)
-      case input_type = options.delete(:input_type).to_s
+      if required = options.delete(:required)
+        options[:class] = (options[:class] or '') + " required"
+      end
+      submit_text = options.delete(:submit_text)
+
+      case input_type = options.delete(:type).to_s
       when "text", ""
         input = text_field(     object_name, method, options)
       when "password"
@@ -72,11 +77,11 @@ module LRD
         input = hidden_field(   object_name, method, options)
       when "file"
         input = file_field(     object_name, method, options)
-      when "text_area"
+      when "text_area", "textarea"
         input = text_area(      object_name, method, options)
       when "search"
         input = search_field(   object_name, method, options)
-      when "telephone"
+      when "telephone", 'tel'
         input = telephone_field(object_name, method, options)
       when "url"
         input = url_field(      object_name, method, options)
@@ -87,20 +92,31 @@ module LRD
       when "range"
         input = range_field(    object_name, method, options)
       when "submit"
-        input = submit_tag(     options[:submit_text], options)
+        input = submit_tag(     submit_text, options)
       else
         raise "labeled_input input_type #{input_type} is not a valid type!"
       end
       input
     end
 
+    # Shortcut for a version of labeled_input that suppresses the
+    # label text.   Just calls labeled_input with :label => false.
     def unlabeled_input(object_name, method, options)
       labeled_input(object_name, method, options.merge!(:label => false))
     end
 
     # creates a submit button that lines up with a bunch of labeled_input fields
+    # Pass a single argument to override the default text of the submit button.
+    #
+    # ==== Examples (in HAML):
+    #   - form_for(@user) do
+    #     = f.unlabeled_submit("Click Me")
+    #   # => <div class='labeled_input'>
+    #   # =>   <label> </label>
+    #   # =>   <input type='submit' name='[]' value='Click Me' />
+    #   # => </div>
     def unlabeled_submit(text = nil)
-      labeled_input(nil, nil, :input_type => :submit, :submit_text => text)
+      labeled_input(nil, nil, :type => :submit, :submit_text => text)
     end
   end
 end

data/spec/labelled_input_spec.rb

@@ -10,17 +10,250 @@ describe "form_for().labelled_input", :type => :view do
 
   let :user do
     view.stub!(:user_path => "#")
-    mock_model("User", :login => "Username")
+    mock_model("User", :login => "Username", :bio => "This is my story", :phone => "626-111-2222")
   end
 
-  it "should render a labeled_input successfully" do
-    render(:inline => <<-EOTEMPLATE, :locals => { :user => user })
-      <%= form_for(user) do |f| %>
-         <%= f.labeled_input(:login) %>
-      <%- end -%>
-    EOTEMPLATE
-    p "Rendered is: ", rendered
-    rendered.should_not be_nil
 
+  describe "with default type" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login) %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should render successfully" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not be_nil
+    end
+
+    it "should have a label" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath('//label')
+    end
+
+    it "should have a text input" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath('//input')
+    end
+
+    it "should have a div with class labeled_input" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath('//div[@class="labeled_input"]')
+    end
+  end
+
+  describe "with block passed" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login) do %>
+             <select name='foo'>
+                <option value='bar'>Bar</option>
+                <option value='baz'>Baz</option>
+                <option value='bletch'>Bletch</option>
+             </select>
+          <%- end -%>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should not generate the default input" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//div[@class='labeled_input']/input")
+    end
+
+    it "should insert the block's elements" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath(
+        "//div[@class='labeled_input']/select[@name='foo'][count(option)=3]"
+      )
+    end
+  end
+
+  describe "with :required => true" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login, :required => true) %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should set the div class to required" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div[contains(@class,'required')][contains(@class, 'labeled_input')]")
+    end
+
+    it "should set the input class to required" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div[contains(@class,'required')]/input[contains(@class, 'required')]")
+    end
+
+  end
+
+
+  describe "with label text specified" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login, :text => 'Label text') %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should set the content of the label" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//label[.='Label text']")
+    end
+
+    it "should not apply a 'text' attribute to the other elements" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//label[@text]")
+      rendered.should_not have_xpath("//input[@text]")
+      rendered.should_not have_xpath("//div[@text]")
+    end
+
+    it "should not apply a class 'text' to the other elements" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//label[contains(@class, 'text')]")
+      rendered.should_not have_xpath("//input[contains(@class, 'text')]")
+      rendered.should_not have_xpath("//div[contains(@class, 'text')]")
+    end
+  end
+
+  describe "with a comment specified" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login, :comment => 'Reminder text') %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should add a span for the comment" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div/span[contains(@class, 'comment')][.='Reminder text']")
+    end
+
+    it "should not apply a comment attribute to the other elements" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//label[@comment]")
+      rendered.should_not have_xpath("//input[@comment]")
+      rendered.should_not have_xpath("//div[@comment]")
+    end
+
+    it "should not apply a class 'comment' to the other elements" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//label[contains(@class, 'comment')]")
+      rendered.should_not have_xpath("//input[contains(@class, 'comment')]")
+      rendered.should_not have_xpath("//div[contains(@class, 'comment')]")
+    end
   end
+
+  describe "with a divclass specified" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:login, :divclass => 'foobar') %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should apply the appropriate class to the div" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div[contains(@class, 'foobar')]")
+    end
+
+    it "should not apply the divclass to the input or label" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//label[contains(@class, 'foobar')]")
+      rendered.should_not have_xpath("//input[contains(@class, 'foobar')]")
+    end
+  end
+
+  describe "with type :submit" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:bio, :type => :submit) %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should have a submit button" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div[@class='labeled_input']/input[@type='submit']")
+    end
+
+    describe "and submit text" do
+      let :template do
+        <<-EOTEMPLATE
+          <%= form_for(user) do |f| %>
+             <%= f.labeled_input(:bio, :type => :submit, :submit_text => 'Click Me') %>
+          <%- end -%>
+        EOTEMPLATE
+      end
+
+      it "should have a submit button with text" do
+        render(:inline => template, :locals => { :user => user })
+        rendered.should have_xpath("//div[@class='labeled_input']/input[@type='submit'][@value='Click Me']")
+      end
+
+      it "should not put a 'submit_text' attribute in the other tags" do
+        render(:inline => template, :locals => { :user => user })
+        rendered.should_not have_xpath("//*[@submit_text]")
+      end
+    end
+  end
+
+
+  describe "with type :text_area" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:bio, :type => 'text_area') %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should have a text area" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath('//textarea')
+    end
+  end
+
+
+  describe "with type :textarea" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:bio, :type => :textarea) %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should have a text area" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath('//textarea')
+    end
+  end
+
+  describe "with type :telephane" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.labeled_input(:phone, :type => :telephone) %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+    it "should have a telephone input" do
+      render(:inline => template, :locals => { :user=> user })
+      rendered.should have_xpath('//input[@type="tel"]')
+    end
+
+  end
+
+
 end

data/spec/spec_helper.rb

@@ -7,6 +7,9 @@ require 'rspec/rails/matchers/render_template'
 require 'rspec/rails/browser_simulators'
 require 'rspec/rails/example/view_example_group'
 require 'rspec/rails/mocks'
+require 'webrat'
+require "webrat/integrations/rspec-rails"
+require 'webrat/core/matchers'
 
 plugin_spec_dir = File.dirname(__FILE__)
 #ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
@@ -16,3 +19,4 @@ RSpec::configure do |c|
     :file_path => 'spec/views'
   }
 end
+

data/spec/unlabeled_submit_spec.rb

@@ -0,0 +1,44 @@
+require 'spec/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'lib','app', 'helpers', 'lrd_form_helper')
+ActionView::Helpers::FormHelper.send(:include, LRD::FormHelper)
+
+describe "form_for().unlabeled_submit", :type => :view do
+  let :user do
+    view.stub!(:user_path => "#")
+    mock_model("User", :login => "Username", :bio => "This is my story", :phone => "626-111-2222")
+  end
+
+
+  let :template do
+    <<-EOTEMPLATE
+      <%= form_for(user) do |f| %>
+         <%= f.unlabeled_submit %>
+      <%- end -%>
+    EOTEMPLATE
+  end
+
+  it "should have a submit button" do
+    render(:inline => template, :locals => { :user => user })
+    rendered.should have_xpath("//div[@class='labeled_input']/input[@type='submit']")
+  end
+
+  describe "and submit text" do
+    let :template do
+      <<-EOTEMPLATE
+        <%= form_for(user) do |f| %>
+           <%= f.unlabeled_submit('Click Me') %>
+        <%- end -%>
+      EOTEMPLATE
+    end
+
+    it "should have a submit button with text" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should have_xpath("//div[@class='labeled_input']/input[@type='submit'][@value='Click Me']")
+    end
+
+    it "should not put a 'submit_text' attribute in the other tags" do
+      render(:inline => template, :locals => { :user => user })
+      rendered.should_not have_xpath("//*[@submit_text]")
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lrd_view_tools
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Evan Dorn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-27 00:00:00 -07:00
+date: 2011-05-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -35,13 +35,11 @@ files:
 - lib/app/helpers/lrd_form_helper.rb
 - lib/app/helpers/lrd_view_helper.rb
 - lib/lrd_view_tools.rb
-- spec/helpers/lrd_view_helper_spec.rb
 - spec/labelled_input_spec.rb
 - spec/lrd_view_tools_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/spec_helper_naked.rb
-- spec/spec_helper_plugin.rb
+- spec/unlabeled_submit_spec.rb
 has_rdoc: true
 homepage: http://LRDesign.com
 licenses: 
@@ -72,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: View helpers and defaults for LRD projects.

data/spec/helpers/lrd_view_helper_spec.rb

@@ -1,43 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-require 'lrd_view_helper'
-
-describe LRD::ViewHelper do
-  
-  describe "bool_checked" do
-    describe "with true" do
-      it "should return an image tag for the checkmark" do
-        helper.bool_checked(true).should =~ /images\/check.png/
-      end
-    end
-    describe "with false" do
-      it "should return an image tag for a spacer" do
-        helper.bool_checked(false).should =~ /images\/blank.gif/        
-      end
-    end
-  end   
-                 
-  describe "labeled_input" do
-    before(:each) do
-      @form = mock(ActionView::Helpers::FormHelper)
-      @form.stub!(:text_field).and_return("<input name='field' />")
-      @form.stub!(:label).and_return("<label for='field'>")
-      
-      @labeled_input = helper.labeled_input(@form, :field)
-    end
-    
-    it "should return a string" do  
-      @labeled_input.is_a?(String).should be_true
-    end
-    it "should contain the input tag" do
-      @labeled_input.should match(/<input/)
-      @labeled_input.should match(/name='field'/)
-    end               
-    it "should contain the label tag field" do
-      @labeled_input.should match(/<label/)
-      @labeled_input.should match(/for='field'/)
-    end
-    
-  end                 
-                 
-   
-end

data/spec/spec_helper_naked.rb

@@ -1,11 +0,0 @@
-begin
-  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
-rescue LoadError
-#  puts "You need to install rspec in your base app"
-#  exit
-end
-
-require 'rspec/rails/example/view_example_group'
-
-plugin_spec_dir = File.dirname(__FILE__)
-#ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")

data/spec/spec_helper_plugin.rb

@@ -1,10 +0,0 @@
-begin
-  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
-rescue LoadError
-  puts "You need to install rspec in your base app"
-  exit
-end
-
-plugin_spec_dir = File.dirname(__FILE__)
-ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
-