syto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 680b0e8f2fc3d847fc27ff9e5b3f5891d5d5331f84661250b90774e018daacde
+  data.tar.gz: ca58ebde9c0c3d6ece12a1f6f0ea44dd69e4151ba437e5c0992583dc75254665
+SHA512:
+  metadata.gz: 7cf3dc9333fa4c2b1be5bece3563f6e77c47ccf5503e3da299f5078b6801eb43d837790e58f670449bd183cb9665893531dde40c9907d217e9999d39a847a4b6
+  data.tar.gz: b84f56820dd009d84fe71310fed024e7a06fa4cadc5c50c24640fc2654b87413f2641f8134fe7c0672fe40ba8c48c4016f69d667f75e1c03b14e9464b09ffb0e

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/.idea/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+Gemfile.lock
+*.DS_Store

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in syto.gemspec
+gemspec
+
+group :test do
+  gem 'codecov', require: false
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'rubocop'
+  gem 'rubocop-minitest'
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Vadym Lukavyi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Syto
+
+Simple gem to filter data for ruby on rails models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syto'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syto
+
+## Usage
+
+Initialize Syto in AR model 
+
+Define filters for attributes `country`, `area_id` and `rate`
+
+```ruby
+# app/model/user.rb
+class User < ActiveModel
+  include Syto
+  syto_attrs_map :active, 
+                 country: { key: :country, case_insensitive: true }, # allows to filter by 'users.country'
+                 area_id: { key: :region },                          # allows to filter by 'users.area_id' as 'region'
+                 rate: { key_from: :rate_from, key_to: :rate_to }    # allows to filter by 'users.rate' with range
+end
+```
+
+Define custom filters in class
+
+```ruby
+# app/models/post.rb
+class Post < ActiveModel
+  include Syto
+  syto_filters_class PostFilters
+end
+```
+
+```ruby
+# app/models/concerns/post_filter.rb
+class PostFilters < Syto
+  def extended_filters
+    self.result = result.where(published: params[:published])
+    filter_by_range(:published_at, key_from: :pub_from, key_to: :pub_to)
+  end
+end
+```
+
+Use in code:
+
+```ruby
+params = { country: 'UA', rate_from: 2, rate_to: 3 }
+User.filter_by(params)
+```
+
+```ruby
+params = { published: true, pub_from: '2021-01-01' }
+Post.filter_by(params) # select published posts from 2021
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/p9436/syto.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'syto'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/syto/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Syto
+  VERSION = '0.1.0'
+end

data/lib/syto.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'syto/version'
+
+# Syto
+module Syto
+  class Error < StandardError; end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Class methods for Syto
+  module ClassMethods
+    # Define class with custom filter implementation
+    #
+    # $ cat app/model/user.rb
+    # class User < ActiveModel
+    #   include Syto
+    #   syto_attrs_map :role_id, :country, rate: { key_from: rate_from, key_to: rate_to }
+    # end
+
+    # $ cat app/models/post.rb
+    # class Post < ActiveModel
+    #   include Syto
+    #   syto_filters_class PostFilter
+    # end
+    #
+    # $ cat app/models/concerns/post_filter.rb
+    # class PostFilter < Syto
+    #   def define_filters
+    #     self.result = result.where(published: params[:published])
+    #   end
+    # end
+    #
+    # Usage:
+    #
+    # params = { country: 'UA', rate_from: 2 }
+    # User.filter_by(params)
+    #
+    # params = { published: true }
+    # Post.syto(params)
+    #
+
+    # Set class with customized filter settings
+    #
+    # @param [Class] filter_klass
+    #
+    def syto_filters_class(filter_klass)
+      @filter_klass = filter_klass
+    end
+
+    # Define map of filterable attributes
+    #
+    # @param [Array] attrs_map
+    #
+    def syto_attrs_map(*attrs_map)
+      @syto_attrs_map = attrs_map
+    end
+
+    # Filtering method
+    #
+    # @param [Hash] params
+    #
+    # @return [ActiveRecord::Relation]
+    #
+    def filter_by(params)
+      return all if params.blank? || params.empty?
+
+      @filter_klass ||= Syto::Base
+      @filter_klass.new(all, params.symbolize_keys, @syto_attrs_map).perform
+    end
+  end
+
+  # Base class for filters implementation
+  #
+  class Base
+    attr_accessor :result, :params
+
+    # @param [ActiveRecord::Relation] result
+    # @param [Hash] params
+    # @param [Array] attrs_map
+    #
+    def initialize(result, params, attrs_map)
+      @result    = result
+      @params    = params
+      @attrs_map = attrs_map
+    end
+
+    def perform
+      filter_by_attrs_map
+
+      extended_filters
+
+      result
+    end
+
+    def extended_filters
+      puts '[WARNING] Filters not defined'
+    end
+
+    private
+
+    def filter_by_attrs_map
+      return unless @attrs_map
+
+      @attrs_map.flatten.each do |filter|
+        case filter
+        when Symbol, String
+          scalar_filter(filter)
+        when Hash
+          hash_filter(filter)
+        end
+      end
+    end
+
+    # Filter by attribute
+    #
+    # @param [String. Symbol] attr
+    # @param [Hash] params_key
+    #
+    def scalar_filter(attr, params_key = nil)
+      params_key ||= attr
+      params_key = params_key.to_sym
+      return unless @params[params_key]
+
+      @result = @result.where(attr => @params[params_key])
+    end
+
+    # Filter by attribute with options
+    #
+    # @param [Hash] attrs
+    #
+    def hash_filter(attrs)
+      attrs.each do |attr, options|
+        case options
+        when String, Symbol
+          scalar_filter attr, options
+        when Hash
+          filter_hash_options(attr, options)
+        end
+      end
+    end
+
+    def filter_hash_options(attr, options)
+      if options.key?(:key)
+        filter_by_value attr, options
+      else
+        filter_by_range attr, options
+      end
+    end
+
+    # Filter by single value
+    #
+    # @param [Symbol] field_name
+    # @param [Hash] options
+    #
+    def filter_by_value(field_name, options = {})
+      options ||= {}
+
+      key ||= options[:key] || field_name
+      return unless @params.key?(key)
+
+      value = @params[key]
+
+      @result = if options[:case_insensitive] && value.respond_to?(:downcase)
+                  @result.where(result.arel_table[field_name].lower.in(value.downcase))
+                else
+                  @result.where(field_name => value)
+                end
+    end
+
+    # Filter by range
+    #
+    # @param [Symbol] field_name
+    # @param [Hash{Symbol->Object}] options
+    #
+    # options:
+    # - key_from,
+    # - key_to,
+    #
+    def filter_by_range(field_name, options = {})
+      key_from  = options[:key_from] || :"#{field_name}_from"
+      key_to    = options[:key_to]   || :"#{field_name}_to"
+
+      value_from = @params[key_from]
+      value_to   = @params[key_to]
+
+      return if value_from.blank? && value_to.blank?
+
+      @result = @result.where(field_name => (value_from..value_to))
+    end
+  end
+end

data/syto.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'syto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'syto'
+  spec.version       = Syto::VERSION
+  spec.authors       = ['Vadym Lukavyi']
+  spec.email         = ['vadym.lukavyi@gmail.com']
+
+  spec.summary       = 'Filtering for ActiveRecord models'
+  spec.description   = 'Simple filters for RubyOnRails'
+  spec.homepage      = 'https://github.com/p9436/syto'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.7'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/p9436/syto'
+    spec.metadata['changelog_uri'] = 'https://github.com/p9436/syto/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+  spec.add_dependency 'activesupport', '>= 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'minitest-rails'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: syto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vadym Lukavyi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple filters for RubyOnRails
+email:
+- vadym.lukavyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/syto.rb
+- lib/syto/version.rb
+- syto.gemspec
+homepage: https://github.com/p9436/syto
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/p9436/syto
+  source_code_uri: https://github.com/p9436/syto
+  changelog_uri: https://github.com/p9436/syto/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Filtering for ActiveRecord models
+test_files: []