flounder 0.11.7 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40563f93ef03c6003326865768ad7c1b9db8e8f5
-  data.tar.gz: 2b98f903f37a846635937120b5fda6747be4fd5d
+  metadata.gz: 89027cfd2718cdb12b179408c60d7597333b8f35
+  data.tar.gz: 94b4670b43b45137c6c7d111ded56903b1dc514d
 SHA512:
-  metadata.gz: 3fa1f0d537188df5b47f953193172267b34df442f88bd1c9ec066f40d38c5febd3ff3c54bf9d155366c488e7ca614cf1f53f7246c5c3273a60f864fa10b49a4e
-  data.tar.gz: c8aee48a61009a255747fd3d80728661fd47087c4ac5a2f5e72b0aa385f357655c1c97492b109ace3a17bfa9d789999f002eee1b0ce7efdb325661bbdb6a8a33
+  metadata.gz: cc55bcecfa205bd8c7897b2a1b71201cc8fcc06907ac2d10f7609230a23bfde2e7fe9e765a2ed300722a3e78b49b758a4815b50f5411eb318353ee72394290d1
+  data.tar.gz: 60b493884663840097701f8bfb8f9707c214e5a2ac85c05f25ec36d1ab144f567e928618d317f1c5fe0f5c1c24997241fe8f76126226d825b2667510ede96313

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    flounder (0.11.5)
+    flounder (0.11.7)
+      aggregate
       arel (~> 5, > 5.0.1)
       connection_pool (~> 2)
       hashie (~> 3, >= 3.2)
@@ -13,6 +14,7 @@ GEM
   specs:
     ae (1.8.2)
       ansi
+    aggregate (0.2.2)
     ansi (1.4.3)
     arel (5.0.1.20140414130214)
     brass (1.2.1)

data/HISTORY

@@ -1,3 +1,6 @@
+# 0.12 
+  + domain#stats keeps a histogram of execution times. 
+
 # 0.11
 
   + #anchor now only affects the interpretation of #on, doesn't modify return 

data/flounder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name     = "flounder"
-  s.version  = '0.11.7'
+  s.version  = '0.12.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"
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'hashie', '~> 3', '>= 3.2'
   s.add_runtime_dependency 'connection_pool', '~> 2'
   s.add_runtime_dependency 'pg-hstore', '~> 1.2', '>= 1.2.0'
+  s.add_runtime_dependency 'aggregate', '~> 0.2', '>= 0.2.2'
   
   s.files         = Dir['**/*']
   s.test_files    = Dir['qed/**/*']

data/lib/flounder/domain.rb

@@ -1,6 +1,7 @@
 
 require 'forwardable'
 require 'logger'
+require 'aggregate'
 
 module Flounder
   class Domain
@@ -48,6 +49,22 @@ module Flounder
       end
     end
 
+    # Returns an aggregate of all query wall clock times. Please see 
+    # https://github.com/josephruscio/aggregate for more information on this 
+    # object. 
+    #
+    # @return [Aggregate] statistics for this thread
+    # 
+    def stats
+      Thread.current[:__flounder_stats] ||= Aggregate.new
+    end
+
+    # Resets this threads stats. 
+    #
+    def reset_stats
+      Thread.current[:__flounder_stats] = nil
+    end
+
     # Returns the entity with the given plural name. 
     #
     def [] name
@@ -72,6 +89,7 @@ module Flounder
       @logger.info sql
     end
     def log_bm measure
+      stats << measure.total * 1_000
       @logger.info "Query took #{measure}."
     end
 

data/qed/database_technicalities.md

@@ -48,4 +48,39 @@ When connecting to a database, you can use the `search_path` argument to install
     path = result.to_a.first.first.last
     path.assert == 'public, test'
   end
+~~~
+
+# Benchmarking
+
+The time taken for each query is measured and aggregated. If you want to get data about how many queries you've executed and what time it took to execute them, please look at the following methods. 
+
+~~~ruby
+  stats = domain.stats
+
+  # Please see https://github.com/josephruscio/aggregate for more documentation.
+  stats.count.assert > 0
+
+  # Can be printed to look nice
+  stats.count
+  stats.mean # kept in miliseconds
+  stats.to_s # binary histogram!
+~~~
+
+Statistics are per thread.
+
+~~~ruby
+  # stats are per thread: 
+  t = Thread.start do
+    Thread.current.abort_on_exception = true
+    domain.stats.count.assert == 0
+    domain.stats.refute == stats
+  end
+  t.join
+~~~
+
+They can be reset, again per thread.
+
+~~~ruby
+  domain.reset_stats
+  domain.stats.count.assert == 0
 ~~~

data/qed/index.md

@@ -72,10 +72,5 @@ By default, symbols are interpreted as field names in the entity that you start
     assert generates_sql("SELECT [fields] FROM \"users\"  WHERE \"posts\".\"id\" = 1")
 ~~~
 
-# Selective projection
-
-~~~ruby
-  domain[:users].where(id: 2013).project(domain[:users][:id]).
-    to_sql.assert == %Q(SELECT "users"."id" FROM "users"  WHERE "users"."id" = 2013)
-~~~
+TODO links to other documentation
 

data/qed/projection.md

@@ -12,6 +12,9 @@ Without projection, result objects will be packaged in a subhash.
 When projecting, all result data will be toplevel and only the projected data is loaded.
 
 ~~~ruby
+  domain[:users].where(id: 2013).project(domain[:users][:id]).
+    to_sql.assert == %Q(SELECT "users"."id" FROM "users"  WHERE "users"."id" = 2013)
+
   result = posts.join(users).on(:user_id => :id).
     project(users[:name]).first
 
@@ -22,8 +25,11 @@ When projecting, all result data will be toplevel and only the projected data is
 Otherwise a projected query can be treated like an ordinary query, including appending stuff by joining it in. 
 
 ~~~ruby
-    posts.
-      project(users[:name]).
-      join(users).on(:user_id => :id).
-      first
+  post = posts.
+    join(users).on(:user_id => :id).
+    join(users.as(:approvers, :approver)).on(:approver_id => :id).
+    first
+
+  post.user.name.assert == 'John Snow' 
+  post.approver.name.assert == 'John Doe' 
 ~~~

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flounder
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.12.0
 platform: ruby
 authors:
 - Kaspar Schiess
@@ -9,96 +9,116 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-18 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
   code. It \n    allows very simple access to database tables without going all the
   way to\n    begin an object mapper. \n"
@@ -107,11 +127,14 @@ 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
@@ -129,8 +152,6 @@ files:
 - lib/flounder/query/select.rb
 - lib/flounder/query/update.rb
 - lib/flounder/symbol_extensions.rb
-- lib/flounder.rb
-- LICENSE
 - qed/applique/ae.rb
 - qed/applique/flounder.rb
 - qed/applique/setup_domain.rb
@@ -146,10 +167,8 @@ files:
 - qed/joins.md
 - qed/ordering.md
 - qed/projection.md
-- qed/results.md
 - qed/selects.md
 - qed/updates.md
-- README
 homepage: https://bitbucket.org/technologyastronauts/oss_flounder
 licenses:
 - MIT
@@ -160,17 +179,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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Flounder is a way to write SQL simply in Ruby. It deals with everything BUT
@@ -191,6 +210,6 @@ test_files:
 - qed/joins.md
 - qed/ordering.md
 - qed/projection.md
-- qed/results.md
 - qed/selects.md
 - qed/updates.md
+has_rdoc: 

data/qed/results.md

@@ -1,21 +0,0 @@
-
-
-
-~~~ruby
-  post = posts.
-    join(users).on(:user_id => :id).
-    join(users.as(:approvers, :approver)).on(:approver_id => :id).
-    first
-
-  post.user.name.assert == 'John Snow' 
-  post.approver.name.assert == 'John Doe' 
-~~~
-
-# Custom Projections
-
-TBD: Describes how to do custom projections and how these results will be available in the resulting object. 
-
-
-# Aliasing
-
-TBD: Describes to join a table multiple times and how to deal with the results.