lrd_view_tools 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Logical Reality Design and Evan Dorn
+
+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/README.rdoc

@@ -0,0 +1,72 @@
+=LRD ViewTools
+
+Standard view helpers and stylesheet defaults for Logical Reality Design
+Projects.
+
+== Installing
+
+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)
+
+  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.
+
+  Usage example:
+    form_for(@user) do |form
+      = labeled_input(form, :name)
+      = labeled_input(form, :email)
+      = labeled_input(form, nil, :input => form.submit("Save Changes"))
+    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))
+
+    #Force a blank label:
+    labeled_input(form, :fieldname, :nolabel => true )
+
+    #Alter label text:
+    labeled_input(form, :fieldname, :text => "Other Text")
+
+    #Add a comment after the input:
+    labeled_input(form, :password_confirmation, :comment => "Re-enter password")
+
+== Pass a block to partial:
+
+  block_to_partial(partial_name, options = {}, &block)
+
+  Usage example:
+    block_to_partial('shared/my_partial') do
+      <p>Paragraph to be yielded inside the partial.</p>
+    end
+
+  The block will be available to the partial as 'body', and any options
+  will be passed through as locals.   In addition, options[:id] and
+  options[:class] will get converted to locals 'cssid' and 'cssclass'
+  to avoid name collisions.
+
+== A better debug()
+
+   lrd_debug(var) will output var, wrapped in <pre></pre>, but using a
+   recursive pp output to handle large objects.
+
+   Usage example (in HAML):
+   if ENV["RAILS_ENV"] == development
+   #debug
+     %h2 Request environment:
+     = lrd_debug(request.env)
+
+Copyright (c) 2010-2011 Evan Dorn, released under the MIT license

data/lib/app/helpers/lrd_debug_helper.rb

@@ -0,0 +1,30 @@
+module LRD
+  module DebugHelper
+    require 'pp'
+    require 'stringio'
+
+    def lrd_debug(object)
+     "<pre>#{h(pp_s(object))}</pre>"
+    end
+
+    def pp_s(*objs)
+        s = StringIO.new
+        objs.each {|obj|
+          PP.pp(obj, s)
+        }
+        s.rewind
+        s.read
+    end
+    alias :pp_to_s :pp_s
+
+    def debug_link(name)
+      link_to name.titleize, '#', :onclick => "Element.toggle('#{name}_debug_info'); return false;"
+    end
+    def debug_block(name, &block)
+      content = capture(&block)
+      title = content_tag(:h2, name.titleize)
+      concat(content_tag :fieldset, content, {:id => "#{name}_debug_info", :style => 'display: none;' } )
+    end
+
+  end
+end

data/lib/app/helpers/lrd_form_helper.rb

@@ -0,0 +1,150 @@
+
+module LRD
+  module FormHelper
+
+    def self.included(arg)
+      p "LRD::FormHelper included in  #{arg}"
+      ActionView::Helpers::FormBuilder.send(:include, LRD::FormBuilder)
+    end
+
+    # Returns a <div> containing a label, an input, and an option comment
+    # 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  :text => "foo"  to override the label text
+    # pass  :class => '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
+    #    (also supported: text, passsword, hidden, file, text_area, search, telephone, url
+    #     email, range, submit)
+    #
+    # ==== Examples (in HAML):
+    #   - form_for(@user) do
+    #     = f.labeled_input(:login)
+    #   # => <div class='labeled_input'>
+    #   # =>   <label for='user_login'>login</label>
+    #   # =>   <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)
+      comment = comment_for_labeled_input(options.delete(:comment))
+      if block_given?
+        input = yield
+      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)
+      else
+        label = label(object_name, method, options)
+      end
+      content_tag(:div, (label + input + comment), { :class => divclass })
+    end
+
+    def comment_for_labeled_input(text)
+      if text
+        content_tag( :span, { :class => 'comment' } ) { text }
+      else
+        ""
+      end
+    end
+
+
+    def labeled_input_divclass(options)
+      cssclass = "labeled_input"
+      cssclass += " required" if options[:required]
+      cssclass += " #{options[:class]}" if options[:class]
+      cssclass
+    end
+
+    def input_for_labeled_input(object_name, method, options)
+      case input_type = options.delete(:input_type).to_s
+      when "text", ""
+        input = text_field(     object_name, method, options)
+      when "password"
+        input = password_field( object_name, method, options)
+      when "hidden"
+        input = hidden_field(   object_name, method, options)
+      when "file"
+        input = file_field(     object_name, method, options)
+      when "text_area"
+        input = text_area(      object_name, method, options)
+      when "search"
+        input = search_field(   object_name, method, options)
+      when "telephone"
+        input = telephone_field(object_name, method, options)
+      when "url"
+        input = url_field(      object_name, method, options)
+      when "email"
+        input = email_field(    object_name, method, options)
+      when "number"
+        input = number_field(   object_name, method, options)
+      when "range"
+        input = range_field(    object_name, method, options)
+      when "submit"
+        input = submit_tag(     options[:submit_text], options)
+      else
+        raise "labeled_input input_type #{input_type} is not a valid type!"
+      end
+      input
+    end
+
+    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
+    def unlabeled_submit(text = nil)
+      labeled_input(nil, nil, :input_type => :submit, :submit_text => text)
+    end
+  end
+end
+
+  # # pass { :nolabel => true } to replace the label with a spacer
+  #   # pass { :required => true } to dispay as a required field
+  #   # pass { :text => "foo" } to override the label text
+  #   # pass { :class => 'foo'} to add 'foo' to the CSS class of the <div>
+  #   #
+  #   # input_options hash gets passed directly to the input field
+  #   def labeled_input(form, field, options = {}, input_options = {})
+  #     options[:text] = "&nbsp;".html_safe if options[:nolabel]
+  #     options.reverse_merge!(:text => nil,:required => false, :nolabel => false)
+  #     options.merge!(:form => form, :field => field)
+  #     input_options.reverse_merge!( :size => 30 )
+  #
+  #     cssclass = "labeled_input"
+  #     cssclass += " required" if options[:required]
+  #     cssclass += " #{options[:class]}" if options[:class]
+  #
+  #     unless input = options[:input]
+  #       input = form.text_field field, input_options
+  #     end
+  #
+  #     if field.blank?
+  #       label = (content_tag :label, options[:text]).html_safe
+  #     else
+  #       label = (form.label field, options[:text]).html_safe
+  #     end
+  #     comment = options[:comment] ? content_tag( :span, { :class => 'comment' } ) { options[:comment] }  : ""
+  #
+  #     content_tag(:div, (label + input + comment), { :class => cssclass }).html_safe
+  #   end
+# f.labeled_input(stuff, :input_type => :hidden)
+#
+# f.labeled_input(stuff){ f.hidden_field(stuff) }
+#
+
+module LRD::FormBuilder
+  def labeled_input(method, options = {})
+    @template.labeled_input(@object_name, method, objectify_options(options))
+  end
+  def unlabeled_submit(text = nil)
+    @template.unlabeled_submit(text)
+  end
+end
+
+

data/lib/app/helpers/lrd_view_helper.rb

@@ -0,0 +1,52 @@
+module LRD
+  module ViewHelper
+
+    # Stores a headline for later rendering by the layout
+    def set_headline(headline)
+      content_for(:headline, headline)
+    end
+
+    # displays a checkmark if the field is set true
+    def bool_checked(field)
+      filename = field ? "check.png" : "blank.gif"
+      image_tag(filename, :alt => "yes", :size => "16x16")
+    end
+
+
+    # Passes the supplied block to the named partial
+    def block_to_partial(partial_name, options = {}, &block)
+      # replace :id with :cssid and :class with :cssclass
+      if options[:id]
+        options[:cssid] = options.delete(:id)
+      else
+        options[:cssid] = "" if options[:cssid].nil?
+      end
+      if options[:class]
+        options[:cssclass] = options.delete(:class)
+      else
+        options[:cssclass] = "" if options[:cssclass].nil?
+      end
+
+      options.merge!(:body => capture(&block))
+      render(:partial => partial_name, :locals => options)
+    end
+
+    # a standardized view helper that renders a box with an optional
+    # title.   The standard partial for it is in views/shared/_page_block.html.haml
+    def page_block(title = nil, options = {}, &block)
+      block_to_partial('shared/block', options.merge(:title => title), &block).html_safe
+    end
+
+  end
+
+  def debug_link(name)
+    link_to name.titleize, '#', :onclick => "Element.toggle('#{name}_debug_info'); return false;"
+  end
+  def debug_block(name, &block)
+    content = capture(&block)
+    title = content_tag(:h2, name.titleize)
+    concat(content_tag :fieldset, content, {:id => "#{name}_debug_info", :style => 'display: none;' } )
+  end
+
+end
+

data/lib/lrd_view_tools.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), 'app', 'helpers', 'lrd_view_helper')
+require File.join(File.dirname(__FILE__), 'app', 'helpers', 'lrd_debug_helper')
+require File.join(File.dirname(__FILE__), 'app', 'helpers', 'lrd_form_helper')
+
+module LRD::DevTools
+  class Railtie < Rails::Railtie
+    ActionController::Base.helper(LRD::ViewHelper)
+    ActionController::Base.helper(LRD::DebugHelper)
+    ActionView::Helpers::FormHelper.send(:include, LRD::FormHelper)
+  end
+end

data/spec/helpers/lrd_view_helper_spec.rb

@@ -0,0 +1,43 @@
+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/labelled_input_spec.rb

@@ -0,0 +1,26 @@
+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().labelled_input", :type => :view do
+  it "should render an inline template" do
+    render :inline => "<%= who%> rocks!", :locals => {:who => "Judson"}
+    rendered.should == "Judson rocks!"
+  end
+
+  let :user do
+    view.stub!(:user_path => "#")
+    mock_model("User", :login => "Username")
+  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
+
+  end
+end

data/spec/lrd_view_tools_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# include LRDViewHelpers
+
+describe "LRDViewHelpers" do
+  it "should have a pending spec"
+  
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+require 'active_support/deprecation'
+require 'action_view'
+require 'rspec/rails/adapters'
+require 'rspec/rails/example/rails_example_group'
+require 'rspec/rails/matchers/render_template'
+require 'rspec/rails/browser_simulators'
+require 'rspec/rails/example/view_example_group'
+require 'rspec/rails/mocks'
+
+plugin_spec_dir = File.dirname(__FILE__)
+#ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+RSpec::configure do |c|
+  c.include RSpec::Rails::ViewExampleGroup, :type => :view, :example_group => {
+    :file_path => 'spec/views'
+  }
+end

data/spec/spec_helper_naked.rb

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,10 @@
+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")
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: lrd_view_tools
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Evan Dorn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Compatible with Rails 3.x. Don't even bother trying with Rails 2.x or before.'
+email: evan@lrdesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- LICENSE.txt
+- README.rdoc
+- lib/app/helpers/lrd_debug_helper.rb
+- 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
+has_rdoc: true
+homepage: http://LRDesign.com
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib/
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: View helpers and defaults for LRD projects.
+test_files: []
+