axiom-sql-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d25343b68c5a6f3bdd4ed65617eb70603a9cccb
+  data.tar.gz: f9811c6a02fa2d5164bcae6834fd0efcdc1765f4
+SHA512:
+  metadata.gz: e653e67c840caddfad52723fd1cd9b292f5b938e58c2b4d0134ed62031d4255e4ea23706ee8b502b4af97615524bac89c4b1476ad4637a77f24d5734b9ee1742
+  data.tar.gz: b74b606e245597593ae5967b83511d0d84077029ab70e4fb688f0f0db6435841c17c0c551ae09ebf07aa82ed6450def109e7e949b7e7a25a02ae920f2f43960c

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--profile
+--order random

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/.travis.yml

@@ -0,0 +1,35 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+notifications:
+  irc:
+    channels:
+      - irc.freenode.org#datamapper
+    on_success: never
+    on_failure: change
+  email:
+    recipients:
+      - dan.kubb@gmail.com
+    on_success: never
+    on_failure: change
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    # mutant fails
+    - rvm: 1.9.3
+    - rvm: rbx-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+Contributing
+------------
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it. This library is still in early development, and the direction it is going may not always be clear. Some features may not be appropriate yet, may need to be deferred until later when the foundation for them is laid, or may be more applicable in a plugin.
+* Fork the project.
+* Make your feature addition or bug fix.
+  * Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branches.

data/Gemfile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gem 'axiom', '~> 0.0.8', :git => 'https://github.com/dkubb/axiom.git'
+
+gem 'devtools', :git => 'https://github.com/datamapper/devtools.git'
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.0.4'
+  gem 'rspec', '~> 2.13.0'
+  gem 'yard',  '~> 0.8.5.2'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.0.1'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.7.0'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.5.2'
+
+  # file system change event handling
+  gem 'listen',     '~> 0.7.3'
+  gem 'rb-fchange', '~> 0.0.6', :require => false
+  gem 'rb-fsevent', '~> 0.9.3', :require => false
+  gem 'rb-inotify', '~> 0.9.0', :require => false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', :require => false
+  gem 'rb-notifu',               '~> 0.0.4', :require => false
+  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+end
+
+group :metrics do
+  gem 'backports',       '~> 3.3', '>= 3.3.0'
+  gem 'coveralls',       '~> 0.6.4'
+  gem 'flay',            '~> 2.1.0'
+  gem 'flog',            '~> 3.2.3'
+  gem 'reek',            '~> 1.3.1', :git => 'https://github.com/troessner/reek.git'
+  gem 'simplecov',       '~> 0.7.1'
+  gem 'yardstick',       '~> 0.9.5'
+  gem 'yard-spellcheck', '~> 0.1.5'
+
+  platforms :mri_19, :rbx do
+    gem 'mutant', '~> 0.2.20'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/Guardfile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec, :cli => File.read('.rspec').split.join(' '), :keep_failed => false do
+  # run all specs if configuration is modified
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+
+  # run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"]         }
+  watch(%r{\Alib/(.+)/support/(.+)\.rb\z})                            { |m| Dir["spec/unit/#{m[1]}/#{m[2]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                               }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2013 Dan Kubb
+
+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,70 @@
+axiom-sql-generator
+===================
+
+Relational algebra SQL generator
+
+[![Gem Version](https://badge.fury.io/rb/axiom-sql-generator.png)][gem]
+[![Build Status](https://secure.travis-ci.org/dkubb/axiom-sql-generator.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/dkubb/axiom-sql-generator.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/dkubb/axiom-sql-generator.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/dkubb/axiom-sql-generator/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/axiom-sql-generator
+[travis]: https://travis-ci.org/dkubb/axiom-sql-generator
+[gemnasium]: https://gemnasium.com/dkubb/axiom-sql-generator
+[codeclimate]: https://codeclimate.com/github/dkubb/axiom-sql-generator
+[coveralls]: https://coveralls.io/r/dkubb/axiom-sql-generator
+
+Installation
+------------
+
+With Rubygems:
+
+```bash
+$ gem install axiom-sql-generator
+$ irb -rubygems
+>> require 'axiom-sql-generator'
+=> true
+```
+
+With git and local working copy:
+
+```bash
+$ git clone git://github.com/dkubb/axiom-sql-generator.git
+$ cd axiom-sql-generator
+$ rake install
+$ irb -rubygems
+>> require 'axiom-sql-generator'
+=> true
+```
+
+Usage
+-----
+
+```ruby
+# visit every node in the relation AST
+generator = Axiom::SQL::Generator::Relation.visit(relation)
+
+# generate an SQL string
+sql = generator.to_sql
+
+# generate an SQL subquery string
+subquery_sql = generator.to_subquery
+```
+
+Description
+-----------
+
+The purpose of this gem is to produce valid SQL from a [axiom](https://github.com/dkubb/axiom) relation. A relation is a representation of a query constructed using relational algebra organized into an AST. Each node in the AST corresponds to an operation defined in the algebra.
+
+The SQL produced has been verified and tested against [PostgreSQL](http://www.postgresql.org/) 9.0.4. Dialects for [MySQL](http://www.mysql.com/), [SQLite](http://www.sqlite.org/), [Oracle](http://www.oracle.com/) and [SQL Server](http://www.microsoft.com/sqlserver/) are planned.
+
+Contributing
+------------
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+Copyright
+---------
+
+Copyright © 2010-2013 Dan Kubb. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'devtools'
+
+Devtools.init_rake_tasks

data/TODO

@@ -0,0 +1,34 @@
+* Replace some of the conditional function with polymorphism, especially
+  where there is special case function for certain types of generators
+  within other generators.
+  * Replace Equality/Inequality with classes that handle all of the
+    special cases.
+  * Use different classes for inclusive/exclusive Range literals so that
+    they can be serialized to SQL differently.
+    * Create Axiom::Literal::Range proxy object w/factory method
+    * Create Axiom::Literal::Range::Inclusive
+    * Create Axiom::Literal::Range::Exclusive
+
+* Handle cases where an Inequality/Exclusion predicate is used (or a
+  Negation wrapping an Equality/Inclusion) on an *optional* attribute.
+  * Add "OR attribute IS NULL" to the statement to ensure cases when
+    the value is NULL still matches.
+
+* Handle case where Inclusion/Exclusion predicate enumerable contains a nil value.
+  * Remove the nil value from the enumerable.
+  * If the attribute is *optional*, change query so that "OR attribute IS * NULL"
+    is added to the output statement.
+
+* Handle cases where WHERE clause does and does not reference a function
+  in the SELECT list.
+  * It should collapse the inner subquery when there is no reference, and
+    keep the subquery when it is referenced.
+  * This will likely apply to projection and rename operators too.
+
+* When Restriction wraps a Summarization, and it would normally wrap the
+  statement and apply a WHERE clause, it should apply the clause using
+  HAVING instead.
+
+* Handle case where Extension does not reference a column in the
+  wrapped Summarization or Rename. It should be safe to collapse the query
+  in those cases.

data/axiom-sql-generator.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/axiom/sql/generator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'axiom-sql-generator'
+  gem.version     = Axiom::SQL::Generator::VERSION.dup
+  gem.authors     = ['Dan Kubb']
+  gem.email       = 'dan.kubb@gmail.com'
+  gem.description = 'Generate SQL from a axiom relation'
+  gem.summary     = 'Relational algebra SQL generator'
+  gem.homepage    = 'https://github.com/dkubb/axiom-sql-generator'
+  gem.licenses    = %w[MIT]
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- spec/unit`.split($/)
+  gem.extra_rdoc_files = %w[LICENSE README.md CONTRIBUTING.md TODO]
+
+  gem.add_runtime_dependency('axiom', '~> 0.1.0')
+
+  gem.add_development_dependency('rake',  '~> 10.0.4')
+  gem.add_development_dependency('rspec', '~> 2.13.0')
+  gem.add_development_dependency('yard',  '~> 0.8.5.2')
+end

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 63
+total_score: 396

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 12.0

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: axiom-sql-generator
+namespace: Axiom::SQL::Generator

data/config/reek.yml

@@ -0,0 +1,165 @@
+---
+Attribute:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Relation
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Function
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Function::Predicate#new_from_enumerable_predicate
+  - Axiom::SQL::Generator::Function::Predicate#optional?
+  - Axiom::SQL::Generator::Function::Predicate#visit_axiom_function_predicate_inequality
+  - Axiom::SQL::Generator::Identifier#visit_identifier
+  - Axiom::SQL::Generator::Identifier#visit_identifier
+  - Axiom::SQL::Generator::Literal#visit_numeric
+  - Axiom::SQL::Generator::Literal#visit_string
+  - Axiom::SQL::Generator::Literal#visit_string
+  - Axiom::SQL::Generator::Relation#column_list_for
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Function::Predicate#new_from_enumerable_predicate
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Relation::Materialized#visit_axiom_relation_materialized
+  - Axiom::SQL::Generator::Visitor#self.handlers
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Function::Predicate#inequality_sql
+  - Axiom::SQL::Generator::Function::Predicate#visit_axiom_function_predicate_equality
+RepeatedConditional:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Relation
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Relation::Binary
+  - Axiom::SQL::Generator::Relation::Unary
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Relation
+  - Axiom::SQL::Generator::Relation::Unary
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - Date#iso8601
+  - DateTime#iso8601_timediv
+  - Axiom::SQL::Generator::Function::Predicate#exclusive_range_exclusion_sql
+  - Axiom::SQL::Generator::Function::Predicate#exclusive_range_inclusion_sql
+  - Axiom::SQL::Generator::Function::Predicate#inequality_expressions
+  - Axiom::SQL::Generator::Function::Predicate#visit_axiom_function_predicate_inequality
+  - Axiom::SQL::Generator::Literal#visit_class
+  - Axiom::SQL::Generator::Relation#column_list_for
+  - Axiom::SQL::Generator::Relation#columns_for
+  - Axiom::SQL::Generator::Relation#implicit_columns
+  - Axiom::SQL::Generator::Relation#self.visit
+  - Axiom::SQL::Generator::Relation::Binary#set_operands
+  - Axiom::SQL::Generator::Relation::Binary#visit_axiom_algebra_join
+  - Axiom::SQL::Generator::Relation::Binary#visit_axiom_algebra_product
+  - Axiom::SQL::Generator::Relation::Insertion#visit_axiom_relation_operation_insertion
+  - Axiom::SQL::Generator::Relation::Materialized#generate_sql
+  - Axiom::SQL::Generator::Relation::Set#self.normalize_operand_headers
+  - Axiom::SQL::Generator::Relation::Set#visit_axiom_algebra_difference
+  - Axiom::SQL::Generator::Relation::Set#visit_axiom_algebra_intersection
+  - Axiom::SQL::Generator::Relation::Set#visit_axiom_algebra_union
+  - Axiom::SQL::Generator::Relation::Unary#reset_query_state
+  - Axiom::SQL::Generator::Relation::Unary#subquery_for
+  - Axiom::SQL::Generator::Relation::Unary#summarize_per
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_algebra_extension
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_algebra_projection
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_algebra_rename
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_algebra_restriction
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_algebra_summarization
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_relation_base
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_relation_operation_binary
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_relation_operation_limit
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_relation_operation_offset
+  - Axiom::SQL::Generator::Relation::Unary#visit_axiom_relation_operation_order
+  - Axiom::SQL::Generator::Visitor#self.method_for
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude:
+  - Date#iso8601
+  - DateTime#iso8601
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude:
+  - Axiom::SQL::Generator::Function::Predicate#new_from_enumerable_predicate
+  - Axiom::SQL::Generator::Function::Predicate#optional?
+  - Axiom::SQL::Generator::Identifier#visit_identifier
+  - Axiom::SQL::Generator::Literal#visit_numeric
+  - Axiom::SQL::Generator::Literal#visit_string
+  max_helper_calls: 0