querylet 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eae3b4c9cb1beeea8edfbb41bab195ad133ac2c91d6393942f942d075860324
-  data.tar.gz: 6632e474232ac27c6e64cd3d991b65e5331e61e97116280b9b8a9b00c1702a5f
+  metadata.gz: 89d1a03b5028328b79f0d575c2aeadec57ebf47f1d743fe5722b4c4a4b165fc6
+  data.tar.gz: 5db0889a5a8fc5a21aca04bb27f406522a22de46f91ef1fd95af5f0137983156
 SHA512:
-  metadata.gz: c33031f332be7c159ce11f3fb4ec86cf8b606125ad3cf51cfd28c4aa7bb3600d2d5188b7bcb91664bc7b00d307cd258784b09fed852e5886cc8cd4e243ea22d6
-  data.tar.gz: 1d5b1e8f732f7dd43dd110c442528a5af5b6d9939593d57bb5a9f5724e2e9d8fab9083265a885f2e57977f6612724babdc3a451aa0c786b0c4f7ab0edca19c30
+  metadata.gz: 296e9452984b0099681d8567ac291e1c71e9ee62cb706d96668927c0e2cab8062ac54f0c1186eed56bdf2e0a93ee463602a75928525fcb1d02eefe3089fae665
+  data.tar.gz: 3b1f422e8cabd1ee7dfbb977df2e3b77ed4d28a6b5bb93f0007cf20aff608737276a8504ca40239671dcd8b66d4e4f8bacaf2a8db92a62d746c200a5e7d7f687

data/README.md

@@ -1,21 +1,118 @@
-## Querylet
+# Querylet
+
+Querylet is a templating language for SQL
+and is designed to make writing raw SQL much easier.
+
+```sql
+SELECT
+  questions.id,
+  questions.uuid,
+  questions.question_html as question,
+  questions.target_type as kind,
+  {{#object}}
+  SELECT
+    case_study_questions.menu,
+    case_study_questions.questions_pool_size,
+
+    CASE {{str sub_question_type}}
+    WHEN 'MultiChoiceQuestion' THEN
+      {{> object 'questions.multiple_choice' id='{{sub_question_id}}' }} as question
+    WHEN 'MultiSelectQuestion' THEN
+      {{> object 'questions.multiple_select' id='{{sub_question_id}}' }} as question
+    END,
+
+    {{#array}}
+      SELECT
+        que.id,
+        que.uuid,
+        que.target_type as kind,
+        choices.comment,
+        choices.flagged,
+        choices.choice_value as answered,
+        multiple_select_questions.answers_count
+      FROM ts_admin_que.questions que
+      LEFT JOIN public.choices ON choices.question_id = que.id AND choices.attempt_id = {{id}}
+      LEFT JOIN ts_admin_que.multiple_select_questions ON multiple_select_questions.id = que.target_id AND que.target_type = 'MultipleSelectQuestion'
+      WHERE
+        que.id = ANY(case_study_questions.question_ids)
+    {{/array}} as questions
+  {{/object}} as case_study
+FROM ts_admin_que.questions
+LEFT JOIN ts_admin_que.case_study_questions ON case_study_questions.question_id = questions.id
+WHERE
+  questions.id = {{id}}
+```
+
+## Variable Filters
+ 
+### Int (Integer)
+
+Cast variable to integer
+
+```
+{{int my_number}}
+```
+
+### Str (String)
+
+Cast variable to string
 
-#Variables
+```
+{{str my_string}}
+```
 
+### Float
+
+Cast variable to float
+
+```
+{{float my_number}}
+```
+
+### Arr (Array)
+
+Cast to array (not a postgres array)
+
+```
+{{arr my_array}}
+```
+
+### Wild (Wildcard)
+
+Wildcard front and back of string
+
+```
+{{wild my_string}}
+```
+
+### Variables
+
+```
 {{my_variable}}
+```
 
-#Partials
+### Partials
 
-{{>include 'link.to.path' param='{{testing}}'}}
+```
+{{> include 'link.to.path' name='andrew' }}
+{{> include 'link.to.path' name={{my_name}} }}
+{{> include 'link.to.path' name={{str my_name}} }}
+```
+
+### Partial blocks
 
-#Partial blocks
+```
 {{#array}}
 {{/array}}
+```
 
-# If Else
+### If Else
+
+```
 {{#if variable}}
 {{else}}
 {{/end}}
+```
 
 ## Parslet
 
@@ -56,12 +153,10 @@ parser.parse_with_debug(input)
 
 ## Parser
 
-Parslet parsers output deep nested hashes.
-
-To see all the define rules check out `parser_helper.rb`
+To see all the define rules check out `parser_spec.rb`
 
 ```
-rspec spec/parser_helper.rb
+bundle exec rspec spec/parser_spec.rb
 ```
 
 ## Transform

data/lib/querylet/context.rb

@@ -1,5 +1,10 @@
 module Querylet
-  module Context
+  class Context
+    def initialize(querylet, data)
+      @querylet = querylet
+      @data = data
+    end
+
     def get(value)
       @data.merge(locals)[value.to_sym]
     end
@@ -12,15 +17,21 @@ module Querylet
       hash.map { |k, v| add_item(k, v) }
     end
 
-    def with_temporary_context(args = {})
-      saved = args.keys.collect { |key| [key, get(key.to_s)] }.to_h
+    def get_partial name, dot_path, data
+      @querylet.get_partial name, dot_path, @data.merge(data)
+    end
 
-      add_items(args)
-      block_result = yield
-      locals.merge!(saved)
+    # This never appears to be used
+    # commented out unless I find a use for it.
+    #def with_temporary_context(args = {})
+    #  saved = args.keys.collect { |key| [key, get(key.to_s)] }.to_h
 
-      block_result
-    end
+    #  add_items(args)
+    #  block_result = yield
+    #  locals.merge!(saved)
+
+    #  block_result
+    #end
 
     private
 

data/lib/querylet/parser.rb

@@ -96,7 +96,7 @@ module Querylet
     rule(:variable) { docurly >> space? >> id.as(:variable) >> space? >> dccurly}
 
     # Can either be a variable or a string:
-    rule(:parameter)   { id.as(:variable) | string }
+    rule(:parameter) {  id.as(:variable) | string }
 
     # used in includes eg. hello='world'
     rule(:parameter_kv) {
@@ -104,7 +104,7 @@ module Querylet
       space? >>
       eq >>
       space? >>
-      string.as(:value) >>
+      (filter | variable | string).as(:value) >>
       space?
     }
 
@@ -147,7 +147,7 @@ module Querylet
     rule(:nocurly)     { match('[^{}]') }
     rule(:eof)         { any.absent? }
 
-    # String contained in Single Qoutes 'content'
+    # String contained in Single Quotes 'content'
     rule(:string)   { match("'") >> match("[^']").repeat(1).as(:string) >> match("'") }
   end
 end

data/lib/querylet/template.rb

@@ -1,4 +1,4 @@
-#require_relative 'context'
+require_relative 'context'
 
 module Querylet
   class Template
@@ -7,13 +7,19 @@ module Querylet
       @ast = ast
     end
 
+    # In Ruby, the call method is used to invoke a block, proc, or lambda, 
+    # which are all different types of callable objects in Ruby.
+    #
+    # This is how querylet will get called in a developers code.
+    #
+    # querylet = Querylet::Querylet.new path: 'path/to/sql'
+    # querylet.compile(template).call(data)
+    # @args is the initial values passed to the template
     def call(args = nil)
-      if args
-        @querylet.set_context(args)
-      end
+      ctx = Context.new(@querylet, args)
 
       # AST should return a Querylet::Tree and call its eval method
-      @ast.eval(@querylet)
+      @ast.eval(ctx)
     end
-  end
-end
+  end # Template
+end # Querylet

data/lib/querylet/tree.rb

@@ -36,10 +36,12 @@ module Querylet
 
     class Partial < TreeItem.new(:partial, :path, :parameters)
       def _eval(context)
+        data = {}
         [parameters].flatten.map(&:values).map do |vals|
-          context.add_item vals.first.to_s, vals.last._eval(context)
+          # we have to set it as sym so it overrides correctly
+          data[vals.first.to_sym] = vals.last._eval(context)
         end
-        content = context.get_partial(partial.to_s, path)
+        content = context.get_partial(partial.to_s, path, data)
         if partial == 'array'
         <<-HEREDOC.chomp
 (SELECT COALESCE(array_to_json(array_agg(row_to_json(array_row))),'[]'::json) FROM (
@@ -131,6 +133,8 @@ module Querylet
           else
             raise "expected input for: #{parameter.item} to be String, Integer or Array"
           end
+        else
+          raise "unexpected filter name: #{filter}"
         end
       end
     end

data/lib/querylet/version.rb

@@ -1,4 +1,4 @@
 module Querylet
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end
 

data/lib/querylet.rb

@@ -6,7 +6,6 @@ require_relative 'querylet/context'
 
 module Querylet
   class Querylet
-    include Context
     def initialize(path:)
       @sql_path = path
     end
@@ -19,17 +18,15 @@ module Querylet
       #puts deep_nested_hash
       abstract_syntax_tree = transform.apply deep_nested_hash
       #puts abstract_syntax_tree
-      Template.new self, abstract_syntax_tree
-    end
 
-    def set_context(ctx)
-      @data = ctx
+      # Querylet::Template
+      Template.new self, abstract_syntax_tree
     end
 
-    def get_partial name, dot_path
+    def get_partial name, dot_path, data={}
       path = @sql_path + '/' + dot_path.to_s.split('.').join('/') + '.sql'
       template = File.read(path).to_s.chomp
-      self.compile(template).call(@data)
+      self.compile(template).call(data)
     end
   end # class Querylet
 end # module Querylet

data/spec/parser_spec.rb

@@ -10,10 +10,9 @@ RSpec.describe Querylet::Parser do
     end
 
     it 'string' do 
-      (SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (
-
       expect(parser.parse_with_debug("(SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (")).to eq({items:[{content: "(SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM ("}]})
     end
+
     it 'variable' do
       expect(parser.parse('{{worf}}')).to eq({items:[{variable: 'worf'}]})
       expect(parser.parse('{{ worf}}')).to eq({items:[{variable: 'worf'}]})
@@ -52,8 +51,24 @@ RSpec.describe Querylet::Parser do
         partial: 'include',
         path: 'path.to.template',
         parameters: [
-          {key: 'hello', value: {string: 'world'}},
-          {key: 'star', value: {string: 'trek'}}
+          {key: 'hello', value: { string: 'world'}},
+          {key: 'star' , value: { string: 'trek'}}
+        ]
+      }]})
+
+      expect(parser.parse("{{> include 'path.to.template' hello={{world}} }}")).to eq({items:[{
+        partial: 'include',
+        path: 'path.to.template',
+        parameters: [
+          {key: 'hello', value: { variable: 'world'}}
+        ]
+      }]})
+
+      expect(parser.parse("{{> include 'path.to.template' hello={{int world}} }}")).to eq({items:[{
+        partial: 'include',
+        path: 'path.to.template',
+        parameters: [
+          {key: 'hello', value: {filter: 'int', parameter: {variable: 'world'} }}
         ]
       }]})
     end

data/spec/querylet_spec.rb

@@ -23,41 +23,40 @@ describe Querylet::Querylet do
 
     context 'helpers' do
       it 'include' do
-query = <<-SQL.chomp
-(SELECT
-  users.email
-FROM users
-WHERE
-  users.id = 1) as email
-SQL
+        query = "(SELECT users.email FROM users WHERE users.id = 1) as email"
         expect(evaluate("({{> include 'examples.include' }}) as email")).to eq(query)
       end
 
       it 'include with variables' do
-query = <<-SQL.chomp
-(SELECT
-  users.email
-FROM users
-WHERE
-  users.id = 100) as email
-SQL
+        query = "(SELECT users.email FROM users WHERE users.id = 100) as email"
         template = "({{> include 'examples.include_with_vars' }}) as email"
         expect(evaluate(template, {id: 100})).to eq(query)
       end
 
       it 'include with parameters' do
-query = <<-SQL.chomp
-(SELECT
-  users.email,
-  'andrew' as name
-FROM users
-WHERE
-  users.id = 200) as email
-SQL
+        query = "(SELECT users.email, 'andrew' as name FROM users WHERE users.id = 200) as email"
         template = "({{> include 'examples.include_with_params' id='200' name='andrew' }}) as email"
         expect(evaluate(template, {id: 100})).to eq(query)
       end
 
+      it 'include with parameters variable' do
+        query = "(SELECT users.email FROM users WHERE users.id = 300) as email"
+        template = "({{> include 'examples.include_with_params_vars' id={{user_id}} name='andrew' }}) as email"
+        expect(evaluate(template, {user_id: 300})).to eq(query)
+      end
+
+      it 'include with parameters filter' do
+        query = "(SELECT users.email, 'Andrew' as name FROM users WHERE users.id = 100) as email"
+        template = "({{> include 'examples.include_with_params_filter' name={{str my_name}} }}) as email"
+        expect(evaluate(template, {my_name: "Andrew", id: 100})).to eq(query)
+      end
+
+      it 'variable overrides' do
+        query = "(SELECT questions.id, (SELECT que.id FROM questions que WHERE que.id = 555) as sub FROM questions WHERE questions.id = 100"
+        template = "(SELECT questions.id, ({{> include 'examples.vars_overrides_include' xid={{sub_id}} }}) as sub FROM questions WHERE questions.id = {{xid}}"
+        expect(evaluate(template, {sub_id: 555, xid: 100})).to eq(query)
+      end
+
       it 'object' do
 query = <<-SQL.chomp
 (SELECT COALESCE(row_to_json(object_row),'{}'::json) FROM (
@@ -152,5 +151,5 @@ SQL
       end
 
     end # context 'helpers'
-  end # context 'evaluating'
+ end # context 'evaluating'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querylet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ExamPro
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-05 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -74,7 +74,7 @@ homepage: http://exampro.co
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,11 +89,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Querylet
 test_files:
-- spec/spec_helper.rb
 - spec/parser_spec.rb
 - spec/querylet_spec.rb
+- spec/spec_helper.rb