sqlite3_extend_function 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f1a8e83ab2ee29e39fe322af75225c0afb71fe45ce0c9ac0a9d93a4c694351d
-  data.tar.gz: 910ece0c01d8bc20dd23e2538fd878c4b74f2522a77b59f949df326ea3668afd
+  metadata.gz: b370727ad3e7fe4e4dbce17de3372fb15fff6c2193f2400563c1a7a1e9e6fc88
+  data.tar.gz: d66b7180e476b6154ff201b82424df92f0e28572643e7de869ddd842a9707159
 SHA512:
-  metadata.gz: 2456666472f46222eb6f042fe494a47d62cb55e79be77e3245069fae1f8f90a0762c3ea0b8e2e1b057610a344311b28b0722d8bff5a343d46f2a30c54ff066c2
-  data.tar.gz: ff90a662e004f3a9137f887d74ad972ab2a330e0aec5b8a621b400ec06dfac6fee5949784911611d0d63eb98ff972f430041af75757b7abe87b495d515c8c7d0
+  metadata.gz: b52dc19acdd7720c481acdc73ba8390aaad68f79181f0d9ce4f0fff87bd6c4b512e01bd2faa7141461b6efc4b9909a3b306ff0544c3b233c8b833c5183750940
+  data.tar.gz: d2f10a203913bbdcf6bf7d1c85e48b0be609cf158ae08209dbe6016561e28653350092f2d7b487a486c05680133b52c847b60073a5b3dd89550518ec26cf633c

data/README.md

@@ -1,25 +1,73 @@
 # SQLite3ExtendFunction
 
-Add some user-defined function to SQL when using SQLie3 with ActiveRecord.
+Add some user-defined function to SQL when using SQLie3.
 
 ## Functions
 
+The following PostgreSQL functions are supported.
+
+- acos
+- ascii
+- asin
+- atan
+- atan2
+- bit\_length
+- btrim
+- cbrt
 - ceil
+- char\_length
+- chr
+- concat
+- concat\_ws
+- cos
+- cot
+- decode
+- degrees
+- div
+- encode
+- exp
 - floor
+- format
+- initcap
+- ln
+- log
+- md5
+- mod
+- now
+- octet\_length
+- pi
+- power
+- radians
+- sign
+- sin
+- sqrt
+- tan
+- trunc
+- width\_bucket
+
+See [PostgreSQL Document](https://www.postgresql.org/docs/12/functions.html)
 
 ```
-ActiveRecord::Base.connection.select_one("select ceil(0.1)")
-=> {"ceil(0.1)"=>1}
+# check
+db = SQLite3::Database.new(':memory:')
 
-ActiveRecord::Base.connection.select_one("select floor(1.1)")
-=> {"floor(1.1)"=>1}
+db.execute("select ceil(0.1)")[0][0]
+=> 1
+
+db.execute("select floor(1.1)")[0][0]
+=> 1
 ```
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sqlite3_extend_function', '~> 0.1'
+gem 'sqlite3_extend_function', '~> 0.2'
+
+# master branch
+gem 'sqlite3_extend_function',
+    git: 'https://github.com/shoma07/sqlite3_extend_function.git',
+    branch: 'master'
 ```
 
 And then execute:

data/lib/sqlite3_extend_function.rb

@@ -1,25 +1,27 @@
 # frozen_string_literal: true
 
-require 'active_record'
+require 'sqlite3'
 require 'sqlite3_extend_function/version'
 require 'sqlite3_extend_function/function'
-require 'sqlite3_extend_function/configuration'
 
 # SQLite3ExtendFunction
 module SQLite3ExtendFunction
-  extend Configuration
-
-  def self.included(klass)
-    klass.set_callback(:checkout, :before, lambda { |conn|
-      return if conn.adapter_name != 'SQLite'
-
-      SQLite3ExtendFunction.options[:functions].each do |func|
-        lmd = Function.send(func)
-        args = lmd.parameters.size - 1
-        conn.raw_connection.create_function(func.to_s, args, &lmd)
+  def self.included(base)
+    base.class_eval do
+      original_method = instance_method(:initialize)
+      define_method(:initialize) do |*args, &block|
+        result = original_method.bind(self).call(*args)
+        SQLite3ExtendFunction::Function.singleton_methods.each do |func|
+          lmd = Function.send(func)
+          create_function(func.to_s, (lmd.parameters.size - 1), &lmd)
+        end
+        # frozen_string_literal: true
+        # SQLite3ExtendFunction
+        block&.call(self)
+        result
       end
-    })
+    end
   end
 end
 
-ActiveRecord::ConnectionAdapters::AbstractAdapter.include(SQLite3ExtendFunction)
+SQLite3::Database.include(SQLite3ExtendFunction)

data/lib/sqlite3_extend_function/function.rb

@@ -1,32 +1,563 @@
 # frozen_string_literal: true
 
+require 'bigdecimal'
+require 'base64'
+require 'digest/md5'
 module SQLite3ExtendFunction
   # SQLite3ExtendFunction::Function
   module Function
     class << self
       # @return [Proc]
       def ceil
-        lambda do |func, value|
-          func.result = if value.nil?
-                          nil
-                        elsif value.is_a? Numeric
-                          value.ceil
-                        else
-                          0
-                        end
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            func.result = Kernel.Float(dp).ceil.to_i
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
         end
       end
 
       # @return [Proc]
       def floor
-        lambda do |func, value|
-          func.result = if value.nil?
-                          nil
-                        elsif value.is_a? Numeric
-                          value.floor
-                        else
-                          0
-                        end
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            func.result = Kernel.Float(dp).floor.to_i
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # cube root
+      # @return [Proc]
+      def cbrt
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            result = Math.cbrt(Kernel.Float(dp))
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # radians to degrees
+      # @return [Proc]
+      def degrees
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            func.result = Kernel.Float(dp) * 180 / Math::PI
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # integer quotient of y/x
+      # @return [Proc]
+      def div
+        lambda do |func, y, x|
+          return if y.nil? || x.nil?
+
+          begin
+            func.result = Kernel.Float(y).div(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  'invalid input syntax for type numeric'
+          end
+        end
+      end
+
+      # exponential
+      # @return [Proc]
+      def exp
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            result = Math.exp(Kernel.Float(dp))
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # natural logarithm
+      # @return [Proc]
+      def ln
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            result = Math.log(Kernel.Float(dp))
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  'cannot take logarithm of a negative number'
+          end
+        end
+      end
+
+      # base 10 logarithm
+      # @return [Proc]
+      def log
+        lambda do |func, y, x = nil|
+          if x.nil?
+            return if y.nil?
+
+            result = Math.log10(Kernel.Float(y))
+            func.result = result.to_i == result ? result.to_i : result
+          else
+            return if y.nil? || x.nil?
+
+            func.result = Math.log(x, y)
+          end
+        rescue ArgumentError
+          raise SQLite3::SQLException,
+                'invalid input syntax for type numeric'
+        end
+      end
+
+      # remainder of y/x
+      # @return [Proc]
+      def mod
+        lambda do |func, y, x|
+          func.result = Kernel.Float(y).modulo(Kernel.Float(x)).to_i
+        rescue ArgumentError
+          raise SQLite3::SQLException,
+                'Could not choose a best candidate function. You might need to add explicit type casts.'
+        end
+      end
+
+      # "π" constant
+      # @return [Proc]
+      def pi
+        lambda do |func|
+          func.result = Math::PI
+        end
+      end
+
+      # a raised to the power of b
+      # @return [Proc]
+      def power
+        lambda do |func, a, b|
+          return if a.nil? || b.nil?
+
+          begin
+            result = Kernel.Float(a)**Kernel.Float(b)
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  'invalid input syntax for type double precision'
+          end
+        end
+      end
+
+      # degrees to radians
+      # @return [Proc]
+      def radians
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            result = Kernel.Float(dp) * Math::PI / 180
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # sign of the argument (-1, 0, +1)
+      # @return [Proc]
+      def sign
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            value = Kernel.Float(dp)
+            func.result = if value.zero?
+                            0
+                          elsif value.positive?
+                            1
+                          else
+                            -1
+                          end
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # square root
+      # @return [Proc]
+      def sqrt
+        lambda do |func, dp|
+          return if dp.nil?
+
+          begin
+            result = Math.sqrt(Kernel.Float(dp))
+            func.result = result.to_i == result ? result.to_i : result
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: \"#{dp}\""
+          end
+        end
+      end
+
+      # truncate toward zero
+      # @return [Proc]
+      def trunc
+        lambda do |func, dp, s = 0|
+          return if dp.nil?
+
+          begin
+            ss = BigDecimal(Kernel.Float(s).to_s)
+            dec = if ss.zero?
+                    BigDecimal('1.0')
+                  else
+                    BigDecimal((1.0 / (10**ss).to_f).to_s)
+                  end
+            result = (BigDecimal(Kernel.Float(dp).to_s) / dec).to_i * dec
+            func.result = result.to_i == result ? result.to_i : result.to_f
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  'invalid input syntax for type double precision'
+          end
+        end
+      end
+
+      # return the bucket number to which operand would be assigned input
+      # a histogram having count equal-width buckets spanning the range b1 to b2;
+      # returns 0 or count+1 for an input outside the range
+      # @return [Proc]
+      def width_bucket
+        lambda do |func, operand, b1, b2, count|
+          begin
+            operand = Kernel.Float(operand)
+            b1 = Kernel.Float(b1)
+            b2 = Kernel.Float(b2)
+            count = Kernel.Float(count)
+
+            raise ArgumentError unless count.positive?
+            result = (operand / ((b2 - b1) / count)).ceil
+            result = count + 1 if result > count
+            result = 0 if result.negative?
+            func.result = result.to_i
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  'ArgumentError'
+          end
+        end
+      end
+
+      # @return [Proc]
+      def acos
+        lambda do |func, x|
+          begin
+            func.result = Math.acos(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def asin
+        lambda do |func, x|
+          begin
+            func.result = Math.asin(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def atan
+        lambda do |func, x|
+          begin
+            func.result = Math.atan(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def atan2
+        lambda do |func, y, x|
+          begin
+            func.result = Math.atan2(Kernel.Float(y), Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def cos
+        lambda do |func, x|
+          begin
+            func.result = Math.cos(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def cot
+        lambda do |func, x|
+          begin
+            func.result = 1 / Math.tan(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def sin
+        lambda do |func, x|
+          begin
+            func.result = Math.sin(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # @return [Proc]
+      def tan
+        lambda do |func, x|
+          begin
+            func.result = Math.tan(Kernel.Float(x))
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                  "invalid input syntax for type double precision: #{x}"
+          end
+        end
+      end
+
+      # Number of bits in string
+      # @return [Proc]
+      def bit_length
+        lambda do |func, str|
+          begin
+            func.result = str.bytesize * 8
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # Number of characters in string
+      # @return [Proc]
+      def char_length
+        lambda do |func, str|
+          begin
+            func.result = str.length
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # octet_length
+      # @return [Proc]
+      def octet_length
+        lambda do |func, str|
+          begin
+            func.result = str.bytesize
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def ascii
+        lambda do |func, str|
+          begin
+            raise ArgumentError if str.is_a? String
+
+            func.result = str.ord
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def btrim
+        lambda do |func, text, chrs = ''|
+          begin
+            func.result = text.sub(/\A[#{chrs}]*/, '').sub(/[#{chrs}]*\z/, '')
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def chr
+        lambda do |func, int|
+          begin
+            func.result = int.chr
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def concat
+        lambda do |func, *args|
+          begin
+            func.result = args.compact.join
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def concat_ws
+        lambda do |func, sep, *args|
+          begin
+            func.result = args.compact.join(sep)
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def decode
+        lambda do |func, str, format|
+          return if data.nil?
+
+          begin
+            raise ArgumentError if data.is_a? String
+
+            func.result = case format
+                          when 'base64'
+                            Base64.decode64(str)
+                          when 'hex'
+                            str.scan(/.{2}/).map(&:hex).map(&:chr).join
+                          when 'escape'
+                            raise ArgumentError
+                          else
+                            raise ArgumentError
+                          end
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def encode
+        lambda do |func, data, format|
+          return if data.nil?
+
+          begin
+            raise ArgumentError if data.is_a? String
+
+            func.result = case format
+                          when 'base64'
+                            Base64.encode64(data)
+                          when 'hex'
+                            data.unpack("C*").map { |c| c.to_s(16) }.join
+                          when 'escape'
+                            raise ArgumentError
+                          else
+                            raise ArgumentError
+                          end
+          rescue ArgumentError
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def format
+        lambda do |func, formartstr, *args|
+          func.result = formartstr % args
+        end
+      end
+
+      # @return [Proc]
+      def initcap
+        lambda do |func, str|
+          return if str.nil?
+
+          begin
+            regexp = /([a-zA-Z0-9]*|[^a-zA-Z0-9]*)/
+            func.result = str.split(regexp).map.with_index { |s, i|
+              i.odd? ? s.downcase.capitalize : s
+            }.join
+          rescue
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # @return [Proc]
+      def md5
+        lambda do |func, str|
+          return if str.nil?
+
+          begin
+            func.result = Digest::MD5.hexdigest(str)
+          rescue
+            raise SQLite3::SQLException,
+                 "No function matches the given name and argument types. You might need to add explicit type casts."
+          end
+        end
+      end
+
+      # Current date and time (start of current transaction)
+      # @return [Proc]
+      def now
+        lambda do |func|
+          func.result = Time.now.strftime('%Y-%m-%d %H:%M:%S.%6N%:z')
         end
       end
     end

data/lib/sqlite3_extend_function/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SQLite3ExtendFunction
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,58 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: sqlite3_extend_function
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - shoma07
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Add some user-defined functions to SQL when using SQLie3 with Rails.
+        version: '3.0'
+description: Add some user-defined functions to SQL when using SQLie3.
 email:
 - 23730734+shoma07@users.noreply.github.com
 executables: []
@@ -63,7 +77,6 @@ files:
 - README.md
 - Rakefile
 - lib/sqlite3_extend_function.rb
-- lib/sqlite3_extend_function/configuration.rb
 - lib/sqlite3_extend_function/function.rb
 - lib/sqlite3_extend_function/version.rb
 homepage: https://github.com/shoma07/sqlite3_extend_function
@@ -72,7 +85,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/shoma07/sqlite3_extend_function
   source_code_uri: https://github.com/shoma07/sqlite3_extend_function
-  changelog_uri: https://github.com/shoma07/sqlite3_extend_function/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/shoma07/sqlite3_extend_function/blob/v0.2.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -91,5 +104,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Add some user-defined functions to SQL when using SQLie3 with Rails.
+summary: Add some user-defined functions to SQL when using SQLie3.
 test_files: []

data/lib/sqlite3_extend_function/configuration.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module SQLite3ExtendFunction
-  # SQLite3ExtendFunction::Configuration
-  module Configuration
-    mattr_accessor :options
-
-    self.options = {
-      functions: Function.singleton_methods
-    }
-
-    def configure
-      yield self
-    end
-
-    # @param [Array] functions
-    def functions=(functions)
-      options[:functions] = Function.singleton_methods & functions
-    end
-  end
-end