oci8-auto-binder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24d5cdbeb9e402ac300d7f8b59635756456ed8a5
-  data.tar.gz: e02e9f71eaf85d06f5b61c5ac3bae24c0efa513e
+  metadata.gz: 7a732dcc2046abb7f0ed827822c59e0bbbd8c669
+  data.tar.gz: a2ec13df2972e2f67d2bd26894beac63512fc5cd
 SHA512:
-  metadata.gz: 259d3f4ba9b7af441130620dbddd07ce18e79655e25fd463974e2c76fffcb47efe8819eec330787b475b9ea230c85b6e2d709f7d2d7cd04e322a177cedfdc8e2
-  data.tar.gz: 972cc18f9870d23ec42fde6e994bbd81d78ebcefb449ddb5960a8f47d06d2dd5cd57700e17714ba5f0f7c041a914e2e83b877015240fe3cedee23ec02ee3480f
+  metadata.gz: b5935ccb0d1a42d299c6c7ac666ff95f993cf5942ea4cc620bf3704102be11956bcb4b684da8971abb94595b9e58a62446a887fae40a18bf9f3512918852b486
+  data.tar.gz: 0943a9b0b9fafc40b7640ad4c3f0b8248e68994bf43c0edd798f7a2fa8a4d94eba5cfd9df98e9a11b48c83471bd29fc05b76029d7b63da5395a55e2c1f5df4f7

data/.gitignore

@@ -1,3 +1,5 @@
 /Gemfile.lock
 *.sw?
 *.gem
+/test/db_config.yml
+/test/test.log

data/README.md

@@ -0,0 +1,45 @@
+# OCI8 Auto binder
+
+This library changes the query to parameterized query automatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oci8-auto-binder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oci8-auto-binder
+
+## Usage
+
+```ruby
+OCI8AutoBinder.replace_original_class!
+conn = OCI8.new(username, password, ident)
+conn.exec("select * from table1 where column1 = 1") do |r|
+  # change to prarameterized query atomatically in exec method
+  # query = "select * from table1 where column1 = :a0", params = {:a0 => 1}
+  puts r.join(',')
+end
+conn.logoff
+```
+
+## logging parameterized query and parameters
+```ruby
+OCI8AutoBinder.replace_original_class!
+OCI8AutoBinder.logger = Logger.new(log_file_name)
+OCI8AutoBinder.logger.level = Logger::INFO   # save all log(FOUND_BINDVARS, PARSE_ERROR, NO_PARAMS, PARSE_SUCCESS)
+OCI8AutoBinder.logger.level = Logger::ERROR   # save parse error log(PARSE_ERROR)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jksy/oci8-auto-binder.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+GRAMMAR_FILES = FileList['lib/oracle-sql-parser/grammar/*.treetop']
+
+task :build_gem => [:gen_force] do
+  sh 'gem build oci8-auto-binder.gemspec'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList[
+                    'test/oci8_test.rb',
+                    ]
+  t.verbose = true
+end

data/lib/oci8-auto-binder/base.rb

@@ -4,29 +4,48 @@ require 'oracle-sql-parser'
 module OCI8AutoBinder
   ORIGINAL_OCI8 = ::OCI8
   @replace = false
+  @logger = nil
+
+  # OCI8をOCI8AutoBinder::OCI8に置き換えます
+  # replace to OCI8AutoBinder::OCI8 from OCI8
   def self.replace_original_class!
     unless @replaced
       Object.const_set(:OCI8, ::OCI8AutoBinder::OCI8)
       @replaced = true
     end
   end
+
+  # パースした結果を保存するログファイルを渡します
+  # set Logger for the purpose of logging
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  # get logger
+  def self.logger
+    @logger
+  end
+
 end
 
+# OCI8#execを上書きし、OracleSqlParser::Grammar::GrammarParserで構文解析した結果をOCI8#execに渡します。
+# Pass the result that was parsed by OracleSqlParser::Grammar::GrammarParser to OCI8#exec
 class OCI8AutoBinder::OCI8 < ::OCI8
-  def parser
-    @parser ||= OracleSqlParser::Grammar::GrammarParser.new
-  end
 
+  # OracleSqlParser::Grammar::GrammarParserで構文解析し、NumberLiteralとTextLiteralをbinding変数としてOCI8#execに渡す
   def exec_with_auto_binder(sql, *bindvars, &block)
     if bindvars.length != 0
+      logger.info {"FOUND_BINDVARS:#{sql}, #{bindvars.inspect}"} if logger
       return exec_without_auto_binder(sql, *bindvars, &block)
     end
     syntax_tree = parser.parse(sql)
     unless syntax_tree
+      logger.error {"PARSE_ERROR:#{sql}, #{bindvars.inspect}"} if logger
       return exec_without_auto_binder(sql, *bindvars, &block)
     end
     p = syntax_tree.ast.to_parameternized
     if p.params.size == 0
+      logger.info {"NO_PARAMS:#{sql}, #{bindvars.inspect}"} if logger
       return exec_without_auto_binder(sql, *bindvars, &block)
     end
 
@@ -41,9 +60,21 @@ class OCI8AutoBinder::OCI8 < ::OCI8
       end
     end
 
+    logger.info {"PARSE_SUCCESS:#{sql}, #{p.to_sql}, #{values.inspect}"} if logger
     return exec_without_auto_binder(p.to_sql, *values, &block)
   end
 
   alias :exec_without_auto_binder :exec
   alias :exec :exec_with_auto_binder
+
+  def logger
+    OCI8AutoBinder.logger
+  end
+
+  private
+  # GrammerParserを取得する
+  # get GrammerParser
+  def parser
+    @parser ||= OracleSqlParser::Grammar::GrammarParser.new
+  end
 end

data/lib/oci8-auto-binder/version.rb

@@ -1,3 +1,3 @@
 module OCI8AutoBinder
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/oci8-auto-binder.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["junichiro.kasuya@gmail.com"]
 
   spec.summary       = %q{execute parameternized query for OCI8}
-  spec.description   = %q{execute parameternized query for OCI8}
+  spec.description   = %q{This library changes the query to parameterized query automatically.}
   spec.homepage      = "https://github.com/jksy/oci8-auto-binder"
   spec.licenses      = ["MIT"]
 
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 1.9.0'
-  spec.add_dependency "bundler", ">= 1.10"
-  spec.add_dependency "rake", ">= 10.0"
-  spec.add_dependency "test-unit", ">= 3.1"
-  spec.add_dependency "ruby-oci8", ">= 2.0"
-  spec.add_dependency "oracle-sql-parser", ">= 0.5.0"
+  spec.add_dependency "bundler", "~> 1.10"
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "test-unit", "~> 3.1"
+  spec.add_dependency "ruby-oci8", "~> 2.0"
+  spec.add_dependency "oracle-sql-parser", "~> 0.5"
 end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: oci8-auto-binder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Junichiro Kasuya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ruby-oci8
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: oracle-sql-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-description: execute parameternized query for OCI8
+        version: '0.5'
+description: This library changes the query to parameterized query automatically.
 email:
 - junichiro.kasuya@gmail.com
 executables: []
@@ -89,6 +89,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- README.md
+- Rakefile
 - lib/oci8-auto-binder.rb
 - lib/oci8-auto-binder/base.rb
 - lib/oci8-auto-binder/version.rb