flounder 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 787c40edcbbb187dfe3103cf3ac536b8f36da6ab
-  data.tar.gz: 7b4d0797c663cebaabe2a6535370129db329ef5d
+  metadata.gz: 212f1134237b0adfe5f4f94d8f79d508a2997ce9
+  data.tar.gz: e093b402cf0cf81c9b01c178ac6b20847d4b9403
 SHA512:
-  metadata.gz: b9468c1b7af2c48c491f310103e78e201b7963f13422fdb1f83b6b8731b3f441e48a32931ee244eb3a68504d7789b178f84efaa1b75228944e6a7caba3628d21
-  data.tar.gz: 7d9e0fd8257ac9956b8e03791f6d6b7470c307c06609f265523f66e08720198b5b3f6170ec4038f56afced3c7a832c41b27dc3abab624804856f9ba233d876b5
+  metadata.gz: 8444a433354c815819d087c8c44d85bb56b3389d452d6f5ab554927e22a056763eda19383be7bd94cc4cf5c9d87b8452a61de254de30283acda9b33a881a60e7
+  data.tar.gz: 334f3c8a41c8b26ba4cf86f6ec8e36813106c4015daa2110d84a190d82854612097cb0dcbbefdf199114e72f5930d71c1798f4ae97aa86b5c221eaf317049e6a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flounder (0.16.0)
+    flounder (0.17.0)
       aggregate (~> 0.2, >= 0.2.2)
       arel (~> 5, > 5.0.1)
       connection_pool (~> 2)

data/HISTORY

@@ -1,3 +1,6 @@
+# 0.18
+  + Allows usage of relation names in where clauses.
+
 # 0.17 
   + A call to order_by fully replaces previously set ordering.
 

data/flounder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name     = "flounder"
-  s.version  = '0.17.0'
+  s.version  = '0.18.0'
   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/oss_flounder"

data/lib/flounder/helpers/entity.rb

@@ -1,15 +1,25 @@
 module Flounder::Helpers
+
+  # Helper module that helps with entity resolution. To include this module in
+  # a class, you need to provide the following two methods: 
+  # 
+  #   * has_entity?(sym) -> Boolean
+  #     Decides if a given symbol can be converted into an entity
+  #   * resolve_entity(sym) -> Entity
+  #     Resolves an entity from a symbol name.
+  #
   module Entity
     def entity_like? something
       something.kind_of?(Flounder::Entity) ||
-        something.kind_of?(Symbol) && domain.has_entity?(something)
+        something.kind_of?(Flounder::EntityAlias) ||
+        something.kind_of?(Symbol) && has_entity?(something)
     end
     def convert_to_entity something
       case something
         when Flounder::Entity, Flounder::EntityAlias
           return something
         when Symbol
-          return domain[something]
+          return resolve_entity(something)
       else
         fail "Not entity-like - yet! (#{something.inspect})"
       end

data/lib/flounder/query/base.rb

@@ -139,6 +139,18 @@ module Flounder::Query
       # should be overridden
     end
 
+    # Checks if a given symbol can be an entity after resolution. 
+    #
+    def has_entity? sym
+      domain.has_entity?(sym)
+    end
+
+    # Resolves an entity through the domain. 
+    #
+    def resolve_entity sym
+      domain[sym]
+    end
+
     # Rewrites a statement that contains bind placeholders like '$1' to
     # contain placeholders starting at offset+1. Also checks that no
     # placeholder exceeds the limit.

data/lib/flounder/query/select.rb

@@ -40,11 +40,16 @@ module Flounder::Query
 
     attr_reader :join_entity, :last_join
 
+    # maps relations that were included in this select to their entities.
+    attr_reader :relation_entity_map
+
     def _join join_node, entity
       entity = convert_to_entity(entity)
 
       @last_join = entity
 
+      @relation_entity_map = {}
+
       table = entity.table
       manager.join(table, join_node)
       add_fields_to_default(entity)
@@ -168,6 +173,24 @@ module Flounder::Query
     end
 
   private
+    # Checks if a symbol can be turned into an entity. Overwritten from base
+    # query because we want to allow entity names that are introduced through
+    # #connect as well. 
+    #
+    def has_entity? sym
+      super || relation_entity_map.has_key?(sym)
+    end
+
+    # Resolves an entity through the domain. Overwritten from base query because
+    # we want to allow entity names that are introduced through #connect as
+    # well.
+    #
+    def resolve_entity sym
+      return domain[sym] if domain.has_entity?(sym)
+      return relation_entity_map[sym] if relation_entity_map.has_key?(sym)
+
+      raise NoSuchEntity, "No such entity #{sym.inspect} either in this select statement or in the domain."
+    end
 
     # Follows a given relationship spec. Does NOT change anchoring.
     #
@@ -178,7 +201,10 @@ module Flounder::Query
         when Symbol
           relation = entity.relations[spec]
           raise "No such relation #{spec.inspect} on entity #{entity}." unless relation
+
           relation.apply(self)
+          relation_entity_map[spec] = relation.linked_entity
+
         when Hash
           spec.each do |k, v|
             follow_relation_spec(join_entity, k)
@@ -186,6 +212,7 @@ module Flounder::Query
 
             follow_relation_spec(join_entity, v)
           end
+          
         when Array
           spec.each do |v|
             follow_relation_spec(join_entity, v)

data/lib/flounder/relation.rb

@@ -10,21 +10,40 @@ module Flounder
         domain, type, name, entity_ref, join_conditions
     end
 
-    def apply query
-      entity = convert_to_entity(entity_ref)
+    def linked_entity
+      @linked_entity ||= begin
+        entity = convert_to_entity(entity_ref)
+
+        if name != entity_ref
+          # TODO maybe using name for both singular and plural is not a good
+          # idea. Maybe it is.
+          entity = entity.as(name, name)
+        end
 
-      if name != entity_ref
-        # TODO maybe using name for both singular and plural is not a good idea.
-        # Maybe it is.
-        entity = entity.as(name, name)
+        entity
       end
+    end
 
+    def apply query
       query.
-        join(entity).
+        join(linked_entity).
         on(join_conditions)
-    end    
+    end
 
   private
+    # Checks if a given symbol can be an entity after resolution. 
+    #
+    def has_entity? sym
+      domain.has_entity?(sym)
+    end
+
+    # Resolves an entity through the domain. 
+    #
+    def resolve_entity sym
+      domain[sym]
+    end
+
+    # Now that the above two methods exist, we can use this helper:
     include Flounder::Helpers::Entity
   end
 end

data/qed/joins.md

@@ -105,11 +105,17 @@ Or a more complicated example, using hashes and arrays in the join specification
 
 ~~~ruby
   # Query for users, joining posts and joining comments from posts (anchor)
-  query = users.connect(:posts => [:comments, :approver])
+  query = users.
+    connect(:posts => [:comments, :approver]).
+    where(:approver, id: 1)
 
+  # This manual route is of course always available.
+  approver = users.as(:approver, :approver)
   users.
     join(:posts).on(:id => :author_id).anchor.
     join(:comments).on(:id => :post_id).
-    join(users.as(:approver, :approver)).on(:author_id => :id).to_sql.assert == query.to_sql
+    join(approver).on(:author_id => :id).
+    where(approver, id: 1).
+    to_sql.assert == query.to_sql
 ~~~
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flounder
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Kaspar Schiess
@@ -9,114 +9,114 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5'
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5'
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: pg-hstore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: aggregate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.2
 description: "    Flounder is the missing piece between the database and your Ruby
@@ -127,14 +127,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- flounder.gemspec
 - Gemfile
 - Gemfile.lock
 - HACKING
 - HISTORY
-- LICENSE
-- README
-- flounder.gemspec
-- lib/flounder.rb
 - lib/flounder/connection.rb
 - lib/flounder/connection_pool.rb
 - lib/flounder/domain.rb
@@ -155,6 +152,8 @@ files:
 - lib/flounder/query/update.rb
 - lib/flounder/relation.rb
 - lib/flounder/symbol_extensions.rb
+- lib/flounder.rb
+- LICENSE
 - qed/applique/ae.rb
 - qed/applique/flounder.rb
 - qed/applique/setup_domain.rb
@@ -173,6 +172,7 @@ files:
 - qed/projection.md
 - qed/selects.md
 - qed/updates.md
+- README
 homepage: https://bitbucket.org/technologyastronauts/oss_flounder
 licenses:
 - MIT
@@ -183,17 +183,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Flounder is a way to write SQL simply in Ruby. It deals with everything BUT
@@ -217,4 +217,3 @@ test_files:
 - qed/projection.md
 - qed/selects.md
 - qed/updates.md
-has_rdoc: