├── test ├── dummy │ ├── log │ │ └── .gitkeep │ ├── app │ │ ├── mailers │ │ │ └── .gitkeep │ │ ├── models │ │ │ └── .gitkeep │ │ ├── helpers │ │ │ └── application_helper.rb │ │ ├── controllers │ │ │ └── application_controller.rb │ │ ├── views │ │ │ └── layouts │ │ │ │ └── application.html.erb │ │ └── assets │ │ │ ├── stylesheets │ │ │ └── application.css │ │ │ └── javascripts │ │ │ └── application.js │ ├── lib │ │ └── assets │ │ │ └── .gitkeep │ ├── public │ │ ├── favicon.ico │ │ ├── 500.html │ │ ├── 422.html │ │ └── 404.html │ ├── config │ │ ├── routes.rb │ │ ├── environment.rb │ │ ├── locales │ │ │ └── en.yml │ │ ├── initializers │ │ │ ├── mime_types.rb │ │ │ ├── backtrace_silencers.rb │ │ │ ├── session_store.rb │ │ │ ├── secret_token.rb │ │ │ ├── wrap_parameters.rb │ │ │ └── inflections.rb │ │ ├── boot.rb │ │ ├── database.yml │ │ ├── environments │ │ │ ├── development.rb │ │ │ ├── test.rb │ │ │ └── production.rb │ │ └── application.rb │ ├── config.ru │ ├── Rakefile │ ├── script │ │ └── rails │ └── README.rdoc ├── ransack_advanced_search_test.rb ├── integration │ └── navigation_test.rb └── test_helper.rb ├── app ├── assets │ ├── images │ │ └── ransack_advanced_search │ │ │ └── .gitkeep │ ├── javascripts │ │ └── ransack_advanced_search │ │ │ ├── application.js │ │ │ └── ransack_advanced_search.js │ └── stylesheets │ │ └── ransack_advanced_search │ │ └── application.css ├── models │ └── saved_search.rb ├── controllers │ ├── ransack_advanced_search │ │ └── application_controller.rb │ ├── saved_searches_controller.rb │ └── concerns │ │ └── ransack_advanced_search │ │ └── saved_search_utils.rb ├── views │ └── ransack_advanced_search │ │ ├── _value_fields.erb │ │ ├── _sort_fields.erb │ │ ├── _attribute_fields.erb │ │ ├── _condition_fields.erb │ │ ├── _saved_searches_list.erb │ │ ├── _grouping_fields.erb │ │ ├── _quick_search.html.erb │ │ └── _advanced_search.html.erb └── helpers │ └── ransack_advanced_search_helper.rb ├── lib ├── ransack_advanced_search │ ├── version.rb │ ├── engine.rb │ └── helpers │ │ └── configuration.rb ├── tasks │ └── ransack_advanced_search_tasks.rake ├── generators │ ├── templates │ │ ├── ransack_advanced_search.rb │ │ └── create_ransack_advanced_search_saved_search.rb │ └── ransack_advanced_search │ │ ├── install_generator.rb │ │ └── saved_search_generator.rb └── ransack_advanced_search.rb ├── config ├── initializers │ └── ransack_advanced_search_setup.rb ├── routes.rb └── locales │ ├── ransack.en.yml │ └── ransack.pt-BR.yml ├── .gitignore ├── script └── rails ├── Gemfile ├── ransack_advanced_search.gemspec ├── Rakefile ├── MIT-LICENSE ├── Gemfile.lock └── README.md /test/dummy/log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/app/mailers/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/app/models/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/lib/assets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/assets/images/ransack_advanced_search/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/dummy/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /lib/ransack_advanced_search/version.rb: -------------------------------------------------------------------------------- 1 | module RansackAdvancedSearch 2 | VERSION = "0.1.8" 3 | end 4 | -------------------------------------------------------------------------------- /config/initializers/ransack_advanced_search_setup.rb: -------------------------------------------------------------------------------- 1 | Rails.application.config.i18n.fallbacks = [:en] 2 | -------------------------------------------------------------------------------- /config/routes.rb: -------------------------------------------------------------------------------- 1 | Rails.application.routes.draw do 2 | resources :saved_searches, only: [:destroy] 3 | end 4 | -------------------------------------------------------------------------------- /lib/ransack_advanced_search/engine.rb: -------------------------------------------------------------------------------- 1 | module RansackAdvancedSearch 2 | class Engine < ::Rails::Engine 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /test/dummy/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery 3 | end 4 | -------------------------------------------------------------------------------- /test/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | Rails.application.routes.draw do 2 | 3 | mount RansackAdvancedSearch::Engine => "/ransack_advanced_search" 4 | end 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bundle/ 2 | log/*.log 3 | pkg/ 4 | test/dummy/db/*.sqlite3 5 | test/dummy/log/*.log 6 | test/dummy/tmp/ 7 | test/dummy/.sass-cache 8 | *.gem 9 | -------------------------------------------------------------------------------- /lib/tasks/ransack_advanced_search_tasks.rake: -------------------------------------------------------------------------------- 1 | # desc "Explaining what the task does" 2 | # task :ransack_advanced_search do 3 | # # Task goes here 4 | # end 5 | -------------------------------------------------------------------------------- /app/models/saved_search.rb: -------------------------------------------------------------------------------- 1 | class SavedSearch < ActiveRecord::Base 2 | validates_presence_of :context, :description, :search_params 3 | 4 | serialize :search_params 5 | end 6 | -------------------------------------------------------------------------------- /test/dummy/config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require ::File.expand_path('../config/environment', __FILE__) 4 | run Dummy::Application 5 | -------------------------------------------------------------------------------- /lib/generators/templates/ransack_advanced_search.rb: -------------------------------------------------------------------------------- 1 | RansackAdvancedSearch.configuration do |config| 2 | 3 | # Enable feature for Saving Searches 4 | config.enable_saved_searches = false 5 | end 6 | -------------------------------------------------------------------------------- /test/dummy/config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the rails application 2 | require File.expand_path('../application', __FILE__) 3 | 4 | # Initialize the rails application 5 | Dummy::Application.initialize! 6 | -------------------------------------------------------------------------------- /test/ransack_advanced_search_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | class RansackAdvancedSearchTest < ActiveSupport::TestCase 4 | test "truth" do 5 | assert_kind_of Module, RansackAdvancedSearch 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /app/controllers/ransack_advanced_search/application_controller.rb: -------------------------------------------------------------------------------- 1 | module RansackAdvancedSearch 2 | class ApplicationController < ActionController::Base 3 | protect_from_forgery :with => :exception 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_value_fields.erb: -------------------------------------------------------------------------------- 1 | <%= content_tag(:span, f.text_field(:value, {class: 'form-control input-sm ransack-attribute-value'}), 2 | { class: 'fields value', 'data-object-name' => f.object_name }, false) %> 3 | -------------------------------------------------------------------------------- /test/integration/navigation_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | class NavigationTest < ActionDispatch::IntegrationTest 4 | fixtures :all 5 | 6 | # test "the truth" do 7 | # assert true 8 | # end 9 | end 10 | 11 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_sort_fields.erb: -------------------------------------------------------------------------------- 1 | <%= content_tag(:div, 2 | "#{button_to_remove_fields} #{f.sort_select({}, {class: 'form-control input-sm'})}", 3 | { class: 'fields', 'data-object-name' => f.object_name }, false) %> 4 | -------------------------------------------------------------------------------- /test/dummy/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Sample localization file for English. Add more files in this directory for other locales. 2 | # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points. 3 | 4 | en: 5 | hello: "Hello world" 6 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | # Mime::Type.register_alias "text/html", :iphone 6 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_attribute_fields.erb: -------------------------------------------------------------------------------- 1 | <%= content_tag(:span, 2 | f.attribute_select({associations: @search.klass.ransackable_associations}, {class: 'ransack-attribute-select form-control input-sm'}), 3 | { class: 'fields', 'data-object-name' => f.object_name }, false) %> 4 | -------------------------------------------------------------------------------- /test/dummy/config/boot.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | gemfile = File.expand_path('../../../../Gemfile', __FILE__) 3 | 4 | if File.exist?(gemfile) 5 | ENV['BUNDLE_GEMFILE'] = gemfile 6 | require 'bundler' 7 | Bundler.setup 8 | end 9 | 10 | $:.unshift File.expand_path('../../../../lib', __FILE__) -------------------------------------------------------------------------------- /test/dummy/Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | # Add your own tasks in files placed in lib/tasks ending in .rake, 3 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 4 | 5 | require File.expand_path('../config/application', __FILE__) 6 | 7 | Dummy::Application.load_tasks 8 | -------------------------------------------------------------------------------- /test/dummy/script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. 3 | 4 | APP_PATH = File.expand_path('../../config/application', __FILE__) 5 | require File.expand_path('../../config/boot', __FILE__) 6 | require 'rails/commands' 7 | -------------------------------------------------------------------------------- /test/dummy/app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Dummy 5 | <%= stylesheet_link_tag "application", :media => "all" %> 6 | <%= javascript_include_tag "application" %> 7 | <%= csrf_meta_tags %> 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /lib/ransack_advanced_search.rb: -------------------------------------------------------------------------------- 1 | require 'rails' 2 | require 'ransack' 3 | 4 | require 'ransack_advanced_search/engine' 5 | require 'ransack_advanced_search/version' 6 | require 'ransack_advanced_search/helpers/configuration' 7 | 8 | module RansackAdvancedSearch 9 | extend Configuration 10 | 11 | define_setting :enable_saved_searches, false 12 | end 13 | -------------------------------------------------------------------------------- /script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. 3 | 4 | ENGINE_ROOT = File.expand_path('../..', __FILE__) 5 | ENGINE_PATH = File.expand_path('../../lib/ransack_advanced_search/engine', __FILE__) 6 | 7 | require 'rails/all' 8 | require 'rails/engine/commands' 9 | -------------------------------------------------------------------------------- /lib/generators/templates/create_ransack_advanced_search_saved_search.rb: -------------------------------------------------------------------------------- 1 | class CreateRansackAdvancedSearchSavedSearch < ActiveRecord::Migration 2 | def change 3 | create_table :saved_searches do |t| 4 | t.string :context, null: false 5 | t.string :description, null: false 6 | t.text :search_params, null: false 7 | 8 | t.timestamps null: false 9 | end 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | Dummy::Application.config.session_store :cookie_store, key: '_dummy_session' 4 | 5 | # Use the database for sessions instead of the cookie-based default, 6 | # which shouldn't be used to store highly confidential information 7 | # (create the session table with "rails generate session_migration") 8 | # Dummy::Application.config.session_store :active_record_store 9 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | # Configure Rails Environment 2 | ENV["RAILS_ENV"] = "test" 3 | 4 | require File.expand_path("../dummy/config/environment.rb", __FILE__) 5 | require "rails/test_help" 6 | 7 | Rails.backtrace_cleaner.remove_silencers! 8 | 9 | # Load support files 10 | Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f } 11 | 12 | # Load fixtures from the engine 13 | if ActiveSupport::TestCase.method_defined?(:fixture_path=) 14 | ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__) 15 | end 16 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | # Make sure the secret is at least 30 characters and all random, 6 | # no regular words or you'll be exposed to dictionary attacks. 7 | Dummy::Application.config.secret_token = '37758d02ace58f6e9d614c330f8f665850f4b2242791be9b7116daa72010a2091de360dbf589523cc6d090dd1b5b0eb304a19ca83ea41deada4305857313b30a' 8 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] 9 | end 10 | 11 | # Disable root element in JSON by default. 12 | ActiveSupport.on_load(:active_record) do 13 | self.include_root_in_json = false 14 | end 15 | -------------------------------------------------------------------------------- /lib/generators/ransack_advanced_search/install_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/base' 2 | 3 | module RansackAdvancedSearch 4 | module Generators 5 | class InstallGenerator < Rails::Generators::Base 6 | source_root File.expand_path("../../templates", __FILE__) 7 | include Rails::Generators::Migration 8 | desc "Install Ransack Advanced Search" 9 | class_option :orm 10 | 11 | def copy_initializer 12 | template "ransack_advanced_search.rb", "config/initializers/ransack_advanced_search.rb" 13 | end 14 | end 15 | end 16 | end 17 | -------------------------------------------------------------------------------- /test/dummy/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format 4 | # (all these examples are active by default): 5 | # ActiveSupport::Inflector.inflections do |inflect| 6 | # inflect.plural /^(ox)$/i, '\1en' 7 | # inflect.singular /^(ox)en/i, '\1' 8 | # inflect.irregular 'person', 'people' 9 | # inflect.uncountable %w( fish sheep ) 10 | # end 11 | # 12 | # These inflection rules are supported but not enabled by default: 13 | # ActiveSupport::Inflector.inflections do |inflect| 14 | # inflect.acronym 'RESTful' 15 | # end 16 | -------------------------------------------------------------------------------- /test/dummy/app/assets/stylesheets/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the top of the 9 | * compiled file, but it's generally better to create a new file per style scope. 10 | * 11 | *= require_self 12 | *= require_tree . 13 | */ 14 | -------------------------------------------------------------------------------- /lib/ransack_advanced_search/helpers/configuration.rb: -------------------------------------------------------------------------------- 1 | module Configuration 2 | 3 | def configuration 4 | yield self 5 | end 6 | 7 | def define_setting(name, default = nil) 8 | class_variable_set("@@#{name}", default) 9 | 10 | define_class_method "#{name}=" do |value| 11 | class_variable_set("@@#{name}", value) 12 | end 13 | 14 | define_class_method name do 15 | class_variable_get("@@#{name}") 16 | end 17 | end 18 | 19 | private 20 | 21 | def define_class_method(name, &block) 22 | (class << self; self; end).instance_eval do 23 | define_method name, &block 24 | end 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Declare your gem's dependencies in ransack_advanced_search.gemspec. 4 | # Bundler will treat runtime dependencies like base dependencies, and 5 | # development dependencies will be added by default to the :development group. 6 | gemspec 7 | 8 | # jquery-rails is used by the dummy application 9 | gem "jquery-rails" 10 | 11 | # Declare any dependencies that are still in development here instead of in 12 | # your gemspec. These might include edge Rails or gems from your path or 13 | # Git. Remember to move these dependencies to your gemspec before releasing 14 | # your gem to rubygems.org. 15 | 16 | # To use debugger 17 | # gem 'debugger' 18 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_condition_fields.erb: -------------------------------------------------------------------------------- 1 | <%= content_tag :div, { 2 | class: 'fields condition ransack-condition-field', 'data-object-name' => f.object_name 3 | } do %> 4 | 5 | <%= content_tag(:span, button_to_remove_fields, {}, false) %> 6 | 7 | <%= f.attribute_fields do |a| %> 8 | <%= render 'ransack_advanced_search/attribute_fields', f: a %> 9 | <% end %> 10 | 11 | <%= f.predicate_select({}, {class: 'form-control input-sm'}) %> 12 | 13 | <%= f.value_fields do |v| %> 14 | <%= render 'ransack_advanced_search/value_fields', f: v %> 15 | <% end %> 16 | 17 | <%= button_to_add_fields '', f, :value, 'ransack-add-attribute' %> 18 | 19 | <% end %> 20 | -------------------------------------------------------------------------------- /app/assets/javascripts/ransack_advanced_search/application.js: -------------------------------------------------------------------------------- 1 | // This is a manifest file that'll be compiled into application.js, which will include all the files 2 | // listed below. 3 | // 4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, 5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path. 6 | // 7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the 8 | // the compiled file. 9 | // 10 | // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD 11 | // GO AFTER THE REQUIRES BELOW. 12 | // 13 | //= require_tree . 14 | -------------------------------------------------------------------------------- /test/dummy/config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | development: 7 | adapter: sqlite3 8 | database: db/development.sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | # Warning: The database defined as "test" will be erased and 13 | # re-generated from your development database when you run "rake". 14 | # Do not set this db to the same as development or production. 15 | test: 16 | adapter: sqlite3 17 | database: db/test.sqlite3 18 | pool: 5 19 | timeout: 5000 20 | 21 | production: 22 | adapter: sqlite3 23 | database: db/production.sqlite3 24 | pool: 5 25 | timeout: 5000 26 | -------------------------------------------------------------------------------- /app/controllers/saved_searches_controller.rb: -------------------------------------------------------------------------------- 1 | class SavedSearchesController < ApplicationController 2 | before_action :set_saved_search, only: [:destroy] 3 | 4 | # DELETE /saved_search/1 5 | # DELETE /saved_search/1.json 6 | def destroy 7 | @saved_search.destroy 8 | respond_to do |format| 9 | redirect_path = params[:redirect_to] || root_path 10 | format.html { redirect_to redirect_path, notice: t('ransack.saved_search.delete.success') } 11 | format.json { head :no_content } 12 | end 13 | end 14 | 15 | private 16 | # Use callbacks to share common setup or constraints between actions. 17 | def set_saved_search 18 | @saved_search = SavedSearch.find(params[:id]) 19 | end 20 | end 21 | -------------------------------------------------------------------------------- /test/dummy/app/assets/javascripts/application.js: -------------------------------------------------------------------------------- 1 | // This is a manifest file that'll be compiled into application.js, which will include all the files 2 | // listed below. 3 | // 4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, 5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path. 6 | // 7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the 8 | // the compiled file. 9 | // 10 | // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD 11 | // GO AFTER THE REQUIRES BELOW. 12 | // 13 | //= require jquery 14 | //= require jquery_ujs 15 | //= require_tree . 16 | -------------------------------------------------------------------------------- /test/dummy/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

We're sorry, but something went wrong.

23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /test/dummy/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The change you wanted was rejected.

23 |

Maybe you tried to change something you didn't have access to.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /test/dummy/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The page you were looking for doesn't exist.

23 |

You may have mistyped the address or the page may have moved.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /ransack_advanced_search.gemspec: -------------------------------------------------------------------------------- 1 | $:.push File.expand_path("../lib", __FILE__) 2 | 3 | # Maintain your gem's version: 4 | require "ransack_advanced_search/version" 5 | 6 | # Describe your gem and declare its dependencies: 7 | Gem::Specification.new do |s| 8 | s.name = "ransack_advanced_search" 9 | s.version = RansackAdvancedSearch::VERSION 10 | s.authors = ["David Brusius"] 11 | s.email = ["brusiusdavid@gmail.com"] 12 | s.homepage = "" 13 | s.summary = "Summary of RansackAdvancedSearch." 14 | s.description = "Description of RansackAdvancedSearch." 15 | 16 | s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.md"] 17 | s.test_files = Dir["test/**/*"] 18 | 19 | s.add_dependency 'rails', ['>= 3.2.6','< 5'] 20 | s.add_dependency 'ransack', '~> 1.7.0', '>= 1.7.0' 21 | 22 | s.add_development_dependency 'pry', '~>0.10' 23 | end 24 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | begin 3 | require 'bundler/setup' 4 | rescue LoadError 5 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 6 | end 7 | begin 8 | require 'rdoc/task' 9 | rescue LoadError 10 | require 'rdoc/rdoc' 11 | require 'rake/rdoctask' 12 | RDoc::Task = Rake::RDocTask 13 | end 14 | 15 | RDoc::Task.new(:rdoc) do |rdoc| 16 | rdoc.rdoc_dir = 'rdoc' 17 | rdoc.title = 'RansackAdvancedSearch' 18 | rdoc.options << '--line-numbers' 19 | rdoc.rdoc_files.include('lib/**/*.rb') 20 | end 21 | 22 | APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__) 23 | load 'rails/tasks/engine.rake' 24 | 25 | 26 | 27 | Bundler::GemHelper.install_tasks 28 | 29 | require 'rake/testtask' 30 | 31 | Rake::TestTask.new(:test) do |t| 32 | t.libs << 'lib' 33 | t.libs << 'test' 34 | t.pattern = 'test/**/*_test.rb' 35 | t.verbose = false 36 | end 37 | 38 | 39 | task :default => :test 40 | -------------------------------------------------------------------------------- /lib/generators/ransack_advanced_search/saved_search_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/base' 2 | require 'rails/generators/migration' 3 | 4 | module RansackAdvancedSearch 5 | module Generators 6 | class SavedSearchGenerator < Rails::Generators::Base 7 | source_root File.expand_path("../../templates", __FILE__) 8 | include Rails::Generators::Migration 9 | desc "Creates a Saved Search model and migrations to save advanced searches made with Ransack." 10 | class_option :orm 11 | 12 | desc 'add the migrations' 13 | def self.next_migration_number(path) 14 | unless @prev_migration_nr 15 | @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i 16 | else 17 | @prev_migration_nr += 1 18 | end 19 | @prev_migration_nr.to_s 20 | end 21 | 22 | def copy_migrations 23 | migration_template "create_ransack_advanced_search_saved_search.rb", "db/migrate/create_ransack_advanced_search_saved_search.rb" 24 | end 25 | 26 | end 27 | 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /app/assets/stylesheets/ransack_advanced_search/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the top of the 9 | * compiled file, but it's generally better to create a new file per style scope. 10 | * 11 | *= require_self 12 | *= require_tree . 13 | */ 14 | 15 | .ransack-advanced-search i.remove_fields, 16 | .ransack-advanced-search i.add_fields { 17 | cursor: pointer; 18 | } 19 | 20 | .ransack-advanced-search .ransack-condition-field { 21 | margin-bottom: 5px; 22 | margin-top: 5px; 23 | } 24 | 25 | .ransack-advanced-search .ransack-action-buttons { 26 | margin-top: 10px; 27 | } 28 | 29 | .ransack-advanced-search .ransack-saved-search-delete { 30 | margin-top: 1px; 31 | } 32 | -------------------------------------------------------------------------------- /MIT-LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2016 David Brusius 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_saved_searches_list.erb: -------------------------------------------------------------------------------- 1 |
2 |
<%= t('ransack.saved_search.title') %>
3 | 25 |
26 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_grouping_fields.erb: -------------------------------------------------------------------------------- 1 | <%= content_tag :div, { class: 'fields', 'data-object-name' => f.object_name } do %> 2 | 3 | <% remove_able = true if local_assigns[:remove_able].nil? %> 4 | <% if remove_able == false %> 5 | <%= content_tag(:span, "#{t('ransack.advanced_search.condition_group.match')} 6 | #{f.combinator_select({}, {class: 'form-control input-sm'})} 7 | #{t('ransack.advanced_search.condition_group.match_condition')}", nil, false) %> 8 | <% else %> 9 | <%= content_tag(:span, "#{t('ransack.advanced_search.condition_group.match')} 10 | #{f.combinator_select({}, {class: 'form-control input-sm'})} #{t('ransack.advanced_search.condition_group.match_condition')} 11 | #{button_to_remove_fields}", nil, false) %> 12 | <% end %> 13 | 14 | <% condition_fields = f.condition_fields do |c| %> 15 | <%= render 'ransack_advanced_search/condition_fields', f: c %> 16 | <% end %> 17 | <%= condition_fields %> 18 | <% if condition_fields.empty? %> 19 | <%= f.send("condition_fields", f.object.send("build_condition"), child_index: "new_condition") do |builder| %> 20 | <%= render 'ransack_advanced_search/condition_fields', f: builder %> 21 | <% end %> 22 | <% end %> 23 | 24 | <%= button_to_add_fields '', f, :condition %> 25 | 26 | <%= f.grouping_fields do |g| %> 27 | <%= render partial: 'ransack_advanced_search/grouping_fields', 28 | locals: { f: g, remove_able: true } %> 29 | <% end %> 30 | 31 | <% end %> 32 | -------------------------------------------------------------------------------- /test/dummy/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Log error messages when you accidentally call methods on nil. 10 | config.whiny_nils = true 11 | 12 | # Show full error reports and disable caching 13 | config.consider_all_requests_local = true 14 | config.action_controller.perform_caching = false 15 | 16 | # Don't care if the mailer can't send 17 | config.action_mailer.raise_delivery_errors = false 18 | 19 | # Print deprecation notices to the Rails logger 20 | config.active_support.deprecation = :log 21 | 22 | # Only use best-standards-support built into browsers 23 | config.action_dispatch.best_standards_support = :builtin 24 | 25 | # Raise exception on mass assignment protection for Active Record models 26 | config.active_record.mass_assignment_sanitizer = :strict 27 | 28 | # Log the query plan for queries taking more than this (works 29 | # with SQLite, MySQL, and PostgreSQL) 30 | config.active_record.auto_explain_threshold_in_seconds = 0.5 31 | 32 | # Do not compress assets 33 | config.assets.compress = false 34 | 35 | # Expands the lines which load the assets 36 | config.assets.debug = true 37 | end 38 | -------------------------------------------------------------------------------- /test/dummy/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Configure static asset server for tests with Cache-Control for performance 11 | config.serve_static_assets = true 12 | config.static_cache_control = "public, max-age=3600" 13 | 14 | # Log error messages when you accidentally call methods on nil 15 | config.whiny_nils = true 16 | 17 | # Show full error reports and disable caching 18 | config.consider_all_requests_local = true 19 | config.action_controller.perform_caching = false 20 | 21 | # Raise exceptions instead of rendering exception templates 22 | config.action_dispatch.show_exceptions = false 23 | 24 | # Disable request forgery protection in test environment 25 | config.action_controller.allow_forgery_protection = false 26 | 27 | # Tell Action Mailer not to deliver emails to the real world. 28 | # The :test delivery method accumulates sent emails in the 29 | # ActionMailer::Base.deliveries array. 30 | config.action_mailer.delivery_method = :test 31 | 32 | # Raise exception on mass assignment protection for Active Record models 33 | config.active_record.mass_assignment_sanitizer = :strict 34 | 35 | # Print deprecation notices to the stderr 36 | config.active_support.deprecation = :stderr 37 | end 38 | -------------------------------------------------------------------------------- /app/assets/javascripts/ransack_advanced_search/ransack_advanced_search.js: -------------------------------------------------------------------------------- 1 | (function() { 2 | this.Search = (function() { 3 | function Search(templates) { 4 | this.templates = templates != null ? templates : {}; 5 | } 6 | 7 | Search.prototype.remove_fields = function(button) { 8 | return $(button).closest('.fields').remove(); 9 | }; 10 | 11 | Search.prototype.add_fields = function(button, type, content) { 12 | var new_id, regexp; 13 | new_id = new Date().getTime(); 14 | regexp = new RegExp('new_' + type, 'g'); 15 | return $(button).before(content.replace(regexp, new_id)); 16 | }; 17 | 18 | Search.prototype.nest_fields = function(button, type) { 19 | var id_regexp, new_id, object_name, sanitized_object_name, template; 20 | new_id = new Date().getTime(); 21 | id_regexp = new RegExp('new_' + type, 'g'); 22 | template = this.templates[type]; 23 | object_name = $(button).closest('.fields').attr('data-object-name'); 24 | sanitized_object_name = object_name.replace(/\]\[|[^-a-zA-Z0-9:.]/g, '_').replace(/_$/, ''); 25 | template = template.replace(/new_object_name\[/g, object_name + "["); 26 | template = template.replace(/new_object_name_/, sanitized_object_name + '_'); 27 | return $(button).before(template.replace(id_regexp, new_id)); 28 | }; 29 | 30 | Search.prototype.convertFieldType = function (fieldType) { 31 | var fieldTypeToHtmlType = { 32 | 'default': 'text', 33 | 'integer': 'number', 34 | 'date' : 'date', 35 | 'datetime' : 'date' 36 | }; 37 | return (fieldTypeToHtmlType[fieldType] || fieldTypeToHtmlType['default']); 38 | }; 39 | 40 | Search.prototype.changeValueInputsType = function(element, fieldName, search) { 41 | fieldType = search.fieldsType[fieldName]; 42 | conditionValueInputs = $(element).parents('.ransack-condition-field').find('.ransack-attribute-value'); 43 | conditionValueInputs.attr('type', search.convertFieldType(fieldType)); 44 | }; 45 | 46 | return Search; 47 | 48 | })(); 49 | 50 | }).call(this); 51 | -------------------------------------------------------------------------------- /app/controllers/concerns/ransack_advanced_search/saved_search_utils.rb: -------------------------------------------------------------------------------- 1 | module RansackAdvancedSearch 2 | module SavedSearchUtils 3 | extend ActiveSupport::Concern 4 | 5 | # Perform saved searches actions to provide full functionality with one method 6 | def perform_saved_searches_actions(context, params={}) 7 | get_saved_searches(context) 8 | save_or_update_saved_search(params.merge(context: context)) 9 | get_params_to_search(context) 10 | end 11 | 12 | # Get list of Saved Search by context 13 | def get_saved_searches(context) 14 | @saved_searches = SavedSearch.where(context: context) 15 | end 16 | 17 | # Return params of Saved Search or search form params 18 | def get_params_to_search(context) 19 | if params[:saved_search].present? 20 | @saved_search = SavedSearch.find_by(id: params[:saved_search], context: context) 21 | end 22 | return params[:q] if params[:use_search_params].present? 23 | params[:q] = @saved_search.try(:search_params) || params[:q] 24 | end 25 | 26 | # Save or update Saved Search 27 | def save_or_update_saved_search(params) 28 | if params[:save_new_search].present? || params[:save_search].present? 29 | if params[:save_new_search].present? 30 | @saved_search = new_saved_search(params) 31 | elsif params[:save_search].present? && params[:saved_search].present? 32 | @saved_search = update_saved_search(params) 33 | elsif params[:save_search].present? 34 | @saved_search = new_saved_search(params) 35 | end 36 | 37 | if @saved_search.save 38 | flash[:notice] = t('ransack.saved_search.save.success') 39 | else 40 | flash[:error] = t('ransack.saved_search.save.error') 41 | end 42 | end 43 | end 44 | 45 | def new_saved_search(params) 46 | SavedSearch.new( 47 | context: params[:context], description: params[:description], 48 | search_params: params[:q] 49 | ) 50 | end 51 | 52 | def update_saved_search(params) 53 | saved_search = SavedSearch.find_by(id: params[:saved_search], context: params[:context]) 54 | saved_search.description = params[:description] 55 | saved_search.search_params = params[:q] 56 | saved_search 57 | end 58 | end 59 | end 60 | -------------------------------------------------------------------------------- /test/dummy/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # Code is not reloaded between requests 5 | config.cache_classes = true 6 | 7 | # Full error reports are disabled and caching is turned on 8 | config.consider_all_requests_local = false 9 | config.action_controller.perform_caching = true 10 | 11 | # Disable Rails's static asset server (Apache or nginx will already do this) 12 | config.serve_static_assets = false 13 | 14 | # Compress JavaScripts and CSS 15 | config.assets.compress = true 16 | 17 | # Don't fallback to assets pipeline if a precompiled asset is missed 18 | config.assets.compile = false 19 | 20 | # Generate digests for assets URLs 21 | config.assets.digest = true 22 | 23 | # Defaults to nil and saved in location specified by config.assets.prefix 24 | # config.assets.manifest = YOUR_PATH 25 | 26 | # Specifies the header that your server uses for sending files 27 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache 28 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx 29 | 30 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 31 | # config.force_ssl = true 32 | 33 | # See everything in the log (default is :info) 34 | # config.log_level = :debug 35 | 36 | # Prepend all log lines with the following tags 37 | # config.log_tags = [ :subdomain, :uuid ] 38 | 39 | # Use a different logger for distributed setups 40 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new) 41 | 42 | # Use a different cache store in production 43 | # config.cache_store = :mem_cache_store 44 | 45 | # Enable serving of images, stylesheets, and JavaScripts from an asset server 46 | # config.action_controller.asset_host = "http://assets.example.com" 47 | 48 | # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) 49 | # config.assets.precompile += %w( search.js ) 50 | 51 | # Disable delivery errors, bad email addresses will be ignored 52 | # config.action_mailer.raise_delivery_errors = false 53 | 54 | # Enable threaded mode 55 | # config.threadsafe! 56 | 57 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 58 | # the I18n.default_locale when a translation can not be found) 59 | config.i18n.fallbacks = true 60 | 61 | # Send deprecation notices to registered listeners 62 | config.active_support.deprecation = :notify 63 | 64 | # Log the query plan for queries taking more than this (works 65 | # with SQLite, MySQL, and PostgreSQL) 66 | # config.active_record.auto_explain_threshold_in_seconds = 0.5 67 | end 68 | -------------------------------------------------------------------------------- /test/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | require 'rails/all' 4 | 5 | Bundler.require(*Rails.groups) 6 | require "ransack_advanced_search" 7 | 8 | module Dummy 9 | class Application < Rails::Application 10 | # Settings in config/environments/* take precedence over those specified here. 11 | # Application configuration should go into files in config/initializers 12 | # -- all .rb files in that directory are automatically loaded. 13 | 14 | # Custom directories with classes and modules you want to be autoloadable. 15 | # config.autoload_paths += %W(#{config.root}/extras) 16 | 17 | # Only load the plugins named here, in the order given (default is alphabetical). 18 | # :all can be used as a placeholder for all plugins not explicitly named. 19 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 20 | 21 | # Activate observers that should always be running. 22 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 23 | 24 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 25 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 26 | # config.time_zone = 'Central Time (US & Canada)' 27 | 28 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 29 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 30 | # config.i18n.default_locale = :de 31 | 32 | # Configure the default encoding used in templates for Ruby 1.9. 33 | config.encoding = "utf-8" 34 | 35 | # Configure sensitive parameters which will be filtered from the log file. 36 | config.filter_parameters += [:password] 37 | 38 | # Enable escaping HTML in JSON. 39 | config.active_support.escape_html_entities_in_json = true 40 | 41 | # Use SQL instead of Active Record's schema dumper when creating the database. 42 | # This is necessary if your schema can't be completely dumped by the schema dumper, 43 | # like if you have constraints or database-specific column types 44 | # config.active_record.schema_format = :sql 45 | 46 | # Enforce whitelist mode for mass assignment. 47 | # This will create an empty whitelist of attributes available for mass-assignment for all models 48 | # in your app. As such, your models will need to explicitly whitelist or blacklist accessible 49 | # parameters by using an attr_accessible or attr_protected declaration. 50 | config.active_record.whitelist_attributes = true 51 | 52 | # Enable the asset pipeline 53 | config.assets.enabled = true 54 | 55 | # Version of your assets, change this if you want to expire all your assets 56 | config.assets.version = '1.0' 57 | end 58 | end 59 | 60 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_quick_search.html.erb: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 | <% if RansackAdvancedSearch.enable_saved_searches %> 5 |
6 | <%= render 'ransack_advanced_search/saved_searches_list', redirect_path: redirect_path %> 7 |
8 |
9 | <% else %> 10 |
11 | <% end %> 12 | <%= search_form_for(@search, url: search_url, html: { method: :post, class: 'form-inline', role: 'form' }) do |f| %> 13 | <% setup_search_form f, @search %> 14 | 15 | <% if RansackAdvancedSearch.enable_saved_searches %> 16 |
17 | <%= label_tag 'Descrição da Busca (necessária para salvar a busca)' %> 18 | <%= text_field_tag :description, @saved_search.try(:description), class: 'form-control input-sm' %> 19 | <% if @saved_search %> 20 | <%= hidden_field_tag :saved_search, @saved_search.id %> 21 | <%= hidden_field_tag :use_search_params, true %> 22 | <% end %> 23 |
24 | <% end %> 25 | 26 |

<%= t('ransack.quick_search.condition_group.title') %>

27 |
28 | <% if f.grouping_fields.empty? %> 29 | <%= render partial: 'ransack_advanced_search/grouping_fields', 30 | locals: { f: f, remove_able: false } %> 31 | <% else %> 32 | <%= f.grouping_fields do |g| %> 33 | <%= render partial: 'ransack_advanced_search/grouping_fields', 34 | locals: { f: f, remove_able: true } %> 35 | <% end %> 36 | <%= button_to_add_fields '', f, :grouping %> 37 | <% end %> 38 |
39 | 40 |
41 |
42 | <%= f.submit t('ransack.advanced_search.form.submit_text'), class: 'btn btn-primary' %> 43 | <% if RansackAdvancedSearch.enable_saved_searches %> 44 | <%= f.submit t('ransack.advanced_search.form.save_submit_text'), name: 'save_search', class: 'btn btn-primary' %> 45 | <%= f.submit t('ransack.advanced_search.form.save_new_submit_text'), name: 'save_new_search', class: 'btn btn-primary' %> 46 | <% end %> 47 | <%= link_to t('ransack.advanced_search.form.clear_search_text'), redirect_path, class: 'btn btn-default' %> 48 |
49 | <% end %> 50 |
51 |
52 |
53 | 54 | <% content_for(:ransack_advanced_search_setup) do %> 55 | <%= stylesheet_link_tag 'ransack_advanced_search/application', media: 'all' %> 56 | <%= javascript_include_tag 'ransack_advanced_search/application' %> 57 | 58 | 63 | <% end %> 64 | -------------------------------------------------------------------------------- /app/helpers/ransack_advanced_search_helper.rb: -------------------------------------------------------------------------------- 1 | module RansackAdvancedSearchHelper 2 | def setup_search_form(builder, search_object) 3 | fields = builder.grouping_fields builder.object.new_grouping, 4 | object_name: 'new_object_name', child_index: "new_grouping" do |f| 5 | render('ransack_advanced_search/grouping_fields', f: f) 6 | end 7 | content_for :ransack_setup, %Q{ 8 | var search = new Search({grouping: "#{escape_javascript(fields)}"}); 9 | search.fieldsType = #{get_fields_data_type(search_object).to_json.html_safe} 10 | $('select.ransack-attribute-select').each(function(e) { 11 | fieldName = $(this).find('option:selected')[0].value; 12 | search.changeValueInputsType(this, fieldName, search); 13 | }); 14 | $(document).on("click", "i.add_fields", function() { 15 | search.add_fields(this, $(this).data('fieldType'), $(this).data('content')); 16 | if($(this).hasClass('ransack-add-attribute')) { 17 | fieldName = $(this).parents('.ransack-condition-field').find('select.ransack-attribute-select').find('option:selected')[0].value; 18 | search.changeValueInputsType(this, fieldName, search); 19 | } 20 | return false; 21 | }); 22 | $(document).on('change', 'select.ransack-attribute-select', function(e) { 23 | fieldName = $(this).find('option:selected')[0].value; 24 | search.changeValueInputsType(this, fieldName, search); 25 | }); 26 | $(document).on("click", "i.remove_fields", function() { 27 | search.remove_fields(this); 28 | return false; 29 | }); 30 | $(document).on("click", "button.nest_fields", function() { 31 | search.nest_fields(this, $(this).data('fieldType')); 32 | return false; 33 | }); 34 | }.html_safe 35 | end 36 | 37 | def get_fields_data_type(search) 38 | bases = [''] + search.klass.ransackable_associations 39 | fields_type = Hash.new 40 | bases.each do |model| 41 | model_name = model.present? ? "#{model}_" : "" 42 | search.context.traverse(model).columns_hash.each do |field, attributes| 43 | fields_type["#{model_name}#{field}"] = attributes.type 44 | end 45 | end 46 | fields_type 47 | end 48 | 49 | def button_to_remove_fields 50 | content_tag :i, nil, class: 'remove_fields glyphicon glyphicon-minus-sign text-danger' 51 | end 52 | 53 | def button_to_add_fields(name, f, type, custom_class='') 54 | new_object = f.object.send "build_#{type}" 55 | fields = f.send("#{type}_fields", new_object, child_index: "new_#{type}") do |builder| 56 | render('ransack_advanced_search/' + type.to_s + "_fields", f: builder) 57 | end 58 | content_tag :i, name, :class => custom_class + ' add_fields glyphicon glyphicon-plus-sign text-success', :type => 'button', 'data-field-type' => type, 'data-content' => "#{fields}" 59 | end 60 | 61 | def button_to_nest_fields(name, type) 62 | content_tag :button, name, :class => 'nest_fields', 'data-field-type' => type 63 | end 64 | end 65 | -------------------------------------------------------------------------------- /app/views/ransack_advanced_search/_advanced_search.html.erb: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 | <% if RansackAdvancedSearch.enable_saved_searches %> 5 |
6 | <%= render 'ransack_advanced_search/saved_searches_list', redirect_path: redirect_path %> 7 |
8 |
9 | <% else %> 10 |
11 | <% end %> 12 | <%= search_form_for(@search, url: search_url, html: { method: :post, class: 'form-inline', role: 'form' }) do |f| %> 13 | 14 | <% setup_search_form f, @search %> 15 | 16 | <% if RansackAdvancedSearch.enable_saved_searches %> 17 |
18 | <%= label_tag 'Descrição da Busca (necessária para salvar a busca)' %> 19 | <%= text_field_tag :description, @saved_search.try(:description), class: 'form-control input-sm' %> 20 | <% if @saved_search %> 21 | <%= hidden_field_tag :saved_search, @saved_search.id %> 22 | <%= hidden_field_tag :use_search_params, true %> 23 | <% end %> 24 |
25 | <% end %> 26 | 27 |

<%= t('ransack.advanced_search.sort.title') %>

28 |
29 | <%= f.sort_fields do |s| %> 30 | <%= render 'ransack_advanced_search/sort_fields', f: s %> 31 | <% end %> 32 | <%= button_to_add_fields '', f, :sort %> 33 |
34 | 35 |

<%= t('ransack.advanced_search.condition_group.title') %>

36 |
37 | <%= f.grouping_fields do |g| %> 38 | <%= render 'ransack_advanced_search/grouping_fields', f: g %> 39 | <% end %> 40 | <%= button_to_add_fields '', f, :grouping %> 41 |
42 | 43 | 44 | 45 |
46 |
47 | <%= f.submit t('ransack.advanced_search.form.submit_text'), class: 'btn btn-primary' %> 48 | <% if RansackAdvancedSearch.enable_saved_searches %> 49 | <%= f.submit t('ransack.advanced_search.form.save_submit_text'), name: 'save_search', class: 'btn btn-primary' %> 50 | <%= f.submit t('ransack.advanced_search.form.save_new_submit_text'), name: 'save_new_search', class: 'btn btn-primary' %> 51 | <% end %> 52 | <%= link_to t('ransack.advanced_search.form.clear_search_text'), redirect_path, class: 'btn btn-default' %> 53 |
54 | <% end %> 55 |
56 |
57 |
58 | 59 | <% content_for(:ransack_advanced_search_setup) do %> 60 | <%= stylesheet_link_tag 'ransack_advanced_search/application', media: 'all' %> 61 | <%= javascript_include_tag 'ransack_advanced_search/application' %> 62 | 63 | 68 | <% end %> 69 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | ransack_advanced_search (0.1.5) 5 | rails (>= 3.2.6, < 5) 6 | ransack (~> 1.7.0, >= 1.7.0) 7 | 8 | GEM 9 | remote: https://rubygems.org/ 10 | specs: 11 | actionmailer (3.2.22.2) 12 | actionpack (= 3.2.22.2) 13 | mail (~> 2.5.4) 14 | actionpack (3.2.22.2) 15 | activemodel (= 3.2.22.2) 16 | activesupport (= 3.2.22.2) 17 | builder (~> 3.0.0) 18 | erubis (~> 2.7.0) 19 | journey (~> 1.0.4) 20 | rack (~> 1.4.5) 21 | rack-cache (~> 1.2) 22 | rack-test (~> 0.6.1) 23 | sprockets (~> 2.2.1) 24 | activemodel (3.2.22.2) 25 | activesupport (= 3.2.22.2) 26 | builder (~> 3.0.0) 27 | activerecord (3.2.22.2) 28 | activemodel (= 3.2.22.2) 29 | activesupport (= 3.2.22.2) 30 | arel (~> 3.0.2) 31 | tzinfo (~> 0.3.29) 32 | activeresource (3.2.22.2) 33 | activemodel (= 3.2.22.2) 34 | activesupport (= 3.2.22.2) 35 | activesupport (3.2.22.2) 36 | i18n (~> 0.6, >= 0.6.4) 37 | multi_json (~> 1.0) 38 | arel (3.0.3) 39 | builder (3.0.4) 40 | coderay (1.1.1) 41 | erubis (2.7.0) 42 | hike (1.2.3) 43 | i18n (0.7.0) 44 | journey (1.0.4) 45 | jquery-rails (3.1.4) 46 | railties (>= 3.0, < 5.0) 47 | thor (>= 0.14, < 2.0) 48 | json (1.8.3) 49 | mail (2.5.4) 50 | mime-types (~> 1.16) 51 | treetop (~> 1.4.8) 52 | method_source (0.8.2) 53 | mime-types (1.25.1) 54 | multi_json (1.11.3) 55 | polyamorous (1.3.0) 56 | activerecord (>= 3.0) 57 | polyglot (0.3.5) 58 | pry (0.10.3) 59 | coderay (~> 1.1.0) 60 | method_source (~> 0.8.1) 61 | slop (~> 3.4) 62 | rack (1.4.7) 63 | rack-cache (1.6.1) 64 | rack (>= 0.4) 65 | rack-ssl (1.3.4) 66 | rack 67 | rack-test (0.6.3) 68 | rack (>= 1.0) 69 | rails (3.2.22.2) 70 | actionmailer (= 3.2.22.2) 71 | actionpack (= 3.2.22.2) 72 | activerecord (= 3.2.22.2) 73 | activeresource (= 3.2.22.2) 74 | activesupport (= 3.2.22.2) 75 | bundler (~> 1.0) 76 | railties (= 3.2.22.2) 77 | railties (3.2.22.2) 78 | actionpack (= 3.2.22.2) 79 | activesupport (= 3.2.22.2) 80 | rack-ssl (~> 1.3.2) 81 | rake (>= 0.8.7) 82 | rdoc (~> 3.4) 83 | thor (>= 0.14.6, < 2.0) 84 | rake (11.1.2) 85 | ransack (1.7.0) 86 | actionpack (>= 3.0) 87 | activerecord (>= 3.0) 88 | activesupport (>= 3.0) 89 | i18n 90 | polyamorous (~> 1.2) 91 | rdoc (3.12.2) 92 | json (~> 1.4) 93 | slop (3.6.0) 94 | sprockets (2.2.3) 95 | hike (~> 1.2) 96 | multi_json (~> 1.0) 97 | rack (~> 1.0) 98 | tilt (~> 1.1, != 1.3.0) 99 | thor (0.19.1) 100 | tilt (1.4.1) 101 | treetop (1.4.15) 102 | polyglot 103 | polyglot (>= 0.3.1) 104 | tzinfo (0.3.49) 105 | 106 | PLATFORMS 107 | ruby 108 | 109 | DEPENDENCIES 110 | jquery-rails 111 | pry (~> 0.10) 112 | ransack_advanced_search! 113 | -------------------------------------------------------------------------------- /config/locales/ransack.en.yml: -------------------------------------------------------------------------------- 1 | en: 2 | ransack: 3 | quick_search: 4 | condition_group: 5 | title: Conditions 6 | advanced_search: 7 | form: 8 | submit_text: Search 9 | save_submit_text: Save and Search 10 | save_new_submit_text: Save as new and Search 11 | clear_search_text: Reset 12 | delete_saved_search: Delete this saved search 13 | delete_saved_search_confirm: Confirm deletion of this saved search? 14 | sort: 15 | title: Sort 16 | label_title: Sort by 17 | add: Add Sort 18 | condition_group: 19 | title: Condition Groups 20 | add: Add Condition Group 21 | match: Match 22 | match_condition: conditions 23 | attribute_field: 24 | add: Add Condition 25 | attribute_value: 26 | add: Add Value 27 | saved_search: 28 | title: Saved Searches 29 | empty_list: There are no saved searches in this context. 30 | save: 31 | success: Search saved successfully. 32 | error: Error while saving the search. You must enter a description of the search and at least one filter. 33 | delete: 34 | success: Search successfully destroyed. 35 | search: "search" 36 | predicate: "predicate" 37 | and: "and" 38 | or: "or" 39 | any: "any" 40 | all: "all" 41 | combinator: "combinator" 42 | attribute: "attribute" 43 | value: "value" 44 | condition: "condition" 45 | sort: "sort" 46 | asc: "ascending" 47 | desc: "descending" 48 | predicates: 49 | eq: "equals" 50 | eq_any: "equals any" 51 | eq_all: "equals all" 52 | not_eq: "not equal to" 53 | not_eq_any: "not equal to any" 54 | not_eq_all: "not equal to all" 55 | matches: "matches" 56 | matches_any: "matches any" 57 | matches_all: "matches all" 58 | does_not_match: "doesn't match" 59 | does_not_match_any: "doesn't match any" 60 | does_not_match_all: "doesn't match all" 61 | lt: "less than" 62 | lt_any: "less than any" 63 | lt_all: "less than all" 64 | lteq: "less than or equal to" 65 | lteq_any: "less than or equal to any" 66 | lteq_all: "less than or equal to all" 67 | gt: "greater than" 68 | gt_any: "greater than any" 69 | gt_all: "greater than all" 70 | gteq: "greater than or equal to" 71 | gteq_any: "greater than or equal to any" 72 | gteq_all: "greater than or equal to all" 73 | in: "in" 74 | in_any: "in any" 75 | in_all: "in all" 76 | not_in: "not in" 77 | not_in_any: "not in any" 78 | not_in_all: "not in all" 79 | cont: "contains" 80 | cont_any: "contains any" 81 | cont_all: "contains all" 82 | not_cont: "doesn't contain" 83 | not_cont_any: "doesn't contain any" 84 | not_cont_all: "doesn't contain all" 85 | start: "starts with" 86 | start_any: "starts with any" 87 | start_all: "starts with all" 88 | not_start: "doesn't start with" 89 | not_start_any: "doesn't start with any" 90 | not_start_all: "doesn't start with all" 91 | end: "ends with" 92 | end_any: "ends with any" 93 | end_all: "ends with all" 94 | not_end: "doesn't end with" 95 | not_end_any: "doesn't end with any" 96 | not_end_all: "doesn't end with all" 97 | 'true': "is true" 98 | 'false': "is false" 99 | present: "is present" 100 | blank: "is blank" 101 | 'null': "is null" 102 | not_null: "is not null" 103 | -------------------------------------------------------------------------------- /config/locales/ransack.pt-BR.yml: -------------------------------------------------------------------------------- 1 | pt-BR: 2 | ransack: 3 | quick_search: 4 | condition_group: 5 | title: Filtros 6 | advanced_search: 7 | form: 8 | submit_text: Pesquisar 9 | save_submit_text: Salvar e Pesquisar 10 | save_new_submit_text: Salvar nova e Pesquisar 11 | clear_search_text: Limpar 12 | delete_saved_search: Excluir esta busca salva 13 | delete_saved_search_confirm: Confirma a exclusão desta busca salva? 14 | sort: 15 | title: Ordenação 16 | add: Adicionar ordenação 17 | condition_group: 18 | title: Grupos de filtros 19 | add: Adicionar grupo 20 | match: Filtrar 21 | match_condition: condições 22 | attribute_field: 23 | add: Adicionar filtro 24 | attribute_value: 25 | add: Adicionar valor 26 | saved_search: 27 | title: Buscas Salvas 28 | empty_list: Não existem buscas salvas para este contexto. 29 | save: 30 | success: Busca salva com sucesso. 31 | error: Erro ao salvar a busca. Você precisa informar a descrição da busca e pelo menos um filtro. 32 | delete: 33 | success: Busca excluída com sucesso. 34 | search: "pesquisar" 35 | predicate: "predicado" 36 | and: "e" 37 | or: "ou" 38 | any: "alguma das" 39 | all: "todas as" 40 | combinator: "combinador" 41 | attribute: "atributo" 42 | value: "valor" 43 | condition: "condição" 44 | sort: "classificar" 45 | asc: "ascendente" 46 | desc: "descendente" 47 | predicates: 48 | eq: "igual" 49 | eq_any: "igual a algum" 50 | eq_all: "igual a todos" 51 | not_eq: "não é igual a" 52 | not_eq_any: "não é igual a algum" 53 | not_eq_all: "não é igual a todos" 54 | matches: "corresponde" 55 | matches_any: "corresponde a algum" 56 | matches_all: "corresponde a todos" 57 | does_not_match: "não corresponde" 58 | does_not_match_any: "não corresponde a algum" 59 | does_not_match_all: "não corresponde a todos" 60 | lt: "menor que" 61 | lt_any: "menor que algum" 62 | lt_all: "menor que todos" 63 | lteq: "menor ou igual a" 64 | lteq_any: "menor ou igual a algum" 65 | lteq_all: "menor ou igual a todos" 66 | gt: "maior que" 67 | gt_any: "maior que algum" 68 | gt_all: "maior que todos" 69 | gteq: "maior que ou igual a" 70 | gteq_any: "maior que ou igual a algum" 71 | gteq_all: "maior que ou igual a todos" 72 | in: "em" 73 | in_any: "em algum" 74 | in_all: "em todos" 75 | not_in: "não em" 76 | not_in_any: "não em algum" 77 | not_in_all: "não em todos" 78 | cont: "contém" 79 | cont_any: "contém algum" 80 | cont_all: "contém todos" 81 | not_cont: "não contém" 82 | not_cont_any: "não contém algum" 83 | not_cont_all: "não contém todos" 84 | start: "começa com" 85 | start_any: "começa com algum" 86 | start_all: "começa com todos" 87 | not_start: "não começa com" 88 | not_start_any: "não começa com algum" 89 | not_start_all: "não começa com algum" 90 | end: "termina com" 91 | end_any: "termina com algum" 92 | end_all: "termina com todos" 93 | not_end: "não termina com" 94 | not_end_any: "não termina com algum" 95 | not_end_all: "não termina com todos" 96 | 'true': "é verdadeiro" 97 | 'false': "é falso" 98 | present: "está presente" 99 | blank: "está em branco" 100 | 'null': "é nullo" 101 | not_null: "não é nulo" 102 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Gem Version](https://badge.fury.io/rb/ransack_advanced_search.svg)](https://badge.fury.io/rb/ransack_advanced_search) 2 | 3 | # Ransack Advanced Search 4 | 5 | [ransack](https://github.com/activerecord-hackery/ransack) is a Object-based searching for Rails. 6 | 7 | The `ransack_advanced_search` gem provides Bootstrap based templates for the [ransack](https://github.com/activerecord-hackery/ransack) Advanced query mode. This gem also provides some additional features to make search experience better and easy to use. 8 | 9 | ## Features 10 | * Full [ransack](https://github.com/activerecord-hackery/ransack) compatibility (you can still use the default [ransack](https://github.com/activerecord-hackery/ransack) features); 11 | * Ransack integrated Advanced Search mode with helpers and views - extracted from [ransack-demo](https://github.com/activerecord-hackery/ransack_demo) project; 12 | * Saved Searches, scoped by contexts, to persist search params and use it in the future; 13 | * Custom search value inputs based on data type; 14 | * TODO: scope by current user or current account (abstract scope). 15 | 16 | ## Installation 17 | 18 | Remove any entry of `ransack` gem from your application's Gemfile. The `ransack_advanced_search` gem will include the `ransack` gem as a dependency. 19 | 20 | Add this line to your application's Gemfile: 21 | 22 | ```ruby 23 | gem 'ransack_advanced_search' 24 | ``` 25 | 26 | Execute: 27 | 28 | $ bundle 29 | 30 | Or install it yourself as: 31 | 32 | $ gem install ransack_advanced_search 33 | 34 | Run the generator to install the gem initializer, this will create the file `config/initializers/ransack_advanced_search.rb`: 35 | 36 | $ rails generate ransack_advanced_search:install 37 | 38 | For while we don't need to change this file. 39 | 40 | ## Usage 41 | 42 | First, in your controller action that you will use for search, include the following: 43 | 44 | ```ruby 45 | # GET /your_models 46 | # GET /your_models.json 47 | # POST /your_models/advanced_search 48 | def index 49 | # The ransack search must be in the @search instance variable, because the advanced search will use it to build the search form. You must provide associations you will use in the includes method. 50 | @search = YourModel.search(params[:q]) 51 | @results = @search.result().includes(:association1, :association2) 52 | # or, if the above doesn't work 53 | @search = YourModel.ransack(params[:q]) 54 | @results = @search.result(:association1, :association2) 55 | end 56 | ``` 57 | 58 | To use the Advanced Search with associtions you must provide a method in your model to tell what are the associations for that model 59 | ```ruby 60 | class YourModel < ActiveRecord::Base 61 | # Associations to be included in the search attributes 62 | def self.ransackable_associations(*) 63 | %w( association1 association2 ) 64 | end 65 | end 66 | ``` 67 | 68 | By default ransack will provide all your model fields to the avaliable field to search. You can restrict what fields will be included in the Advanced Search by defining it in your model, like this: 69 | ```ruby 70 | class YourModel < ActiveRecord::Base 71 | # Fields that will be included in ransack advanced search 72 | def self.ransackable_attributes(*) 73 | %w( name description other_fields_names ) + _ransackers.keys 74 | end 75 | end 76 | ``` 77 | 78 | This rule applies to each model included in the search, even in the associations you can restrict fields to search. 79 | 80 | 81 | Now, we have to create a POST route to this action, in your `config/routes.rb` provide a POST route to this controller/action: 82 | 83 | ```ruby 84 | # For example 85 | resources :your_models do 86 | collection do 87 | match :advanced_search, to: 'your_models#index', via: :post 88 | end 89 | end 90 | ``` 91 | 92 | We have a ransack search well configured, from this step we will include the Advanced Search query mode in our views. 93 | 94 | In your application layout `app/views/layouts/application.erb`, include a yield in the head section to load ransack advanced search dependencies: 95 | ```html 96 | 97 | 98 | 99 | <%= yield(:ransack_advanced_search_setup) %> 100 | 101 | 102 | 103 | 104 | ``` 105 | In the view that you want the advanced search views you can choose betwenn quick_search and advanced_search views, so insert the following for advanced_search: 106 | 107 | ```ruby 108 | <%= render partial: 'ransack_advanced_search/advanced_search', 109 | locals: { 110 | search_url: advanced_search_your_models_path, # POST route we created above 111 | redirect_path: your_models_path # GET redirect path, to return after some actions 112 | } 113 | %> 114 | ``` 115 | 116 | Or, the following for quick_search: 117 | 118 | ```ruby 119 | <%= render partial: 'ransack_advanced_search/quick_search', 120 | locals: { 121 | search_url: advanced_search_your_models_path, # POST route we created above 122 | redirect_path: your_models_path # GET redirect path, to return after some actions 123 | } 124 | %> 125 | ``` 126 | IMPORTANT: If you are using saved searches and you want to change from quick search to advanced search views or vice versa, you must provide a new context for this saved searches or delete all saved search for that context before changing the view. 127 | 128 | All done! Enjoy the search! 129 | 130 | ## Saving Searches 131 | 132 | If you want to provide the feature to Save ransack searches, follow these steps. 133 | 134 | Enable Saved Searches configuration in `config/initializers/ransack_advanced_search.rb`: 135 | 136 | ```ruby 137 | config.enable_saved_searches = true 138 | ``` 139 | 140 | Run this command to generate the Saved Search Migration: 141 | 142 | $ rails generate ransack_advanced_search:saved_search 143 | 144 | Execute: 145 | 146 | $ rake db:migrate 147 | 148 | In each controller action with the Advanced Search: 149 | 150 | * Include the Saved Search Utils methods: 151 | ```ruby 152 | include RansackAdvancedSearch::SavedSearchUtils 153 | ``` 154 | 155 | * Insert this line before creating the search: 156 | ```ruby 157 | # GET /your_models 158 | # GET /your_models.json 159 | # POST /your_models/advanced_search 160 | def index 161 | # Call this methods passing a context(to scope the saved searches, can be any symbol) and the params variable 162 | params[:q] = perform_saved_searches_actions(:your_models_index, params) 163 | @search = YourModel.search(params[:q]) 164 | @results = @search.result() 165 | end 166 | ``` 167 | IMPORTANT: if you use custom inflections settings, you can receive this error: 168 | ``` 169 | Table 'calendario_development.saved_searchs' doesn't exist 170 | ``` 171 | To avoid this you will have to include an irregular inflection: 172 | ```ruby 173 | inflect.irregular 'saved_search', 'saved_searches' 174 | ``` 175 | 176 | ## i18n Support 177 | 178 | This gem was built using i18n translation supports, and has bult-in support for English (en) and Brazilian Portuguese (pt-BR). If you want to translate to your specific language, add a new locale file in your `config/locales` and translate the values to your language. You can get one of the locales of this project to make it easier to translate to your language. 179 | 180 | 181 | ## Contributing 182 | 183 | 1. Fork it ( https://github.com/davidbrusius/ransack_advanced_search/fork ) 184 | 2. Create your feature branch (`git checkout -b my-new-feature`) 185 | 3. Commit your changes (`git commit -am 'Add some feature'`) 186 | 4. Push to the branch (`git push origin my-new-feature`) 187 | 5. Create a new Pull Request 188 | 189 | This project uses MIT-LICENSE. 190 | -------------------------------------------------------------------------------- /test/dummy/README.rdoc: -------------------------------------------------------------------------------- 1 | == Welcome to Rails 2 | 3 | Rails is a web-application framework that includes everything needed to create 4 | database-backed web applications according to the Model-View-Control pattern. 5 | 6 | This pattern splits the view (also called the presentation) into "dumb" 7 | templates that are primarily responsible for inserting pre-built data in between 8 | HTML tags. The model contains the "smart" domain objects (such as Account, 9 | Product, Person, Post) that holds all the business logic and knows how to 10 | persist themselves to a database. The controller handles the incoming requests 11 | (such as Save New Account, Update Product, Show Post) by manipulating the model 12 | and directing data to the view. 13 | 14 | In Rails, the model is handled by what's called an object-relational mapping 15 | layer entitled Active Record. This layer allows you to present the data from 16 | database rows as objects and embellish these data objects with business logic 17 | methods. You can read more about Active Record in 18 | link:files/vendor/rails/activerecord/README.html. 19 | 20 | The controller and view are handled by the Action Pack, which handles both 21 | layers by its two parts: Action View and Action Controller. These two layers 22 | are bundled in a single package due to their heavy interdependence. This is 23 | unlike the relationship between the Active Record and Action Pack that is much 24 | more separate. Each of these packages can be used independently outside of 25 | Rails. You can read more about Action Pack in 26 | link:files/vendor/rails/actionpack/README.html. 27 | 28 | 29 | == Getting Started 30 | 31 | 1. At the command prompt, create a new Rails application: 32 | rails new myapp (where myapp is the application name) 33 | 34 | 2. Change directory to myapp and start the web server: 35 | cd myapp; rails server (run with --help for options) 36 | 37 | 3. Go to http://localhost:3000/ and you'll see: 38 | "Welcome aboard: You're riding Ruby on Rails!" 39 | 40 | 4. Follow the guidelines to start developing your application. You can find 41 | the following resources handy: 42 | 43 | * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html 44 | * Ruby on Rails Tutorial Book: http://www.railstutorial.org/ 45 | 46 | 47 | == Debugging Rails 48 | 49 | Sometimes your application goes wrong. Fortunately there are a lot of tools that 50 | will help you debug it and get it back on the rails. 51 | 52 | First area to check is the application log files. Have "tail -f" commands 53 | running on the server.log and development.log. Rails will automatically display 54 | debugging and runtime information to these files. Debugging info will also be 55 | shown in the browser on requests from 127.0.0.1. 56 | 57 | You can also log your own messages directly into the log file from your code 58 | using the Ruby logger class from inside your controllers. Example: 59 | 60 | class WeblogController < ActionController::Base 61 | def destroy 62 | @weblog = Weblog.find(params[:id]) 63 | @weblog.destroy 64 | logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") 65 | end 66 | end 67 | 68 | The result will be a message in your log file along the lines of: 69 | 70 | Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! 71 | 72 | More information on how to use the logger is at http://www.ruby-doc.org/core/ 73 | 74 | Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are 75 | several books available online as well: 76 | 77 | * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) 78 | * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) 79 | 80 | These two books will bring you up to speed on the Ruby language and also on 81 | programming in general. 82 | 83 | 84 | == Debugger 85 | 86 | Debugger support is available through the debugger command when you start your 87 | Mongrel or WEBrick server with --debugger. This means that you can break out of 88 | execution at any point in the code, investigate and change the model, and then, 89 | resume execution! You need to install ruby-debug to run the server in debugging 90 | mode. With gems, use sudo gem install ruby-debug. Example: 91 | 92 | class WeblogController < ActionController::Base 93 | def index 94 | @posts = Post.all 95 | debugger 96 | end 97 | end 98 | 99 | So the controller will accept the action, run the first line, then present you 100 | with a IRB prompt in the server window. Here you can do things like: 101 | 102 | >> @posts.inspect 103 | => "[#nil, "body"=>nil, "id"=>"1"}>, 105 | #"Rails", "body"=>"Only ten..", "id"=>"2"}>]" 107 | >> @posts.first.title = "hello from a debugger" 108 | => "hello from a debugger" 109 | 110 | ...and even better, you can examine how your runtime objects actually work: 111 | 112 | >> f = @posts.first 113 | => #nil, "body"=>nil, "id"=>"1"}> 114 | >> f. 115 | Display all 152 possibilities? (y or n) 116 | 117 | Finally, when you're ready to resume execution, you can enter "cont". 118 | 119 | 120 | == Console 121 | 122 | The console is a Ruby shell, which allows you to interact with your 123 | application's domain model. Here you'll have all parts of the application 124 | configured, just like it is when the application is running. You can inspect 125 | domain models, change values, and save to the database. Starting the script 126 | without arguments will launch it in the development environment. 127 | 128 | To start the console, run rails console from the application 129 | directory. 130 | 131 | Options: 132 | 133 | * Passing the -s, --sandbox argument will rollback any modifications 134 | made to the database. 135 | * Passing an environment name as an argument will load the corresponding 136 | environment. Example: rails console production. 137 | 138 | To reload your controllers and models after launching the console run 139 | reload! 140 | 141 | More information about irb can be found at: 142 | link:http://www.rubycentral.org/pickaxe/irb.html 143 | 144 | 145 | == dbconsole 146 | 147 | You can go to the command line of your database directly through rails 148 | dbconsole. You would be connected to the database with the credentials 149 | defined in database.yml. Starting the script without arguments will connect you 150 | to the development database. Passing an argument will connect you to a different 151 | database, like rails dbconsole production. Currently works for MySQL, 152 | PostgreSQL and SQLite 3. 153 | 154 | == Description of Contents 155 | 156 | The default directory structure of a generated Ruby on Rails application: 157 | 158 | |-- app 159 | | |-- assets 160 | | | |-- images 161 | | | |-- javascripts 162 | | | `-- stylesheets 163 | | |-- controllers 164 | | |-- helpers 165 | | |-- mailers 166 | | |-- models 167 | | `-- views 168 | | `-- layouts 169 | |-- config 170 | | |-- environments 171 | | |-- initializers 172 | | `-- locales 173 | |-- db 174 | |-- doc 175 | |-- lib 176 | | |-- assets 177 | | `-- tasks 178 | |-- log 179 | |-- public 180 | |-- script 181 | |-- test 182 | | |-- fixtures 183 | | |-- functional 184 | | |-- integration 185 | | |-- performance 186 | | `-- unit 187 | |-- tmp 188 | | `-- cache 189 | | `-- assets 190 | `-- vendor 191 | |-- assets 192 | | |-- javascripts 193 | | `-- stylesheets 194 | `-- plugins 195 | 196 | app 197 | Holds all the code that's specific to this particular application. 198 | 199 | app/assets 200 | Contains subdirectories for images, stylesheets, and JavaScript files. 201 | 202 | app/controllers 203 | Holds controllers that should be named like weblogs_controller.rb for 204 | automated URL mapping. All controllers should descend from 205 | ApplicationController which itself descends from ActionController::Base. 206 | 207 | app/models 208 | Holds models that should be named like post.rb. Models descend from 209 | ActiveRecord::Base by default. 210 | 211 | app/views 212 | Holds the template files for the view that should be named like 213 | weblogs/index.html.erb for the WeblogsController#index action. All views use 214 | eRuby syntax by default. 215 | 216 | app/views/layouts 217 | Holds the template files for layouts to be used with views. This models the 218 | common header/footer method of wrapping views. In your views, define a layout 219 | using the layout :default and create a file named default.html.erb. 220 | Inside default.html.erb, call <% yield %> to render the view using this 221 | layout. 222 | 223 | app/helpers 224 | Holds view helpers that should be named like weblogs_helper.rb. These are 225 | generated for you automatically when using generators for controllers. 226 | Helpers can be used to wrap functionality for your views into methods. 227 | 228 | config 229 | Configuration files for the Rails environment, the routing map, the database, 230 | and other dependencies. 231 | 232 | db 233 | Contains the database schema in schema.rb. db/migrate contains all the 234 | sequence of Migrations for your schema. 235 | 236 | doc 237 | This directory is where your application documentation will be stored when 238 | generated using rake doc:app 239 | 240 | lib 241 | Application specific libraries. Basically, any kind of custom code that 242 | doesn't belong under controllers, models, or helpers. This directory is in 243 | the load path. 244 | 245 | public 246 | The directory available for the web server. Also contains the dispatchers and the 247 | default HTML files. This should be set as the DOCUMENT_ROOT of your web 248 | server. 249 | 250 | script 251 | Helper scripts for automation and generation. 252 | 253 | test 254 | Unit and functional tests along with fixtures. When using the rails generate 255 | command, template test files will be generated for you and placed in this 256 | directory. 257 | 258 | vendor 259 | External libraries that the application depends on. Also includes the plugins 260 | subdirectory. If the app has frozen rails, those gems also go here, under 261 | vendor/rails/. This directory is in the load path. 262 | --------------------------------------------------------------------------------