seek_party 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7366a41454326575b488a8149cefab4ee1fa184b9df1695e332cf3b114cae5cc
+  data.tar.gz: ebc591f2d3f4a962f953df3caf19f986560f2838fb9b5688f3b71bb70e38f779
+SHA512:
+  metadata.gz: 5c360583067ade61cbb950fe07eca9f00b03cafa1843f61d880bf1bf32cb61938a05becf230efe5cd86b6290a57bb506a705861cfb61d4bd6fabd6eecf437601
+  data.tar.gz: b04839f0ba524ae18fd0f62406a9b6252f33c5e2ad95407b2a25e2802810af66aedc309acdd44b7bd2add6e7015f7f9ed5a2cf49e0bed59b788914cfdae7ca9f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea
+

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build seek_party-0.0.1.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install seek_party-0.0.1.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install seek_party-0.0.1.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.0.1 and build and push seek_party-0.0.1.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +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 charles_was_7@hotmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+ruby '2.6.3'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.3'
+
+group :test do
+  # Use sqlite3 as the database for Active Record
+  gem 'sqlite3'
+
+  # Use rspec as the test tool
+  gem 'rspec-rails', '~> 3.6'
+
+  # Use codeclimate-test-reporter to report tests to codeclimate
+  gem 'codeclimate-test-reporter'
+
+  # Use simplecov to generate the coverage results
+  gem 'simplecov', require: false
+end
+
+# Specify your gem's dependencies in seek_party.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,167 @@
+PATH
+  remote: .
+  specs:
+    seek_party (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4)
+      actionpack (= 5.2.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4)
+      actionview (= 5.2.4)
+      activesupport (= 5.2.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4)
+      activesupport (= 5.2.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4)
+      activesupport (= 5.2.4)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4)
+      activesupport (= 5.2.4)
+    activerecord (5.2.4)
+      activemodel (= 5.2.4)
+      activesupport (= 5.2.4)
+      arel (>= 9.0)
+    activestorage (5.2.4)
+      actionpack (= 5.2.4)
+      activerecord (= 5.2.4)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4)
+      actioncable (= 5.2.4)
+      actionmailer (= 5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
+      activemodel (= 5.2.4)
+      activerecord (= 5.2.4)
+      activestorage (= 5.2.4)
+      activesupport (= 5.2.4)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4)
+      actionpack (= 5.2.4)
+      activesupport (= 5.2.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  codeclimate-test-reporter
+  rails (~> 5.2.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails (~> 3.6)
+  seek_party!
+  simplecov
+  sqlite3
+
+RUBY VERSION
+   ruby 2.6.3p62
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Charles Washington
+
+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,164 @@
+# SeekParty - Searches made easy
+
+<p align="center">
+  <img width="1000" height="204" src="https://i.ibb.co/CHjZYwj/search-party-logo-vector.png">
+</p>
+
+### What is this?
+
+Have you ever had to write a search functionality for a web application and found yourself
+having to write SQL code? 
+
+**Then this is for you.** 
+
+SeekParty adds the method #search to classes that extend it. Once called, SeekParty builds and runs those ugly SQL
+queries in a nice way by inspecting your attributes and checking what is present in your params hash
+against the attributes of your model.
+
+Since it returns an instance of ActiveRecord_Relation, you can chain other scopes/methods if you
+so desire.   
+
+Currently compatible with Sqlite3 and PostgreSQL.
+
+### When should I use this?
+
+When coming up with simple search features for a given application. 
+
+### What is this capable of doing?
+
+Below is what's currently doable:
+  - Search for specific attributes (by passing a params hash where the key is your attribute name and 
+    the value is what you're looking for).
+  - Hit the database with a query containing LIKE for all attributes not present in the BLACK_LIST (or present in the WHITE_LIST) and using
+    a value stored in your params[:search] key. 
+  - Hit the database with a query containing LIKE and the operator = for all attributes not present in the BLACK_LIST (or present in the WHITE_LIST) 
+    and using a value stored in your params[:search] key and a key for one of your attributes (params[:name], for the example of a class User).     
+
+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.
+
+## Getting started
+
+### Instalation
+
+Add the following to your Gemfile
+
+``` ruby
+gem 'seek_party', '~> 0.0.1'
+```
+Then run:
+
+``` shell
+bundle install
+```
+
+Add the SeekParty functionality to your model:
+
+``` ruby
+class User < ApplicationRecord
+  extend SeekParty
+  ...
+end
+```
+
+## Usage
+
+Given a User model like the following:
+
+``` ruby
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :email
+  end
+```
+
+You could search the table like so:
+
+``` ruby
+params = {search: 'bilbo'}
+User.search(params: params)
+```
+
+PS: The params hash can be either created by you or you can pass the ActionController::Parameters
+instance that is available at the controller level.
+
+And it would produce the following query for Sqlite3:
+
+``` sql
+SELECT "users".* FROM "users" WHERE (LOWER(CAST(name AS TEXT)) LIKE '%bilbo%' OR LOWER(CAST(email AS TEXT)) LIKE '%bilbo%')
+```
+
+As you can see, it took all of the attributes into consideration when generating the
+query. But you can also limit what's going to be used to build such query by writing it 
+in the following way:
+
+``` ruby
+params = {search: 'bilbo'}
+User.search(params: params, white_list: ['name'])
+```
+
+Which would in turn produce the following query:
+
+``` sql
+SELECT "users".* FROM "users" WHERE (LOWER(CAST(name AS TEXT)) LIKE '%bilbo%')
+```
+
+If your params hash does not contain a search key, SeekParty will try to compare
+the attributes in your model with the keys available in the params hash.
+
+Which means that the following:
+
+``` ruby
+params = {name: 'bilbo'}
+User.search(params: params)
+```
+
+Would produce a query like this:
+``` sql
+SELECT "users".* FROM "users" WHERE (LOWER(CAST(name AS TEXT)) = 'bilbo')
+```
+
+SeekParty would use the equals operator instead of the LIKE, since it infers that
+if you have keys in your params hash that match the attributes in your model, you basically 
+know what you are looking for.
+
+But say that you are searching for a record for which you know one of the attributes for SURE, 
+but not the other(s). In this case, you could use both the search key as well as one key for 
+each one of your attributes like this:
+
+
+``` ruby
+params = {search: 'bilbo@theshire.com', name: 'bilbo'}
+User.search(params: params)
+```
+
+And this would result in the following query being produced:
+
+``` sql
+SELECT "users".* FROM "users" WHERE (LOWER(CAST(name AS TEXT)) LIKE '%sugoi%' AND LOWER(CAST(name AS TEXT)) = 'bilbo' OR LOWER(CAST(email AS TEXT)) LIKE '%sugoi%' AND LOWER(CAST(name AS TEXT)) = 'bilbo')
+```
+
+### TO DO
+
+- Write more tests
+- Improve code quality
+- Add support to other adapters 
+
+## 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/caws/seek_party. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SeekParty project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/seek_party/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seek_party"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/seek_party/seek_party_attribute.rb

@@ -0,0 +1,47 @@
+module SeekParty
+  class SeekPartyAttribute
+    attr_accessor :inspected_class,
+                  :white_list,
+                  :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
+    end
+
+    # Compare attributes to params passed
+    # If only search is present, query against all params
+    # If both search and other attributes match agains the
+    # params hash, query against them too.
+    def discover_attributes
+      check_attributes inspected_class.new
+    end
+
+    private
+
+    def check_attributes(another_model)
+      return nil if another_model.nil?
+
+      attributes = []
+      another_model.attributes.keys.each do |attribute|
+        next unless another_model.has_attribute? attribute
+        next if black_listed? attribute
+
+        attributes << attribute if white_listed? attribute
+      end
+
+      attributes
+    end
+
+    def white_listed?(attribute_name)
+      return true if white_list.nil?
+
+      white_list.include? attribute_name
+    end
+
+    def black_listed?(attribute_name)
+      black_list.include? attribute_name
+    end
+  end
+end

data/lib/seek_party/seek_party_engine.rb

@@ -0,0 +1,41 @@
+module SeekParty
+  class SeekPartyEngine
+    attr_accessor :seek_party_attribute,
+                  :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)
+      @inspected_class = inspected_class
+      @scopes = scopes
+    end
+
+    def search
+      attributes = seek_party_attribute.discover_attributes
+      final_query = seek_party_query.build_query(attributes)
+      run_search(final_query)
+    end
+
+    private
+
+    def run_search(final_query)
+      # If scopes were passed, iterate trough\ them.
+      setup_scopes if @scopes
+
+      # Execute final query (alongside any scopes that have been passed)
+      @inspected_class.where(final_query)
+    end
+
+    def setup_scopes
+      # Iterate trough the scopes that may have been
+      # passed. PS: This is more of a luxury than anything
+      # 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)
+      end
+    end
+  end
+end

data/lib/seek_party/seek_party_query.rb

@@ -0,0 +1,86 @@
+module SeekParty
+  class SeekPartyQuery
+
+    attr_accessor :params,
+                  :queries
+
+    def initialize(params)
+      self.params = params
+      self.queries = ({})
+    end
+
+    def build_query(attributes)
+      return unless params
+
+      build_base_queries(attributes)
+      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}'"
+      else
+        queries[attribute_deep] = "#{cast_according_to_adapter(attribute_deep)} = "\
+                                "'#{params[attribute_deep.to_sym].to_s.downcase}'"
+      end
+    end
+
+    def build_base_queries(attributes)
+      attributes.each do |attribute|
+        if params[:search].present?
+          queries[attribute] = "#{cast_according_to_adapter(attribute)} 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|
+          next unless params[attribute_deep.to_sym]
+
+          build_subquery_string(attribute, attribute_deep)
+        end
+      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}"
+      end
+    end
+
+    def db_sqlite3?
+      ActiveRecord::Base.connection.instance_of? ActiveRecord::ConnectionAdapters::SQLite3Adapter
+    rescue StandardError
+      false
+    end
+
+    def db_postgresql?
+      ActiveRecord::Base.connection.instance_of? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/seek_party/version.rb

@@ -0,0 +1,3 @@
+module SeekParty
+  VERSION = '0.0.1'.freeze
+end

data/lib/seek_party.rb

@@ -0,0 +1,27 @@
+require 'active_record' unless defined? ActiveRecord
+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/version'
+
+module SeekParty
+  DEFAULT_BLACK_LIST = %w[id created_at updated_at].freeze
+
+  # Method below triggers all the magic
+  def search(params: [],
+             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,
+             params: params,
+             white_list: white_list,
+             black_list: black_list,
+             scopes: scopes)
+        .search
+  end
+end

data/seek_party.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "seek_party/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "seek_party"
+  spec.version       = SeekParty::VERSION
+  spec.authors       = ["Charles Washington"]
+  spec.email         = ["charles_was_7@hotmail.com"]
+
+  spec.summary       = %q{SeekParty makes quick work of adding search functionalities to your models.}
+  spec.description   = %q{This gem should be used alongside ActiveRecord and uses introspection in order to check the fields of a given model. }
+  spec.homepage      = "https://github.com/caws/seek_party"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/caws/seek_party"
+  spec.metadata["changelog_uri"] = "https://github.com/caws/seek_party"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: seek_party
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Washington
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'This gem should be used alongside ActiveRecord and uses introspection
+  in order to check the fields of a given model. '
+email:
+- charles_was_7@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seek_party.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/version.rb
+- seek_party.gemspec
+homepage: https://github.com/caws/seek_party
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/caws/seek_party
+  source_code_uri: https://github.com/caws/seek_party
+  changelog_uri: https://github.com/caws/seek_party
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: SeekParty makes quick work of adding search functionalities to your models.
+test_files: []