mao 0.0.6 → 0.0.7

data/.gitignore

@@ -1 +1,18 @@
-/pkg
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/README.md

@@ -1,9 +1,18 @@
-# Mao [![Build Status](https://secure.travis-ci.org/unnali/mao.png)](http://travis-ci.org/unnali/mao)
+# Mao [![Build Status](https://secure.travis-ci.org/unnali/mao.png)](http://travis-ci.org/unnali/mao) [![Dependency Status](https://gemnasium.com/unnali/mao.png)](https://gemnasium.com/unnali/mao)
 
 **Mao Ain't an ORM.**
 
 ## mission/tenets
 
+1. From the code you have written, it should be sufficiently declarative and
+   map sufficiently predictably to SQL that you can predict the SQL produced.
+
+## releasing
+
+1. Bump `lib/mao/version.rb` as appropriate.
+2. Commit same.
+3. `rake release`
+
 ## authorship
 
 * [Timothy Leslie Allen](https://github.com/timothyleslieallen).

data/Rakefile

@@ -1,8 +1,13 @@
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
+require 'rdoc/task'
 
 task :default => :spec
 
 RSpec::Core::RakeTask.new
 
+RDoc::Task.new do |i|
+  i.rdoc_files = FileList['lib/**/*.rb']
+end
+
 # vim: set sw=2 et cc=80:

data/TODO

@@ -1,5 +1,10 @@
+Test that PG::Connection#escape_literal-less Mao.escape_literal works with
+binary data.
 Specify error handling at all levels.
-Joins/eager loads.  What syntax?  How do we prevent unexpected blowouts?
- - no auto subqueries, etc.  Thinner wrapper over SQL than AR.
+Reconnection.
 
-Do JOINs without all the "c1" "c2" "c3" business; assume (= check we can assume) that the primary table's columns come first, and secondary table's after; then just pick off the first n cols of a result tuple (where n is number of cols in primary table) and assign them to the primary table, and the remaining m (where m is no. of cols in secondary) to secondary.
+Do JOINs without all the "c1" "c2" "c3" business; assume (= check we can
+assume) that the primary table's columns come first, and secondary table's
+after; then just pick off the first n cols of a result tuple (where n is number
+of cols in primary table) and assign them to the primary table, and the
+remaining m (where m is no. of cols in secondary) to secondary.

data/lib/mao/filter.rb

@@ -24,10 +24,13 @@ module Mao::Filter
     end
   end
 
+  # Initialize a filter object with the given options.  Filters are intended to
+  # be used immutably, and all methods on same return new, immutable filters.
   def initialize(options={})
     @options = options.freeze
   end
 
+  # The options hash for this filter.
   attr_reader :options
 
   # Returns an AND filter where the current object is the LHS and +rhs+ is the
@@ -79,9 +82,9 @@ module Mao::Filter
   end
 
   # Returns a filter where the current object is checked if it IS NULL.
-  # HACK(arlen): ? Calling this "nil?" results in the world crashing down
-  # around us.  But it seems a pity to have this be not-quite-like-Ruby.  Would
-  # it be better to make #==(nil) map to IS NULL instead of = NULL?
+  #   HACK(arlen): ? Calling this "nil?" results in the world crashing down
+  #   around us.  But it seems a pity to have this be not-quite-like-Ruby.
+  #   Would it be better to make #==(nil) map to IS NULL instead of = NULL?
   def null?
     Mao::Filter::Binary.new(:op => 'IS', :lhs => self, :rhs => nil)
   end
@@ -92,9 +95,12 @@ module Mao::Filter
     Mao::Filter::Binary.new(:op => 'IN', :lhs => self, :rhs => rhs)
   end
 
+  # A reference to a column('s value) in a filter.
   class Column
     include Mao::Filter
 
+    # Produces an array which becomes part of the resulting Mao::Query's
+    # options, used by Mao::Query#sql.
     def finalize
       if @options[:table]
         [:Column, @options[:table], @options[:name]]
@@ -103,14 +109,19 @@ module Mao::Filter
       end
     end
 
+    # Used by Mao::Filter.sql to generate the actual SQL for a column
+    # reference.
     def self.sql(*opts)
       opts.map {|i| Mao.quote_ident(i.to_s)}.join(".")
     end
   end
 
+  # A binary operation on two filters.
   class Binary
     include Mao::Filter
 
+    # Produces an array which becomes part of the resulting Mao::Query's
+    # options, used by Mao::Query#sql.
     def finalize
       [:Binary,
        @options[:op],
@@ -118,6 +129,8 @@ module Mao::Filter
        Mao::Filter.finalize_or_literal(@options[:rhs])]
     end
 
+    # Used by Mao::Filter.sql to generate the actual SQL for a column
+    # reference.
     def self.sql(op, lhs, rhs)
       s = "("
       s << Mao::Filter.sql(lhs)
@@ -135,6 +148,9 @@ module Mao::Filter
   # which checks if it belongs to a column, and if so, constructs a
   # Mao::Filter::Column.
   class Table
+    # Constructs a Table; +query+ is the Mao::Query instance, and +explicit+
+    # refers to whether we need to explicitly name tables in the generated SQL.
+    # (e.g. when a JOIN is being performed)
     def initialize(query, explicit)
       @query = query
       @explicit = explicit

data/lib/mao/query.rb

@@ -9,10 +9,12 @@ class Mao::Query
 
   # A container for text that should be inserted raw into a query.
   class Raw
+    # Creates the Mao::Query::Raw with SQL +text+.
     def initialize(text)
       @text = text
     end
 
+    # The raw SQL text.
     attr_reader :text
   end
 
@@ -21,6 +23,9 @@ class Mao::Query
     Raw.new(text).freeze
   end
 
+  # Constructs the Query with reference to a table named +table+, and immutable
+  # options hash +options+.  +col_types+ is column information for the table,
+  # usually populated by a prior invocation of Mao::Query.new.
   def initialize(table, options={}, col_types=nil)
     @table, @options = table.to_sym, options.freeze
 
@@ -43,8 +48,14 @@ class Mao::Query
     @col_types = col_types.freeze
   end
 
+  # A symbol of the name of the table this Query points to.
   attr_reader :table
+
+  # The immutable options hash of this Query instance.
   attr_reader :options
+
+  # The cached information about columns and their types for the table being
+  # referred to.
   attr_reader :col_types
 
   # Returns a new Mao::Query with +options+ merged into the options of this
@@ -368,6 +379,8 @@ class Mao::Query
 
   private
 
+  # Checks that +column+ is a valid column reference in +table+, given
+  # +col_types+ for the table.
   def check_column column, table, col_types
     unless column.is_a? Symbol
       raise ArgumentError, "#{column.inspect} not a Symbol"

data/lib/mao/version.rb

@@ -1,5 +1,7 @@
 module Mao
-  VERSION = "0.0.6"
+  # The version of the last release of Mao made.  Increment when releasing a
+  # new gem.
+  VERSION = "0.0.7"
 end
 
 # vim: set sw=2 cc=80 et:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mao
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -73,7 +73,6 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - TODO
@@ -87,7 +86,6 @@ files:
 - spec/mao_spec.rb
 - spec/query_spec.rb
 - spec/spec_helper.rb
-- thoughts.rb
 homepage: https://github.com/unnali/mao
 licenses: []
 post_install_message: 

data/Gemfile.lock

@@ -1,28 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mao (0.0.4)
-      pg (~> 0.14.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    pg (0.14.1)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mao!
-  rake
-  rspec

data/thoughts.rb

@@ -1,42 +0,0 @@
-X.trans do
-  X.query(:tblSamuraiUser).join { ... }.where {
-    upp = tblSamuraiUserProduct
-
-    upp.userProductId == 188...
-
-
-    first_cond = (email == "arlen@noblesamurai.com").and(userId > 10000)
-    second_cond = x.and(y).and(z)
-
-    blah = tblSamuraiUserProduct.columnName == xyzzy
-
-    first_cond.or second_cond.or blah
-  }
-
-  my_new_record = my_old_record.merge(changes)
-
-  X.update(:tblSamuraiUser).where { userId == 610610 }.update(changes)
-end
-
-X.query(:tblSamuraiUser).where(lambda {email == "arlen@noblesamurai.com"}, lambda {userId > 10000})
-
-#Tim's thoughts:
-#
-#- We need to know what we think of statically defined r'ships b/w tables vs defining everything in place where the query is performed.
-#  Is the ActiveRecord way of defining r'ships b/w tables a good model for us?
-#  Or do we have some alternative way of statically defining this stuff?  Or do we dynamically infer it?
-#
-#  I am thinking we need a means to join which is based again on a simple hash.  For example, the hash
-#  could look like: {:from => :tblSamuraiUser.id, :to => tblSamuraiUserProduct.user_id}
-#  Then, the user could define these hash as constants, eg UserToUserProduct = blah
-#  The joins could then be brought in to the query object (perhaps a .joins method, which can either take a single hash or an array),
-#  as with a :joins key, which might map to an array of joins options hashes.
-#
-#  Anyway, those are my thoughts for now, we can chat further!
-
-
-
-# Tenet:
-#
-# From the code you have written, it should be sufficiently declarative and map
-# sufficiently predictably to SQL that you can predict the SQL produced.