hsql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b36d377513ad3f4e47233608a6c6a3d10abc5400
+  data.tar.gz: cfa80fcbd40a0f23e715d84274d6f60be9ae56b9
+SHA512:
+  metadata.gz: 0ceda7a4890b22ce3a751b249d4d6a13b2db52093086ab6b5b7cdefd045e77c99779676a39954ba14b14ce2e64556110e4a39a89b71bcbfd097ad5f5438c4e1c
+  data.tar.gz: 46ff5428b17d28372906f0d92e7f04846337165e36a5a447c6b2036a2ef87133f62024e9e80aa38758d4d498fe5e3dc5cd7accfccb78f6cfa4001b13546e8a3e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hsql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jack Danger Canty
+
+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,31 @@
+# HSQL
+
+".SQL ETL" is a library that parses `.sql` files with YAML front matter.
+This allows analysts and other non-developers to write and develop ETLs
+without having to write source code but still giving them the power of
+specifying variables to interpolate into the SQL and other metadata that
+the program executing the SQL can use.
+
+## How to use this
+
+Rather than specifying variables and metadata for a set of database
+queries in a .rb or other programming language source file the queries
+should be written to a .sql file directly.
+
+    # filename: daily_summary.sql
+    owner: jackdanger
+    schedule: hourly
+    data:
+      production:
+        output_table: summaries
+        update_condition:
+      development:
+        output_table: jackdanger_summaries
+        update_condition: WHERE 1 <> 1
+    ---
+    USE some_database;
+    INSERT INTO {{{output_table}}} SELECT * FROM interesting_information;
+    UPDATE summaries_performed SET complete = 1 {{{update_condition}}};
+
+The above is a SQL file and any text editor will allow analysts to use
+code completion and syntax highlighting for their queries.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hsql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hsql.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hsql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hsql"
+  spec.version       = Setl::VERSION
+  spec.authors       = ["Jack Danger Canty"]
+  spec.email         = ["gems@jackcanty.com"]
+
+  spec.summary       = %q{Store a hash of data with your SQL queries.}
+  spec.description   = %q{Write SQL queries in a .sql format and ship them with metadata about how they should be executed}
+  spec.homepage      = "https://github.com/JackDanger/hsql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mustache", '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "pry-byebug", '~> 0'
+end

data/lib/hsql.rb

@@ -0,0 +1,18 @@
+require_relative "hsql/version"
+require_relative "hsql/template"
+require_relative "hsql/file"
+require 'mustache'
+
+module HSQL
+  # This is used to indicate when a source file is malformed.
+  class FormatError < StandardError
+  end
+
+  # Given the contents of a SQL file with YAML front matter (see README for an
+  # example) this will return a HSQL::File object providing access to the parts
+  # of that file.
+  def self.parse(string, environment)
+    raise ArgumentError, "The environment argument is required" unless environment
+    File.new(string, environment).parse!
+  end
+end

data/lib/hsql/file.rb

@@ -0,0 +1,56 @@
+# HSQL::File parses the input file and provides reader methods to the hash of
+# YAML data from the front matter section and a list of the queries in the SQL
+# portion.
+module HSQL
+  class File < Struct.new(:string, :environment)
+    def yaml
+      @yaml ||= YAML.load(@front_matter)
+    end
+
+    def queries
+      # TODO: allow multi-line queries!
+      @queries ||= @rendered_sql.lines.map(&:chomp).reject(&:empty?)
+    end
+
+    def parse!
+      split!
+      interpolate_data!
+      self
+    end
+
+    private
+
+    def split!
+      @split ||= begin
+        @front_matter, divider, @sql = string.partition(/^---$/)
+        unless divider == '---'
+          raise FormatError, "The YAML front matter is required, otherwise this is just a SQL file"
+        end
+        true
+      end
+    end
+
+    def data
+      @data ||= begin
+        if yaml['data']
+          unless yaml['data'].key?(environment)
+            raise ArgumentError, "The environment #{environment.inspect} is not specified"
+          end
+          yaml['data'][environment]
+        end || {}
+      end
+    end
+
+    def interpolate_data!
+      template = Template.new(@sql)
+      template.variable_names.each do |name|
+        unless data.key?(name)
+          raise FormatError, "#{name.inspect} is not set in #{environment.inspect} environment"
+        end
+      end
+
+      # Insert the `data:` section of YAML for the given environment into our SQL queries.
+      @rendered_sql = template.render(data)
+    end
+  end
+end

data/lib/hsql/template.rb

@@ -0,0 +1,28 @@
+require 'mustache'
+module HSQL
+  class Template < Struct.new(:input)
+    def variable_names
+      extract_variable_names(ast).uniq
+    end
+
+    def render(hash)
+      Mustache.render(input, hash)
+    end
+
+    private
+
+    # See Mustache::Generator#compile! for reference code
+    def extract_variable_names(tree)
+      return unless tree.is_a?(Array)
+      if tree[1] == :fetch
+        tree.last.first
+      else
+        tree.map { |token| extract_variable_names(token) }.compact.flatten
+      end
+    end
+
+    def ast
+      ::Mustache::Parser.new.compile(input)
+    end
+  end
+end

data/lib/hsql/version.rb

@@ -0,0 +1,3 @@
+module Setl
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: hsql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Danger Canty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Write SQL queries in a .sql format and ship them with metadata about
+  how they should be executed
+email:
+- gems@jackcanty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hsql.gemspec
+- lib/hsql.rb
+- lib/hsql/file.rb
+- lib/hsql/template.rb
+- lib/hsql/version.rb
+homepage: https://github.com/JackDanger/hsql
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Store a hash of data with your SQL queries.
+test_files: []
+has_rdoc: