flounder 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9860bdc14eff074ea0e340f278593cc4e489599b
-  data.tar.gz: 830bccfe9f8204a93e9eacb9c72b3b53191f82fb
+  metadata.gz: 9fa808fa17085d2e8f7c70a808ec4aa6c3b3ffe7
+  data.tar.gz: 47ab3d8800befc2e6864cb077cf715fbe1c20621
 SHA512:
-  metadata.gz: 2c93426c7de1ac2a10368dcf8f85cdd269a20d00f71229706bbd2a42ff928d2415bf157217d52167c7d2e308a6dd59cb50ad505cacf04f4425eb7210e5380d94
-  data.tar.gz: 4799ae63203ad83d6059c87efcb5c86619a054628591594e5c5cae93a10d3d1156136481b4387b4ddffb6defb0715d66d9ef31c3d01146435ecd6829973e16d0
+  metadata.gz: 2c7fdedda33c494affe87c3392049e901caa969c1a1cea7592ca3b0aad20fe1da296bb8157bcf6915a1ab626b994ced623fe952ecacab955271f25bb3385ebce
+  data.tar.gz: e2e96f3d0a887444b56212e3cef71434bbb9929b257be45c75b09089113708565890356b54a071cc7244cf68b3af5f190127aab6281c078800650ae5a70f42cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flounder (0.2.0)
+    flounder (0.4.0)
       arel (~> 5, > 5.0.1)
       connection_pool (~> 2)
       hashie (~> 3, >= 3.2)

data/flounder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name     = "flounder"
-  s.version  = '0.4.0'
+  s.version  = '0.4.1'
   s.summary  = "Flounder is a way to write SQL simply in Ruby. It deals with everything BUT object relational mapping. "
   s.email    = "kaspar.schiess@technologyastronauts.ch"
   s.homepage = "https://bitbucket.org/technologyastronauts/laboratory_flounder"

data/lib/flounder/connection.rb

@@ -79,7 +79,12 @@ module Flounder
         |entity, name, value, type_oid, binary, idx|
         # TODO remove entity resolution from each_field?
 
-        entity, name = yield name if block_given?
+        # TODO This is currently here to cover the special case of a query.
+        # Certainly needs refactoring.
+        #
+        processed_entity, processed_name = yield name if block_given?
+        entity = processed_entity || entity
+        name   = processed_name || name
 
         typecast_value = typecast(type_oid, value)
 

data/lib/flounder/query.rb

@@ -39,7 +39,7 @@ module Flounder
 
     def where conditions={}
       conditions.each do |k, v|
-        manager.where(transform_hash_condition(k, v))
+        manager.where(transform_hash(k, v))
       end
       self
     end    
@@ -79,7 +79,7 @@ module Flounder
     def on join_conditions
       join_conditions.each do |k, v|
         manager.on(
-          transform_hash_condition(k, join_field(v)))
+          transform_hash(k, join_field(v)))
       end
       self
     end
@@ -109,8 +109,8 @@ module Flounder
     #
     def order_by *field_list
       field_list.each do |field|
-        field = from_entity[field] unless field.kind_of?(Field)
-        manager.order field.fully_qualified_name
+        field = transform field
+        manager.order field
       end
       self
     end
@@ -225,22 +225,45 @@ module Flounder
         manager.project *default_projection
       end
     end
+    
+    # Called on a value for a
+    #  * order by
+    # clause, this returns a field that can be passed to Arel
+    #  * #where
+    #  * #on
+    #
+    def transform field
+      case field
+        when String
+          Immediate.new(field).to_arel_field
+        when Flounder::Field
+          field.fully_qualified_name
+        when Flounder::SymbolExtensions::Modifier
+          field.to_arel_field(from_entity).send field.kind
+      else
+        from_entity[field].arel_field
+      end
+    end
 
-    # Called on each key/value pair of a condition clause, this returns a 
-    # condition that can be passed to Arel #where. 
+    # Called on each key/value pair of a
+    #  * condition
+    #  * join
+    # clause, this returns a field that can be passed to Arel
+    #  * #where
+    #  * #on
     #
-    def transform_hash_condition field, value
+    def transform_hash field, value
       if value.kind_of? Field
         value = value.arel_field
       end
 
       case field
         when Symbol
-          condition_part(from_entity[field].arel_field, value)
+          join_and_condition_part(from_entity[field].arel_field, value)
         when Flounder::Field
-          condition_part(field.arel_field, value)
+          join_and_condition_part(field.arel_field, value)
         when Flounder::SymbolExtensions::Modifier
-          condition_part(
+          join_and_condition_part(
             field.to_arel_field(from_entity), 
             value, 
             field.kind)
@@ -248,7 +271,7 @@ module Flounder
         fail "Could not transform condition part. (#{field.inspect}, #{value.inspect})"
       end
     end
-    def condition_part arel_field, value, kind=:eq
+    def join_and_condition_part arel_field, value, kind=:eq
       case value
         when Symbol
           value_field = from_entity[value].arel_field

data/lib/flounder/symbol_extensions.rb

@@ -1,10 +1,10 @@
 module Flounder
   module SymbolExtensions
     class Modifier < Struct.new(:sym, :kind)
-      def to_arel_field from_entity
+      def to_arel_field entity
         af = case sym
           when Symbol
-            from_entity[sym].arel_field
+            entity[sym].arel_field
           when Flounder::Field
             sym.arel_field
         else
@@ -13,7 +13,7 @@ module Flounder
       end
     end
 
-    [:not_eq, :lt, :gt, :gteq, :lteq, :matches].each do |kind|
+    [:not_eq, :lt, :gt, :gteq, :lteq, :matches, :asc, :desc].each do |kind|
       define_method kind do
         Modifier.new(self, kind)
       end

data/qed/index.md

@@ -96,7 +96,7 @@ The call to `#anchor` anchors all further joins at that point.
   domain[:users].where(id: 2013).order_by(domain[:users][:id]).
     assert generates_sql(%Q(SELECT [fields] FROM "users"  WHERE "users"."id" = 2013  ORDER BY "users"."id"))
 
-  domain[:users].order_by('id').
+  domain[:users].order_by(:id).
     assert generates_sql(%Q(SELECT [fields] FROM "users"   ORDER BY "users"."id"))
 ~~~
 

data/qed/ordering.md

@@ -0,0 +1,57 @@
+Results can be ordered.
+
+~~~ruby
+  sql = domain[:posts].order_by(:title).to_sql
+
+  sql.assert == 'SELECT "posts"."id" AS _posts_id, "posts"."title" AS _posts_title, "posts"."text" AS _posts_text, "posts"."user_id" AS _posts_user_id, "posts"."approver_id" AS _posts_approver_id FROM "posts"   ORDER BY "posts"."title"'
+~~~
+
+They can be ordered ASC.
+
+~~~ruby
+  sql = domain[:posts].order_by(:title.asc).to_sql
+
+  sql.assert == 'SELECT "posts"."id" AS _posts_id, "posts"."title" AS _posts_title, "posts"."text" AS _posts_text, "posts"."user_id" AS _posts_user_id, "posts"."approver_id" AS _posts_approver_id FROM "posts"   ORDER BY "posts"."title" ASC'
+~~~
+
+They can also be ordered DESC.
+
+~~~ruby
+  sql = domain[:posts].order_by(:title.desc).to_sql
+
+  sql.assert == 'SELECT "posts"."id" AS _posts_id, "posts"."title" AS _posts_title, "posts"."text" AS _posts_text, "posts"."user_id" AS _posts_user_id, "posts"."approver_id" AS _posts_approver_id FROM "posts"   ORDER BY "posts"."title" DESC'
+~~~
+
+Multiple fields can be used.
+
+~~~ruby
+  sql = domain[:posts].order_by(:title, :text).to_sql
+
+  sql.assert == 'SELECT "posts"."id" AS _posts_id, "posts"."title" AS _posts_title, "posts"."text" AS _posts_text, "posts"."user_id" AS _posts_user_id, "posts"."approver_id" AS _posts_approver_id FROM "posts"   ORDER BY "posts"."title", "posts"."text"'
+~~~
+
+Multiple fields can be used with ASC, DESC.
+
+~~~ruby
+  sql = domain[:posts].order_by(:title.asc, :text.desc).to_sql
+
+  sql.assert == 'SELECT "posts"."id" AS _posts_id, "posts"."title" AS _posts_title, "posts"."text" AS _posts_text, "posts"."user_id" AS _posts_user_id, "posts"."approver_id" AS _posts_approver_id FROM "posts"   ORDER BY "posts"."title" ASC, "posts"."text" DESC'
+~~~
+
+Ordering can be defined in many ways.
+
+~~~ruby
+  user = users.first
+
+  inserted = posts.insert(:title => 'ABC', :text => 'Alphabet', :user_id => user.id).returning '*'
+
+  domain[:posts].order_by(:title).map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by(:title.asc).map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by(:title.desc).map(&:title).assert == ['First Light', 'ABC']
+  domain[:posts].order_by('title').map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by('title ASC').map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by('title DESC').map(&:title).assert == ['First Light', 'ABC']
+  domain[:posts].order_by(posts[:title]).map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by(posts[:title].asc).map(&:title).assert == ['ABC', 'First Light']
+  domain[:posts].order_by(posts[:title].desc).map(&:title).assert == ['First Light', 'ABC']
+~~~

data/qed/projection.md

@@ -0,0 +1,19 @@
+Without projection, result objects will be packaged in a subhash.
+
+~~~ruby
+  user = posts.join(users).on(:user_id => :id).
+    first.user
+
+  user.id.assert != nil
+  user.name.assert == 'John Snow'
+~~~
+
+When projecting, all result data will be toplevel and only the projected data is loaded.
+
+~~~ruby
+  result = posts.join(users).on(:user_id => :id).
+    project(users[:name]).first
+
+  result.id.assert == nil # Not loaded.
+  result.name.assert == 'John Snow'
+~~~

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flounder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kaspar Schiess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arel
@@ -113,6 +113,8 @@ files:
 - qed/flounder.sql
 - qed/index.md
 - qed/inserts.md
+- qed/ordering.md
+- qed/projection.md
 - qed/results.md
 - qed/selects.md
 - qed/updates.md
@@ -148,6 +150,8 @@ test_files:
 - qed/flounder.sql
 - qed/index.md
 - qed/inserts.md
+- qed/ordering.md
+- qed/projection.md
 - qed/results.md
 - qed/selects.md
 - qed/updates.md