twowaysql 0.2.1 → 0.3.0

data/History.txt

@@ -1,7 +1,10 @@
-== 0.2.0 / 2008-09-05
-* Initial release
-* RubyForge settings
-* rdoc for published classes and methods
+== release_0_3 / 2008-09-10
+* better whitespace handling
+* Whitespace compaction mode
+* remove preserve_eol flag
+* preserve actual comment content
+* write docs for space compaction mode
+* change line-based scanning to whole string based scanning
 
 == 0.2.1 / 2008-09-07
 * bugfix: case insensitive match for SQL reserved words
@@ -9,3 +12,8 @@
 * integrate ditz html into site
 * change idiom 'substitution' to 'interpolation'
 * Handle Embedded variable comment at Scanner/Grammar level
+
+== 0.2.0 / 2008-09-05
+* Initial release
+* RubyForge settings
+* rdoc for published classes and methods

data/Manifest.txt

@@ -5,16 +5,21 @@ README.txt
 Rakefile
 config/hoe.rb
 config/requirements.rb
+issues/issue-001c53236380a42cd8c5a9099bbcc6ec613919c2.yaml
 issues/issue-1cee7e821865a216674832b0186bd92792680571.yaml
 issues/issue-25efcfc383f3b0f6c0e2730ae7c2975bb2b3de26.yaml
+issues/issue-279105dd0d9f03514d318f5eab5e99c4c2d47fda.yaml
+issues/issue-28cde89ed3eb306957edc90595b1d16bf43daf42.yaml
 issues/issue-39023ea09e17e2d64bcef03aa59cdfe38b78ad5b.yaml
 issues/issue-4bc308d55ae91f266e656162a4147d356de1166c.yaml
 issues/issue-5c973ef5bb074eacca0c6c84f7d27c4267773ea8.yaml
 issues/issue-664986b219202ff1948cab717b56e7540f493561.yaml
+issues/issue-6daccddf089d11d42bf016897da98f70cf5ab46c.yaml
 issues/issue-897995fa10377eabdf597e8e7692f17087c76923.yaml
 issues/issue-901f65630639507c8b05b466790e9f22256c6450.yaml
 issues/issue-bd38c1cdc965d73dd629a81db2de1bcdcf4b10b8.yaml
 issues/issue-dca4b19aa13de59838b33e03252bf824670a2d12.yaml
+issues/issue-f1bd40de5458397d9b142ea3e197e5264e0dcdbf.yaml
 issues/issue-f2b773020b54f839c03d899b38b5113c8fd991df.yaml
 issues/issue-f39b907d01d7fa93df8c7a9de2e1b5e27727ee0a.yaml
 issues/issue-f64d73ed4f9854f1ded77e6496dbf59cfb3770a7.yaml

data/README.txt

@@ -121,10 +121,9 @@ TwoWaySQL is not
 
 * actual SQL comment
 
-
-=== Known limitations
-
-* currently, ruby version of TwoWaySQL cannot parse multi-line comments.
+* parse options
+  * preserve_space
+  * preserve_comment
 
 
 
@@ -143,7 +142,7 @@ TwoWaySQL::Template is the class you may only use. TwoWaySQL::Template acts as a
 ==== Input
 * TwoWaySQL-style SQL(string,file or anything like IO) to TwoWaySQL::Template.parse to create template object (note: template object is stateless and reentrant, so you can cache it)
   * (Optionally) TwoWaySQL::Template.parse accepts Hash of parse options as second argument
-* data object(Hash-like object) to the TwoWaySQL::Template#merge then TwoWaySQL will evaluate the data as 'ctx'.
+* data object to the TwoWaySQL::Template#merge then TwoWaySQL will evaluate the data as name 'ctx'.
 
 ==== Output
 * SQL String with placeholders (generally, '?' is used for placeholders)
@@ -174,7 +173,7 @@ TwoWaySQL may use bind variable as follows. In this case, value of ctx[:empno] i
 ===== usage
 
   sql = "SELECT * FROM emp WHERE job = /*ctx[:job]*/'CLERK' AND deptno = /*ctx[:deptno]*/20"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
   merged = template.merge(:job => "HOGE", :deptno => 30)
   merged.sql                #=> "SELECT * FROM emp WHERE job = ? AND deptno = ?"
@@ -197,7 +196,7 @@ acceptable argument for IN clause is an array-like object. Say, Object that resp
 ===== usage
 
   sql = "SELECT * FROM emp WHERE deptno IN /*ctx[:deptnoList]*/(10, 20) ORDER BY ename"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
   merged = template.merge(:deptnoList => [30,40,50])
   merged.sql                #=> "SELECT * FROM emp WHERE deptno IN (?, ?, ?) ORDER BY ename"
@@ -232,7 +231,7 @@ As you noticed. Embedded variable comment has risk for SQL Injection. Please not
 ===== usage
 
   sql = "SELECT * FROM emp ORDER BY /*$ctx[:order_by]*/ename /*$ctx[:order]*/ASC"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
   merged = template.merge(:order_by => 'id, :order => 'DESC')
   merged.sql                #=> "SELECT * FROM emp ORDER BY id DESC"
@@ -256,7 +255,7 @@ When the condition returns a truthy value, TwoWaySQL treats statements in "/*IF*
 ==== usage
 
   sql = "SELECT * FROM emp/*IF ctx[:job] */ WHERE job = /*ctx[:job]*/'CLERK'/*END*/"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
 
   # active case
@@ -286,7 +285,7 @@ In this case, when the eval(ctx[:foo]) returns an falsy value, string "hoge IS N
 ==== ELSE comment sample
 
   sql = "SELECT * FROM emp WHERE /*IF ctx[:job]*/job = /*ctx[:job]*/'CLERK'-- ELSE job IS NULL/*END*/"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
   # active case
   merged = template.merge(:job => 'MANAGER')
@@ -327,7 +326,7 @@ In the above example,
 ==== usage
 
   sql = "SELECT * FROM emp/*BEGIN*/ WHERE /*IF ctx[:job]*/job = /*ctx[:job]*/'CLERK'/*END*//*IF ctx[:deptno]*/ AND deptno = /*ctx[:deptno]*/20/*END*//*END*/"
-  template = TwoWaySQL::Template.parse(sql, :preserve_eol => false)
+  template = TwoWaySQL::Template.parse(sql)
 
   # when data is empty (no param exists)
   ctx = {}
@@ -350,6 +349,79 @@ In the above example,
 
 
 
+=== Parse Options
+
+TwoWaySQL::Template.parse takes parse options as optional second argument. Acceptable parse options are kind_of Hash with available keys. Unknown options are just ignored.
+
+* available parse option keys
+  * :preserve_space (default is true)
+  * :preserve_comment (default is false)
+  * :debug (internal use only)
+
+
+==== :preserve_space (default is true)
+
+Default is true. When true, parser preserves original whitespaces. When false, parser translates consecutive whitespaces to single whitespace. This flag is useful for log space saving.
+
+
+    sql = <<-EOS
+  SELECT
+    *
+  FROM
+    emp
+  WHERE
+    job    =   /*ctx[:job]*/'CLERK'
+    AND   deptno   =   /*ctx[:deptno]*/10
+  EOS
+    template = TwoWaySQL::Template.parse(sql, :preserve_space => false)
+    
+    result = template.merge(:job => 'MANAGER', :deptno => 30)
+    
+    result.sql                 #=> "SELECT * FROM emp WHERE job = ? AND deptno = ? "
+    result.bound_variables     #=> ["MANAGER", 30]
+
+
+==== :preserve_comment (default is false)
+
+Default is false. When true, parser preserves original actual comments. When false, parser skips actual comment, therefore parsed SQL does not contain actual comments.
+
+    sql = <<-EOS
+  SELECT
+    *
+  FROM
+    emp
+    /* 
+       This is a
+       multiline comment
+    */
+  WHERE
+    job    =   /*ctx[:job]*/'CLERK'
+    AND   deptno   =   /*ctx[:deptno]*/10
+  EOS
+    template = TwoWaySQL::Template.parse(sql, :preserve_comment => true)
+    
+    result = template.merge(:job => 'MANAGER', :deptno => 30)
+    
+    expected = <<-EOS
+  SELECT
+    *
+  FROM
+    emp
+    /* 
+       This is a
+       multiline comment
+    */
+  WHERE
+    job    =   ?
+    AND   deptno   =   ?
+  EOS
+    result.sql == expected     #=> true
+    result.bound_variables     #=> ["MANAGER", 30]
+
+
+
+
+
 == REQUIREMENTS:
 
 * racc/parser (basically bundled with ruby)
@@ -357,7 +429,7 @@ In the above example,
 
 == INSTALL:
 
-* sudo gem install twowaysql
+* (sudo) gem install twowaysql
 
 
 == AUTHOR:

data/issues/issue-001c53236380a42cd8c5a9099bbcc6ec613919c2.yaml

@@ -0,0 +1,18 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: integrate RSpec report into website
+desc: integrate RSpec report into website
+type: :task
+component: twowaysql
+release: 
+reporter: takuto <takuto.wada@gmail.com>
+status: :unstarted
+disposition: 
+creation_time: 2008-09-09 05:46:28.201883 Z
+references: []
+
+id: 001c53236380a42cd8c5a9099bbcc6ec613919c2
+log_events: 
+- - 2008-09-09 05:46:29.606754 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""

data/issues/issue-25efcfc383f3b0f6c0e2730ae7c2975bb2b3de26.yaml

@@ -3,10 +3,10 @@ title: better whitespace handling
 desc: better whitespace handling on Scanner/Grammar.
 type: :feature
 component: twowaysql
-release: 
+release: release_0_3
 reporter: takuto <takuto.wada@gmail.com>
-status: :unstarted
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2008-09-03 09:00:15.483485 Z
 references: []
 
@@ -16,3 +16,15 @@ log_events:
   - takuto <takuto.wada@gmail.com>
   - created
   - fix some dirty rules for whitespaces, if possible.
+- - 2008-09-08 08:56:27.771360 Z
+  - takuto <takuto.wada@gmail.com>
+  - assigned to release release_0_3 from unassigned
+  - ""
+- - 2008-09-08 08:57:22.550994 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-09 05:38:29.182555 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/issue-279105dd0d9f03514d318f5eab5e99c4c2d47fda.yaml

@@ -0,0 +1,21 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: deal with trailing space of ELSE
+desc: |-
+  deal with trailing space of ELSE. e.g.
+  ... --ELSE age IS NULL  #=> 'age IS NULL'
+  ... --ELSE AND age IS NULL  #=> 'AND age IS NULL' or ' age IS NULL' 
+type: :task
+component: twowaysql
+release: 
+reporter: takuto <takuto.wada@gmail.com>
+status: :unstarted
+disposition: 
+creation_time: 2008-09-09 05:43:46.691586 Z
+references: []
+
+id: 279105dd0d9f03514d318f5eab5e99c4c2d47fda
+log_events: 
+- - 2008-09-09 05:43:48.017710 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""

data/issues/issue-28cde89ed3eb306957edc90595b1d16bf43daf42.yaml

@@ -0,0 +1,26 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: write docs for space compaction mode
+desc: write docs for space compaction mode
+type: :task
+component: twowaysql
+release: release_0_3
+reporter: takuto <takuto.wada@gmail.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-09-09 05:40:16.864740 Z
+references: []
+
+id: 28cde89ed3eb306957edc90595b1d16bf43daf42
+log_events: 
+- - 2008-09-09 05:40:18.449669 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""
+- - 2008-09-09 09:56:02.992717 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-10 06:28:29.298991 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/issue-664986b219202ff1948cab717b56e7540f493561.yaml

@@ -3,7 +3,7 @@ title: line number support on parse error
 desc: show line number of SQL when parse error has occurred.
 type: :feature
 component: twowaysql
-release: release_0_3
+release: release_0_4
 reporter: takuto <takuto.wada@gmail.com>
 status: :unstarted
 disposition: 
@@ -20,3 +20,7 @@ log_events:
   - takuto <takuto.wada@gmail.com>
   - assigned to release release_0_3 from unassigned
   - assign to release_0_3
+- - 2008-09-10 06:27:47.942216 Z
+  - takuto <takuto.wada@gmail.com>
+  - assigned to release release_0_4 from release_0_3
+  - ""

data/issues/issue-6daccddf089d11d42bf016897da98f70cf5ab46c.yaml

@@ -0,0 +1,18 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: integrate ditz to 'push-button release'
+desc: integrate 'ditz release' and 'ditz changelog' into rake task
+type: :task
+component: twowaysql
+release: 
+reporter: takuto <takuto.wada@gmail.com>
+status: :unstarted
+disposition: 
+creation_time: 2008-09-07 17:34:42.830046 Z
+references: []
+
+id: 6daccddf089d11d42bf016897da98f70cf5ab46c
+log_events: 
+- - 2008-09-07 17:34:44.130887 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""

data/issues/issue-901f65630639507c8b05b466790e9f22256c6450.yaml

@@ -3,10 +3,10 @@ title: Whitespace compaction mode
 desc: Whitespace compaction mode for log space saving
 type: :feature
 component: twowaysql
-release: 
+release: release_0_3
 reporter: takuto <takuto.wada@gmail.com>
-status: :unstarted
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2008-09-05 11:32:38.661495 Z
 references: []
 
@@ -16,3 +16,15 @@ log_events:
   - takuto <takuto.wada@gmail.com>
   - created
   - ""
+- - 2008-09-08 08:56:36.791742 Z
+  - takuto <takuto.wada@gmail.com>
+  - assigned to release release_0_3 from unassigned
+  - ""
+- - 2008-09-08 08:57:29.584166 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-09 05:38:35.131235 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/issue-f1bd40de5458397d9b142ea3e197e5264e0dcdbf.yaml

@@ -0,0 +1,26 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: remove preserve_eol flag
+desc: remove preserve_eol flag. both for one-liner and multi-line SQL.
+type: :feature
+component: twowaysql
+release: release_0_3
+reporter: takuto <takuto.wada@gmail.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-09-08 18:50:03.580663 Z
+references: []
+
+id: f1bd40de5458397d9b142ea3e197e5264e0dcdbf
+log_events: 
+- - 2008-09-08 18:50:05.346009 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""
+- - 2008-09-08 18:50:28.843212 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-08 19:11:02.345285 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/issue-f2b773020b54f839c03d899b38b5113c8fd991df.yaml

@@ -3,10 +3,10 @@ title: change line-based scanning to whole string based scanning
 desc: try whole string based scanning to handle multiline comments and directives
 type: :task
 component: twowaysql
-release: 
+release: release_0_3
 reporter: takuto <takuto.wada@gmail.com>
-status: :unstarted
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2008-09-03 09:04:04.695887 Z
 references: []
 
@@ -16,3 +16,15 @@ log_events:
   - takuto <takuto.wada@gmail.com>
   - created
   - this is a trial. not necessary for current specs.
+- - 2008-09-08 08:56:33.359947 Z
+  - takuto <takuto.wada@gmail.com>
+  - assigned to release release_0_3 from unassigned
+  - ""
+- - 2008-09-08 08:57:26.255202 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-08 18:16:21.995139 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/issue-f64d73ed4f9854f1ded77e6496dbf59cfb3770a7.yaml

@@ -5,8 +5,8 @@ type: :feature
 component: twowaysql
 release: release_0_3
 reporter: takuto <takuto.wada@gmail.com>
-status: :unstarted
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2008-09-03 08:33:12.940300 Z
 references: []
 
@@ -20,3 +20,11 @@ log_events:
   - takuto <takuto.wada@gmail.com>
   - assigned to release release_0_3 from unassigned
   - assign to release_0_3
+- - 2008-09-08 10:33:48.093770 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-09-08 17:51:22.696803 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/project.yaml

@@ -20,13 +20,17 @@ releases:
     - 0.2 release done.
 - !ditz.rubyforge.org,2008-03-06/release 
   name: release_0_3
-  status: :unreleased
-  release_time: 
+  status: :released
+  release_time: 2008-09-10 06:33:15.041316 Z
   log_events: 
   - - 2008-09-05 11:23:24.696817 Z
     - takuto <takuto.wada@gmail.com>
     - created
     - release 0.3
+  - - 2008-09-10 06:33:15.041327 Z
+    - takuto <takuto.wada@gmail.com>
+    - released
+    - ""
 - !ditz.rubyforge.org,2008-03-06/release 
   name: release_0_2_1
   status: :released
@@ -40,3 +44,12 @@ releases:
     - takuto <takuto.wada@gmail.com>
     - released
     - 0.2.1 release
+- !ditz.rubyforge.org,2008-03-06/release 
+  name: release_0_4
+  status: :unreleased
+  release_time: 
+  log_events: 
+  - - 2008-09-10 06:27:14.808896 Z
+    - takuto <takuto.wada@gmail.com>
+    - created
+    - ""

data/lib/twowaysql/node.rb

@@ -210,20 +210,30 @@ module TwoWaySQL
   end
 
 
-  class CommentNode < Node
-    def initialize(val)
-      @val = val
+  class ActualCommentNode < Node
+    def initialize(delim, content)
+      @delim = delim
+      @content = content
     end
     def accept(ctx)
-      # nothing to do
+      ctx.add_sql("#{@delim}*#{@content}*#{@delim}")
     end
   end
 
 
-  class EolNode < Node
+  class WhiteSpaceNode < Node
+    def initialize(val, preserve)
+      @val = val
+      @preserve = preserve
+    end
     def accept(ctx)
-      ctx.add_sql("\n")
+      if @preserve
+        ctx.add_sql(@val)
+      else
+        ctx.add_sql(" ")
+      end
     end
   end
 
+
 end