might 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15a3ffb400a36a96c6479bd3717c94622b064437
-  data.tar.gz: fb6e300fedf6060ec38e7d2dab644a9faf8673cb
+  metadata.gz: a99e1e236e472a2f44627590833f038129a24b8b
+  data.tar.gz: 4d73b4d2dc3a555a946a3335baa5eb125b1efe13
 SHA512:
-  metadata.gz: b2325e15a768c3726bb4a7d06ccdc7550999eb769fa9bc0f575828b88f2625826cacba54f76c97c74aadb7176a7628d1cfcf66f9899a6eb0c6019b603b4f8061
-  data.tar.gz: bcf3c17a88edeb04959dc1818e3951539b65c3bdf06b4fa1d85830bb4e2fe0a760299ab351ec6e9ea5e7300672832d283dcfa2491c5cd60f3a4a4f82803a674a
+  metadata.gz: 9725439777f374fe441cee6b05bdfd69fd836fb18a8776141eab222c99c28c128658de13e83aaa174cc8f5d6c9b1284b0bfe433818ded81c47d974f9ad63513f
+  data.tar.gz: 86ff8d294343e2917804b38c1551a364245d6eba9784eed5e63f52863dc9c8a60e30e8254281da17d52c34bac6da6e83094ec3c25d7c47ab1c37b34c98053541

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 spec/examples.txt
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -1,15 +1,13 @@
-sudo: false
+---
 language: ruby
 rvm:
-  - 2.1.5
-  - 2.2.2
-  - 2.2.3
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-before_install: gem install bundler -v 1.10.6
+- 2.2.5
+- 2.3.1
 script:
-  - bundle exec rake spec
-  - bundle exec rubocop --fail-level C
+- 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

@@ -1,3 +1,13 @@
+**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

data/README.md

@@ -303,6 +303,16 @@ new version, update the version number in `version.rb`, and then run `bundle exe
 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 `Might` 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

data/gemfiles/rails_4.2.7_ransack_1.6.6.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activerecord", "4.2.7"
+gem "activesupport", "4.2.7"
+gem "ransack", "1.6.6"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.7_ransack_1.8.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activerecord", "4.2.7"
+gem "activesupport", "4.2.7"
+gem "ransack", "1.8.2"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.0_ransack_1.6.6.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activerecord", "5.0.0"
+gem "activesupport", "5.0.0"
+gem "ransack", "1.6.6"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.0_ransack_1.8.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", :group => :test, :require => nil
+gem "activerecord", "5.0.0"
+gem "activesupport", "5.0.0"
+gem "ransack", "1.8.2"
+
+gemspec :path => "../"

data/lib/might/filter_parameter_definition.rb

@@ -71,7 +71,7 @@ module Might
     end
 
     def undefined?
-      !self.defined? # rubocop:disable Style/RedundantSelf
+      !self.defined?
     end
 
     # Proc with defined validations

data/lib/might/filter_parameters.rb

@@ -1,33 +1,83 @@
 require 'set'
+require 'forwardable'
 
 module Might
   #
-  class FilterParameters < Set
+  class FilterParameters
+    include Comparable
+    include Enumerable
+    extend Forwardable
+
     FilterError = Class.new(KeyError)
 
+    def_delegators :parameters, :detect, :each
+
+    # @param [<Might::FilterParameter>]
+    def initialize(parameters = nil)
+      @parameters = Set.new(parameters)
+    end
+
     # Find filter by name
     # @param name [String]
     # @return [Might::FilterParameter, nil]
     #
     def [](name)
-      detect { |filter| filter.name == name }
+      parameters.detect { |filter| filter.name == name }
     end
 
     # Find filter by name or raise error
     # @param name [String]
+    # @yieldparam name [String]
+    #   block value will be returned if no `FilterParameter` found with specified name
     # @return [Might::FilterParameter]
     # @raise FilterError
     #
     def fetch(name)
       if (filter = self[name])
         filter
+      elsif block_given?
+        yield(name)
       else
         fail FilterError, "filter not found: #{name.inspect}"
       end
     end
 
+    # param value [Might::FilterParameter]
+    def add(value)
+      self.class.new(parameters.add(value))
+    end
+
+    alias << add
+
     def map(&block)
-      dup.map!(&block)
+      self.class.new(parameters.map(&block))
     end
+
+    # param other [Might::FilterParameters]
+    def -(other)
+      self.class.new(parameters - other.parameters)
+    end
+
+    # param other [Might::FilterParameters]
+    def +(other)
+      self.class.new(parameters.merge(other.parameters))
+    end
+
+    # Delete filter by name
+    # @param name [String]
+    # @return [Might::FilterParameter, nil]
+    def delete(name)
+      filter_parameter = self[name]
+      parameters.delete(filter_parameter) if filter_parameter
+      filter_parameter
+    end
+
+    def <=>(other)
+      parameters <=> other.parameters
+    end
+
+    protected
+
+    attr_reader :parameters
   end
 end

data/lib/might/filter_parameters_extractor.rb

@@ -55,7 +55,7 @@ module Might
       predicate = FilterPredicates.all.detect { |p| name_with_predicate.end_with?("_#{p}") }
       [
         name_with_predicate.chomp("_#{predicate}"),
-        predicate
+        predicate,
       ]
     end
 

data/lib/might/filter_predicates.rb

@@ -34,22 +34,22 @@ module Might
     CONT_ANY = 'cont_any'.freeze
 
     @predicates_on_value = Set.new([
-                                     NOT_EQ, EQ,
-                                     DOES_NOT_MATCH, MATCHES,
-                                     GT, LT,
-                                     GTEQ, LTEQ,
-                                     NOT_CONT, CONT,
-                                     NOT_START, START,
-                                     DOES_NOT_END, ENDS,
-                                     NOT_TRUE, TRUE,
-                                     NOT_FALSE, FALSE,
-                                     BLANK, PRESENT,
-                                     NOT_NULL, NULL
-                                   ])
+      NOT_EQ, EQ,
+      DOES_NOT_MATCH, MATCHES,
+      GT, LT,
+      GTEQ, LTEQ,
+      NOT_CONT, CONT,
+      NOT_START, START,
+      DOES_NOT_END, ENDS,
+      NOT_TRUE, TRUE,
+      NOT_FALSE, FALSE,
+      BLANK, PRESENT,
+      NOT_NULL, NULL
+    ])
     @predicates_on_array = Set.new([
-                                     NOT_IN, IN,
-                                     NOT_CONT_ANY, CONT_ANY
-                                   ])
+      NOT_IN, IN,
+      NOT_CONT_ANY, CONT_ANY
+    ])
 
     # Registers predicate on singular value or on array
     # @param predicate [String, Symbol]

data/lib/might/pagination_middleware.rb

@@ -49,7 +49,7 @@ module Might
     def default_pagination_options
       {
         limit: @per_page,
-        offset: 0
+        offset: 0,
       }.with_indifferent_access
     end
   end

data/lib/might/ransackable_filter_parameters_adapter.rb

@@ -10,7 +10,7 @@ module Might
       scope, params = env
 
       ransackable_parameters = Array(params[:filter]).reject { |f| f.predicate.nil? }
-                                                     .each_with_object({}) do |filter, ransackable_filters|
+        .each_with_object({}) do |filter, ransackable_filters|
         ransackable_filters[canonical_name_for(filter)] = filter.value
       end
 
@@ -52,8 +52,8 @@ module Might
       polymorphic_name = filter.on.keys.first
 
       name = Array(filter.on.values.first)
-             .map { |polymorphic_type| "#{polymorphic_name}_of_#{polymorphic_type}_type_#{filter.name}" }
-             .join('_or_')
+        .map { |polymorphic_type| "#{polymorphic_name}_of_#{polymorphic_type}_type_#{filter.name}" }
+        .join('_or_')
 
       "#{name}_#{filter.predicate}"
     end

data/lib/might/result.rb

@@ -27,7 +27,10 @@ module Might
 
     # @raise [NotImplementedError]
     def get
-      fail NotImplementedError
+      fail NotImplementedError, <<-MESSAGE.strip_heredoc
+        #{self.class} does not respond to #get. You should explicitly check for
+        #success? before calling #get.
+      MESSAGE
     end
 
     # @yield given block

data/lib/might/sort_parameter.rb

@@ -7,7 +7,7 @@ module Might
     DIRECTIONS = %w(asc desc).freeze
     REVERSED_DIRECTIONS = {
       'asc' => 'desc',
-      'desc' => 'asc'
+      'desc' => 'asc',
     }.freeze
 
     attr_reader :direction

data/lib/might/sort_parameter_definition.rb

@@ -48,7 +48,7 @@ module Might
     end
 
     def undefined?
-      !self.defined? # rubocop:disable Style/RedundantSelf
+      !self.defined?
     end
   end
 end

data/lib/might/version.rb

@@ -1,4 +1,4 @@
 #
 module Might
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/might.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activemodel', '>= 3.2'
   spec.add_runtime_dependency 'uber', '~> 0.0.15'
   spec.add_runtime_dependency 'ibsciss-middleware', '~> 0.3'
-  spec.add_runtime_dependency 'ransack', '~> 1.6.6'
-  spec.add_development_dependency 'activerecord', '>= 3.2'
-  spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'spbtv_code_style', '~> 1.2.3'
+  spec.add_runtime_dependency 'ransack', '>= 1.6.6'
+  spec.add_development_dependency 'activerecord', '>= 3.2', '< 6.0.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.11'
+  spec.add_development_dependency 'bundler', '~> 1.12.5'
+  spec.add_development_dependency 'rake', '~> 11.2.2'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'spbtv_code_style', '1.4.1'
+  spec.add_development_dependency 'appraisal', '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: might
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tema Bolshakov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,14 +70,14 @@ dependencies:
   name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.6
 - !ruby/object:Gem::Dependency
@@ -87,6 +87,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -94,76 +97,93 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.11
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.12.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: spbtv_code_style
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 2.1.0
 description: Mighty resource fetchers build on top of Ransack gem
 email:
 - abolshakov@spbtv.com
@@ -176,6 +196,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -184,6 +205,10 @@ files:
 - bin/console
 - bin/setup
 - config/locales/en.yml
+- 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
 - lib/might.rb
 - lib/might/fetcher.rb
 - lib/might/fetcher_error.rb
@@ -234,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Mighty resource fetchers