formative 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "actionpack"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Rehfeld
+
+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,77 @@
+= Formative
+
+Formative is an extraction of the custom form builder I used in my last couple of Rails projects. It is the simplest thing that could possibly work for me. YMMV.
+
+I am packaging this as a gem mainly for my personal use. So do not expect this to be any of well-documented, stable or refined.
+
+== Usage
+
+I am using Formative together with this initializer to enable inline error messages:
+
+  # Show error messages next to form field labels
+  ActionView::Base.field_error_proc = Proc.new {|html_tag, instance_tag|
+    if html_tag =~ /type="hidden"/ || !(html_tag =~ /<label/)
+      html_tag
+    else
+      %(<span class="field-with-errors">#{html_tag} <span class="error-message">#{[instance_tag.error_message].flatten.first}</span></span>).html_safe
+    end
+  }
+
+Then just use `Formative::FormBuilder` as your builder -- here is an example form (haml):
+
+  = form_for :resource, :builder => Formative::FormBuilder do |f|
+    %fieldset
+      %legend Request Form
+
+      = f.text_field :bananas, :unit => 'kg'
+                     :hint => 'Enter the amount of bananas in kg you would like to eat right now'
+
+    .controls
+      = f.submit 'Request', :disable_with => 'Request'
+      %p.cancel= link_to 'Cancel', resource_path(@resource)
+
+The generated markup would look something like this:
+
+  <form action="/resource" method="post">
+    <fieldset>
+      <legend>Request Form</legend>
+
+      <p class="field text-field bananas">
+        <label for="resource_bananas">Bananas</label>
+        <input id="resource_bananas" name="resource[bananas]" type="text">
+        <span class="unit">kg</span>
+        <span class="hint">Enter the amount of bananas in kg you would like to eat right now</span>
+      </p>
+    </fieldset>
+
+    <div class="controls">
+      <input data-disable-with="Request" id="resource_submit" name="commit" type="submit" value="Request">
+      <p class="cancel">
+        <a href="/resource">Cancel</a>
+      </p>
+    </div>
+  </form>
+
+You can customize the markup for each field with these options:
+
+   Option         Default         Possible Value(s)
+   :wrapper       :p              Symbol to specify alternate tag or false to suppress wrapper
+   :label         true            false to suppress label
+   :required      false/auto      true will add "required" as a class to the label
+   :label_class   auto            specify a class for the label directly
+   :hint          false           hint text
+   :unit          false           unit text
+
+== Contributing to formative (if you want to help make it a real Gem)
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Martin Rehfeld. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "formative"
+  gem.homepage = "http://github.com/martinrehfeld/formative"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple yet useful form builder for Rails 2 and 3}
+  gem.description = %Q{Formative is an extraction of the custom form builder I used in my last couple of Rails projects. It is the simplest thing that could possibly work for me. YMMV.}
+  gem.email = "martin.rehfeld@glnetworks.de"
+  gem.authors = ["Martin Rehfeld"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/formative.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{formative}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Rehfeld"]
+  s.date = %q{2011-02-17}
+  s.description = %q{Formative is an extraction of the custom form builder I used in my last couple of Rails projects. It is the simplest thing that could possibly work for me. YMMV.}
+  s.email = %q{martin.rehfeld@glnetworks.de}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "formative.gemspec",
+    "init.rb",
+    "lib/formative.rb",
+    "lib/formative/form_builder.rb",
+    "rails/init.rb",
+    "spec/form_builder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/martinrehfeld/formative}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple yet useful form builder for Rails 2 and 3}
+  s.test_files = [
+    "spec/form_builder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionpack>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'formative'

data/lib/formative.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Formative
+  autoload :FormBuilder, "formative/form_builder"
+end

data/lib/formative/form_builder.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Formative
+  class FormBuilder < ::ActionView::Helpers::FormBuilder
+
+    %w[text_field select collection_select password_field text_area date_select].each do |method_name|
+      define_method(method_name) do |field_name, *args|
+        content_tag(wrapper(*args), (field_label(field_name, *args) + super(field_name, *args) + unit(*args) + hint(*args)).html_safe, :class => wrapper_class(method_name, field_name))
+      end
+    end
+
+    def check_box(field_name, options = {}, checked_value = "1", unchecked_value = "0")
+      content_tag(wrapper(options), super + field_label(field_name, options) + unit(options) + hint(options).html_safe, :class => wrapper_class('check_box', field_name))
+    end
+
+    def submit(*args)
+      options = filter_custom_options(args.extract_options!)
+      super(args, options)
+    end
+
+    private
+
+      def content_tag(tag, content, *args)
+        return content unless tag
+        @template.content_tag(tag, content, *args)
+      end
+
+      def field_label(field_name, *args)
+        options = args.extract_options!
+        return '' if options[:label] == false
+        options.reverse_merge!(:required => field_required?(field_name))
+        options[:label_class] = 'required' if options[:required]
+        label(field_name, options[:label], :class => options[:label_class])
+      end
+
+      def hint(*args)
+        options = args.extract_options!
+        return '' if options[:hint] == false || options[:hint].blank?
+        content_tag(:span, options[:hint], :class => 'hint')
+      end
+
+      def unit(*args)
+        options = args.extract_options!
+        return '' if options[:unit] == false || options[:unit].blank?
+        content_tag(:span, options[:unit], :class => 'unit')
+      end
+
+      def field_required?(field_name)
+        object.class.reflect_on_validations_for(field_name).map(&:macro).include?(:validates_presence_of) if object.class.respond_to?(:reflect_on_validations_for)
+      end
+
+      def wrapper(*args)
+        options = args.extract_options!
+        options[:wrapper] == false ? nil : (options[:wrapper] || :p)
+      end
+
+      def wrapper_class(method_name, field_name)
+        "field #{method_name.to_s.dasherize} #{field_name.to_s.dasherize}"
+      end
+
+      def objectify_options(options)
+        filter_custom_options(super)
+      end
+
+      def filter_custom_options(options)
+        options.except(:label, :required, :label_class, :wrapper, :hint, :unit)
+      end
+
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "init"))

data/spec/form_builder_spec.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Formative::FormBuilder do
+
+  include FormativeSpecHelper
+
+  let(:template) { mock_template }
+  let(:model) { mock('model', :attribute => 'THE_VALUE') }
+
+  subject { Formative::FormBuilder.new(:model, model, template, {}, Proc.new {}) }
+
+  {
+    :select => [ [] ],
+    :text_field => [],
+    :collection_select => [ [Struct.new(:value, :text).new], :value, :text ],
+    :password_field => [],
+    :text_area => [],
+    :check_box => [],
+    :submit => []
+  }.each_pair do |builder_method, additional_args|
+
+    describe "##{builder_method}" do
+      let(:args) { [builder_method, :attribute].concat additional_args }
+
+      unless builder_method == :submit
+        it 'should output a default wrapper' do
+          subject.send(*args).should =~ /^<p.*\/p>$/
+        end
+
+        it 'should output a given wrapper' do
+          subject.send(*(args << {:wrapper => :div})).should =~ /^<div.*\/div>$/
+        end
+
+        it 'should add "field <method_name> <field_name>" as class of wrapper' do
+          subject.send(*args).should =~ /^<p class="field #{builder_method.to_s.dasherize} attribute"/
+        end
+
+        it 'should output a proper label' do
+          subject.send(*args).should =~ /<label for="model_attribute".*\/label>/
+        end
+
+        it 'should output a given unit' do
+          subject.send(*(args << {:unit => 'the unit'})).should =~ /<span class="unit">the unit<\/span>/
+        end
+
+        it 'should output a given hint' do
+          subject.send(*(args << {:hint => 'additional information'})).should =~ /<span class="hint">additional information<\/span>/
+        end
+      end
+
+      context ":wrapper => false" do
+        let(:no_wrapper_args) { args << {:wrapper => false} }
+
+        it 'should not output a wrapper' do
+          subject.send(*no_wrapper_args).should_not =~ /^<p/
+          subject.send(*no_wrapper_args).should_not =~ /\/p>$/
+        end
+
+        it 'should not output the wrapper option into the tag attributes' do
+          subject.send(*no_wrapper_args).should_not =~ /wrapper\s*=/
+        end
+      end
+
+      context ":label => false" do
+        let(:no_label_args) { args << {:label => false} }
+
+        it 'should not output a label' do
+          subject.send(*no_label_args).should_not =~ /<label/
+          subject.send(*no_label_args).should_not =~ /\/label>/
+        end
+
+        it 'should not output the label option into the tag attributes' do
+          subject.send(*no_label_args).should_not =~ /label\s*=/
+        end
+      end
+
+      context ":hint => false" do
+        let(:no_hint_args) { args << {:hint => false} }
+
+        it 'should not output a hint' do
+          subject.send(*no_hint_args).should_not =~ /<\w+ class="hint"/
+        end
+
+        it 'should not output the hint option into the tag attributes' do
+          subject.send(*no_hint_args).should_not =~ /hint\s*=/
+        end
+      end
+
+      context ":unit => false" do
+        let(:no_unit_args) { args << {:unit => false} }
+
+        it 'should not output a unit' do
+          subject.send(*no_unit_args).should_not =~ /<\w+ class="unit"/
+        end
+
+        it 'should not output the unit option into the tag attributes' do
+          subject.send(*no_unit_args).should_not =~ /unit\s*=/
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'action_view'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'formative'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end
+
+module FormativeSpecHelper
+
+  def mock_template
+    t = Object.new
+
+    class << t
+      include ActionView::Helpers
+    end
+
+    t
+  end
+
+end
+
+::ActiveSupport::Deprecation.silenced = false

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: formative
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Martin Rehfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Formative is an extraction of the custom form builder I used in my last couple of Rails projects. It is the simplest thing that could possibly work for me. YMMV.
+email: martin.rehfeld@glnetworks.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- formative.gemspec
+- init.rb
+- lib/formative.rb
+- lib/formative/form_builder.rb
+- rails/init.rb
+- spec/form_builder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/martinrehfeld/formative
+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: 4206223225746873947
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple yet useful form builder for Rails 2 and 3
+test_files: 
+- spec/form_builder_spec.rb
+- spec/spec_helper.rb