sql_query 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bcabea48b51e540272e1d6ab1a0fea40a31062d
-  data.tar.gz: 1872be0b93de9a0102b4d5e4d7376c0fcd4e6cc9
+  metadata.gz: 009df4df82b72078bd0ac55ecc561782d3e807cd
+  data.tar.gz: 40b8ecd5c19a9a926dc28c97aad2ed46e6c488ed
 SHA512:
-  metadata.gz: 063b8846227a1b821f7449936b9036ef2781bf595f90b95f77615d0acd94d4d4e0c688a5063df819f6fd50e615c7aabd87a978c24a7935feed8bfac84316e0b2
-  data.tar.gz: c8e922123a346667fcb97eab1cfbf835f5516c40afa51694239c97cb38b6e4906b75c6b9027e57df3403719a7579a7fff2ad6acd05dab4c76c8d69c552d83eec
+  metadata.gz: a89bc2585da42c4aa61604186efdbefbff685ce035b9349e87363b338e33b53b15b0d282a230c4512e6344c3662932594a6d95c7a027e318fbc8b8f087d2ee35
+  data.tar.gz: 4f560eeb5d953480a2a6493cba61e1b912dcde3640af6a0c0ce1a477b6905df3588c0f8f7d2fe98b62a837a02ad17a8fd06b98ce014bee8536385e2e9cabf915

data/.travis.yml

@@ -7,6 +7,8 @@ rvm:
 
 addons:
   postgresql: '9.3'
+  code_climate:
+    repo_token: 743bf63d7a422064551b35931628682c6cad81a30743edee7ff9ea8af061397d
 
 env:
   - BUILDER=travis

data/CHANGELOG.md

@@ -10,3 +10,6 @@
 
 * [Fixed]
 
+## 0.1.0 / 2015-04-27
+
+* [Added] support for .erb.sql extension

data/README.md

@@ -9,6 +9,7 @@
 Ruby gem to load SQL queries from `.sql.erb` templates using ERB.
 
 It makes working with pure SQL easier with syntax highlighting.
+
 Let's you clean your Ruby code from SQL strings.
 
 ## Installation
@@ -35,10 +36,11 @@ SELECT *
 FROM players
 WHERE email = <%= quote @email %>
 ```
+`quote` method is an alias to `ActiveRecord.connection.quote` method. You can use it to sanitize your variables for SQL.
 
 You can use SQL like this:
 
-```shell
+```ruby
 > query = SqlQuery.new(sql_name: :get_player_by_email, email: 'e@mail.dev')
 
 > query.execute
@@ -69,11 +71,21 @@ WHERE email = 'e@mail.dev'
 ### Methods
 
 - **execute** - executes query and returns result data.
-
 - **explain** - runs explain for SQL from template
 - **sql** - returns SQL string
 - **pretty_sql** - returns SQL string prettier to read in console
-- prepared_for_logs - returns sql string without new lines and multiple whitespaces.
+- **prepared_for_logs** - returns sql string without new lines and multiple whitespaces.
+
+### Configuration
+
+If you don't like default path to your queries you can configure it in initializer.
+
+```ruby
+# config/initializers/sql_query.rb
+SqlQuery.configure do |config|
+  config.path = '/app/sql_templates'
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+task :default => :spec
+
+RSpec::Core::RakeTask.new

data/lib/sql_query.rb

@@ -19,7 +19,7 @@ class SqlQuery
   end
 
   def sql
-    @sql ||= ERB.new(File.read(path)).result(binding)
+    @sql ||= ERB.new(File.read(file_path)).result(binding)
   end
 
   def pretty_sql
@@ -70,10 +70,21 @@ class SqlQuery
     end
   end
 
+  def file_path
+    files = Dir.glob(path)
+    if files.size == 0
+      raise "File not found with name: #{ @sql_name } in #{self.class.config.path}#{ @file_path }"
+    elsif files.size > 1
+      raise "More than one file found: #{ files.join(', ')}"
+    else
+      files.first
+    end
+  end
+
   def path
     root = defined?(Rails) ? Rails.root.to_s : Dir.pwd
     tmp_path = "#{ root }#{self.class.config.path}"
-    tmp_path += "#{ @sql_path }/#{ @sql_name }.sql.erb"
+    tmp_path += "#{ @sql_path }/#{ @sql_name }.{sql.erb,erb.sql}"
     tmp_path
   end
 end

data/spec/sql_queries/duplicated.erb.sql

@@ -0,0 +1 @@
+SELECT 1

data/spec/sql_queries/duplicated.sql.erb

@@ -0,0 +1 @@
+SELECT 2

data/spec/sql_queries/erb_sql.erb.sql

@@ -0,0 +1 @@
+SELECT <%= @fake %>

data/spec/sql_query_spec.rb

@@ -2,14 +2,44 @@ require 'spec_helper'
 
 describe SqlQuery do
 
-  let(:base_options) { { sql_name: :get_player_by_email, email: 'e@mail.dev' } }
-  let(:options) { base_options }
+  let(:options) { { sql_name: :get_player_by_email, email: 'e@mail.dev' } }
   let(:query) { described_class.new(options) }
 
+  describe '#file_path' do
+    context 'when there is only one file with name' do
+      it 'returns path to it' do
+        expect(query.send(:file_path)).to include('get_player_by_email.sql.erb')
+      end
+    end
+    context 'when there are no files' do
+      let(:options) { { sql_name: :not_exists } }
+
+      it 'raises error' do
+        expect{ query.send(:file_path) }.to raise_error('File not found with name: not_exists in /spec/sql_queries')
+      end
+    end
+
+    context 'when there are more than one matching files' do
+      let(:options) { { sql_name: :duplicated } }
+
+      it 'raises error' do
+        expect{ query.send(:file_path) }.to raise_error.with_message(/More than one file found:/)
+      end
+    end
+  end
+
   describe '#sql' do
     it 'returns query string' do
       expect(query.sql).to eq "SELECT *\nFROM players\nWHERE email = 'e@mail.dev'\n"
     end
+
+    context 'when file is .erb.sql' do
+      let(:options) { { sql_name: :erb_sql, fake: 12 } }
+
+      it 'returns query string' do
+        expect(query.sql).to eq "SELECT 12\n"
+      end
+    end
   end
 
   describe '#pretty_sql' do

data/sql_query.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "sql_query"
-  spec.version       = "0.0.2"
+  spec.version       = "0.1.0"
   spec.authors       = ["sufleR"]
   spec.email         = ["szymon.fracczak@netguru.co"]
   spec.summary       = %q{Ruby gem to load and execute SQL queries from `.sql.erb` templates}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_query
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - sufleR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -139,6 +139,9 @@ files:
 - Rakefile
 - lib/sql_query.rb
 - spec/spec_helper.rb
+- spec/sql_queries/duplicated.erb.sql
+- spec/sql_queries/duplicated.sql.erb
+- spec/sql_queries/erb_sql.erb.sql
 - spec/sql_queries/get_player_by_email.sql.erb
 - spec/sql_query_spec.rb
 - sql_query.gemspec
@@ -168,5 +171,8 @@ specification_version: 4
 summary: Ruby gem to load and execute SQL queries from `.sql.erb` templates
 test_files:
 - spec/spec_helper.rb
+- spec/sql_queries/duplicated.erb.sql
+- spec/sql_queries/duplicated.sql.erb
+- spec/sql_queries/erb_sql.erb.sql
 - spec/sql_queries/get_player_by_email.sql.erb
 - spec/sql_query_spec.rb