query_helper 0.0.0

data/lib/query_helper/sql_sort.rb

@@ -0,0 +1,49 @@
+require "query_helper/invalid_query_error"
+
+class QueryHelper
+  class SqlSort
+
+    attr_accessor :column_maps
+
+    def initialize(sort_string: "", column_maps: [])
+      @sort_string = sort_string
+      @column_maps = column_maps
+    end
+
+    def parse_sort_string
+      sql_strings = []
+      sorts = @sort_string.split(",")
+      sorts.each_with_index do |sort, index|
+        sort_alias = sort.split(":")[0]
+        direction = sort.split(":")[1]
+        modifier = sort.split(":")[2]
+
+        begin
+          sql_expression = @column_maps.find{ |m| m.alias_name == sort_alias }.sql_expression
+        rescue NoMethodError => e
+          raise InvalidQueryError.new("Sorting not allowed on column '#{sort_alias}'")
+        end
+
+        if direction == "desc"
+          case ActiveRecord::Base.connection.adapter_name
+          when "SQLite" # SQLite is used in the test suite
+            direction = "desc"
+          else
+            direction = "desc nulls last"
+          end
+        else
+          direction = "asc"
+        end
+
+        case modifier
+        when "lowercase"
+          sql_expression = "lower(#{sql_expression})"
+        end
+
+        sql_strings << "#{sql_expression} #{direction}"
+      end
+
+      return sql_strings
+    end
+  end
+end

data/lib/query_helper/version.rb

@@ -0,0 +1,3 @@
+class QueryHelper
+  VERSION = "0.0.0"
+end

data/lib/query_helper.rb

@@ -0,0 +1,173 @@
+require "active_record"
+
+require "query_helper/version"
+require "query_helper/filter"
+require "query_helper/column_map"
+require "query_helper/associations"
+require "query_helper/query_helper_concern"
+require "query_helper/sql_parser"
+require "query_helper/sql_manipulator"
+require "query_helper/sql_filter"
+require "query_helper/sql_sort"
+require "query_helper/invalid_query_error"
+
+class QueryHelper
+
+  attr_accessor :model, :query, :bind_variables, :sql_filter, :sql_sort, :page, :per_page, :single_record, :associations, :as_json_options, :executed_query, :api_payload
+
+  def initialize(
+    model: nil, # the model to run the query against
+    query: nil, # a sql string or an active record query
+    bind_variables: {}, # a list of bind variables to be embedded into the query
+    sql_filter: SqlFilter.new(), # a SqlFilter object
+    sql_sort: SqlSort.new(), # a SqlSort object
+    page: nil, # define the page you want returned
+    per_page: nil, # define how many results you want per page
+    single_record: false, # whether or not you expect the record to return a single result, if toggled, only the first result will be returned
+    associations: nil, # a list of activerecord associations you'd like included in the payload
+    as_json_options: nil, # a list of as_json options you'd like run before returning the payload
+    custom_mappings: {}, # custom keyword => sql_expression mappings
+    api_payload: false # Return the paginated payload or simply return the result array
+  )
+    @model = model
+    @query = query
+    @bind_variables = bind_variables
+    @sql_filter = sql_filter
+    @sql_sort = sql_sort
+    @page = page.to_i if page
+    @per_page = per_page.to_i if per_page
+    @single_record = single_record
+    @associations = associations
+    @as_json_options = as_json_options
+    @custom_mappings = custom_mappings
+    @api_payload = api_payload
+
+    if @page && @per_page
+      # Determine limit and offset
+      limit = @per_page
+      offset = (@page - 1) * @per_page
+
+      # Merge limit/offset variables into bind_variables
+      @bind_variables.merge!({limit: limit, offset: offset})
+    end
+  end
+
+  def update_query(query: nil, model:nil, bind_variables: {})
+    @model = model if model
+    @query = query if query
+    @bind_variables.merge!(bind_variables)
+  end
+
+  def add_filter(operator_code:, criterion:, comparate:)
+    @sql_filter.filter_values["comparate"] = { operator_code => criterion }
+  end
+
+  def execute_query
+    # Correctly set the query and model based on query type
+    determine_query_type()
+
+    # Create column maps to be used by the filter and sort objects
+    column_maps = create_column_maps()
+    @sql_filter.column_maps = column_maps
+    @sql_sort.column_maps = column_maps
+
+    # create the filters from the column maps
+    @sql_filter.create_filters()
+
+    # merge the filter bind variables into the query bind variables
+    @bind_variables.merge!(@sql_filter.bind_variables)
+
+    # Execute Sql Query
+    manipulator = SqlManipulator.new(
+      sql: @query,
+      where_clauses: @sql_filter.where_clauses,
+      having_clauses:  @sql_filter.having_clauses,
+      order_by_clauses: @sql_sort.parse_sort_string,
+      include_limit_clause: @page && @per_page ? true : false
+    )
+    @executed_query = manipulator.build()
+    @results = @model.find_by_sql([@executed_query, @bind_variables]) # Execute Sql Query
+    @results = @results.first if @single_record # Return a single result if requested
+
+    determine_count()
+    load_associations()
+    clean_results()
+  end
+
+  def results()
+    execute_query()
+    return paginated_results() if @api_payload
+    return @results
+  end
+
+
+
+  private
+
+    def paginated_results
+      { pagination: pagination_results(),
+        data: @results }
+    end
+
+    def determine_query_type
+      # If a custom sql string is passed in, make sure a valid model is passed in as well
+      if @query.class == String
+        raise InvalidQueryError.new("a valid model must be included to run a custom SQL query") unless @model < ActiveRecord::Base
+      # If an active record query is passed in, find the model and sql from the query
+      elsif @query.class < ActiveRecord::Relation
+        @model = @query.model
+        @query = @query.to_sql
+      else
+        raise InvalidQueryError.new("unable to determine query type")
+      end
+    end
+
+    def determine_count
+      # Determine total result count (unpaginated)
+      @count = @page && @per_page && @results.length > 0 ? @results.first["_query_full_count"] : @results.length
+    end
+
+    def load_associations
+      @results = Associations.load_associations(
+        payload: @results,
+        associations: @associations,
+        as_json_options: @as_json_options
+      )
+    end
+
+    def clean_results
+      @results.map!{ |r| r.except("_query_full_count") } if @page && @per_page
+    end
+
+    def pagination_results
+      # Set pagination params if they aren't provided
+      @per_page = @count unless @per_page
+      @page = 1 unless @page
+
+      total_pages = (@count/(@per_page.nonzero? || 1).to_f).ceil
+      next_page = @page + 1 if @page.between?(1, total_pages - 1)
+      previous_page = @page - 1 if @page.between?(2, total_pages)
+      first_page = @page == 1
+      last_page = @page == total_pages
+      out_of_range = !@page.between?(1,total_pages)
+
+      { count: @count,
+        current_page: @page,
+        next_page: next_page,
+        previous_page: previous_page,
+        total_pages: total_pages,
+        per_page: @per_page,
+        first_page: first_page,
+        last_page: last_page,
+        out_of_range: out_of_range }
+    end
+
+    def create_column_maps
+      ColumnMap.create_column_mappings(
+        query: @query,
+        custom_mappings: @custom_mappings,
+        model: @model
+      )
+    end
+
+end

data/query_helper.gemspec

@@ -0,0 +1,51 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "query_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_helper"
+  spec.version       = QueryHelper::VERSION
+  spec.authors       = ["Evan McDaniel"]
+  spec.email         = ["eamigo13@gmail.com"]
+
+  spec.summary       = %q{Ruby Gem to help with pagination and data formatting at Pattern, Inc.}
+  spec.description   = %q{Ruby gem developed to help with pagination, filtering, sorting, and including associations on both active record queries and custom sql queries}
+  spec.homepage      = "https://github.com/iserve-products/query_helper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    #
+    # spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6"
+  spec.add_development_dependency "faker", "~> 1.9.3"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'actionpack'
+  spec.add_development_dependency 'activesupport'
+
+  spec.add_dependency "activerecord", "~> 5.0"
+  spec.add_dependency "activesupport", "~> 5.0"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: query_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Evan McDaniel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby gem developed to help with pagination, filtering, sorting, and including
+  associations on both active record queries and custom sql queries
+email:
+- eamigo13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/query_helper.rb
+- lib/query_helper/associations.rb
+- lib/query_helper/column_map.rb
+- lib/query_helper/filter.rb
+- lib/query_helper/invalid_query_error.rb
+- lib/query_helper/query_helper_concern.rb
+- lib/query_helper/sql_filter.rb
+- lib/query_helper/sql_manipulator.rb
+- lib/query_helper/sql_parser.rb
+- lib/query_helper/sql_sort.rb
+- lib/query_helper/version.rb
+- query_helper.gemspec
+homepage: https://github.com/iserve-products/query_helper
+licenses:
+- MIT
+metadata: {}
+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: Ruby Gem to help with pagination and data formatting at Pattern, Inc.
+test_files: []