formal 0.0.3 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d21e6d5dc193f7af782330e988253ee219c397a2
+  data.tar.gz: 88b86cdb027538447a1f5de3a9d5e6904dc833f3
+SHA512:
+  metadata.gz: 28b44ea81f3b987682da5b265d7a09577d0c7bb0a270b1f799761672e01400047d2391fe6eef4affd7b1b461edce48c3ee400012e807052b5f57c6628efff993
+  data.tar.gz: ebd8ca726289c489b8f2581e8ec3e8f82061fd41a544dc001fd3b71f56d2b01a32741bdff2b3197cd263b23f76ceba948e92953f0835ad151d03be3f44560dc8

data/README.md

@@ -1,5 +1,9 @@
 # Formal
 
+[![Gem Version](https://badge.fury.io/rb/formal.png)](http://badge.fury.im/rb/formal)
+[![Build Status](https://travis-ci.org/mrmicahcooper/formal.png?branch=master)](https://travis-ci.org/mrmicahcooper/formal)
+[![Code Climate](https://codeclimate.com/github/mrmicahcooper/formal.png)](https://codeclimate.com/github/mrmicahcooper/formal)
+
 Formal is simply a form builder that provides the markup we typically use
 around form fields on Hashrocket projects.
 
@@ -19,68 +23,28 @@ Or install it yourself as:
 
 ## Usage
 
-Specify the builder option in your form_for parameters
+Specify the builder option in your `form_for` parameters
 
 ```ruby
-= form_for post, builder: Formal::Builder do |f| 
+form_for(obj, builder: Formal::FormBuilder)
 ```
 
+### Label
 
-```f.label``` gets wrapped in a ```<dt>``` or a ```<dt class="error">```(wherethere is an error)
-
-
-The following get wrapped in a ```<dd>``` or a ```<dd class="error">```:
-
-```ruby
-f.text_field
-f.password_field
-f.text_area
-f.select
-f.email_field
-f.search_field
-f.telephone_field
-f.number_field
-f.file_field
-f.range_field
-```
+Label is created with error messaging within `label` element
 
-__Example:__
+Example:
 
 ```ruby
-f.text_field :body 
-```
-
-returns
-
-```HTML
-<dd>
-  <input type="text" id="post_body" name="post[body]" />
-</dd>
-```
-
-Also provided is a helper for a label with a checkbox __inside__ it (which is
-also wrapped in a ```<dt>```). Use:
-
-```ruby 
-f.check_box_with_label :published
+= f.label attribute
 ```
 
-which returns:
+When `obj.attribute` is in an invalid state the markup returned will be like:
 
 ```html
-<dt>
-  <label for="post_published">
-     <input name="post[published]" type="hidden" value="0" />
-     <input id="post_published" name="post[published]" type="checkbox" value="1" /> 
-     published
-  </label>
-</dt>
+<label for='obj_attribute'>Attribute <span class='error'>Error message</span></label>
 ```
 
-
-
-
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -2,10 +2,8 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
+desc 'Run formal tests.'
+RSpec::Core::RakeTask.new('spec')
+
 desc 'Default: run tests.'
 task :default => :spec
-
-desc 'Run formal tests.'
-RSpec::Core::RakeTask.new('spec') do |t|
-  t.pattern = FileList['spec/**/*_spec.rb']
-end

data/formal.gemspec

@@ -15,5 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Formal::VERSION
 
-  gem.add_development_dependency("rspec-rails")
+  gem.add_development_dependency("rspec-rails", "2.14.0.rc1")
+  gem.add_development_dependency("pry")
 end

data/lib/formal.rb

@@ -1,42 +1,5 @@
-require "formal/version"
+require 'formal/version'
+require 'formal/form_builder'
 
 module Formal
-  class Builder < ActionView::Helpers::FormBuilder
-
-    ActionView::Base.field_error_proc = proc { |input, instance| input }
-
-    @@field_helper_methods = %w(label_tag text_field password_field text_area select email_field search_field telephone_field number_field file_field range_field)
-
-    def label(method, text = nil, options = {}, &block)
-      text = text || method.to_s.humanize
-
-      if object.errors.any?
-        error_message = object.errors[method]
-        errors = error_message.is_a?(Array) ? error_message.first : error_message
-        error_span = @template.content_tag(:span, errors, class: 'error')
-        text << " #{error_span}"
-        @template.content_tag(:dt, super(method, text.html_safe, options, &block), class: 'error')
-      else
-        @template.content_tag(:dt, super(method, text.html_safe, options, &block))
-      end
-    end
-
-    @@field_helper_methods.each do |method_name|
-      define_method method_name do |*args|
-        method_name = args.first
-        if object.errors[method_name].present?
-          @template.content_tag(:dd, super(*args), class: 'error')
-        else
-          @template.content_tag(:dd, super(*args))
-        end
-      end
-    end
-
-    def check_box_with_label(method, text = nil, *args)
-      text = text || method.to_s
-      box = [check_box(method, *args).html_safe, text].join(" ")
-      label(method, box, *args)
-    end
-  end
-
 end

data/lib/formal/form_builder.rb

@@ -0,0 +1,42 @@
+module Formal
+
+  # Public: Adds functionality to rails form builder
+  #
+  class FormBuilder < ActionView::Helpers::FormBuilder
+
+    # Public: renders html label element
+    #
+    # method  - String or Symbol object attribute
+    # text    - String text to be rendered inside of `label` markup
+    #           (optional, default: nil)
+    # options - Hash of options
+    #           :error_element - String or Symbol representing html element the
+    #                            error markup will be rendered in.
+    #                            (optional, default: :span)
+    #           :hide_errors   - Boolean to hide error markup if it is to be
+    #                            rendered. (optional)
+    def label(method, text = nil, options = {}, &block)
+      error_element = options.delete(:error_element) || :span
+      hide_errors   = options.delete(:hide_errors)
+      i18n_text     = I18n.t("#{object_name}.#{method}", default: '', scope: "helpers.label").presence
+      text          = i18n_text || text || method.to_s.humanize
+
+      unless object.nil? || hide_errors
+        errors = object.errors[method.to_sym]
+        if errors.present?
+          error_message = errors.is_a?(Array) ? errors.first : errors
+          error_markup = @template.content_tag(error_element, error_message, class: 'error')
+          text << " #{error_markup}"
+        end
+      end
+
+      super(method, text.html_safe, options, &block)
+    end
+
+    def check_box_with_label(method, text = nil, *args)
+      text = text || method.to_s
+      box = [check_box(method, *args).html_safe, text].join(" ")
+      label(method, box, *args)
+    end
+  end
+end

data/lib/formal/version.rb

@@ -1,3 +1,3 @@
 module Formal
-  VERSION = "0.0.3"
+  VERSION = "1.0.1"
 end

data/lib/rails/generators/formal/install/install_generator.rb

@@ -0,0 +1,15 @@
+module Formal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates the Formal initializer at config/initializers/formal.rb"
+
+      def self.source_root
+        @source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_initializer_file
+        template "initializer.rb", "config/initializers/formal.rb"
+      end
+    end
+  end
+end

data/lib/rails/generators/formal/install/templates/initializer.rb

@@ -0,0 +1 @@
+ActionView::Base.default_form_builder = Formal::FormBuilder

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  helpers:
+    label:
+      test_invalid:
+        body: 'INVALID'
+      test_valid:
+        body: 'VALID'

data/spec/formal_spec.rb

@@ -1,50 +1,110 @@
 require 'spec_helper'
+require 'formal'
 
-describe Formal do
+describe Formal::FormBuilder do
   include FormalSpecHelper
 
-  before do
-    @post = Post.new
-    @output = ''
-  end
+  describe "#label" do
+    describe 'when in a valid state' do
+      context 'and text is provided' do
+        it 'returns element with provided text' do
+          form_for(TestValid.new, builder: described_class) do |f|
+            label = f.label(:body, "PROVIDED TEXT")
+            expected_result = "<label for=\"test_valid_body\">PROVIDED TEXT</label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
 
-  it 'should yield the formal builder' do
-    form_for(@post, builder: Formal::Builder) do |f|
-      f.should be_kind_of(Formal::Builder)
-    end
-  end
+      context 'and local is unavailable' do
+        it 'returns a properly populated label element' do
+          form_for(TestValid.new, builder: described_class) do |f|
+            label = f.label(:body)
+            expected_result = "<label for=\"test_valid_body\">Body</label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
 
-  it 'should wrap input inside dd tag' do
-    with_builder do |f|
-      f.text_field :body
-    end
+      context 'and locale is available' do
+        before do
+          I18n.config.backend.load_translations(fixture_locale(:en))
+        end
 
-    expected = %q{<dd><input id="post_body" name="post[body]" size="30" type="text" /></dd>}
-    output.should include(expected)
-  end
+        after do
+          I18n.config.backend.reload!
+        end
 
-  it 'should wrap check box with label inside' do
-    with_builder do |f|
-      f.check_box_with_label :published
+        it 'returns a properly populated label element' do
+          form_for(TestValid.new, builder: described_class) do |f|
+            label = f.label(:body)
+            expected_result = "<label for=\"test_valid_body\">VALID</label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
     end
-    expected = %q{<dt><label for="post_published"><input name="post[published]" type="hidden" value="0" /><input id="post_published" name="post[published]" type="checkbox" value="1" /> published</label></dt>}
-    output.should include(expected)
-  end
 
-  context "with error" do
-    let(:invalid_post) { InvalidPost.new }
+    describe "when in an invalid state" do
+      context "and locale is unavailable" do
+        it 'returns a label with nested error element' do
+          form_for(TestInvalid.new, builder: described_class) do |f|
+            label = f.label(:body)
+            expected_result = "<label for=\"test_invalid_body\">Body <span class=\"error\">ERROR</span></label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
+
+      context 'and locale is available' do
+        before do
+          I18n.config.backend.load_translations(fixture_locale(:en))
+        end
+
+        after do
+          I18n.config.backend.reload!
+        end
 
-    it 'should add error class ONLY to the erroneous dd tag' do
-      with_builder(invalid_post) { |f| f.text_field :body }
-      expected_error = %q{<dd class="error"><input id="invalid_post_body" name="invalid_post[body]" size="30" type="text" /></dd>}
-      output.should include(expected_error)
+        it 'returns a label with nested error element' do
+          form_for(TestInvalid.new, builder: described_class) do |f|
+            label = f.label(:body)
+            expected_result = "<label for=\"test_invalid_body\">INVALID <span class=\"error\">ERROR</span></label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
     end
 
-    it "does not add the error class to non erroneous dd tags" do
-      with_builder(invalid_post) { |f| f.text_field :title }
-      expected_error = %q{<dd><input id="invalid_post_title" name="invalid_post[title]" size="30" type="text" /></dd>}
-      output.should include(expected_error)
+    describe 'error element' do
+      context 'when default' do
+        it 'returns span markup' do
+          form_for(TestInvalid.new, builder: described_class) do |f|
+            label = f.label(:body)
+            expected_result = "<label for=\"test_invalid_body\">Body <span class=\"error\">ERROR</span></label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
+
+      context 'when passed in' do
+        it 'returns passed in markup' do
+          form_for(TestInvalid.new, builder: described_class) do |f|
+            label = f.label(:body, nil, error_element: :small)
+            expected_result = "<label for=\"test_invalid_body\">Body <small class=\"error\">ERROR</small></label>"
+            expect(label).to eq(expected_result)
+          end
+        end
+      end
     end
 
+    describe 'hide errors' do
+      it 'removes error markup' do
+        form_for(TestInvalid.new, builder: described_class) do |f|
+          label = f.label(:body, nil, hide_errors: true)
+          expected_result = "<label for=\"test_invalid_body\">Body</label>"
+          expect(label).to eq(expected_result)
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,8 @@ require 'action_view'
 require 'active_model'
 
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/formal'))
-require 'formal'
 
-class Post < Struct.new(:body, :published)
+class TestValid < Struct.new(:body)
   extend  ActiveModel::Naming
   include ActiveModel::Conversion
 
@@ -17,7 +16,7 @@ class Post < Struct.new(:body, :published)
   end
 end
 
-class InvalidPost < Struct.new(:body, :title)
+class TestInvalid < Struct.new(:body)
   extend  ActiveModel::Naming
   include ActiveModel::Conversion
 
@@ -26,31 +25,32 @@ class InvalidPost < Struct.new(:body, :title)
   end
 
   def errors
-    { :body => ["can't be blank"] }
+    { :body => ["ERROR"] }
   end
 end
 
+def fixture_locale(local_name)
+  File.expand_path("../fixtures/locales/#{local_name}.yml", __FILE__)
+end
+
 module FormalSpecHelper
   include ActionView::Context if defined?(ActionView::Context)
   include ActionController::RecordIdentifier
   include ActionView::Helpers::FormHelper
 
-  def posts_path(*args)
-    "/posts"
+  def path(*args)
+    "/test_path"
   end
-  alias :invalid_posts_path :posts_path
+  alias :test_invalids_path :path
+  alias :test_valids_path :path
 
   def protect_against_forgery?
     false
   end
 
   def with_builder(model = Post.new)
-    @output = form_for(model, builder: Formal::Builder) do |f|
+    @output = form_for(model, builder: Formal::FormBuilder) do |f|
       yield f
     end
   end
-
-  def output
-    @output
-  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - mrmicahcooper
@@ -10,22 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Helpful form builder used by Rocketeers
@@ -36,40 +47,43 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - formal.gemspec
 - lib/formal.rb
+- lib/formal/form_builder.rb
 - lib/formal/version.rb
+- lib/rails/generators/formal/install/install_generator.rb
+- lib/rails/generators/formal/install/templates/initializer.rb
+- spec/fixtures/locales/en.yml
 - spec/formal_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/mrmicahcooper/formal
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A form builder that wraps form fields the way we like it at Hashrocket
 test_files:
+- spec/fixtures/locales/en.yml
 - spec/formal_spec.rb
 - spec/spec_helper.rb

data/.rspec

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