foundation_form_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 641a1f19acac3199b1398734ccd81f852057dfdf
+  data.tar.gz: 29acdd3bf4eb8b85999dab0e2a0efae033dabbf0
+SHA512:
+  metadata.gz: bfe7df075ac97f33f9b4e16b7c67d52add64ac42661638c908258646b82651ab61c3ba4403dda301a9b7685d824fc75e1104ac3cc2b5d49184616ce1ad122466
+  data.tar.gz: 83d310b59371eda1a206dc8f74fd011a4237a28b0c4be4f99e64e240c3d9ef6d4ea96f9198f7eea961e4c6a835f2539d0265539f5e177561ea76c5ff7c1db4ae

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# FoundationFormBuilder changelog
+
+# 0.1.0
+
+25 Feb 2015
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foundation_form_builder.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,51 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+directories %w(lib spec)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marnen Laibow-Koser
+
+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.md

@@ -0,0 +1,67 @@
+[![Code Climate](https://codeclimate.com/github/marnen/foundation_form_builder/badges/gpa.svg)](https://codeclimate.com/github/marnen/foundation_form_builder)
+[![Test Coverage](https://codeclimate.com/github/marnen/foundation_form_builder/badges/coverage.svg)](https://codeclimate.com/github/marnen/foundation_form_builder)
+
+# FoundationFormBuilder
+
+## What is this gem for?
+
+[Foundation](http://foundation.zurb.com) is an excellent CSS framework, and provides some [lovely components](http://foundation.zurb.com/docs/components/forms.html) for working with forms. Unfortunately, using them with Rails can be a bit of a hassle, as Foundation wants each form input to be wrapped in a `<div>`, with another `<div>` for errors.
+
+In addition, I wanted to use something like [Formtastic](http://github.com/justinfrench/formtastic) to DRY up my form field markup, but writing new renderers for Formtastic is non-trivial, and I wanted something a bit simpler anyway, so I rolled my own.
+
+This gem is a work in progress. I welcome bug reports and pull requests! It's only tested on Rails 4.2 and Ruby 2.2 so far, but I'd love to support older versions of both Rails and Ruby if it's not too difficult to do so.
+
+## Sounds great! How do I use it?
+
+Install the gem, then put the following in your `application.rb` file:
+```ruby
+config.action_view.default_form_builder = FoundationFormBuilder
+```
+This tells Rails to use the gem for all forms. If you don't want to do that, then specify it for the particular form you'd like to use it on.
+
+### Simple usage
+
+```ruby
+form_for @user do |f|
+  f.input_div :email
+end
+```
+will create something like
+```html
+<form action='users/1' and='all the other standard Rails attributes :)'>
+  <div class='email'>
+    <label for='user_email'>Email</label>
+    <input type='email' id='user_email' name='user[email]' />
+    <!-- if there are validation errors, also the following: -->
+    <div class='error'>can't be blank</div>
+  </div>
+</form>
+```
+
+Note that `FoundationFormBuilder` uses the Rails form helper functions to render the fields, and that it is somewhat smart in its choice of helpers. It uses `email_field` automatically if the name of the field is `email`; similarly, it uses `password_field` for any field whose name *contains* `password`. If the name of the field is `time_zone`, it renders a Rails `time_zone_select`. If the field corresponds to a `text` column in the database, it calls `text_area`; for a `date` column, it uses `date_field`. Otherwise, a plain `text_field` is used.
+
+
+Since `FoundationFormBuilder` is a subclass of the standard Rails `ActionView::Helpers::FormBuilder`, all the usual Rails `FormBuilder` helpers are also available. You'll probably need to use `f.submit` at least; we're not doing anything special with submit buttons at the moment.
+
+### Advanced usage
+
+`input_div` takes several options if you want to override its defaults. `:label` overrides the label text, while `:type` overrides the inferred type (known values are `:date`, `:email`, `:password`, `:select`, `:textarea`, and `:time_zone`; anything else is understood as a text field). `:field` takes a hash of options which are passed through to the underlying Rails form helper.
+
+If `type: :select` is specified, then the values for the `select`options must be specified in `:values`, like this:
+
+```ruby
+f.input_div :size, label: 'My size is:', type: :select, values: [['Small', 1], ['Large', 2]], field: {prompt: 'Choose a size'}
+```
+
+which produces:
+```html
+<div class='size'>
+  <label for='product_size'>My size is:</label>
+  <select name='product[size]' id='product_size'>
+    <option>Choose a size</option>
+    <option value='1'>Small</option>
+    <option value='2'>Large</option>
+  </select>
+  <!-- error div if necessary, as above -->
+</div>
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "foundation_form_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/foundation_form_builder.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foundation_form_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "foundation_form_builder"
+  spec.version       = FoundationFormBuilder::VERSION
+  spec.authors       = ["Marnen Laibow-Koser"]
+  spec.email         = ["marnen@marnen.org"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.summary       = %q{Rails FormBuilder for use with ZURB Foundation.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/marnen/foundation_form_builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  [
+    ['actionview', '>= 4.2.0'],
+    ['activerecord', '>= 4.2.0'],
+    ['activesupport', '>= 4.2.0']
+  ].each {|gem| spec.add_dependency *gem }
+
+  [
+    ['bundler', '~> 1.8'],
+    ['rake', '~> 10.0'],
+    'ffaker',
+    'guard-rspec',
+    'rspec-html-matchers'
+  ].each {|gem| spec.add_development_dependency *gem }
+end

data/lib/foundation_form_builder/version.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), '..', 'foundation_form_builder')
+
+FoundationFormBuilder.class_eval do
+  self::VERSION = "0.1.0"
+end

data/lib/foundation_form_builder.rb

@@ -0,0 +1,70 @@
+require 'action_view'
+require 'active_record'
+require 'active_support/time_with_zone'
+
+class FoundationFormBuilder < ActionView::Helpers::FormBuilder
+  def input_div(field_name, label: nil, type: nil, values: nil, field: {})
+    raise ArgumentError, ':values is only meaningful with type: :select' if values && type != :select
+    @template.content_tag :div, class: field_name do
+      [
+        label(field_name, label),
+        input_for(field_name, type, field, values: values),
+        error_div(field_name)
+      ].compact.join("\n").html_safe
+    end
+  end
+
+  private
+
+  def error_div(field_name)
+    error_messages = errors[field_name]
+    if error_messages.present?
+      @template.content_tag :div, class: :error do
+        error_messages.join(@template.tag :br).html_safe
+      end
+    else
+      nil
+    end
+  end
+
+  def errors
+    @errors ||= @object.errors
+  end
+
+  def input_for(field_name, type, field_options, values: nil)
+    type ||= infer_type field_name
+
+    case type
+    when :select
+      select field_name, values, field_options
+    when :time_zone
+      priority_zones = field_options.delete(:priority_zones)
+      time_zone_select field_name, priority_zones, field_options
+    else
+      method_mappings = {
+        date: :date_field,
+        email: :email_field,
+        password: :password_field,
+        textarea: :text_area,
+      }
+
+      field_method = method_mappings[type] || :text_field
+
+      self.send field_method, field_name, field_options
+    end
+  end
+
+  def infer_type(field_name)
+    case field_name
+    when :email, :time_zone
+      field_name
+    when %r{(\b|_)password(\b|_)}
+      :password
+    else
+      type_mappings = {text: :textarea}
+
+      db_type = @object.column_for_attribute(field_name).type
+      type_mappings[db_type] || db_type
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: foundation_form_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marnen Laibow-Koser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- marnen@marnen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- foundation_form_builder.gemspec
+- lib/foundation_form_builder.rb
+- lib/foundation_form_builder/version.rb
+homepage: https://github.com/marnen/foundation_form_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rails FormBuilder for use with ZURB Foundation.
+test_files: []