ensql 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689e8e2af4e7e8c941ed6f14937288a3e080f822b71ee22938898ac0a15f5277
-  data.tar.gz: 9693bc5e2476794d9f60feb70e80c821596ec18a4e71993d45aee65a26a152f1
+  metadata.gz: a9e2413596055c82bef5870277ed617889235a66bc6854c762886f14783580c7
+  data.tar.gz: 2993ee9976c316a975fd51dc18b53f187298f7e6e2a4627b0b59dc9bd233ec54
 SHA512:
-  metadata.gz: 10c90d7568c1c6ed34b9cb04e4a2e4a9af0ed6bb788ea6ec88f206b807468091e9d541f6dfc79ae7eb3d5e90b92e33a12718aae1c4d7e6977352331a499fbee1
-  data.tar.gz: 6b945c42734e68a599b2d32d825fa6c9d8b61a7eb1175086afae237c21fb58d30d4753eb916a69716a2c0c3a43dd51da34d655fb6b145352814d5256aa137d9d
+  metadata.gz: 47ee3648dc665dacc57263befd5c46466f36688138120d7c7b82b5a3464daf3c262e28bcc2eb9dd7f58f6cdea13838a352fe93d9b58f63a9543eca2aadcab40d
+  data.tar.gz: 51afecfd75ac23a5820538cd6c1914d48aeba21fea5e2b8f07a2bb193f4474329b9a6723c43addb5bcfc24642d3ca96c6efd7883ce1762ecc2ee57598f495461

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 
-## [0.6.4] - unreleased
+## [0.6.5] - 2021-03-24
+
+- Raises `Ensql::Error` with a more helpful message when `load_sql` can't find a file.
+
+## [0.6.4] - 2021-03-12
 
 - Exposes `PostgresAdapter#query_type_map` to extend PG type mapping.
 - Defers building type maps for PostgreSQL connections, to avoid bugs with ActiveRecord.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ensql (0.6.4)
+    ensql (0.6.5)
       connection_pool (>= 0.9.3, < 3)
 
 GEM

data/README.md

@@ -6,7 +6,7 @@
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 Ensql provides a light-weight wrapper over your existing database connections, letting you write plain SQL for your
-application safely and simply. Ditch your ORM and embrace the power and ease of writing SQL again.
+application safely and simply. Escape your ORM and embrace the power and ease of writing SQL again.
 
 * **Write exactly the SQL you want.** Don't limit your queries to what's in the Rails docs. Composable scopes and
   dynamic includes can cripple performance for non-trivial queries. Break through the ORM abstraction and unlock the
@@ -30,14 +30,12 @@ application safely and simply. Ditch your ORM and embrace the power and ease of
   ActiveRecord or Sequel so you don't need to manage a separate connection to the database.
 
 ```ruby
-# Run adhoc statements
-Ensql.run("SET TIME ZONE 'UTC'")
+# Safely interpolate parameters into adhoc statements with correct quoting and escaping.
+Ensql.run("INSERT INTO users (email) VALUES (%{email})", email: params[:email])
+Ensql.sql("DELETE FROM logs WHERE timestamp < %{expiry}", expiry: 1.month.ago).count # => 100
 
-# Run adhoc D/U/I statements and get the affected row count
-Ensql.sql('DELETE FROM logs WHERE timestamp < %{expiry}', expiry: 1.month.ago).count # => 100
-
-# Organise your SQL and fetch results as convenient Ruby primitives
-Ensql.sql_path = 'app/sql'
+# Organise your SQL and fetch results as convenient Ruby primitives.
+Ensql.sql_path = 'app/sql' # Defaults to './sql'. This can be set in an initializer or similar.
 Ensql.load_sql('customers/revenue_report', params).rows # => [{ "customer_id" => 100, "revenue" => 1000}, … ]
 
 # Easily retrive results in the simplest shape
@@ -54,7 +52,7 @@ result = { data: current_results.rows, total: total.first_field }
 Links:
 
 * [Source Code](https://github.com/danielfone/ensql)
-* [API Documentation](https://rubydoc.info/gems/ensql/Ensql/SQL)
+* [API Documentation](https://rubydoc.info/gems/ensql)
 * [Ruby Gem](https://rubygems.org/gems/ensql)
 
 ## Installation
@@ -123,15 +121,15 @@ app/sql
 ### Interpolation
 
 All interpolation is marked by `%{}` placeholders in the SQL. This is the only place that user-supplied input should be
-allowed. Only various forms of literal interpolation are supported - identifier interpolation is not supported at this
-stage.
+allowed. Only literal interpolation is supported - identifier interpolation is not supported at this stage.
+
+There are 3 types of safe (correctly quoted/escaped) interpolation:
 
-There are 4 types of interpolation:
+  1. `%{param}` interpolates a Ruby object as a single SQL literal.
+  2. `%{(param)}` expands a Ruby Array into a list of SQL literals.
+  3. `%{param( nested sql )}` interpolates an Array of Hashes into the nested sql with each hash in an array.
 
-  1. `%{param}` interpolates a Ruby object as a SQL literal.
-  2. `%{(param)}` expands an array into a list of SQL literals.
-  3. `%{param( nested sql )}` interpolates the nested sql with each hash in an array.
-  4. `%{!sql_param}` only interpolates Ensql::SQL objects as SQL fragments.
+In addition you can interpolate raw SQL with `%{!sql_param}`. It's up to you to ensure this is safe!
 
 ```ruby
 # Interpolate a literal
@@ -148,7 +146,7 @@ Ensql.sql('INSERT INTO users (name, created_at) VALUES %{users( %{name}, now() )
 )
 # INSERT INTO users VALUES ('Claudia Buss', now()), ('Lundy L''Anglais', now())
 
-# Interpolate a SQL fragement
+# Interpolate a raw SQL fragment without quoting. Use with care!
 Ensql.sql('SELECT * FROM users ORDER BY %{!orderby}', orderby: Ensql.sql('name asc'))
 # SELECT * FROM users ORDER BY name asc
 ```

data/ensql.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["daniel@fone.net.nz"]
 
   spec.summary = "Write SQL the safe and simple way"
-  spec.description = "Ditch your ORM and embrace the power and simplicity of writing plain SQL again."
+  spec.description = "Escape your ORM and embrace the power and simplicity of writing plain SQL again."
   spec.homepage = "https://github.com/danielfone/ensql"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")

data/gemfiles/maintained.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    ensql (0.6.4)
+    ensql (0.6.5)
       connection_pool (>= 0.9.3, < 3)
 
 GEM

data/gemfiles/minimum.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    ensql (0.6.4)
+    ensql (0.6.5)
       connection_pool (>= 0.9.3, < 3)
 
 GEM

data/lib/ensql/load_sql.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "sql"
+require_relative "error"
 
 module Ensql
   class << self
@@ -31,6 +32,8 @@ module Ensql
     def load_sql(name, params = {})
       path = File.join(sql_path, "#{name}.sql")
       SQL.new(File.read(path), params, name)
+    rescue Errno::ENOENT
+      raise Error, "couldn't load SQL from file '#{path}' (sql_path: '#{sql_path}')"
     end
   end
 end

data/lib/ensql/version.rb

@@ -2,7 +2,7 @@
 
 module Ensql
   # Gem version
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
   # Versions of activerecord compatible with the {ActiveRecordAdapter}
   SUPPORTED_ACTIVERECORD_VERSIONS = [">= 5.0", "< 6.2"].freeze
   # Versions of sequel compatible with the {SequelAdapter}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ensql
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Daniel Fone
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -86,7 +86,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.26
-description: Ditch your ORM and embrace the power and simplicity of writing plain
+description: Escape your ORM and embrace the power and simplicity of writing plain
   SQL again.
 email:
 - daniel@fone.net.nz
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
+rubygems_version: 3.2.14
 signing_key:
 specification_version: 4
 summary: Write SQL the safe and simple way