right 0.7.2

data/lib/right/sort_parameters_extractor.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+module Right
+  # User provided sorting syntax:
+  #   * `name` - sort by name
+  #   * `-name` - sort by name in reversed order
+  #   * `-name,created_at` - sort by name in reversed order, and then sort by created_at
+  #
+  # This middleware parses sorting string and builds Parameter array
+  # @see Right::Sort::Parameter
+  #
+  # If user passes not defined sort order, it yields to `UndefinedParameter`, so you may
+  # validate it.
+  #
+  class SortParametersExtractor
+    # @param app [#call]
+    # @param parameters_definition [Set<Right::SortParameterDefinition>]
+    def initialize(app, parameters_definition)
+      @app = app
+      @parameters_definition = parameters_definition
+    end
+
+    # @param env [<String, []>]
+    #   * first element is a scope to be sorted
+    #   * second is a String with user provided sortings
+    # @return [<<Right::RansackableSort::SortParameter, []>]
+    #
+    def call(env)
+      params, errors = env
+
+      sort_params = sort_order(params[:sort]).map do |(attribute, direction)|
+        extract_parameter(attribute, direction)
+      end
+
+      app.call([params.merge(sort: sort_params), errors])
+    end
+
+    private
+
+    attr_reader :parameters_definition, :app
+
+    def extract_parameter(name, direction)
+      definition = parameters_definition.detect { |d| d.as == name } || SortUndefinedParameter.new(name)
+      SortParameter.new(direction, definition)
+    end
+
+    def sort_order(params)
+      String(params).split(',').map do |attribute|
+        sorting_for(attribute)
+      end
+    end
+
+    def sorting_for(field)
+      if field.start_with?('-')
+        [field.delete('-'), 'desc']
+      else
+        [field, 'asc']
+      end
+    end
+  end
+end

data/lib/right/sort_parameters_validator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Right
+  # Validates sortings and raises error if one of them is invalid
+  #
+  class SortParametersValidator
+    # @param app [#call]
+    def initialize(app)
+      @app = app
+    end
+
+    # @param env [<{:sort => Right::FilterParameter}, Array>]
+    # @return [<{:sort => Right::FilterParameter}, Array>]
+    #
+    def call(env)
+      params, errors = env
+
+      not_allowed_parameters = Array(params[:sort]).select(&:invalid?)
+      messages = not_allowed_parameters.flat_map(&:errors)
+
+      app.call([params, errors.concat(messages)])
+    end
+
+    private
+
+    attr_reader :app
+  end
+end

data/lib/right/sort_undefined_parameter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Right
+  # Null object for ParameterDefinition
+  #
+  class SortUndefinedParameter < SortParameterDefinition
+    def required?
+      false
+    end
+
+    def defined?
+      false
+    end
+  end
+end

data/lib/right/sort_value_validator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Right
+  # Build singleton validation class for specified attribute name
+  # @example you need a nice validator for a first_name
+  #   validator_klass = ValueValidator.build('first_name', presence: true, length: { minimum: 3 })
+  #   validator = validator_klass.new('Bo')
+  #   validator.valid? #=> false
+  #   validator.errors.full_messages #=> ['First name is too short (minimum is 3 characters)']
+  #
+  module SortValueValidator
+    module_function
+
+    # Validates if Parameter is undefined or not
+    class DefinedValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, _value)
+        record.errors.add(attribute, :undefined_sort_order) if record.undefined?
+      end
+    end
+
+    def build(definition)
+      Class.new do
+        include ActiveModel::Validations
+
+        validates(definition.name, 'right/sort_value_validator/defined': true)
+
+        define_method(:undefined?) { definition.undefined? }
+        define_method(definition.name) {}
+
+        def self.model_name
+          ActiveModel::Name.new(Right, nil, 'Right')
+        end
+      end
+    end
+  end
+end

data/lib/right/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Right
+  VERSION = '0.7.2'
+end

data/right.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'right/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'right'
+  spec.version       = Right::VERSION
+  spec.authors       = ['Tema Bolshakov']
+  spec.email         = ['abolshakov@spbtv.com']
+
+  spec.summary       = 'Mighty resource fetchers'
+  spec.description   = 'Mighty resource fetchers build on top of Ransack gem'
+  spec.homepage      = 'https://github.com/SPBTV/right'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.2'
+  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', '< 6.0.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.11'
+  spec.add_development_dependency 'bundler', '>= 1.13.7'
+  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'
+  spec.add_development_dependency 'rubocop', '0.40.0'
+end

metadata

@@ -0,0 +1,281 @@
+--- !ruby/object:Gem::Specification
+name: right
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+platform: ruby
+authors:
+- Tema Bolshakov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+- !ruby/object:Gem::Dependency
+  name: ibsciss-middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  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
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !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.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: spbtv_code_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        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: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+description: Mighty resource fetchers build on top of Ransack gem
+email:
+- abolshakov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- 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/right.rb
+- lib/right/fetcher.rb
+- lib/right/fetcher_error.rb
+- lib/right/filter_middleware.rb
+- lib/right/filter_parameter.rb
+- lib/right/filter_parameter_definition.rb
+- lib/right/filter_parameters.rb
+- lib/right/filter_parameters_extractor.rb
+- lib/right/filter_parameters_validator.rb
+- lib/right/filter_predicates.rb
+- lib/right/filter_undefined_parameter.rb
+- lib/right/filter_value_validator.rb
+- lib/right/pagination_middleware.rb
+- lib/right/pagination_parameters_validator.rb
+- lib/right/paginator.rb
+- lib/right/railtie.rb
+- lib/right/ransackable_filter.rb
+- lib/right/ransackable_filter_parameters_adapter.rb
+- lib/right/ransackable_sort.rb
+- lib/right/ransackable_sort_parameters_adapter.rb
+- lib/right/result.rb
+- lib/right/sort_middleware.rb
+- lib/right/sort_parameter.rb
+- lib/right/sort_parameter_definition.rb
+- lib/right/sort_parameters_extractor.rb
+- lib/right/sort_parameters_validator.rb
+- lib/right/sort_undefined_parameter.rb
+- lib/right/sort_value_validator.rb
+- lib/right/version.rb
+- right.gemspec
+homepage: https://github.com/SPBTV/right
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Mighty resource fetchers
+test_files: []