ransack_ui 1.0.1 → 1.0.2

data/README.md

@@ -3,6 +3,8 @@
 Provides HTML templates and JavaScript to build a fully functional
 advanced search form using Ransack.
 
+Please note: this project is still in *alpha* and the following instructions are not yet complete/fully working.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,6 +19,28 @@ Or install it yourself as:
 
     $ gem install ransack_ui
 
+## Usage
+
+Make your model ransackable (if you name associations, it will enable you to search them aswell).
+
+```ruby
+has_ransackable_associations %w(account tags)
+ransack_can_autocomplete
+```
+
+In your controller, where you'd like to add search functionality, add the following before_filter hook. You can change the 'index' action if needed.
+
+```ruby
+before_filter :load_ransack_search, :only => :index
+```
+
+Insert the following helper call into your rails view code where you'd like the search form to appear.
+
+```ruby
+= ransack_ui_search
+```
+
+Now you can start playing with the results.
 
 ## Contributing
 
@@ -25,3 +49,9 @@ Or install it yourself as:
 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
+
+## Credits / Acknowledgements
+
+* Nathan Broadbent (ndbroadbent) - creator of ransack_ui code
+* Ernie Miller (ernie) for creating ransack - https://github.com/ernie/ransack
+* Steve Kenworthy (steveyken) - for tiny tweaks

data/app/assets/javascripts/ransack_ui_jquery/search_form.js.coffee.erb

@@ -12,7 +12,8 @@
 
       # Store initial predicates and set up Select2 on select lists in .filters
       containers = el.find('.filters')
-      @init_select2(containers)
+      if Select2?
+        @init_select2(containers)
       @store_initial_predicates(containers)
 
       if $.ransack.button_group_select?
@@ -31,7 +32,6 @@
 
       base_id = target.attr('id').slice(0, -8)
       predicate_select  = @element.find("select##{base_id}p")
-      predicate_select2 = @element.find("#s2id_#{base_id}p")
       query_input = $("input##{base_id}v_0_value")
 
       # Initialize datepicker if column is date/datetime/time
@@ -70,14 +70,17 @@
 
       # Handle regular columns
       else
-        predicate_select2.select2("enable")
-        # If Select2 is on query input, remove and set defaults
-        if (query_select2 = @element.find("#s2id_#{base_id}v_0_value")).length > 0
-          query_input.select2('destroy')
-          query_input.val('')
-          previous_val = ''
-        else
-          previous_val = predicate_select.val()
+        if Select2?
+          predicate_select2 = @element.find("#s2id_#{base_id}p")
+          predicate_select2.select2("enable")
+
+          # If Select2 is on query input, remove and set defaults
+          if (query_select2 = @element.find("#s2id_#{base_id}v_0_value")).length > 0
+            query_input.select2('destroy')
+            query_input.val('')
+            previous_val = ''
+          else
+            previous_val = predicate_select.val()
 
         # Build array of supported predicates
         available = predicate_select.data['predicates']
@@ -103,7 +106,8 @@
             predicate_select.append $("<option value=#{predicate}>#{label}</option>")
 
         # Select first predicate if current selection is invalid
-        predicate_select.select2('val', previous_val)
+        if Select2?
+          predicate_select.select2('val', previous_val)
 
         # Run predicate_changed callback
         predicate_select.change()
@@ -149,13 +153,15 @@
     # Dsiables predicate choices and sets it to 'eq'
     force_eq_predicate: (base_id) ->
       predicate_select  = @element.find("select##{base_id}p")
-      predicate_select2 = @element.find("#s2id_#{base_id}p")
-      # Disable predicate Select2
-      predicate_select2.select2('disable')
       # Clear predicates, and set 'eq' predicate
       predicate_select.find('option').each (i, o) -> $(o).remove()
       predicate_select.append $('<option selected="selected" value="eq">is</option>')
-      predicate_select2.select2('val', 'eq')
+
+      if Select2?
+        predicate_select2 = @element.find("#s2id_#{base_id}p")
+        # Disable predicate Select2
+        predicate_select2.select2('disable')
+        predicate_select2.select2('val', 'eq')
 
     # Attempts to find a predicate translation for the specific column type,
     # or returns the default label.
@@ -212,14 +218,15 @@
       # Hide all query inputs
       inputs.hide()
 
-      # Find newly created input and setup Select2
-      multi_query = @element.find('#' + multi_id)
-      multi_query.select2
-        tags: []
-        tokenSeparators: [',']
-        formatNoMatches: (t) ->
-          "Add a search term"
-      multi_query.select2('val', values)
+      if Select2?
+        # Find newly created input and setup Select2
+        multi_query = @element.find('#' + multi_id)
+        multi_query.select2
+          tags: []
+          tokenSeparators: [',']
+          formatNoMatches: (t) ->
+            "Add a search term"
+        multi_query.select2('val', values)
 
     add_query_input: (base_input, base_name, id, value) ->
       base_input.after $('<input name="'+base_name+'['+id+'][value]" '+
@@ -235,18 +242,18 @@
       content = target.data("content")
       new_id = new Date().getTime()
       regexp = new RegExp('new_' + type, 'g')
-      container = target.closest('p')
-      container.before content.replace(regexp, new_id)
-      prev_container = container.prev()
+      target.before content.replace(regexp, new_id)
+      prev_container = target.prev()
 
-      @init_select2(prev_container)
+      if Select2?
+        @init_select2(prev_container)
 
       if $.ransack.button_group_select?
         @init_button_group_select(prev_container)
 
       @store_initial_predicates(prev_container)
       # Fire change event on any new selects.
-      container.prev().find("select").change()
+      prev_container.find("select").change()
       false
 
     remove_fields: (e) ->
@@ -269,33 +276,32 @@
         predicate_select.data['predicates'] = predicates
 
     init_select2: (container) ->
-      if Select2?
-        container.find('select.ransack_predicate').select2
-          width: '160px'
-          formatNoMatches: (term) ->
-            "Select a field first"
-
-        container.find('select.ransack_attribute').select2
-          width: '230px'
-          placeholder: "Select a Field"
-          allowClear: true
-          formatSelection: (object, container) ->
-            # Return 'Model: field' unless column is on root model
-            if !object.element || $(object.element).data('root-model')
+      container.find('select.ransack_predicate').select2
+        width: '160px'
+        formatNoMatches: (term) ->
+          "Select a field first"
+
+      container.find('select.ransack_attribute').select2
+        width: '230px'
+        placeholder: "Select a Field"
+        allowClear: true
+        formatSelection: (object, container) ->
+          # Return 'Model: field' unless column is on root model
+          if !object.element || $(object.element).data('root-model')
+            object.text
+          else
+            group_label = $(object.element).parent().attr('label')
+            # Avoid labels like 'Contact: Contact'
+            if group_label == object.text
               object.text
+            else if group_label?
+              group_label + ': ' + object.text
             else
-              group_label = $(object.element).parent().attr('label')
-              # Avoid labels like 'Contact: Contact'
-              if group_label == object.text
-                object.text
-              else if group_label?
-                group_label + ': ' + object.text
-              else
-                object.text
-
-        @element.find('select.ransack_sort').select2
-          width: '230px'
-          placeholder: "Select a Field"
+              object.text
+
+      @element.find('select.ransack_sort').select2
+        width: '230px'
+        placeholder: "Select a Field"
 
     init_button_group_select: (containers) ->
       containers.find('select.ransack_combinator, select.ransack_sort_order').button_group_select()

data/app/assets/stylesheets/ransack_ui_bootstrap/search.css.scss

@@ -1,4 +1,4 @@
-#ransack_search {
+.ransack_search {
   .remove_fields, .ransack_attribute, .ransack_predicate,
   .ransack_query, .ransack_sort_order, .ransack_sort,
   .btn-group-select {
@@ -15,14 +15,19 @@
     &:hover { opacity: 0.6; }
   }
   .remove_fields.btn {
-    padding: 0px 3px;
+    padding: 0px 3px 2px;
     &:hover { opacity: 1; }
   }
 
-  a.btn {
-    i    { margin-bottom: 2px; }
+  .add_fields.btn {
+    margin-top: 20px;
+  }
+
+  .btn {
+    i    { line-height: 16px; }
     span { margin-left: 5px; }
   }
+  .btn-small { padding-left: 6px; }
 
   .combinator { margin-bottom: 20px; }
 
@@ -30,4 +35,7 @@
     margin-top: 20px;
   }
 
+  .fields.sort {
+    margin-bottom: 20px;
+  }
 }

data/app/views/ransack_ui/_condition_fields.html.erb

@@ -0,0 +1,15 @@
+<div class="fields condition" data-object-name="<%= f.object_name %>">
+  <%= link_to_remove_fields t('ransack.remove_condition'), f, options %>
+
+  <%= f.attribute_fields do |a| %>
+    <span class="fields" data-object-name="<%= f.object_name %>">
+    <%= a.attribute_select({}, :class => 'ransack_attribute') %>
+  <% end %>
+
+  <%= f.predicate_select({}, :class => 'ransack_predicate') %>
+
+  <%= f.value_fields do |v| %>
+    <span class="fields value" data-object-name="<%= f.object_name %>">
+    <%= v.text_field :value, :style => "width: 200px;", :class => "ransack_query" %>
+  <% end %>
+</div>

data/app/views/ransack_ui/_grouping_fields.html.erb

@@ -0,0 +1,16 @@
+<div class="fields well" data-object-name="<%= f.object_name %>">
+  <div class="combinator">
+    <% key = (f.object_name =~ /[0]/) ? :group_first : :group_rest %>
+    <% combinator = f.combinator_select({}, :class => 'ransack_combinator') %>
+    <%= t("ransack.#{key}", :combinator => combinator).html_safe %>
+  </div>
+
+  <div class="filters">
+    <% f.object.build_condition unless f.object.conditions.any? %>
+    <%= f.condition_fields do |c| %>
+      <%= render 'ransack_ui/condition_fields', :f => c, :options => options %>
+    <% end %>
+
+    <%= link_to_add_fields t('ransack.add_condition'), f, :condition, options %>
+  </div>
+</div>

data/app/views/ransack_ui/_search.html.erb

@@ -0,0 +1,28 @@
+<%= search_form_for @ransack_search, :url => (options[:url] || url_for(:action => :index)),
+  :html => {:method => :get, :class => "ransack_search"}, :remote => !!options[:remote] do |f| %>
+
+  <% javascript_tag do %>
+    if (window.Ransack == null) { window.Ransack = {}; }
+    Ransack.alt_predicates_i18n = #{I18n.translate(:"ransack.predicates.alt", :default => {}).to_json}
+  <% end %>
+
+  <div class="row">
+    <div class="span12 well">
+      <%= f.sort_fields do |s| %>
+        <%= render 'ransack_ui/sort_fields', :f => s %>
+      <% end %>
+
+      <%= f.grouping_fields do |g| %>
+        <%= render 'ransack_ui/grouping_fields', :f => g, :options => options %>
+      <% end %>
+
+      <%= link_to_add_fields t('ransack.add_group'), f, :grouping, options %>
+
+      <div class="pull-right">
+        <%= hidden_field_tag :distinct, '1' %>
+        <%= hidden_field_tag :page, '1' %>
+        <%= f.submit t('ransack.submit'), :class => 'btn btn-primary btn-large' %>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/ransack_ui/_sort_fields.html.erb

@@ -0,0 +1,4 @@
+<div class="fields sort">
+  <span class="sort_by">Sort by:</span>
+  <%= f.sort_select %>
+</div>

data/lib/ransack_ui/rails/engine.rb

@@ -12,7 +12,7 @@ module RansackUI
         ActionController::Base.send :include, ControllerHelpers
       end
 
-      initializer :assets do
+      config.before_configuration do
         # Add images to be precompiled
         ::Rails.application.config.assets.precompile += %w(ransack_ui/delete.png ransack_ui/calendar.png)
       end

data/lib/ransack_ui/ransack_overrides/helpers/form_builder.rb

@@ -1,4 +1,4 @@
-  require 'ransack/helpers/form_builder'
+require 'ransack/helpers/form_builder'
 
 module Ransack
   module Helpers
@@ -35,10 +35,10 @@ module Ransack
           @template.select(
             @object_name, :name,
             @template.grouped_options_for_select(attribute_collection_for_bases(bases), object.name),
-            objectify_options(options), @default_options.merge({class: 'ransack_sort'}).merge(html_options)
+            objectify_options(options), @default_options.merge({:class => 'ransack_sort'}).merge(html_options)
           ) + @template.collection_select(
             @object_name, :dir, [['asc', object.translate('asc')], ['desc', object.translate('desc')]], :first, :last,
-            objectify_options(options.except(:include_blank)), @default_options.merge({class: 'ransack_sort_order'}).merge(html_options)
+            objectify_options(options.except(:include_blank)), @default_options.merge({:class => 'ransack_sort_order'}).merge(html_options)
           )
         else
           # searchable_attributes now returns [c, type]
@@ -50,14 +50,30 @@ module Ransack
           end
           @template.collection_select(
             @object_name, :name, collection, :first, :last,
-            objectify_options(options), @default_options.merge({class: 'ransack_sort'}).merge(html_options)
+            objectify_options(options), @default_options.merge({:class => 'ransack_sort'}).merge(html_options)
           ) + @template.collection_select(
             @object_name, :dir, [['asc', object.translate('asc')], ['desc', object.translate('desc')]], :first, :last,
-            objectify_options(options.except(:include_blank)), @default_options.merge({class: 'ransack_sort_order'}).merge(html_options)
+            objectify_options(options.except(:include_blank)), @default_options.merge({:class => 'ransack_sort_order'}).merge(html_options)
           )
         end
       end
 
+      def predicate_keys(options)
+        keys = options[:compounds] ? Predicate.names : Predicate.names.reject {|k| k.match(/_(any|all)$/)}
+        if only = options[:only]
+          if only.respond_to? :call
+            keys = keys.select {|k| only.call(k)}
+          else
+            only = Array.wrap(only).map(&:to_s)
+            # Create compounds hash, e.g. {"eq" => ["eq", "eq_any", "eq_all"], "blank" => ["blank"]}
+            key_groups = keys.inject(Hash.new([])){ |h,k| h[k.sub(/_(any|all)$/, '')] += [k]; h }
+            # Order compounds hash by 'only' keys
+            keys = only.map {|k| key_groups[k] }.flatten.compact
+          end
+        end
+        keys
+      end
+
       def predicate_select(options = {}, html_options = {})
         options = Ransack.options[:default_predicates] || {} if options.blank?
 
@@ -154,5 +170,6 @@ module Ransack
         nil
       end
     end
+
   end
-end
+end

data/lib/ransack_ui/ransack_overrides/nodes/condition.rb

@@ -0,0 +1,13 @@
+require 'ransack/nodes/condition'
+
+module Ransack
+  module Nodes
+    Condition.class_eval do
+      attr_writer :is_default
+
+      def default?
+        @is_default
+      end
+    end
+  end
+end

data/lib/ransack_ui/ransack_overrides/nodes/grouping.rb

@@ -0,0 +1,20 @@
+require 'ransack/nodes/grouping'
+
+module Ransack
+  module Nodes
+    Grouping.class_eval do
+
+      def new_condition(opts = {})
+        attrs = opts[:attributes] || 1
+        vals = opts[:values] || 1
+        condition = Condition.new(@context)
+        condition.predicate_name = opts[:predicate] || 'eq'
+        condition.is_default = true
+        attrs.times { condition.build_attribute }
+        vals.times { condition.build_value }
+        condition
+      end
+
+    end
+  end
+end

data/lib/ransack_ui/version.rb

@@ -1,3 +1,3 @@
 module RansackUI
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/ransack_ui.rb

@@ -6,3 +6,5 @@ require "ransack_chronic"
 # Require ransack overrides
 require 'ransack_ui/adapters/active_record'
 Dir.glob(File.expand_path('../ransack_ui/ransack_overrides/**/*.rb', __FILE__)) {|f| require f }
+
+require "ransack"

data/ransack_ui.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'ransack_chronic'
+  gem.add_dependency 'ransack_chronic', '>= 1.1.0'
+  gem.add_dependency 'ransack'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack_ui
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack_chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: ransack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -48,10 +64,10 @@ files:
 - app/assets/javascripts/ransack_ui_jquery/search_form.js.coffee.erb
 - app/assets/stylesheets/ransack_ui_bootstrap/index.css
 - app/assets/stylesheets/ransack_ui_bootstrap/search.css.scss
-- app/views/ransack_ui/_condition_fields.html.haml
-- app/views/ransack_ui/_grouping_fields.html.haml
-- app/views/ransack_ui/_search.html.haml
-- app/views/ransack_ui/_sort_fields.html.haml
+- app/views/ransack_ui/_condition_fields.html.erb
+- app/views/ransack_ui/_grouping_fields.html.erb
+- app/views/ransack_ui/_search.html.erb
+- app/views/ransack_ui/_sort_fields.html.erb
 - config/locales/en.yml
 - lib/core_ext/enumerable.rb
 - lib/ransack_ui.rb
@@ -63,6 +79,8 @@ files:
 - lib/ransack_ui/ransack_overrides/configuration.rb
 - lib/ransack_ui/ransack_overrides/context.rb
 - lib/ransack_ui/ransack_overrides/helpers/form_builder.rb
+- lib/ransack_ui/ransack_overrides/nodes/condition.rb
+- lib/ransack_ui/ransack_overrides/nodes/grouping.rb
 - lib/ransack_ui/version.rb
 - lib/ransack_ui/view_helpers.rb
 - ransack_ui.gemspec
@@ -81,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3453459259470944049
+      hash: 1751889683287985587
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3453459259470944049
+      hash: 1751889683287985587
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21

data/app/views/ransack_ui/_condition_fields.html.haml

@@ -1,13 +0,0 @@
-.fields.condition{ "data-object-name" => f.object_name }
-  %p
-    = link_to_remove_fields t('ransack.remove_condition'), f, options
-
-    = f.attribute_fields do |a|
-      %span.fields{ "data-object-name" => f.object_name }
-      = a.attribute_select({}, :class => 'ransack_attribute')
-
-    = f.predicate_select({}, :class => 'ransack_predicate')
-
-    = f.value_fields do |v|
-      %span.fields.value{ 'data-object-name' => f.object_name }
-      = v.text_field :value, :style => "width: 200px;", :class => "ransack_query"

data/app/views/ransack_ui/_grouping_fields.html.haml

@@ -1,13 +0,0 @@
-.fields.well{ 'data-object-name' => f.object_name }
-  .combinator
-    - key = (f.object_name =~ /[0]/) ? :group_first : :group_rest
-    - combinator = f.combinator_select({}, :class => 'ransack_combinator')
-    = t("ransack.#{key}", :combinator => combinator).html_safe
-
-  .filters
-    - f.object.build_condition unless f.object.conditions.any?
-    = f.condition_fields do |c|
-      = render 'ransack_ui/condition_fields', :f => c, :options => options
-
-    %p
-      = link_to_add_fields t('ransack.add_condition'), f, :condition, options

data/app/views/ransack_ui/_search.html.haml

@@ -1,23 +0,0 @@
-= search_form_for @ransack_search, :url => (options[:url] || url_for(:action => :index)),
-  :html => {:method => :get, :class => "ransack_search"}, :remote => !!options[:remote] do |f|
-
-  :javascript
-    if (window.Ransack == null) { window.Ransack = {}; }
-    Ransack.alt_predicates_i18n = #{I18n.translate(:"ransack.predicates.alt", :default => {}).to_json}
-
-  .row
-    .span12.well
-    
-      = f.sort_fields do |s|
-        = render 'ransack_ui/sort_fields', :f => s
-
-      = f.grouping_fields do |g|
-        = render 'ransack_ui/grouping_fields', :f => g, :options => options
-
-      %p
-        = link_to_add_fields t('ransack.add_group'), f, :grouping, options
-
-      .pull-right
-        = hidden_field_tag :distinct, '1'
-        = hidden_field_tag :page, '1'
-        = f.submit t('ransack.submit'), :class => 'btn btn-primary btn-large'

data/app/views/ransack_ui/_sort_fields.html.haml

@@ -1,3 +0,0 @@
-.fields.sort
-  %span.sort_by Sort by:
-  = f.sort_select