awesome_form 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b455dd0dfebd90800af8b8bd3f331cbbe8be7008
+  data.tar.gz: 49f489364ef8e918c87dd4047880d846cf2e2c0c
+SHA512:
+  metadata.gz: 9abc0cd5aac34858ded3e7573527a45ce92fd8b8db8d35353abbb3f1cefd8294bf344e05af978e208264fe75fc0e3901faa44f7567e7a01f14682f33545d86e3
+  data.tar.gz: 3042c0369946585e9ab2ade746bce45ab1fd8eae07ecf2977e659f85e9b89cafdca258f601c358afb9cfe9a7fed289766b0aa00762b11f5864c8598c7195725b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,113 @@
+## AwesomeForm
+
+[![Build Status](https://travis-ci.org/abe33/awesome_form.png)](https://travis-ci.org/abe33/awesome_form)
+[![Coverage Status](https://coveralls.io/repos/abe33/awesome_form/badge.png)](https://coveralls.io/r/abe33/awesome_form)
+[![Code Climate](https://codeclimate.com/github/abe33/awesome_form.png)](https://codeclimate.com/github/abe33/awesome_form)
+[![Dependency Status](https://gemnasium.com/abe33/awesome_form.png)](https://gemnasium.com/abe33/awesome_form)
+
+`AwesomeForm` is yet another form helper for `Rails`, but, contrary to `Formtastic` and `SimpleForm` it relies on partial views instead of html helpers.
+
+Each input type is a partial in its theme directory, and wrappers are made using the `layout` option of the `render` method.
+
+For instance, a boolean field will be rendered using a partial named `_boolean` in the `app/views/awesome_form` directory (See below for further explanation on partials lookup).
+
+The same principles apply with form actions, each action is map to a partial file and eventually wrapped using a layout file.
+
+### Usage
+
+Using `AwesomeForm` doesn't differ much of using `Formtastic` or `SimpleForm`:
+
+```haml
+= awesome_form_for resource, url: resource_path(resource) do |form|
+
+  = form.inputs :attribute, :another_attribute
+
+  = form.input :some_attribute, as: :boolean
+
+  = form.actions :submit, :cancel
+```
+
+### Model Attributes Discovery
+
+When using the `inputs` method without any arguments, the form builder will attempt to discover attributes of the model. By default it'll generate an input for every column of the model as well as for each association (both `belongs_to` and `has_many` associations).
+
+Columns can be excluded by adding them to the `AwesomeForm.excluded_columns` array. By default, only timestamps columns are ignored.
+
+```ruby
+AwesomeForm.setup do |config|
+  config.excluded_columns << %w(column_to_ignore another_column_to_ignore)
+end
+```
+
+By default, both `belongs_to` and `has_many` associations appears in discovered model's attributes. The default association are editable using
+the `AwesomeForm.default_associations` config.
+
+```ruby
+AwesomeForm.setup do |config|
+  config.default_associations = [:belongs_to]
+end
+```
+
+### Views Lookup
+
+The lookup process for a form input takes place as follow:
+
+First, we look for a partial for the given model attribute, either
+at the top level or in the selected theme:
+
+  1. `app/views/awesome_form/inputs/:object_name/:attribute_name`
+  2. `app/views/awesome_form/:theme/inputs/:object_name/:attribute_name`
+
+If a partial cannot be found for the model attribute, we look for a
+partial for the attribute's type:
+
+  3. `app/views/awesome_form/inputs/:attribute_type`
+  4. `app/views/awesome_form/:theme/inputs/:attribute_type`
+  5. `app/views/awesome_form/default_theme/inputs/:attribute_type`
+
+And if there's no partial for the attribute's type, we look for the
+default input partial.
+
+  6. `app/views/awesome_form/inputs/default`
+  7. `app/views/awesome_form/:theme/inputs/default`
+  8. `app/views/awesome_form/default_theme/inputs/default`
+
+#### Inputs Wrappers
+
+The same kind of lookup is used for fields wrappers, but instead of looking into the `inputs` view directory, it'll look into the `wrappers` directory.
+
+  1. `app/views/awesome_form/wrappers/:object_name/:attribute_name`
+  2. `app/views/awesome_form/:theme/wrappers/:object_name/:attribute_name`
+  3. `app/views/awesome_form/wrappers/:attribute_type`
+  4. `app/views/awesome_form/:theme/wrappers/:attribute_type`
+  5. `app/views/awesome_form/default_theme/wrappers/:attribute_type`
+  6. `app/views/awesome_form/wrappers/default`
+  7. `app/views/awesome_form/:theme/wrappers/default`
+  8. `app/views/awesome_form/default_theme/wrappers/default`
+
+Fields wrappers are just layouts, and as every layout, the content of the view is injected where the `yield` keyword is found in the layout.
+
+#### Action Views Lookup
+
+A similar lookup is performed to find actions's views and wrappers:
+
+For the action itself:
+
+  1. `awesome_form/actions/:object_name/:action`
+  2. `awesome_form/:theme/actions/:object_name/:action`
+  3. `awesome_form/actions/:action`
+  4. `awesome_form/:theme/actions/:action`
+  5. `awesome_form/default_theme/actions/:action`
+  6. `awesome_form/actions/default`
+  7. `awesome_form/:theme/actions/default`
+  8. `awesome_form/default_theme/actions/default`
+
+And for the wrapper:
+
+  1. `awesome_form/wrappers/:object_name/:action`
+  2. `awesome_form/:theme/wrappers/:object_name/:action`
+  3. `awesome_form/wrappers/:action`
+  4. `awesome_form/:theme/wrappers/:action`
+  5. `awesome_form/default_theme/wrappers/:action`
+
+As you may notice, the action wrapper lookup doesn't fallback on any default.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AwesomeForm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/views/awesome_form/default_theme/actions/_default.html.haml

@@ -0,0 +1,8 @@
+:ruby
+  attrs = {
+    type: action,
+    name: name,
+    class: "#{builder.model_name} #{action}",
+  }
+
+%button.action{attrs}= builder.action_label(action)

data/app/views/awesome_form/default_theme/inputs/_association.html.haml

@@ -0,0 +1,14 @@
+:ruby
+  attrs = {
+    name: builder.association_name(attribute_name),
+    id: builder.input_id(attribute_name),
+    class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+    multiple: multiple,
+  }
+
+%select.input{attrs}
+  - if defined?(include_blank) && include_blank
+    %option{value: ''}
+
+  - collection.each do |value, label|
+    %option{value: value, selected: selected.include?(value)}= label

data/app/views/awesome_form/default_theme/inputs/_boolean.html.haml

@@ -0,0 +1,12 @@
+:ruby
+  attrs = {
+    name: builder.input_name(attribute_name),
+    id: builder.input_id(attribute_name),
+    type: :checkbox,
+    class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+    value: '1',
+    checked: object.try(attribute_name),
+  }
+  attrs.merge! builder.filter_attributes_for(:input, input_html)
+
+%input.input{attrs}

data/app/views/awesome_form/default_theme/inputs/_check_boxes.html.haml

@@ -0,0 +1,18 @@
+- selected ||= []
+
+- collection.each do |value, label|
+  :ruby
+    id = "#{builder.input_id(attribute_name)}_#{(label || value).to_s.underscore}"
+    attrs = {
+      name: builder.collection_name(attribute_name),
+      id: id,
+      type: :checkbox,
+      class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+      value: value,
+      checked: selected.include?(value),
+    }
+    attrs.merge! builder.filter_attributes_for(:input, input_html)
+
+  %p
+    %input.input{attrs}
+    %label{for: id}= label || value.to_s.humanize

data/app/views/awesome_form/default_theme/inputs/_default.html.haml

@@ -0,0 +1,11 @@
+:ruby
+  attrs = {
+    name: builder.input_name(attribute_name),
+    id: builder.input_id(attribute_name),
+    class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+    type: type == :string ? :text : type,
+    value: object.try(attribute_name),
+  }
+  attrs.merge! builder.filter_attributes_for(:input, input_html)
+
+%input.input{attrs}

data/app/views/awesome_form/default_theme/inputs/_radios.html.haml

@@ -0,0 +1,18 @@
+- selected ||= []
+
+- collection.each do |value, label|
+  :ruby
+    id = "#{builder.input_id(attribute_name)}_#{(label || value).to_s.underscore}"
+    attrs = {
+      name: builder.input_name(attribute_name),
+      id: id,
+      type: :radio,
+      class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+      value: value,
+      checked: selected.include?(value),
+    }
+    attrs.merge! builder.filter_attributes_for(:input, input_html)
+
+  %p
+    %input.input{attrs}
+    %label{for: id}= label || value.to_s.humanize

data/app/views/awesome_form/default_theme/inputs/_select.html.haml

@@ -0,0 +1,18 @@
+:ruby
+  multiple ||= false
+  selected ||= []
+
+  attrs = {
+    name: multiple ? builder.collection_name(attribute_name) : builder.input_name(attribute_name),
+    id: builder.input_id(attribute_name),
+    class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+    multiple: multiple
+  }
+  attrs.merge! builder.filter_attributes_for(:select, input_html)
+
+%select.input{attrs}
+  - if defined?(include_blank) && include_blank
+    %option{value: ''}
+
+  - collection.each do |value, label|
+    %option{value: value, selected: selected.include?(value)}= label || value.to_s.humanize

data/app/views/awesome_form/default_theme/inputs/_text.html.haml

@@ -0,0 +1,9 @@
+:ruby
+  attrs = {
+    name: builder.input_name(attribute_name),
+    class: "#{builder.model_name} #{attribute_name} #{input_html.delete(:class)}",
+    id: builder.input_id(attribute_name),
+  }
+  attrs.merge! builder.filter_attributes_for(:textarea, input_html)
+
+%textarea.input{attrs}= object.try(attribute_name)

data/app/views/awesome_form/default_theme/wrappers/_actions.html.haml

@@ -0,0 +1,2 @@
+
+%fieldset.actions= yield

data/app/views/awesome_form/default_theme/wrappers/_boolean.html.haml

@@ -0,0 +1,4 @@
+.field
+  = yield
+  %label{for: builder.input_id(attribute_name)}
+    = builder.input_label(attribute_name)

data/app/views/awesome_form/default_theme/wrappers/_default.html.haml

@@ -0,0 +1,4 @@
+.field
+  %label{for: builder.input_id(attribute_name)}
+    = builder.input_label(attribute_name)
+  .controls= yield

data/app/views/awesome_form/default_theme/wrappers/_inputs.html.haml

@@ -0,0 +1,2 @@
+
+%fieldset.inputs= yield

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/awesome_form.rb

@@ -0,0 +1,36 @@
+require 'action_view'
+require "awesome_form/engine"
+require "awesome_form/form_builder"
+require "awesome_form/action_view_extensions/form_helper"
+
+module AwesomeForm
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :FormBuilder
+  end
+
+  mattr_accessor :theme
+  @@theme = :default_theme
+
+  mattr_accessor :default_actions
+  @@default_actions = [:submit]
+
+  mattr_accessor :excluded_columns
+  @@excluded_columns = [:created_at, :updated_at]
+
+  mattr_accessor :default_associations
+  @@default_associations = [:belongs_to, :has_many]
+
+  mattr_accessor :legal_attributes
+  @@legal_attributes = {
+    input: %w(accept alt autocomplete autofocus checked dirname disabled form formaction formenctype formmethod formnovalidate formtarget height list max maxlength min multiple name pattern placeholder readonly required size src step type value width).map(&:to_sym),
+    textarea: %w(autocomplete autofocus cols dirname disabled form maxlength name placeholder readonly required rows wrap).map(&:to_sym),
+    select: %w(autofocus disabled form multiple name required size).map(&:to_sym)
+  }
+
+  def self.setup
+    yield self
+  end
+end
+

data/lib/awesome_form/action_view_extensions/form_helper.rb

@@ -0,0 +1,13 @@
+module AwesomeForm
+  module ActionViewExtensions
+    module FormHelper
+      def awesome_form_for(object, options={}, &block)
+        options[:builder] ||= AwesomeForm::FormBuilder
+
+        form_for(object, options, &block)
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, AwesomeForm::ActionViewExtensions::FormHelper

data/lib/awesome_form/engine.rb

@@ -0,0 +1,4 @@
+module AwesomeForm
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/awesome_form/form_builder.rb

@@ -0,0 +1,63 @@
+require 'awesome_form/methods/attributes'
+require 'awesome_form/methods/inputs'
+require 'awesome_form/methods/actions'
+require 'awesome_form/methods/naming'
+require 'awesome_form/methods/labels'
+
+module AwesomeForm
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include AwesomeForm::Methods::Attributes
+    include AwesomeForm::Methods::Inputs
+    include AwesomeForm::Methods::Actions
+    include AwesomeForm::Methods::Naming
+    include AwesomeForm::Methods::Labels
+
+    def initialize(*)
+      super
+    end
+
+    def render(render_options)
+      @template.render(render_options)
+    end
+
+    def view_exists?(view)
+      path_elements = view.split('/')
+      view = "_#{path_elements.pop}".squeeze '_'
+      prefix = path_elements.join('/')
+
+      @template.lookup_context.exists? view, [prefix]
+    end
+
+    def lookup_views(paths)
+      paths.select { |p| view_exists? p }.first
+    end
+
+    def filter_attributes_for(html, options)
+      options.select do |k|
+        AwesomeForm.legal_attributes[html].include?(k) ||
+        k.to_s =~ /^data($|-)/
+      end
+    end
+
+    def model_name
+      object.class.name.underscore
+    end
+
+    def resource_name
+      model_name.pluralize
+    end
+
+  protected
+
+    def filter_arguments(*args)
+      options = {}
+
+      symbols = args.select {|a| a.is_a? Symbol }
+      options_args = args.select {|a| a.is_a? Hash }
+      options_args.each {|h| options.merge! h }
+
+      [symbols, options]
+    end
+
+  end
+end

data/lib/awesome_form/methods/actions.rb

@@ -0,0 +1,78 @@
+require 'awesome_form/methods/rendering'
+
+module AwesomeForm
+  module Methods
+    module Actions
+      extend AwesomeForm::Methods::Rendering
+
+      render_method :action
+
+    protected
+
+      def default_keys_for_actions
+        AwesomeForm.default_actions
+      end
+
+      def options_for_action(action, options)
+        options = {
+          action: action.to_sym,
+          object_name: object_name,
+          object: object,
+          builder: self
+        }
+
+        case action.to_sym
+        when :submit then options[:name] = :commit
+        when :cancel then options[:name] = :cancel
+        when :reset then options[:name] = :reset
+        end
+
+        options.merge(options)
+      end
+
+      def default_actions_content(options)
+        ''
+      end
+
+      def partial_for_action(action_options)
+        partial_paths_for_action(action_options).select { |p| view_exists? p }.first
+      end
+
+      def wrapper_for_action(action_options)
+        partial_paths_for_action_wrapper(action_options).select { |p| view_exists? p }.first
+      end
+
+      def partial_paths_for_action(action_options)
+        theme = AwesomeForm.theme
+        action = action_options[:action]
+
+        [
+          "awesome_form/actions/#{resource_name}/#{action}",
+          "awesome_form/#{theme}/actions/#{resource_name}/#{action}",
+
+          "awesome_form/actions/#{action}",
+          "awesome_form/#{theme}/actions/#{action}",
+          "awesome_form/default_theme/actions/#{action}",
+
+          "awesome_form/actions/default",
+          "awesome_form/#{theme}/actions/default",
+          "awesome_form/default_theme/actions/default"
+        ].uniq
+      end
+
+      def partial_paths_for_action_wrapper(action_options)
+        theme = AwesomeForm.theme
+        action = action_options[:action]
+
+        [
+          "awesome_form/wrappers/#{resource_name}/#{action}",
+          "awesome_form/#{theme}/wrappers/#{resource_name}/#{action}",
+
+          "awesome_form/wrappers/#{action}",
+          "awesome_form/#{theme}/wrappers/#{action}",
+          "awesome_form/default_theme/wrappers/#{action}"
+        ].uniq
+      end
+    end
+  end
+end