twowaysql 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,6 @@
+== release_0_4_1 / 2008-11-02
+* apply latest newgem structure
+
 == release_0_4 / 2008-09-29
 * line number support on parse error
 * integrate coverage report into website

data/Manifest.txt

@@ -1,11 +1,7 @@
 History.txt
 License.txt
-Manifest.skip
 Manifest.txt
-README.txt
-Rakefile
-config/hoe.rb
-config/requirements.rb
+README.rdoc
 issues/issue-001c53236380a42cd8c5a9099bbcc6ec613919c2.yaml
 issues/issue-1cee7e821865a216674832b0186bd92792680571.yaml
 issues/issue-25efcfc383f3b0f6c0e2730ae7c2975bb2b3de26.yaml
@@ -22,6 +18,7 @@ issues/issue-901f65630639507c8b05b466790e9f22256c6450.yaml
 issues/issue-a185b4247f64c1104bc49ebf823b57b5de3d06f8.yaml
 issues/issue-bd38c1cdc965d73dd629a81db2de1bcdcf4b10b8.yaml
 issues/issue-dca4b19aa13de59838b33e03252bf824670a2d12.yaml
+issues/issue-ec698dd75fb717a23045852de2fb367cff119b2e.yaml
 issues/issue-f1bd40de5458397d9b142ea3e197e5264e0dcdbf.yaml
 issues/issue-f2b773020b54f839c03d899b38b5113c8fd991df.yaml
 issues/issue-f39b907d01d7fa93df8c7a9de2e1b5e27727ee0a.yaml
@@ -32,17 +29,8 @@ lib/twowaysql/node.rb
 lib/twowaysql/parser.rb
 lib/twowaysql/parser.y
 lib/twowaysql/template.rb
-lib/twowaysql/version.rb
-setup.rb
 spec/large_sql_spec.rb
 spec/learning_regex_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/twowaysql_spec.rb
-tasks/deployment.rake
-tasks/ditz.rake
-tasks/environment.rake
-tasks/racc.rake
-tasks/rcov.rake
-tasks/rspec.rake
-tasks/website.rake

data/{README.txt → README.rdoc}

@@ -5,6 +5,8 @@
 * {Project Page}[http://rubyforge.org/projects/twowaysql]
 * {API Doc}[http://twowaysql.rubyforge.org/rdoc/]
 * {Issue Tracking}[http://twowaysql.rubyforge.org/issues/]
+* {Coverage Report}[http://twowaysql.rubyforge.org/coverage/]
+
 
 === sources:
 * http://github.com/twada/twowaysql/tree/master
@@ -154,7 +156,7 @@ TwoWaySQL::Template is the class you may only use. TwoWaySQL::Template acts as a
 
 Firstly, In TwoWaySQL, expressions are written within SQL comment such as within "/**/" and "--". SQL may still be executed since TwoWaySQL specific, non-SQL expressions are written within comments. As a best practice, it is better to first write and test SQL and then write expressions within comments.
 
-To write actual comments in SQL, *insert a space* after "/*" before the comment string. For example, /* hoge*/. TwoWaySQL will recognize the space(s) after the comment start ("/*") and treat the enclosed content as an actual comment.
+To write actual comments in SQL, *insert a space* after "/*" before the comment string. For example, /* foo*/. TwoWaySQL will recognize the space(s) after the comment start ("/*") and treat the enclosed content as an actual comment.
 
 
 
@@ -175,9 +177,9 @@ TwoWaySQL may use bind variable as follows. In this case, value of ctx[:empno] i
   sql = "SELECT * FROM emp WHERE job = /*ctx[:job]*/'CLERK' AND deptno = /*ctx[:deptno]*/20"
   template = TwoWaySQL::Template.parse(sql)
 
-  merged = template.merge(:job => "HOGE", :deptno => 30)
+  merged = template.merge(:job => "FOO", :deptno => 30)
   merged.sql                #=> "SELECT * FROM emp WHERE job = ? AND deptno = ?"
-  merged.bound_variables    #=> ["HOGE", 30]
+  merged.bound_variables    #=> ["FOO", 30]
 
 
 
@@ -211,9 +213,9 @@ acceptable argument for IN clause is an array-like object. Say, Object that resp
 
 If you want to use "LIKE", you may write bind variables:
 
-  ename LIKE /*ctx[:ename]*/'hoge'
+  ename LIKE /*ctx[:ename]*/'foo'
 
-Unfortunately, there is no special support for "LIKE". So, to use a wildcard character, add wildcard directy to the data. For example, to specify to include "COT", add wildcard character in the value as follows:
+Unfortunately, there is no special support for "LIKE". So, to use a wildcard character, add wildcard directly to the data. For example, to specify to include "COT", add wildcard character in the value as follows:
 
   :ename => "%COT%"
 
@@ -226,7 +228,7 @@ You can use Embedded variable comment to embed value directly (say without quoti
   /*$variable name*/Literal
 
 ===== CAUTION:
-As you noticed. Embedded variable comment has risk for SQL Injection. Please note, like any other 'eval' usage of TwoWaySQL, Embedded variable comment evals the data in safe level 4. Therefore, dangerous actions in Ruby world (ex. system call, valiable assignments, tainted strings) are never executed. However, this is not enough. Valid ruby string is still dangerous string as SQL fragments. Do NOT use user input or any other strings outside your code. If you use Embedded variable comment, you should carefully check the data and its origin.
+Please note, Embedded variable comment has risk for SQL Injection. Like any other 'eval' usage of TwoWaySQL, Embedded variable comment evals the data in safe level 4. Therefore, dangerous actions in Ruby world (ex. system call, variable assignments, tainted strings) are never executed. However, this is not enough. Valid ruby string is still dangerous string as SQL fragments. Do NOT use user input or any other strings outside your code. If you use Embedded variable comment, you should carefully check the data and its origin.
 
 ===== usage
 
@@ -247,9 +249,9 @@ To change SQL during execution based on a condition, use IF comments. IF comment
 
 An example of IF comment is as follows:
 
-  /*IF ctx[:foo]*/hoge = /*ctx[:hoge]*/'abc'/*END*/
+  /*IF ctx[:foo]*/foo = /*ctx[:foo]*/'abc'/*END*/
 
-When the condition returns a truthy value, TwoWaySQL treats statements in "/*IF*/" and "/*END*/" as active. In the above example, "hoge = /*ctx[:hoge]*/'abc'" will be output only when 'eval(ctx[:foo])' retuens an truthy value.
+When the condition returns a truthy value, TwoWaySQL treats statements in "/*IF*/" and "/*END*/" as active. In the above example, "foo = /*ctx[:foo]*/'abc'" will be output only when 'eval(ctx[:foo])' returns an truthy value.
 
 
 ==== usage
@@ -275,11 +277,11 @@ When the condition returns a truthy value, TwoWaySQL treats statements in "/*IF*
 
 You can use ELSE comment to activate statements when condition is false. Sn example of IF comment with ELSE is as follows.
 
-  /*IF ctx[:foo]*/hoge = /*ctx[:hoge]*/'abc'
-    -- ELSE hoge IS NULL
+  /*IF ctx[:foo]*/foo = /*ctx[:foo]*/'abc'
+    -- ELSE foo IS NULL
   /*END*/
 
-In this case, when the eval(ctx[:foo]) returns an falsy value, string "hoge IS NULL" will be active.
+In this case, when the eval(ctx[:foo]) returns an falsy value, string "foo IS NULL" will be active.
 
 
 ==== ELSE comment sample
@@ -437,6 +439,12 @@ Default is false. When true, parser preserves original actual comments. When fal
 * Takuto Wada(takuto.wada at gmail dot com)
 
 
+== CONTRIBUTORS:
+
+* Keiji Muraishi(http://github.com/kjim)
+* Keiji Yoshimi(http://github.com/walf443)
+
+
 == LICENSE:
 
 Copyright 2004-2008 the Seasar Foundation and the Others.

data/issues/issue-ec698dd75fb717a23045852de2fb367cff119b2e.yaml

@@ -0,0 +1,30 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: apply latest newgem structure
+desc: apply latest newgem structure
+type: :task
+component: twowaysql
+release: release_0_4_1
+reporter: takuto <takuto.wada@gmail.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-11-02 21:05:36.085228 Z
+references: []
+
+id: ec698dd75fb717a23045852de2fb367cff119b2e
+log_events: 
+- - 2008-11-02 21:05:37.613114 Z
+  - takuto <takuto.wada@gmail.com>
+  - created
+  - ""
+- - 2008-11-02 21:08:03.079665 Z
+  - takuto <takuto.wada@gmail.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-11-02 21:22:12.307551 Z
+  - takuto <takuto.wada@gmail.com>
+  - assigned to release release_0_4_1 from unassigned
+  - ""
+- - 2008-11-02 22:01:17.787460 Z
+  - takuto <takuto.wada@gmail.com>
+  - closed with disposition fixed
+  - ""

data/issues/project.yaml

@@ -57,3 +57,16 @@ releases:
     - takuto <takuto.wada@gmail.com>
     - released
     - ""
+- !ditz.rubyforge.org,2008-03-06/release 
+  name: release_0_4_1
+  status: :released
+  release_time: 2008-11-02 22:03:09.020717 Z
+  log_events: 
+  - - 2008-11-02 21:19:28.448115 Z
+    - takuto <takuto.wada@gmail.com>
+    - created
+    - release for applying latest newgem structure
+  - - 2008-11-02 22:03:09.020757 Z
+    - takuto <takuto.wada@gmail.com>
+    - released
+    - ""

data/lib/twowaysql.rb

@@ -4,3 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'twowaysql/node'
 require 'twowaysql/parser'
 require 'twowaysql/template'
+
+module TwoWaySQL
+  VERSION = '0.4.1'
+end

data/lib/twowaysql/node.rb

@@ -94,9 +94,6 @@ module TwoWaySQL
     def accept(ctx)
       exec_list(@tree, ctx)
     end
-    def children
-      @tree
-    end
   end
 
 
@@ -133,12 +130,12 @@ module TwoWaySQL
 
 
   class SubStatementNode < Node
-    def initialize(prefix, tree)
-      @prefix = prefix
+    def initialize(first_node, tree)
+      @first_node = first_node
       @tree = tree
     end
     def accept(ctx)
-      ctx.add_sql(@prefix) if ctx.enabled?
+      ctx.add_sql(@first_node) if ctx.enabled?
       exec_list(@tree, ctx)
     end
     def each
@@ -174,6 +171,7 @@ module TwoWaySQL
     def accept(ctx)
       result = do_eval(ctx, @exp)
       return if result.nil?
+      ##TODO: is there any better way to handle array-like structure?
       if result.respond_to?('to_ary')
         bind_values(ctx, result.to_ary)
       else

data/lib/twowaysql/parser.rb

@@ -11,7 +11,7 @@ module TwoWaySQL
 
   class Parser < Racc::Parser
 
-module_eval <<'..end lib/twowaysql/parser.y modeval..id30c07c2d1a', 'lib/twowaysql/parser.y', 134
+module_eval <<'..end lib/twowaysql/parser.y modeval..id64138765db', 'lib/twowaysql/parser.y', 134
 
 require 'strscan'
 
@@ -64,10 +64,11 @@ def parse( io )
   # @q.push [ false, nil ]
   @q.push [ false, [@s.pos, nil] ]
     
-  ## cal racc's private parse method
+  ## call racc's private parse method
   do_parse
 end
 
+
 ## called by racc
 def next_token
   @q.shift
@@ -116,22 +117,23 @@ def scan_str
     when @s.scan(SEMICOLON_AT_INPUT_END_PATTERN)
       #drop semicolon at input end
     else
-      raise Racc::ParseError, "syntax error near line:[#{line_no(@s.pos)}], str:[#{@s.rest}]"
+      raise Racc::ParseError, "syntax error at or near line:[#{line_no(@s.pos)}], str:[#{@s.rest}]"
     end
   end
 end
 
 
+## override racc's default on_error method
 def on_error(t, v, vstack)
   ## cursor in value-stack is an array of two items,
-  ## that have position value as 0th item. like [731, "ctx[:limit] "]
+  ##   that have position value as 0th item. like [731, "ctx[:limit] "]
   cursor = vstack.find do |tokens|
     tokens.size == 2 and tokens[0].kind_of?(Fixnum)
   end
   pos = cursor[0]
   line = line_no(pos)
   rest = @s.string[pos .. -1]
-  raise Racc::ParseError, "syntax error near line:[#{line}], str:[#{rest}]"
+  raise Racc::ParseError, "syntax error at or near line:[#{line}], str:[#{rest}]"
 end
 
 
@@ -141,7 +143,7 @@ def line_no(pos)
   scanned.each_line { lines += 1 }
   lines
 end
-..end lib/twowaysql/parser.y modeval..id30c07c2d1a
+..end lib/twowaysql/parser.y modeval..id64138765db
 
 ##### racc 1.4.5 generates ###
 

data/lib/twowaysql/parser.y

@@ -183,10 +183,11 @@ def parse( io )
   # @q.push [ false, nil ]
   @q.push [ false, [@s.pos, nil] ]
     
-  ## cal racc's private parse method
+  ## call racc's private parse method
   do_parse
 end
 
+
 ## called by racc
 def next_token
   @q.shift
@@ -235,22 +236,23 @@ def scan_str
     when @s.scan(SEMICOLON_AT_INPUT_END_PATTERN)
       #drop semicolon at input end
     else
-      raise Racc::ParseError, "syntax error near line:[#{line_no(@s.pos)}], str:[#{@s.rest}]"
+      raise Racc::ParseError, "syntax error at or near line:[#{line_no(@s.pos)}], str:[#{@s.rest}]"
     end
   end
 end
 
 
+## override racc's default on_error method
 def on_error(t, v, vstack)
   ## cursor in value-stack is an array of two items,
-  ## that have position value as 0th item. like [731, "ctx[:limit] "]
+  ##   that have position value as 0th item. like [731, "ctx[:limit] "]
   cursor = vstack.find do |tokens|
     tokens.size == 2 and tokens[0].kind_of?(Fixnum)
   end
   pos = cursor[0]
   line = line_no(pos)
   rest = @s.string[pos .. -1]
-  raise Racc::ParseError, "syntax error near line:[#{line}], str:[#{rest}]"
+  raise Racc::ParseError, "syntax error at or near line:[#{line}], str:[#{rest}]"
 end
 
 

data/lib/twowaysql/template.rb

@@ -33,9 +33,9 @@ module TwoWaySQL
     #
     # === Usage
     #
-    #   merged = template.merge(:job => "HOGE", :deptno => 30)
+    #   merged = template.merge(:job => "MANAGER", :deptno => 30)
     #   merged.sql                #=> "SELECT * FROM emp WHERE job = ? AND deptno = ?"
-    #   merged.bound_variables    #=> ["HOGE", 30]
+    #   merged.bound_variables    #=> ["MANAGER", 30]
     #
     # === Arguments
     #
@@ -51,7 +51,6 @@ module TwoWaySQL
       @root.accept(c)
       MergeResult.new(c)
     end
-    alias mungle merge
 
     protected
     def initialize(root)
@@ -65,9 +64,9 @@ module TwoWaySQL
   #
   # === Usage
   #
-  #   merged = template.merge(:job => "HOGE", :deptno => 30)
+  #   merged = template.merge(:job => "MANAGER", :deptno => 30)
   #   merged.sql                #=> "SELECT * FROM emp WHERE job = ? AND deptno = ?"
-  #   merged.bound_variables    #=> ["HOGE", 30]
+  #   merged.bound_variables    #=> ["MANAGER", 30]
   #
   class MergeResult
     def initialize(context)

data/spec/large_sql_spec.rb

@@ -34,7 +34,7 @@ EOS
     end
 
 
-    describe do
+    describe '' do
       before do
         template = TwoWaySQL::Template.parse(@sql)
         @result = template.merge(:name => "HOGE", :status => [3, 4])
@@ -100,7 +100,7 @@ WHERE
 EOS
     end
 
-    describe do
+    describe '' do
       before do
         template = TwoWaySQL::Template.parse(@sql)
         data = {
@@ -194,7 +194,7 @@ EOS
 
 
   describe "examples in website" do
-    it do
+    it '' do
   # given SQL string with TwoWaySQL comments
   sql = <<-EOS
     SELECT * FROM emp
@@ -259,7 +259,7 @@ EOS
       begin
         TwoWaySQL::Template.parse(sql)
       rescue Racc::ParseError => e
-        e.to_s.should match(/line:\[10\]/)
+        e.to_s.should =~ /line:\[10\]/
       end
     end
 
@@ -282,8 +282,8 @@ EOS
       begin
         TwoWaySQL::Template.parse(sql)
       rescue Racc::ParseError => e
-        e.to_s.should match(/line:\[12\]/)
-        e.to_s.should match(/OFFSET \/\*ctx\[:offset\]\*\/0/)
+        e.to_s.should =~ /line:\[12\]/
+        e.to_s.should =~ /OFFSET \/\*ctx\[:offset\]\*\/0/
         
       end
     end
@@ -319,7 +319,7 @@ EOS
         TwoWaySQL::Template.parse(sql)
       rescue Racc::ParseError => e
         # unmatched END is at line 17 but value stack indicates open BEGIN statement
-        e.to_s.should match(/line:\[14\]/)
+        e.to_s.should =~ /line:\[14\]/
       end
     end
 

data/spec/learning_regex_spec.rb

@@ -44,7 +44,7 @@ EOS
     end
 
     describe "-- comment start" do
-      it do
+      it '' do
         (@str_re =~ 'foo-bar--ELSE').should_not be_nil
         $1.should == 'foo-bar'
         $'.should == '--ELSE'
@@ -83,17 +83,17 @@ EOS
         $1.should == 'foo/bar'
         $'.should == ' /* hoge */'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo/bar/* hoge */').should_not be_nil
         $1.should == 'foo/bar'
         $'.should == '/* hoge */'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo/bar/* hoge */').should_not be_nil
         $1.should == 'foo/bar'
         $'.should == '/* hoge */'
       end
-      it do
+      it '' do
         (@str_re =~ 'foobar/* hoge */').should_not be_nil
         $1.should == 'foobar'
         $'.should == '/* hoge */'
@@ -106,17 +106,17 @@ EOS
         $1.should == 'foo#bar'
         $'.should == ' #* hoge *#'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo#bar#* hoge *#').should_not be_nil
         $1.should == 'foo#bar'
         $'.should == '#* hoge *#'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo#bar#* hoge *#').should_not be_nil
         $1.should == 'foo#bar'
         $'.should == '#* hoge *#'
       end
-      it do
+      it '' do
         (@str_re =~ 'foobar#* hoge *#').should_not be_nil
         $1.should == 'foobar'
         $'.should == '#* hoge *#'
@@ -124,12 +124,12 @@ EOS
     end
 
     describe "comma" do
-      it do
+      it '' do
         (@str_re =~ 'foo,bar').should_not be_nil
         $1.should == 'foo'
         $'.should == ',bar'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo , bar').should_not be_nil
         $1.should == 'foo'
         $'.should == ' , bar'
@@ -137,12 +137,12 @@ EOS
     end
 
     describe "left paren" do
-      it do
+      it '' do
         (@str_re =~ 'foo(bar').should_not be_nil
         $1.should == 'foo'
         $'.should == '(bar'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo ( bar').should_not be_nil
         $1.should == 'foo'
         $'.should == ' ( bar'
@@ -150,12 +150,12 @@ EOS
     end
 
     describe "right paren" do
-      it do
+      it '' do
         (@str_re =~ 'foo)bar').should_not be_nil
         $1.should == 'foo'
         $'.should == ')bar'
       end
-      it do
+      it '' do
         (@str_re =~ 'foo ) bar').should_not be_nil
         $1.should == 'foo'
         $'.should == ' ) bar'
@@ -170,19 +170,19 @@ EOS
     before do
       @str_re = /(\'(?:[^\']+|\'\')*\')/
     end
-    it do
+    it '' do
       (@str_re =~ "he said 'foo bar' then 'baz'").should_not be_nil
       $1.should == "'foo bar'"
     end
-    it do
+    it '' do
       (@str_re =~ "he said 'Let''s go' then went out").should_not be_nil
       $1.should == "'Let''s go'"
     end
-    it do
+    it '' do
       (@str_re =~ "he said 'foo bar'then went out").should_not be_nil
       $1.should == "'foo bar'"
     end
-    it do
+    it '' do
       sql = "SELECT * FROM emp/*BEGIN*/ WHERE /*IF ctx[:job]*/job = /*ctx[:job]*/'CLERK'/*END*//*IF ctx['deptno']*/ AND deptno = /*ctx[:deptno]*/20/*END*//*END*/"
       (@str_re =~ sql).should_not be_nil
       $1.should == "'CLERK'"
@@ -198,14 +198,14 @@ EOS
     end
 
     describe "matched pair" do
-      it do
+      it '' do
         (@str_re =~ '/*ctx[:job]*/').should_not be_nil
         $1.should == '/'
         $2.should == 'ctx[:job]'
         $'.should == ''
       end
 
-      it do
+      it '' do
         (@str_re =~ '#*ctx[:job]*#').should_not be_nil
         $1.should == '#'
         $2.should == 'ctx[:job]'
@@ -214,14 +214,14 @@ EOS
     end
 
     describe "unmatched pair" do
-      it do
+      it '' do
         (@str_re =~ '/*ctx[:job]*#').should be_nil
         $1.should be_nil
         $2.should be_nil
         $'.should be_nil
       end
       
-      it do
+      it '' do
         (@str_re =~ '/*ctx[:job]*#').should be_nil
         $1.should be_nil
         $2.should be_nil