ransack 1.6.6 → 2.4.0

data/CONTRIBUTING.md

@@ -1,16 +1,20 @@
 # Contributing to Ransack
 
-Please take a moment to review this document in order to make the contribution
-process easy and effective for everyone involved!
+Please take a moment to review this document to make contributing easy and
+effective for everyone involved!
 
 Ransack is an open source project and we encourage contributions.
 
+Please do not use the issue tracker for personal support requests. Stack
+Overflow is a better place for that where a wider community can help you!
+
 ## Filing an issue
 
-A bug is a _demonstrable problem_ that is caused by the code in the repository.
-Good bug reports are extremely helpful! Please do not use the issue tracker for personal support requests.
+Good issue reports are extremely helpful!  Please only open an issue if a bug
+is caused by Ransack, is new (has not already been reported), and can be
+reproduced from the information you provide.
 
-Guidelines for bug reports:
+Steps:
 
 1. **Use the GitHub issue search** — check if the issue has already been
    reported.
@@ -18,18 +22,25 @@ Guidelines for bug reports:
 2. **Check if the issue has been fixed** — try to reproduce it using the
    `master` branch in the repository.
 
-3. **Isolate and report the problem** — ideally create a reduced test
-   case.
+3. **Isolate the real problem** — make sure the issue is really a bug in
+   Ransack and not in your code or another gem.
+
+4. **Report the issue** by providing the link to a self-contained
+   gist like [this](https://gist.github.com/jonatack/63048bc5062a84ba9e09) or
+   [this](https://gist.github.com/jonatack/5df41a0edb53b7bad989). Please use
+   these code examples as a bug-report template for your Ransack issue!
 
-When filing an issue, please provide these details:
+If you do not provide a self-contained gist and would like your issue to be reviewed, do provide at a minimum:
 
-* A comprehensive list of steps to reproduce the issue, or - far better - **a failing spec**.
-* The version (and branch) of Ransack *and* the versions of Rails, Ruby, and your operating system.
+* A comprehensive list of steps to reproduce the issue, or even better, a
+  passing/failing test spec.
+* Whether you are using Ransack through another gem like ActiveAdmin,
+  SimpleForm, etc.
+* The versions of Ruby, Rails, Ransack and the database.
 * Any relevant stack traces ("Full trace" preferred).
 
-Any issue that is open for 14 days without actionable information or activity
-will be marked as "stalled" and then closed. Stalled issues can be re-opened
-if the information requested is provided.
+Issues filed without the above information or that remain open without activity
+for 14 days will be closed. They can be re-opened if actionable information to reproduce the issue is provided.
 
 ## Pull requests
 
@@ -53,6 +64,9 @@ Here's a quick guide:
 2. Create a thoughtfully-named branch for your changes (`git checkout -b my-new-feature`).
 
 3. Install the development dependencies by running `bundle install`.
+   To install rails other than latest (set in Gemfile): `RAILS='5-2-stable' bundle install`
+
+        $ RAILS='5-2-stable' bundle install
 
 4. Begin by running the tests. We only take pull requests with passing tests,
    and it's great to know that you have a clean slate:
@@ -61,11 +75,30 @@ Here's a quick guide:
 
    The test suite runs by default with SQLite3. To run the test suite with PostgreSQL or MySQL, use:
 
-        $ DB=postgresql bundle exec rake spec (`DB=pg` & `DB=postgres` work too)
+        $ DB=pg bundle exec rake spec (`DB=postgres` & `DB=postgresql` work too)
         $ DB=mysql bundle exec rake spec
 
-5. Hack away! Please use Ruby features that are compatible down to Ruby 1.9.
-   Since version 1.5, Ransack no longer maintains Ruby 1.8 compatibility.
+   For Postgres and MySQL, databases are expected to exist, called 'ransack'. To create use these commands (assuming OS X and Homebrew):
+
+   ### Postgres
+       $ createdb ransack 
+
+   ### MySQL
+       $ mysql -u root
+       mysql> create database ransack;     
+
+   The test suite runs by default
+
+   To run only the tests in a particular file: `bundle exec rspec <path/to/filename>`
+
+        $ bundle exec rspec spec/ransack/search_spec.rb
+
+   To run a single test in that file: `bundle exec rspec <path/to/filename> -e "test name"`
+
+        $ bundle exec rspec spec/ransack/search_spec.rb -e "accepts a context option"
+
+5. Hack away! Please use Ruby features that are compatible down to Ruby 2.3.
+   Since version 2.3.1, Ransack no longer maintains Ruby 2.2 compatibility.
 
 6. Add tests for your changes. Only refactoring and documentation changes
    require no new tests. If you are adding functionality or fixing a bug, we
@@ -76,20 +109,24 @@ Here's a quick guide:
 8. Update the Change Log. If you are adding new functionality, document it in
    the README.
 
-9. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
+9. Make sure git knows your name and email address in your `~/.gitconfig` file:
+
+        $ git config --global user.name "Your Name"
+        $ git config --global user.email "contributor@example.com"
 
-10. If necessary, rebase your commits into logical chunks, without errors. To
+10. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
+   If your pull request only contains documentation changes, please remember
+   to add `[skip ci]` to the beginning of your commit message so the Travis
+   test suite doesn't :runner: needlessly.
+
+11. If necessary, rebase your commits into logical chunks, without errors. To
    interactively rebase and cherry-pick from, say, the last 10 commits:
    `git rebase -i HEAD~10`, then `git push -f`.
 
-11. Push the branch up to your fork on Github
-   (`git push origin my-new-feature`) and from Github submit a pull request to
+12. Push the branch up to your fork on GitHub
+   (`git push origin my-new-feature`) and from GitHub submit a pull request to
    Ransack's `master` branch.
 
-12. If your pull request only contains documentation changes, please remember
-   to add `[skip ci]` to the beginning of your commit message so the Travis
-   test suite doesn't :runner: needlessly.
-
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business
 day). We may suggest some changes or improvements or alternatives.
@@ -107,11 +144,11 @@ Syntax:
 * 80 characters per line.
 * No trailing whitespace. Blank lines should not have any space.
 * Prefer `&&`/`||` over `and`/`or`.
-* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or my_method my_arg.
+* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
 * `a = b` and not `a=b`.
 * `a_method { |block| ... }` and not `a_method { | block | ... }` or
 `a_method{|block| ...}`.
 * Prefer simplicity, readability, and maintainability over terseness.
 * Follow the conventions you see used in the code already.
 
-And in case we didn't emphasize it enough: we love tests!
+And in case we didn't emphasize it enough: We love tests!

data/Gemfile

@@ -3,49 +3,49 @@ gemspec
 
 gem 'rake'
 
-rails = ENV['RAILS'] || '4-2-stable'
-
-if rails == 'master'
-  gem 'arel', github: 'rails/arel'
-  gem 'polyamorous', github: 'activerecord-hackery/polyamorous'
-else
-  gem 'polyamorous', '~> 1.2'
-end
-
-gem 'pry'
-
-# Provide timezone information on Windows
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
+rails = ENV['RAILS'] || '6-0-stable'
+
+rails_version = case rails
+                when /\// # A path
+                  File.read(File.join(rails, "RAILS_VERSION"))
+                when /^v/ # A tagged version
+                  rails.gsub(/^v/, '')
+                else
+                  rails
+                end
+
+gem 'faker', '~> 1.0'
+gem 'sqlite3', ::Gem::Version.new(rails_version) >= ::Gem::Version.new('6-0-stable') ? '~> 1.4.1' : '~> 1.3.3'
+gem 'pg', '~> 1.0'
+gem 'pry', '~> 0.12.2'
+gem 'byebug'
 
 case rails
 when /\// # A path
   gem 'activesupport', path: "#{rails}/activesupport"
+  gem 'activemodel', path: "#{rails}/activemodel"
   gem 'activerecord', path: "#{rails}/activerecord", require: false
   gem 'actionpack', path: "#{rails}/actionpack"
+  gem 'actionview', path: "#{rails}/actionview"
 when /^v/ # A tagged version
-  git 'git://github.com/rails/rails.git', :tag => rails do
+  git 'https://github.com/rails/rails.git', :tag => rails do
     gem 'activesupport'
     gem 'activemodel'
     gem 'activerecord', require: false
     gem 'actionpack'
   end
 else
-  git 'git://github.com/rails/rails.git', :branch => rails do
+  git 'https://github.com/rails/rails.git', :branch => rails do
     gem 'activesupport'
     gem 'activemodel'
     gem 'activerecord', require: false
     gem 'actionpack'
   end
-  if rails == '3-0-stable'
-    gem 'mysql2', '< 0.3'
-  end
-end
-
-if ENV['DB'] =~ /mongodb/
-  gem 'mongoid', '~> 4.0.0', require: false
 end
+gem 'mysql2', '~> 0.5.2'
 
-# Removed from Ruby 2.2 but needed for testing Rails 3.x.
 group :test do
-  gem 'test-unit', '~> 3.0' if RUBY_VERSION >= '2.2'
+  gem 'machinist', '~> 1.0.6'
+  gem 'rspec', '~> 3'
+  gem 'simplecov', :require => false
 end