form_assistant 1.0.0

data/lib/form_assistant/error.rb

@@ -0,0 +1,16 @@
+module RPH
+  module FormAssistant
+    # class used to DRY up error handling
+    class Error < RuntimeError
+      def self.message(msg=nil)
+        msg.nil? ? @message : self.message = msg 
+      end
+      
+      def self.message=(msg)
+        @message = msg 
+      end
+    end
+    
+    # custom errors go here
+  end
+end

data/lib/form_assistant/field_errors.rb

@@ -0,0 +1,27 @@
+module RPH
+  module FormAssistant
+    # extensions for formatting error messages
+    #
+    #   Ex: <%= errors %>
+    #       <%= errors.to_s(:break => true) %>
+    #       <%= errors.to_list %>
+    #       <%= errors.to_list(:class => 'errorz') %>
+    class FieldErrors < Array
+      def to_s(options = {})
+        return self.join('<br />') if options[:break]
+        self.to_sentence
+      end
+  
+      # converts an array into an unordered list
+      def to_list(options = {})
+        css_class = options.delete(:class) || 'errors'
+    
+        list_items = self.inject("") do |items, error|
+          items << "<li>#{error}</li>"
+        end
+    
+        return '<ul class="%s">%s</ul>' % [css_class, list_items]
+      end
+    end
+  end
+end    

data/lib/form_assistant/rules.rb

@@ -0,0 +1,17 @@
+module RPH
+  module FormAssistant
+    private
+      # used to assist generic logic throughout FormAssistant
+      class Rules
+        # used mainly for #concat() so that this plugin will
+        # work with versions of Rails other than edge
+        def self.binding_required?
+          !!( Rails.version < '2.2.0' )
+        end
+        
+        def self.has_I18n_support?
+          !!( Rails.version > '2.2.0' )
+        end
+      end
+  end
+end

data/tasks/form_assistant_tasks.rake

@@ -0,0 +1,18 @@
+desc "copies basic form templates to app/views/forms"
+namespace :form_assistant do
+  task :install do
+    PLUGIN_ROOT = File.join(File.dirname(__FILE__), '..')
+    DESTINATION = File.join(Rails.root, 'app/views', 'forms')
+
+    FileUtils.mkpath(DESTINATION) unless File.directory?(DESTINATION)
+    forms = Dir[File.join(PLUGIN_ROOT, 'forms/*')].select { |f| File.file?(f) }
+    longest_filename = forms.inject([]) { |sizes, f| sizes << f.gsub(PLUGIN_ROOT, '').length }.max
+
+    forms.each do |partial|
+      file_to_copy = File.join(DESTINATION, '/', File.basename(partial))
+      puts " - form_assistant%-#{longest_filename}s copied to %s" %
+        [partial.gsub(PLUGIN_ROOT, ''), DESTINATION.gsub(Rails.root, '')]
+      FileUtils.cp [partial], DESTINATION
+    end
+  end
+end

data/test/forms/_field.html.erb

@@ -0,0 +1,14 @@
+<div class="widget">
+  <div class="label">
+    <%= label %>
+  </div>
+  <div class="tip">
+    <%= tip %>
+  </div>
+  <div class="element">
+    <%= element %>
+  </div>
+  <div class="errors">
+    <%= errors %>
+  </div>
+</div>

data/test/forms/_fieldset.html.erb

@@ -0,0 +1,4 @@
+<h2><%= legend %></h2>
+<div class="fieldset">
+  <%= fields %>
+</div>

data/test/forms/_text_field.html.erb

@@ -0,0 +1,5 @@
+<%= label %>
+<p>
+  <%= element %> <span><%= tip %></span><br />
+  <%= errors %>
+</p>

data/test/forms/_widget.html.erb

@@ -0,0 +1,14 @@
+<div class="widget">
+  <div class="label">
+    <%= label %>
+  </div>
+  <div class="tip">
+    <%= tip %>
+  </div>
+  <div class="element">
+    <%= element %>
+  </div>
+  <div class="errors">
+    <%= errors %>
+  </div>
+</div>

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+ENV["RAILS_ENV"] ||= "test"
+$:.unshift(File.join(File.dirname(__FILE__), *%w[../lib]))
+
+require 'ostruct'
+require 'active_support'
+require 'action_controller'
+# require 'action_controller/test_process'
+# require 'action_view/test_case'
+require 'active_record'
+
+require 'mocha'
+require 'mock_rails'
+require 'form_assistant'
+

data/test/mock_rails.rb

@@ -0,0 +1,27 @@
+unless Object.const_defined?(:Rails)
+  class Rails
+    class << self
+      attr_accessor :root, :version
+
+      def root
+        @root ||= File.dirname(__FILE__)
+      end
+  
+      def version
+        @version ||= '2.2.2'
+      end
+      
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+    
+    class Configuration
+      attr_accessor :view_path
+      
+      def view_path
+        @view_path ||= ''
+      end
+    end
+  end
+end

data/test/test_field_errors.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class FieldErrorsTest < ActiveSupport::TestCase
+  def setup
+    @errors = RPH::FormAssistant::FieldErrors.new(%w(A B C))
+  end
+  
+  test "should return errors as sentence" do
+    assert_equal 'A, B, and C', @errors.to_s
+  end
+  
+  test "should return errors with breaks" do
+    assert_equal 'A<br />B<br />C', @errors.to_s(:break => true)
+  end
+  
+  test "should return errors as list" do
+    assert_equal '<ul class="errors"><li>A</li><li>B</li><li>C</li></ul>',
+      @errors.to_list
+  end
+
+  test "should return errors as list with custom class" do
+    assert_equal '<ul class="problems"><li>A</li><li>B</li><li>C</li></ul>',
+      @errors.to_list(:class => 'problems')
+  end
+end

data/test/test_form_assistant.rb

@@ -0,0 +1,205 @@
+require 'helper'
+
+module FormAssistantHelpers
+  attr_accessor :render_options
+  attr_accessor :view
+  attr_accessor :response
+  
+  def view
+    @view ||= ActionView::Base.new(Rails.configuration.view_path)  
+  end
+  
+  def render(options={})
+    self.render_options = options
+    @response = view.render(options)
+  end
+
+  def locals
+    render_options[:locals] rescue {}
+  end
+
+  def expect_render(expected={})
+    assert_hash_includes expected, render_options
+  end
+  
+  def assert_hash_includes(expected, actual)
+    expected.each do |k, v|
+      assert_equal v, actual[k]
+    end  
+  end
+
+  def expect_locals(expected={})
+    assert_hash_includes expected, locals
+  end    
+
+  def template_root
+    RPH::FormAssistant::FormBuilder.template_root
+  end
+  
+  def template_path(name)
+    File.join(template_root, name) + '.html.erb'
+  end
+end
+
+class AddressBook < ActiveRecord::Base
+  class Column
+    attr_accessor :name, :type
+    def initialize(name, type)
+      @name, @type = name, type
+    end
+  end
+    
+  attr_accessor :first_name, :nickname, 
+    :day, :month, :year, :is_boy,
+    :created_at
+
+  def self.columns
+    {}
+  end
+  
+  def self.columns_hash
+    [ Column.new('first_name', :string),
+      Column.new('is_boy', :boolean),
+      Column.new('created_at', :datetime)
+    ].index_by(&:name)
+  end
+end
+
+class FormAssistantTest < ActionView::TestCase
+  include FormAssistantHelpers
+  include ::RPH::FormAssistant::ActionView
+  attr_accessor :form
+
+  def setup
+    Rails.configuration.view_path = File.expand_path(File.dirname(__FILE__))
+
+    @address_book = AddressBook.new
+    @form = RPH::FormAssistant::FormBuilder.new(:address_book, @address_book, self, {}, nil)
+    RPH::FormAssistant::FormBuilder.template_root = File.expand_path(File.join(File.dirname(__FILE__), 'forms'))
+  end
+  
+  test "should use template based on input type" do
+    form.text_field :first_name
+    expect_render :partial => template_path('text_field')
+  end
+  
+  test "should use fallback template if no specific template is found" do
+    form.text_field :first_name, :template => 'fancy_template_that_does_not_exist'
+    expect_render :partial => template_path(form.fallback_template)
+  end
+  
+  test "should render a valid field" do
+    form.text_field :first_name
+    expect_locals :errors => nil
+  end
+  
+  test "should render an invalid field" do
+    @address_book.errors.add(:first_name, 'cannot be root')
+    form.text_field :first_name
+    expect_locals :errors => ['First name cannot be root']
+    assert_kind_of RPH::FormAssistant::FieldErrors, locals[:errors]
+  end
+ 
+  test "should render a field with a tip" do
+    form.text_field :nickname, :tip => 'What should we call you?'
+    expect_locals :tip => 'What should we call you?' 
+  end
+  
+  test "should render a field without a template" do
+    result = form.text_field(:nickname, :template => false)
+    assert_equal text_field(:address_book, :nickname), result
+  end
+  
+  test "should create fieldset" do
+    fieldset('Information') { "fields-go-here" }
+    expect_render :partial => template_path('fieldset')
+    expect_locals :legend => 'Information',
+      :fields => 'fields-go-here'
+  end
+  
+  test "should support I18n if available" do
+    if Object.const_defined?(:I18n)
+      I18n.backend = I18n::Backend::Simple.new
+      I18n.backend.store_translations 'en', :activerecord => {
+        :attributes => { 
+          :address_book => {
+            :first_name => 'Given name'
+          } 
+        } 
+      }
+      
+      @address_book.errors.add(:first_name, 'cannot be root')
+      @address_book.errors.add(:first_name, 'cannot be admin')
+      form.text_field :first_name
+      expect_locals :errors => ['Given name cannot be root', 'Given name cannot be admin']
+    end
+  end
+  
+  test "should massage error messages when I18n isn't not available" do
+    RPH::FormAssistant::Rules.expects(:has_I18n_support?).returns(false)
+    @address_book.errors.add(:first_name, 'cannot be root')
+    @address_book.errors.add(:first_name, 'cannot be admin')
+    form.text_field :first_name
+    expect_locals :errors => ['First name cannot be root', 'First name cannot be admin']
+  end
+  
+  test "should create widget" do
+    @address_book.errors.add(:birthday, 'is invalid')
+    
+    form.widget :birthday, :tip => 'Enter your birthday' do
+      concat @day   = form.select(:day,   (1..31))
+      concat @month = form.select(:month, (1..12))
+      concat @year  = form.select(:year,  (1975...1985))
+    end
+    
+    expect_locals :element => (@day + @month + @year),
+      :errors => ['Birthday is invalid'],
+      :tip    => 'Enter your birthday',
+      :helper => 'widget'
+    
+    expect_render :partial => template_path('field')  
+  end
+
+  test "should create widget with multiple fields" do
+    @address_book.errors.add(:first_name, 'cannot be root')
+    @address_book.errors.add(:nickname, 'cannot be batman')
+    
+    form.widget([:first_name, :nickname], :label => 'Names') do
+      concat @first_name = form.text_field(:first_name)
+      concat @nickname   = form.text_field(:nickname)
+    end
+
+    expect_locals :element => (@first_name + @nickname),
+      :errors => [
+        'First name cannot be root',
+        'Nickname cannot be batman'
+      ],
+      :helper => 'widget'
+
+    expect_render :partial => template_path('field')
+  end
+  
+  test "should pass extra locals" do
+    form.text_field :first_name, :locals => { :nickname => true }
+    expect_locals :nickname => true
+  end
+  
+  test 'should create proper fields with #input' do
+    form.expects(:text_field).with(:first_name)
+    form.input :first_name
+    
+    form.expects(:check_box).with(:is_boy)
+    form.input :is_boy
+    
+    form.expects(:datetime_select).with(:created_at)
+    form.input :created_at
+  end
+  
+  test 'should create many fields with #inputs' do
+    options = { :required => true }
+    form.expects(:text_field).with(:first_name, options)
+    form.expects(:check_box).with(:is_boy, options)
+    form.expects(:datetime_select).with(:created_at, options)
+    form.inputs :first_name, :is_boy, :created_at, options
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification 
+name: form_assistant
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Heath
+- Chris Scharf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  name: rake
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  name: activesupport
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  name: actionpack
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  name: activerecord
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  type: :development
+  name: rdoc
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  type: :development
+  name: jeweler
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: mocha
+  version_requirements: *id009
+description: Custom form builder that attempts to make your forms friendly
+email: scharfie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- autotest/testunit.rb
+- forms/_check_box.html.erb
+- forms/_field.html.erb
+- forms/_fieldset.html.erb
+- forms/_file_field.html.erb
+- forms/_password_field.html.erb
+- forms/_radio_button.html.erb
+- forms/_text_area.html.erb
+- forms/_text_field.html.erb
+- init.rb
+- install.rb
+- lib/form_assistant.rb
+- lib/form_assistant/error.rb
+- lib/form_assistant/field_errors.rb
+- lib/form_assistant/rules.rb
+- tasks/form_assistant_tasks.rake
+- test/forms/_field.html.erb
+- test/forms/_fieldset.html.erb
+- test/forms/_text_field.html.erb
+- test/forms/_widget.html.erb
+- test/helper.rb
+- test/mock_rails.rb
+- test/test_field_errors.rb
+- test/test_form_assistant.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/scharfie/form_assistant
+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.4.2
+signing_key: 
+specification_version: 3
+summary: Custom form builder that attempts to make your forms friendly
+test_files: []
+