filter_form 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0687dda492a9e82d4e3b5555586410a5679a52e7
+  data.tar.gz: 167fb3b2e8dc2cd001b2dd8c618088632cb12263
+SHA512:
+  metadata.gz: 78954032e35a6c3e71dbdfb2e5e678a90a41a6d163e658d0f76240c775f7ec517dd0c26af01927135ad888548b9fac813f1a1d337da5540a773990cecbadb755
+  data.tar.gz: c6ed716a620c7465a14c1318c1dd130e37dad616588f276c58f9dc4ce49356f6ff32d186cbfc9bd90b2d5371f8d67752384cc622a161c53b91d319e5b393a2bf

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Evgeny Li
+
+MIT License
+
+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,76 @@
+# FilterForm
+
+Build filter forms easily by using `ransack` and `simple_form`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filter_form'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filter_form
+
+## Usage
+
+In your contoller:
+
+```ruby
+def index
+  @q = Person.search(params[:q])
+  @people = @q.result
+end
+```
+
+In your view file:
+
+```erb
+<%= filter_form_for @q do |f| %>
+  <%= f.filter_input :name %>
+  <%= f.filter_input :age %>
+  <%= f.filter_input :city_id %>
+  <%= f.filter_input :birthday %>
+  <%= f.button :submit %>
+<% end %>
+```
+
+For `string` attribute (like name) it will automatically create a text input with predicate `cont` (contains).
+
+For `integer` type (age) it will set predicate `eq`.
+
+For association's `foreign key` (city_id) it will automatically build a select tag.
+
+For `date` and `datetime` (birthday) it will automatically add jQuery [datepicker](http://jqueryui.com/datepicker/) and set predicate `eq`.
+
+If you want to use datepicker add to your application.js file:
+
+```js
+//= require jquery
+//= require jquery.ui.datepicker
+//= require filter_form
+```
+
+And application.css:
+
+```css
+*= require jquery.ui.datepicker
+```
+
+For more information about predicates visit [ransack](https://github.com/ernie/ransack).
+
+If you want to customize your form visit [simple_form](https://github.com/plataformatec/simple_form).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/filter_form.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filter_form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'filter_form'
+  spec.version       = FilterForm::VERSION
+  spec.authors       = ['Evgeny Li']
+  spec.email         = ['exaspark@gmail.com']
+  spec.description   = %q{Build filter forms easily}
+  spec.summary       = %q{Build your filter forms automatically}
+  spec.homepage      = 'https://github.com/exAspArk/filter_form'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jquery-rails'
+  spec.add_dependency 'simple_form'
+  spec.add_dependency 'ransack'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/assets/javascripts/filter_form.js.coffee

@@ -0,0 +1,3 @@
+$ ->
+  $('.filter_form_date').datepicker
+    dateFormat: 'yy-mm-dd'

data/lib/filter_form/form_helper.rb

@@ -0,0 +1,15 @@
+module FilterForm
+  module FormHelper
+    def filter_form_for(record, options = {}, &block)
+      options.reverse_merge!({
+        url:    url_for,
+        method: :get,
+        html:   { class: 'filter_form', novalidate: true }
+      })
+
+      simple_form_for(record, options, &block)
+    end
+  end
+end
+
+ActionView::Base.send :include, FilterForm::FormHelper

data/lib/filter_form/input.rb

@@ -0,0 +1,113 @@
+module FilterForm
+  class Input
+    DATE_CLASS = 'filter_form_date'
+
+    include ActiveModel::Model
+
+    attr_accessor :attribute_name, :object
+
+    def options
+      result = default_options
+
+      case type
+      when :select
+        result.merge!(select_options)
+      else
+        result[:input_html].merge!(value: input_value)
+      end
+
+      case attribute_type
+      when :datetime, :date
+        result[:input_html].merge!(class: DATE_CLASS)
+      end
+
+      result
+    end
+
+  private
+
+    def default_options
+      {
+        as:         type,
+        required:   false,
+        input_html: { name: input_name }
+      }
+    end
+
+    # Select options ------------------------------------------------------------
+
+    def select_options
+      {
+        collection:    collection,
+        include_blank: true,
+        selected:      selected
+      }
+    end
+
+    def collection
+      if reference_attribute?
+        attribute_name.to_s.gsub('_id', '').camelize.constantize.all
+      else
+        object.klass.pluck(attribute_name).uniq
+      end
+    end
+
+    def selected
+      if object_condition.present?
+        input_value
+      else
+        false
+      end
+    end
+
+    # ---------------------------------------------------------------------------
+
+    def input_name
+      "q[#{ input_attribute_name }]"
+    end
+
+    def type
+      return :select if reference_attribute?
+
+      case attribute_type
+      when :string, :integer, :datetime, :date
+        :string
+      when :float
+        :float
+      when :boolean
+        :radio_buttons
+      else
+        :select
+      end
+    end
+
+    def input_value
+      object_condition.values.first.value if object_condition
+    end
+
+    def reference_attribute?
+      attribute_name.to_s.end_with?('_id')
+    end
+
+    def object_condition
+      object.base.conditions.select { |c| c.a.first.name == attribute_name.to_s }.first
+    end
+
+    def input_attribute_name
+      "#{ attribute_name }_#{ predicate_name }"
+    end
+
+    def attribute_type
+      object.klass.columns_hash[attribute_name.to_s].type
+    end
+
+    def predicate_name
+      case attribute_type
+      when :string
+        'cont'
+      else
+        'eq'
+      end
+    end
+  end
+end

data/lib/filter_form/simple_form/form_builder.rb

@@ -0,0 +1,12 @@
+require 'filter_form/input'
+
+module SimpleForm
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    def filter_input(attribute_name, options = {}, &block)
+      filter_input = FilterForm::Input.new(attribute_name: attribute_name, object: object)
+      options.reverse_merge!(filter_input.options)
+
+      input(attribute_name, options, &block)
+    end
+  end
+end

data/lib/filter_form/version.rb

@@ -0,0 +1,3 @@
+module FilterForm
+  VERSION = '0.0.2'
+end

data/lib/filter_form.rb

@@ -0,0 +1,8 @@
+require 'filter_form/version'
+require 'filter_form/form_helper'
+require 'filter_form/simple_form/form_builder'
+
+module FilterForm
+  class Engine < ::Rails::Engine
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: filter_form
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Evgeny Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Build filter forms easily
+email:
+- exaspark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filter_form.gemspec
+- lib/assets/javascripts/filter_form.js.coffee
+- lib/filter_form.rb
+- lib/filter_form/form_helper.rb
+- lib/filter_form/input.rb
+- lib/filter_form/simple_form/form_builder.rb
+- lib/filter_form/version.rb
+homepage: https://github.com/exAspArk/filter_form
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Build your filter forms automatically
+test_files: []