sql_query 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748c4c52de904df3008bce29a438a87fb35999a7
-  data.tar.gz: d6f2f18bd2182837f558290c57119fe33137272d
+  metadata.gz: bee55d0da7461b026132a7282340f29ad1a17768
+  data.tar.gz: 0460233cafaf0331980a61e538fcf01058d76511
 SHA512:
-  metadata.gz: c72a0c1ddbe997fa7508b03abe76724ba9cb2c0beaf193668c2dbbca397c1e925810cc267be4b410610ea64b1d018111fac214499dc17caf869e1070b7dddcf2
-  data.tar.gz: c25bc31e5266d0ae7ec96b559e42a08ccc604aeb996852fc575d36591fe04ed7d318b12778c66f0f4d2f812020cb60e639086666a7250d0987ac74af6684c910
+  metadata.gz: 8bb059c5e3f304165e409f8ec22fbce07f1e9a13cc6793242dd2bb63f0bc3bdf527e339e72fb294468a750abd9838817d86f68e00419b418da50f4abb4536fba
+  data.tar.gz: 8509f4a76b9e9772e0eda5e8db5ea58bf5e5d173210609e49c272ab88d965582f3ea90dd3824a85bc9f73e4eab2cffae08e8b4809388bb028b7cad30f47e2b9b

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - '1.9.3'
   - '2.0.0'
   - '2.1.5'
-  - '2.2.1'
+  - '2.2.3'
 
 addons:
   postgresql: '9.3'

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # SqlQuery change log
 
-## 0.2.2 / Unreleased
+## 0.3.1 / Unreleased
 
 * [Added]
 
@@ -10,6 +10,10 @@
 
 * [Fixed]
 
+## 0.3.0 / 2015-12-10
+
+* [Added] support for partials
+
 ## 0.2.1 / 2015-05-01
 
 * [Added] support for activerecord >= 3.2

data/README.md

@@ -97,6 +97,32 @@ SqlQuery.configure do |config|
   config.path = '/app/sql_templates'
 end
 ```
+### Partials
+
+You can prepare part of sql query in partial file and reuse it in multiple queries.
+
+Partial file should start with '_'. 
+
+Example:
+
+```sql
+# app/sql_queries/_email_partial.sql.erb
+players.email = <%= quote @email %>
+```
+
+and use this partial like this:
+
+```sql
+SELECT *
+FROM players
+WHERE <%= partial :email_partial %>
+```
+
+## Examples
+
+Check examples folder for some usefull queries.
+
+If you have some examples to share please make pull request.
 
 ## Contributing
 

data/examples/README.md

@@ -0,0 +1,10 @@
+### File list:
+
+* __distinct_values.sql.erb__ - implements "loose indexscan" in postgresql. More info [https://wiki.postgresql.org/wiki/Loose_indexscan](https://wiki.postgresql.org/wiki/Loose_indexscan)
+
+```
+SqlQuery.new(:distinct_values, table_name: :players, column_name: :player_type).execute
+
+```
+### 
+

data/examples/distinct_values.sql.erb

@@ -0,0 +1,14 @@
+WITH RECURSIVE t AS (
+  SELECT MIN(<%= @column_name %>) AS <%= @column_name %>
+  FROM <%= @table_name %>
+  UNION ALL
+  SELECT (
+    SELECT MIN(<%= @column_name %>) FROM <%= @table_name %>
+    WHERE <%= @column_name %> > t.<%= @column_name %>)
+  FROM t WHERE t.<%= @column_name %> IS NOT NULL
+)
+SELECT <%= @column_name %> FROM t WHERE <%= @column_name %> IS NOT NULL
+<% if @with_nulls %>
+  UNION ALL
+  SELECT NULL WHERE EXISTS(SELECT 1 FROM <%= @table_name %> WHERE <%= @column_name %> IS NULL)
+<% end %>

data/lib/sql_query.rb

@@ -8,7 +8,8 @@ class SqlQuery
       fail ArgumentError, 'SQL file name should be String or Symbol'
     end
     @sql_filename = file_name
-    prepare_variables(options)
+    @options = options
+    prepare_variables
     @connection = ActiveRecord::Base.connection
   end
 
@@ -38,6 +39,13 @@ class SqlQuery
     sql.gsub(/(\n|\s)+/,' ')
   end
 
+  def partial(partial_name, partial_options = {})
+    path, file_name = split_to_path_and_name(partial_name)
+    self.class.new("#{path}/_#{file_name}",
+                   @options.merge(partial_options),
+                  ).sql
+  end
+
   def self.config=(value)
     @config = value
   end
@@ -60,6 +68,15 @@ class SqlQuery
 
   private
 
+  def split_to_path_and_name(file)
+    if file.is_a?(Symbol)
+      ['', file.to_s]
+    else
+      parts = file.rpartition('/')
+      [parts.first, parts.last]
+    end
+  end
+
   def pretty(value)
     # override inspect to be more human readable from console
     # code copy from ActiveRecord
@@ -68,8 +85,8 @@ class SqlQuery
     value
   end
 
-  def prepare_variables(options)
-    options.each do |k, v|
+  def prepare_variables
+    @options.each do |k, v|
       instance_variable_set("@#{k}", v)
     end
   end
@@ -77,7 +94,7 @@ class SqlQuery
   def file_path
     files = Dir.glob(path)
     if files.size == 0
-      raise "File not found: #{ @sql_filename }"
+      raise "File not found: #{@sql_filename}"
     elsif files.size > 1
       raise "More than one file found: #{ files.join(', ')}"
     else
@@ -87,8 +104,8 @@ class SqlQuery
 
   def path
     root = defined?(Rails) ? Rails.root.to_s : Dir.pwd
-    tmp_path = "#{ root }#{self.class.config.path}"
-    tmp_path += "/#{ @sql_filename }.{sql.erb,erb.sql}"
+    tmp_path = "#{root}#{self.class.config.path}"
+    tmp_path += "/#{@sql_filename}.{sql.erb,erb.sql}"
     tmp_path
   end
 end

data/spec/sql_queries/_email_partial.sql.erb

@@ -0,0 +1 @@
+players.email = <%= quote @email %>

data/spec/sql_queries/get_player_by_email_with_template.sql.erb

@@ -0,0 +1,3 @@
+SELECT *
+FROM players
+WHERE <%= partial :email_partial %>

data/spec/sql_query_spec.rb

@@ -101,4 +101,11 @@ describe SqlQuery do
       expect(query.execute).to eq [{ 'email' => 'e@mail.dev'}]
     end
   end
+
+  describe '#partial' do
+    let(:file_name) { :get_player_by_email_with_template }
+    it 'resolves partials as parts of sql queries' do
+      expect(query.sql).to eq("SELECT *\nFROM players\nWHERE players.email = 'e@mail.dev'\n\n")
+    end
+  end
 end

data/sql_query.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "sql_query"
-  spec.version       = "0.2.1"
+  spec.version       = "0.3.0"
   spec.authors       = ["sufleR"]
-  spec.email         = ["szymon.fracczak@netguru.co"]
+  spec.email         = ["szymon.fracczak@gmail.com"]
   spec.summary       = %q{Ruby gem to load and execute SQL queries from `.sql.erb` templates}
   spec.description   = %q{
     It makes working with pure SQL easier with syntax highlighting.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_query
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - sufleR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -139,7 +139,7 @@ dependencies:
 description: "\n    It makes working with pure SQL easier with syntax highlighting.\n
   \   Let's you clean your Ruby code from SQL strings.\n  "
 email:
-- szymon.fracczak@netguru.co
+- szymon.fracczak@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -152,16 +152,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/README.md
+- examples/distinct_values.sql.erb
 - gemfiles/3.2.gemfile
 - gemfiles/4.0.gemfile
 - gemfiles/4.1.gemfile
 - gemfiles/4.2.gemfile
 - lib/sql_query.rb
 - spec/spec_helper.rb
+- spec/sql_queries/_email_partial.sql.erb
 - 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_queries/get_player_by_email_with_template.sql.erb
 - spec/sql_query_spec.rb
 - sql_query.gemspec
 homepage: https://github.com/sufleR/sql_query
@@ -184,14 +188,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.0
 signing_key: 
 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/_email_partial.sql.erb
 - 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_queries/get_player_by_email_with_template.sql.erb
 - spec/sql_query_spec.rb