seek_party 0.0.2 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0924852e23e1fe893c17e0bea8305d4c1c1f31d6f73eedd3e2b91c009b9f8809'
-  data.tar.gz: 8a63dbfc9a23816286856195f820e67d78b1ac2016a20882c645e5b08e575200
+  metadata.gz: 3ca3c040d22ecaf44d42c4d94f63bc34795a691ebc3fcf24a201ba346611c560
+  data.tar.gz: 884466fbeb0b97fc741e82e21eca594d1611c78407eabb7f44f2606a3f5e8812
 SHA512:
-  metadata.gz: 91b7c0211204c18d97c7ae9f81d7d341730b923e39783838f720afc97965441c1fd9a037146ee45df391f7393dad27d9c02cce6aea83a91a9626c5787ccb8dc4
-  data.tar.gz: 746be003921717ebfc0a2ee4b7a252f039d38103f364b326c1fd8bf06df534aff31e85aae05c2863073c4d15d7efa0ad3fd47fd05cabd2f846bd08a27368a346
+  metadata.gz: 65fba3d3ab15003a1a3c781f8101a405f308688c6fcf3cd0ef1349551c13a795146c67d5e5ccd054af6f1fc26f45321d9574dc5ef0eb22bac38481d61daad8f7
+  data.tar.gz: 2de6b896f03f992aafa9b6cdaf80165289eeaab1eaae0a79c7b736cd436accee7bd1fdcf31018476270c8348e29e92d51f476a3528f948c60fd1920d648e748a

data/.travis.yml

@@ -0,0 +1,19 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CODECLIMATE_REPO_TOKEN
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install:
+  - gem install bundler -v 2.0.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle
+  - bundle exec rspec
+after_success:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seek_party (0.0.2)
+    seek_party (0.0.8)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,9 @@
 # SeekParty - Searches made easy
 
+[![Build Status](https://travis-ci.org/caws/seek_party.svg?branch=master)](https://travis-ci.org/caws/seek_party)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a05e479c6f535645d307/maintainability)](https://codeclimate.com/github/caws/seek_party/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a05e479c6f535645d307/test_coverage)](https://codeclimate.com/github/caws/seek_party/test_coverage)
+
 ### What is this?
 
 Have you ever had to write a search functionality for a web application and found yourself
@@ -33,8 +37,6 @@ Below is what's currently doable:
 PS: The DEFAULT_BLACK_LIST contains the attributes :id, :created_at and :updated_at. You can pass your own
     DEFAULT_BLACK_LIST when calling the #search method from your model, but I recommend using the WHITE_LIST, 
     as SeekParty will then only generate queries using the column names present there.
-    You should also keep in mind that when building the queries, seek_party tries to pluralize your table name in order to refer to the table
-    columns by their full name (ex: 'your_table.your_column_name').
 
 ## Getting started
 
@@ -43,7 +45,7 @@ PS: The DEFAULT_BLACK_LIST contains the attributes :id, :created_at and :updated
 Add the following to your Gemfile
 
 ``` ruby
-gem 'seek_party', '~> 0.0.2'
+gem 'seek_party', '~> 0.0.7'
 ```
 Then run:
 
@@ -134,7 +136,7 @@ User.search(params: params)
 And this would result in the following query being produced:
 
 ``` sql
-SELECT "users".* FROM "users" WHERE (LOWER(CAST(users.name AS TEXT)) LIKE '%sugoi%' AND LOWER(CAST(users.name AS TEXT)) = 'bilbo' OR LOWER(CAST(users.email AS TEXT)) LIKE '%sugoi%' AND LOWER(CAST(users.name AS TEXT)) = 'bilbo')
+SELECT "users".* FROM "users" WHERE (LOWER(CAST(users.name AS TEXT)) LIKE '%bilbo@theshire.com%' AND LOWER(CAST(users.name AS TEXT)) = 'bilbo' OR LOWER(CAST(users.email AS TEXT)) LIKE '%bilbo@theshire.com%' AND LOWER(CAST(users.name AS TEXT)) = 'bilbo')
 ```
 
 ### TO DO

data/lib/seek_party.rb

@@ -1,7 +1,9 @@
 require 'active_record' unless defined? ActiveRecord
+require_relative 'seek_party/models/sp_attribute'
+require_relative 'seek_party/models/sp_query'
 require_relative 'seek_party/seek_party_attribute'
 require_relative 'seek_party/seek_party_engine'
-require_relative 'seek_party/seek_party_query'
+require_relative 'seek_party/seek_party_query_builder'
 require_relative 'seek_party/version'
 
 module SeekParty
@@ -12,9 +14,6 @@ module SeekParty
              black_list: DEFAULT_BLACK_LIST,
              white_list: nil,
              scopes: [])
-    # If there are params to work with, use SeekParty.
-    # Otherwise, just return an empty instance of ActiveRecord_Relation.
-    return none if params.empty?
 
     SeekPartyEngine
         .new(self,

data/lib/seek_party/models/sp_attribute.rb

@@ -0,0 +1,20 @@
+class SPAttribute
+  attr_accessor :attributes, :table_name
+
+  def initialize(attributes: [], table_name: nil)
+    @attributes = attributes
+    @table_name = table_name
+  end
+
+  def add_attribute(attribute)
+    @attributes << attribute
+  end
+
+  def get_full_column_name(attribute)
+    if @attributes.include? attribute
+      "#{@table_name}.#{attribute}"
+    else
+      raise 'Attribute not present in the attribute list.'
+    end
+  end
+end

data/lib/seek_party/models/sp_query.rb

@@ -0,0 +1,31 @@
+class SPQuery
+  attr_accessor :queries, :params
+
+  def initialize(queries: {}, params: nil)
+    @queries = queries
+    @params = params
+  end
+
+  def add_attribute_query(attribute, query)
+    @queries[attribute] << query
+  end
+
+  def set_attribute_query(attribute, query)
+    @queries[attribute] = query
+  end
+
+  def build_final_query
+    return if @queries.blank?
+
+    @queries.map { |key, value|
+      if key == @queries.keys.first
+        value
+      else
+        or_and(value)
+      end }.sum
+  end
+
+  def or_and(value)
+    @params[:search].present? ? " OR #{value}" : " AND #{value}"
+  end
+end

data/lib/seek_party/seek_party_attribute.rb

@@ -5,17 +5,17 @@ module SeekParty
                   :black_list
 
     def initialize(inspected_class, white_list, black_list)
-      self.inspected_class = inspected_class
-      self.white_list = white_list
-      self.black_list = black_list
+      @inspected_class = inspected_class
+      @white_list = white_list
+      @black_list = black_list
     end
 
     # Compare attributes to params passed
     # If only search is present, query against all params
-    # If both search and other attributes match agains the
+    # If both search and other attributes match against the
     # params hash, query against them too.
     def discover_attributes
-      check_attributes inspected_class.new
+      check_attributes @inspected_class.new
     end
 
     private
@@ -23,31 +23,30 @@ module SeekParty
     def check_attributes(another_model)
       return nil if another_model.nil?
 
-      attributes = []
+      sp_attribute = SPAttribute.new(table_name: get_table_name)
+
       another_model.attributes.keys.each do |attribute|
         next unless another_model.has_attribute? attribute
         next if black_listed? attribute
 
-        if white_listed? attribute
-          attributes << "#{pluralize_and_snake_case_class_name}.#{attribute}"
-        end
+        sp_attribute.add_attribute(attribute) if white_listed? attribute
       end
 
-      attributes
+      sp_attribute
     end
 
     def white_listed?(attribute_name)
-      return true if white_list.nil?
+      return true if @white_list.nil?
 
-      white_list.include? attribute_name
+      @white_list.include? attribute_name
     end
 
     def black_listed?(attribute_name)
-      black_list.include? attribute_name
+      @black_list.include? attribute_name
     end
 
-    def pluralize_and_snake_case_class_name
-      inspected_class.name.pluralize.underscore
+    def get_table_name
+      @inspected_class.table_name.underscore
     end
   end
 end

data/lib/seek_party/seek_party_engine.rb

@@ -4,16 +4,22 @@ module SeekParty
                   :seek_party_query,
                   :inspected_class
 
-    def initialize(inspected_class, params: {}, white_list: nil, black_list: nil, scopes: {})
-      @seek_party_attribute = SeekPartyAttribute.new(inspected_class, white_list, black_list)
-      @seek_party_query = SeekPartyQuery.new(params)
+    def initialize(inspected_class,
+                   params: {},
+                   white_list: nil,
+                   black_list: nil,
+                   scopes: {})
+      @seek_party_attribute = SeekPartyAttribute.new(inspected_class,
+                                                     white_list,
+                                                     black_list)
+      @seek_party_query = SeekPartyQueryBuilder.new(params)
       @inspected_class = inspected_class
       @scopes = scopes
     end
 
     def search
-      attributes = seek_party_attribute.discover_attributes
-      final_query = seek_party_query.build_query(attributes)
+      spa_attribute = seek_party_attribute.discover_attributes
+      final_query = seek_party_query.build_query(spa_attribute)
       run_search(final_query)
     end
 
@@ -33,8 +39,22 @@ module SeekParty
       # else, as the returned object from run_search is an
       # ActiveRecord_Relation object that would accept
       # method chaining
-      @scopes.each do |key, value|
-        @inspected_class = @inspected_class.method(key).call(value)
+      @scopes.each do |scope|
+        if scope.respond_to?(:keys)
+          scope.keys.each do |key|
+            scope_call(key, scope[key])
+          end
+        else
+          scope_call(scope, nil)
+        end
+      end
+    end
+
+    def scope_call(key, value)
+      if value.present?
+        @inspected_class = @inspected_class.method(key).call(*value)
+      else
+        @inspected_class = @inspected_class.method(key).call
       end
     end
   end

data/lib/seek_party/{seek_party_query.rb → seek_party_query_builder.rb}

@@ -1,44 +1,45 @@
 module SeekParty
-  class SeekPartyQuery
+  class SeekPartyQueryBuilder
 
     attr_accessor :params,
-                  :queries
+                  :sp_query
 
     def initialize(params)
-      self.params = params
-      self.queries = ({})
+      @params = params
+      @sp_query = SPQuery.new(params: params)
     end
 
-    def build_query(attributes)
+    def build_query(sp_attributes)
       return unless params
 
-      build_base_queries(attributes)
-      build_final_query
+      build_base_queries(sp_attributes)
+
+      @sp_query.build_final_query
     end
 
     private
 
     def build_subquery_string(attribute, attribute_deep)
       if params[:search].present?
-        queries[attribute] << " AND #{cast_according_to_adapter(attribute_deep)} = "\
-                                "'#{params[attribute_deep.to_sym].to_s.downcase}'"
+        @sp_query.add_attribute_query(attribute, " AND #{build_equals_query(attribute_deep)}")
       else
-        queries[attribute_deep] = "#{cast_according_to_adapter(attribute_deep)} = "\
-                                "'#{params[attribute_deep.to_sym].to_s.downcase}'"
+        @sp_query.set_attribute_query(attribute_deep, build_equals_query(attribute_deep))
       end
     end
 
-    def build_base_queries(attributes)
-      attributes.each do |attribute|
+    def build_base_queries(spattribute)
+      spattribute.attributes.each do |attribute|
         if params[:search].present?
-          queries[attribute] = "#{cast_according_to_adapter(attribute)} LIKE "\
-                             "'%#{params[:search].downcase}%'"
+          full_column_name = spattribute.get_full_column_name(attribute)
+          cast_column_name = cast_according_to_adapter(full_column_name)
+          @sp_query.set_attribute_query(attribute, "#{cast_column_name} LIKE "\
+                                                 "'%#{params[:search].downcase}%'")
         end
 
         # If there are other params being used other than :search
         # it means a where clause is needed.
         # TODO: Figure out a way to work with date intervals, too.
-        attributes.each do |attribute_deep|
+        spattribute.attributes.each do |attribute_deep|
           next unless params[attribute_deep.to_sym]
 
           build_subquery_string(attribute, attribute_deep)
@@ -46,31 +47,21 @@ module SeekParty
       end
     end
 
-    def build_final_query
-      final_query = ''
-      queries.each do |_key, value|
-        next unless value
-
-        final_query << if value == queries[queries.keys.first]
-                         value
-                       else
-                         params[:search].present? ? " OR #{value}" : " AND #{value}"
-                       end
-      end
-
-      final_query
-    end
-
     def cast_according_to_adapter(column_name)
       if db_sqlite3?
         "LOWER(CAST(#{column_name} AS TEXT))"
       elsif db_postgresql?
         "LOWER(#{column_name}::VARCHAR)"
       else
-        raise "SeekParty does not support #{ActiveRecord::Base.connection.class}"
+        raise "SeekParty does not support #{ActiveRecord::Base.connection.class}."
       end
     end
 
+    def build_equals_query(attribute)
+      "#{cast_according_to_adapter(attribute)} = "\
+      "'#{@params[attribute.to_sym].to_s.downcase}'"
+    end
+
     def db_sqlite3?
       ActiveRecord::Base.connection.instance_of? ActiveRecord::ConnectionAdapters::SQLite3Adapter
     rescue StandardError

data/lib/seek_party/version.rb

@@ -1,3 +1,3 @@
 module SeekParty
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seek_party
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.8
 platform: ruby
 authors:
 - Charles Washington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - ".rakeTasks"
 - ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -72,9 +73,11 @@ files:
 - bin/console
 - bin/setup
 - lib/seek_party.rb
+- lib/seek_party/models/sp_attribute.rb
+- lib/seek_party/models/sp_query.rb
 - lib/seek_party/seek_party_attribute.rb
 - lib/seek_party/seek_party_engine.rb
-- lib/seek_party/seek_party_query.rb
+- lib/seek_party/seek_party_query_builder.rb
 - lib/seek_party/version.rb
 - seek_party.gemspec
 homepage: https://github.com/caws/seek_party