jordi-find_by_sql_file 0.9.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Jordi Bunster <jordi@bunster.org>
+
+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.markdown

@@ -0,0 +1,55 @@
+# Find by SQL file
+
+This plugin extends the API of `ActiveRecord::Base.find_by_sql`.
+
+## Usage
+
+Instead of passing the SQL statement as a string...
+
+    Elephant.find_by_sql "SELECT * FROM elephants WHERE weight='massive'"
+
+You can pass a symbol that refers to a query file stored in
+`RAILS_ROOT`/app/queries/`TABLE_NAME`/`SYMBOL`.sql
+
+    Elephant.find_by_sql :massive_weight
+
+## A Warning
+
+Besides the warnings on the `ERB` section below (don't ignore those), this
+code is not tested at all, and has no track record whatsoever. So there,
+beware.
+
+## Motivation
+
+The advantage of the latter approach is that the SQL file can be properly
+indented and commented (the indentation and comments are stripped from the
+logs.)
+
+It's possible to pass named bind variables, much like in the conditions
+parameter of `ActiveRecord::Base.find`, by passing a hash as the second
+parameter, like so:
+
+    Elephant.find_by_sql :specifics, :color => 'grey', :weight => 6800
+
+## ERB (be careful)
+
+It is also possible to use `ERB` inside the query file, but **beware!**
+Unlike the named bind variables, any data passed in via the ERB method is not
+properly quoted by the database adapter, leaving open the possibility of
+**SQL injection**. 99.9% of the time, **you will _NOT_ need this**.
+
+Here's an artificial (but easy to explain) example of how the
+(very dangerous!) `ERB` _feature_ works:
+
+    Elephant.find_by_sql :single_value, :value   => 'grey',
+                                        :inject! => { :field => 'color' }
+
+The call above replaces the bind variable `:value` inside the SQL file,
+but it also populates the instance variable `@field` with `"color"`, which
+can then be used with the usual ERB syntax, like so:
+
+    SELECT <%= @field -%> FROM elephants WHERE <%= @field -%> = :value
+
+### Legal
+
+Copyright (c) 2008 Jordi Bunster, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the find_by_sql_file plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the find_by_sql_file plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FindBySqlFile'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/find_by_sql_file.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name        = 'find_by_sql_file'
+  s.version     = '0.9.0'
+  s.date        = '2008-10-02'
+
+  s.author      = 'Jordi Bunster'
+  s.email       = 'jordi@bunster.org'
+  s.homepage    = 'http://github.com/jordi/find_by_sql_file'
+
+  s.summary     = "Extension to ActiveRecord's find_by_sql to use SQL files"
+  s.description = %{ This ActiveRecord extension lets you pass a symbol to
+                     ActiveRecord::Base#find_by_sql, which refers to a query
+                     file saved under app/queries/. Variable replacement
+                     and ERB are available, and comments and indentation are
+                     stripped. }.strip!.gsub! /\s+/, ' '
+
+  s.test_files  = %w[ test test/find_by_sql_file_test.rb ]
+  s.files       = %w[ MIT-LICENSE
+                      README.markdown
+                      Rakefile
+                      find_by_sql_file.gemspec
+                      init.rb
+                      install.rb
+                      lib
+                      lib/bunster
+                      lib/bunster/erb_jacket.rb
+                      lib/bunster/find_by_sql_file.rb
+                      rails
+                      rails/init.rb ]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README.markdown        ]
+  s.rdoc_options     = %w[ --main README.markdown ]
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rails/init'

data/install.rb

@@ -0,0 +1,5 @@
+unless File.exist?(Bunster::FindBySqlFile::SQL_PATH) &&
+       File.directory?(Bunster::FindBySqlFile::SQL_PATH)
+
+  FileUtils.mkdir_p Bunster::FindBySqlFile::SQL_PATH
+end

data/lib/bunster/erb_jacket.rb

@@ -0,0 +1,23 @@
+require 'erb'
+
+module Bunster # :nodoc:
+
+  # This makes it a tad simpler to create a clean ERB binding context. It
+  # works like so:
+  #
+  # ERBJacket.wrap "A Foo is: <%= @foo -%>", :foo => 'not a bar'
+  #
+  class ERBJacket
+    def initialize(hash) # :nodoc:
+      hash.each { |k, v| instance_variable_set('@' + k.to_s, v) }
+    end
+
+    def wrap(erb_template) # :nodoc:
+      ::ERB.new(erb_template, nil, '-').result binding
+    end
+
+    def self.wrap(erb_template = '', instance_variables = {}) # :nodoc:
+      new(instance_variables).wrap erb_template
+    end
+  end
+end

data/lib/bunster/find_by_sql_file.rb

@@ -0,0 +1,38 @@
+module Bunster # :nodoc:
+  module FindBySqlFile
+
+    # The path to the directory query queries will be found, organized
+    # inside directories named like their main tables (or 'application'
+    # for shared queries)
+    SQL_PATH = File.join RAILS_ROOT, 'app', 'queries'
+
+    def find_by_sql_with_sql_file(query_or_symbol, opts = {}) # :nodoc:
+      find_by_sql_without_sql_file sql_file(query_or_symbol, opts)
+    end
+
+    def count_by_sql_with_sql_file(query_or_symbol, opts = {}) # :nodoc:
+      count_by_sql_without_sql_file sql_file(query_or_symbol, opts)
+    end
+
+    def sql_file(query_or_symbol, opts = {}) # :nodoc:
+      if query_or_symbol.is_a? Symbol
+
+        file_name = File.join SQL_PATH,
+          (table_name rescue 'application'), (query_or_symbol.to_s + '.sql')
+
+        bound_variables = HashWithIndifferentAccess.new(opts).symbolize_keys!
+        injected_locals = bound_variables.delete(:inject!) || []
+
+        query = ERBJacket.wrap File.read(file_name), injected_locals
+        query = replace_named_bind_variables(query, bound_variables)
+
+        query.gsub(/--.*/, '').squish!
+      else
+        raise %' Additional parameters only supported when using a query
+          file (pass a symbol, not a string) '.squish! unless opts.blank?
+
+        query_or_symbol
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,8 @@
+require 'bunster/find_by_sql_file'
+
+class << ActiveRecord::Base
+  include Bunster::FindBySqlFile
+
+  alias_method_chain :find_by_sql,  :sql_file
+  alias_method_chain :count_by_sql, :sql_file
+end

data/test/find_by_sql_file_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class FindBySqlFileTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: jordi-find_by_sql_file
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Jordi Bunster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This ActiveRecord extension lets you pass a symbol to ActiveRecord::Base#find_by_sql, which refers to a query file saved under app/queries/. Variable replacement and ERB are available, and comments and indentation are stripped.
+email: jordi@bunster.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- find_by_sql_file.gemspec
+- init.rb
+- install.rb
+- lib
+- lib/bunster
+- lib/bunster/erb_jacket.rb
+- lib/bunster/find_by_sql_file.rb
+- rails
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/jordi/find_by_sql_file
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Extension to ActiveRecord's find_by_sql to use SQL files
+test_files: 
+- test
+- test/find_by_sql_file_test.rb