sql_capsule 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e4724c21b2c31b68991236b530a899fbb70152f
+  data.tar.gz: 485b598ea069ffb03c1d013a3cf80354a8dd1a27
+SHA512:
+  metadata.gz: c5226e6d66ef2cf79a1979581c6d60388921b90a246cd30b7aee6ac1940e6d86f1a270047f909a36518c780e06d2fa66dc12eceb207c9c4463ed6b1acbba8576
+  data.tar.gz: c742e47a417cb9d5c5b55474c57b9708f559d0f3ab667a005d77ff1e5fce0588d152eea3444382d361d90e3037068f8c0f0030582278ad268e339e84fe9fb046

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+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 sql_capsule.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,133 @@
+# SQLCapsule
+
+SQLCapsule is the culmination of many of my thoughts and concerns surrounding ORMs and how
+we use Ruby to interact with databases. The goal is to be a small and easy to understand
+tool to help you talk to your database without the baggage of a using a full fledged ORM.
+SQLCapsule is reminiscent of the repository pattern (though you may use it however you like)
+and works by registering and naming SQL queries for later use.
+
+SQLCapsule aims to provide helpful errors, and to assist you along the way to building
+an application specific PostgreSQL interaction layer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_capsule'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sql_capsule
+
+## Usage
+
+Initialize a wrapper using a PG connection object:
+```ruby
+user_database = SQLCapsule.wrap(pg_connection)
+```
+
+Once you have a wrapper you can register bits of SQL. The method
+signature is: `query_name, raw_sql, *arguments`
+
+```ruby
+query = "SELECT * FROM users_table WHERE id = $1;"
+user_database.register(:find_user, query, :id)
+```
+
+If you try and register a SQL statement using `$1` without defining an
+argument name it will raise an error.
+
+```ruby
+user_database.register :find_user, "SELECT * FROM users WHERE id = $1;"
+  # SQLCapsule::Query::ArgumentCountMismatchError: Argument count mismatch
+  # 0 arguments provided for
+  # SQL: SELECT * FROM users WHERE id = $1;
+  # Args:[]
+```
+
+Likewise, if you try and register an argument without defining
+its use within the SQL it will also raise an error.
+
+```ruby
+user_database.register :find_user, "SELECT * FROM users;", :id
+  # SQLCapsule::Query::ArgumentCountMismatchError: Argument count mismatch
+  # 1 arguments provided for
+  # SQL: SELECT * FROM users;
+  # Args:[:id]
+```
+
+Arguments are used in order, so if you register `:id, :name` then `$1` will
+correspond with `:id` and `$2` will correspond with `:name`. SQLCapsule does
+not attempt to verify your numbering. :-)
+
+It is also possible to register a query with a block to handle the resulting rows:
+
+```ruby
+query = "SELECT * FROM users_table WHERE id = $1;", :id
+user_database.register(:find_user, query, :id) { |row| row.merge('preprocessed' => true) }
+user_database.run(:find_user, id: 1) => [ { 'name' => 'John', 'age' => 20, 'id' => 3, 'preprocessed' => true} ]
+```
+
+Any registered query can be called like:
+```ruby
+user_database.run :find_user, id: 3  # => [ { 'name' => 'John', 'age' => 20, 'id' => 3 } ]
+```
+
+Or with a block:
+```ruby
+user_database.run(:find_user, id: 3) { |user| user.merge('loaded' => true) }
+  # => [ { 'name' => 'John', 'age' => 20, 'id' => 3, 'loaded' => true } ]
+```
+
+Run checks for required keywords when called and will throw an error if missing one:
+```ruby
+user_database.run :find_user
+  # => SQLCapsule::QueryGroup::MissingKeywordArgumentError: Missing query argument: id
+```
+
+The result of a query will return in the form of an array of hashes, where each item in
+the array corresponds to result row, and key/value pairs in the hash correspond with
+column/value pairs in a resulting row.
+
+```ruby
+user_database.register :find_adult_users, "SELECT * FROM users WHERE age >= 18;"
+user_database.run :find_adult_users  # => [ { 'name' => 'John', 'age' => 20 }, { 'name' =>  'Anne', 'age' =>  23 } ]
+```
+
+### Complex Queries
+
+One thing about SQL and relational databases is that returning tables with identical
+column names is a perfectly normal and sane thing to do. SQLCapsule enforces the use
+of `AS` to alias column names and will raise an error when duplicate column names result
+from a query (like a join)
+
+```ruby
+query = 'SELECT * FROM widgets LEFT JOIN orders on widgets.id=orders.widget_id;'
+widget_database.register :join_widgets, query
+widget_database.run :join_widgets
+  # SQLCapsule::Wrapper::DuplicateColumnNamesError: Error duplicate column names in resulting table: ["name", "price", "id", "widget_id", "amount", "id"]
+  # This usually happens when using a `JOIN` with a `SELECT *`
+  # You may need use `AS` to name your columns.
+  # QUERY: SELECT * FROM widgets LEFT JOIN orders on widgets.id=orders.widget_id;
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piisalie/sql_capsule. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,32 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+namespace :db do
+
+  desc "Create testing database."
+  task :create do
+    system("createdb --echo sql_capsule_test")
+  end
+
+  desc "Drop testing database."
+  task :drop do
+    system("dropdb --echo sql_capsule_test")
+  end
+
+  desc "Migrate testing database."
+  task :migrate do
+    require 'pg'
+    db = PG.connect(dbname: 'sql_capsule_test')
+    db.exec('CREATE TABLE widgets (name VARCHAR NOT NULL, price INTEGER NOT NULL, id INTEGER NOT NULL UNIQUE);')
+    db.exec('CREATE TABLE orders (widget_id INTEGER NOT NULL, amount INTEGER NOT NULL, id INTEGER NOT NULL UNIQUE);')
+  end
+
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sql_capsule"
+
+# 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"
+@db      = PG.connect(dbname: 'sql_capsule_test')
+@wrapper = SQLCapsule.wrap(@db)
+@wrapper.register(:all_widgets, "SELECT * FROM widgets;") { |widget| widget.merge!("inblock" => true)  }
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+bundle exec rake db:drop
+bundle exec rake db:create
+bundle exec rake db:migrate

data/lib/sql_capsule/query.rb

@@ -0,0 +1,44 @@
+module SQLCapsule
+  class Query
+    attr_reader :sql, :args, :pre_processor
+    private     :sql
+
+    def initialize(sql, *args, &pre_processor)
+      @sql  = sql
+      @args = args
+      @pre_processor = pre_processor || Proc.new { |row| row }
+      verify_arguments
+    end
+
+    def to_sql
+      sql.end_with?(";") ? sql : sql + ";"
+    end
+
+    def filter_args(given_args)
+      given_args.select { |key, value| args.include?(key) }.values
+    end
+
+    def add_post_processor(block)
+      block ||= Proc.new { |row| row }
+      Proc.new { |row| block.call(pre_processor.call(row)) }
+    end
+
+    private
+
+    def verify_arguments
+      raise ArgumentCountMismatchError.new(sql,args) unless args_count_matches_sql_args_count?
+    end
+
+    def args_count_matches_sql_args_count?
+      sql.scan(/\$\d+/).count == args.count
+    end
+
+    class ArgumentCountMismatchError < RuntimeError
+      def initialize(sql, args)
+        message = "Argument count mismatch\n#{args.count} arguments provided for\nSQL: #{sql}\nArgs:#{args}"
+        super(message)
+      end
+    end
+
+  end
+end

data/lib/sql_capsule/query_group.rb

@@ -0,0 +1,46 @@
+require_relative 'query'
+
+module SQLCapsule
+  class QueryGroup
+    attr_reader :queries, :wrapper, :query_object
+    private     :queries, :wrapper, :query_object
+
+    def initialize(wrapper, query_object = Query)
+      @wrapper      = wrapper
+      @queries      = { }
+      @query_object = query_object
+    end
+
+    def register(name, query, *args, &block)
+      queries[name] = query_object.new(query, *args, &block)
+    end
+
+    def registered_queries
+      queries.keys
+    end
+
+    def run name, args = { }, &handler
+      query = find_query name
+      check_args query.args, args.keys
+
+      block = query.add_post_processor handler
+      wrapper.run(query.to_sql, query.filter_args(args), &block)
+    end
+
+    private
+
+    def find_query name
+      queries.fetch(name) { fail MissingQueryError.new "Query #{name} not registered" }
+    end
+
+    def check_args required_args, args
+      required_args.each do |keyword|
+        fail MissingKeywordArgumentError.new "Missing query argument: #{keyword}" unless args.include? keyword
+      end
+    end
+
+    class MissingQueryError           < RuntimeError; end
+    class MissingKeywordArgumentError < RuntimeError; end
+
+  end
+end

data/lib/sql_capsule/version.rb

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

data/lib/sql_capsule/wrapper.rb

@@ -0,0 +1,39 @@
+require 'pg'
+
+module SQLCapsule
+  class Wrapper
+    attr_reader :db
+    private     :db
+
+    def initialize(db)
+      @db = db
+    end
+
+    def run(query, arguments = [ ])
+      result = db.exec(query, arguments)
+      raise DuplicateColumnNamesError.new(result.fields, query) if duplicate_result_columns?(result.fields)
+
+      if block_given?
+        result.map do |row|
+          yield row
+        end
+      else
+        result.to_a
+      end
+    end
+
+    private
+
+    def duplicate_result_columns?(fields)
+      fields.uniq.count != fields.count
+    end
+
+    class DuplicateColumnNamesError < RuntimeError
+      def initialize(fields, query)
+        message = "Error duplicate column names in resulting table: #{fields}\nThis usually happens when using a `JOIN` with a `SELECT *`\nYou may need use `AS` to name your columns.\nQUERY: #{query}"
+        super(message)
+      end
+    end
+
+  end
+end

data/lib/sql_capsule.rb

@@ -0,0 +1,9 @@
+require "sql_capsule/version"
+require "sql_capsule/wrapper"
+require "sql_capsule/query_group"
+
+module SQLCapsule
+  def self.wrap(connection)
+    QueryGroup.new(Wrapper.new(connection))
+  end
+end

data/sql_capsule.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_capsule/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sql_capsule"
+  spec.version       = SQLCapsule::VERSION
+  spec.authors       = ["Paul Dawson"]
+  spec.email         = ["paul@into.computer"]
+
+  spec.summary       = %q{ Less ORM, more SQL }
+  spec.description   = %q{ SQLCapsule is the culmination of many of my thoughts and concerns surrounding ORMs and how we use Ruby to interact with databases. The goal is to be a small and easy to understand tool to help you talk to your database without the baggage of a using a full fledged ORM. SQLCapsule is reminiscent of the repository pattern (though you may use it however you like) and works by registering and naming SQL queries for later use. SQLCapsule aims to provide helpful errors, and to assist you along the way to building an application specific PostgreSQL interaction layer. }
+
+  spec.homepage      = "https://github.com/piisalie/sql_capsule"
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "pg", "~> 0.18.1"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sql_capsule
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Dawson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-26 00:00:00.000000000 Z
+dependencies:
+- !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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: " SQLCapsule is the culmination of many of my thoughts and concerns surrounding
+  ORMs and how we use Ruby to interact with databases. The goal is to be a small and
+  easy to understand tool to help you talk to your database without the baggage of
+  a using a full fledged ORM. SQLCapsule is reminiscent of the repository pattern
+  (though you may use it however you like) and works by registering and naming SQL
+  queries for later use. SQLCapsule aims to provide helpful errors, and to assist
+  you along the way to building an application specific PostgreSQL interaction layer. "
+email:
+- paul@into.computer
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_capsule.rb
+- lib/sql_capsule/query.rb
+- lib/sql_capsule/query_group.rb
+- lib/sql_capsule/version.rb
+- lib/sql_capsule/wrapper.rb
+- sql_capsule.gemspec
+homepage: https://github.com/piisalie/sql_capsule
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.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: Less ORM, more SQL
+test_files: []