sql-builder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16002ee092061ecac8b29f725d606e5617252dad607d138269a651dad5b21a3a
-  data.tar.gz: bc9b44a28f909204e86bc6b8b208b8b48746423552e649ce21002e12f902bfd3
+  metadata.gz: 150ba78258f5b3cb152890b76982b01652a5a779bfd4aecfbb1591e0ab7820ad
+  data.tar.gz: 726c4b1b6b4d7a522d02848059285529c924ad6109b367bd2fe42cb77f97f26e
 SHA512:
-  metadata.gz: eb95a8dddc6c56f9073bfd997e19e184c8c9c1f87992fae67bd9df6329db8af564beb5066e0ab5ecde9495c71da12c4dda3034fdaa3e5dc213cd922302c31dee
-  data.tar.gz: 115738ea5dda02fe1ef57114ac3765e43b4b30d1e405b1eaee1d332192dd66e4d27a6bbf7262e0980b524dfd22c0077da95065dda009261fdcb5d194f87b138d
+  metadata.gz: d912e64843705a78564aed481d87f1dd00959cd80b33583f7cd7b9cdb12b4cf7bf0693d3f9041972a0e00deeb79037905fef68d733aac1e20958e67119c8aca5
+  data.tar.gz: 338b7ae715a9c01144a228d5e752db1007fb21504463b58ff69fc9a5201a2d032b317f817b236f628adad540cea113b3bfb3143086ee485bf91c90b1798cf741

data/README.md

@@ -4,11 +4,13 @@ A simple SQL builder for generate SQL for non-ActiveRecord supports databases.
 
 [![Build Status](https://travis-ci.org/huacnlee/sql-builder.svg?branch=master)](https://travis-ci.org/huacnlee/sql-builder)
 
+[中文说明](https://ruby-china.org/topics/39399)
+
 ## Features
 
-- Simple SQL generator with DSL.
-- Sanitize SQL by ActiveRecord methods, keep security.
-- Simple SQL geneate logic for keep support any SQL databases (MySQL, PostgreSQL, TiDB, Amazon Redshift...)
+- ActiveRecord style DSL.
+- [Sanitize](https://api.rubyonrails.org/classes/ActiveRecord/Sanitization/ClassMethods.html#method-i-sanitize_sql) SQL by ActiveRecord methods, keep security.
+- Support any SQL databases (MySQL, PostgreSQL, TiDB, Amazon Redshift...)
 
 ## Installation
 
@@ -20,7 +22,9 @@ gem 'sql-builder'
 
 ## Usage
 
-```rb
+More API documents, please visit [rdoc.info/gems/sql-builder](https://rdoc.info/gems/sql-builder).
+
+```ruby
 SQLBuilder.new("SELECT * FROM users")
   .where("name = ?", "hello world")
   .where("status != ?", 1)
@@ -33,31 +37,51 @@ SQLBuilder.new("SELECT * FROM users")
 => "SELECT * FROM users WHERE name = 'hello world' AND status != 1 ORDER BY created_at desc, id asc LIMIT 20 OFFSET 0"
 ```
 
-More complext:
+### More complex case
 
-```rb
+```ruby
 query = SQLBuilder.new("SELECT users.name, users.age, user_profiles.bio, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.user_id")
+```
 
-# conditions by params
+Add the conditions by request params:
+
+```ruby
 query.where("age >= ?", params[:age]) unless params[:age].blank?
 query.where("status = ?", params[:status]) unless params[:status].nil?
 if params[:created_at_from] && params[:created_at_to]
   query.where("created_at >= ? and created_at <= ?", params[:created_at_from], params[:created_at_to])
 end
 query.order("id desc").limit(100).to_sql
+```
+
+Returns string SQL:
 
-=> "SELECT users.name, users.age, user_profiles.bio, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.user_id WHERE age >= 18 AND status = 3 AND created_at >= '2020-01-03 10:54:08 +0800' and created_at <= '2020-01-03 10:54:08 +0800' ORDER BY id desc LIMIT 100 OFFSET 0"
+```sql
+SELECT users.name, users.age, user_profiles.bio, user_profiles.avatar FROM users
+INNER JOIN user_profiles ON users.id = user_profiles.user_id
+WHERE age >= 18 AND status = 3 AND created_at >= '2020-01-03 10:54:08 +0800' AND created_at <= '2020-01-03 10:54:08 +0800'
+ORDER BY id desc LIMIT 100 OFFSET 0
 ```
 
-## TODO
+### Group by, Having
+
+```rb
+query = SQLBuilder.new("select user_id, name, count(ip) as ip_count from user_visits")
+query.where("status = ?", 1).where("created_at > ?", params[:created_at])
+query.group("user_id").group("name").having("count(ip) > 2")
+query.to_sql
+```
 
-- [ ] where by or;
+returns
 
-## Development
+```sql
+select user_id, name, count(ip) as ip_count from user_visits WHERE status = 1 AND status = 1 AND created_at > '2020-01-03 10:54:08 +0800' GROUP BY user_id, name HAVING count(ip) > 2"
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## TODO
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- [ ] `OR` conditions;
+- [X] `Group By`, `Having`;
 
 ## License
 

data/lib/sql-builder/builder.rb

@@ -1,33 +1,43 @@
+require "active_record"
+
 # SQLBuilder write the complex SQL as DSL
+# = Example:
 #
-# Example:
-#
-#    query = SQLBuilder.new("SELECT * FROM users inner join ")
+#    query = SQLBuilder.new("SELECT * FROM users")
 #      .where("name = ?", "hello world")
 #      .where("status != ?", 1)
 #      .order("created_at desc")
 #      .order("id asc")
 #      .page(1).per(20)
 #      .to_sql
-require "active_record"
-
 class SQLBuilder
-  attr_reader :sql, :conditions, :orders, :limit_options, :page_options
+  attr_reader :sql, :conditions, :havings, :orders, :groups, :limit_options, :page_options
   delegate :sanitize_sql, :sanitize_sql_for_order, to: ActiveRecord::Base
 
+  # Create a new SQLBuilder
+  #
+  # == Example
+  #   query = SQLBuilder.new("SELECT users.*, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.id")
+  #   query.to_sql
+  #   # => "SELECT users.*, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.id"
+  #
   def initialize(sql = "")
     @sql = sql
     @conditions = []
     @orders = []
+    @groups = []
+    @havings = []
     @limit_options = {}
     @page_options = { per_page: 20 }
   end
 
   # Add `AND` condition
   #
-  # query.where("name = ?", params[:name]).where("age >= ?", 18)
+  #   query.where("name = ?", params[:name]).where("age >= ?", 18)
+  #
   # or
-  # count_query.where(query)
+  #
+  #   count_query.where(query)
   def where(*condition)
     case condition.first
     when SQLBuilder
@@ -42,16 +52,15 @@ class SQLBuilder
 
   # Order By
   #
-  # query.order("name asc").order("created_at desc").to_sql
-  # => "ORDER BY name asc, created_at desc"
+  #   query.order("name asc").order("created_at desc").to_sql
+  #   # => "ORDER BY name asc, created_at desc"
   def order(condition)
     orders << sanitize_sql_for_order(condition)
     self
   end
 
   # Offset
-  #
-  # query.offset(3).limit(10) => "LIMIT 10 OFFSET 3"
+  # See #limit
   def offset(offset)
     limit_options[:offset] = offset.to_i
     self
@@ -59,17 +68,54 @@ class SQLBuilder
 
   # Limit
   #
-  # query.offset(3).limit(10) => "LIMIT 10 OFFSET 3"
+  #   query.offset(3).limit(10).to_sql
+  #   # => "LIMIT 10 OFFSET 3"
   def limit(limit)
     limit_options[:offset] ||= 0
     limit_options[:limit] = limit.to_i
     self
   end
 
+  # Group By
+  #
+  # Allows to specify a group attribute:
+  #
+  #   query.group("name as new_name, age").to_sql
+  #   # => "GROUP BY name as new_name, age"
+  #
+  # or
+  #
+  #   query.group("name", "age").to_sql # => "GROUP BY name, age"
+  #   query.group(:name, :age).to_sql # => "GROUP BY name, age"
+  #   query.group(["name", "age"]).to_sql # => "GROUP BY name, age"
+  #   query.group("name").group("age").to_sql # => "GROUP BY name, age"
+  #
+  def group(*args)
+    case args.first
+    when Array
+      @groups += args.first.collect(&:to_s)
+    else
+      @groups += args.collect(&:to_s)
+    end
+
+    @groups.uniq!
+    self
+  end
+
+  # Having
+  #
+  #   query.group("name").having("count(name) > ?", 5).to_sql
+  #   # => "GROUP BY name HAVING count(name) > 5"
+  #
+  def having(*condition)
+    havings << sanitize_sql(condition)
+    self
+  end
+
   # Pagination
   #
-  # query.page(1).per(12) => "LIMIT 12 OFFSET 0"
-  # query.page(2).per(12) => "LIMIT 12 OFFSET 12"
+  #   query.page(1).per(12).to_sql # => "LIMIT 12 OFFSET 0"
+  #   query.page(2).per(12).to_sql # => "LIMIT 12 OFFSET 12"
   def page(page_no)
     page_options[:page] = page_no
     page_options[:per_page] ||= 10
@@ -79,7 +125,8 @@ class SQLBuilder
     self
   end
 
-  # See page
+  # Set per_page limit
+  # See #page
   def per(per_page)
     page_options[:per_page] = per_page
     self.page(page_options[:page])
@@ -95,6 +142,12 @@ class SQLBuilder
     if orders.any?
       sql_parts << "ORDER BY " + orders.join(", ")
     end
+    if groups.any?
+      sql_parts << "GROUP BY " + groups.join(", ")
+    end
+    if havings.any?
+      sql_parts << "HAVING " + havings.join(" AND ")
+    end
     if limit_options[:limit]
       sql_parts << "LIMIT " + limit_options[:limit].to_s
     end
@@ -103,4 +156,4 @@ class SQLBuilder
     end
     sql_parts.join(" ")
   end
-end
+end

data/lib/sql-builder/version.rb

@@ -1,3 +1,3 @@
 class SQLBuilder
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord