rao-query 0.0.3.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19dcce90ee295149c4a55e9412bbcf3ecf98407d
+  data.tar.gz: 28f11c998767d9f7304e52793af3739638701ea5
+SHA512:
+  metadata.gz: 064ab43e5fd6708d42008df4eb0f46b5f2fbb341104b94c16646818f4d9ba1dfeeb9c4c01407dfcca846d65a29ed71dbbd5e598348c3667e63e354a0c3c15407
+  data.tar.gz: 83f3bf5075cf12df8af694c39dd774ac0d1787f1d17efa725afc62dc610e055509e9a95aaa15e3370386bee3d4a780c98c1f31dc9489a6f99a934238625b0f92

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Roberto Vasquez Angel
+
+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,28 @@
+# Rails Add-Ons Query
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-query'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-query
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Add-Ons Query'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'

data/app/concerns/rao/query/controller/query_concern.rb

@@ -0,0 +1,70 @@
+module Rao
+  module Query
+    module Controller
+      # Example
+      #
+      #     # app/controllers/posts_controller.rb
+      #     class PostsController < ApplicationController
+      #       include Rao::Query::Controller::QueryConcern
+      #
+      #       def index
+      #         @posts = with_conditions_from_query(Post).all
+      #       end
+      #     end
+      #
+      module QueryConcern
+        extend ActiveSupport::Concern
+
+        private
+
+        def with_conditions_from_query(scope)
+          if query_params.keys.include?('q')
+            condition_params = normalize_query_params(query_params)
+          else
+            condition_params = query_params
+          end
+
+          condition_params.reject.reject { |k,v| v.blank? }.each do |field, condition|
+            case field
+            when 'limit'
+              scope = scope.limit(condition.to_i)
+            when 'offset'
+              scope = scope.offset(condition.to_i)
+            when 'order'
+              scope = scope.order(condition)
+            when 'includes'
+              scope = scope.includes(condition.map(&:to_sym))
+            else
+              condition_statement = ::Rao::Query::ConditionParser.new(scope, field, condition).condition_statement
+              scope = scope.where(condition_statement)
+            end
+          end
+          scope
+        end
+
+        def query_params
+          default_query_params
+        end
+
+        def default_query_params
+          request.query_parameters.except(*default_query_params_exceptions)
+        end
+
+        def default_query_params_exceptions
+          %w(sort_by sort_direction utf8 commit page)
+        end
+
+        def normalize_query_params(params)
+          params['q'].each_with_object({}) { |(k, v), m| m[normalize_key(k)] = v }
+        end
+
+        def normalize_key(key)
+          splitted_key = key.split('_')
+          predicate = splitted_key.last
+          attribute = splitted_key[0..-2].join('_')
+          "#{attribute}(#{predicate})"
+        end
+      end
+    end
+  end
+end

data/app/concerns/rao/query/controller/query_form_concern.rb~

@@ -0,0 +1,13 @@
+module Rao
+  module Query
+    module Controller
+      module QueryFormConcern
+        extend ActiveSupport::Concern
+
+        included do
+          view_helper Rao::Query::ApplicationHelper, as: :query_helper
+        end
+      end
+    end
+  end
+end

data/app/parsers/rao/query/condition_parser.rb

@@ -0,0 +1,149 @@
+module Rao
+  module Query
+    class ConditionParser
+      OPERATOR_MAP = {
+        gt:       :>,
+        gt_or_eq: :>=,
+        eq:       :'=',
+        not_eq:   :'<>',
+        lt_or_eq: :<=,
+        lt:       :<,
+        null:     :is_null,
+        not_null: :is_not_null,
+        cont:     :like
+      }
+
+      def initialize(scope, field, condition)
+        @scope, @field, @condition = scope, field, condition
+      end
+
+      def condition_statement
+        build_condition_statement(@field, @condition)
+      end
+
+      private
+
+      def build_condition_statement(parent_key, condition, nested = false)
+        if is_a_condition?(parent_key) && !nested
+          table, column, operator = extract_table_column_and_operator(parent_key)
+          return handle_null_condition(column, operator) if is_null_operator?(operator)
+          # binding.pry
+          if operator == 'cont'
+            return ["#{table}.#{column} LIKE ?", "%#{normalized_condition(table, column, condition)}%"]
+          else
+            return ["#{table}.#{column} = ?", normalized_condition(table, column, condition)]
+          end
+          # if column_is_boolean?(column)
+          #   ["#{column} = ?", to_boolean(condition)]
+          # else
+          #   ["#{column} = ?", condition]
+          # end
+        else
+          if nested
+            column = extract_column(parent_key)
+            { column => condition }
+          else
+            { parent_key => build_condition_statement(condition.first[0], condition.first[1], true) }
+          end
+        end
+      end
+
+      def is_null_operator?(operator)
+        %w(null not_null).include?(operator)
+      end
+
+      def handle_null_condition(column, operator)
+        case operator.to_sym
+        when :null
+          "#{column} IS NULL"
+        when :not_null
+          "#{column} IS NOT NULL"
+        end
+      end
+
+      def is_a_condition?(obj)
+        !!extract_operator(obj)
+      end
+
+      def extract_operator(obj)
+        string = obj.to_s
+        operator_map.each do |key, value|
+          return value if string.end_with?("(#{key})")
+        end
+        nil
+      end
+
+      def extract_column(obj)
+        obj.to_s.split("(").first
+      end
+
+      # def extract_column_and_operator(string)
+      #   if string =~ /([\.a-z_]{1,})\(([a-z_]{2,})\)/
+      #     return $~[1], $~[2]
+      #   end
+      # end
+
+      def extract_table_column_and_operator(string)
+        if string =~ /([\.a-z_]{1,})\(([a-z_]{2,})\)/
+          table_and_column = $~[1]
+          operator = $~[2]
+          column, table_or_association = table_and_column.split('.').reverse
+          if table_or_association.nil?
+            table = @scope.table_name
+          else
+            table = tables_and_classes_with_associations[table_or_association].table_name
+          end
+          return table, column, operator
+        end
+      end
+
+      def operator_map
+        OPERATOR_MAP
+      end
+
+      def column_is_boolean?(table_name, column_name)
+        scope, column = get_scope_and_column_from_column_name(column_name, table_name)
+        raise "Unknown column: #{column_name}" unless scope.columns_hash.has_key?(column)
+        scope.columns_hash[column].type == :boolean
+      end
+
+      def get_scope_and_column_from_column_name(column_name, table_name = nil)
+        if table_name == @scope.table_name
+          return @scope, column_name
+        else
+          # tables_and_classes = @scope.reflect_on_all_associations.reject { |a| a.polymorphic? }.each_with_object({}) { |a, memo| memo[a.table_name] = a.klass }
+          # associations_and_classes = @scope.reflect_on_all_associations.reject { |a| a.polymorphic? }.each_with_object({}) { |a, memo| memo[a.name.to_s] = a.klass }
+          # scope = tables_and_classes.merge(associations_and_classes)[$~[1]]
+          scope = tables_and_classes_with_associations[table_name]
+          return scope, column_name
+        end
+      end
+
+      def tables_and_classes_with_associations
+        tables_and_classes = @scope.reflect_on_all_associations.reject { |a| (a.respond_to?(:polymorphic?) && a.polymorphic?) || a.options[:polymorphic] == true }.each_with_object({}) { |a, memo| memo[a.table_name] = a.klass }
+        associations_and_classes = @scope.reflect_on_all_associations.reject { |a| (a.respond_to?(:polymorphic?) && a.polymorphic?) || a.options[:polymorphic] == true }.each_with_object({}) { |a, memo| memo[a.name.to_s] = a.klass }
+        tables_and_classes.merge(associations_and_classes)
+      end
+
+      def to_boolean(string)
+        result = case
+        when Rails.version < '4.2'
+          ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(string)
+        when Rails.version < '5.0'
+          ::ActiveRecord::Type::Boolean.new.type_cast_for_schema(string)
+        else
+          ::ActiveRecord::Type::Boolean.new.cast(string)
+        end
+        result.gsub('"', '')
+      end
+
+      def normalized_condition(table, column, condition)
+        if column_is_boolean?(table, column)
+          to_boolean(condition)
+        else
+          condition
+        end
+      end
+    end
+  end
+end

data/app/view_helpers/rao/query/application_helper.rb

@@ -0,0 +1,131 @@
+module Rao
+  module Query
+    # First you have to add the helper and the query concern to your controller:
+    #
+    #     # app/controllers/application_controller.rb
+    #     class ApplicationController < ActionController::Base
+    #       include Rao::Query::Controller::QueryConcern
+    #       view_helper Rao::Query::ApplicationHelper, as: :query_helper
+    #       # ....
+    #     end
+    #
+    class ApplicationHelper < ViewHelper::Base
+      # Example:
+      #
+      #     # app/views/posts/index.html.haml
+      #     = query_helper(self).form_for(@posts, url: posts_path, method: :get) do |f|
+      #       = f.input :title_cont
+      #       = f.input :body_cont
+      #       = f.boolean :published_eq
+      #       = f.submit nil, class: 'btn btn-primary'
+      #       = f.reset  nil, class: 'btn btn-default'
+      #
+      #     # app/controllers/posts_controller.rb
+      #     class ApplicationController < ActionController::Base
+      #       def index
+      #         @posts = with_conditions_from_query(Post).all
+      #       end
+      #
+      # If you are using bootstrap you may want to display the form inline for a
+      # more compact view:
+      #
+      #     = query_helper(self).form_for(collection, html: { class: 'form-inline' }) do |f|
+      #
+      def form_for(collection, options = {}, &block)
+        handle_simple_form_missing unless c.respond_to?(:simple_form_for)
+        wrapped_collection = SearchableCollection.new(collection, c.params[:q])
+        c.simple_form_for(wrapped_collection, options.reverse_merge(as: :q, url: c.collection_path, method: :get, builder: SearchFormBuilder), &block)
+      end
+
+      class SearchFormBuilder < SimpleForm::FormBuilder
+        def boolean(name, options = {})
+          translated_label = translate_label_for_boolean(name)
+          options.reverse_merge!(collection: [[I18n.t("search_form_builder.yes"), 1], [I18n.t("search_form_builder.no"), 0]], include_blank: true, label: translated_label)
+          input name, options
+        end
+
+        def input(name, options = {})
+          if association = options.delete(:association)
+            translated_label = translate_label(name, association)
+            input_name = "#{association}.#{name}"
+          else
+            translated_label = translate_label(name)
+            input_name = name
+          end
+          super(input_name, options.reverse_merge(label: translated_label))
+        end
+
+        def submit(title = nil, options = {})
+          title ||= I18n.t('search_form_builder.submit')
+          super(title, options)
+        end
+
+        def reset(title = nil, options = {})
+          title ||= I18n.t('search_form_builder.reset')
+          link_html = options.delete(:link_html) || {}
+          template.link_to(title, template.url_for(), link_html)
+        end
+
+        private
+
+        def translate_label(name, association = nil)
+          splitted_name = name.to_s.split('_')
+          attribute_name = splitted_name[0..-2].join('_')
+          predicate = splitted_name.last
+          translated_attribute_name = if association.nil?
+            klass_name = object.original_model_class_name
+            klass_name.constantize.human_attribute_name(attribute_name)
+          else
+            klass_name = object.original_model_class.reflect_on_association(association).klass.name
+            klass = klass_name.constantize
+            "#{klass.model_name.human} #{klass.human_attribute_name(attribute_name)}"
+          end
+          I18n.t("search_form_builder.predicates.#{predicate}", attribute_name: translated_attribute_name)
+        end
+
+        def translate_label_for_boolean(name)
+          splitted_name = name.to_s.split('_')
+          attribute_name = splitted_name[0..-2].join('_')
+          predicate = splitted_name.last
+          if association.nil?
+            klass_name = object.original_model_class_name
+          else
+            klass_name = object.original_model_class.reflect_on_association(association).klass
+          end
+          translated_attribute_name = klass_name.constantize.human_attribute_name(attribute_name)
+          I18n.t("search_form_builder.boolean_label", attribute_name: translated_attribute_name)
+        end
+      end
+
+      class SearchableCollection
+        include ActiveModel::Model
+        extend ActiveModel::Translation
+
+        def method_missing(method, *args)
+          if method.to_s.match(/(.+)_(gt|gt_or_eq|eq|not_eq|lt_or_eq|lt|null|not_null|cont)/)
+            @query.send(:[], method)
+          else
+            super
+          end
+        end
+
+        def initialize(collection, query)
+          @collection = collection
+          @query = query || {}
+        end
+
+        def original_model_class_name
+          @collection.class.to_s.deconstantize
+        end
+
+        def original_model_class
+          @collection.klass
+        end
+      end
+
+      def handle_simple_form_missing
+        raise "simple_form_for is not available. Please add simple_form to your Gemfile."
+      end
+    end
+  end
+end

data/lib/rao/query/configuration.rb

@@ -0,0 +1,9 @@
+module Rao
+  module Query
+    module Configuration
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/rao/query/engine.rb

@@ -0,0 +1,7 @@
+module Rao
+  module Query
+    class Engine < ::Rails::Engine
+      isolate_namespace Rao::Query
+    end
+  end
+end

data/lib/rao/query/version.rb

@@ -0,0 +1,7 @@
+require 'rao/version'
+
+module Rao
+  module Query
+    VERSION = ::Rao::VERSION
+  end
+end

data/lib/rao/query.rb

@@ -0,0 +1,11 @@
+require "rao-view_helper"
+
+require "rao/query/version"
+require "rao/query/configuration"
+require "rao/query/engine"
+
+module Rao
+  module Query
+    extend Configuration
+  end
+end

data/lib/rao-query.rb

@@ -0,0 +1 @@
+require 'rao/query'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: rao-query
+version: !ruby/object:Gem::Version
+  version: 0.0.3.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rao
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rao-view_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: guard-rspec
+  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: guard-bundler
+  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: pry
+  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'
+description: 
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/concerns/rao/query/controller/query_concern.rb
+- app/concerns/rao/query/controller/query_form_concern.rb~
+- app/parsers/rao/query/condition_parser.rb
+- app/view_helpers/rao/query/application_helper.rb
+- lib/rao-query.rb
+- lib/rao/query.rb
+- lib/rao/query/configuration.rb
+- lib/rao/query/engine.rb
+- lib/rao/query/version.rb
+homepage: https://github.com/rao
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Filter Queries for Ruby on Rails.
+test_files: []