query_filter 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b6afc4d8301e89187a25929659d0bf700393759
-  data.tar.gz: f02b574cca6bb204af006029925294da51b8ea0b
+SHA256:
+  metadata.gz: f281a64c42dfafb2f5478b7dc850e4d09fbc177357d85590a45e2abaa55b91ea
+  data.tar.gz: c9823c4351c0757a97eeb0d851e22980da495ecdc13784002f6e2ef3390f6403
 SHA512:
-  metadata.gz: 907332261dafbb301d9d59ab4cf50673dcb8b4fe08ce120b4a0e42f7fa5a4d12feca5dfb95bf40adc9682e3ef81f5a83d8d5dea817b540a2bc5a33669f9406cd
-  data.tar.gz: 4fd382934f56ffcc95722d9ac05c4e02a20575f29402e197b4c1518a6b7f697c9aa3caf8dc7402a8d4096f7ce5da9ca466deef646c86934a39e1aeae972e8511
+  metadata.gz: 38bdd2e28381998445c90a2c86fff1f0d3513df6b995ffbafc1399cf3b3460d5fb25b462602ff3b48426597e0a1aba0951e2adcc4cc3eb4c42ca943bf0c0bff8
+  data.tar.gz: a1aeac38a34238ecb73269246e716501e01897f420181c1a1cdd632a2b5b803a976d26c6d6e012389e9ca2e7b681f573081835df489ed9acbe85959aae928cc8

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.4
+  - 2.5.5
 before_install: gem install bundler -v 1.15.1

data/Gemfile.lock

@@ -1,33 +1,33 @@
 PATH
   remote: .
   specs:
-    query_filter (0.1.8)
+    query_filter (0.2.0)
       activesupport (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.2)
-      activesupport (= 5.1.2)
-    activerecord (5.1.2)
-      activemodel (= 5.1.2)
-      activesupport (= 5.1.2)
-      arel (~> 8.0)
-    activesupport (5.1.2)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    ffi (1.9.18)
+    ffi (1.10.0)
     formatador (0.2.5)
-    guard (2.14.1)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -38,46 +38,45 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (0.8.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.8.2)
-    minitest (5.10.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    minitest (5.11.3)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.10.4)
+    pry (0.12.2)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rb-fsevent (0.9.8)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    slop (3.6.0)
-    sqlite3 (1.3.13)
-    thor (0.19.4)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -94,4 +93,4 @@ DEPENDENCIES
   sqlite3 (~> 1.3, >= 1.3.13)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -26,6 +26,37 @@ class Order < ActiveRecord::Base
 end
 ```
 
+Where OrderFilter class looks like:
+
+```ruby
+# app/filters/order_filter.rb
+#
+class OrderFilter < QueryFilter::Base
+  scope :customer_id
+  scope :service
+
+  range :total
+
+  date_range :completed_at
+
+  def scope_customer_id(value)
+    query.where(customer_id: value)
+  end
+
+  def scope_service(value)
+    query.where(service_id: value.to_i)
+  end
+
+  def range_total(range)
+    query.where(range.query('orders.total'))
+  end
+
+  def date_range_completed_at(period)
+    query.where(completed_at: period.range_original)
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/query_filter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Build select query based on params hash
 #
 module QueryFilter

data/lib/query_filter/rules/date_range.rb

@@ -1,42 +1,47 @@
+# frozen_string_literal: true
+
 # Parse date range params
 #
 #  date_range :created_at, keys: [:start_date, :end_date]
 #
 #  date_range :last_login_date
 #
-module QueryFilter::Rules
-  class DateRange < Scope
-    def name
-      'date_range'.freeze
-    end
+module QueryFilter
+  module Rules
+    class DateRange < Scope
+      def name
+        'date_range'
+      end
 
-    def valid?(values)
-      period = build_period_from_params(values)
-      !(period.nil? || period.default?)
-    end
+      def valid?(values)
+        period = build_period_from_params(values)
+        !(period.nil? || period.default?)
+      end
 
-    def normalize_params(values)
-      build_period_from_params(values)
-    end
+      def normalize_params(values)
+        build_period_from_params(values)
+      end
 
-    protected
+      protected
 
-    def build_period_from_params(params)
-      if params[key].present?
-        QueryFilter::Utils::DatePeriod.parse_from_string(params[key], @options[:format])
-      elsif keys_start_end_dates_exists?(params)
-        QueryFilter::Utils::DatePeriod.new(*values_start_end_dates(params), @options[:format])
+      def build_period_from_params(params)
+        if params[key].present?
+          QueryFilter::Utils::DatePeriod.parse_from_string(params[key], @options[:format])
+        elsif keys_start_end_dates_exists?(params)
+          QueryFilter::Utils::DatePeriod.new(*values_start_end_dates(params), @options[:format])
+        end
       end
-    end
 
-    def keys_start_end_dates_exists?(params)
-      values = values_start_end_dates(params)
-      !values.nil? && values.size == 2
-    end
+      def keys_start_end_dates_exists?(params)
+        values = values_start_end_dates(params)
+        !values.nil? && values.size == 2
+      end
+
+      def values_start_end_dates(params)
+        return unless @options[:keys]
 
-    def values_start_end_dates(params)
-      return if @options[:keys].nil?
-      params.values_at(*@options[:keys])
+        params.values_at(*@options[:keys])
+      end
     end
   end
 end

data/lib/query_filter/rules/order_by.rb

@@ -1,23 +1,27 @@
+# frozen_string_literal: true
+
 # Define order by filter rule
 #
-module QueryFilter::Rules
-  class OrderBy < Scope
-    DIRECTIONS = %w[asc desc].freeze
+module QueryFilter
+  module Rules
+    class OrderBy < Scope
+      DIRECTIONS = %w[asc desc].freeze
 
-    def name
-      'order_by'.freeze
-    end
+      def name
+        'order_by'
+      end
 
-    def valid?(params)
-      params[key].present? && DIRECTIONS.include?(params[direction_key].try(:downcase))
-    end
+      def valid?(params)
+        params[key].present? && DIRECTIONS.include?(params[direction_key].try(:downcase))
+      end
 
-    def direction_key
-      @direction_key ||= (@options[:via] || 'sort_direction').to_sym
-    end
+      def direction_key
+        @direction_key ||= (@options[:via] || 'sort_direction').to_sym
+      end
 
-    def normalize_params(values)
-      [values[key], values[direction_key]]
+      def normalize_params(values)
+        [values[key], values[direction_key]]
+      end
     end
   end
 end

data/lib/query_filter/rules/range.rb

@@ -1,38 +1,42 @@
+# frozen_string_literal: true
+
 # Define range filter rule
 #
-module QueryFilter::Rules
-  class Range < Scope
-    def initialize(keys, options = {})
-      @key = Array(keys).first
-      @keys = [key_from, key_to]
-      @options = options
-    end
+module QueryFilter
+  module Rules
+    class Range < Scope
+      def initialize(keys, options = {})
+        @key = Array(keys).first
+        @keys = [key_from, key_to]
+        @options = options
+      end
 
-    def name
-      'range'.freeze
-    end
+      def name
+        'range'
+      end
 
-    def valid?(values)
-      filter = build_range_from_params(values)
-      filter.valid?
-    end
+      def valid?(values)
+        filter = build_range_from_params(values)
+        filter.valid?
+      end
 
-    def normalize_params(values)
-      build_range_from_params(values)
-    end
+      def normalize_params(values)
+        build_range_from_params(values)
+      end
 
-    protected
+      protected
 
-    def build_range_from_params(params)
-      QueryFilter::Utils::ScopeRange.new(key, params)
-    end
+      def build_range_from_params(params)
+        QueryFilter::Utils::ScopeRange.new(key, params)
+      end
 
-    def key_from
-      @key_from ||= "#{key}_from".to_sym
-    end
+      def key_from
+        @key_from ||= "#{key}_from".to_sym
+      end
 
-    def key_to
-      @key_to ||= "#{key}_to".to_sym
+      def key_to
+        @key_to ||= "#{key}_to".to_sym
+      end
     end
   end
 end

data/lib/query_filter/rules/scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Define filter rules
 #
 module QueryFilter
@@ -33,7 +35,7 @@ module QueryFilter
       end
 
       def name
-        'scope'.freeze
+        'scope'
       end
 
       def key

data/lib/query_filter/rules/splitter_range.rb

@@ -1,44 +1,49 @@
-module QueryFilter::Rules
-  class SplitterRange < Scope
-    class RangeParam
-      SPLITTER = /[;-]/
+# frozen_string_literal: true
 
-      def initialize(value)
-        @value = value
-      end
+module QueryFilter
+  module Rules
+    class SplitterRange < Scope
+      class RangeParam
+        SPLITTER = /[;-]/.freeze
 
-      def valid?
-        @value.present? && items.size == 2
-      end
+        def initialize(value)
+          @value = value
+        end
+
+        def valid?
+          @value.present? && items.size == 2
+        end
 
-      def range
-        ::Range.new(*items)
+        def range
+          ::Range.new(*items)
+        end
+
+        def items
+          @items ||= @value.split(SPLITTER).map(&:strip).map(&:to_i)
+        end
       end
 
-      def items
-        @items ||= @value.split(SPLITTER).map(&:strip).map(&:to_i)
+      def name
+        'splitter_range'
       end
-    end
 
-    def name
-      'splitter_range'.freeze
-    end
+      def valid?(values)
+        period = build_period_from_params(values)
+        !period.nil?
+      end
 
-    def valid?(values)
-      period = build_period_from_params(values)
-      !period.nil?
-    end
+      def normalize_params(values)
+        build_period_from_params(values)
+      end
 
-    def normalize_params(values)
-      build_period_from_params(values)
-    end
+      protected
 
-    protected
+      def build_period_from_params(values)
+        param = RangeParam.new(values[key])
+        return unless param.valid?
 
-    def build_period_from_params(values)
-      param = RangeParam.new(values[key])
-      return unless param.valid?
-      param
+        param
+      end
     end
   end
 end

data/lib/query_filter/utils/date_normalizer.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 module QueryFilter
   module Utils
     class DateNormalizer
-      TIME_FORMAT = '%Y-%m-%d %H:%M:%S'
       PG_MIN_YEAR = -4713
-      PG_MAX_YEAR = 294276
+      PG_MAX_YEAR = 294_276
 
       attr_reader :date, :format
 
-      def initialize(date, format)
+      def initialize(date, format = nil)
         @date = date
         @format = format
-        @parsed_value = parse
+      end
+
+      def parsed_value
+        @parsed_value ||= parse
       end
 
       def normalize
-        valid?(@parsed_value) ? @parsed_value : default_date
+        valid?(parsed_value) ? parsed_value : default_date
       end
 
       private
@@ -31,13 +35,22 @@ module QueryFilter
 
       def parse
         return date if date?
+        return default_date if date.blank?
+
+        [@format].concat(QueryFilter.datetime_formats).compact.each do |format|
+          value = safe_parse_date(date, format)
+          return value if value
+        end
 
-        time = DateTime.strptime(date, format)
-        Time.zone.parse(time.strftime(TIME_FORMAT))
-      rescue StandardError => _e
         default_date
       end
 
+      def safe_parse_date(string, format)
+        DateTime.strptime(string, format)
+      rescue ArgumentError => _e
+        nil
+      end
+
       def default_date
         Time.zone.today
       end

data/lib/query_filter/utils/date_period.rb

@@ -3,14 +3,12 @@
 module QueryFilter
   module Utils
     class DatePeriod
-      attr_reader :date_from_raw, :date_to_raw, :format
-
-      TIME_FORMAT = '%Y-%m-%d %H:%M:%S'
+      attr_reader :date_from_raw, :date_to_raw
 
       def initialize(date_from = nil, date_to = nil, format = nil)
-        @format = (format.blank? ? QueryFilter.date_period_format : format)
         @date_from_raw = date_from
         @date_to_raw = date_to
+        @format = format
       end
 
       def range
@@ -42,11 +40,11 @@ module QueryFilter
       end
 
       def datefrom
-        @datefrom ||= I18n.l(date_from, format: @format)
+        @datefrom ||= I18n.l(date_from, format: date_display_format)
       end
 
       def dateto
-        @dateto ||= I18n.l(date_to, format: @format)
+        @dateto ||= I18n.l(date_to, format: date_display_format)
       end
 
       def to_param
@@ -72,15 +70,19 @@ module QueryFilter
         return value if value.is_a?(DatePeriod)
 
         if value.blank?
-          new(nil, nil, format)
+          new
         else
           dates = value.to_s.split(QueryFilter.date_period_splitter).map(&:strip)
-          new(dates[0], dates[1], format)
+          new(dates[0], dates[1], format || QueryFilter.date_period_format)
         end
       end
 
       private
 
+      def date_display_format
+        @format || QueryFilter.date_display_format
+      end
+
       def normalize_date(date)
         QueryFilter::Utils::DateNormalizer.new(date, @format).normalize
       end

data/lib/query_filter/utils/scope_range.rb

@@ -1,42 +1,46 @@
-module QueryFilter::Utils
-  # Usage:
-  #
-  #   range = Utils::ScopeRange.new(:orders, { orders_from: 1, orders_to: 44 })
-  #   range.query('orders_count')
-  #
-  class ScopeRange
-    def initialize(name, options = {})
-      @name = name
-      @options = options
-    end
+# frozen_string_literal: true
 
-    def name_from
-      @name_from ||= "#{@name}_from".to_sym
-    end
+module QueryFilter
+  module Utils
+    # Usage:
+    #
+    #   range = Utils::ScopeRange.new(:orders, { orders_from: 1, orders_to: 44 })
+    #   range.query('orders_count')
+    #
+    class ScopeRange
+      def initialize(name, options = {})
+        @name = name
+        @options = options
+      end
 
-    def name_to
-      @name_to ||= "#{@name}_to".to_sym
-    end
+      def name_from
+        @name_from ||= "#{@name}_from".to_sym
+      end
 
-    def value_from
-      @options[name_from]
-    end
+      def name_to
+        @name_to ||= "#{@name}_to".to_sym
+      end
 
-    def value_to
-      @options[name_to]
-    end
+      def value_from
+        @options[name_from]
+      end
 
-    def valid?
-      @options && (value_from.present? || value_to.present?)
-    end
+      def value_to
+        @options[name_to]
+      end
+
+      def valid?
+        @options && (value_from.present? || value_to.present?)
+      end
 
-    def query(column)
-      if value_from.present? && value_to.present?
-        ["#{column} BETWEEN ? AND ?", value_from, value_to]
-      elsif value_from.present?
-        ["#{column} >= ?", value_from]
-      elsif value_to.present?
-        ["#{column} <= ?", value_to]
+      def query(column)
+        if value_from.present? && value_to.present?
+          ["#{column} BETWEEN ? AND ?", value_from, value_to]
+        elsif value_from.present?
+          ["#{column} >= ?", value_from]
+        elsif value_to.present?
+          ["#{column} <= ?", value_to]
+        end
       end
     end
   end

data/lib/query_filter/utils/user_conditions.rb

@@ -15,8 +15,8 @@ module QueryFilter
 
       def passed?
         return true if empty?
-        value = target.params
 
+        value = target.params
         conditions_lambdas.all? { |c| c.call(target, value) }
       end
 
@@ -35,8 +35,8 @@ module QueryFilter
 
       private
 
-      def invert_lambda(l)
-        ->(*args, &blk) { !l.call(*args, &blk) }
+      def invert_lambda(lblock)
+        ->(*args, &blk) { !lblock.call(*args, &blk) }
       end
 
       # Filters support:
@@ -61,6 +61,7 @@ module QueryFilter
         if filter.arity > 1
           lambda do |target, _, &block|
             raise ArgumentError unless block
+
             target.instance_exec(target, block, &filter)
           end
         elsif filter.arity <= 0

data/lib/query_filter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module QueryFilter
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.2.0'
 end

data/lib/query_filter.rb

@@ -31,6 +31,18 @@ module QueryFilter
   mattr_accessor :date_period_splitter
   self.date_period_splitter = 'to'
 
+  mattr_accessor :date_display_format
+  self.date_display_format = '%Y-%m-%d %H:%M'
+
+  mattr_accessor :datetime_formats
+  self.datetime_formats = %w[
+    %Y-%m-%dT%H:%M:%S.%L%z
+    %Y-%m-%dT%H:%M:%S%z
+    %Y-%m-%d %H:%M:%S
+    %Y-%m-%d %H:%M
+    %Y-%m-%d
+  ]
+
   # Default way to setup QueryFilter
   # @example
   #   QueryFilter.setup do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Galeta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: ActiveRecord query filter gem