sqlconstructor 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWUyODI0Yzc1YzQyMDE1NmYyNTZhMzAxNjk2NjA5OTQzY2Y2MzY1OQ==
+  data.tar.gz: !binary |-
+    ODVjYTI4ZTY5MWRkOGZkMzJiNmUzZTlmM2VjYzNlYjljNjRiODUxNA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmZkZTQzYTg5MDg4Mzc1YTI2NDlhNDIzYjdlNjQ5ZjE1MGQxMGU0ZmRiNGUz
+    NDQzY2FlZTEyZGM5MDc5ZTM1Mzg5MWU1ZTU3MWZkMzE2OWVmM2UxMmYwMjcz
+    NGJiYmVmMTExYzg5MTg5YzU5NjUxYmQzYWU4NzQ2NGExMWM0MmY=
+  data.tar.gz: !binary |-
+    MTIyMjEyMzljYzc5OGNlMzJmNjAyM2MxZWI3YmFkMDIxYjcyYmEyMjAzNDBl
+    MmI0MzM4N2YxMjA2ZmZkY2JlNjk2NmNiNzMwZGJiMzdjYTNmYjgxMTNhMmIx
+    YjMyNjcxYjM3ZDIzY2JmNWZjZGQ4NzZhYmNlMWZmODM3MDc5ZDE=

data/LICENSE.md

@@ -0,0 +1,16 @@
+Copyright (C) 2014  V.Korol (vakorol@mail.ru)
+
+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,161 @@
+sqlconstructor-ruby
+===================
+
+SQLConstructor - Ruby gem for constructing SQL queries via object-oriented interface.
+Currently only MySQL dialect is supported, but hopefully, IBM Informix syntax will be added, too.
+It is easy to add support for mostly any SQL dialect - see files lib/dialects/example-constructor.rb
+and lib/dialects/example-exporter.rb.
+
+SQL SELECT, DELETE, UPDATE and INSERT clauses are supported. There's also an experimental 
+implementation of MySQL index hints.
+
+Column values and other data that should be escaped is passed to the methods as strings. Column
+and table names, aliases and everything that goes unescaped is passed as symbols.
+
+Detailed rdoc class documentation can be found in the doc folder.
+
+Typical usage:
+--------------
+
+```ruby
+sql = SQLConstructor.new
+sql.select( :col1, :col2 ).from( :table ).where.eq( :col3, 16 ).and.lt( :col4, 5 )
+p sql
+```
+
+will result in:
+```
+SELECT  col1,col2 FROM table WHERE  (col3 = 16  AND col4 < 5)
+```
+
+One can also construct complex queries like:
+
+```ruby
+    sql = SQLConstructor.new( :tidy => true, :dialect => 'mysql' )
+    inner_select1 = SQLConstructor.new( :tidy => true )
+    inner_select1.select( :"MAX(h.item_id)" ).from( :item_data => :d ).
+          inner_join( :call_data => :h ).on.eq( :"d.item_nm", :call_ref ).where.
+          eq( :"d.item_num", :"g.item_num" ).group_by( :"h.venue_nm" ).having.eq( :"COUNT(*)", 1 )
+    inner_select2 = SQLConstructor.new( :dialect => 'mysql', :tidy => true )
+    inner_select2.select( :"d.item_num" ).from( :item_data => :d ).
+          inner_join( :call_data => :h ).on.eq( :"d.item_nm", :call_ref ).
+          group_by( :"h.venue_nm" ).having.eq( :"COUNT(*)", 1 )
+    sql.update( :guest => :g ).set( :link_id => inner_select1).
+        where.in( :"g.item_num", inner_select2 )
+    p sql
+```
+    will produce:
+```
+    UPDATE
+     guest g
+    SET link_id=
+    (SELECT
+     MAX(h.item_id)
+    FROM item_data d
+    INNER JOIN call_data h
+    ON 
+    (d.item_nm = call_ref)
+    WHERE 
+    (d.item_num = g.item_num)
+    GROUP BY h.venue_nm
+    HAVING 
+    (COUNT(*) = 1)
+    )
+    WHERE 
+    (g.item_num IN 
+    (SELECT
+     d.item_num
+    FROM item_data d
+    INNER JOIN call_data h
+    ON 
+    (d.item_nm = call_ref)
+    GROUP BY h.venue_nm
+    HAVING 
+    (COUNT(*) = 1)
+    ))
+```
+Queries can be modified "on the fly", which can be useful for dynamic construction:
+```ruby
+    sql.delete.from( :datas ).where.ne( :x, "SOME TEXT" ).order_by( :y )
+    p sql
+```
+```
+    DELETE
+    FROM datas
+    WHERE 
+    (x != 'SOME TEXT')
+    ORDER BY y
+```
+```ruby
+    sql._remove( :order_by )
+    sql._get( :from ).push( :dataf )
+    p sql
+```
+```
+    DELETE
+    FROM datas,dataf
+    WHERE 
+    (x != 'SOME TEXT')
+```
+
+Methods
+-------
+
+The list of available methods for the SQL queries:
+
+|SELECT         |DELETE       |INSERT    |UPDATE     |JOIN      |
+|---------------|-------------|----------|-----------|----------|
+|select         |delete       |insert    |update     |on        |
+|from           |from         |into      |update_more|using     |
+|where          |where        |values    |tables     |join_more |
+|select_more    |using        |set       |set        |          |
+|having         |order_by     |columns   |where      |          |
+|distinct       |order_by_asc |select    |first      |          |
+|all            |order_by_desc|          |skip       |          |
+|distinctrow    |first        |          |           |          |
+|join           |skip         |          |           |          |
+|group_by       |             |          |           |          |
+|group_by_asc   |             |          |           |          |
+|group_by_desc  |             |          |           |          |
+|order_by       |             |          |           |          |
+|order_by_asc   |             |          |           |          |
+|order_by_desc  |             |          |           |          |
+|first          |             |          |           |          |
+|skip           |             |          |           |          |
+|union          |             |          |           |          |
+|union_all      |             |          |           |          |
+|union_distinct |             |          |           |          |
+                                                     
+
+MySQL-specific methods:                              
+
+|SELECT                  |DELETE      |INSERT                 |UPDATE      |
+|------------------------|------------|-----------------------|------------|
+|straight_join           |low_priority|low_priority           |low_priority|
+|sql_cache               |quick       |delayed                |ignore      |
+|sql_no_cache            |ignore      |high_priority          |limit       |
+|high_priority           |limit       |quick                  |            |
+|sql_calc_found_rows     |            |ignore                 |            |
+|sql_small_result        |            |on_duplicate_key_update|            |
+|sql_big_result          |            |                       |            |
+|sql_buffer_result       |            |                       |            |
+|limit                   |            |                       |            |
+|group_by_with_rollup    |            |                       |            |
+|use_index               |            |                       |            |
+|force_index             |            |                       |            |
+|ignore_index            |            |                       |            |
+|use_key                 |            |                       |            |
+|force_key               |            |                       |            |
+|ignore_key              |            |                       |            |
+|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|            |                       |            |
+ 

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/queries.rb']
+    t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test
+

data/doc/Object.html

@@ -0,0 +1,267 @@
+<?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>Class: Object</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <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 id="top" class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/sqlerrors_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/sqlerrors.rb">lib/sqlerrors.rb</a></li>
+          
+            <li><a href="./lib/sqlconstructor_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/sqlconstructor.rb">lib/sqlconstructor.rb</a></li>
+          
+            <li><a href="./lib/dialects/mysql-constructor_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/dialects/mysql-constructor.rb">lib/dialects/mysql-constructor.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link">BasicObject</p>
+        
+      </div>
+      
+
+      
+
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./SQLConstructor.html">SQLConstructor</a></li>
+        
+          <li><a href="./SQLConstructor/BasicDelete.html">SQLConstructor::BasicDelete</a></li>
+        
+          <li><a href="./SQLConstructor/BasicDelete_mysql.html">SQLConstructor::BasicDelete_mysql</a></li>
+        
+          <li><a href="./SQLConstructor/BasicInsert.html">SQLConstructor::BasicInsert</a></li>
+        
+          <li><a href="./SQLConstructor/BasicInsert_mysql.html">SQLConstructor::BasicInsert_mysql</a></li>
+        
+          <li><a href="./SQLConstructor/BasicJoin.html">SQLConstructor::BasicJoin</a></li>
+        
+          <li><a href="./SQLConstructor/BasicJoin_mysql.html">SQLConstructor::BasicJoin_mysql</a></li>
+        
+          <li><a href="./SQLConstructor/BasicSelect.html">SQLConstructor::BasicSelect</a></li>
+        
+          <li><a href="./SQLConstructor/BasicSelect_example.html">SQLConstructor::BasicSelect_example</a></li>
+        
+          <li><a href="./SQLConstructor/BasicSelect_mysql.html">SQLConstructor::BasicSelect_mysql</a></li>
+        
+          <li><a href="./SQLConstructor/BasicUnion.html">SQLConstructor::BasicUnion</a></li>
+        
+          <li><a href="./SQLConstructor/BasicUpdate.html">SQLConstructor::BasicUpdate</a></li>
+        
+          <li><a href="./SQLConstructor/BasicUpdate_mysql.html">SQLConstructor::BasicUpdate_mysql</a></li>
+        
+          <li><a href="./SQLConstructor/GenericQuery.html">SQLConstructor::GenericQuery</a></li>
+        
+          <li><a href="./SQLConstructor/QAttr.html">SQLConstructor::QAttr</a></li>
+        
+          <li><a href="./SQLExporter.html">SQLExporter</a></li>
+        
+          <li><a href="./SQLExporter/Exporter_generic.html">SQLExporter::Exporter_generic</a></li>
+        
+          <li><a href="./SQLExporter/Exporter_mysql.html">SQLExporter::Exporter_mysql</a></li>
+        
+          <li><a href="./SQLConditional.html">SQLConditional</a></li>
+        
+          <li><a href="./SQLConditional/BasicCond.html">SQLConditional::BasicCond</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+          <li><a href="./SQLAliasedList.html">SQLAliasedList</a></li>
+        
+          <li><a href="./SQLColumn.html">SQLColumn</a></li>
+        
+          <li><a href="./SQLCondList.html">SQLCondList</a></li>
+        
+          <li><a href="./SQLConstructorTest.html">SQLConstructorTest</a></li>
+        
+          <li><a href="./SQLObject.html">SQLObject</a></li>
+        
+          <li><a href="./SQLValList.html">SQLValList</a></li>
+        
+          <li><a href="./SQLValue.html">SQLValue</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">Object</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="DIALECTS_PATH">DIALECTS_PATH</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_INVALID_COL_NAME">ERR_INVALID_COL_NAME</a></dt>
+          
+          <dd class="description"><p>List of error messages</p></dd>
+          
+        
+          <dt><a name="ERR_INVALID_RULES">ERR_INVALID_RULES</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_NAME_NOT_FOUND">ERR_NAME_NOT_FOUND</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_NUMERIC_VALUE_EXPECTED">ERR_NUMERIC_VALUE_EXPECTED</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_UNKNOWN_DIALECT">ERR_UNKNOWN_DIALECT</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_UNKNOWN_METHOD">ERR_UNKNOWN_METHOD</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_UNKNOWN_OPERATOR_TYPE">ERR_UNKNOWN_OPERATOR_TYPE</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_VALUES_NUM_MISMATCH">ERR_VALUES_NUM_MISMATCH</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_WHERE_INVALID_ARGS">ERR_WHERE_INVALID_ARGS</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="ERR_WHERE_LIKE_INVALID_ARGS">ERR_WHERE_LIKE_INVALID_ARGS</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+          <dt><a name="VALID_INDEX_HINTS">VALID_INDEX_HINTS</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+