sql-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16002ee092061ecac8b29f725d606e5617252dad607d138269a651dad5b21a3a
+  data.tar.gz: bc9b44a28f909204e86bc6b8b208b8b48746423552e649ce21002e12f902bfd3
+SHA512:
+  metadata.gz: eb95a8dddc6c56f9073bfd997e19e184c8c9c1f87992fae67bd9df6329db8af564beb5066e0ab5ecde9495c71da12c4dda3034fdaa3e5dc213cd922302c31dee
+  data.tar.gz: 115738ea5dda02fe1ef57114ac3765e43b4b30d1e405b1eaee1d332192dd66e4d27a6bbf7262e0980b524dfd22c0077da95065dda009261fdcb5d194f87b138d

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jason Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# SQLBuilder
+
+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)
+
+## 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...)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql-builder'
+```
+
+## Usage
+
+```rb
+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
+
+=> "SELECT * FROM users WHERE name = 'hello world' AND status != 1 ORDER BY created_at desc, id asc LIMIT 20 OFFSET 0"
+```
+
+More complext:
+
+```rb
+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
+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
+
+=> "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
+
+- [ ] where by or;
+
+## Development
+
+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.
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sql-builder.rb

@@ -0,0 +1,5 @@
+require "sql-builder/version"
+require "sql-builder/builder"
+
+class SQLBuilder
+end

data/lib/sql-builder/builder.rb

@@ -0,0 +1,106 @@
+# SQLBuilder write the complex SQL as DSL
+#
+# Example:
+#
+#    query = SQLBuilder.new("SELECT * FROM users inner join ")
+#      .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
+  delegate :sanitize_sql, :sanitize_sql_for_order, to: ActiveRecord::Base
+
+  def initialize(sql = "")
+    @sql = sql
+    @conditions = []
+    @orders = []
+    @limit_options = {}
+    @page_options = { per_page: 20 }
+  end
+
+  # Add `AND` condition
+  #
+  # query.where("name = ?", params[:name]).where("age >= ?", 18)
+  # or
+  # count_query.where(query)
+  def where(*condition)
+    case condition.first
+    when SQLBuilder
+      query_scope = condition.first
+      @conditions = query_scope.conditions
+    else
+      conditions << sanitize_sql(condition)
+    end
+
+    self
+  end
+
+  # Order By
+  #
+  # 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"
+  def offset(offset)
+    limit_options[:offset] = offset.to_i
+    self
+  end
+
+  # Limit
+  #
+  # query.offset(3).limit(10) => "LIMIT 10 OFFSET 3"
+  def limit(limit)
+    limit_options[:offset] ||= 0
+    limit_options[:limit] = limit.to_i
+    self
+  end
+
+  # Pagination
+  #
+  # query.page(1).per(12) => "LIMIT 12 OFFSET 0"
+  # query.page(2).per(12) => "LIMIT 12 OFFSET 12"
+  def page(page_no)
+    page_options[:page] = page_no
+    page_options[:per_page] ||= 10
+
+    limit_options[:offset] = page_options[:per_page].to_i * (page_options[:page].to_i - 1)
+    limit_options[:limit] = page_options[:per_page].to_i
+    self
+  end
+
+  # See page
+  def per(per_page)
+    page_options[:per_page] = per_page
+    self.page(page_options[:page])
+    self
+  end
+
+  # Generate SQL
+  def to_sql
+    sql_parts = [sql]
+    if conditions.any?
+      sql_parts << "WHERE " + conditions.join(" AND ")
+    end
+    if orders.any?
+      sql_parts << "ORDER BY " + orders.join(", ")
+    end
+    if limit_options[:limit]
+      sql_parts << "LIMIT " + limit_options[:limit].to_s
+    end
+    if limit_options[:limit] && limit_options[:offset]
+      sql_parts << "OFFSET " + limit_options[:offset].to_s
+    end
+    sql_parts.join(" ")
+  end
+end

data/lib/sql-builder/version.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: sql-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: A simple SQL builder for generate SQL for non-ActiveRecord supports databases.
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/sql-builder.rb
+- lib/sql-builder/builder.rb
+- lib/sql-builder/version.rb
+homepage: https://github.com/huacnlee/sql-builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/huacnlee/sql-builder
+  changelog_uri: https://github.com/huacnlee/sql-builder/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple SQL builder for generate SQL for non-ActiveRecord supports databases
+test_files: []