yaqb 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e04137221fff3125141b5bde2639f5cf593196c5cf0ebe8d5539b08ea015dda6
-  data.tar.gz: 05c9f3e841fc59acc09aa8cb02384a5ab0734101af280f9caada7106b27d1d65
+  metadata.gz: a04bf5ad9bfc9480751951e4ff8d5130c63720fada33e09012d9204ac5a3082e
+  data.tar.gz: 3cbe75005b7df8d27bb0569db90dfc05377c59266bd137959a97281a0c944a7b
 SHA512:
-  metadata.gz: 4671b0432e53842b4287c34889728ee91ac8e4368cd40402d49f580323ef5e4163a448dbe0bb362d14c055552b9dd3fb060ad386ce1d9587fe855f5775406377
-  data.tar.gz: 7cd15411fc2abde2695d6d779578928d1ba1297557164ab81df4b9bdb262878e9bc8f56c5b6872b8dcdf3ccf17605f4dbcaacdc803e849b6af997dd0afd08942
+  metadata.gz: 0b1095d0e8d279e3d6d3ff7526ad3b92621676edfc43642e141b9275ef9aae43ec65b4f350da5e0c5b5c06fc9f51b362091f80366e92375dbeb838e4066271d6
+  data.tar.gz: 7cc7b2b5c26915c326da053903d129c55daca8575df356c836ca3703224d57c3995a3f4b6f7a73948e214d3524e115e0b8e7fb6c4d6204e81bfd03ae8320a412

data/lib/yaqb/{query_builder.rb → base.rb}

@@ -3,11 +3,20 @@
 require 'yaqb/query_builders/query_orchestrator'
 
 module Yaqb
-  module QueryBuilder
+  module Base
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        rescue_from Yaqb::Errors::QueryBuilderError, with: :builder_error
+      end
+    end
+
+    module ClassMethods; end
+
     private
 
-    def orchestrate(scope, options = {})
-      QueryBuilders::QueryOrchestrator.new(scope, params, request, response, options).call
+    def orchestrate(scope, presenter)
+      QueryBuilders::QueryOrchestrator.new(scope, params, request, response, presenter).call
     end
 
     def builder_error(error)

data/lib/yaqb/hooks.rb

@@ -3,22 +3,9 @@
 begin; require 'kaminari'; rescue LoadError; end
 
 unless defined?(Kaminari)
-  Kernel.warn <<~HEREDOC.chomp
+  Kernel.warn <<~HEREDOC
     Warning: Yaqb relies on Kaminari. Please
     install dependency by adding the following to your Gemfile:
-    gem 'kaminari'
+    gem 'kaminari'\n
   HEREDOC
 end
-
-
-if defined?(ActionController::Base)
-  require 'yaqb/query_builder'
-  ActionController::Base.send(:include, Yaqb::QueryBuilder)
-  ActionController::Base.rescue_from Yaqb::Errors::QueryBuilderError, with: :builder_error
-end
-
-if defined?(ActionController::API)
-  require 'yaqb/query_builder'
-  ActionController::API.send(:include, Yaqb::QueryBuilder)
-  ActionController::API.rescue_from Yaqb::Errors::QueryBuilderError, with: :builder_error
-end

data/lib/yaqb/presenter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yaqb
+  class Presenter
+    @sort_attributes = []
+    @filter_attributes = []
+
+    class << self
+      attr_accessor :sort_attributes, :filter_attributes
+
+      def sort_by(*args)
+        @sort_attributes = args.map(&:to_s)
+      end
+
+      def filter_by(*args)
+        @filter_attributes = args.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/yaqb/query_builders/filter.rb

@@ -5,10 +5,10 @@ module Yaqb
     class Filter
       PREDICATES = %w[eq cont notcont start end gt lt].freeze
 
-      def initialize(scope, params, options = {})
+      def initialize(scope, params, presenter)
         @scope = scope
         @filters = params['q'] || {}
-        @options = options
+        @presenter = presenter
       end
 
       def filter
@@ -68,7 +68,8 @@ module Yaqb
       end
 
       def validate_filters
-        attributes = @options[:columns]
+        attributes = @presenter.filter_attributes
+
         @filters.each do |key, data|
           error!(key, data) unless attributes.include?(data[:column])
           error!(key, data) unless PREDICATES.include?(data[:predicate])
@@ -76,7 +77,7 @@ module Yaqb
       end
 
       def error!(key, data)
-        columns = @options[:columns].join(', ')
+        columns = @presenter.filter_attributes.join(', ')
         pred = PREDICATES.join(', ')
 
         raise Errors::QueryBuilderError.new("q[#{key}]=#{data[:value]}"),

data/lib/yaqb/query_builders/query_orchestrator.rb

@@ -7,12 +7,12 @@ require 'yaqb/query_builders/filter'
 module Yaqb
   module QueryBuilders
     class QueryOrchestrator
-      def initialize(scope, params, request, response, options = {})
+      def initialize(scope, params, request, response, presenter)
         @scope = scope
         @params = params
         @request = request
         @response = response
-        @options = options
+        @presenter = presenter
       end
 
       def call
@@ -37,7 +37,7 @@ module Yaqb
       end
 
       def filter
-        Filter.new(@scope, @params.to_unsafe_hash, @options).filter
+        Filter.new(@scope, @params.to_unsafe_hash, @presenter).filter
       end
     end
   end

data/lib/yaqb/version.rb

@@ -1,3 +1,3 @@
 module Yaqb
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/yaqb.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'yaqb/version'
+require 'yaqb/hooks'
 require 'yaqb/configuration'
+require 'yaqb/presenter'
+require 'yaqb/base'
 require 'yaqb/errors/query_builder_error'
-require 'yaqb/railtie'
 
 module Yaqb
   class << self

data/yaqb.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'railties', '>= 4.2.0'
   spec.add_development_dependency 'rake', '~> 12.3.0'
   spec.add_development_dependency 'rspec', '~> 3.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaqb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ronald Chacon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,15 +85,15 @@ files:
 - bin/console
 - bin/setup
 - lib/yaqb.rb
+- lib/yaqb/base.rb
 - lib/yaqb/configuration.rb
 - lib/yaqb/errors/query_builder_error.rb
 - lib/yaqb/hooks.rb
-- lib/yaqb/query_builder.rb
+- lib/yaqb/presenter.rb
 - lib/yaqb/query_builders/filter.rb
 - lib/yaqb/query_builders/paginate.rb
 - lib/yaqb/query_builders/query_orchestrator.rb
 - lib/yaqb/query_builders/sort.rb
-- lib/yaqb/railtie.rb
 - lib/yaqb/version.rb
 - yaqb.gemspec
 homepage: https://github.com/ronaldchacon/yaqb

data/lib/yaqb/railtie.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/railtie'
-
-module Yaqb
-  class Railtie < ::Rails::Railtie
-    config.after_initialize do
-      require 'yaqb/hooks'
-    end
-  end
-end