sqlite_ext 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a1d3805872b3cf9967f73e10eceef144881de8
-  data.tar.gz: 7b8f3047b28c6d4ef317a312c6599923a283cee4
+  metadata.gz: cc98b5174c0640ce74feba4c553d0061600bffef
+  data.tar.gz: 5d617dd109ed311c43c8b066f6d74d3505da4568
 SHA512:
-  metadata.gz: b527f7514fe8d6bedf7280f1ff18ec153eead448d297b8d96c5d1fb44edc04a434f4d626e32bc0df4d8a7b46bda773e2f82990646107a5b270bf6d4c24f1755d
-  data.tar.gz: 7de2cc1620f33e8193d3cae6340ba45551dbda54b01ca91562a9c69f20c8a997336b76e59c53aa3dfbe9ed70c1950038b1508fdbe0c459583365c0e08ff09109
+  metadata.gz: 9a918310e21666283174b41a6b87f85fe42052e052bf6774fb8ee7d3fb57f85314bf6f7d9b36811517e30003c7930994dfce55992fd4159cb8a74b15b07c076b
+  data.tar.gz: e57a95e894c8be15190ba915ee9810d534f0b64754c23f252225e01d649cf1d79235ff1c7c1162ced5298608c30bffd5c17b2aa2fb05bb935bb0137310550f7a

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 0.3.0 - 2016-06-23
+* Removals
+  * Removed support for a block argument to `SqliteExt.register_function`.
+    It now accepts a `Proc` passed as a standard argument instead.
+* Enhancements
+  * Functions registered using `SqliteExt.register_function` automatically
+    propagate `NULL` when `NULL` is passed for one or more of the required
+    parameters of the `Proc` that performs the function.

data/README.md

@@ -37,12 +37,20 @@ Or install it yourself as:
 
 ## Usage
 
-    SqliteExt.register_function('sqrt'){ |x| Math.sqrt(x) }
-    
+    SqliteExt.register_function(
+      'sqrt',
+      ->(x){ Math.sqrt(x) }
+    )
+
     SQLite3::Database.new 'data.db' do |db|
-      puts db.execute("SELECT sqrt(25)")[0][0]
+      puts db.execute(
+        "SELECT sqrt(25), COALESCE(sqrt(NULL), -1)"
+      ).first
     end
-    # Output: 5.0
+
+    # == Output ==
+    # 5.0
+    # -1
 
 ## Development
 

data/lib/sqlite_ext/init_injection.rb

@@ -1,15 +1,24 @@
 module SqliteExt
+
+  # This module is prepended to `SQLite3::Database` to inject new
+  # initialization behavior.
   module InitInjection
+
+    # Adds functions registered with SqliteExt to each new
+    # instance before it is returned from `.new` or `.open`or is
+    # passed to the given block.
     def initialize(file, *other_init_args)
       if block_given?
-        super file, *other_init_args do |db|
+        super file, *other_init_args do
           SqliteExt.enhance_db_session self
-          yield db
+          yield self
         end
       else
         super
         SqliteExt.enhance_db_session self
       end
     end
+
   end
+
 end

data/lib/sqlite_ext/version.rb

@@ -1,3 +1,3 @@
 module SqliteExt
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/sqlite_ext.rb

@@ -16,22 +16,56 @@ module SqliteExt
 
   class << self
 
-    # Registers a block of ruby code to be used as a function in
-    # SQL executed through subsequent new instances of
+    # Registers a Ruby `Proc` to be used as a function in SQL
+    # code executed through subsequent new instances of
     # `SQLite3::Database`.
     #
+    # When `NULL` value is passed 1 or more of the `Proc`'s
+    # required parameters, it will be "propagated", meaning that
+    # the specified `Proc` will not be invoked and `NULL` will be
+    # returned from the call in SQL.
+    #
+    # When non-`NULL` values are passed to all of the `Proc`'s
+    # required parameters and `NULL` is passed to any or all of
+    # the `Proc`'s optional parameters, they will NOT be
+    # propagated, and the `Proc` WILL be invoked. Values passed
+    # as `NULL` in SQL will be forwarded to the `Proc` as Ruby
+    # `nil`s.
+    #
+    # Whenever the `Proc` is called and returns `nil`, that will
+    # result in `NULL` being returned from the function call in
+    # SQL.
+    #
     # Example:
     #
-    # SqliteExt.register_function('sqrt'){ |x| Math.sqrt(x) }
+    # SqliteExt.register_function(
+    #   'sqrt',
+    #   ->(x){ Math.sqrt(x) }
+    # )
     #
     # SQLite3::Database.new 'data.db' do |db|
-    #   puts db.execute("SELECT sqrt(25)")[0][0]
+    #   puts db.execute(
+    #     "SELECT sqrt(25), COALESCE(sqrt(NULL), -1)"
+    #   ).first
     # end
-    # # Output: 5.0
     #
-    def register_function(name, &block)
-      register_create_function name, block.arity do |fn,*args|
-        fn.result = block.call(*args)
+    # # == Output ==
+    # # 5.0
+    # # -1
+    #
+    def register_function(name, prok)
+      minimum_arity =
+        prok.
+        parameters.select{ |(kind,_)| kind == :req }.
+        count
+
+      register_create_function name, minimum_arity do |fn,*args|
+        fn.result =
+          if args[0...minimum_arity].any?{ |a| a.nil? }
+            nil
+          else
+            prok.call(*args)
+          end
       end
     end
 
@@ -88,7 +122,7 @@ module SqliteExt
     # `SQLite3::Database`.
     #
     # This is normally called automatically for each new
-    # instance, but can also be used to add the functions to
+    # instance, but it can also be used to add the functions to
     # an instance that was created before the functions were
     # registered.
     def enhance_db_session(db)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlite_ext
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Jorgensen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -83,8 +84,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- data.db
-- foo.db
 - lib/sqlite_ext.rb
 - lib/sqlite_ext/init_injection.rb
 - lib/sqlite_ext/version.rb