epoxy 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Erik Hollensbe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= Epoxy - bind data to queries for any query language.
+
+Let me hit ya with some science!
+
+    ep = Epoxy.new("select * from foo where bar=?")
+    binds = %W[foo]
+    bound_query = ep.quote { |x| "'" + binds[x] + "'" }
+    "select * from foo where bar='foo'"
+
+Epoxy handles:
+
+* ? for numbered binds (named binds coming soon!)
+* ?? for a *real* question mark
+* '?' for a *real* question mark
+* comments, weird quoting styles (look at the "holy shit" test for examples)
+* not telling you how to quote your data. This solution works for any query language and any database.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Erik Hollensbe. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "epoxy"
+    gem.summary = %Q{A binding API for query languages that does not depend on any specific database.}
+    gem.description = %Q{Parse binds in SQL or any other data query language, quote, even configure for client-side binding. It all works!}
+    gem.email = "erik@hollensbe.org"
+    gem.homepage = "http://github.com/erikh/epoxy"
+    gem.authors = ["Erik Hollensbe"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+task :to_blog => [:clobber_rdoc, :rdoc] do
+    sh "rm -fr $git/blog/content/docs/epoxy && mv rdoc $git/blog/content/docs/epoxy"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "epoxy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/epoxy.rb

@@ -0,0 +1,90 @@
+# = Epoxy - bind data to queries for any query language.
+# 
+# Let me hit ya with some science!
+# 
+#     ep = Epoxy.new("select * from foo where bar=?")
+#     binds = %W[foo]
+#     bound_query = ep.quote { |x| "'" + binds[x] + "'" }
+#     "select * from foo where bar='foo'"
+# 
+# Epoxy handles:
+# 
+# * ? for numbered binds (named binds coming soon!)
+# * ?? for a *real* question mark
+# * '?' for a *real* question mark
+# * comments, weird quoting styles (look at the "holy shit" test for examples)
+# * not telling you how to quote your data. This solution works for any query language and any database.
+#
+class Epoxy
+    #
+    # Token parser, isolates components of the query into parts to where they
+    # can be managed indepdently.
+    #
+    # Probably not the easiest thing to deal with by itself. Use the standard
+    # methods plox.
+    def self.parse_tokens(query)
+        query.scan(%r{
+            (
+                -- .*                               (?# matches "--" style comments to the end of line or string )
+                |   -                                   (?# matches single "-" )
+                |
+                /[*] .*? [*]/                       (?# matches C-style comments )
+                |   /                                   (?# matches single slash )    
+                |
+                ' ( [^'\\]  |  ''  |  \\. )* '      (?# match strings surrounded by apostophes )
+                |
+                " ( [^"\\]  |  ""  |  \\. )* "      (?# match strings surrounded by " )
+                |
+                \?\??                               (?# match one or two question marks )
+                |
+                [^-/'"?]+                           (?# match all characters except ' " ? - and / )
+
+            )
+        }x).collect(&:first)
+    end
+
+    # tokens generated by Epoxy.parse_tokens. Just use Epoxy#quote for now.
+    attr_reader :tokens
+    # the original query, before quoting.
+    attr_reader :query
+
+    #
+    # Takes a query as a string. The binding rules are as follows:
+    #
+    # * ? for numbered binds (named binds coming soon!)
+    # * ?? for a *real* question mark
+    # * '?' for a *real* question mark
+    # * comments, weird quoting styles are unaffected.
+    #
+    def initialize(query)
+        @query  = query
+        @tokens = self.class.parse_tokens(query) 
+    end
+
+    #
+    # Processes your query for quoting. Provide a block that emulates how your
+    # data should be quoted, and it will yield on each successive bound element
+    # with the index of that element passed.
+    #
+    # *You* are responsible for quoting your data properly. Epoxy just makes it
+    # easier to get the places you need to quote out of the query.
+    #
+    def quote(&block)
+        result = ""
+        bind_pos = 0
+
+        tokens.each do |part|
+            case part
+            when '?'
+                result << block.call(bind_pos)
+                bind_pos += 1
+            when '??'
+                result << "?"
+            else
+                result << part
+            end
+        end
+
+        return result
+    end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'epoxy'
+
+class Test::Unit::TestCase
+end

data/test/test_epoxy.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class TestEpoxy < Test::Unit::TestCase
+    def test_01_basic
+        ep = Epoxy.new("select * from foo where bar=?")
+        assert(ep)
+        assert_kind_of(Epoxy, ep)
+
+        assert_equal("select * from foo where bar='foo'", ep.quote { |x| "'foo'" })
+    end
+
+    def test_02_double_question
+        ep = Epoxy.new("select ?? from foo where bar=?")
+        assert_equal("select ? from foo where bar='foo'", ep.quote { |x| "'foo'" })
+    end
+
+    def test_03_quotes_already
+        ep = Epoxy.new("select * from \"foo\" where bar=?")
+        assert_equal("select * from \"foo\" where bar='foo'", ep.quote { |x| "'foo'" })
+        
+        ep = Epoxy.new("select * from 'foo' where bar=?")
+        assert_equal("select * from 'foo' where bar='foo'", ep.quote { |x| "'foo'" })
+    end
+    
+    def test_04_holy_shit
+        ep = Epoxy.new("select * from \"'foo'\" where bar=?")
+        assert_equal("select * from \"'foo'\" where bar='foo'", ep.quote { |x| "'foo'" })
+        
+        ep = Epoxy.new("select * from E\"'foo'\" where bar=?")
+        assert_equal("select * from E\"'foo'\" where bar='foo'", ep.quote { |x| "'foo'" })
+        
+        ep = Epoxy.new("select * from E\"''foo''\" where bar=?")
+        assert_equal("select * from E\"''foo''\" where bar='foo'", ep.quote { |x| "'foo'" })
+        
+        ep = Epoxy.new("select * from E\"\\''foo''\" where bar=?")
+        assert_equal("select * from E\"\\''foo''\" where bar='foo'", ep.quote { |x| "'foo'" })
+        
+        ep = Epoxy.new("select * from E\"\\''foo\\''\" where bar=?")
+        assert_equal("select * from E\"\\''foo\\''\" where bar='foo'", ep.quote { |x| "'foo'" })
+       
+        ep = Epoxy.new("select * from foo where bar='?'")
+        assert_equal("select * from foo where bar='?'", ep.quote { |x| "'foo'" })
+    end
+
+    def test_05_comments
+        ep = Epoxy.new(%Q{
+                       -- a comment!
+                       select * from foo where bar=?
+                       }.strip)
+        
+        assert_equal(%Q{
+                       -- a comment!
+                       select * from foo where bar='foo'
+                     }.strip, ep.quote { |x| "'foo'" })
+    end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: epoxy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Erik Hollensbe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Parse binds in SQL or any other data query language, quote, even configure for client-side binding. It all works!
+email: erik@hollensbe.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/epoxy.rb
+- test/helper.rb
+- test/test_epoxy.rb
+has_rdoc: true
+homepage: http://github.com/erikh/epoxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A binding API for query languages that does not depend on any specific database.
+test_files: 
+- test/helper.rb
+- test/test_epoxy.rb