candy--sql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f488ce2f5e412a34a8054d2ebb6a77a3ea59fa52
+  data.tar.gz: 76e20cad837b9950b3519b6aa2ad03068f946b97
+SHA512:
+  metadata.gz: 27f22cf230a8edcccba0c78c3af16963f753adaf3182126e53380faab2e6b87d4e54e2c7345dccec51e3758f28657d55269c55920fdbce25b2d7a2ad1b98f38c
+  data.tar.gz: 9553fe961bdbb0b7967a4bcb8cb1fa74e0a8530cc421de1e0765dad52e8d3457444ae70112f4cb82f9b08e14f986b9d7e6be6f10e263c340936b1c86213716dc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in candy--sql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 llby
+
+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.jp.md

@@ -0,0 +1,102 @@
+# CANDY--SQL
+
+## 概要
+SQLの構文糖です。
+
+シンタックスシュガーです。
+
+キャンディーです。
+
+これはSQLに対しての構文糖や、DSLの類いです。
+最近は、O/Rマッパーが広がってるようですが
+その時代の流れに逆らい、まだSQLに別の進化があるのではないか？
+と思っています。
+
+これを作ろうと思ったのは、私はSQLを書く事が多く
+サブクエリなど長々と書いていると分かりにくくなってきて
+「もっと簡単に書けないのか？」
+などと思う事が多くありました。
+
+SQLが普及してから長く経つので、こういったものがあるのではないか？
+と探してみましたが、なかなか良いものが見つかりませんでした。
+
+世間的にどちらかというと、SQLが長くなりそうな場合は
+プログラム側に処理を移すのが、一般的なやり方だと思います。
+その方が可読性も高まるし、変数なども使用出来ます。
+
+それでも私の場合は、SQLを使う場面が多くあり
+しかも長いSQLが多い。
+
+それではと思い自分用に作っていましたが
+「他にも同じように困っている方がいるかもしれない」
+と思い、公開する事にしました。
+
+## 目的
+時代の流れを、またSQLの方に戻そうという野望があります。
+
+## 前提条件
+SQLが使える方向けです。
+
+## 使い方
+ファイルは、２つのパートに分かれます。
+上のパートは、定義パートです。
+下のパートは、SQL構文パートです。
+
+###定義パート
+定義パートには、SQLでASを使って宣言される
+* テーブル定義
+* SELECT内のカラム定義
+を変数のように定義する事が出来ます。
+
+下記のように記載します。
+
+```
+変数名== 定義内容
+```
+また、ASを使わずにそのまま変換される変数も定義する事が出来ます。
+
+下記のように記載します。
+
+```
+変数名= 定義内容
+```
+これらは、定義パート、SQL構文パートで展開されますが
+GROUP BY、ORDER BY、HAVINGでは展開されません。
+
+###SQL構文パート
+SQL構文パートは、省略記号を使ってSQLを短く記載する事が出来ます。
+
+```
+S--				/* SELECT */
+F--				/* FROM */
+W--				/* WHERE */
+ A-				/* AND */
+ O-				/* OR */
+G--				/* GROUP BY */
+O--				/* ORDER BY */
+H--				/* HAVING */
+```
+まるで、キャンディのようですね。
+これらの記号は、全て行の先頭でのみ使用可能です。
+
+また、「F--」の行では、下記の結合記号が使用出来ます。
+
+```
+=<				/* INNER JOIN */
+<<				/* LEFT JOIN */
+>>				/* RIGHT JOIN */
+```
+
+## 今後について
+SQLからドキュメントの様なものが出力出来ないか？
+と思っています。
+
+その他、SQLを書くうえで困る事があれば対応していきたいです。
+
+
+## ライセンス
+MITライセンスです。
+
+llby@shingor.net
+
+Copyright (c) 2015 llby

data/README.md

@@ -0,0 +1,38 @@
+# Candy--Sql
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'candy--sql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install candy--sql
+
+
+## Usage
+
+    $ bin/make sample/sample1.csql
+
+You should make tables in your database before do sample queries.
+Please use sample/seed.sql
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/llby/candy--sql.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "candy--sql"
+require "irb"
+IRB.start

data/bin/make

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'candy--sql'
+
+filename = ARGV[0]
+res = CandySql.make( filename )
+puts res

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/candy--sql.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'candy--sql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "candy--sql"
+  spec.version       = CandySql::VERSION
+  spec.authors       = ["llby"]
+  spec.email         = ["llby@shingor.net"]
+
+  spec.summary       = %q{Syntax sugar for sql.}
+  spec.homepage      = "https://github.com/llby/candy--sql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/candy--sql.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+require 'candy--sql/version'
+require 'candy--sql/interpreter'
+require 'candy--sql/token'
+require 'candy--sql/variable'
+
+module CandySql
+
+  def make(filename)
+
+    mode = 0 #(0: 変数定義、1: SQL構文)
+    var = {}
+    res = []
+
+    open(filename) { |file|
+      while row = file.gets
+
+        # トークン分割
+        src = CandySql::Token.tokenize(row)
+
+        if mode == 0
+          if src[1] == "=="
+            # AS定義
+            var = var.merge( CandySql::Valiable.definAs(src, var) )
+          elsif src[1] == "="
+            # 変数定義
+            var = var.merge( CandySql::Valiable.defin(src, var) )
+          elsif src[1] == "<"
+            # サブクエリ定義
+            tmp = "(" + CandySql.make(src[2][1 .. -2]) + ")"
+            src.slice!( 2, 2 )
+            src.insert(2, tmp)
+            src[1] = "="
+            var = var.merge( CandySql::Valiable.definAs(src, var) )
+          elsif src[1] == "--"
+            mode = 1
+          end
+        end
+        
+        if mode == 1
+          # SQL構文
+          res << CandySql::Interpreter.statement(src, var)
+        end
+        
+      end
+    }
+
+    return res.join("\n")
+  end
+
+  module_function :make
+end

data/lib/candy--sql/interpreter.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+module CandySql
+  module Interpreter
+
+    def statement(src, var)
+
+      if src[1] == "--"
+        if  src[0] == "G"
+
+          src[0] = "GROUP BY"
+
+        elsif src[0] == "O"
+
+          src[0] = "ORDER BY"
+
+        elsif src[0] == "H"
+
+          src[0] = "HAVING"
+
+        else
+          if src[0] == "S"
+
+            src[0] = "SELECT"
+          
+          elsif src[0] == "F"
+
+            src[0] = "FROM"
+
+          elsif src[0] == "W"
+
+            src[0] = "WHERE"
+
+          end
+          src.each_with_index do |t, i|
+            if t == "=<"
+              src[i] = "INNER JOIN"
+              src.insert( i, "\n" )
+            elsif t == "<<"
+              src[i] = "LEFT JOIN"
+              src.insert( i, "\n" )
+            elsif t == ">>"
+              src[i] = "RIGHT JOIN"
+              src.insert( i, "\n" )
+            elsif var.key?(t)
+              src[i] = var[t]
+              if src[i+1] == ","
+                src[i+1] = ",\n"
+              end
+            end
+          end
+        end
+        src.slice!( 1, 1 )
+
+      elsif src[1] == "-"
+
+        if src[0] == "A"
+
+          src[0] = "AND"
+
+        elsif src[0] == "O"
+
+          src[0] = "OR"
+
+        end
+        src.slice!( 1, 1 )
+        src.each_with_index do |t, i|
+          if var.key?(t)
+            src[i] = var[t]
+          end
+        end
+      end
+
+      return src.join(" ").gsub(/\s\(/, "(").gsub(/\s,/, ",")
+    end
+
+    module_function :statement
+  end
+end

data/lib/candy--sql/token.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+module CandySql
+  module Token
+
+    def tokenize(src)
+      res = []
+
+      while !src.empty? do
+
+        if src =~ /^('.*')/ || src =~ /^(".*")/
+
+          # 文字列
+          res << src.slice!(0,$1.length)
+
+        elsif src =~ /^([\w\.]+)/
+
+          # 変数
+          res << src.slice!(0,$1.length)
+
+        elsif src =~ /^([\s\t]+)/
+
+          # 空白、タブは除外する
+          src.slice!(0,$1.length)
+
+        elsif src =~ /^(--|==|<=|>=|=<|<<|>>)/
+
+          # 2文字以上記号
+          res << src.slice!(0,$1.length)
+
+        elsif src =~ /^\W/
+
+          # 記号
+          res << src.slice!(0,1)
+
+        end
+
+      end
+
+      return res
+    end
+
+    module_function :tokenize
+  end
+end

data/lib/candy--sql/variable.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+
+module CandySql
+  module Valiable
+
+    def defin(src, var)
+      val = []
+
+      key = src[0]
+      # 変数定義
+      src.shift(2)
+      src.each_with_index{ |s, i|
+        if var.key?(s)
+          src[i] = var[s]
+        end
+      }
+      var[key] = src.join(" ")
+      return var
+    end
+
+    def definAs(src, var)
+      val = []
+
+      key = src[0]
+      if src[3] == "["
+        # JOIN定義
+        val << [src[2], "AS", key]
+        src.shift(3)
+
+        src.each{ |s|
+
+          if s == "]"
+
+          else
+            if s == "["
+              s = "ON"
+            elsif var.key?(s)
+              s = var[s]
+            end
+            val << s
+          end
+        }
+      else
+        # AS定義
+        src.shift(2)
+        src.each_with_index{ |s, i|
+          if var.key?(s)
+            src[i] = var[s]
+          end
+        }
+        src << ["AS", key]
+        val = src
+      end
+      var[key] = val.join(" ")
+      return var
+    end
+
+    module_function :defin
+    module_function :definAs
+  end
+end

data/lib/candy--sql/version.rb

@@ -0,0 +1,3 @@
+module CandySql
+  VERSION = "0.1.0"
+end

data/sample/sample1.csql

@@ -0,0 +1,3 @@
+S-- *
+F-- candies
+O-- id

data/sample/sample2.csql

@@ -0,0 +1,4 @@
+S-- count(*)
+F-- sales
+W-- created_at >= '2015-01-01'
+O-- created_at

data/sample/sample3.csql

@@ -0,0 +1,8 @@
+SL== sales
+CD== candies[CD.id = SL.candy_id]
+
+
+S-- *, SL.num * CD.price
+F-- SL =< CD
+W-- CD.sweet > 2
+O-- created_at

data/sample/sample4.csql

@@ -0,0 +1,9 @@
+SL== sales
+CD== candies[CD.id = SL.candy_id]
+SUB<"sample/sample4_sub.csql">[SUB.Y = DATE_FORMAT(SL.created_at, '%Y')]
+
+
+S-- DATE_FORMAT(SL.created_at, '%Y-%m'), sum(SL.num * CD.price), sum(SL.num * CD.price) / SUB.SUM_OF_Y * 100
+F-- SL =< CD =< SUB
+G-- DATE_FORMAT(SL.created_at, '%Y-%m')
+O-- SL.created_at

data/sample/sample4_sub.csql

@@ -0,0 +1,10 @@
+Y==DATE_FORMAT(SL.created_at, '%Y')
+SUM_OF_Y== sum(SL.num * CD.price)
+SL== sales
+CD== candies[CD.id = SL.candy_id]
+
+
+S-- Y, SUM_OF_Y
+F-- SL =< CD
+G-- DATE_FORMAT(SL.created_at, '%Y')
+O-- created_at

data/sample/sample5.csql

@@ -0,0 +1,15 @@
+SUM_NUM_PRI= sum(SL.num * CD.price)
+Y= DATE_FORMAT(SL.created_at, '%Y')
+
+YM== DATE_FORMAT(SL.created_at, '%Y-%m')
+SUM_OF_M== SUM_NUM_PRI
+PER_OF_Y== SUM_NUM_PRI / SUB.SUM_OF_Y * 100
+SL== sales
+CD== candies[CD.id = SL.candy_id]
+SUB<"sample/sample4_sub.csql">[SUB.Y = Y]
+
+
+S-- YM, SUM_OF_M, PER_OF_Y
+F-- SL =< CD =< SUB
+G-- YM
+O-- created_at

data/sample/sample6.csql

@@ -0,0 +1,11 @@
+YM== DATE_FORMAT(SL.created_at, '%Y-%m')
+SUM_OF_M== sum(SL.num * CD.price)
+SL== sales
+CD== candies[CD.id = SL.candy_id]
+
+
+S-- CD.name, YM, SUM_OF_M
+F-- SL =< CD
+W-- SL.created_at >= '2015-01-01'
+ A- CD.sweet > 2
+G-- CD.id, YM

data/sample/seed.sql

@@ -0,0 +1,49 @@
+CREATE TABLE candies (
+  id    integer     unsigned not null auto_increment,
+  name  varchar(50) not null default "",
+  price integer     not null default 0,
+  sweet tinyint     not null default 0,
+  primary key (id)
+)
+
+INSERT INTO candies(name, price, sweet)
+VALUES
+("strawberry", 130, 4),
+("orange",     120, 3),
+("lemon",      100, 1),
+("chocolate",  150, 5);
+
+
+CREATE TABLE sales (
+  id        integer  unsigned not null auto_increment,
+  candy_id  integer  not null,
+  num       integer  not null default 0,
+  created_at datetime not null default current_timestamp,
+  primary key (id)
+)
+
+INSERT INTO sales(candy_id, num, created_at)
+VALUES
+(1, 6,  '2014-01-01'),
+(1, 11, '2014-02-12'),
+(1, 12, '2014-03-08'),
+(1, 9,  '2015-06-03'),
+(1, 27, '2015-07-05'),
+(1, 13, '2015-08-09'),
+(2, 26, '2014-04-21'),
+(2, 25, '2014-05-22'),
+(2, 19, '2015-05-04'),
+(2, 14, '2015-07-30'),
+(3, 20, '2014-03-09'),
+(3, 28, '2015-02-11'),
+(3, 21, '2015-04-20'),
+(3, 9,  '2015-11-02'),
+(3, 1,  '2015-12-03'),
+(3, 18, '2015-06-07'),
+(3, 7,  '2015-03-25'),
+(4, 2,  '2014-12-07'),
+(4, 4,  '2015-02-22'),
+(4, 3,  '2015-04-25');
+
+
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: candy--sql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- llby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- llby@shingor.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.jp.md
+- README.md
+- Rakefile
+- bin/console
+- bin/make
+- bin/setup
+- candy--sql.gemspec
+- lib/candy--sql.rb
+- lib/candy--sql/interpreter.rb
+- lib/candy--sql/token.rb
+- lib/candy--sql/variable.rb
+- lib/candy--sql/version.rb
+- sample/sample1.csql
+- sample/sample2.csql
+- sample/sample3.csql
+- sample/sample4.csql
+- sample/sample4_sub.csql
+- sample/sample5.csql
+- sample/sample6.csql
+- sample/seed.sql
+homepage: https://github.com/llby/candy--sql
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Syntax sugar for sql.
+test_files: []