form_cutter 1.0.0

data/README.rdoc

@@ -0,0 +1,107 @@
+== FormCutter
+
+The default rails form builder is great but it is so tedious to change the html that goes around it.
+This gem wraps *your* html around the form elements.  So all you have to do is this:
+
+  <%= f.text_field :name %>
+
+And add your html template in <tt>app/views/forms/text_field.html.erb</tt> like this:
+  
+  <div class="forms">
+    <%= label(object_name, method, label_name) %><em><%= required %></em><br/>
+    <%= text_field(object_name, method, options) %>
+    <% if hint.present? %><p><%= hint %></p><% end %>
+  </div>
+
+== Installation
+
+Install the gem:
+
+  gem install form_cutter
+
+Add it to your Gemfile:
+
+  gem "form_cutter"
+
+Run the generator:
+
+  rails generate form_cutter:install
+
+== Usage
+
+Use the form builders normally, except don't add any markup (unless you want to).
+
+  <%= form_for @post do |f| %>
+    <fieldset>
+      <%= f.text_field :title %>
+      <%= f.text_area :body %>
+      <%= f.select :section, choices %>
+      <%= f.radio_button :am_fm %>
+      <%= f.check_box :terms_and_conditions %>
+    </fieldset>
+    <div class="buttons">
+      <%= f.sumbit 'Save' %>
+    </div>
+  <% end %>
+
+The form builders will now wrap all form helper methods with *your* html.
+
+You're done.
+
+=== Customization
+
+There will always be an exception to the rule.  So there are 2 ways to change the html wrapper.
+1. Like a resource - by creating a directory inside forms/, <tt>app/views/forms/blog/</tt>.
+2. Passing the :template option - either false or the '<tt>path/to/template</tt>'.
+
+It will render the first erb template that it finds.  If you use <tt><%= f.text_field :title, :template => 'custom' %></tt> for the @blog model, it looks in this order:
+* forms/blog/custom.html.erb
+* forms/custom.html.erb
+* forms/custom/title.html.erb
+* forms/custom/text_field.html.erb
+* forms/custom/default.html.erb
+* forms/title.html.erb
+* forms/blog/text_field.html.erb
+* forms/text_field.html.erb
+* forms/default.html.erb
+
+=== One more thing
+
+You can pass <tt>:report => true</tt> and you get an instant view page.
+
+This will search in app/views/reports/ instead of app/views/forms/.
+
+  <%= f.text_field(:title, :report => true) %>
+
+==== Other options
+You can pass any options to the helper methods.  These will become availble in the.
+
+  <%= f.text_field(:title, :hint => 'This is a field hint', :anything => 'anything you want') %>
+
+Will give you:
+
+  <%= hint %>
+  => 'This is a field hint'
+  
+  <%= options[:anything] %>
+  => 'anything you want'
+
+FormCutter has several configuration values. You can read and change them in the initializer created by FormCutter, so if you haven't executed the command below yet, please do:
+
+  rails generate form_cutter:install
+
+== TODO
+
+Please refer to TODO file.
+
+== Maintainers
+
+* Benjamin Lewis (http://github.com/23inhouse)
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
+
+http://github.com/23inhouse/form_cutter/issues
+
+MIT License. Copyright 2010 23inhouse. http://23inhouse.com

data/init.rb

@@ -0,0 +1 @@
+require 'form_cutter'

data/lib/form_cutter/action_view_extensions/builder.rb

@@ -0,0 +1,21 @@
+module FormCutter
+  module ActionViewExtensions
+    module Builder
+      def self.included(base)
+        base.send(:alias_method, :objectify_options_original, :objectify_options)
+        base.send(:remove_method, :objectify_options)
+      end
+      
+    private
+      def objectify_options(options)
+        extended_options = {}
+        extended_options.merge!(:report => @options[:report]) unless @options[:report].nil?
+        extended_options.merge!(:template => @options[:template]) unless @options[:template].nil?
+        extended_options.merge!(options)
+        objectify_options_original(extended_options)
+      end
+    end
+  end
+end
+
+ActionView::Helpers::FormBuilder.send :include, FormCutter::ActionViewExtensions::Builder

data/lib/form_cutter/action_view_extensions/form_helper.rb

@@ -0,0 +1,90 @@
+module FormCutter
+  module ActionViewExtensions
+    module FormHelper
+      different_methods = ['form_for', 'apply_form_for_options!', 'fields_for', 'label', 'check_box', 'radio_button']
+      (ActionView::Helpers::FormHelper.instance_method_names - different_methods).each do |helper_method_name|
+        module_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{helper_method_name}(object_name, method, options = {})
+            begin
+              raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
+              render(:template => template_file(object_name, method, options, '#{helper_method_name}'), :locals => locals(object_name, method, '#{helper_method_name}', options))
+            rescue ActionView::MissingTemplate
+              super
+            end
+          end
+        METHOD
+      end
+      
+      def check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+        begin
+          raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
+          render(:template => template_file(object_name, method, options, :check_box), :locals => locals(object_name, method, :check_box, options))
+        rescue ActionView::MissingTemplate
+          super
+        end
+      end
+      
+      def radio_button(object_name, method, tag_value, options = {})
+        begin
+          raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
+          render(:template => template_file(object_name, method, options, :radio_button), :locals => locals(object_name, method, :radio_button, options))
+        rescue ActionView::MissingTemplate
+          super
+        end
+      end
+      
+    private
+      
+      def locals(object_name, method, helper_method_name, options, content = nil)
+        options[:required] = options[:object].class.validators_on(method).map(&:class).include? ActiveModel::Validations::PresenceValidator if options[:required].nil?
+        options[:required] = (options[:required] == true) ? I18n.t(:"form_cutter.required.mark", :default => '*') : ''
+        
+        locals = { :object => options[:object], :object_name => object_name, :method => method, :helper_method_name => helper_method_name, :options => options }
+        locals.merge!({:hint => (options.delete(:hint) || '').html_safe})
+        locals.merge!({:label_name => options.delete(:label)})
+        locals.merge!({:report => options.delete(:report)})
+        locals.merge!({:required => options.delete(:required)})
+        locals.merge!({:template => options.delete(:template)})
+        locals
+      end
+      
+      def template_file(object_name, method, options, helper_method_name)
+        resource = options[:object].class.to_s.pluralize.downcase
+        template = options.delete(:template) || '..'
+        
+        template_path = ActionView::PathSet.new(Array.wrap('app/views'))
+        details = {:locale => [:en, :en], :formats => [:html], :handlers => [:erb, :rjs, :builder, :rhtml, :rxml]}
+        path = base_template_path(options)
+        [
+          [path, resource, template].join('/'),            # forms/blog/custom.html.erb
+          [path, template].join('/'),                      # forms/custom.html.erb
+          [path, template, method.to_s].join('/'),         # forms/custom/title.html.erb
+          [path, template, helper_method_name].join('/'),  # forms/custom/text_field.html.erb
+          [path, template, 'default'].join('/'),           # forms/custom/default.html.erb
+          [path, resource, method.to_s].join('/'),         # forms/title.html.erb
+          [path, resource, helper_method_name].join('/'),  # forms/blog/text_field.html.erb
+          [path, helper_method_name].join('/'),            # forms/text_field.html.erb
+          [path, 'default'].join('/')                      # forms/default.html.erb
+        ].find { |template_file| template_path.exists?(template_file, '', false, details) } || '..'
+      end
+      
+      def base_template_path(options)
+        report?(options) ? FormCutter.reports_path : FormCutter.forms_path
+      end
+      
+      def report?(options)
+        options[:report]
+      end
+      
+      def template?(options)
+        !(options[:template] == false)
+      end
+      
+      def template_error
+        ActionView::MissingTemplate.new([], '1', '2', '3') # this will never be shown, it will be rescued by super
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, FormCutter::ActionViewExtensions::FormHelper

data/lib/form_cutter/version.rb

@@ -0,0 +1,3 @@
+module FormCutter
+  VERSION = "1.0.0".freeze
+end

data/lib/form_cutter.rb

@@ -0,0 +1,18 @@
+require 'action_view'
+require 'form_cutter/action_view_extensions/form_helper'
+require 'form_cutter/action_view_extensions/builder'
+
+module FormCutter
+  # Default form and report template paths
+  mattr_accessor :forms_path
+  @@forms_path = 'forms'
+
+  mattr_accessor :reports_path
+  @@reports_path = 'reports'
+  
+  # Default way to setup FormCutter. Run rails generate form_cutter:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+end

data/lib/generators/form_cutter/USAGE

@@ -0,0 +1,3 @@
+To copy a FormCutter initializer to your Rails App, with some configuration values, just do:
+
+    rails generate form_cutter:install

data/lib/generators/form_cutter/install_generator.rb

@@ -0,0 +1,26 @@
+module FormCutter
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy FormCutter default files"
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :template_engine
+
+      def copy_initializers
+        copy_file 'form_cutter.rb', 'config/initializers/form_cutter.rb'
+      end
+
+      def copy_templates
+        copy_file 'default.html.erb', 'app/views/forms/default.html.erb'
+      end
+
+      def copy_locale_file
+        copy_file 'en.yml', 'config/locales/form_cutter.en.yml'
+      end
+
+      def copy_scaffold_template
+        engine = options[:template_engine]
+        copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
+      end
+    end
+  end
+end

data/lib/generators/form_cutter/templates/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= form_for(@<%= singular_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

data/lib/generators/form_cutter/templates/_form.html.haml

@@ -0,0 +1,18 @@
+= form_cutter_for(@<%= singular_name %>) do |f|
+  - if @<%= singular_name %>.errors.any?
+    #error_explanation
+      %h2
+        = pluralize(@<%= singular_name %>.errors.count, "error")
+        prohibited this <%= singular_name %> from being saved:
+
+      %ul
+      - @<%= singular_name %>.errors.full_messages.each do |msg|
+        %li= msg
+
+  .inputs
+  <%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+  <%- end -%>
+
+  .actions
+    = f.button :submit

data/lib/generators/form_cutter/templates/default.html.erb

@@ -0,0 +1,5 @@
+<div class="forms">
+  <%= label(object_name, method, label_name) %><em><%= required %></em><br/>
+  <%= send(helper_method_name, object_name, method, options) %>
+  <% if hint.present? %><p><%= hint %></p><% end %>
+</div>

data/lib/generators/form_cutter/templates/en.yml

@@ -0,0 +1,4 @@
+en:
+  form_cutter:
+    required:
+      mark: '*'

data/lib/generators/form_cutter/templates/form_cutter.rb

@@ -0,0 +1,6 @@
+# Use this setup block to configure all options available in FormCutter.
+FormCutter.setup do |config|
+  # template paths
+  config.forms_path = 'forms'     # app/views/forms
+  config.reports_path = 'reports' # app/views/reports
+end

data/test/action_view_extensions/form_helper_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class FormHelperTest < ActionView::TestCase
+  
+  test 'a template was rendered' do
+    concat(form_for(:user, :url => '/account', :html => { :id => 'my_form' }) do |f|
+      f.text_field(:name)
+    end)
+    assert_template 'hi/there'
+  end
+end

data/test/form_cutter_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class FormCutterTest < ActiveSupport::TestCase
+  test 'setup block yields self' do
+    FormCutter.setup do |config|
+      assert_equal FormCutter, config
+    end
+  end
+end

data/test/support/misc_helpers.rb

@@ -0,0 +1,31 @@
+module MiscHelpers
+  def store_translations(locale, translations, &block)
+    begin
+      I18n.backend.store_translations locale, translations
+      yield
+    ensure
+      I18n.reload!
+    end
+  end
+
+  def assert_no_select(selector, value = nil)
+    assert_select(selector, :text => value, :count => 0)
+  end
+
+  def swap(object, new_values)
+    old_values = {}
+    new_values.each do |key, value|
+      old_values[key] = object.send key
+      object.send :"#{key}=", value
+    end
+    yield
+  ensure
+    old_values.each do |key, value|
+      object.send :"#{key}=", value
+    end
+  end
+
+  def with_concat_form_for(object, &block)
+    concat form_cutter_for(object, &block)
+  end
+end

data/test/support/mock_controller.rb

@@ -0,0 +1,15 @@
+class MockController
+  attr_accessor :action_name
+
+  def _routes
+    self
+  end
+
+  def action_name
+    @action_name || "edit"
+  end
+
+  def url_for(*args)
+    "http://example.com"
+  end
+end

data/test/support/mock_response.rb

@@ -0,0 +1,14 @@
+class MockResponse
+
+  def initialize(test_case)
+    @test_case = test_case
+  end
+
+  def content_type
+    'text/html'
+  end
+
+  def body
+    @test_case.send :output_buffer
+  end
+end

data/test/support/models.rb

@@ -0,0 +1,133 @@
+require 'ostruct'
+
+Column = Struct.new(:name, :type, :limit)
+Association = Struct.new(:klass, :name, :macro, :options)
+
+class Company < Struct.new(:id, :name)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+
+  def self.all(options={})
+    all = (1..3).map{|i| Company.new(i, "Company #{i}")}
+    return [all.first] if options[:conditions].present?
+    return [all.last]  if options[:order].present?
+    return all[0..1] if options[:include].present?
+    return all[1..2] if options[:joins].present?
+    all
+  end
+
+  def self.merge_conditions(a, b)
+    (a || {}).merge(b || {})
+  end
+
+  def persisted?
+    true
+  end
+end
+
+class Tag < Company
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+
+  def self.all(options={})
+    (1..3).map{|i| Tag.new(i, "Tag #{i}")}
+  end
+end
+
+class User
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+
+  attr_accessor :id, :name, :company, :company_id, :time_zone, :active, :description, :created_at, :updated_at,
+    :credit_limit, :age, :password, :delivery_time, :born_at, :special_company_id, :country, :url, :tag_ids,
+    :avatar, :email, :status, :residence_country, :phone_number
+
+  def initialize(options={})
+    options.each do |key, value|
+      send("#{key}=", value)
+    end if options
+  end
+
+  def new_record!
+    @new_record = true
+  end
+
+  def persisted?
+    !(@new_record || false)
+  end
+
+  def company_attributes=(*)
+  end
+
+  def column_for_attribute(attribute)
+    column_type, limit = case attribute.to_sym
+      when :name, :status, :password then [:string, 100]
+      when :description   then :text
+      when :age           then :integer
+      when :credit_limit  then [:decimal, 15]
+      when :active        then :boolean
+      when :born_at       then :date
+      when :delivery_time then :time
+      when :created_at    then :datetime
+      when :updated_at    then :timestamp
+    end
+    Column.new(attribute, column_type, limit)
+  end
+
+  def self.human_attribute_name(attribute)
+    case attribute
+      when 'name'
+        'Super User Name!'
+      when 'description'
+        'User Description!'
+      when 'company'
+        'Company Human Name!'
+      else
+        attribute.humanize
+    end
+  end
+
+  def self.reflect_on_association(association)
+    case association
+      when :company
+        Association.new(Company, association, :belongs_to, {})
+      when :tags
+        Association.new(Tag, association, :has_many, {})
+      when :first_company
+        Association.new(Company, association, :has_one, {})
+      when :special_company
+        Association.new(Company, association, :belongs_to, { :conditions => { :id => 1 } })
+    end
+  end
+
+  def errors
+    @errors ||= begin
+      hash = Hash.new { |h,k| h[k] = [] }
+      hash.merge!(
+        :name => ["can't be blank"],
+        :description => ["must be longer than 15 characters"],
+        :age => ["is not a number", "must be greater than 18"],
+        :company => ["company must be present"],
+        :company_id => ["must be valid"]
+      )
+    end
+  end
+end
+
+class ValidatingUser < User
+  include ActiveModel::Validations
+  validates :name, :presence => true
+  validates :company, :presence => true
+  validates_numericality_of :age,
+    :greater_than_or_equal_to => 18,
+    :less_than_or_equal_to => 99,
+    :only_integer => true
+end
+
+class OtherValidatingUser < User
+  include ActiveModel::Validations
+  validates_numericality_of :age,
+    :greater_than => 17,
+    :less_than => 100,
+    :only_integer => true
+end

data/test/test_helper.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+
+require 'test/unit'
+require 'mocha'
+
+require 'active_model'
+require 'action_controller'
+require 'action_view'
+require 'action_view/template'
+require 'action_view/test_case'
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'form_cutter'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+I18n.default_locale = :en
+
+country_select = "#{File.dirname(__FILE__)}/support/country_select/lib"
+
+# if File.exists?(country_select)
+#   $:.unshift country_select
+#   require 'country_select'
+# else
+#   raise "Could not find country_select plugin in test/support. Please execute git submodule update --init."
+# end
+
+class FormCutter::FormBuilder
+  attr_accessor :attribute_name, :column, :reflection, :input_type, :options
+end
+
+class ActionView::TestCase
+  include MiscHelpers
+  include FormCutter::ActionViewExtensions::FormHelper
+  
+  setup :set_controller
+  setup :set_response
+  setup :setup_new_user
+
+  def set_controller
+    @controller = MockController.new
+  end
+
+  def set_response
+    @response = MockResponse.new(self)
+  end
+
+  def setup_new_user(options={})
+    @user = User.new({
+      :id => 1,
+      :name => 'New in Form Cutter!',
+      :description => 'Hello!',
+      :created_at => Time.now
+    }.merge(options))
+
+    @validating_user = ValidatingUser.new({
+      :id => 1,
+      :name => 'New in Form Cutter!',
+      :description => 'Hello!',
+      :created_at => Time.now,
+      :age => 19,
+      :company => 1
+    }.merge(options))
+
+    @other_validating_user = OtherValidatingUser.new({
+      :id => 1,
+      :name => 'New in Form Cutter!',
+      :description => 'Hello!',
+      :created_at => Time.now,
+      :age => 19,
+      :company => 1
+    }.merge(options))
+  end
+
+  def protect_against_forgery?
+    false
+  end
+
+  def user_path(*args)
+    '/users'
+  end
+  alias :users_path :user_path
+  alias :super_user_path :user_path
+  alias :validating_user_path :user_path
+  alias :other_validating_user_path :user_path
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: form_cutter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Benjamin Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-22 00:00:00 +10:30
+default_executable: 
+dependencies: []
+
+description: Lets you wrap your form helper methods is custom html
+email: 23inhouse@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- init.rb
+- lib/form_cutter.rb
+- lib/form_cutter/action_view_extensions/builder.rb
+- lib/form_cutter/action_view_extensions/form_helper.rb
+- lib/form_cutter/version.rb
+- lib/generators/form_cutter/USAGE
+- lib/generators/form_cutter/install_generator.rb
+- lib/generators/form_cutter/templates/_form.html.erb
+- lib/generators/form_cutter/templates/_form.html.haml
+- lib/generators/form_cutter/templates/default.html.erb
+- lib/generators/form_cutter/templates/en.yml
+- lib/generators/form_cutter/templates/form_cutter.rb
+- README.rdoc
+- test/action_view_extensions/form_helper_test.rb
+- test/form_cutter_test.rb
+- test/support/misc_helpers.rb
+- test/support/mock_controller.rb
+- test/support/mock_response.rb
+- test/support/models.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/23inhouse/form_cutter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      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: Forms made templatable!
+test_files: 
+- test/action_view_extensions/form_helper_test.rb
+- test/form_cutter_test.rb
+- test/support/misc_helpers.rb
+- test/support/mock_controller.rb
+- test/support/mock_response.rb
+- test/support/models.rb
+- test/test_helper.rb