sql_query 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 009df4df82b72078bd0ac55ecc561782d3e807cd
-  data.tar.gz: 40b8ecd5c19a9a926dc28c97aad2ed46e6c488ed
+  metadata.gz: dd5a1fd8db226ffab78b0ed0cfd6c52bdcb0be54
+  data.tar.gz: 6b7e65e29f6d9feb80b1d8f0969e429c1be2687b
 SHA512:
-  metadata.gz: a89bc2585da42c4aa61604186efdbefbff685ce035b9349e87363b338e33b53b15b0d282a230c4512e6344c3662932594a6d95c7a027e318fbc8b8f087d2ee35
-  data.tar.gz: 4f560eeb5d953480a2a6493cba61e1b912dcde3640af6a0c0ce1a477b6905df3588c0f8f7d2fe98b62a837a02ad17a8fd06b98ce014bee8536385e2e9cabf915
+  metadata.gz: c9c888ada8499947bec7a29225b837a4d834522eec0ebc34804d61570cb946147a287a634be18965294a81e54341797a1cc7b052e3a24a58259d23b3c4cc315d
+  data.tar.gz: 9d748e7bb3b793e4b0f717568c42872d040227f1ca2b83ccd5cc2e2f1bcfae11d7555bdb205b56ded42116a24d5351ff8159419bcee4f720eff7a3c04d318d08

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # SqlQuery change log
 
-## 0.0.1 / Unreleased
+## 0.2.1 / Unreleased
 
 * [Added]
 
@@ -10,6 +10,16 @@
 
 * [Fixed]
 
+## 0.2.0 / 2015-05-01
+
+* [Added] First argument in initialize as sql file name with path
+
+* [Deprecated] 
+
+* [Removed] sql_name and sql_path in options hash
+
+* [Fixed]
+
 ## 0.1.0 / 2015-04-27
 
 * [Added] support for .erb.sql extension

data/README.md

@@ -6,12 +6,14 @@
 
 # SqlQuery
 
-Ruby gem to load SQL queries from `.sql.erb` templates using ERB.
+Ruby gem to load SQL queries from templates using ERB.
 
 It makes working with pure SQL easier with syntax highlighting.
 
 Let's you clean your Ruby code from SQL strings.
 
+Supported extensions: `.sql.erb` or `.erb.sql`
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,7 +43,7 @@ WHERE email = <%= quote @email %>
 You can use SQL like this:
 
 ```ruby
-> query = SqlQuery.new(sql_name: :get_player_by_email, email: 'e@mail.dev')
+> query = SqlQuery.new(:get_player_by_email, email: 'e@mail.dev')
 
 > query.execute
    (0.6ms)  SELECT * FROM players WHERE email = 'e@mail.dev'
@@ -68,6 +70,15 @@ FROM players
 WHERE email = 'e@mail.dev'
 ```
 
+### initialization
+
+If you need to have nested paths to your queries like ```player/get_by_email``` just use string instead of symbol as file name.
+
+Example:
+```ruby
+SqlQuery.new('player/get_by_email', email: 'e@mail.dev')
+```
+
 ### Methods
 
 - **execute** - executes query and returns result data.

data/lib/sql_query.rb

@@ -3,7 +3,11 @@ require 'erb'
 class SqlQuery
   attr_reader :connection
 
-  def initialize(options = {})
+  def initialize(file_name, options = {})
+    unless file_name.is_a?(String) || file_name.is_a?(Symbol)
+      fail ArgumentError, 'SQL file name should be String or Symbol'
+    end
+    @sql_filename = file_name
     prepare_variables(options)
     @connection = ActiveRecord::Base.connection
   end
@@ -73,7 +77,7 @@ class SqlQuery
   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 }"
+      raise "File not found: #{ @sql_filename }"
     elsif files.size > 1
       raise "More than one file found: #{ files.join(', ')}"
     else
@@ -84,7 +88,7 @@ class SqlQuery
   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,erb.sql}"
+    tmp_path += "/#{ @sql_filename }.{sql.erb,erb.sql}"
     tmp_path
   end
 end

data/spec/sql_query_spec.rb

@@ -2,8 +2,32 @@ require 'spec_helper'
 
 describe SqlQuery do
 
-  let(:options) { { sql_name: :get_player_by_email, email: 'e@mail.dev' } }
-  let(:query) { described_class.new(options) }
+  let(:options) { { email: 'e@mail.dev' } }
+  let(:file_name) { :get_player_by_email }
+  let(:query) { described_class.new(file_name, options) }
+
+  describe '#initialize' do
+
+    it 'sets instance variables for all options' do
+      expect(query.instance_variable_get(:@email)).to eq 'e@mail.dev'
+    end
+
+    context 'when options are set not in parentheses' do
+      let(:query) { described_class.new(file_name, email: 'e@mail.dev') }
+
+      it 'sets instance variables for all options' do
+        expect(query.instance_variable_get(:@email)).to eq 'e@mail.dev'
+      end
+    end
+
+    context 'file_name argument is not Symbol or String' do
+      let(:file_name) { { do: 'something' } }
+
+      it 'raises ArgumentError' do
+        expect{ query }.to raise_error(ArgumentError, 'SQL file name should be String or Symbol')
+      end
+    end
+  end
 
   describe '#file_path' do
     context 'when there is only one file with name' do
@@ -12,15 +36,15 @@ describe SqlQuery do
       end
     end
     context 'when there are no files' do
-      let(:options) { { sql_name: :not_exists } }
+      let(:file_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')
+        expect{ query.send(:file_path) }.to raise_error('File not found: not_exists')
       end
     end
 
     context 'when there are more than one matching files' do
-      let(:options) { { sql_name: :duplicated } }
+      let(:file_name) { :duplicated }
 
       it 'raises error' do
         expect{ query.send(:file_path) }.to raise_error.with_message(/More than one file found:/)
@@ -34,7 +58,8 @@ describe SqlQuery do
     end
 
     context 'when file is .erb.sql' do
-      let(:options) { { sql_name: :erb_sql, fake: 12 } }
+      let(:options) { { fake: 12 } }
+      let(:file_name) { :erb_sql }
 
       it 'returns query string' do
         expect(query.sql).to eq "SELECT 12\n"
@@ -65,6 +90,7 @@ describe SqlQuery do
         "INSERT INTO players (email) VALUES ('e@mail.dev')"
       )
     end
+
     after do
       ActiveRecord::Base.connection.execute(
         "DELETE FROM players"

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.1.0"
+  spec.version       = "0.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sufleR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord