sql_formatter_web_interface 1.0.0

data/CHANGELOG

@@ -0,0 +1 @@
+v1.0.0. First release. Provides the SqlFormatterWebInterface::format and optionally the String#to_formatted_sql methods

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
+  gem 'echoe'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'heredoc_unindent'
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    allison (2.0.3)
+    diff-lcs (1.1.3)
+    echoe (4.6.3)
+      allison (>= 2.0.3)
+      gemcutter (>= 0.7.0)
+      rake (>= 0.9.2)
+      rdoc (>= 3.6.1)
+      rubyforge (>= 2.0.4)
+    gemcutter (0.7.1)
+    github-markup (0.7.2)
+    heredoc_unindent (1.1.2)
+    json (1.7.0)
+    json_pure (1.7.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  echoe
+  github-markup
+  heredoc_unindent
+  redcarpet
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Maurizio De Santis <desantis.maurizio@gmail.com>
+
+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/Manifest

@@ -0,0 +1,14 @@
+CHANGELOG
+Gemfile
+Gemfile.lock
+LICENSE
+README.markdown
+Rakefile
+examples/multiple_inserts.sql
+examples/pg_view.sql
+examples/subquery.sql
+lib/sql_formatter_web_interface.rb
+lib/sql_formatter_web_interface/to_formatted_sql.rb
+spec/spec_helper.rb
+spec/sql_formatter_web_interface_spec.rb
+Manifest

data/README.markdown

@@ -0,0 +1,99 @@
+# SqlFormatterWebInterface
+
+## Description
+This library lets you write this:
+
+```ruby
+sql = <<-SQL
+         select user_id, count(*) as how_many from bboard where 
+         not exists (select 1 from bboard_authorized_maintainers bam 
+         where bam.user_id = bboard.user_id) and posting_time + 60 > sysdate 
+         group by user_id order by how_many desc;
+         SQL
+SqlFormatterWebInterface.format(sql) #=>
+# SELECT user_id,
+#        count(*) AS how_many
+# FROM bboard
+# WHERE NOT EXISTS
+#     (SELECT 1
+#      FROM bboard_authorized_maintainers bam
+#      WHERE bam.user_id = bboard.user_id)
+#   AND posting_time + 60 > sysdate
+# GROUP BY user_id
+# ORDER BY how_many DESC;
+```
+
+or this:
+
+```ruby
+sql = <<-SQL
+         insert into customer (id, name) values (1, 'John');
+         insert into customer (id, name) values (2, 'Jack');
+         insert into customer (id, name) values (3, 'Jane');
+         insert into customer (id, name) values (4, 'Jim');
+         insert into customer (id, name) values (5, 'Jerry');
+         insert into customer (id, name) values (1, 'Joe');
+         SQL
+SqlFormatterWebInterface.format(sql) #=>
+# INSERT INTO customer (id, name)
+# VALUES (1,
+#         'John');
+# 
+# INSERT INTO customer (id, name)
+# VALUES (2,
+#         'Jack');
+# 
+# INSERT INTO customer (id, name)
+# VALUES (3,
+#         'Jane');
+# 
+# INSERT INTO customer (id, name)
+# VALUES (4,
+#         'Jim');
+# 
+# INSERT INTO customer (id, name)
+# VALUES (5,
+#         'Jerry');
+# 
+# INSERT INTO customer (id, name)
+# VALUES (1,
+#         'Joe');
+```
+
+or even this:
+
+```ruby
+require 'sql_formatter_web_interface/to_formatted_sql'
+'select * from foo join bar on val1 = val2 where id = 123;'.to_formatted_sql(:keyword_case => 'capitalize') #=>
+# Select *
+# From foo
+# Join bar On val1 = val2
+# Where id = 123;
+```
+
+Formatting happens making a request to an online SQL formatting service (http://sqlformat.appspot.com/format/ is the only supported at the moment).
+
+## Installation
+
+```ruby
+gem install sql_formatter_web_interface
+```
+
+In your Gemfile:
+
+```ruby
+gem 'sql_formatter_web_interface'
+```
+
+Or, if you want to use `String#to_formatted_sql`:
+
+```ruby
+gem 'sql_formatter_web_interface', :require => 'sql_formatter_web_interface/to_formatted_sql'
+```
+
+## Usage
+
+You can use `SqlFormatterWebInterface::format(sql, options)` or either `String#to_formatted_sql(options)`, where `options` is an hash with the options supported by the web service (see http://sqlformat.appspot.com/api/)
+
+## License
+MIT (see [LICENSE](LICENSE))

data/Rakefile

@@ -0,0 +1,51 @@
+require 'echoe'
+
+Echoe.new("sql_formatter_web_interface") do |p|
+  p.url         = 'https://github.com/ProGNOMmers/sql_formatter_web_interface'
+  p.project     = 'sql_formatter_web_interface'
+  p.author      = "Maurizio De Santis"
+  p.email       = 'desantis.maurizio@gmail.com'
+  p.description = "SQL formatter web interface - Web interface for SQL formatting"
+  p.summary     = "It lets you format SQL via web SQL formatting services"
+end
+
+desc 'IRB console'
+task :irb do
+  $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+  # require 'sql_formatter_web_interface'
+  require 'sql_formatter_web_interface/to_formatted_sql'
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+desc 'run example'
+task :run_example, [:example_name, :options] do |t, args|
+  $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+  require 'sql_formatter_web_interface'
+
+  example = args.example_name
+
+  options = 
+    if args.options.nil?
+      {}
+    else
+      {}.tap do |hash|
+        args.options.split(';').each do |v| 
+          _v = v.split(':')
+          raise Exception, 'options must be in this format: opt1:val1;opt2:val2;...' unless _v.size == 2
+          hash[_v[0]] = _v[1]
+        end
+      end
+    end
+
+  examples_dir = File.join(File.dirname(__FILE__), 'examples')
+  examples = Dir[File.join(examples_dir, '*.sql')].map { |filename| File.basename(filename, '.sql') }
+
+  raise Exception, "there is not any example named '#{example}'" unless examples.include? example
+
+  example_content = open(File.join(examples_dir, "#{example}.sql")).read
+
+  puts SqlFormatterWebInterface.format(example_content, options)
+
+end

data/examples/multiple_inserts.sql

@@ -0,0 +1 @@
+insert into customer (id, name) values (1, 'John');insert into customer (id, name) values (2, 'Jack');insert into customer (id, name) values (3, 'Jane');insert into customer (id, name) values (4, 'Jim');insert into customer (id, name) values (5, 'Jerry');insert into customer (id, name) values (1, 'Joe');

data/examples/pg_view.sql

@@ -0,0 +1 @@
+SELECT DISTINCT (current_database())::information_schema.sql_identifier AS view_catalog, (nv.nspname)::information_schema.sql_identifier AS view_schema, (v.relname)::information_schema.sql_identifier AS view_name, (current_database())::information_schema.sql_identifier AS table_catalog, (nt.nspname)::information_schema.sql_identifier AS table_schema, (t.relname)::information_schema.sql_identifier AS table_name FROM pg_namespace nv, pg_class v, pg_depend dv, pg_depend dt, pg_class t, pg_namespace nt WHERE ((((((((((((((nv.oid = v.relnamespace) AND (v.relkind = 'v'::"char")) AND (v.oid = dv.refobjid)) AND (dv.refclassid = ('pg_class'::regclass)::oid)) AND (dv.classid = ('pg_rewrite'::regclass)::oid)) AND (dv.deptype = 'i'::"char")) AND (dv.objid = dt.objid)) AND (dv.refobjid <> dt.refobjid)) AND (dt.classid = ('pg_rewrite'::regclass)::oid)) AND (dt.refclassid = ('pg_class'::regclass)::oid)) AND (dt.refobjid = t.oid)) AND (t.relnamespace = nt.oid)) AND (t.relkind = ANY (ARRAY['r'::"char", 'v'::"char"]))) AND pg_has_role(t.relowner, 'USAGE'::text)) ORDER BY (current_database())::information_schema.sql_identifier, (nv.nspname)::information_schema.sql_identifier, (v.relname)::information_schema.sql_identifier, (current_database())::information_schema.sql_identifier, (nt.nspname)::information_schema.sql_identifier, (t.relname)::information_schema.sql_identifier;

data/examples/subquery.sql

@@ -0,0 +1 @@
+select sum(a1.Sales) from Store_Information a1 where a1.Store_name in (select store_name from Geography a2 where a2.store_name = a1.store_name);

data/lib/sql_formatter_web_interface.rb

@@ -0,0 +1,85 @@
+require 'net/http'
+# @author Maurizio De Santis <desantis.maurizio@gmail.com>
+#
+# This module helps you to format your SQL using an online SQL formatting 
+# service (http://sqlformat.appspot.com/format/ is the only supported at the 
+# moment), providing a {format} method which accepts a SQL string and returns
+# the formatted version.
+# 
+# @note <b> 
+#   Being a web interface, it is _VERY_ unsafe sending data via HTTP
+#   to a service that could store informations about the requests; 
+#   this library should be used only with queries not including 
+#   sensitive data - did someone say _development database_?
+#   </b>
+module SqlFormatterWebInterface
+
+  SQL_FORMATTER_URL = 'http://sqlformat.appspot.com/format/'
+
+  # @private
+  #   XXX According to HTTP::NET API must be String => String
+  DEFAULT_OPTIONS = {
+    'format'          => 'text',
+    'remove_comments' => '',
+    'highlight'       => '',
+    'keyword_case'    => 'upper',
+    'identifier_case' => '',
+    'n_indents'       => '2',
+    'right_margin'    => '',
+    'output_format'   => 'sql'
+  }
+
+  # It makes a request to an online formatting service which will format a SQL string, 
+  # according to the setted options (see http://sqlformat.appspot.com for details about
+  # the default SQL formatting service)
+  #
+  # @example
+  #   sql = <<-SQL
+  #            select user_id, count(*) as how_many from bboard where 
+  #            not exists (select 1 from bboard_authorized_maintainers bam 
+  #            where bam.user_id = bboard.user_id) and posting_time ` 60 > sysdate 
+  #            group by user_id order by how_many desc;
+  #            SQL
+  #   SqlFormatterWebInterface.format(sql) #=>
+  #   # SELECT user_id,
+  #   #        count(*) AS how_many
+  #   # FROM bboard
+  #   # WHERE NOT EXISTS
+  #   #     (SELECT 1
+  #   #      FROM bboard_authorized_maintainers bam
+  #   #      WHERE bam.user_id = bboard.user_id)
+  #   #   AND posting_time + 60 > sysdate
+  #   # GROUP BY user_id
+  #   # ORDER BY how_many DESC;
+  #
+  # @param [String] sql   SQL query to be formatted
+  # @param [Hash] options The options to pass to the web service (see 
+  #                       http://sqlformat.appspot.com/api/ for informations about the
+  #                       available options); it will be merged with {DEFAULT_OPTIONS}.
+  #                       The special option `:url` can be used in order to specify 
+  #                       the URL of the request (if `nil` {SQL_FORMATTER_URL} will be used)
+  #
+  # @return [String]      If `sql` is a valid SQL a formatted copy of the string
+  #                       converted to the expected format, else an identical copy of the string
+  # @raise [SocketError]  When the service cannot reach the setted URL
+  def self.format(sql, options = {})
+    uri = URI(options[:url].nil? ? SQL_FORMATTER_URL : options.delete(:url))
+
+    stringify_hash!(options)
+
+    options['data'] = sql
+    options = DEFAULT_OPTIONS.merge(options)
+
+    Net::HTTP.post_form(uri, options).body
+
+  rescue SocketError
+    raise SocketError.new "unable to resolve #{uri.to_s}"
+  end
+
+  private
+  def self.stringify_hash!(hash)
+    hash.keys.each do |key|
+      hash[key.to_s] = hash.delete(key).to_s
+    end
+  end
+end

data/lib/sql_formatter_web_interface/to_formatted_sql.rb

@@ -0,0 +1,20 @@
+require 'sql_formatter_web_interface'
+
+module SqlFormatterWebInterface
+  # Includes the {InstanceMethods#to_formatted_sql} method in the `String` class
+  module ToFormattedSql
+    def self.included(klass)
+      klass.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      # It calls SqlFormatterWebInterface#format using `self` for `sql`
+      # @see SqlFormatterWebInterface#format
+      def to_formatted_sql(options = {})
+        SqlFormatterWebInterface.format(self, options)
+      end
+    end
+  end
+end
+
+String.send(:include, SqlFormatterWebInterface::ToFormattedSql)

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'open-uri'
+require 'heredoc_unindent'
+require 'sql_formatter_web_interface'

data/spec/sql_formatter_web_interface_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+# I am online if I can reach Google
+def online?
+  open('http://www.google.com')
+  true
+rescue SocketError
+  false
+end
+
+module SqlFormatterWebInterface
+  describe SqlFormatterWebInterface do
+    before(:each) do
+      raise Exception, "it seems you're not online: check your internet connection" unless online?
+    end
+    describe '::format' do
+      context 'with a reachable url' do
+        it "returns a String" do
+          SqlFormatterWebInterface.format('').class.should == String
+        end
+        context 'with a valid sql' do
+          it "returns a formatted sql" do
+            input = <<-SQL.strip
+                     select user_id, count(*) as how_many from bboard where 
+                     not exists (select 1 from bboard_authorized_maintainers bam 
+                     where bam.user_id = bboard.user_id) and posting_time + 60 > sysdate 
+                     group by user_id order by how_many desc;
+                     SQL
+            expected_output = <<-SQL.unindent.strip
+                              SELECT user_id,
+                                     count(*) AS how_many
+                              FROM bboard
+                              WHERE NOT EXISTS
+                                  (SELECT 1
+                                   FROM bboard_authorized_maintainers bam
+                                   WHERE bam.user_id = bboard.user_id)
+                                AND posting_time + 60 > sysdate
+                              GROUP BY user_id
+                              ORDER BY how_many DESC;
+                              SQL
+            SqlFormatterWebInterface.format(input).should == expected_output
+          end
+        end
+        context 'with an invalid sql' do
+          it "returns the same string as the input one" do
+            input = 'invalid blah blah blah!'
+            SqlFormatterWebInterface.format(input).should == input
+          end
+        end
+      end
+      context 'with an unreachable url' do
+        it "raises a SocketError" do
+          unreachable_url = 'http://this.is.an.unreachable.url'
+          proc { SqlFormatterWebInterface.format('', :url => unreachable_url) }.should raise_error SocketError, "unable to resolve #{unreachable_url}"
+        end
+      end
+    end
+  end
+end

data/sql_formatter_web_interface.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sql_formatter_web_interface"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maurizio De Santis"]
+  s.date = "2012-04-29"
+  s.description = "SQL formatter web interface - Web interface for SQL formatting"
+  s.email = "desantis.maurizio@gmail.com"
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.markdown", "lib/sql_formatter_web_interface.rb", "lib/sql_formatter_web_interface/to_formatted_sql.rb"]
+  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "LICENSE", "README.markdown", "Rakefile", "examples/multiple_inserts.sql", "examples/pg_view.sql", "examples/subquery.sql", "lib/sql_formatter_web_interface.rb", "lib/sql_formatter_web_interface/to_formatted_sql.rb", "spec/spec_helper.rb", "spec/sql_formatter_web_interface_spec.rb", "Manifest", "sql_formatter_web_interface.gemspec"]
+  s.homepage = "https://github.com/ProGNOMmers/sql_formatter_web_interface"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sql_formatter_web_interface", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "sql_formatter_web_interface"
+  s.rubygems_version = "1.8.24"
+  s.summary = "It lets you format SQL via web SQL formatting services"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sql_formatter_web_interface
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Maurizio De Santis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-29 00:00:00.000000000 Z
+dependencies: []
+description: SQL formatter web interface - Web interface for SQL formatting
+email: desantis.maurizio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- LICENSE
+- README.markdown
+- lib/sql_formatter_web_interface.rb
+- lib/sql_formatter_web_interface/to_formatted_sql.rb
+files:
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- examples/multiple_inserts.sql
+- examples/pg_view.sql
+- examples/subquery.sql
+- lib/sql_formatter_web_interface.rb
+- lib/sql_formatter_web_interface/to_formatted_sql.rb
+- spec/spec_helper.rb
+- spec/sql_formatter_web_interface_spec.rb
+- Manifest
+- sql_formatter_web_interface.gemspec
+homepage: https://github.com/ProGNOMmers/sql_formatter_web_interface
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Sql_formatter_web_interface
+- --main
+- README.markdown
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: sql_formatter_web_interface
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: It lets you format SQL via web SQL formatting services
+test_files: []