monster-queries 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85f1857d151c3e35c4e06617e0dccfac90507e8b921c53ba06c48d10017b004f
+  data.tar.gz: c216ed5afe37826d7bb25ed75c2ee28d330723e24b5a4fe7f20e8bf4644e9ed3
+SHA512:
+  metadata.gz: 336797ea6a5cb43daecbae9d744d4a6fb7b512b412e98495893dcf57f5f865a1172c246bbf57856a4d37613b49793f480700c87aae9bf57da69c431491e182cb
+  data.tar.gz: 4d1332d1c5e49fafdea99126555dcd98d130f0e2eb09ec4c8e1a7dbb0edc6e6a1a2dbb3dcf40d761a14f466d6e144e856c0d1bc14d43403e01f4a664d9a529de

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'MonsterQueries'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/queries/pagination/offset.sql

@@ -0,0 +1,7 @@
+{{#unless count}}
+  LIMIT {{per_page}}
+  {{#if page}}
+    OFFSET (({{page}} - 1) * {{per_page}})
+  {{/if}}
+{{/unless}}
+

data/app/queries/pagination/select.sql

@@ -0,0 +1,12 @@
+SELECT
+  {{#if column}}
+    COUNT({{column}}) as total_entries,
+  {{else}}
+    COUNT(*) as total_entries,
+  {{/if}}
+  {{per_page}} as per_page,
+  {{#if page}}
+    {{page}} as page
+  {{else}}
+    1 as page
+  {{/if}}

data/config/initializers/query.rb

@@ -0,0 +1,4 @@
+require 'monster_queries/query'
+ActiveRecord::Base.send     :include, MonsterQueries::ActiveRecord
+ActionController::Base.send :include, MonsterQueries::ActionController
+Q = MonsterQueries::Query

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/monster-queries.rb

@@ -0,0 +1,6 @@
+require "monster_queries/builder"
+require "monster_queries/query"
+require "monster_queries/active_record"
+require "monster_queries/action_controller"
+require "monster_queries/engine"
+module MonsterQueries; end

data/lib/monster_queries/action_controller.rb

@@ -0,0 +1,55 @@
+module MonsterQueries
+  module ActionController
+    def set_pagination_headers count_json
+      json = JSON.parse(count_json)
+      json = json.first if json.is_a?(Array)
+      page = json['page']
+      total = json['total_entries']
+      per_page = json['per_page'] || 20
+      pages = (total.to_f / per_page).ceil
+      end_entry = page * per_page
+      end_entry = total if end_entry > total
+      headers["X-Pagination"] = {
+        page: page,
+        total:         total,
+        total_pages:   pages,
+        first_page:    page == 1,
+        last_page:     page >= pages,
+        previous_page: page - 1,
+        next_page:     page + 1,
+        out_of_bounds: page < 1 || page > pages,
+        first_entry:    (page - 1) * per_page + 1,
+        end_entry:  end_entry
+      }.to_json
+    end
+
+    # AB - We should phase out {{sort}} in favour
+    # of {{order}} {{by}} for more finetune control
+    def render_paginated target, method, attrs
+      if attrs.key?(:sort)
+        name,dir = attrs[:sort].split ','
+        v = [name]
+        v.push dir.upcase if dir
+        v = v.join ' '
+        attrs[:sort] = v
+        attrs[:order] = name
+        attrs[:by]    = (dir || 'ASC').upcase
+      end
+      attrs[:count] = true
+      count_json = target.send method,attrs
+      set_pagination_headers count_json
+      attrs.delete(:count)
+      target.send method, attrs
+    end
+
+    def render_paginated_json target, method, attrs
+      json = render_paginated target, method, attrs
+      render json: json
+    end
+
+    def index_params
+      params.permit :page, :search, :sort
+    end
+  end
+end
+

data/lib/monster_queries/active_record.rb

@@ -0,0 +1,101 @@
+module MonsterQueries
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    def execute query
+      begin
+        self.class.connection.execute query
+      rescue
+        File.open(Rails.root.join('tmp','failed.sql'), 'w') { |file| file.write(query) }
+        Rails.root.join
+        raise
+      end
+    end
+
+    def select_value query
+      begin
+        self.class.connection.select_value query
+      rescue
+        File.open(Rails.root.join('tmp','failed.sql'), 'w') { |file| file.write(query) }
+        raise
+      end
+    end
+
+    def select_values query
+      begin
+        self.class.connection.select_values query
+      rescue
+        File.open(Rails.root.join('tmp','failed.sql'), 'w') { |file| file.write(query) }
+        raise
+      end
+    end
+
+    def select_json query, count
+      if count
+        select_object query
+      else
+        select_array query
+      end
+    end
+
+    def select_array query
+      sql = <<-SQL
+        SELECT COALESCE(array_to_json(array_agg(row_to_json(query_row))), '[]'::json)
+        FROM (#{query}) query_row
+      SQL
+      select_value sql
+    end
+
+    def select_object query
+      sql = <<-SQL
+        SELECT COALESCE(row_to_json(query_row),'{}'::json)
+        FROM (#{query}) query_row
+      SQL
+      select_value sql
+    end
+
+
+    def select_all query
+      self.class.connection.select_all query
+    end
+
+
+    module ClassMethods
+      def execute query
+        connection.execute query
+      end
+
+      def select_value query
+        connection.select_value query
+      end
+
+      def select_values query
+        connection.select_values query
+      end
+
+      def select_json query, count
+        if count
+          select_object query
+        else
+          select_array query
+        end
+      end
+
+      def select_array query
+        sql = <<-SQL
+          SELECT COALESCE(array_to_json(array_agg(row_to_json(query_row))), '[]'::json)
+          FROM (#{query}) query_row
+        SQL
+        select_value sql
+      end
+
+      def select_object query
+        sql = <<-SQL
+          SELECT COALESCE(row_to_json(query_row),'{}'::json)
+          FROM (#{query}) query_row
+        SQL
+        select_value sql
+      end
+    end
+  end # module
+end # module

data/lib/monster_queries/builder.rb

@@ -0,0 +1,49 @@
+module MonsterQueries
+  class Builder
+    def self.with_scope args
+      q = self.new nil
+      q.scope = args
+      q
+    end
+
+    attr_writer :scope, :paginate
+
+    def initialize name
+      @paginate = false
+      @scope = [name]
+    end
+
+    def method_missing name, args=nil
+      @scope << name
+      file_exists? ? file_contents(args) : self
+    end
+
+    def to_s args={}
+      if file_exists?
+        ::Rails.logger.tagged('MONSTER QUERY') do
+          ::Rails.logger.info {"Rendered #{@scope.join('.')}"}
+        end
+        file_contents args
+      else
+        raise "Query doesn't exist: #{@scope.join('.')}"
+      end
+    end
+
+    def paginate
+      @paginate = true
+      self
+    end
+
+    private
+
+    def file_exists?
+      Q.exists? @scope
+    end
+
+    def file_contents variables
+      template = MonsterQueries::Query.template @scope
+      result = template.call variables
+      result
+    end
+  end # class
+end # module

data/lib/monster_queries/engine.rb

@@ -0,0 +1,4 @@
+module MonsterQueries
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/monster_queries/helpers.rb

@@ -0,0 +1,4 @@
+module MonsterQueries
+  class Helpers
+  end # class
+end # module

data/lib/monster_queries/query.rb

@@ -0,0 +1,147 @@
+require 'active_record'
+require 'handlebars'
+require 'pry'
+module MonsterQueries
+  class Query
+    @template_cache = {}
+    @exists_cache = {}
+    SKIP_CACHE = true
+
+    def self.template_from_parts parts, vars
+      MonsterQueries::Builder.with_scope(parts).to_s vars
+    end
+
+    def self.template_from_string string, vars
+      template = handlebars.compile string, noEscape: true
+      result   = template.call vars
+      result
+    end
+
+    # Method Missing is used to create a chain path
+    # to the query eg. Q.admin.users.index
+    def self.method_missing name
+      MonsterQueries::Builder.new name
+    end
+
+    def self.paginate
+      q = MonsterQueries::Builder.new nil
+      q.paginate = true
+      q
+    end
+
+    def self.locate_file scope
+      search_paths = [Rails.root,MonsterQueries::Engine.root]
+      search_paths.each do |path|
+        file = path.join('app','queries',*scope.compact.map(&:to_s)).to_s + '.sql'
+        return file if File.exists?(file)
+      end
+      return false
+    end
+
+    def self.template scope
+      if !@template_cache[scope.join('.')] || SKIP_CACHE
+        file_name = locate_file(scope)
+        data = File.read file_name
+        @template_cache[scope.join('.')] = handlebars.compile(data, noEscape: true)
+      end
+      @template_cache[scope.join('.')]
+    end
+
+    def self.exists? scope
+      if !@exists_cache[scope] || SKIP_CACHE
+        file_name = locate_file(scope)
+        @exists_cache[scope] = file_name && File.file?(file_name)
+      end
+      @exists_cache[scope]
+    end
+
+    def self.handlebars
+      return @handlebars if @handlebars
+      @handlebars = Handlebars::Context.new
+      @handlebars.register_helper :include        , &(method(:helper_include).to_proc)
+      @handlebars.register_helper :paginate       , &(method(:helper_paginate).to_proc)
+      @handlebars.register_helper :paginate_offset, &(method(:helper_paginate_offset).to_proc)
+      @handlebars.register_helper :wildcard       , &(method(:helper_wildcard).to_proc)
+      @handlebars.register_helper :quote          , &(method(:helper_quote).to_proc)
+      @handlebars.register_helper :int            , &(method(:helper_int).to_proc)
+      @handlebars.register_helper :float          , &(method(:helper_float).to_proc)
+      @handlebars.register_helper :array          , &(method(:helper_array).to_proc)
+      @handlebars.register_helper :object         , &(method(:helper_object).to_proc)
+      @handlebars
+    end
+
+    def self.helper_include context, name, options
+      vars = {}
+      context.each do |k,v|
+        vars[k] = v
+      end
+      options['hash'].each do |k,v|
+        vars[k] = v
+      end if options
+      parts = name.split('.')
+      MonsterQueries::Builder.with_scope(parts).to_s vars
+    end
+
+    def self.helper_paginate context, value, options
+      if value.is_a?(String)
+        count = !!context["count"]
+        name = count ? 'pagination.select' : value
+        self.helper_include context, name, options
+      else
+        value.fn context
+      end
+    end
+
+    def self.helper_paginate_offset context, value, options
+      self.helper_include context, 'pagination.offset', options
+    end
+
+    def self.helper_wildcard context, value, options
+      ::ActiveRecord::Base.connection.quote "%#{value.gsub('\\','\\\\\\')}%"
+    end
+
+    def self.helper_quote context, value, options
+      if value.is_a?(V8::Array)
+        value.collect{|v| ::ActiveRecord::Base.connection.quote v}.join(',')
+      else
+        ::ActiveRecord::Base.connection.quote value
+      end
+    end
+
+    def self.helper_int context, value, options
+      value.to_i
+    end
+
+    def self.helper_float context, value, options
+      value.to_f
+    end
+
+    def self.helper_array context, block, options
+      content =
+      if block.is_a?(String)
+        "\n" + helper_include(context, block, options)
+      else
+        block.fn context
+      end
+      <<-HEREDOC
+(SELECT COALESCE(array_to_json(array_agg(row_to_json(array_row))),'[]'::json) FROM (
+#{content}
+) array_row)
+      HEREDOC
+    end
+
+    def self.helper_object context, block, options
+      content =
+      if block.is_a?(String)
+        "\n" + helper_include(context, block, options)
+      else
+        block.fn context
+      end
+      <<-HEREDOC
+(SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (
+#{content}
+) object_row)
+      HEREDOC
+    end
+  end # class
+end # module

data/lib/monster_queries/version.rb

@@ -0,0 +1,3 @@
+module MonsterQueries
+  VERSION = "1.3.3"
+end

data/lib/tasks/monster_queries_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :monster_queries do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: monster-queries
+version: !ruby/object:Gem::Version
+  version: 1.3.3
+platform: ruby
+authors:
+- Monsterbox Productions
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  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: pry
+  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: libv8
+  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'
+description: Queries
+email:
+- andrew@monsterboxpro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/queries/pagination/offset.sql
+- app/queries/pagination/select.sql
+- config/initializers/query.rb
+- config/routes.rb
+- lib/monster-queries.rb
+- lib/monster_queries/action_controller.rb
+- lib/monster_queries/active_record.rb
+- lib/monster_queries/builder.rb
+- lib/monster_queries/engine.rb
+- lib/monster_queries/helpers.rb
+- lib/monster_queries/query.rb
+- lib/monster_queries/version.rb
+- lib/tasks/monster_queries_tasks.rake
+homepage: http://monsterboxpro.com
+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: []
+rubyforge_project:
+rubygems_version: 2.7.8
+signing_key:
+specification_version: 4
+summary: Queries
+test_files: []