yaasql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbeb6099694ca9dcf3eee459946df642f5d77759
+  data.tar.gz: c1be07baf1f630e5081f71f49832062cfeca9795
+SHA512:
+  metadata.gz: 2d3c70104907a11301cb6d98e943a6003b01be0533dec70b0b511d08b8941f0f20261d73be1ff1eef7ac2bb97f5209da088bdf8aa7fda79c0a85ac948e4d7cc7
+  data.tar.gz: efeebac87fc68aa367909406464dc91ad5fa8a16c237a98720a69c91b05ea13999acbddc5311e4ce7c63cbeb5b09f842467a9331e9cfbbaf0aaea48f4bb74d44

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Horace Williams
+
+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,115 @@
+# Yaasql
+
+Basic SQL-templating library inspired by [https://github.com/krisajenkins/yesql](https://github.com/krisajenkins/yesql).
+
+You can read more about the rationale for a library like this in [Yesql's Readme](https://github.com/krisajenkins/yesql#rationale)
+
+## Usage
+
+### Installing
+
+```ruby
+gem 'yaasql'
+```
+
+### Defining Queries
+
+Create a `.sql` file to define your queries.
+
+Queries **must** be identified with a comment line each query a name. This name will become the name of the Ruby method yaasql eventually creates for your query.
+
+You may have multiple queries per file.
+
+```sql
+-- name: count_examples
+SELECT COUNT(*) FROM examples;
+```
+
+### Loading queries
+
+```ruby
+require 'yaasql/db'
+require 'pg'
+
+class MyDB
+  DB_CONN = PG.connect(DB_URL)
+  extend Yaasql::DB
+  define_queries("./queries.sql", DB_CONN)
+end
+
+MyDB.new.count_examples
+# => [{"count" => "3"}]
+```
+
+### Parameterizing Queries
+
+Words with a leading `:` in query files will be interpreted as arguments to the query.
+
+```sql
+-- name: get_example_by_id
+SELECT * FROM examples where id = :id limit 1;
+
+-- name: get_examples_by_id
+SELECT * FROM examples where id =ANY(:ids);
+```
+
+Arguments can then be provided as a symbol-keyed hash when querying the function:
+
+```ruby
+db = MyDB.new
+
+db.get_example_by_id({id: 1})
+# => [{"id" => "1", "name" => "example 1"}]
+
+db.get_examples_by_id({ids: [1,2,3]})
+# => [{"id" => "1", "name" => "example 1"}, {"id" => "2", "name" => "example 2"}]
+```
+
+## Development
+
+Requires a local postgres server for testing.
+
+```bash
+bundle install
+rake setup # creates the test postgres DB
+rake # runs tests
+```
+
+### Releasing
+
+* Builds the `.gem` package
+* Creates and pushes a git tag for the current version
+* Pushes the `.gem` to [rubygems.org](https://rubygems.org)
+
+```
+bundle exec rake release
+```
+
+### Building a `.gem` package
+
+```
+bundle exec rake build
+```
+
+### Installing Dev Version Locally
+
+```
+bundle exec rake install
+```
+
+#### Feature Wishlist
+
+* [X] Reading multiple queries from single string (blank-line separated?)
+* [X] Module for including into a namespace
+* [X] Metaprogramming for defining query methods
+* [X] Define queries from a file
+* [X] Support array queries with `=ANY()`
+* [ ]`where IN (...)` queries
+* [ ] Option for stdout / stdin redirection (to support `COPY FROM` / `COPY TO` queries)
+* [ ] Option for streaming queries to process results row-by-row (e.g. for large datasets)
+* [ ] Support positional `?` arguments
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+TEST_DB = 'yaasql_test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc "Setup the test DB"
+task :setup do
+  `dropdb --if-exists #{TEST_DB}`
+  `createdb #{TEST_DB}`
+  `psql -d #{TEST_DB} -f ./test/schema.sql`
+end
+
+task :default => :test

data/lib/yaasql/db.rb

@@ -0,0 +1,14 @@
+require "./lib/yaasql/reader"
+
+module Yaasql
+  module DB
+    def define_queries(file_path, db_conn)
+      queries = Reader.new.from_file(file_path)
+      queries.each do |q|
+        define_method(q.name) do |arguments = {}|
+          q.execute(db_conn, arguments)
+        end
+      end
+    end
+  end
+end

data/lib/yaasql/query.rb

@@ -0,0 +1,34 @@
+require "./lib/yaasql/reader"
+
+module Yaasql
+  class Query
+    attr_reader :name, :body, :arguments
+
+    def self.from_string(query)
+      new(Reader.new.components(query))
+    end
+
+    def initialize(components)
+      [:body, :name, :arguments].each do |param|
+        raise ArgumentError.new("Query missing component #{param}") unless components[param]
+      end
+      @body = components[:body]
+      @name = components[:name]
+      @arguments = components[:arguments]
+    end
+
+    def prepare(argument)
+      case argument
+      when Array
+        "{#{argument.join(",")}}"
+      else
+        argument
+      end
+    end
+
+    def execute(connection, args = {})
+      params = self.arguments.map { |a| prepare(args.fetch(a)) }
+      connection.exec_params(body, params).to_a
+    end
+  end
+end

data/lib/yaasql/reader.rb

@@ -0,0 +1,41 @@
+module Yaasql
+  class Reader
+    HEADER_PATTERN = /^-- name: (.*)\n/
+    def name(query)
+      match = query.match(HEADER_PATTERN)
+      if match
+        match[1].to_sym
+      else
+        raise ArgumentError.new("Must provide a header comment with query name")
+      end
+    end
+
+    def raw_body(query)
+      query.split("\n").map(&:strip).reject do |line|
+        line.start_with?('--')
+      end.join('\n')
+    end
+
+    def with_sql_args(body, arguments)
+      arguments.each.with_index.reduce(body) do |body, (arg, index)|
+        body.gsub(":#{arg}", "$#{index+1}")
+      end
+    end
+
+    def arguments(body)
+      body.scan(/:(\w+);?/).flatten.map(&:to_sym)
+    end
+
+    def components(query)
+      name = name(query)
+      body = raw_body(query)
+      arguments = arguments(body)
+      {name: name, body: with_sql_args(body, arguments), arguments: arguments}
+    end
+
+    def from_file(path)
+      query_strings = File.read(path).split("\n\n")
+      query_strings.map { |q| Query.new(components(q)) }
+    end
+  end
+end

data/lib/yaasql/version.rb

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

data/lib/yaasql.rb

@@ -0,0 +1,5 @@
+require "yaasql/version"
+
+module Yaasql
+  # Your code goes here...
+end

data/yaassql.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaasql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaasql"
+  spec.version       = Yaasql::VERSION
+  spec.authors       = ["Horace Williams"]
+  spec.email         = ["horace@worace.works"]
+
+  spec.summary       = "Simple SQL query-templating for ruby, a la https://github.com/krisajenkins/yesql."
+  spec.description   = "Write db queries directly in SQL - no ORM or query-builder required. Include some conveniences around naming queries and providing arguments."
+  spec.homepage      = "https://github.com/worace/yaasql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pg", "~> 0.18"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: yaasql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Horace Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Write db queries directly in SQL - no ORM or query-builder required.
+  Include some conveniences around naming queries and providing arguments.
+email:
+- horace@worace.works
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yaasql.rb
+- lib/yaasql/db.rb
+- lib/yaasql/query.rb
+- lib/yaasql/reader.rb
+- lib/yaasql/version.rb
+- yaassql.gemspec
+homepage: https://github.com/worace/yaasql
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple SQL query-templating for ruby, a la https://github.com/krisajenkins/yesql.
+test_files: []