right 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 616d92c13fb6a17a21c4f8d95e8f4bc569dcc0ee
+  data.tar.gz: 57113f7c268ed99f23b896091ac74a9558f9ec9d
+SHA512:
+  metadata.gz: 20c7622dcc83385188b18d3d69244668eac67fd94cf928ca88471865d0f13e7a6a0bb61dc5e9db1ab1349b5a210e0ac668768898547ab56651a172c42a9112c7
+  data.tar.gz: 67fb364b9fbf02914eb06153784f7a5aeed3ca4a05fed341b4bfd62e14a77ccfc25b83252add76034fa72ab778bf413e290c00e2de1815c76107f1ecd17a67b8

data/.codeclimate.yml

@@ -0,0 +1,19 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- bin/**/*
+- config/**/*
+- gemfiles/**/*
+- spec/**/*

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/examples.txt
+gemfiles/*.gemfile.lock

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.3
+inherit_gem:
+  spbtv_code_style: .rubocop.yml
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/right/result.rb'
+#
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+rvm:
+- 2.2.5
+- 2.3.1
+script:
+- bundle exec rake spec
+- bundle exec rubocop --fail-level C
+gemfile:
+- gemfiles/rails_4.2.7_ransack_1.6.6.gemfile
+- gemfiles/rails_4.2.7_ransack_1.8.2.gemfile
+- gemfiles/rails_5.0.0_ransack_1.6.6.gemfile
+- gemfiles/rails_5.0.0_ransack_1.8.2.gemfile

data/Appraisals

@@ -0,0 +1,27 @@
+require 'yaml'
+
+ruby_versions = %w(2.2.5 2.3.1)
+rails_versions = %w(4.2.7 5.0.0)
+ransack_versions = %w(1.6.6 1.8.2)
+
+rails_versions.product(ransack_versions).each do |(rails, ransack)|
+  appraise "rails_#{rails}_ransack_#{ransack}" do
+    gem 'activerecord', rails
+    gem 'activesupport', rails
+    gem 'ransack', ransack
+  end
+end
+
+::File.open('.travis.yml', 'w+') do |f|
+  travis_hash = {
+    'language' => 'ruby',
+    'rvm' => ruby_versions,
+    'script'  => [
+      'bundle exec rake spec',
+      'bundle exec rubocop --fail-level C'
+    ],
+    'gemfile' => Dir.glob('gemfiles/*.gemfile')
+  }
+  travis = ::YAML.dump(travis_hash)
+  f.write travis
+end

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+**0.7.2**
+
+  * Use `autoload` instead of explicit `require` and `require_relative`.
+
+**0.7.0**
+
+  * Allow to pass block to `FilterParameter#fetch` to customize not found behaviour.
+  * Implement `FilterParameter#delete`.
+  * `FilterParameters` is not derived from `Set` anymore.
+
+**0.6.1**
+
+  * Add error message to `Failure#get`
+
+**0.6.0**
+
+  * Implement public API for registering predicates
+
+**0.5.0**
+
+  *  Introduce `Right::FilterParameters` as subclass of Set
+
+**0.4.0**
+
+  * Got rid off `#pagination` method on paginated collection.

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in right.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', '1.0.4', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Square Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,323 @@
+[![Build Status](https://travis-ci.org/SPBTV/might.svg)](https://travis-ci.org/SPBTV/might)
+[![Code Climate](https://codeclimate.com/github/SPBTV/might/badges/gpa.svg)](https://codeclimate.com/github/SPBTV/might)
+[![Test Coverage](https://codeclimate.com/github/SPBTV/might/badges/coverage.svg)](https://codeclimate.com/github/SPBTV/might/coverage)
+[![Gem Version](https://badge.fury.io/rb/might.svg)](https://badge.fury.io/rb/might)
+
+# Right
+
+Right utilizes the power of Ransack gem to provide models gathering api for Rails' controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'right'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install right
+
+## Usage
+
+Define a mighty fetcher
+
+```ruby
+class ChannelFetcher < Right::Fetcher
+  # Specify resource to be fetched
+  self.resource_class = Channel
+
+  # Specify list of allowed filters
+  filter :genres_name
+
+  # Allowed sortings
+  sort :name
+  sort :created_at
+end
+```
+
+And fetch resources by user input:
+
+```ruby
+params = {
+  'filter' => {
+    'genres_name_in' => 'Horror,Drama',
+  },
+  'sort' => '-created_at,name',
+  'page' => {
+    'limit' => 50,
+    'offset' => 0
+  }
+}
+ChannelFetcher.run(params) do |result|
+  if result.success?
+    render json: result.get
+  else
+    render json: result.errors, status: :bad_request
+  end
+end
+
+# or
+
+ChannelFetcher.run(params) #=> ChannelFetcher::Result
+```
+
+`params` hash should follow the following conventions:
+
+* `:filter` key is used for filtering
+* `:sort` key is used for sorting
+* `:page` key is used for pagination
+
+The result of evaluating `#run` method is `Right::Result`. It may be either success or failure.
+This container have the following api:
+
+* `#success?` - `true` if result is `Success`, false otherwise
+* `#failure?` - `true` if result is `Failure`, false otherwise
+* `#get` - returns fetching result if result is `Success`, raises exception if it is `Failure`
+* `#errors` - returns parameters processing errors (as array of strings) if result is `Failure`, raises exception if it is `Success`
+
+**NOTE**: `#errors` returns only errors in user input, and not includes exceptions thrown during fetching process.
+
+### Configuring filters
+
+To filter resources using Mighty Fetcher you should provide white list of allowed filters.
+Internally it uses [Ransack](https://github.com/activerecord-hackery/ransack) gem, so consult with its documentation
+in case of frustration.
+
+
+Simplest filter definition looks as follows:
+
+```ruby
+filter :name
+```
+
+It allows client to filter collection on its name. So if a client want to
+ filter on exec name it should pass a hash containing `name` followed by `_eq` predicate:
+
+```ruby
+ChannelFetcher.run(
+  'filter' => {
+    'name_eq' => 'MTV'
+  }
+)
+```
+
+If you need to pass list of values, specify them as comma separated list:
+
+```ruby
+ChannelFetcher.run(
+  'filter' => {
+    'name_in' => 'MTV,A-One'
+  }
+)
+```
+
+You may provide alias for an attributes using `:as` option
+
+```ruby
+filter :name, as: :title
+```
+
+The `Channel#name` attribute would be exposed as `title` to the fetcher api.
+
+```ruby
+ChannelFetcher.run(
+  'filter' => {
+    'title_eq' => 'MTV'
+  }
+)
+```
+
+Using power of Ransack we can filter of relations' attributes. For instance
+to search for channels on languages with specified iso2 code, you have two options.
+
+```ruby
+filter :language_iso2
+```
+
+Query on this attribute as is and Ransack will handle all details:
+
+```ruby
+ChannelFetcher.run(
+  'filter' => {
+    'language_iso2_eq' => 'ru'
+  }
+)
+```
+
+The second option is:
+
+```ruby
+filter :iso2, on: :language
+```
+
+```ruby
+ChannelFetcher.run(
+  'filter' => {
+    'iso2_eq => 'ru'
+  }
+)
+```
+
+It's possible to coerce attribute before using it:
+
+```ruby
+filter :resource_type, coerce: ->(value) { String(value).classify }
+```
+
+You can whitelist predicates for each filter:
+
+```ruby
+filter id: [:in, :eq]
+filter name: :eq
+```
+
+Filtering on polymorphic association needs more configuration.
+
+```ruby
+class House < ActiveRecord::Base
+  has_one :location, as: :locatable
+end
+
+class Location < ActiveRecord::Base
+  belongs_to :locatable, polymorphic: true
+end
+
+class LocationFetcher < Right::Fetcher
+  filter :locatable_id, on: { resource: ['House'] }
+end
+```
+
+User provided filters may be validated using `ActiveModel::Validation`
+
+```ruby
+filter registration_number: :eq, validates: { length: { is: 6 } }
+```
+
+If value of the `registration_number` is invalid it raises `Right::FilterValidationFailed`.
+
+#### List of all supported predicates
+
+Predicate      | Opposite Predicate | Meaning
+--------------:|-------------------:|-----------------------------------------------------
+`eq`           | `not_eq`           | field is exactly equal to a given value
+`matches`      | `does_not_match`   | field is like a given value
+`lt`           | `gt`               | field is less than a given value
+`lteq`         | `gteq`             | field is less than or equal to a given value
+`in`           | `not_in`           | field is within a specified list
+`cont`         | `not_cont`         | field contains a given value
+`cont_any`     | `not_cont_any`     | field contains any of given values
+`start`        | `not_start`        | field begins with a given value
+`end`          | `not_end`          | field ends with a given value
+`true`         | `not_true`         | field is true
+`false`        | `not_false`        | field is false
+`present`      | `blank`            | field is present (not null and not a blank string)
+`null`         | `not_null`         | field is null
+
+You may want to implement custom predicate. First of all you should implement predicate for [Ransack gem](https://github.com/activerecord-hackery/ransack/).
+This process [documented here](https://github.com/activerecord-hackery/ransack/wiki/custom-predicates).
+Then you have to register predicate.
+
+```ruby
+# Predicate for a singular value (such as a string)
+Right::FilterPredicates.register('is_upper_case', on: :value)
+
+# Predicate for an array
+Right::FilterPredicates.register('includes', on: :array)
+```
+
+
+### Configuring sorting
+
+Mighty Fetcher supports sorting resource collections according to one or more criteria.
+
+```ruby
+sort :name
+sort :created_at
+```
+
+To sort on one of the allowed fields provide `sort` parameter:
+
+```ruby
+ChannelFetcher.run('sort' => 'name')
+```
+
+If you need to sort against multiple fields separate them with comma. Sort fields would be applied
+in the order specified.
+
+```ruby
+ChannelFetcher.run('sort' => 'name,created_at')
+```
+
+The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.
+
+```ruby
+ChannelFetcher.run('sort' => '-created_at,name')
+```
+
+The above example should return the newest channels first. Any articles created on the same date will then
+be sorted by their name in ascending alphabetical order.
+
+### Configuring components
+
+Mighty Fetcher implements it's components as chain of middlewares (Using [ibsciss-middleware](https://github.com/Ibsciss/ruby-middleware))
+
+You can disable sorting, pagination and filtering altering middleware chain.
+
+```ruby
+class ChannelFetch < Fetch
+  middleware.delete Right::FilterMiddleware
+  middleware.insert_before Right::SortMiddleware, CustomFilterMiddleware
+  middleware.use AnotherMiddleware
+end
+```
+
+If you need do perform some actions before or after middleware chain:
+
+```ruby
+class FavoritesFetcher < Right::Fetcher
+  before do |favorites, params|
+    [favorites.by_user(params[:user]), params]
+  end
+end
+```
+
+To get translated error messages load Rails Railtie
+
+```ruby
+require 'right/railtie'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a
+new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+
+We test `Right` against different versions of `ActiveRecord` and `Ransack` using [appraisal](https://github.com/thoughtbot/appraisal) gem.
+To regenerate gemfiles run:
+
+    $ appraisal install
+
+To run specs against all versions:
+
+    $ appraisal rake spec
+
+## License
+
+Copyright 2015 SPB TV AG
+
+Licensed under the Apache License, Version 2.0 (the ["License"](LICENSE)); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and limitations under the License.