rad_core_rails 0.5.3 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542155bff8ff325428b30760ef13fda51209abd8d3f828fe6f4e8d6ebaa27c79
-  data.tar.gz: 31a9ee127dd3dd4639df4f8504083521f6587f1d67d9ed64498ef9b38e163627
+  metadata.gz: c5230b7df1cd2ab97fe6564245ecf4e2db25cc3a94347c671ce7ba0130ff97a9
+  data.tar.gz: aec5f63b9beaf6bb4d944b48bae11f4013c234c9b19f65ac94117df0f99e3c13
 SHA512:
-  metadata.gz: 5d0404693b4bad560238af7f4c459fd3cda9075ac720163b818d38e8d12e49bcc1cf14a503dc4f09a361eec550f652b8936ad476b3da36e980073a8a67c2eae0
-  data.tar.gz: e9a5a0ba37595e5a3ab1326b9af740bab64305801867660275e63b3e98cebf0a7d5d2d3191b3fe8abebb336382262342dcc95c82ae2ecb4af64018a8917d9f05
+  metadata.gz: 8499c89d340f431ea160f9aa49bd82bef51ad59ba9468e3503f4e398234e770ffdc23f3c17e0475f0e90a44bf5a42c0b1d0c44ee06385968c83ef562f8da33a5
+  data.tar.gz: d674bb003a850988e2896aa67ed0d8cf991c9359e9d3878d21ac8bd2e908b98d6552c2a2ab214d3dead033282201157cace3e3e6e0d4c60902f4bd5c889a9c44

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/.rubocop.yml

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

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,33 +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, "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
-          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?('+') }
-          clause = []
-          search_terms.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 ?)")
-              args.push '%' + (operand == 'OR' ? term[1, term.length].downcase.strip : term.downcase.strip) + '%'
+              and_args.push sanitized_term
             end
-            clause.push '(' + columns.join(' OR ') + ')'
+            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 ?)")
+              or_args.push sanitized_term
+            end
+            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
@@ -74,15 +147,24 @@ module RadCoreRails
         str = if optional_exclusion_clause.present? && filter[:option] == '!='
                 optional_exclusion_clause
               else
-                "(#{column_name} #{filter[:option]} ANY(ARRAY[?]))"
+                # 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[?])"
+        str = "(#{column_name}::text[] && ARRAY[?])"
         args = [filter[:values]]
 
         [str, args]
@@ -169,6 +251,29 @@ 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

data/lib/rad_core_rails/railtie.rb

@@ -0,0 +1,7 @@
+module RadCoreRails
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/rad_core_rails.rake"
+    end
+  end
+end

data/lib/rad_core_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RadCoreRails
-  VERSION = '0.5.3'
+  VERSION = '0.7.3'
 end

data/lib/rad_core_rails/zip_code.rb

@@ -0,0 +1,54 @@
+module RadCoreRails
+  class ZipCode < ActiveRecord::Base
+    self.table_name = 'zip_codes'
+
+    validates_presence_of :city, :state, :zip, :latitude, :longitude
+
+    class << self
+      # Query for returning a one latitude for given zip-code
+      def lat_sub_query
+        <<-SQL
+        SELECT zip_codes.latitude
+        FROM zip_codes
+        WHERE zip = ?
+        LIMIT 1
+        SQL
+      end
+
+      # Query for returning a one longitude value for given zip-code
+      def lng_sub_query
+        <<-SQL
+        SELECT zip_codes.longitude
+        FROM zip_codes
+        WHERE zip = ?
+        LIMIT 1
+        SQL
+      end
+
+      # Query for returning an array of zip codes around the zip-code sent to this function with a given radius in miles.
+      def distance_query
+        <<-SQL
+        WITH t AS (SELECT
+        zip, (
+          3959 * acos (
+            cos(RADIANS((#{lat_sub_query})))
+            * cos(RADIANS(zip_codes.latitude))
+            * cos(RADIANS(zip_codes.longitude) - RADIANS((#{lng_sub_query})))
+            + sin(RADIANS((#{lat_sub_query})))
+            * sin(RADIANS(zip_codes.latitude))
+          )
+        ) AS distance
+        FROM zip_codes) SELECT t.zip FROM t WHERE t.distance < ?
+        SQL
+      end
+
+      # Query arguments for the `distance_query` based on passed filter params.
+      def distance_args(filter)
+        zip_value = filter[:values].try(:first) || ''
+        distance_miles = filter[:option] || 0
+
+        [zip_value, zip_value, zip_value, distance_miles]
+      end
+    end
+  end
+end

data/lib/rad_core_rails/zip_importer.rb

@@ -0,0 +1,43 @@
+require "rad_core_rails/zip_code"
+
+module RadCoreRails
+  class ZipImporter
+    attr_reader :file_path, :zip_codes_data
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def call
+      puts "Parsing file..."
+      parse_data
+      puts "Parsing completed."
+
+      puts "Importing data..."
+      import_data!
+      puts "Successfully imported!"
+
+      true
+    end
+
+    private
+
+    def import_data!
+      zip_codes_data.each do |zip_code_data|
+        fields = zip_code_data["fields"]
+
+        RadCoreRails::ZipCode.find_or_create_by!(
+          city: fields["city"].to_s,
+          state: fields["state"].to_s,
+          zip: fields["zip"].to_s,
+          latitude: fields["latitude"].to_s,
+          longitude: fields["longitude"].to_s
+        )
+      end
+    end
+
+    def parse_data
+      @zip_codes_data = JSON.parse(IO.read(file_path))
+    end
+  end
+end