whereable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fb9a55c5cc4baff3d60aaaa56e5ce74fde2a8a2b20ff4abec5ca7268cca927c
+  data.tar.gz: dd20820bcb8b5a46bdd30458e9c135f41892db53062caeb088590e98e33851c3
+SHA512:
+  metadata.gz: '055580e74876c9f5e1746ce1eb16d2fba7a20efc9fb32f87b1a0fe6faf5648d84b35f9435d11c1749c856d7ab8ee8f0f6f87bcf9f21b7ce7dbaf5a707765fa2b'
+  data.tar.gz: 05e88aef960b3a18d6dcc72d119a8e172adb3c83256215cb1555198dbd9b330b5dfd79b7203e7f3ad9258a40af5956efc5bcdbe9d62882fe783d9f3f9e48762d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mack Earnhardt
+
+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,40 @@
+# Whereable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/whereable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whereable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install whereable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whereable.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/whereable.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Mack Earnhardt
+
+require 'whereable/version'
+require 'active_record'
+require 'active_support'
+require 'treetop'
+require 'whereable.treetop'
+
+# Whereable module
+module Whereable
+  extend ActiveSupport::Concern
+
+  class FilterInvalid < StandardError; end
+
+  module Disjunction
+    # Hash for OR
+    def to_h
+      return conjunction.to_h if opt.empty?
+
+      {
+        or: [conjunction.to_h] + opt.elements.map { |o| o.conjunction.to_h },
+      }
+    end
+  end
+
+  module Conjunction
+    # Hash for AND
+    def to_h
+      return term.to_h if opt.empty?
+
+      {
+        and: [term.to_h] + opt.elements.map { |o| o.term.to_h },
+      }
+    end
+  end
+
+  module NestedExpression
+    # Hash for nested expression
+    delegate :to_h, to: :expression
+  end
+
+  module Condition
+    # Hash for comparison
+    def to_h
+      {
+        operator.to_sym => {
+          column: column.to_s,
+          literal: literal.to_s,
+        },
+      }
+    end
+  end
+
+  module Column
+    # String column name
+    def to_s
+      text_value
+    end
+  end
+
+  # Operators such as 'eq' that match their Arel equivalent aren't needed here
+  OP_SYMS = {
+    'ne' => :not_eq,
+    'lte' => :lteq,
+    'gte' => :gteq,
+    '=' => :eq,
+    '!=' => :not_eq,
+    '<>' => :not_eq,
+    '<' => :lt,
+    '<=' => :lteq,
+    '>' => :gt,
+    '>=' => :gteq,
+  }.freeze
+  private_constant :OP_SYMS
+
+  module Operator
+    # Arel comparion method
+    def to_sym
+      OP_SYMS[text_value] || text_value.downcase.to_sym
+    end
+  end
+
+  module Literal
+    # Strip enclosing quotes and tranlate embedded quote patterns
+    def to_s
+      text_value
+        .gsub(/\A['"]|['"]\z/, '')
+        .gsub("''", "'")
+        .gsub("\\'", "'")
+        .gsub('\"', '"')
+    end
+  end
+
+  included do
+    scope(
+      :whereable,
+      lambda do |filter|
+        return all if filter.blank?
+
+        hash_tree = whereable_hash_tree(filter)
+
+        where(whereable_deparse(hash_tree))
+      end,
+    )
+  end
+
+  class_methods do
+    # Parse filter to hash tree using Treetop PEG
+    def whereable_hash_tree(filter)
+      parser = WhereableParser.new
+      hash = parser.parse(filter)&.to_h
+
+      raise FilterInvalid, "Invalid filter at #{filter[parser.max_terminal_failure_index..-1]}" if hash.nil?
+
+      hash
+    end
+
+    # deparse hash tree to Arel
+    def whereable_deparse(hash)
+      raise FilterInvalid, "Invalid hash #{hash}" if hash.size > 1
+
+      key, value = hash.first
+
+      case key
+      when :and, :or
+        arel = whereable_deparse(value.first)
+        value[1..-1].each do |o|
+          arel = arel.public_send(key, whereable_deparse(o))
+        end
+        arel
+      when :eq, :not_eq, :gt, :gteq, :lt, :lteq
+        column = value[:column]
+        literal = value[:literal]
+        raise FilterInvalid, "Invalid column #{column}" unless column_names.include?(column)
+
+        if defined_enums.key?(column)
+          literal = defined_enums[column][literal] || raise(FilterInvalid, "Invalid value #{literal} for #{column}")
+        end
+        arel_table[column].public_send(key, literal)
+      else
+        raise FilterInvalid, "Invalid hash #{hash}"
+      end
+    end
+  end
+end

data/lib/whereable.treetop

@@ -0,0 +1,37 @@
+grammar Whereable
+  rule expression
+    disjunction
+  end
+
+  rule disjunction
+    conjunction opt:( _? 'or'i _? conjunction )* <Disjunction>
+  end
+
+  rule conjunction
+    term opt:( _? 'and'i _? term )* <Conjunction>
+  end
+
+  rule term
+    condition / '(' _? expression _? ')' <NestedExpression>
+  end
+
+  rule condition
+    column _? operator _? literal <Condition>
+  end
+
+  rule _
+    [\s]+
+  end
+
+  rule column
+    [a-zA-Z0-9_]+ <Column>
+  end
+
+  rule operator
+    ( 'eq' / 'ne' / 'gte' / 'gt' / 'lte' / 'lt' / '=' / '!=' / '<>' / '>=' / '>' / '<=' / '<' ) <Operator>
+  end
+
+  rule literal
+    ( '"' ( '\"' / [^"] )+ '"' / "'" ( "''" / "\\'" / [^'] )+ "'" / [^\s)]+ ) <Literal>
+  end
+end

data/lib/whereable/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Mack Earnhardt
+
+module Whereable
+  VERSION = '0.1.0'
+  public_constant :VERSION
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: whereable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mack Earnhardt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Translate where-like filter syntax into Arel-based ActiveRecord scope.
+
+  '
+email:
+- mack@agilereasoning.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./CHANGELOG.md"
+- "./LICENSE.txt"
+- "./README.md"
+- "./lib/whereable.treetop"
+- lib/whereable.rb
+- lib/whereable/version.rb
+homepage: https://github.com/MacksMind/whereable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MacksMind/whereable
+  source_code_uri: https://github.com/MacksMind/whereable
+  changelog_uri: https://github.com/MacksMind/whereable/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Translate where-like filter syntax into Arel-based ActiveRecord scope.
+test_files: []