jordi-find_by_sql_file 0.9.4 → 0.9.5

data/Rakefile

@@ -20,3 +20,17 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc 'Measures test coverage using rcov'
+task :rcov do
+  rm_f 'coverage'
+  rm_f 'coverage.data'
+
+  rcov = %{ rcov --aggregate coverage.data --text-summary
+    --include lib
+    --exclude /Library/Ruby
+  }.strip!.gsub! /\s+/, ' '
+
+  system("#{rcov} --html #{Dir.glob('test/**/*_test.rb').join(' ')}")
+  system('open coverage/index.html') if PLATFORM['darwin']
+end

data/WHATSNEW

@@ -0,0 +1,6 @@
+* What's new in version 0.9.5 (2008-10-06):
+
+  - Added a WHATSNEW file :)
+  - Added a few behaviour tests
+  - Added ActiveRecord::Base#find_one_by_sql(*args) as sugar for
+    ActiveRecord::Base#find_by_sql(*args).first

data/find_by_sql_file.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'find_by_sql_file'
-  s.version     = '0.9.4'
-  s.date        = '2008-10-03'
+  s.version     = '0.9.5'
+  s.date        = '2008-10-06'
 
   s.author      = 'Jordi Bunster'
   s.email       = 'jordi@bunster.org'
@@ -14,21 +14,38 @@ Gem::Specification.new do |s|
                      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
-                      lib/find_by_sql_file.rb
-                      lib/jordi-find_by_sql_file.rb
-                      rails
-                      rails/init.rb ]
+  s.test_files  = %w[
+    test
+    test/database.yml
+    test/find_by_sql_file_test.rb
+    test/mock_rails_root
+    test/mock_rails_root/app
+    test/mock_rails_root/app/queries
+    test/mock_rails_root/app/queries/articles
+    test/mock_rails_root/app/queries/articles/all.sql
+    test/mock_rails_root/app/queries/articles/count_all.sql
+    test/mock_rails_root/app/queries/articles/last_updated.sql
+    test/mock_rails_root/app/queries/articles/with_erb_fields.sql
+    test/mock_rails_root/app/queries/articles/with_variables.sql
+    test/schema.rb
+    test/test_helper.rb
+  ]
+
+  s.files = %w[ MIT-LICENSE
+                README.markdown
+                Rakefile
+                WHATSNEW
+                find_by_sql_file.gemspec
+                init.rb
+                install.rb
+                lib
+                lib/bunster
+                lib/bunster/erb_jacket.rb
+                lib/bunster/find_by_sql_file.rb
+                lib/find_by_sql_file.rb
+                lib/jordi-find_by_sql_file.rb
+                rails
+                rails/init.rb ]
 
   s.has_rdoc         = true
   s.extra_rdoc_files = %w[ README.markdown        ]

data/lib/bunster/find_by_sql_file.rb

@@ -1,6 +1,7 @@
+require 'bunster/erb_jacket'
+
 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)
@@ -23,7 +24,7 @@ module Bunster # :nodoc:
         bound_variables = HashWithIndifferentAccess.new(opts).symbolize_keys!
         injected_locals = bound_variables.delete(:inject!) || []
 
-        query = ERBJacket.wrap File.read(file_name), injected_locals
+        query = Bunster::ERBJacket.wrap File.read(file_name), injected_locals
         query = replace_named_bind_variables(query, bound_variables)
 
         query.gsub(/--.*/, '').squish!
@@ -34,5 +35,10 @@ module Bunster # :nodoc:
         query_or_symbol
       end
     end
+
+    # The equivalent of ActiveRecord::Base#find_by_sql(*args).first
+    def find_one_by_sql(*args)
+      find_by_sql(*args).first
+    end
   end
 end

data/test/database.yml

@@ -0,0 +1,3 @@
+adapter:  sqlite3
+database: find_by_sql_file_plugin.sqlite3.db
+

data/test/find_by_sql_file_test.rb

@@ -1,8 +1,70 @@
 require 'test/unit'
+require 'rubygems'
+
+begin
+  require 'redgreen'
+rescue LoadError
+  puts "Install the 'redgreen' gem to get color output"
+end
+
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 class FindBySqlFileTest < Test::Unit::TestCase
-  # Replace this with your real tests.
-  def test_this_plugin
-    flunk
+
+  def test_counting_by_sql_file
+    assert_equal Article.count_by_sql(:count_all), Article.count
+  end
+
+  def test_find_all
+    assert_equal Article.find_by_sql(:all), Article.find(:all)
+  end
+
+  def test_find_last_updated
+    assert_equal Article.find_one_by_sql(:last_updated),
+                 Article.find(:first, :order => 'updated_at DESC')
+  end
+
+  def test_named_bind_variables
+    assert_equal Article.find_by_sql(:with_variables,
+                   :published  => @articles.last.published,
+                   :created_on => @articles.last.created_on),
+                 Article.find(:all, :conditions => {
+                   :published  => @articles.last.published,
+                   :created_on => @articles.last.created_on })
+  end
+
+  def test_erb_injection
+    fields = 'id, title, published'
+
+    assert_equal(
+      Article.find_by_sql(:with_erb_fields,
+        :inject! => { :select => fields }).map  { |a| a.attributes },
+      Article.find(:all, :select => fields).map { |a| a.attributes } )
+  end
+
+  def setup
+    @articles = []
+
+    @articles << Article.new(:title      => 'Lorem ipsum dolor sit amet',
+                             :published  => true,
+                             :created_on => '1969-01-27',
+                             :updated_at => '2008-10-06 12:02:32')
+
+    @articles << Article.new(:title      => 'Consectetur adipisicing elit',
+                             :published  => false,
+                             :created_on => '1969-12-30',
+                             :updated_at => '2008-10-06 12:02:32')
+
+    @articles << Article.new(:title      => 'Sed do eiusmod tempor incididunt',
+                             :published  => false,
+                             :created_on => '1969-01-15',
+                             :updated_at => '2008-10-06 12:02:32')
+
+    @articles << Article.new(:title      => 'Ut enim ad minim veniam',
+                             :published  => false,
+                             :created_on => '1999-12-13',
+                             :updated_at => '2012-10-06 12:02:32')
+
+    @articles.each { |a| a.save }
   end
 end

data/test/mock_rails_root/app/queries/articles/all.sql

@@ -0,0 +1,3 @@
+-- This query gets all of the articles
+SELECT * FROM articles
+

data/test/mock_rails_root/app/queries/articles/count_all.sql

@@ -0,0 +1,2 @@
+-- Count all of the articles using SQL
+SELECT COUNT(*) FROM articles

data/test/mock_rails_root/app/queries/articles/last_updated.sql

@@ -0,0 +1,3 @@
+SELECT * FROM articles
+  ORDER BY updated_at DESC -- Gets the last one updated
+  LIMIT 1

data/test/mock_rails_root/app/queries/articles/with_erb_fields.sql

@@ -0,0 +1,3 @@
+-- Gets certain fields from articles using ERB to pass the SELECT fragment
+
+SELECT <%= @select -%> FROM articles

data/test/mock_rails_root/app/queries/articles/with_variables.sql

@@ -0,0 +1,4 @@
+-- Gets articles with given values for 'created_on' and 'published'
+
+SELECT * FROM articles WHERE created_on = :created_on
+                         AND published  = :published

data/test/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define :version => 1 do
+
+  create_table :articles, :force => true do |article|
+    article.string    :title
+    article.boolean   :published
+    article.date      :created_on
+    article.timestamp :updated_at
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+require 'rubygems'
+require 'active_record'
+
+def establish_connection!
+  database_config_file   = File.join File.dirname(__FILE__), 'database.yml'
+  database_configuration = YAML::load File.open(database_config_file)
+
+  ActiveRecord::Base.establish_connection database_configuration
+end
+
+def create_tables!
+  load File.join( File.dirname(__FILE__), 'schema.rb' )
+end
+
+class Article < ActiveRecord::Base
+end
+
+establish_connection!
+create_tables!
+RAILS_ROOT = File.join( File.dirname(__FILE__), 'mock_rails_root' )
+require File.join(File.dirname(__FILE__), '..', 'lib', 'find_by_sql_file')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jordi-find_by_sql_file
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - Jordi Bunster
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-03 00:00:00 -07:00
+date: 2008-10-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,7 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
+- WHATSNEW
 - find_by_sql_file.gemspec
 - init.rb
 - install.rb
@@ -65,4 +66,16 @@ specification_version: 2
 summary: Extension to ActiveRecord's find_by_sql to use SQL files
 test_files: 
 - test
+- test/database.yml
 - test/find_by_sql_file_test.rb
+- test/mock_rails_root
+- test/mock_rails_root/app
+- test/mock_rails_root/app/queries
+- test/mock_rails_root/app/queries/articles
+- test/mock_rails_root/app/queries/articles/all.sql
+- test/mock_rails_root/app/queries/articles/count_all.sql
+- test/mock_rails_root/app/queries/articles/last_updated.sql
+- test/mock_rails_root/app/queries/articles/with_erb_fields.sql
+- test/mock_rails_root/app/queries/articles/with_variables.sql
+- test/schema.rb
+- test/test_helper.rb