sql_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3407f644b957a15838ea5f8353a471189f1405fe
+  data.tar.gz: 3831c4697d02f500573f4c377d7d3e478477d000
+SHA512:
+  metadata.gz: 608580c195424f5d16eecf139ccf11b7afa2e3beac6ee5f950adc7a13f204cf9e63262f9a3e3a9fb0e2990222d7b0a30614931dd4b001567943e7b008889daa6
+  data.tar.gz: a312a0e5b5c9847ca1fabbd6efed511208d48e7a7a4f3ac6ee28e5edeb840d2d5fbff54c8f0fdfeb1ee7ee5a98fa40737493ac556257ef86d1a81a5300583f84

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sql_formatter.gemspec
+gemspec
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kotaro Mochizuki
+
+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,62 @@
+# SqlFormatter
+
+It is ruby gem to format SQL.
+
+## Installation
+
+```
+gem install sql_formatter
+```
+
+## Usage
+
+```
+pry> require 'sql_formatter'
+=> true
+
+pry> sql_string = "select col1, col2 from table1 where col3 in (select col3 from table2) order by col1;"
+=> "select col1, col2 from table1 where col3 in (select col3 from table2) order by col1;"
+
+pry> puts SqlFormatter.format(sql_string)
+select
+  col1, col2
+from
+  table1
+where
+  col3 in (
+    select col3
+    from table2
+  )
+order by
+  col1
+;
+=> nil
+```
+
+
+## Development
+
+```
+$ git clone git@github.com:mochizukikotaro/sql_formatter.git
+$ cd sql_formatter
+$ bundle exec irb
+irb(main):001:0> require 'sql_formatter'
+=> true
+irb(main):002:0> puts SqlFormatter.format('select * from table;')
+select
+  *
+from
+  table
+;
+=> nil
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mochizukikotaro/sql_formatter.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sql_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sql_formatter/formatter.rb

@@ -0,0 +1,162 @@
+module SqlFormatter
+  class Formatter
+
+    NEWLINE = "\n"
+    SPACE   = " " * 1
+    TAB     = " " * 2
+    COMMA   = ","
+
+    RESERVED_TOPLEVEL = [
+      'select',
+      'from',
+      'where',
+      'group by',
+      'order by'
+    ]
+    BOUNDARY = %w( , ; : ( ) . = < > + - * / ! ~ % | & # )
+
+    REGEX_RESERVED_TOPLEVEL = Regexp.new(RESERVED_TOPLEVEL.join('|').gsub(/ /, '\s+'))
+    REGEX_BOUNDARY = Regexp.new(BOUNDARY.map{ |m| Regexp.escape m }.join('|'))
+
+
+    def initialize(string)
+      @ss       = StringScanner.new(string)
+      @tokens   = []
+      @space    = true
+      @newline  = false
+      @indent_level = 0
+      @inline_parentheses = false
+      @inline_parentheses_level = 0
+      tokenize
+      remove_space
+    end
+
+
+    def format
+      output = ''
+      @tokens.each_with_index do |token, index|
+
+        case
+
+        # Reserved toplevel
+        when  RESERVED_TOPLEVEL.include?(token)
+          lower_indent_level
+          output += NEWLINE if index > 0
+          output += TAB * @indent_level
+
+          # TODO: Add optional..
+          if @indent_level >= 2
+            @newline = false
+          else
+            @newline = true
+          end
+
+          raise_indent_level
+
+        # End of tokens
+        when token == ';' && index == (@tokens.size - 1)
+          output += NEWLINE
+
+        # Comma
+        when token == COMMA
+          @space = true
+
+        # Left parenthesis
+        when token == '('
+          if @newline
+            output += NEWLINE + TAB * @indent_level
+          end
+
+          if inline_left_parenthesis?(index)
+            @newline = false
+            @space = false
+            @inline_parentheses = true
+            @inline_parentheses_level += 1
+            output += SPACE if @tokens[index - 1] == COMMA
+          else
+            @newline = true
+            @indent_level += 2
+            output += SPACE
+          end
+
+        # Right parenthesis
+        when token == ')'
+          if inline_right_parenthesis?
+            @inline_parentheses_level = [0, @inline_parentheses_level - 1].max
+
+            if @inline_parentheses_level == 0
+              @inline_parentheses = false
+              @space = true
+            end
+          else
+            @indent_level -= 2
+            output += NEWLINE + TAB
+          end
+
+        else
+          if @inline_parentheses
+            # Nothing to do
+          elsif @newline
+            output += NEWLINE + TAB * @indent_level
+            @newline = false
+          elsif @space
+            output += SPACE
+          else
+            # Nothing to do
+          end
+        end
+
+        output += token
+      end
+      output
+    end
+
+    private
+
+      def raise_indent_level
+        @indent_level += 1
+      end
+
+      def lower_indent_level
+        @indent_level = [0, @indent_level -1].max
+      end
+
+      def inline_left_parenthesis?(index)
+        RESERVED_TOPLEVEL.include?(@tokens[index + 1]) ? false : true
+      end
+
+      def inline_right_parenthesis?
+        @inline_parentheses ? true : false
+      end
+
+      def tokenize
+        until @ss.eos?
+          @tokens << next_token
+        end
+      end
+
+      def next_token
+        patterns = [
+          /\s+/,
+          REGEX_RESERVED_TOPLEVEL,
+          REGEX_BOUNDARY,
+          /(^'.*?'|^".*?"|^`.*?`)/,
+          /\w+/
+        ]
+        patterns.each do |pattern|
+          return @ss.matched if @ss.scan(pattern)
+        end
+
+        # TODO: Add error handling
+        p 'Warning'
+        p @ss.peek 20
+        @ss.pos += 1
+        return nil
+      end
+
+      def remove_space
+        @tokens.select! { |token| !token.match(/^\s+$/) }
+      end
+
+  end
+end

data/lib/sql_formatter/version.rb

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

data/lib/sql_formatter.rb

@@ -0,0 +1,9 @@
+require "sql_formatter/version"
+require "sql_formatter/formatter"
+
+module SqlFormatter
+  def self.format(string)
+    formatter = SqlFormatter::Formatter.new(string)
+    formatter.format
+  end
+end

data/sample_sql.sql

@@ -0,0 +1,20 @@
+create table users (
+  id serial,
+  name varchar(255),
+  team integer
+)
+;
+
+insert into users (name, team) values
+  ('taro', 1),
+  ('yuki', 1),
+  ('kent', 1),
+  ('hoge', 2),
+  ('piyo', 2),
+  ('fuga', 2),
+  ('aaaa', 3),
+  ('bbbb', 3)
+;
+
+-- Sample query
+puts SqlFormatter.format "select (1), ((2)), hoge, piyo, count(*), max(score) from users where name in (select *, aa from hoge) and team = '3' group by team order by id;"

data/sql_formatter.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sql_formatter"
+  spec.version       = SqlFormatter::VERSION
+  spec.authors       = ["Kotaro Mochizuki"]
+  spec.email         = ["mochizuki@basicinc.jp"]
+
+  spec.summary       = %q{ SQL formatter on Ruby }
+  spec.description   = %q{ Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/mochizukikotaro"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: sql_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kotaro Mochizuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: " Write a longer description or delete this line."
+email:
+- mochizuki@basicinc.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_formatter.rb
+- lib/sql_formatter/formatter.rb
+- lib/sql_formatter/version.rb
+- sample_sql.sql
+- sql_formatter.gemspec
+homepage: https://github.com/mochizukikotaro
+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.5.2
+signing_key: 
+specification_version: 4
+summary: SQL formatter on Ruby
+test_files: []
+has_rdoc: