db2_query 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a54ab3ca53e8078aee466400a89ec9b18c5c5ed65450d6d35cdf7a8552e0e21c
-  data.tar.gz: 72ad54eb98b13a471ba8e022e57cb686a31cf7a2e1d833a4d54d833f3d900105
+  metadata.gz: 42c29fbb4c23d3cc0198ea49b0cbb9e980150a610dde50b19e422c8dd9519c99
+  data.tar.gz: 7ff6974cb986bc5df133229f275d4be9bac9a647e7936c35e1f3103967848b95
 SHA512:
-  metadata.gz: a037c568900f33c3eefdc2692fd0d8d470dc4167ff87f3b1c0fa11902204fb38523b4bc257cf6cac069590a9706f1c94f506fc13fd35aa7388495fc9e28ea84a
-  data.tar.gz: 9f1815d05567d1f972ff1f7d0ff5324a2d11781ae0000b13b552c1c21b4da260de7e7e0d8a633fb48a5ce5636ceea7f90e1fe0a509352a7ff99779788ef0b7d7
+  metadata.gz: 79661005fa24b32c0b03e119549377f5fea9dde025aa91dc5809ad52ad4f212f9b20a278736ea6a077aefb411d4bbc0513bb0e3acb629675d9735202206ebfd4
+  data.tar.gz: 6f58ef2ceb59765e54310d2ea7c1cf1132da62f6102e7187121691b8018670b6a9abe194d41d86cfd9042f35cb5e5746444dcf10c9adced05b85e2335c37f5e6

data/README.md

@@ -45,7 +45,6 @@ At `db2query_database.yml` we can use two type of connection:
 ```yml
 development:
   primary:                          # Connection String Example
-    adapter: db2_query
     conn_string:
       driver: DB2
       database: SAMPLE
@@ -56,8 +55,7 @@ development:
       protocol: IPC
       uid: <%= ENV["DB2EC_UID"] %>
       pwd: <%= ENV["DB2EC_PWD"] %>
-  secondary:
-    adapter: db2_query             # DSN Example
+  secondary:             # DSN Example
     dsn: iseries
     uid: <%= ENV["ISERIES_UID"] %>
     pwd: <%= ENV["ISERIES_PWD"] %>
@@ -92,7 +90,26 @@ class User < DB2Query::Base
     SELECT * FROM LIBTEST.USERS WHERE id = ?
   SQL
 end
+
+class User < DB2query::Base
+  query :id_greater_than, -> id {
+    exec_query({}, "SELECT * FROM LIBTEST.USERS WHERE id > ?", [id])
+  }
+
+  query :insert_record, -> *args {
+    execute(
+      "INSERT INTO users (id, first_name, last_name, email) VALUES (?, ?, ?, ?)", args
+    )
+  }
+end
 ```
+
+The query method must have 2 inputs:
+1. Method name
+2. Body (can be an SQL statement or lamda).
+
+The lambda is used to facilitate us in using `built-in methods` as shown at two query methods above.
+
 Or use a normal sql method (don't forget the `_sql` suffix)
 ```ruby
 class User < DB2Query::Base 
@@ -144,11 +161,20 @@ SQL Load (3.28ms)  SELECT * FROM LIBTEST.USERS WHERE id = ? [["id", 10000]]
 => #<DB2Query::Result @records=[#<Record id: 10000, first_name: "Dr.Strange", last_name: "Stephen", email: "strange@marvel.universe.com">]>
 ```
 
-### Available methods
+### Available Result Ogject methods
 `DB2Query::Result` inherit all `ActiveRecord::Result` methods with additional custom methods:
   1. `records` to convert query result into array of Record objects.
   2. `to_h` to convert query result into hash with symbolized keys.
 
+### Built-in methods
+These built-in methods are delegated to `DB2Query::Connection` methods
+  1. `query_rows(sql)`
+  2. `query_value(sql)`
+  3. `query_values(sql)`
+  4. `execute(sql)`
+  5. `exec_query(formatters, sql, args = [])`
+They behave just likely `ActiveRecords` connection's public methods.
+
 ### ActiveRecord Combination
 
 Create an abstract class that inherit from `ActiveRecord::Base`

data/lib/db2_query.rb

@@ -5,6 +5,7 @@ require "erb"
 require "active_record"
 require "active_support"
 require "db2_query/config"
+require "db2_query/error"
 require "db2_query/connection_handling"
 
 module DB2Query
@@ -12,6 +13,7 @@ module DB2Query
 
   autoload :Version
   autoload :Base
+  autoload :Bind
   autoload :Core
   autoload :DatabaseStatements
   autoload :Connection

data/lib/db2_query/bind.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DB2Query
+  class Bind < Struct.new(:name, :value, :index)
+  end
+end

data/lib/db2_query/connection.rb

@@ -6,6 +6,7 @@ module DB2Query
 
     include DB2Query::DatabaseStatements
     include ActiveSupport::Callbacks
+
     define_callbacks :checkout, :checkin
 
     set_callback :checkin, :after, :enable_lazy_transactions!
@@ -81,7 +82,7 @@ module DB2Query
           msg << "it is already in use by a different thread: #{@owner}. " \
                   "Current thread: #{Thread.current}."
         end
-        raise ActiveRecordError, msg
+        raise DB2Query::Error, msg
       end
 
       @owner = Thread.current
@@ -124,14 +125,14 @@ module DB2Query
       when RuntimeError
         exception
       else
-        ActiveRecord::StatementInvalid.new(message, sql: sql, binds: binds)
+        DB2Query::StatementInvalid.new(message, sql: sql, binds: binds)
       end
     end
 
     def expire
       if in_use?
         if @owner != Thread.current
-          raise ActiveRecordError, "Cannot expire connection, " \
+          raise DB2Query::Error, "Cannot expire connection, " \
             "it is owned by a different thread: #{@owner}. " \
             "Current thread: #{Thread.current}."
         end
@@ -139,7 +140,7 @@ module DB2Query
         @idle_since = Concurrent.monotonic_time
         @owner = nil
       else
-        raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
+        raise DB2Query::Error, "Cannot expire connection, it is not currently leased."
       end
     end
 
@@ -151,11 +152,11 @@ module DB2Query
           @owner = Thread.current
         end
       else
-        raise ActiveRecordError, "Cannot steal connection, it is not currently leased."
+        raise DB2Query::Error, "Cannot steal connection, it is not currently leased."
       end
     end
 
-    def seconds_idle # :nodoc:
+    def seconds_idle
       return 0 if in_use?
       Concurrent.monotonic_time - @idle_since
     end

data/lib/db2_query/connection_handling.rb

@@ -17,7 +17,7 @@ module DB2Query
       end
   end
 
-  class ConnectionSpecification #:nodoc:
+  class ConnectionSpecification
     attr_reader :name, :config
 
     def initialize(name, config)
@@ -70,12 +70,12 @@ module DB2Query
     RAILS_ENV   = -> { (Rails.env if defined?(Rails.env)) || ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence }
     DEFAULT_ENV = -> { RAILS_ENV.call || "default_env" }
 
-    def lookup_connection_handler(handler_key) # :nodoc:
+    def lookup_connection_handler(handler_key)
       handler_key = DB2Query::Base.reading_role
       connection_handlers[handler_key] ||= DB2Query::ConnectionHandler.new
     end
 
-    def resolve_config_for_connection(config_or_env) # :nodoc:
+    def resolve_config_for_connection(config_or_env)
       raise "Anonymous class is not allowed." unless name
 
       config_or_env ||= DEFAULT_ENV.call.to_sym
@@ -101,7 +101,7 @@ module DB2Query
     end
 
     private
-      def swap_connection_handler(handler, &blk) # :nodoc:
+      def swap_connection_handler(handler, &blk)
         old_handler, DB2Query::Base.connection_handler = DB2Query::Base.connection_handler, handler
         return_value = yield
         return_value

data/lib/db2_query/core.rb

@@ -40,19 +40,24 @@ module DB2Query
         formatters.store(attr_name, format)
       end
 
-      def query(name, sql_statement)
+      def query(name, body)
         if defined_method_name?(name)
-          raise ArgumentError, "You tried to define a scope named \"#{name}\" " \
+          raise DB2Query::Error, "You tried to define a scope named \"#{name}\" " \
             "on the model \"#{self.name}\", but DB2Query already defined " \
             "a class method with the same name."
         end
 
-        unless sql_statement.strip.match?(/^select/i)
-          raise NotImplementedError
-        end
-
-        self.class.define_method(name) do |*args|
-          connection.exec_query(sql_statement, formatters, args)
+        if body.respond_to?(:call)
+          singleton_class.define_method(name) do |*args|
+            body.call(*args)
+          end
+        elsif body.is_a?(String)
+          sql = body
+          singleton_class.define_method(name) do |*args|
+            connection.exec_query(formatters, sql, args)
+          end
+        else
+          raise DB2Query::Error, "The query body needs to be callable or is a sql string"
         end
       end
 
@@ -73,12 +78,14 @@ module DB2Query
             sql_statement = allocate.method(sql_method).call
 
             unless sql_statement.is_a? String
-              raise ArgumentError, "Query methods must return a SQL statement string!"
+              raise DB2Query::Error, "Query methods must return a SQL statement string!"
             end
 
             query(method_name, sql_statement)
 
             method(method_name).call(*args)
+          elsif connection.respond_to?(method_name)
+            connection.send(method_name, *args)
           else
             super
           end

data/lib/db2_query/database_statements.rb

@@ -13,25 +13,21 @@ module DB2Query
       query(sql)
     end
 
-    def query_value(sql, name = nil)
+    def query_value(sql)
       single_value_from_rows(query(sql))
     end
 
-    def query_values(sql, name = nil)
+    def query_values(sql)
       query(sql).map(&:first)
     end
 
     def execute(sql, args = [])
-      if args.empty?
-        @connection.do(sql)
-      else
-        @connection.do(sql, *args)
-      end
+      @connection.do(sql, *args)
     end
 
-    def exec_query(sql, formatter = {}, args = [], name = "SQL")
+    def exec_query(formatters, sql, args = [])
       binds, args = extract_binds_from_sql(sql, args)
-      log(sql, name, binds, args) do
+      log(sql, "SQL", binds, args) do
         begin
           if args.empty?
             stmt = @connection.run(sql)
@@ -43,7 +39,7 @@ module DB2Query
         ensure
           stmt.drop unless stmt.nil?
         end
-        DB2Query::Result.new(columns, rows, formatter)
+        DB2Query::Result.new(columns, rows, formatters)
       end
     end
 
@@ -54,36 +50,36 @@ module DB2Query
       end
 
       def key_finder_regex(k)
-        /#{k} =\\? | #{k}=\\? | #{k}= \\? /i
+        /#{k} .\\? | #{k}.\\? | #{k}. \\? /i
       end
 
       def extract_binds_from_sql(sql, args)
         question_mark_positions = sql.enum_for(:scan, /\?/i).map { Regexp.last_match.begin(0) }
-        args = args.first.is_a?(Hash) ? args.first : args.is_a?(Array) ? args : [args]
+        args = args.first.is_a?(Hash) ? args.first : args
         given, expected = args.length, question_mark_positions.length
 
         if given != expected
-          raise ArgumentError, "wrong number of arguments (given #{given}, expected #{expected})"
+          raise DB2Query::Error, "wrong number of arguments (given #{given}, expected #{expected})"
         end
 
         if args.is_a?(Hash)
           binds = args.map do |key, value|
             position = sql.enum_for(:scan, key_finder_regex(key)).map { Regexp.last_match.begin(0) }
             if position.empty?
-              raise ArgumentError, "Column name: `#{key}` not found inside sql statement."
+              raise DB2Query::Error, "Column name: `#{key}` not found inside sql statement."
             elsif position.length > 1
-              raise ArgumentError, "Can't handle such this kind of sql. Please refactor your sql."
+              raise DB2Query::Error, "Can't handle such this kind of sql. Please refactor your sql."
             else
               index = position[0]
             end
 
-            OpenStruct.new({ name: key.to_s, value: value, index: index })
+            DB2Query::Bind.new(key.to_s, value, index)
           end
           binds = binds.sort_by { |bind| bind.index }
           [binds.map { |bind| [bind, bind.value] }, binds.map { |bind| bind.value }]
         elsif question_mark_positions.length == 1 && args.length == 1
-          column = sql[/(.*?) = \?|(.*?) =\?|(.*?)= \?|(.*?)=\?/m, 1].split.last.downcase
-          bind = OpenStruct.new({ name: column, value: args })
+          column = sql[/(.*?) . \?|(.*?) .\?|(.*?). \?|(.*?).\?/m, 1].split.last.downcase
+          bind = DB2Query::Bind.new(column.gsub(/[)(]/, ""), args, 0)
           [[[bind, bind.value]], bind.value]
         else
           [args.map { |arg| [nil, arg] }, args]

data/lib/db2_query/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DB2Query
+  class Error < StandardError
+  end
+
+  class StatementInvalid < ActiveRecord::ActiveRecordError
+    def initialize(message = nil, sql: nil, binds: nil)
+      super(message || $!.try(:message))
+      @sql = sql
+      @binds = binds
+    end
+
+    attr_reader :sql, :binds
+  end
+end

data/lib/db2_query/formatter.rb

@@ -21,7 +21,7 @@ module DB2Query
 
   class AbstractFormatter
     def format(value)
-      raise NotImplementedError, "Implement format method in your subclass."
+      raise DB2Query::Error, "Implement format method in your subclass."
     end
   end
 end

data/lib/db2_query/odbc_connector.rb

@@ -16,13 +16,17 @@ module DB2Query
     def initialize(config)
       @config = config
     end
+
+    def connect
+      raise "abstract method #connect must be defined"
+    end
   end
 
   class DsnConnector < AbstractConnector
     def connect
       ::ODBC.connect(config[:dsn], config[:uid], config[:pwd])
     rescue ::ODBC::Error => e
-      raise ArgumentError, "Unable to activate ODBC DSN connection #{e}"
+      raise DB2Query::Error, "Unable to activate ODBC DSN connection #{e}"
     end
   end
 
@@ -34,7 +38,7 @@ module DB2Query
       end
       ::ODBC::Database.new.drvconnect(driver)
     rescue ::ODBC::Error => e
-      raise ArgumentError, "Unable to activate ODBC Conn String connection #{e}"
+      raise DB2Query::Error, "Unable to activate ODBC Conn String connection #{e}"
     end
   end
 end

data/lib/db2_query/tasks/database.rake

@@ -5,12 +5,10 @@ DB2_QUERY_DATABASE_TEMPLATE ||= <<-EOF
 # Database configuration example
 development:
   primary:
-    adapter: db2_query
     dsn: iseries
     uid: <%= ENV["ISERIES_UID"] %>
     pwd: <%= ENV["ISERIES_PWD"] %>
   secondary:
-    adapter: db2_query
     conn_string:
       driver: DB2
       database: ARUNIT2
@@ -23,12 +21,10 @@ development:
       pwd: <%= ENV["DB2EC_PWD"] %>
 test:
   primary:
-    adapter: db2_query
     dsn: iseries
     uid: <%= ENV["ISERIES_UID"] %>
     pwd: <%= ENV["ISERIES_PWD"] %>
   secondary:
-    adapter: db2_query
     conn_string:
       driver: DB2
       database: ARUNIT2

data/lib/db2_query/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DB2Query
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db2_query
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - yohanes_l
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-odbc
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A Rails query plugin to fetch data from Db2 database by using ODBC connection.
 email:
 - yohanes.lumentut@yahoo.com
@@ -162,11 +134,13 @@ files:
 - Rakefile
 - lib/db2_query.rb
 - lib/db2_query/base.rb
+- lib/db2_query/bind.rb
 - lib/db2_query/config.rb
 - lib/db2_query/connection.rb
 - lib/db2_query/connection_handling.rb
 - lib/db2_query/core.rb
 - lib/db2_query/database_statements.rb
+- lib/db2_query/error.rb
 - lib/db2_query/formatter.rb
 - lib/db2_query/odbc_connector.rb
 - lib/db2_query/railtie.rb
@@ -195,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: DB2Query