ransack_memory 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10e3fba05938906e50d390712345e76dbd704390
-  data.tar.gz: ecd1d5cd30a20f5e5b9768df2d1795b0f18a560f
+  metadata.gz: 7e18e02f0204f759edc457fc98899ad16d731690
+  data.tar.gz: b280afa8586cc6b6595011434fb809e661ecc4e0
 SHA512:
-  metadata.gz: 397f29e47cd222fe96ca649b9a1019dd9e414f917744860851a0aac790d3f8cb11dc5ff471eb4dfb57352931cf8f4cf7fc1b32f87d122154284fb008b6a39301
-  data.tar.gz: f23736495ce5aab52fdf3ce2879e307a5d8ddeee649544a593e918e4811206a3109a15df7acc422630085b3ebadd8ea89d6a4419dc8eec4756af930379b4052c
+  metadata.gz: 965a6bbe5a161c331c487ddf75379b4cb866ac293c32e354507728026c4750eb358813fa2dc6b16f17f428fb10ce90c3d4d8b3fb6263fb9cca2dec1f65348cae
+  data.tar.gz: 1a7e5aa376ad22eedb637cb883daec678a8d7daab72f4befdc1603461b5a04f8a1143347c860805924a90fb392312095d0646297d319f46748d42d6d338450a9

data/README.md

@@ -7,4 +7,39 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'ransack_memory'
-```
+```
+
+Add this line to your basic controller (typically ApplicationController):
+
+```ruby
+class ApplicationController < ActionController::Base
+  include RansackMemory::Concern # insert this line
+
+  before_action :authenticate_user! # only if you use Devise gem
+  before_action :save_and_load_filters # insert this line after Devise auth before filter (Devise gem is not necessary)
+end
+```
+
+Add this in your views where you have search forms. This is clear button, which deletes ransack memory sessions.
+```erb
+<%= clear_filter %>
+```
+You can pass any of link attributes:
+
+```erb
+<%= clear_filter, class: 'btn btn-primary', data: {confirm: 'Really?', my_data: 'something'} %>
+```
+
+## Configuration
+
+Create file in config/initializers/ransack_memory.rb with this content:
+
+```ruby
+RansackMemory::Core.config = {
+  param: :q, # this means the default Ransack param name for searching. You can change it
+  link_label: 'Clear filter' # clear_filter link label
+}
+```
+
+Or you can generate this config file by running ```rails generate ransack_memory``` in console. 
+

data/app/controllers/concerns/{ransack_memory.rb → ransack_memory/concern.rb}

@@ -1,5 +1,5 @@
-module Concerns
-  module RansackMemory
+module RansackMemory
+  module Concern
     extend ActiveSupport::Concern
 
     def save_and_load_filters
@@ -13,7 +13,7 @@ module Concerns
 
       if user_signed_in?
         # search term saving
-        session["#{controller_name}_#{action_name}_#{request.xhr?}"] = params[RansackMemory.config[:param]] if params[RansackMemory.config[:param]].present?
+        session["#{controller_name}_#{action_name}_#{request.xhr?}"] = params[::RansackMemory::Core.config[:param]] if params[::RansackMemory::Core.config[:param]].present?
 
         # page number saving
         session["#{controller_name}_#{action_name}_#{request.xhr?}_page"] = params[:page] if params[:page].present?
@@ -25,9 +25,9 @@ module Concerns
       if user_signed_in?
         # search term load
         if session["#{controller_name}_#{action_name}_#{request.xhr?}"]
-          params[RansackMemory.config[:param]] = session["#{controller_name}_#{action_name}_#{request.xhr?}"]
+          params[::RansackMemory::Core.config[:param]] = session["#{controller_name}_#{action_name}_#{request.xhr?}"]
         else
-          params[RansackMemory.config[:param]] = nil
+          params[::RansackMemory::Core.config[:param]] = nil
         end
 
         # page number load
@@ -38,11 +38,11 @@ module Concerns
         end
 
         # set page number to 1 if filter has changed
-        if (params[RansackMemory.config[:param]] && session[:last_q_params] != params[RansackMemory.config[:param]]) || (params[:cancel_filter].present? && session["#{controller_name}_#{action_name}_#{request.xhr?}_page"] != params[:page])
+        if (params[::RansackMemory::Core.config[:param]] && session[:last_q_params] != params[::RansackMemory::Core.config[:param]]) || (params[:cancel_filter].present? && session["#{controller_name}_#{action_name}_#{request.xhr?}_page"] != params[:page])
           params[:page] = nil
           session["#{controller_name}_#{action_name}_#{request.xhr?}_page"] = nil
         end
-        session[:last_q_params] = params[RansackMemory.config[:param]]
+        session[:last_q_params] = params[::RansackMemory::Core.config[:param]]
 
         # per page load
         if session["#{controller_name}_#{action_name}_#{request.xhr?}_per_page"]

data/app/views/shared/_ransack_memory_clear_filter.html.haml

@@ -1,2 +1,2 @@
-- if params[RansackMemory.config[:param]].present?
-  = link_to 'Clear filter', url_for + "?cancel_filter=true", opts
+- if params[RansackMemory::Core.config[:param].presence || :q].present?
+  = link_to RansackMemory::Core.config[:link_label].presence || 'Clear filter', url_for + "?cancel_filter=true", opts

data/lib/generators/ransack_memory_generator.rb

@@ -2,9 +2,10 @@ if defined?(Rails)
 
   # Rails3 generator invoked with 'rails generate ransack_memory'
   class RansackMemoryGenerator < Rails::Generators::Base
-    source_root(File.expand_path(File.dirname(__FILE__) + "/../../generators/ransack_memory/templates"))
+    source_root(File.expand_path(File.dirname(__FILE__) + "/../templates/ransack_memory"))
     def copy_initializer
-      copy_file 'ransack_memory.rb', 'config/initializers/ransack_memory.rb'
+
+      copy_file 'ransack_memory_template.rb', 'config/initializers/ransack_memory.rb'
     end
   end
 

data/lib/ransack_memory.rb

@@ -1,9 +1,15 @@
-class RansackMemory
-  @@config = {}
-  cattr_accessor :config
+module RansackMemory
 
-  def initialize(opts = {})
-    @opts = opts
+  require 'ransack_memory/version'
+  require 'ransack_memory/engine' if defined?(::Rails)
+
+  class Core
+    @@config = {}
+    cattr_accessor :config
+
+    def initialize(opts = {})
+      @opts = opts
+    end
   end
 
 end

data/lib/ransack_memory/engine.rb

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

data/lib/ransack_memory/version.rb

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

data/lib/templates/ransack_memory/ransack_memory_template.rb

@@ -0,0 +1,4 @@
+RansackMemory::Core.config = {
+  param: :q, # this means the default Ransack param name for searching. You can change it
+  link_label: 'Clear filter' # clear_filter link label
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack_memory
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Lapiš
@@ -17,11 +17,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- app/controllers/concerns/ransack_memory.rb
+- app/controllers/concerns/ransack_memory/concern.rb
 - app/helpers/ransack_memory_helper.rb
 - app/views/shared/_ransack_memory_clear_filter.html.haml
 - lib/generators/ransack_memory_generator.rb
 - lib/ransack_memory.rb
+- lib/ransack_memory/engine.rb
+- lib/ransack_memory/version.rb
+- lib/templates/ransack_memory/ransack_memory_template.rb
 homepage: https://github.com/richardrails/ransack_memory
 licenses:
 - MIT