metasql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d640f39caabdf0c37f23db612fe303cd6c4f18b4350c925cc16e887d0b7129b
+  data.tar.gz: 3dcd34230c397ea8ca9cd5c50815e9919a93a10be4ec1f5fcf12d255f0ef9403
+SHA512:
+  metadata.gz: 3d9d0dac4349bcda86fc4d323f31ce4162b5efd4758a48e2379e419cfe0fc994fc19f7efd365ac100285835229a4ac64d9493ba86ea4d20fa54e2b8d03867b68
+  data.tar.gz: 6d2873e7e28b9e602250db89b58b3f43d9ce44575b18d6e58c1ed3599768fee6cab30ca58907489cca4b78d17d5b66e280dad92b54f6b7ffb23b609cfa531ac0

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: rubocop
+        run: bundle exec rubocop
+      - name: RSpec
+        run: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle:
+    - key
+    - table
+  EnforcedColonStyle:
+    - key
+    - table
+
+Layout/LineLength:
+  Max: 100
+  IgnoredPatterns:
+    - !ruby/regexp /\A +(it|describe|context|shared_examples|include_examples|it_behaves_like) ["']/
+    - !ruby/regexp /\A +(expect)[()]/
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 20

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metasql.gemspec
+gemspec
+
+gem 'pry'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.12'

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    metasql (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  metasql!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.12)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nobuo Takizawa
+
+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,74 @@
+# Metasql
+
+![Gem](https://img.shields.io/gem/v/metasql?style=flat-square)
+![GitHub](https://img.shields.io/github/license/nobuyo/metasql?style=flat-square)
+
+Metasql is Metabase flavored query preprocessor.
+Provides parameter substitution, optional clause deletion, etc.
+
+# Getting Started
+
+```ruby
+require 'metasql'
+
+sql = <<~SQL
+  SELECT
+      *
+  FROM
+      items
+  WHERE
+      foo = TRUE
+      AND bar = {{ bar }}
+      [[
+          AND
+          CASE WHEN {{ baz }} < 10
+          THEN baz = {{ baz }}
+          ELSE TRUE
+      ]]
+SQL
+
+query = Metasql::Parser.parse(sql)
+
+parameters = {
+  bar: 'hi',
+  baz: 10
+}
+
+# with parameter
+print query.with(parameters).deparse
+# =>  SELECT
+#         *
+#     FROM
+#         items
+#     WHERE
+#         foo = TRUE
+#         AND bar = 'hi'
+#
+#             AND
+#             CASE WHEN 10 < 10
+#             THEN baz = 10
+#             ELSE TRUE
+
+# without parameter
+print query.deparse
+# => Metasql::ParameterMissing: Required parameters missing: bar
+
+# partially supply parameter
+print query.with({ bar: 'hi' }).deparse
+# =>  SELECT
+#         *
+#     FROM
+#         items
+#     WHERE
+#         foo = TRUE
+#         AND bar = 'hi'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nobuyo/metasql.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'metasql'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/metasql.rb

@@ -0,0 +1,6 @@
+require 'metasql/version'
+
+require 'metasql/parameter'
+require 'metasql/query'
+require 'metasql/parser'
+require 'metasql/errors'

data/lib/metasql/errors.rb

@@ -0,0 +1,27 @@
+module Metasql
+  class BaseError < StandardError; end
+
+  # InvalidQueryError is caused by Metabase query syntax error.
+  class InvalidQueryError < BaseError
+    attr_reader :message
+
+    def initialize(error_message)
+      @message = error_message
+      super
+    end
+  end
+
+  # ParameterMissing causes when required param is not supplied.
+  class ParameterMissing < BaseError
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+      super
+    end
+
+    def message
+      "Required parameters missing: #{key}"
+    end
+  end
+end

data/lib/metasql/parameter.rb

@@ -0,0 +1,19 @@
+module Metasql
+  # Param represents required parameter in Metabase query.
+  class Param
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name.strip.to_sym
+    end
+  end
+
+  # Optional represents optional clause in Metabase query.
+  class Optional
+    attr_accessor :query
+
+    def initialize(query)
+      @query = query
+    end
+  end
+end

data/lib/metasql/parser.rb

@@ -0,0 +1,110 @@
+module Metasql
+  # Parser for Metabase flavored query.
+  class Parser
+    TOKENS = [
+      { token: :optional_begin, pattern: '[[' },
+      { token: :optional_end,   pattern: ']]' },
+      { token: :param_begin,    pattern: /(.*?)({{(?!{))(.*)/m },
+      { token: :param_end,      pattern: '}}' }
+    ].map(&:freeze).freeze
+
+    # Generate new Metasql::Query from supplied string.
+    def self.parse(query)
+      parser = new(query: query)
+      tokenized = parser.tokenize
+      parsed = parser.parse_tokens(tokens: tokenized)
+
+      Query.new(parsed: parsed)
+    end
+
+    attr_reader :query
+
+    def initialize(query:)
+      @query = query
+    end
+
+    def tokenize
+      TOKENS.inject([query]) do |strs, token_definition|
+        strs.map do |s|
+          next [s] unless s.is_a?(String)
+
+          acc = []
+          target = s
+          loop do
+            break acc if target.nil?
+
+            result = split_on_token(target: target, token: token_definition)
+            break acc << target unless result.compact.size == 3
+
+            acc.concat(result[0..1])
+            target = result[2]
+          end
+        end.flatten
+      end
+    end
+
+    def parse_tokens(tokens:, depth: 0)
+      acc = []
+      remains = tokens
+
+      loop do
+        token, *remains = remains
+
+        if token.nil?
+          if depth.positive?
+            raise Metasql::InvalidQueryError,
+                  "Invalid query: found '[[' or '{{' with no matching ']]' or '}}'"
+          end
+
+          break acc
+        end
+
+        if %i[optional_begin param_begin].include?(token)
+          parsed, remains = parse_tokens(tokens: remains, depth: depth + 1)
+          acc << send(token.to_s.split('_').first, parsed)
+
+          next [acc, remains]
+        end
+
+        if %i[optional_end param_end].include?(token)
+          acc << { optional_end: ']]', param_end: '}}' }[token] unless depth.positive?
+
+          break [acc, remains]
+        end
+
+        acc << token
+      end
+    end
+
+    private
+
+    def param(args)
+      name, *other = args
+      if other.size > 1 || !name.is_a?(String)
+        raise Metasql::InvalidQueryError, "Invalid '{{...}}' clause: expected a param name"
+      end
+
+      Param.new(name)
+    end
+
+    def optional(parsed)
+      if parsed.none? { |t| t.is_a?(Param) }
+        raise Metasql::InvalidQueryError,
+              "'[[...]]' clauses must contain at least one '{{...}}' clause."
+      end
+
+      Optional.new(parsed)
+    end
+
+    def split_on_token(target:, token:)
+      case token[:pattern]
+      when String
+        before, after = target.split(token[:pattern], 2)
+      when Regexp
+        before, _, after = token[:pattern].match(target)&.captures
+      end
+
+      [before, token[:token], after]
+    end
+  end
+end

data/lib/metasql/query.rb

@@ -0,0 +1,60 @@
+module Metasql
+  # Query ...
+  class Query
+    attr_accessor :parsed, :mapping
+
+    def initialize(parsed:, mapping: {})
+      @parsed = parsed
+      @mapping = mapping.transform_keys(&:to_sym)
+    end
+
+    def with(mapping)
+      dup.tap { |q| q.mapping = mapping }
+    end
+
+    # Rebuild query from parsed tokens.
+    # For supplying parameter value, call `with()` before this method.
+    def deparse
+      parsed.map do |token|
+        case token
+        when Metasql::Optional
+          substitute_optional(query_array: token.query)
+        when Metasql::Param
+          substitute_param(param: token)
+        else
+          token
+        end
+      end.join
+    end
+
+    private
+
+    def substitute_optional(query_array:)
+      if query_array.select { |t| t.is_a?(Metasql::Param) }.map(&:name).none? { |n| mapping[n] }
+        return ''
+      end
+
+      query_array.map do |m|
+        if m.is_a?(Metasql::Param)
+          quote_string(mapping[m.name])
+        else
+          m
+        end
+      end.join
+    end
+
+    def substitute_param(param:)
+      raise Metasql::ParameterMissing, param.name unless mapping[param.name]
+
+      quote_string(mapping[param.name])
+    end
+
+    def quote_string(value)
+      if value.is_a?(Numeric)
+        value
+      else
+        "'#{value}'"
+      end
+    end
+  end
+end

data/lib/metasql/version.rb

@@ -0,0 +1,3 @@
+module Metasql
+  VERSION = '0.1.0'.freeze
+end

data/metasql.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/metasql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metasql'
+  spec.version       = Metasql::VERSION
+  spec.authors       = ['Nobuo Takizawa']
+  spec.email         = ['longzechansheng@gmail.com']
+
+  spec.summary       = 'Resolve parameters of Metabase flavored query.'
+  spec.homepage      = 'https://github.com/nobuyo/metasql'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nobuyo/metasql'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: metasql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobuo Takizawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- longzechansheng@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/metasql.rb
+- lib/metasql/errors.rb
+- lib/metasql/parameter.rb
+- lib/metasql/parser.rb
+- lib/metasql/query.rb
+- lib/metasql/version.rb
+- metasql.gemspec
+homepage: https://github.com/nobuyo/metasql
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nobuyo/metasql
+  source_code_uri: https://github.com/nobuyo/metasql
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Resolve parameters of Metabase flavored query.
+test_files: []