RubyGems - sqlconstructor - Versions diffs - 0.1 - Mend

sqlconstructor 0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (80) hide show

checksums.yaml +15 -0
data/LICENSE.md +16 -0
data/README.md +161 -0
data/Rakefile +11 -0
data/doc/Object.html +267 -0
data/doc/Rakefile.html +150 -0
data/doc/SQLAliasedList.html +717 -0
data/doc/SQLColumn.html +326 -0
data/doc/SQLCondList.html +318 -0
data/doc/SQLConditional.html +1082 -0
data/doc/SQLConditional/BasicCond.html +325 -0
data/doc/SQLConstructor.html +763 -0
data/doc/SQLConstructor/BasicDelete.html +383 -0
data/doc/SQLConstructor/BasicDelete_mysql.html +368 -0
data/doc/SQLConstructor/BasicInsert.html +339 -0
data/doc/SQLConstructor/BasicInsert_mysql.html +325 -0
data/doc/SQLConstructor/BasicJoin.html +408 -0
data/doc/SQLConstructor/BasicJoin_mysql.html +439 -0
data/doc/SQLConstructor/BasicSelect.html +554 -0
data/doc/SQLConstructor/BasicSelect_example.html +288 -0
data/doc/SQLConstructor/BasicSelect_mysql.html +466 -0
data/doc/SQLConstructor/BasicUnion.html +396 -0
data/doc/SQLConstructor/BasicUpdate.html +409 -0
data/doc/SQLConstructor/BasicUpdate_mysql.html +310 -0
data/doc/SQLConstructor/GenericQuery.html +797 -0
data/doc/SQLConstructor/QAttr.html +398 -0
data/doc/SQLConstructorTest.html +603 -0
data/doc/SQLExporter.html +382 -0
data/doc/SQLExporter/Exporter_generic.html +413 -0
data/doc/SQLExporter/Exporter_mysql.html +395 -0
data/doc/SQLObject.html +525 -0
data/doc/SQLValList.html +322 -0
data/doc/SQLValue.html +375 -0
data/doc/created.rid +12 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +356 -0
data/doc/js/darkfish.js +118 -0
data/doc/js/jquery.js +32 -0
data/doc/js/quicksearch.js +114 -0
data/doc/js/thickbox-compressed.js +10 -0
data/doc/lib/dialects/example-constructor_rb.html +52 -0
data/doc/lib/dialects/mysql-constructor_rb.html +52 -0
data/doc/lib/dialects/mysql-exporter_rb.html +54 -0
data/doc/lib/sqlconditional_rb.html +64 -0
data/doc/lib/sqlconstructor_rb.html +52 -0
data/doc/lib/sqlerrors_rb.html +54 -0
data/doc/lib/sqlexporter_rb.html +55 -0
data/doc/lib/sqlobject_rb.html +54 -0
data/doc/rdoc.css +763 -0
data/doc/test/queries_rb.html +56 -0
data/doc/test_rb.html +52 -0
data/lib/dialects/example-constructor.rb +45 -0
data/lib/dialects/mysql-constructor.rb +247 -0
data/lib/dialects/mysql-exporter.rb +108 -0
data/lib/sqlconditional.rb +196 -0
data/lib/sqlconstructor.rb +708 -0
data/lib/sqlerrors.rb +15 -0
data/lib/sqlexporter.rb +125 -0
data/lib/sqlobject.rb +284 -0
data/test/queries.rb +92 -0
metadata +121 -0

data/doc/test/queries_rb.html ADDED

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>File: queries.rb [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+  <script src="../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">2014-08-28 15:20:52 +0400</dd>
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+          <li>test/unit</li>
+          <li>sqlconstructor</li>
+        </ul>
+      </dd>
+    </dl>
+  </div>
+  <div id="documentation">
+    <div class="description">
+      <h2>Description</h2>
+    </div>
+  </div>
+</body>
+</html>

data/doc/test_rb.html ADDED

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>File: test.rb [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+  <script src="./js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">2014-08-29 10:20:36 +0400</dd>
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+        </ul>
+      </dd>
+    </dl>
+  </div>
+  <div id="documentation">
+    <div class="description">
+      <h2>Description</h2>
+    </div>
+  </div>
+</body>
+</html>

data/lib/dialects/example-constructor.rb ADDED

@@ -0,0 +1,45 @@
+class SQLConstructor::BasicSelect_example < SQLConstructor::BasicSelect
+    # attr_reader :attr_foo
+    ##########################################################################
+    #   Class constructor.
+    #   Init any attributes here. Do not forget to call 'super'!
+    #   _caller     - the caller object
+    #   *list       - list of sources for the FROM clause
+    ##########################################################################
+    def initialize ( _caller, *list )
+        super
+        # @attr_foo = false
+    end
+    ##########################################################################
+    #   Define your methods here.
+    #   If your dialect supports a keyword FOO, so that you would want to
+    #   construct something like
+    #       SELECT a FROM t WHERE b=1 FOO 5
+    #   you'll need to implement a foo() method here and further use it like
+    #       SQLConstructor.new.select(:a).from('t').where.eq(:b,1).foo(5)
+    ##########################################################################
+    # def foo ( value = nil )
+    #     @attr_foo = value
+    #     return self
+    # end
+    #############################################################################
+    #   You may do mostly anything here, but don't forget to call method_missing
+    #   of the parent ( 'return super' )
+    #############################################################################
+    def method_missing ( method, *args )
+        return super
+    end
+end

data/lib/dialects/mysql-constructor.rb ADDED

@@ -0,0 +1,247 @@
+VALID_INDEX_HINTS = [ :use_index, :force_index, :ignore_index,
+                      :use_key, :ignore_key, :force_key ]
+##########################################################################################
+#   MySQL dialect descendant of BasicSelect class
+##########################################################################################
+class SQLConstructor::BasicSelect_mysql < SQLConstructor::BasicSelect
+    attr_reader :attr_high_priority, :attr_straight_join, :attr_sql_result_size,
+                :attr_sql_cache, :attr_sql_calc_found_rows, :attr_limit, :attr_group_by_with_rollup
+    METHODS = {
+      :straight_join => SQLConstructor::QAttr.new( :name => 'attr_straight_join',
+                                                   :text => 'STRAIGHT_JOIN' ),
+      :sql_cache => SQLConstructor::QAttr.new( :name => 'attr_sql_cache', :text => 'SQL_CACHE'),
+      :sql_no_cache => SQLConstructor::QAttr.new( :name => 'attr_sql_cache', :text => 'SQL_NO_CACHE'),
+      :high_priority => SQLConstructor::QAttr.new( :name => 'attr_high_priority',:text => 'HIGH_PRIORITY' ),
+      :sql_calc_found_rows  => SQLConstructor::QAttr.new( :name => 'attr_sql_calc_found_rows',
+                                                          :text => 'SQL_CALC_FOUND_ROWS' ),
+      :sql_small_result     => SQLConstructor::QAttr.new( :name => 'attr_sql_result_size',
+                                                          :text => 'SQL_SMALL_RESULT' ),
+      :sql_big_result       => SQLConstructor::QAttr.new( :name => 'attr_sql_result_size',
+                                                          :text => 'SQL_BIG_RESULT' ),
+      :sql_buffer_result    => SQLConstructor::QAttr.new( :name => 'attr_sql_result_size',
+                                                          :text => 'SQL_BUFFER_RESULT' ),
+      :limit                => SQLConstructor::QAttr.new( :name => 'attr_limit',
+                                                          :text => 'LIMIT', :val => SQLObject ),
+      :group_by_with_rollup => SQLConstructor::QAttr.new( :name => 'attr_group_by_with_rollup',
+                                                          :text => "WITH ROLLUP" ),
+    }
+    ##########################################################################
+    #   Class constructor.
+    #   _caller     - the caller object
+    #   *list       - list of sources for the FROM clause
+    ##########################################################################
+    def initialize ( _caller, *list )
+        super
+    end
+    ##########################################################################
+    #   Send missing methods calls to the @caller object, and also handle
+    #   JOINs, UNIONs and INDEX hints
+    ##########################################################################
+    def method_missing ( method, *args )
+         # Handle all [*_]join calls:
+        return _addJoin( method, *args )  if method.to_s =~ /^[a-z_]*join$/
+          # Handle all valid *_index/*_key calls:
+        return _addIndexes( method, *args )  if VALID_INDEX_HINTS.include? method
+        super
+    end
+  #########
+  private
+  #########
+    ##########################################################################
+    #   Adds a USE/FORCE/IGNORE INDEX clause for the last objects in for_vals
+    #   argument.
+    ##########################################################################
+    def _addIndexes ( type, *list )
+        type = type.to_s
+        type.upcase!.gsub! /_/, ' '
+        @attr_index_hints ||= [ ]
+         # set the attr_index_hints for the last object in for_vals
+        last_ind = @attr_from.val.length - 1
+        @attr_index_hints[last_ind] = { :type => type, :list => SQLObject.get( list ) }
+        @string = nil
+        return self
+    end
+end
+##########################################################################################
+#   MySQL dialect descendant of BasicDelete class
+##########################################################################################
+class SQLConstructor::BasicDelete_mysql < SQLConstructor::BasicDelete
+    attr_reader :del_ignore, :del_quick, :del_low_priority, :attr_limit
+    METHODS = {
+     :low_priority => SQLConstructor::QAttr.new( :name => 'del_low_priority',
+                                                 :text => 'LOW_PRIORITY' ),
+     :quick        => SQLConstructor::QAttr.new( :name => 'del_quick',  :text => 'QUICK '),
+     :ignore       => SQLConstructor::QAttr.new( :name => 'del_ignore', :text => 'IGNORE'),
+     :limit => SQLConstructor::QAttr.new( :name => 'attr_limit', :text => 'LIMIT', :val => SQLObject)
+    }
+    ##########################################################################
+    #   Class constructor.
+    #   _caller     - the caller object
+    ##########################################################################
+    def initialize ( _caller )
+        super
+    end
+    ##########################################################################
+    #   Handle JOINs or send call to the parent.
+    ##########################################################################
+    def method_missing ( method, *args )
+         # Handle all [*_]join calls:
+        return _addJoin( method, *args )  if method =~ /^[a-z_]*join$/
+        super
+    end
+end
+##########################################################################################
+#   MySQL dialect descendant of BasicInsert class
+##########################################################################################
+class SQLConstructor::BasicInsert_mysql < SQLConstructor::BasicInsert
+    attr_reader :ins_priority, :ins_quick, :ins_ignore, :ins_on_duplicate_key_update
+    METHODS = {
+     :low_priority  => SQLConstructor::QAttr.new( :name => 'ins_priority', :text => 'LOW_PRIORITY' ),
+     :delayed       => SQLConstructor::QAttr.new( :name => 'ins_priority', :text => 'DELAYED'       ),
+     :high_priority => SQLConstructor::QAttr.new( :name => 'ins_priority', :text => 'HIGH_PRIORITY' ),
+     :quick         => SQLConstructor::QAttr.new( :name => 'ins_quick',    :text => 'QUICK'         ),
+     :ignore        => SQLConstructor::QAttr.new( :name => 'ins_ignore',   :text => 'IGNORE'        ),
+     :on_duplicate_key_update => SQLConstructor::QAttr.new(
+                                   :name => 'ins_on_duplicate_key_update',
+                                   :text => 'ON DUPLICATE KEY UPDATE',
+                                   :val  => SQLConditional
+                                 )
+    }
+    ##########################################################################
+    #   Class constructor.
+    #   _caller     - the caller object
+    ##########################################################################
+    def initialize ( _caller )
+        super
+    end
+end
+##########################################################################################
+#   MySQL dialect descendant of BasicUpdate class
+##########################################################################################
+class SQLConstructor::BasicUpdate_mysql < SQLConstructor::BasicUpdate
+    attr_reader :upd_low_priority, :upd_ignore, :attr_limit
+    METHODS = {
+     :low_priority => SQLConstructor::QAttr.new( :name => 'upd_low_priority', :text => 'LOW_PRIORITY'),
+     :ignore       => SQLConstructor::QAttr.new( :name => 'upd_ignore', :text => 'IGNORE' ),
+     :limit        => SQLConstructor::QAttr.new( :name => 'attr_limit', :text => 'LIMIT',
+                                                 :val => SQLObject )
+    }
+    ##########################################################################
+    #   Class constructor.
+    #   _caller     - the caller object
+    ##########################################################################
+    def initialize ( _caller, *list )
+        super
+    end
+end
+##########################################################################################
+#   MySQL dialect descendant of BasicJoin class
+##########################################################################################
+class SQLConstructor::BasicJoin_mysql < SQLConstructor::BasicJoin
+    VALID_JOINS = [ "join", "inner_join", "cross_join", "left_join", "right_join",
+                    "left_outer_join", "right_outer_join",
+                    "natural_join", "natural_left_join", "natural_right_join",
+                    "natural_left_outer_join", "natural_right_outer_join" ]
+    ##########################################################################
+    #   Class contructor. Takes a caller object as the first argument, JOIN
+    #   type as the second argument, and a list of sources for the JOIN clause
+    ##########################################################################
+    def initialize ( _caller, type, *sources )
+        type = type.to_s
+        if ! VALID_JOINS.include? type
+            raise NoMethodError, ERR_UNKNOWN_METHOD + ": " + type
+        end
+        super
+    end
+    ##########################################################################
+    #   Adds a USE/FORCE/IGNORE INDEX clause for the last objects in for_vals
+    #   argument.
+    ##########################################################################
+    def _addIndexes ( type, *list )
+        type = type.to_s
+        type.upcase!.gsub! /_/, ' '
+        @attr_index_hints ||= [ ]
+         # set the attr_index_hints for the last object in for_vals
+        last_ind = @join_sources.length - 1
+        @attr_index_hints[last_ind] = { :type => type, :list => SQLObject.get( list ) }
+        @string = nil
+        return self
+    end
+    ##########################################################################
+    #   Export to string with index hints included
+    ##########################################################################
+    def to_s
+        return @string  if @string
+        result  = @type + " " + to_sWithAliasesIndexes( @join_sources )
+        result += @exporter.separator
+        result += "ON " + @join_on.val.to_s  if @join_on
+        @string = result
+    end
+    ##########################################################################
+    #   Handles INDEX hints or sends the call to the parent
+    ##########################################################################
+    def method_missing ( method, *args )
+         # Handle all valid *_index/*_key calls:
+        return _addIndexes( method, *args )  if VALID_INDEX_HINTS.include? method
+        super
+    end
+  ########
+  private
+  ########
+    ##########################################################################
+    #   Returns a string of objects in list merged with @attr_index_hints
+    ##########################################################################
+    def to_sWithAliasesIndexes ( list )
+        list = [ list ]  if ! [ Array, SQLValList, SQLAliasedList ].include? list.class
+        arr  = [ ]
+        list.each_with_index do |item,i|
+            _alias = item.alias ? " " + item.alias.to_s : ""
+            str = item.to_s + _alias
+            if @attr_index_hints
+                index_hash = @attr_index_hints[i]
+                str += " " + index_hash[:type] + " " + index_hash[:list].to_s
+            end
+            arr << str
+        end
+        return arr.join ','
+    end
+end

data/lib/dialects/mysql-exporter.rb ADDED

@@ -0,0 +1,108 @@
+    #####################################################################################
+    #   MySQL dialect translator class.
+    #####################################################################################
+    class SQLExporter::Exporter_mysql < SQLExporter::Exporter_generic
+        attr_reader :dialect
+         # The main rule for the MySQL SELECT query syntax
+        SELECT_SYNTAX = [
+                            "SELECT",
+                            :attr_distinction,
+                            :attr_high_priority,
+                            :attr_straight_join,
+                            :attr_sql_result_size,
+                            :attr_sql_cache,
+                            :attr_sql_calc_found_rows,
+                            :attr_expression,
+                            :attr_from,
+                            :attr_joins,
+                            :attr_where,
+                            :attr_group_by,
+                            :attr_group_by_order,
+                            :attr_group_by_with_rollup,
+                            :attr_having,
+                            :attr_order_by,
+                            :attr_order_by_order,
+                            :attr_limit,
+                            :attr_unions
+                        ]
+         # The main rule for the MySQL DELETE query syntax
+        DELETE_SYNTAX = [
+                            "DELETE",
+                            :del_low_priority,
+                            :del_quick,
+                            :del_ignore,
+                            :attr_from,
+                            :attr_where,
+                            :attr_order_by,
+                            :attr_limit
+                        ]
+        INSERT_SYNTAX = [
+                            "INSERT",
+                            :ins_priority,
+                            :ins_ignore,
+                            :ins_into,
+                            :ins_values,
+                            :ins_set,
+                            :ins_select,
+                            :ins_on_duplicate_key_update
+                        ]
+        UPDATE_SYNTAX = [
+                            "UPDATE",
+                            :upd_low_priority,
+                            :upd_ignore,
+                            :upd_tables,
+                            :upd_set,
+                            :attr_where,
+                            :attr_order_by,
+                            :attr_limit
+                        ]
+        def initialize ( tidy )
+            @tidy = tidy
+            @dialect = 'mysql'
+            super tidy   # ha ha, "super tidy" :)
+        end
+        #############################################################################
+        #   Forms a string for the FROM clause from the objects attributes @attr_from
+        #   and @attr_index_hints
+        #############################################################################
+        def attr_from ( obj )
+            result = ""
+            if obj.attr_from
+                result = "FROM " + to_sWithAliasesIndexes( obj, obj.attr_from.val )
+            end
+            return result
+        end
+      ########
+      private
+      ########
+        #############################################################################
+        #   Returns a string of objects in list merged with indexes of obj
+        #############################################################################
+        def to_sWithAliasesIndexes ( obj, list )
+            list = [ list ]  if ! [ Array, SQLValList, SQLAliasedList ].include? list.class
+            arr  = [ ]
+            list.each_with_index do |item,i|
+                _alias = item.alias ? " " + item.alias.to_s : ""
+                str = item.to_s + _alias
+                if obj.attr_index_hints
+                    index_hash = obj.attr_index_hints[i]
+                    str += " " + index_hash[:type] + " " + index_hash[:list].to_s
+                end
+                arr << str
+            end
+            return arr.join ','
+        end
+    end