querylet-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66c6879ef73a6a30386db584b9237cfbcc1fe3eb6c75b0807ab91a43f5272714
+  data.tar.gz: c2bf111d8e123d42557a69f422dc97c90950c55393df92235c6dc971e18914c1
+SHA512:
+  metadata.gz: 817d3712b2f5b175a974389ece5dadec2e84b286288cf91d9ff5e06100189c5d39b925a208a203463a69f5de5854b991a25ae47bb8982e402dcea3a04a80173d
+  data.tar.gz: 52499b2461bf2090b7b9e03c6ad98101d6806fb6e1526bd64a884deca3043eb3413fbb22a29eafa548d71080acb61705b80ee1727c7745c5c953dd0b8bcda263

data/Readme.md

@@ -0,0 +1,101 @@
+# Querylet Rails
+
+## What is Querylet?
+
+[Querylet](https://github.com/teacherseat/querylet) is a query template
+langauge for Postgres to ease working with complex queries eg.
+
+Similar to handlebars but a much simpler langague and specfically
+designed for postgre queries.
+
+```
+{{#if count}}
+{{> include 'admin.shared.paginate_select'}}
+{{/else}}
+{{> include 'admin.users.select'}}
+{{/if}}
+FROM users
+WHERE true
+AND 'customer' != ANY(users.role)
+{{#if search}}
+  AND (
+    (coalesce(users.first_name, '') || ' ' || coalesce(users.last_name, '') ILIKE {{wild search}})
+    OR users.email ILIKE {{wild search}}
+  )
+{{/if}}
+{{#unless count}}
+{{#if sort}}
+ORDER BY {{sort}}
+{{/else}}
+ORDER BY users.id ASC
+{{/if}}
+{{> include 'admin.shared.paginate_offset'}}
+{{/unless}}
+```
+
+## What is Querylet Rails?
+
+Querylet Rails helps configure querylet for use in a Rails application.
+
+It contains two files:
+
+- querylet_rails/controller/queryable.rb (QueryletRails::Controller::Queryable)
+- querylet_rails/model/queryable.rb      (QueryletRails::Model::Queryable)
+
+
+## QueryletRails::Controller::Queryable
+
+This module is a Rails Controller Concerns to include your ApplicationController
+
+It defines the following controller methods:
+
+- set_pagination_headers
+- render_paginated
+- render_paginated_json
+- index_params
+
+## QueryletRails::Model::Queryable
+
+This module is a Rails Model Concerns to include your ApplicationRecord
+
+It defines the following model methods:
+
+- select_value and self.select_value
+- select_values and self.select_values
+- select_object and self.select_object
+- select_array and self.select_array
+- select_all and self.select_all
+- select_paginate and self.select_paginate
+- self.query_root
+- self.query
+- self.query_compile_template
+- self.query_wrap_object
+- self.query_wrap_array
+
+## How to Install
+
+Create a queries directory eg.
+
+Create a directory to contain your queries
+
+```
+mkdir app/queries
+```
+
+Include `QueryletRails::Controller::Queryable` in your ApplicationController
+
+```rb
+require 'querylet_rails/controller/queryable'
+class ApplicationController < ActionController::Base
+  include QueryletRails::Controller::Queryable
+end
+```
+
+Include `QueryletRails::Model::Queryablek` in your ApplicationRecord
+
+```rb
+require 'querylet_rails/model/queryable'
+class ApplicationRecord < ActiveRecord::Base
+  include QueryletRails::Model::Queryable
+end
+```

data/lib/querylet_rails/controller/queryable.rb

@@ -0,0 +1,61 @@
+module QueryletRails
+  module Controller
+    module Queryable
+      extend ActiveSupport::Concern
+
+      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
+
+        # Use the same query but to count all the records
+        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 # Queryable
+  end # Controller
+end # QueryletRails

data/lib/querylet_rails/model/queryable.rb

@@ -0,0 +1,119 @@
+require 'querylet'
+
+module QueryletRails
+  module Model
+    module Queryable
+      extend ActiveSupport::Concern
+      # override this function
+
+      def select_value relative_path, data={}
+        self.class.select_value relative_path, data
+      end
+
+      def select_values relative_path, data={}
+        self.class.select_values relative_path, data
+      end
+
+      def select_object relative_path, data={}
+        self.class.select_object relative_path, data
+      end
+
+      def select_array relative_path, data={}
+        self.class.select_array relative_path, data
+      end
+
+      def select_all relative_path, data={}
+        self.class.select_all relative_path, data
+      end
+
+      def select_paginate query, attrs, count
+        self.class.select_paginate query, attrs, count
+      end
+
+      module ClassMethods
+        def query_root
+          Rails.root
+        end
+
+        def query relative_path, data={}
+          file_path = self.query_root.join('app','queries',relative_path + '.sql')
+          template  = File.read file_path
+          query_compile_template template, data
+        end
+
+        def query_compile_template template, data={}
+          querylet = Querylet::Querylet.new path: self.query_root.join('app','queries').to_s
+          begin
+          querylet.compile(template).call(data)
+          rescue => e
+            puts ""
+            puts "===== Querylet Compile Error Occured ====="
+            template_annotated = ''
+            template.split("\n").each_with_index do |line,i|
+              template_annotated << "#{(i+1).to_s.rjust(3, " ")} | #{line}\n"
+            end
+            puts template_annotated
+            raise e
+          end
+        end
+
+        def select_value relative_path, data={}
+          sql = self.query relative_path, data
+          self.connection.select_value sql
+        end
+
+        def select_values relative_path, data={}
+          sql = self.query relative_path, data
+          self.connection.select_values sql
+        end
+
+        def select_array relative_path, data={}
+          template = self.query relative_path, data
+          sql = query_wrap_array template
+          self.connection.select_value sql
+        end
+
+        def select_object relative_path, data={}
+          template = self.query relative_path, data
+          sql = query_wrap_object template
+          self.connection.select_value sql
+        end
+
+        def select_all relative_path, data={}
+          sql = self.query relative_path, data
+          self.connection.select_all sql
+        end
+
+        def query_wrap_object template
+          <<-HEREDOC.chomp
+    (SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (
+    #{template.to_s.chomp}
+    ) object_row)
+          HEREDOC
+        end
+
+        def query_wrap_array template
+          <<-HEREDOC.chomp
+    (SELECT COALESCE(array_to_json(array_agg(row_to_json(array_row))),'[]'::json) FROM (
+    #{template.to_s.chomp}
+    ) array_row)
+          HEREDOC
+        end
+
+        def select_paginate relative_path, data, count
+          file_path = self.query_root.join('app','queries',relative_path + '.sql')
+          template  = File.read file_path
+          if count
+            sql = self.query_wrap_object template
+            sql = self.query_compile_template sql, data
+            self.connection.select_value sql
+          else
+            sql = self.query_wrap_array template
+            sql = self.query_compile_template sql, data
+            self.connection.select_value sql
+          end
+        end
+      end
+    end # Queryable
+  end # Model
+end # QueryletRails

data/lib/querylet_rails/version.rb

@@ -0,0 +1,3 @@
+module QueryletRails
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: querylet-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TeacherSeat
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: querylet
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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'
+description: Querylet Rails
+email:
+- andrew@teacherseat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- lib/querylet_rails/controller/queryable.rb
+- lib/querylet_rails/model/queryable.rb
+- lib/querylet_rails/version.rb
+homepage: https://teacherseat.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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Querylet Rails
+test_files: []