rad_core_rails 0.5.2 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 478fee8c5de287a633bff51aee69953c36f928392d6c1ac283e093f963e3733f
-  data.tar.gz: 9a09f3052e99bb2c108093771fa2aca71845463ca9902e80bef82e586817bcac
+  metadata.gz: 60ce9f471b0a5bdbe4852663368a80b70f1b5962ed05b97f5d46f7c6efd186b6
+  data.tar.gz: 0ca944b3cf5d4ce272e7e0607ca202ba5af6672bf1107f29c55bf17c220d7803
 SHA512:
-  metadata.gz: e01c9c2a528bb6819bd2857aed24c2eb560ba6be63498a62c68a21a7ea820bcb55ca75aca7d6ea1e6828f479ba9dad81a69427ce2ca079317bbbc860f2977bb8
-  data.tar.gz: 8f42802719401dfdc5c0a9b3e90eef16f2e81e5258a4e25fbd10453f931fb320129c256974f6f63fb4ec9e6f8ff0f73bd5a2470bd315d34eeead9839de287893
+  metadata.gz: 5db7400ccea177cf7faed4899187c6da5ad98b2b06dbe9982f9696d5cfe8463b488a32c2df0f4410dfc460d7f941d357004f60bc4eb0b150a46a16d27e055f07
+  data.tar.gz: 1a82d4f0afad3f3138ca2901c39767bf69dadee7bb772d74d522eafc5baedcbbd436f53b50c99d78144c72d692fe88377f6beb38d62eff749efbcc2d5489d648

data/.gitignore

@@ -8,9 +8,10 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
-bin
+/bin/
 *.gem
 .rspec_status
 .ruby-gemset
 .ruby-version
 /.byebug_history
+.robocop.yml

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
---color
---require spec_helper
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  SuggestExtensions: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,6 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.5
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
   - 2.7.0

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,74 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at sancho.ck@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sancho.ck@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Oleksandr Poltavets
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2020 Oleksandr Poltavets
+
+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

@@ -22,7 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+For basic functionality just include `RadCoreRails` to your `ActiveRecord` model.
+
+```ruby
+class Job < ActiveRecord::Base
+  include RadCoreRails
+  ...
+end
+```
+
+For using Zip Codes by Radius filter follow the steps below:
+
+Step 1 - generate migration: 
+
+```shell script
+rails generate rad_core_rails:zip_codes_migration
+```
+
+Step 2 - migrate DB:
+
+```shell script
+rails db:migrate
+```
+
+Step 3 - import all US zip-codes to your DB:
+> this gem has built in JSON file with all US zip-codes
+
+```shell script
+rails rad_core_rails:import_zip_codes
+```
+
+Step 4 - add new filter to `filter_manifest` method like on example:
+
+> OLD Syntax
+```ruby
+class Job < ActiveRecord::Base
+  include RadCoreRails
+
+  def self.filter_manifest
+    { 
+      zip_codes: ->(filter) { generate_zip_codes_clauses('addresses.zip', filter) } 
+    }.with_indifferent_access
+  end
+end
+```  
+
+> NEW Syntax starting from v0.7.0
+
+```ruby
+class Job < ActiveRecord::Base
+  include RadCoreRails
+
+  filterable zip_codes: [:zip_codes, 'addresses.zip']
+end
+```
+
+Step 5 - filter params example
+
+```ruby
+{ key: 'zip_codes', option: '15', values: ['85001'] }
+```
+
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require './support/active_record_rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+# Stub the :environment task for tasks like db:migrate & db:seed. Since this is a Gem we've explicitly required all
+# dependent files in the needed places and we don't have to load the entire environment.
+task :environment

data/lib/generators/rad_core_rails/templates/migration.rb.tt

@@ -0,0 +1,17 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :zip_codes do |t|
+      t.string :city
+      t.string :state
+      t.string :zip
+      t.decimal :latitude, precision: 10, scale: 6
+      t.decimal :longitude, precision: 10, scale: 6
+
+      t.timestamps
+    end
+
+    add_index :zip_codes, :zip, unique: true
+    add_index :zip_codes, :latitude
+    add_index :zip_codes, :longitude
+  end
+end

data/lib/generators/rad_core_rails/zip_codes_migration_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators/active_record"
+
+module RadCoreRails
+  module Generators
+    class ZipCodesMigrationGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/create_zip_codes.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/rad_core_rails.rb

@@ -1,15 +1,18 @@
-require "rad_core_rails/version"
-require "active_support/concern"
-require "active_support/core_ext"
+# Need some refactoring: https://ankane.org/gem-patterns
 require "active_record"
-require 'rad_core_rails/query_generator'
-require 'rad_core_rails/search_terms'
-require 'rad_core_rails/sortable'
+
+require "rad_core_rails/railtie" if defined?(Rails)
+require "rad_core_rails/version"
+require "rad_core_rails/query_generator"
+require "rad_core_rails/search_terms"
+require "rad_core_rails/sortable"
 
 module RadCoreRails
+  autoload :ZipCode, 'rad_core_rails/zip_code'
+
   def self.included(receiver)
     receiver.send :include, Sortable, SearchTerms, QueryGenerator
   end
 
   class Error < StandardError; end
-end
+end

data/lib/rad_core_rails/query_generator.rb

@@ -11,13 +11,17 @@ module RadCoreRails
         @searchable_columns = handle_columns(columns)
       end
 
+      def filterable(filters_data = [])
+        @filter_manifest = handle_filterable(filters_data)
+      end
+
       def joins_clause
         <<-SQL
         SQL
       end
 
       def filter_manifest
-        {}.with_indifferent_access
+        @filter_manifest || {}.with_indifferent_access
       end
 
       def create_filters(search, filters)
@@ -29,31 +33,102 @@ module RadCoreRails
           args << arg
         end
         filters.map do |filter|
-          clause, arguments = filter_manifest[filter[:key]].call(filter)
-          query << clause
-          arguments.each do |arg|
-            args << arg
+          begin
+            clause, arguments = filter_manifest[filter[:key]].call(filter)
+            query << clause
+            arguments.each do |arg|
+              args << arg
+            end
+          rescue NoMethodError
+            raise NoMethodError.new("Filter with the name `#{filter[:key]}` doesn't exist.")
           end
         end
         [query.reject(&:blank?).join(' AND '), args]
       end
 
+      # def generate_search_clause(search)
+      #   and_args = []
+      #   or_args = []
+      #   if search.present? && searchable_columns.is_a?(Array)
+      #     # search_term_size = search.split(' ').length
+      #     and_terms = search.split(' ').select { |term| !term.include?('+') }
+      #     or_terms = search.split(' ').select { |term| term.include?('+') }
+      #     and_columns = []
+      #     or_columns = []
+      #     # just_ors = search_term_size == or_term_size
+      #     # operand = just_ors ? 'OR' : 'AND'
+      #     # search_terms = just_ors == true ? search.split(' ') : search.split(' ').select { |term| !term.include?('+') }
+      #     and_terms.each do |term|
+      #       columns = []
+      #       and_terms.each do |col|
+      #         and_columns.push("(LOWER(#{col}) ILIKE ?)")
+      #         and_args.push '%' + term.downcase.strip + '%'
+      #       end
+      #       or_terms.each do |col|
+      #         columns.push("(LOWER(#{col}) ILIKE ?)")
+      #         or_args.push '%' + term[1, term.length].downcase.strip + '%'
+      #       end
+      #       clause = if or_columns.empty?
+      #                  '(' + and_columns.join(' OR ') + ')'
+      #                else
+      #                  '(' + '(' + and_columns.join(' OR ') + ')' + 'AND' + '(' + or_columns.join(' OR ') + ')' + ')'
+      #                         end
+      #     end
+      #     [clause, and_args + or_args]
+      #   else
+      #     ['', []]
+      #   end
+      # end
+
+      # @searchable_columns, is an array of column names that you can compare to your terms.
+      #
       def generate_search_clause(search)
-        args = []
         if search.present? && searchable_columns.is_a?(Array)
-          search_term_size = search.split(' ').length
-          or_term_size = search.split(' ').select { |term| term.include?('+') }.length
-          operand = search_term_size == or_term_size ? 'OR' : 'AND'
-          clause = []
-          search.split(' ').each do |term|
+          # holds all of the sql from sanitized_and_terms
+          and_args = []
+          # holds all the table columns sql for all the AND terms
+          and_clause = []
+          # holds all of the sql from sanitized_or_terms
+          or_args = []
+          # holds all the table columns sql for all the OR terms
+          or_clause = []
+          # extract and terms, remove casing, and add ILIKE '%' comparisions
+          sanitized_and_terms = search.split(' ')
+                                      .reject { |term| term.include?('+') }
+                                      .map { |term| '%' + term.downcase.strip + '%' }
+          # extract or terms, remove casing, and add ILIKE '%' comparisions
+          sanitized_or_terms = search.split(' ')
+                                     .select { |term| term.include?('+') }
+                                     .map { |term| '%' + term[1, term.length].downcase.strip + '%' }
+          # loop through sanitized_and_terms to find all possible columns.
+          sanitized_and_terms.each do |sanitized_term|
+            columns = []
+            # all possible columns where this should be searched
+            searchable_columns.each do |col|
+              columns.push("(LOWER(#{col}) ILIKE ?)")
+              and_args.push sanitized_term
+            end
+            and_clause.push '(' + columns.join(' OR ') + ')'
+          end
+          # loop through sanitized_or_terms to find all possible columns.
+          sanitized_or_terms.each do |sanitized_term|
             columns = []
+            # all possible columns where this should be searched
             searchable_columns.each do |col|
               columns.push("(LOWER(#{col}) ILIKE ?)")
-              args.push '%' + (operand == 'OR' ? term[1, term.length].downcase.strip : term.downcase.strip) + '%'
+              or_args.push sanitized_term
             end
-            clause.push '(' + columns.join(' OR ') + ')'
+            or_clause.push '(' + columns.join(' OR ') + ')'
+          end
+          if or_clause.empty? && and_clause.empty?
+            ['', []]
+          elsif or_clause.empty?
+            ['(' + and_clause.join(' AND ') + ')', and_args]
+          elsif and_clause.empty?
+            ['(' + or_clause.join(' OR ') + ')', or_args]
+          else
+            ['((' + and_clause.join(' AND ') + ') AND (' + or_clause.join(' OR ') + '))', and_args + or_args]
           end
-          ['(' + clause.join(" #{operand} ") + ')', args]
         else
           ['', []]
         end
@@ -68,13 +143,26 @@ module RadCoreRails
         [str, args]
       end
 
-      def generate_model_clause(column_name, filter)
-        str = "(#{column_name} #{filter[:option]} ANY(ARRAY[?]))"
+      def generate_model_clause(column_name, filter, optional_exclusion_clause = nil)
+        str = if optional_exclusion_clause.present? && filter[:option] == '!='
+                optional_exclusion_clause
+              else
+                # probably should fix this.
+                # somtimes we arent sending a filter option, so just default it to =
+                "(#{column_name} #{filter[:option] || '='} ANY(ARRAY[?]))"
+              end
         args = [filter[:values]]
 
         [str, args]
       end
 
+      def generate_zip_codes_clause(column_name, filter)
+        str = "(#{column_name} = ANY(#{zip_code_class.distance_query}))"
+        args = zip_code_class.distance_args(filter)
+
+        [str, args]
+      end
+
       def generate_array_clause(column_name, filter)
         str = "(#{column_name} && ARRAY[?])"
         args = [filter[:values]]
@@ -163,6 +251,27 @@ module RadCoreRails
           end
         end
       end
+
+      def handle_filterable(filters_data)
+        return nil if filters_data.empty?
+        @zip_code_class = filters_data.delete(:zip_code_class)
+
+        result = {}
+
+        filters_data.each do |filter_data|
+          filter_type, filter_column = filter_data.last
+          result[filter_data.first] = lambda { |filter|
+            public_send("generate_#{filter_type}_clause", filter_column, filter)
+          }
+        end
+
+        result.with_indifferent_access
+      end
+
+      def zip_code_class
+        return RadCoreRails::ZipCode unless @zip_code_class
+        @zip_code_class.to_s.constantize
+      end
     end
   end
 end