simple_query_tool 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Capital Thought.
+
+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.textile

@@ -0,0 +1,8 @@
+h1. Simple Query Tool
+
+This is starter code for building Presenters and other classes that generate custom SQL.  It gives you a light wrapper for ActiveRecord and some useful behavior for instantiating objects. It's perfect for search interfaces.
+
+Inspired by Jay Fields' Presenter post:
+http://blog.jayfields.com/2007/03/rails-presenter-pattern.html
+
+Copyright (c) 2009 Capital Thought, released under the MIT license.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "simple_query_tool"
+    gemspec.summary = "Starter code for building Presenters and other classes that generate custom SQL"
+    gemspec.description = "Including this module gives you a light wrapper for ActiveRecord and some useful behavior for instantiating objects that generate custom SQL queries, perfect for search interfaces."
+    gemspec.email = "mike@otherinbox.com"
+    gemspec.homepage = "http://github.com/otherinbox/simple_logger"
+    gemspec.authors = ["Mike Subelsky"]
+    gemspec.add_development_dependency "mocha"
+    gemspec.test_files = %w(test/simple_query_tool_test.rb)
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

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

data/lib/simple_query_tool.rb

@@ -0,0 +1,54 @@
+require 'active_record'
+
+module SimpleQueryTool
+
+  # will try to default to ActiveRecord::Base components if you don't specify an adapter
+  attr_accessor :db_adapter
+  
+  def initialize(params={})
+    params.each_pair { |attrib, value| instance_variable_set :"@#{attrib}", value }
+    @db_adapter ||= ActiveRecord::Base
+    super()
+  end
+      
+  private
+  
+  def connection
+    db_adapter.connection
+  end                     
+  
+  def select_all_with_query_cache(sql) 
+    connection.select_all_with_query_cache(prepare(sql))
+  end
+
+  def select_all(sql)
+    connection.select_all(prepare(sql))
+  end
+
+  def select_one(sql)
+    connection.select_one(prepare(sql))
+  end
+
+  def select_rows(sql)
+    connection.select_rows(prepare(sql))
+  end
+
+  def select_value(sql)
+    connection.select_value(prepare(sql))
+  end
+
+  def select_values(sql)
+    connection.select_values(prepare(sql))
+  end
+
+  def quote(p)
+    db_adapter.quote_value(p)
+  end
+
+  def prepare(sql)
+    sql = sql.to_a
+    sql.unshift("SET statement_timeout = #{@statement_timeout};") if @statement_timeout
+    sql.join(' ')
+  end
+
+end

data/simple_query_tool.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_query_tool}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Subelsky"]
+  s.date = %q{2010-01-04}
+  s.description = %q{Including this module gives you a light wrapper for ActiveRecord and some useful behavior for instantiating objects that generate custom SQL queries, perfect for search interfaces.}
+  s.email = %q{mike@otherinbox.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/simple_query_tool.rb",
+     "simple_query_tool.gemspec",
+     "test/simple_query_tool_test.rb"
+  ]
+  s.homepage = %q{http://github.com/otherinbox/simple_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Starter code for building Presenters and other classes that generate custom SQL}
+  s.test_files = [
+    "test/simple_query_tool_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/test/simple_query_tool_test.rb

@@ -0,0 +1,93 @@
+#!/usr/local/bin/ruby
+require 'rubygems'
+require 'test/unit'
+require 'mocha' 
+require File.join(File.dirname(__FILE__),'..','lib','simple_query_tool')
+
+class TestHash < Test::Unit::TestCase
+
+  class Foo
+    include SimpleQueryTool
+  end
+  
+  def test_should_set_instance_variables_on_the_fly
+    f = Foo.new(:a => 1, :b => 2, :c => 3,:db_connection => mock,:db_quoter => mock)
+    assert_equal [1,2,3], f.instance_eval { [@a,@b,@c] }
+  end
+  
+  def test_should_set_db_adapter_to_given_variable
+    adapter = mock()
+    f = Foo.new(:db_adapter => adapter)
+    assert_equal adapter,f.db_adapter
+  end
+  
+  def test_should_default_to_using_active_record
+    a = Class.new { include SimpleQueryTool }
+    assert_equal ActiveRecord::Base,a.new.db_adapter
+  end
+
+  def test_should_pass_on_string_sql_queries
+    conn = mock("connection")         
+    adapter = mock("adapter")
+    adapter.stubs(:connection).returns(conn)
+    f = Foo.new(:db_adapter => adapter)    
+
+    methods = [:select_all_with_query_cache,:select_all,:select_one,:select_rows,:select_value,:select_values]
+               
+    methods.each do |method|
+      conn.expects(method).with("SELECT * FROM messages")
+    end
+    
+    f.instance_eval do
+      methods.each do |method|
+        send(method,"SELECT * FROM messages")
+      end
+    end
+  end
+
+  def test_should_join_and_pass_on_array_sql_queries
+    conn = mock("connection")         
+    adapter = mock("adapter")
+    adapter.stubs(:connection).returns(conn)
+    f = Foo.new(:db_adapter => adapter)    
+
+    methods = [:select_all_with_query_cache,:select_all,:select_one,:select_rows,:select_value,:select_values]
+               
+    methods.each do |method|
+      conn.expects(method).with("SELECT * FROM labels WHERE tag = 'Color'")
+    end
+
+    f.instance_eval do
+      methods.each do |method|
+        send(method,["SELECT * FROM labels","WHERE tag = 'Color'"])
+      end
+    end
+  end
+  
+  def test_should_quote_variables
+    adapter = mock("adapter")
+    adapter.expects(:quote_value).returns("'quote_me'")
+    f = Foo.new(:db_adapter => adapter)    
+
+    assert_equal "'quote_me'", f.instance_eval { quote("quote_me") }
+  end
+
+  def test_should_prepend_statement_timeout_if_specified
+    conn = mock("connection")         
+    adapter = mock("adapter")
+    adapter.stubs(:connection).returns(conn)   
+    
+    c = Class.new do
+      include SimpleQueryTool
+    end
+    
+    i = c.new(:db_adapter => adapter,:statement_timeout => 1000)
+
+    conn.expects(:select_all).with("SET statement_timeout = 1000; SELECT * FROM labels WHERE tag = 'Green'")
+
+    i.instance_eval do
+      select_all("SELECT * FROM labels WHERE tag = 'Green'")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: simple_query_tool
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Subelsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Including this module gives you a light wrapper for ActiveRecord and some useful behavior for instantiating objects that generate custom SQL queries, perfect for search interfaces.
+email: mike@otherinbox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/simple_query_tool.rb
+- simple_query_tool.gemspec
+- test/simple_query_tool_test.rb
+has_rdoc: true
+homepage: http://github.com/otherinbox/simple_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Starter code for building Presenters and other classes that generate custom SQL
+test_files: 
+- test/simple_query_tool_test.rb