quote-sql 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f64b3b81c62230c2814c487d3a5b2e56109b651297a599449a2b8edd91b3d8
-  data.tar.gz: 8fc4b373eb65ab1d6ba2e86a32db5d60caf3bef38096e9a098127d9f892a4abe
+  metadata.gz: 5e32e2e164efd0cfb007de82abb8870b13d5b432856d21af6f75faed9d2d1107
+  data.tar.gz: 141ef285fbb563e649d5c4b71faa8b1d9d67066d1c600dd9d85c7dd5ee017edc
 SHA512:
-  metadata.gz: d58cc18c35110eef2ddb9c08f1e23f9b353ab7fc73939063fa3a576156c0fd96b05099e8fe8742fcb4c46261735fc47d547d24f6218ce9f6776c8e91be873211
-  data.tar.gz: 7facea8c215baf9c9196512b636b3ae866343eea0ca8137589b25f3cd6684a4fa815661c05059be58c11ace2c0fc6ac3962d96d02c3c9be1fdef628a00c6349d
+  metadata.gz: 8e13010de0021284de07a99e33822e54b530d3d5dfbc5986028327c903b5c3ab55ceadcf0042eb7207eea8245f31f57db5811a0f902fe8f68eb9a435c02ff255
+  data.tar.gz: f178c03540bdea0b38c8278ace489954d9efff1786fa76b804950c11bf60f2ac3162f6ca3ac9f142f08dc62d830e10cd8835786618175a922b7eb183e71c89bc

data/README.md

@@ -1,5 +1,6 @@
 # QuoteSql - Tool to build and run SQL queries easier
 I've built this library as an addition to ActiveRecord and Arel, however you can use it with any sql database and plain Ruby.
+However currently it is just used with PostgreSQL.
 
 Creating SQL queries and proper quoting becomes complicated especially when you need advanced queries.
 
@@ -8,7 +9,7 @@ I created this library while coding for different projects, and had lots of Here
 
 My strategy is to segment SQL Queries in readable junks, which can be individually tested and then combine their sql to the final query.
 
-QuoteSql is used in production, but is still evolving.
+QuoteSql is used in production, but is still bleeding edge - and there is not a fully sync between doc and code.
 
 If you think QuoteSql is interesting, let's chat!
 Also if you have problems using it, just drop me a note.
@@ -23,6 +24,10 @@ Best Martin
 `QuoteSql.new("SELECT %field__text").quote(field__text: 9).to_sql`
 => SELECT 9::TEXT
 
+### Rails models
+`QuoteSql.new(Users.limit(10).select("%columns")).quote(columns: ['first_name', 'last_name').to_sql` 
+=> SELECT first_name, last_name FROM users LIMIT 10
+
 ### Quoting of columns and table from a model - or an object responding to table_name and column_names or columns
 `QuoteSql.new("SELECT %columns FROM %table_name").quote(table: User).to_sql`
   => SELECT "id",firstname","lastname",... FROM "users"
@@ -47,10 +52,18 @@ Values are be ordered in sequence of columns. Missing value entries are substitu
       ON CONFLICT ("id") DO NOTHING
       
 ### Columns from a list
-`QuoteSql.new("SELECT %columns").quote(columns: [:a, :"b.c", c: "jsonb_build_object('d', 1)"]).to_sql`
-  => SELECT "a","b"."c",jsonb_build_object('d', 1) AS c
+`QuoteSql.new("SELECT %columns").quote(columns: [:a, :"b.c", c: {d: field}]).to_sql`
+  => SELECT "a","b"."c",jsonb_build_object('d', field) AS c 
+
+`QuoteSql.new("SELECT %columns").quote(columns: [:a, :"b.c", c: {d: field, nil: false}]).to_sql`
+  => SELECT "a","b"."c",jsonb_strip_nulls(jsonb_build_object('d', 1)) AS c 
+
+
+### Execution of a query
+`QuoteSql.new("Select 1 as abc").result` => [{:abc=>1}]
 
-## Substitution of 
+
+## Substitution of mixins with quoted values 
   In the SQL matches of `%foo` or `%{foo}` or `%foo_4_bar` or `%{foo_4_bar}` the *"mixins"*
   are substituted with quoted values
   the values are looked up from the options given in the quotes method
@@ -106,6 +119,16 @@ with optional array dimension
   - +String+ value will become the expression, the key the AS {result: "SUM(*)"} => SUM(*) AS result
   - +Proc+ are executed with the +QuoteSQL::Quoter+ object as parameter and added as raw SQL
 
+## Shortcuts and functions
+- `QuoteSQL("select %abc", abc: 1)` == `QuoteSql.new("select %abc").quote(abc: 1)`
+- when you have in your initializer `String.include QuoteSql::Extension` you can do e.g. `"select %abc".quote_sql(abc: 1)`
+- when you have in your initializer `ActiveRecord::Relation.include QuoteSql::Extension` you can do e.g.  `Profile.limit(10).select('%abc').quote_sql(abc: 1)`
+
+## Debug and dump
+If you have pg_format installed you can get the resulting query inspected: 
+  `QuoteSql.new("select %abc").quote(abc: 1).dsql`
+  
+
 ## Installing
 `gem install quote-sql`
 or in Gemfile
@@ -121,3 +144,10 @@ Add this to config/initializers/quote_sql.rb
       ActiveRecord::Relation.include QuoteSql::Extension
     end  
 
+## Todos
+- Functionalities not yet used in my production might not work
+- More documentation
+- Tests missing
+- Missing functionalities
+  - Prepare
+  - which other - let me know!

data/lib/quote_sql/quoter.rb

@@ -13,7 +13,7 @@ class QuoteSql
       when /(?:^|(.*)_)table$/i
         table
       when /(?:^|(.*)_)columns?$/i
-        column_names
+        columns
       when /(?:^|(.*)_)(table_name?s?)$/i
         table_name
       when /(?:^|(.*)_)(column_name?s?)$/i
@@ -22,9 +22,9 @@ class QuoteSql
         ident_name
       when /(?:^|(.*)_)constraints?$/i
         quotable.to_s
-      when /(?:^|(.*)_)(raw|sql)$/
+      when /(?:^|(.*)_)(raw|sql)$/i
         quotable.to_s
-      when /(?:^|(.*)_)(values?)$/
+      when /(?:^|(.*)_)(values?)$/i
         values
       else
         quote
@@ -121,6 +121,20 @@ class QuoteSql
       end
     end
 
+    def columns(item = @quotable)
+      if item.respond_to?(:column_names)
+        item = item.column_names
+      elsif item.class.respond_to?(:column_names)
+        item = item.class.column_names
+      elsif item.is_a?(Array)
+        if item[0].respond_to?(:name)
+          item = item.map(&:name)
+        end
+      end
+      @qsql.column_names ||= item
+      ident_name(item)
+    end
+
     def column_names(item = @quotable)
       if item.respond_to?(:column_names)
         item = item.column_names
@@ -133,6 +147,13 @@ class QuoteSql
       ident_name(item)
     end
 
+    def json_build_object(h)
+      compact = h.delete(nil) == false
+      rv = "jsonb_build_object(" + h.map { "'#{_1}',#{_2}" }.join(",") + ")"
+      return rv unless compact
+      "jsonb_strip_nulls(#{rv})"
+    end
+
     def ident_name(item = @quotable)
       case item
       when Array
@@ -147,14 +168,18 @@ class QuoteSql
           end
         end.join(",")
       when Hash
-        item.map do
-          case _2
+        item.map do |k,v|
+          case v
           when Symbol
-            _quote_column_name(_1, _2)
+            _quote_column_name(k, v)
           when String
-            "#{_2} AS #{_1}"
+            "#{v} AS #{k}"
           when Proc
             item.call(self)
+          when Hash
+            "#{json_build_object(v)} AS #{k}"
+          else
+            raise ArgumentError
           end
         end.join(",")
       else

data/lib/quote_sql/test.rb

@@ -39,7 +39,6 @@ module QuoteSql::Test
       "SELECT * FROM #{self.class.table_name}"
     end
   end
-
   class << self
     def test_columns_and_table_name_simple
       expected Arel.sql(%(SELECT "a","b"."c" FROM "my_table"))

data/lib/quote_sql.rb

@@ -1,4 +1,4 @@
-Dir.glob(__FILE__.sub(/\.rb$/, "/*.rb")).each { require(_1) unless _1[/test\.rb$/] }
+Dir.glob(__FILE__.sub(/\.rb$/, "/*.rb")).each { require(_1) unless _1[/(deprecated|test)\.rb$/] }
 
 # Tool to build and run SQL queries easier
 #
@@ -294,6 +294,15 @@ time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
 
   extend Quoting
 
+  def self.test
+    require __dir__ + "/quote_sql/test.rb"
+    Test
+  end
+end
+
+def QuoteSQL(sql, **options)
+  rv = QuoteSql.new(sql)
+  options.any? ? rv.quote(**options) : rv
 end
 
 QuoteSql.include QuoteSql::Formater

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quote-sql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Martin Kufner
@@ -39,9 +39,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="