veritas-sql-generator 0.0.3

data/Gemfile

@@ -0,0 +1,33 @@
+source :rubygems
+
+gem 'veritas', '0.0.3', :git => 'git://github.com/dkubb/veritas.git'
+
+group :development do
+  gem 'backports', '~> 2.1.0'
+  gem 'jeweler',   '~> 1.5.2'
+  gem 'rake',      '~> 0.8.7'
+  gem 'rspec',     '~> 1.3.2'
+  gem 'yard',      '~> 0.6.8'
+end
+
+group :jruby do
+  platform :jruby do
+    gem 'jruby-openssl', '~> 0.7.3'
+  end
+end
+
+platforms :mri_18 do
+  group :quality do
+    gem 'flay',      '~> 1.4.2'
+    gem 'flog',      '~> 2.5.1'
+    gem 'heckle',    '~> 1.4.3'
+    gem 'json',      '~> 1.5.1'
+    gem 'metric_fu', '~> 2.1.1'
+    gem 'mspec',     '~> 1.5.17'
+    gem 'rcov',      '~> 0.9.9'
+    gem 'reek',      '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
+    gem 'roodi',     '~> 2.1.0'
+    gem 'ruby2ruby', '=  1.2.2'
+    gem 'yardstick', '~> 0.3.0'
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 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.rdoc

@@ -0,0 +1,27 @@
+= Veritas SQL Generator
+
+Relational algebra SQL generator
+
+== Note on Patches/Pull Requests
+
+* 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 it may not always be
+  clear the direction it is going. 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.
+
+== Copyright
+
+Copyright (c) 2010-2011 Dan Kubb. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+
+require File.expand_path('../lib/veritas/sql/generator/version', __FILE__)
+
+begin
+  gem('jeweler', '~> 1.5.2') if respond_to?(:gem, true)
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name        = 'veritas-sql-generator'
+    gem.summary     = 'Relational algebra SQL generator'
+    gem.description = 'Generate SQL from a veritas relation'
+    gem.email       = 'dan.kubb@gmail.com'
+    gem.homepage    = 'https://github.com/dkubb/veritas-sql-generator'
+    gem.authors     = [ 'Dan Kubb' ]
+
+    gem.version = Veritas::SQL::Generator::VERSION
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  FileList['tasks/**/*.rake'].each { |task| import task }
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler -v 1.5.2'
+end

data/TODO

@@ -0,0 +1,17 @@
+* Replace some of the conditional logic with polymorphism, especially
+  where there is special case logic 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 Veritas::Literal::Range proxy object w/factory method
+    * Create Veritas::Literal::Range::Inclusive
+    * Create Veritas::Literal::Range::Exclusive
+
+* Adjust reek and roodi scores down to lower thresholds
+
+* 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.

data/config/flay.yml

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

data/config/flog.yml

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

data/config/roodi.yml

@@ -0,0 +1,16 @@
+---
+AbcMetricMethodCheck:            { score: 7.1 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 316 }
+ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 2 }
+CyclomaticComplexityMethodCheck: { complexity: 6 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 7 }
+MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z](?:_?[a-z])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/ }
+ModuleLineCountCheck:            { line_count: 345 }
+ModuleNameCheck:                 { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
+ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -0,0 +1,124 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 22  # TODO: reduce this in UnaryRelation
+  exclude: []
+  enabled: true
+  max_instance_variables: 9  # TODO: reduce this in UnaryRelation
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 3
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: [
+    # TODO: change these methods to be class methods
+    'Veritas::SQL::Generator::Attribute#visit_veritas_attribute',
+    'Veritas::SQL::Generator::Identifier#visit_identifier',
+    'Veritas::SQL::Generator::Literal#visit_date_time',
+    'Veritas::SQL::Generator::Literal#visit_numeric',
+    'Veritas::SQL::Generator::Literal#visit_string',
+    'Veritas::SQL::Generator::Literal#visit_time',
+    'Veritas::SQL::Generator::Logic#visit_veritas_logic_predicate_inequality',
+    'Veritas::SQL::Generator::Logic#exclusive_range_exclusion_sql',
+    'Veritas::SQL::Generator::Logic#exclusive_range_inclusion_sql',
+    'Veritas::SQL::Generator::Logic#new_from_enumerable_predicate',
+    'Veritas::SQL::Generator::Logic#optional?',
+    'Veritas::SQL::Generator::Relation::Unary#collapse_subquery_for?'
+  ]
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: [
+    'Veritas::SQL::Generator::Visitor#self.handlers'
+  ]
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 7
+  exclude: [
+    'Veritas::SQL::Generator::Relation::Unary#to_s'
+  ]
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 1
+  exclude: [
+    # TODO: change these methods to be class methods
+    'Veritas::SQL::Generator::Attribute#visit_veritas_attribute',
+    'Veritas::SQL::Generator::Identifier#visit_identifier',
+    'Veritas::SQL::Generator::Literal#visit_numeric',
+    'Veritas::SQL::Generator::Literal#visit_string',
+    'Veritas::SQL::Generator::Logic#visit_veritas_logic_predicate_inequality',
+    'Veritas::SQL::Generator::Logic#exclusive_range_exclusion_sql',
+    'Veritas::SQL::Generator::Logic#exclusive_range_inclusion_sql',
+    'Veritas::SQL::Generator::Logic#new_from_enumerable_predicate',
+    'Veritas::SQL::Generator::Logic#optional?',
+    'Veritas::SQL::Generator::Relation::Unary#collapse_subquery_for?'
+  ]
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: [
+    # TODO: split Range handling methods into separate class/module
+    'Veritas::SQL::Generator::Logic'
+  ]
+  enabled: true
+  max_copies: 1
+  min_clump_size: 2
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true

data/config/yardstick.yml

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

data/lib/veritas-sql-generator.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'veritas/sql/generator'

data/lib/veritas/base_relation.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Veritas
+
+  # A class that represents a base relation in an RDBMS
+  class BaseRelation < Relation
+
+    # The base relation name
+    #
+    # @example
+    #   name = base_relation.name
+    #
+    # @return [#to_s]
+    #
+    # @api public
+    attr_reader :name
+
+    # Initialize a base relation
+    #
+    # @param [#to_s] name
+    #   the relation name
+    # @param [Header, #to_ary] header
+    #   the relation header
+    # @param [Enumerable] tuples
+    #   the relation tuples
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(name, *args)
+      super(*args)
+      @name = Immutable.freeze_object(name.to_s)
+    end
+
+  end # class BaseRelation
+end # module Veritas

data/lib/veritas/sql/generator.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'date'
+require 'time'
+
+require 'veritas'
+
+require 'veritas/base_relation'
+
+require 'veritas/sql/generator/visitor'
+
+require 'veritas/sql/generator/identifier'
+require 'veritas/sql/generator/attribute'
+require 'veritas/sql/generator/direction'
+require 'veritas/sql/generator/literal'
+require 'veritas/sql/generator/logic'
+
+require 'veritas/sql/generator/relation'
+require 'veritas/sql/generator/relation/unary'
+require 'veritas/sql/generator/relation/base'
+require 'veritas/sql/generator/relation/binary'
+require 'veritas/sql/generator/relation/set'
+
+require 'veritas/sql/generator/version'
+
+module Veritas
+  module SQL
+    module Generator
+
+      # Raised when an invalid relation is visited
+      class InvalidRelationError < StandardError; end
+
+    end # module Generator
+  end # module SQL
+end # module Veritas

data/lib/veritas/sql/generator/attribute.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Veritas
+  module SQL
+    module Generator
+
+      # Generates an SQL statement for an attribute
+      module Attribute
+        include Identifier
+
+        # Visit an Attribute
+        #
+        # @param [Attribute] attribute
+        #
+        # @return [#to_s]
+        #
+        # @api private
+        def visit_veritas_attribute(attribute)
+          visit_identifier(attribute.name)
+        end
+
+      end # module Attribute
+    end # module Generator
+  end # module SQL
+end # module Veritas

data/lib/veritas/sql/generator/direction.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Veritas
+  module SQL
+    module Generator
+
+      # Generates an SQL statement for a direction
+      module Direction
+        include Attribute
+
+        # Visit an Ascending Direction
+        #
+        # @param [Relation::Operation::Order::Ascending] direction
+        #
+        # @return [#to_s]
+        #
+        # @api private
+        def visit_veritas_relation_operation_order_ascending(direction)
+          dispatch direction.attribute
+        end
+
+        # Visit an Descending Direction
+        #
+        # @param [Relation::Operation::Order::Descending] direction
+        #
+        # @return [#to_s]
+        #
+        # @api private
+        def visit_veritas_relation_operation_order_descending(direction)
+          "#{dispatch direction.attribute} DESC"
+        end
+
+      end # module Direction
+    end # module Generator
+  end # module SQL
+end # module Veritas

data/lib/veritas/sql/generator/identifier.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Veritas
+  module SQL
+    module Generator
+
+      # Generates an SQL statement for an identifier
+      module Identifier
+
+        QUOTE         = '"'.freeze
+        ESCAPED_QUOTE = '""'.freeze
+
+        # Quote the identifier
+        #
+        # @param [#to_s] identifier
+        #
+        # @return [#to_s]
+        #
+        # @api private
+        def visit_identifier(identifier)
+          "#{QUOTE}#{identifier.to_s.gsub(QUOTE, ESCAPED_QUOTE)}#{QUOTE}"
+        end
+
+      end # module Identifier
+    end # module Generator
+  end # module SQL
+end # module Veritas