sqlite_ext 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f6b5d358b16c536bcdad4bb288489e28360658c
-  data.tar.gz: 138d46d2228bb3fc817590ca9fc034e405237730
+  metadata.gz: 8ef79118c67623c9f8ea24483b8546c8ce61a8d9
+  data.tar.gz: 82e046090cdf94052b499694feb657f13251d280
 SHA512:
-  metadata.gz: 1aa86694f1cab9be067f288c0ac11a87c682cc72ffbca404a21e7ccf26902faecab1183b5a4ecdca83a4bbc25b6a4683d9e4ee1b81470c33c46129177603120d
-  data.tar.gz: d839f9d594177b9934779fd67d7d50710db7db7626ba50cb77eca31c2426fcb4ea467248ea143996804cc36f6d6fa4380f066b7da619470ca254a2a2c629c6e5
+  metadata.gz: 644c88efc1b5b4803ca26c0a355485e426c4fc6a9e1711599c886e04b5a8f5c3ac88a63ebeadbc566b35e74c4da543ac194bcd971bbe61deab2f9497dc488493
+  data.tar.gz: d20b161052dd7baa1773d7a451d5a4b8ab7f85f2a95d93772f685710ce7738d6d92d8d799bc030a997ee237a0b05b7d1f0a9bb503a12711bc9d04bfe6090d5af

data/README.md

@@ -1,9 +1,5 @@
 # SqliteExt
 
-Note that the work on this gem is still in the early stages, so
-the text below represents what it is intended to do. The gem does
-not yet accomplish all of that as of yet.
-
 Provides a convenient way of writing functions in Ruby that can
 be called from with in SQLite queries through the SQLite3 gem.
 
@@ -41,14 +37,8 @@ Or install it yourself as:
 
 ## Usage
 
-    SqliteExt.register_create_function 'sqrt', 1 do |fn,x|
-      fn.result =
-        case x
-        when nil then nil
-        else Math.sqrt(x)
-        end
-    end
-
+    SqliteExt.register_function('sqrt', 1){ |x| Math.sqrt(x) }
+    
     SQLite3::Database.new 'data.db' do |db|
       puts db.execute("SELECT sqrt(25)")[0][0]
     end

data/lib/sqlite_ext/version.rb

@@ -1,3 +1,3 @@
 module SqliteExt
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/sqlite_ext.rb

@@ -16,30 +16,54 @@ module SqliteExt
 
   class << self
 
+    # Registers a block of ruby code to be used as a function in
+    # SQL executed through subsequent new instances of
+    # `SQLite3::Database`.
+    #
+    # Example:
+    #
+    # SqliteExt.register_function('sqrt', 1){ |x| Math.sqrt(x) }
+    #
+    # SQLite3::Database.new 'data.db' do |db|
+    #   puts db.execute("SELECT sqrt(25)")[0][0]
+    # end
+    # # Output: 5.0
+    #
+    def register_function(name, &block)
+      register_create_function name, block.arity do |fn,*args|
+        fn.result = block.call(*args)
+      end
+    end
+
     # Registers a #create_function call to be invoked on every
     # new instance of `SQLite3::Database` immidately after it is
     # instantiated and before it is returned from the call to
     # `.new` and before the invocation of a block that is passed
     # to `.new`.
     #
+    # The parameters passed to `#register_create_function` are
+    # exactly the same as those that would be passed to
+    # `SQLite3::Database#create_function`.
+    #
     # Note that this only affects instances of
     # `SQLite3::Database` that are subsequently created and has
     # no effect on previously created instances.
     #
     # Example:
     #
-    #  SqliteExt.register_create_function 'sqrt', 1 do |fn,x|
-    #     fn.result =
-    #       case x
-    #         when nil then nil
-    #         else Math.sqrt(x)
-    #         end
-    #       end
+    # SqliteExt.register_create_function 'sqrt', 1 do |fn,x|
+    #    fn.result =
+    #      case x
+    #        when nil then nil
+    #        else Math.sqrt(x)
+    #        end
+    #      end
+    #
+    # SQLite3::Database.new 'data.db' do |db|
+    #   puts db.execute("SELECT sqrt(25)")[0][0]
+    # end
+    # # Output: 5.0
     #
-    #       SQLite3::Database.new 'data.db' do |db|
-    #         puts db.execute("SELECT sqrt(25)")[0][0]
-    #       end
-    #       # Output: 5.0
     def register_create_function(name, arity, *other_args, &block)
       name = "#{name}"
       registered_function_creations[name] = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqlite_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Jorgensen