midas-ul_form_builder 1.0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.1 2009-03-11
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/ul_form_builder.rb
+lib/ul_form_builder/form_builders.rb
+lib/ul_form_builder/form_helpers.rb
+script/console
+script/destroy
+script/generate
+spec/spec.opts
+spec/spec_helper.rb
+spec/ul_form_builder_spec.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,3 @@
+
+
+

data/README.rdoc

@@ -0,0 +1,83 @@
+= ul_form_builder
+
+http://github.com/midas/ul_form_builder/tree/master
+
+
+== DESCRIPTION:
+
+A Rails form builder and helpers that will render a form wrapped in ul tags, with fields wrapped in li tags.  Also generates a
+label with the human friendly name for the field.  In addition it generates a note span and puts the hint defined in attr_human_hint
+(added to ActiveRecord by Guilded (http://github.com/midas/guilded/tree/master))
+
+
+== FEATURES/PROBLEMS:
+
+* Builds a form wrapped in ul tags with fields wrapped in li tags
+* Creates a label for the field automatically adds the human name defined by attr_human_name
+* Creates a note span and automatically adds the human hint defined by attr_human_hint (added to Activerecord by Guidled (http://github.com/midas/guilded/tree/master))
+
+== SYNOPSIS:
+
+new.html.erb:
+
+  <% ul_form_for @item do |f| %>
+	  <%= render :partial => 'form', :locals => { :f => f }  %>
+	  <li><%= f.submit 'Create Item' %></li>
+	<% end %>
+	
+_form.html.erb:
+
+  <%= f.text_field :name %>
+	
+results:
+
+  <form id="new_item" method="post" action="items">
+	  <div style="margin: 0pt; padding: 0pt;"></div>
+	  <ul>
+	    <li>
+	      <label for="item_name">Name</label>
+	      <input id="item_name" type="text" size="65" name="item[name]" label="Name"/>
+	      <span class="note"/>
+	    </li>
+	  </ul>
+	</form>
+
+
+== REQUIREMENTS:
+
+* Rails >= 2.2.0
+* Guilded >= 0.0.7 (http://github.com/midas/guilded/tree/master)
+
+
+== INSTALL:
+
+  sudo gem install midas-ul_form_builder
+
+Rails environment.rb file:
+
+  config.gem 'midas-ul_form_builder', :version => '1.0.0', :lib => 'ul_form_builder', :source => 'http://gems.github.com'
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/ul_form_builder'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('ul_form_builder', UlFormBuilder::VERSION) do |p|
+  p.developer('C. Jason Harrelson (midas)', 'jason@lookforwardenterprises.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['rails', ">= 2.2.0"],
+    ['guilded', ">= 0.0.7"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/ul_form_builder/form_builders.rb

@@ -0,0 +1,113 @@
+require 'action_view/helpers/form_helper'
+
+module UlFormBuilder
+  module FormBuilders
+
+    class GUnorderedListFormBuilder < ActionView::Helpers::FormBuilder
+      helpers = field_helpers +
+                %w{date_select datetime_select time_select} +
+                %w{collection_select select country_select time_zone_select} -
+                %w{hidden_field label fields_for} # Don't decorate these
+      
+      helpers.each do |name|
+        define_method( name ) do |field, *args|
+          options = args.extract_options!
+          
+          label = ""
+          if !options.nil? && options.has_key?( :label )
+            label = ( opts.respond_to?( :delete ) ? opts.delete( :label ) : nil )
+          else
+            begin
+              label = self.object.class.human_attribute_name( field )
+            rescue => ex
+              label = field.to_s.humanize.titleize if ex.is_a? NoMethodError
+            end
+          end
+          
+          options.merge! :label => label unless options.has_key?( :label )
+          options.merge!( :class => 'frm-standard' ) unless options.has_key?( :class )
+          label = label( field, options[:label], :class => options.delete( :label_class ) )
+          if self.object.class.respond_to?( :human_attribute_hint )
+            hint = @template.content_tag( :span, self.object.class.human_attribute_hint( field.to_sym ), :class => 'note' )
+          else
+            hint = @template.content_tag( :span, (options[:hint] || ''), :class => 'note' )
+          end
+          @template.content_tag( :li, label + super( field, options ) + hint, :class => options[:li_class] )  #wrap with an li 
+        end
+      end
+      
+      def select( method, choices, options={}, html_options={} )
+        label = resolve_label( method, options )
+        hint = resolve_hint( options, self.object, method )
+        label_class = resolve_label_class( options )
+        field_id = resolve_field_id( method )
+        merge_standard_class( html_options )
+
+        super_out = super
+        do_output( method, field_id, label, label_class, hint, super_out )
+      end
+      
+      def collection_select( method, collection, value_method, text_method, options={}, html_options={} )
+        label = resolve_label( method, options )
+        hint = resolve_hint( options, self.object, method )
+        label_class = resolve_label_class( options )
+        field_id = resolve_field_id( method )
+        merge_standard_class( html_options )
+
+        super_out = super
+        do_output( method, field_id, label, label_class, hint, super_out )
+      end
+      
+      def time_zone_select( method, priority_zones=nil, options={}, html_options={} )
+        label = resolve_label( method, options )
+        hint = resolve_hint( options, self.object, method )
+        label_class = resolve_label_class( options )
+        field_id = resolve_field_id( method )
+        merge_standard_class( html_options )
+
+        super_out = super
+        do_output( method, field_id, label, label_class, hint, super_out )
+      end
+      
+    private
+      
+      def resolve_label( field, opts )
+        label = ""
+        if !opts.nil? && opts.has_key?( :label )
+          label = ( opts.respond_to?( :delete ) ? opts.delete( :label ) : nil )
+        else
+          begin
+            label = self.object.class.human_attribute_name( field )
+          rescue => ex
+            label = field.to_s.humanize.titleize if ex.is_a? NoMethodError
+          end
+        end
+        
+        return label
+      end
+      
+      def resolve_field_id( field )
+        CGI.escapeHTML( [self.object_name, field].join( '_' ).downcase )
+      end
+      
+      def resolve_label_class( opts )
+        ( opts.respond_to?( :delete ) ? opts.delete( :label_class ) : nil )
+      end
+      
+      def resolve_hint( opts, obj, field )
+        obj.class.human_attribute_hint( field.to_sym ) || ( opts.respond_to?( :delete ) ? opts.delete( :hint ) : '' )
+      end
+      
+      def merge_standard_class( opts )
+        opts.merge!( :class => 'frm-standard' ) unless opts.has_key?( :class )
+      end
+      
+      def do_output( field, field_id, label, label_class, hint, super_out )
+        "<li><label class=\"#{field} #{field_id} #{label_class}\" for=\"#{field_id}\"" +
+          ">#{label}</label>#{super_out}<span class=\"note\">" + 
+          "#{hint}</span></li>"
+      end
+    end
+    
+  end
+end

data/lib/ul_form_builder/form_helpers.rb

@@ -0,0 +1,42 @@
+module UlFormBuilder
+  module FormHelpers
+    
+    def ul_form_for( record_or_name_or_array, *args, &proc )
+      raise ArgumentError, "Missing block" unless block_given?
+
+      options = args.extract_options!
+      options.merge!( :builder => ActionView::Base::GUnorderedListFormBuilder )
+      
+      case record_or_name_or_array
+        when String, Symbol
+          object_name = record_or_name_or_array
+        when Array
+          object = record_or_name_or_array.last
+          object_name = ActionController::RecordIdentifier.singular_class_name( object )
+          apply_form_for_options!( record_or_name_or_array, options )
+          args.unshift object
+        else
+          object = record_or_name_or_array
+          object_name = ActionController::RecordIdentifier.singular_class_name( object )
+          apply_form_for_options!( [object], options )
+          args.unshift object
+      end
+      
+      html_options = options.delete( :html ) || {}
+      html_options.merge!( :class => options.delete( :class ) )
+
+      concat( form_tag( options.delete( :url ) || {}, html_options || {} ) )
+      concat( "<ul>" )
+      fields_for( object_name, *(args << options), &proc )
+      concat( "</ul>" )
+      concat( '</form>' )
+    end
+    
+    def ul_fields_for( record_or_name_or_array, *args, &proc )
+      options = args.extract_options!
+      options.merge!( :builder => ActionView::Base::GUnorderedListFormBuilder )
+      fields_for( record_or_name_or_array, *(args << options), &proc )
+    end
+    
+  end
+end

data/lib/ul_form_builder.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'ul_form_builder/form_builders'
+require 'ul_form_builder/form_helpers'
+
+module UlFormBuilder
+  VERSION = '1.0.1'
+end
+
+if defined?( ActionView::Base )
+  ActionView::Base.send( :include, UlFormBuilder::FormBuilders ) unless ActionView::Base.include?( UlFormBuilder::FormBuilders )
+  ActionView::Base.send( :include, UlFormBuilder::FormHelpers ) unless ActionView::Base.include?( UlFormBuilder::FormHelpers )
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ul_form_builder.rb'}"
+puts "Loading ul_form_builder gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'ul_form_builder'

data/spec/ul_form_builder_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: midas-ul_form_builder
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- C. Jason Harrelson (midas)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: guilded
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A Rails form builder and helpers that will render a form wrapped in ul tags, with fields wrapped in li tags.  Also generates a label with the human friendly name for the field.  In addition it generates a note span and puts the hint defined in attr_human_hint (added to ActiveRecord by Guilded (http://github.com/midas/guilded/tree/master))
+email: 
+- jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/ul_form_builder.rb
+- lib/ul_form_builder/form_builders.rb
+- lib/ul_form_builder/form_helpers.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/ul_form_builder_spec.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/midas/ul_form_builder/tree/master
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ul_form_builder
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails form builder and helpers that will render a form wrapped in ul tags, with fields wrapped in li tags
+test_files: []
+