ransack_advanced_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58cff2d8f37ca95aca53690bf22a9268395b0187
+  data.tar.gz: c4686f564b1c1b45d981ecc29c97b6367bec2399
+SHA512:
+  metadata.gz: 31acaca1592e2d482bc0e65d922c5db0c06a432aa8d5fa36537a0597f4fae9f906535154bf324f9e0323d2b79cd6c8f92397a7cb61b6b3e35d20ab55b108b2c8
+  data.tar.gz: 92d0c9a03397df1a6edf0673288ad324f6c45ba7132d99f996b6def7bdd015238ab3c72b2b758b414754fa2a85ce6aa9405b39a5590ee6b1ee94dbb35d9b5e5b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 David Brusius
+
+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.rdoc

@@ -0,0 +1,6 @@
+= RansackAdvancedSearch
+
+inflect.irregular 'saved_search', 'saved_searches'
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RansackAdvancedSearch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/ransack_advanced_search/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/app/assets/javascripts/ransack_advanced_search/ransack_advanced_search.js

@@ -0,0 +1,34 @@
+(function() {
+  this.Search = (function() {
+    function Search(templates) {
+      this.templates = templates != null ? templates : {};
+    }
+
+    Search.prototype.remove_fields = function(button) {
+      return $(button).closest('.fields').remove();
+    };
+
+    Search.prototype.add_fields = function(button, type, content) {
+      var new_id, regexp;
+      new_id = new Date().getTime();
+      regexp = new RegExp('new_' + type, 'g');
+      return $(button).before(content.replace(regexp, new_id));
+    };
+
+    Search.prototype.nest_fields = function(button, type) {
+      var id_regexp, new_id, object_name, sanitized_object_name, template;
+      new_id = new Date().getTime();
+      id_regexp = new RegExp('new_' + type, 'g');
+      template = this.templates[type];
+      object_name = $(button).closest('.fields').attr('data-object-name');
+      sanitized_object_name = object_name.replace(/\]\[|[^-a-zA-Z0-9:.]/g, '_').replace(/_$/, '');
+      template = template.replace(/new_object_name\[/g, object_name + "[");
+      template = template.replace(/new_object_name_/, sanitized_object_name + '_');
+      return $(button).before(template.replace(id_regexp, new_id));
+    };
+
+    return Search;
+
+  })();
+
+}).call(this);

data/app/assets/stylesheets/ransack_advanced_search/application.css

@@ -0,0 +1,17 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */
+
+.ransack-advanced-search i.remove_fields {
+  cursor: pointer;
+ }

data/app/controllers/concerns/ransack_advanced_search/saved_search_utils.rb

@@ -0,0 +1,59 @@
+module RansackAdvancedSearch
+  module SavedSearchUtils
+    extend ActiveSupport::Concern
+
+    # Perform saved searches actions to provide full functionality with one method
+    def perform_saved_searches_actions(context, params={})
+      get_saved_searches(context)
+      save_or_update_saved_search(params.merge(context: context))
+      get_params_to_search(context)
+    end
+
+    # Get list of Saved Search by context
+    def get_saved_searches(context)
+      @saved_searches = SavedSearch.where(context: context)
+    end
+
+    # Return params of Saved Search or search form params
+    def get_params_to_search(context)
+      if params[:saved_search].present?
+        @saved_search = SavedSearch.find_by(id: params[:saved_search], context: context)
+      end
+      return params[:q] if params[:use_search_params].present?
+      params[:q] = @saved_search.try(:search_params) || params[:q]
+    end
+
+    # Save or update Saved Search
+    def save_or_update_saved_search(params)
+      if params[:save_new_search].present? || params[:save_search].present?
+        if params[:save_new_search].present?
+          @saved_search = new_saved_search(params)
+        elsif params[:save_search].present? && params[:saved_search].present?
+          @saved_search = update_saved_search(params)
+        elsif params[:save_search].present?
+          @saved_search = new_saved_search(params)
+        end
+
+        if @saved_search.save
+          flash[:notice] = t('ransack.saved_search.save.success')
+        else
+          flash[:error] = t('ransack.saved_search.save.error')
+        end
+      end
+    end
+
+    def new_saved_search(params)
+      SavedSearch.new(
+       context: params[:context], description: params[:description],
+       search_params: params[:q]
+      )
+    end
+
+    def update_saved_search(params)
+      saved_search = SavedSearch.find_by(id: params[:saved_search], context: params[:context])
+      saved_search.description = params[:description]
+      saved_search.search_params = params[:q]
+      saved_search
+    end
+  end
+end

data/app/controllers/ransack_advanced_search/application_controller.rb

@@ -0,0 +1,5 @@
+module RansackAdvancedSearch
+  class ApplicationController < ActionController::Base
+    protect_from_forgery :with => :exception
+  end
+end

data/app/helpers/ransack_advanced_search_helper.rb

@@ -0,0 +1,39 @@
+module RansackAdvancedSearchHelper
+  def setup_search_form(builder)
+    fields = builder.grouping_fields builder.object.new_grouping,
+      object_name: 'new_object_name', child_index: "new_grouping" do |f|
+      render('ransack_advanced_search/grouping_fields', f: f)
+    end
+    content_for :ransack_setup, %Q{
+      var search = new Search({grouping: "#{escape_javascript(fields)}"});
+      $(document).on("click", "button.add_fields", function() {
+        search.add_fields(this, $(this).data('fieldType'), $(this).data('content'));
+        return false;
+      });
+      $(document).on("click", "i.remove_fields", function() {
+        search.remove_fields(this);
+        return false;
+      });
+      $(document).on("click", "button.nest_fields", function() {
+        search.nest_fields(this, $(this).data('fieldType'));
+        return false;
+      });
+    }.html_safe
+  end
+
+  def button_to_remove_fields
+    content_tag :i, nil, class: 'remove_fields glyphicon glyphicon-remove text-danger'
+  end
+
+  def button_to_add_fields(name, f, type)
+    new_object = f.object.send "build_#{type}"
+    fields = f.send("#{type}_fields", new_object, child_index: "new_#{type}") do |builder|
+      render('ransack_advanced_search/' + type.to_s + "_fields", f: builder)
+    end
+    content_tag :button, name, :class => 'add_fields btn btn-default btn-sm', :type => 'button', 'data-field-type' => type, 'data-content' => "#{fields}"
+  end
+
+  def button_to_nest_fields(name, type)
+    content_tag :button, name, :class => 'nest_fields', 'data-field-type' => type
+  end
+end

data/app/models/saved_search.rb

@@ -0,0 +1,5 @@
+class SavedSearch < ActiveRecord::Base
+  validates_presence_of :context, :description, :search_params
+
+  serialize :search_params
+end

data/app/views/ransack_advanced_search/_advanced_search.html.erb

@@ -0,0 +1,73 @@
+<div class="ransack-advanced-search">
+
+  <div class="row">
+    <div class="col-md-4">
+      <div class="panel panel-primary">
+        <div class="panel-heading"><%= t('ransack.saved_search.title') %></div>
+        <div class="list-group lista-buscas">
+          <% @saved_searches.each do |saved_search| %>
+            <%= link_to url_for(saved_search: saved_search.id), method: :post, class: 'list-group-item' do %>
+              <%= saved_search.description %>
+            <% end %>
+          <% end %>
+          <% if @saved_searches.empty? %>
+            <%= link_to '#', class: 'list-group-item' do %>
+              <em><%= t('ransack.saved_search.empty_list') %></em>
+            <% end %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+    <div class="col-md-8">
+      <%= search_form_for(@search, url: search_url, html: { method: :post, class: 'form-vertical', role: 'form'  }) do |f| %>
+
+        <% setup_search_form f %>
+
+        <div class="form-group">
+          <%= label_tag 'Descrição da Busca (necessária para salvar a busca)' %>
+          <%= text_field_tag :description, @saved_search.try(:description), class: 'form-control input-sm' %>
+          <% if @saved_search %>
+            <%= hidden_field_tag :saved_search, @saved_search.id %>
+            <%= hidden_field_tag :use_search_params, true %>
+          <% end %>
+        </div>
+
+        <h4><%= t('ransack.advanced_search.sort.title') %></h4>
+        <div class="form-group">
+          <%= f.sort_fields do |s| %>
+            <%= render 'ransack_advanced_search/sort_fields', f: s %>
+          <% end %>
+          <%= button_to_add_fields t('ransack.advanced_search.sort.add'), f, :sort %>
+        </div>
+
+        <h4><%= t('ransack.advanced_search.condition_group.title') %></h4>
+        <div class="form-group">
+          <%= f.grouping_fields do |g| %>
+            <%= render 'ransack_advanced_search/grouping_fields', f: g %>
+          <% end %>
+          <%= button_to_add_fields t('ransack.advanced_search.condition_group.add'),
+              f, :grouping %>
+        </div>
+
+        <!-- <%= label_tag :distinct, 'Return distinct records?' %> -->
+        <!-- <%= check_box_tag :distinct, '1', params[:distinct].to_i == 1 %> -->
+        <div class="form-group">
+          <%= f.submit t('ransack.advanced_search.form.submit_text'), class: 'btn btn-primary' %>
+          <%= f.submit t('ransack.advanced_search.form.save_submit_text'), name: 'save_search', class: 'btn btn-primary' %>
+          <%= f.submit t('ransack.advanced_search.form.save_new_submit_text'), name: 'save_new_search', class: 'btn btn-primary' %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>
+
+<% content_for(:ransack_advanced_search_setup) do %>
+  <%= stylesheet_link_tag 'ransack_advanced_search/application', media: 'all' %>
+  <%= javascript_include_tag 'ransack_advanced_search/application' %>
+
+  <script>
+    $(document).ready(function () {
+      <%= yield(:ransack_setup) %>
+    });
+  </script>
+<% end %>

data/app/views/ransack_advanced_search/_attribute_fields.erb

@@ -0,0 +1,3 @@
+<%= content_tag(:span,
+  f.attribute_select({associations: %w(posts comments)}, {class: 'form-control input-sm'}),
+  { class: 'fields', 'data-object-name' => f.object_name }, false) %>

data/app/views/ransack_advanced_search/_condition_fields.erb

@@ -0,0 +1,21 @@
+<%= content_tag :div, {
+  class: 'fields condition', 'data-object-name' => f.object_name
+  } do %>
+
+  <%= content_tag(:span, button_to_remove_fields,
+    nil, false) %>
+
+  <%= f.attribute_fields do |a| %>
+    <%= render 'ransack_advanced_search/attribute_fields', f: a %>
+  <% end %>
+
+  <%= f.predicate_select({}, {class: 'form-control input-sm'}) %>
+
+  <%= f.value_fields do |v| %>
+    <%= render 'ransack_advanced_search/value_fields', f: v %>
+  <% end %>
+
+  <%= button_to_add_fields t('ransack.advanced_search.attribute_value.add'),
+      f, :value %>
+
+<% end %>

data/app/views/ransack_advanced_search/_grouping_fields.erb

@@ -0,0 +1,20 @@
+<%= content_tag :div, { class: 'fields',
+  'data-object-name' => f.object_name } do %>
+
+
+  <%= content_tag(:span, "#{t('ransack.advanced_search.condition_group.match')}
+    #{f.combinator_select} #{t('ransack.advanced_search.condition_group.match_condition')}
+    #{button_to_remove_fields}", nil, false) %>
+
+  <%= f.condition_fields do |c| %>
+    <%= render 'ransack_advanced_search/condition_fields', f: c %>
+  <% end %>
+
+  <%= button_to_add_fields t('ransack.advanced_search.attribute_field.add'),
+      f, :condition %>
+
+  <%= f.grouping_fields do |g| %>
+    <%= render 'ransack_advanced_search/grouping_fields', f: g %>
+  <% end %>
+
+<% end %>

data/app/views/ransack_advanced_search/_sort_fields.erb

@@ -0,0 +1,3 @@
+<%= content_tag(:span,
+  "#{f.sort_select({}, {class: 'form-control input-sm'})} #{button_to_remove_fields}",
+  { class: 'fields', 'data-object-name' => f.object_name }, false) %>

data/app/views/ransack_advanced_search/_value_fields.erb

@@ -0,0 +1,2 @@
+<%= content_tag(:span, f.text_field(:value, {class: 'form-control input-sm'}),
+  { class: 'fields value', 'data-object-name' => f.object_name }, false) %>

data/config/initializers/ransack_advanced_search.rb

@@ -0,0 +1 @@
+Rails.application.config.i18n.fallbacks = [:en]

data/config/locales/ransack.en.yml

@@ -0,0 +1,94 @@
+en:
+  ransack:
+    advanced_search:
+      form:
+        submit_text: Search
+        save_submit_text: Save and Search
+        save_new_submit_text: Save as new and Search
+      sort:
+        title: Sort
+        label_title: Sort by
+        add: Add Sort
+      condition_group:
+        title: Condition Groups
+        add: Add Condition Group
+        match: Match
+        match_condition: conditions
+      attribute_field:
+        add: Add Condition
+      attribute_value:
+        add: Add Value
+    saved_search:
+      title: Saved Searches
+      empty_list: There are no saved searches in this context.
+      save:
+        success: Search saved successfully.
+        error: Error while saving the search. You must enter a description of the search and at least one filter.
+    search: "search"
+    predicate: "predicate"
+    and: "and"
+    or: "or"
+    any: "any"
+    all: "all"
+    combinator: "combinator"
+    attribute: "attribute"
+    value: "value"
+    condition: "condition"
+    sort: "sort"
+    asc: "ascending"
+    desc: "descending"
+    predicates:
+      eq: "equals"
+      eq_any: "equals any"
+      eq_all: "equals all"
+      not_eq: "not equal to"
+      not_eq_any: "not equal to any"
+      not_eq_all: "not equal to all"
+      matches: "matches"
+      matches_any: "matches any"
+      matches_all: "matches all"
+      does_not_match: "doesn't match"
+      does_not_match_any: "doesn't match any"
+      does_not_match_all: "doesn't match all"
+      lt: "less than"
+      lt_any: "less than any"
+      lt_all: "less than all"
+      lteq: "less than or equal to"
+      lteq_any: "less than or equal to any"
+      lteq_all: "less than or equal to all"
+      gt: "greater than"
+      gt_any: "greater than any"
+      gt_all: "greater than all"
+      gteq: "greater than or equal to"
+      gteq_any: "greater than or equal to any"
+      gteq_all: "greater than or equal to all"
+      in: "in"
+      in_any: "in any"
+      in_all: "in all"
+      not_in: "not in"
+      not_in_any: "not in any"
+      not_in_all: "not in all"
+      cont: "contains"
+      cont_any: "contains any"
+      cont_all: "contains all"
+      not_cont: "doesn't contain"
+      not_cont_any: "doesn't contain any"
+      not_cont_all: "doesn't contain all"
+      start: "starts with"
+      start_any: "starts with any"
+      start_all: "starts with all"
+      not_start: "doesn't start with"
+      not_start_any: "doesn't start with any"
+      not_start_all: "doesn't start with all"
+      end: "ends with"
+      end_any: "ends with any"
+      end_all: "ends with all"
+      not_end: "doesn't end with"
+      not_end_any: "doesn't end with any"
+      not_end_all: "doesn't end with all"
+      'true': "is true"
+      'false': "is false"
+      present: "is present"
+      blank: "is blank"
+      'null': "is null"
+      not_null: "is not null"

data/config/locales/ransack.pt-BR.yml

@@ -0,0 +1,93 @@
+pt-BR:
+  ransack:
+    advanced_search:
+      form:
+        submit_text: Pesquisar
+        save_submit_text: Salvar e Pesquisar
+        save_new_submit_text: Salvar nova e Pesquisar
+      sort:
+        title: Ordenação
+        add: Adicionar ordenação
+      condition_group:
+        title: Grupos de filtros
+        add: Adicionar grupo
+        match: Filtrar
+        match_condition: condições
+      attribute_field:
+        add: Adicionar filtro
+      attribute_value:
+        add: Adicionar valor
+    saved_search:
+      title: Buscas Salvas
+      empty_list: Não existem buscas salvas para este contexto.
+      save:
+        success: Busca salva com sucesso.
+        error: Erro ao salvar a busca. Você precisa informar a descrição da busca e pelo menos um filtro.
+    search: "pesquisar"
+    predicate: "predicado"
+    and: "e"
+    or: "ou"
+    any: "alguma das"
+    all: "todas as"
+    combinator: "combinador"
+    attribute: "atributo"
+    value: "valor"
+    condition: "condição"
+    sort: "classificar"
+    asc: "ascendente"
+    desc: "descendente"
+    predicates:
+      eq: "igual"
+      eq_any: "igual a algum"
+      eq_all: "igual a todos"
+      not_eq: "não é igual a"
+      not_eq_any: "não é igual a algum"
+      not_eq_all: "não é igual a todos"
+      matches: "corresponde"
+      matches_any: "corresponde a algum"
+      matches_all: "corresponde a todos"
+      does_not_match: "não corresponde"
+      does_not_match_any: "não corresponde a algum"
+      does_not_match_all: "não corresponde a todos"
+      lt: "menor que"
+      lt_any: "menor que algum"
+      lt_all: "menor que todos"
+      lteq: "menor ou igual a"
+      lteq_any: "menor ou igual a algum"
+      lteq_all: "menor ou igual a todos"
+      gt: "maior que"
+      gt_any: "maior que algum"
+      gt_all: "maior que todos"
+      gteq: "maior que ou igual a"
+      gteq_any: "maior que ou igual a algum"
+      gteq_all: "maior que ou igual a todos"
+      in: "em"
+      in_any: "em algum"
+      in_all: "em todos"
+      not_in: "não em"
+      not_in_any: "não em algum"
+      not_in_all: "não em todos"
+      cont: "contém"
+      cont_any: "contém algum"
+      cont_all: "contém todos"
+      not_cont: "não contém"
+      not_cont_any: "não contém algum"
+      not_cont_all: "não contém todos"
+      start: "começa com"
+      start_any: "começa com algum"
+      start_all: "começa com todos"
+      not_start: "não começa com"
+      not_start_any: "não começa com algum"
+      not_start_all: "não começa com algum"
+      end: "termina com"
+      end_any: "termina com algum"
+      end_all: "termina com todos"
+      not_end: "não termina com"
+      not_end_any: "não termina com algum"
+      not_end_all: "não termina com todos"
+      'true': "é verdadeiro"
+      'false': "é falso"
+      present: "está presente"
+      blank: "está em branco"
+      'null': "é nullo"
+      not_null: "não é nulo"

data/config/routes.rb

@@ -0,0 +1,2 @@
+RansackAdvancedSearch::Engine.routes.draw do
+end

data/lib/generators/ransack_advanced_search/saved_search_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+module RansackAdvancedSearch
+  module Generators
+    class SavedSearchGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      include Rails::Generators::Migration
+      desc "Creates a Saved Search model and migrations to save advanced searches made with Ransack."
+      class_option :orm
+
+      desc 'add the migrations'
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_ransack_advanced_search_saved_search.rb", "db/migrate/create_ransack_advanced_search_saved_search.rb"
+      end
+
+    end
+
+  end
+end

data/lib/generators/templates/create_ransack_advanced_search_saved_search.rb

@@ -0,0 +1,11 @@
+class CreateRansackAdvancedSearchSavedSearch < ActiveRecord::Migration
+  def change
+    create_table :saved_searches do |t|
+      t.string :context, null: false
+      t.string :description, null: false
+      t.text :search_params, null: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/ransack_advanced_search/engine.rb

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

data/lib/ransack_advanced_search/version.rb

@@ -0,0 +1,3 @@
+module RansackAdvancedSearch
+  VERSION = "0.1.0"
+end

data/lib/ransack_advanced_search.rb

@@ -0,0 +1,7 @@
+require 'ransack_advanced_search/engine'
+require 'rails'
+require 'ransack'
+
+
+module RansackAdvancedSearch
+end

data/lib/tasks/ransack_advanced_search_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ransack_advanced_search do
+#   # Task goes here
+# end