bisque 0.1.1 → 0.1.2

data/README.rdoc

@@ -20,7 +20,7 @@ Bisque is meant to ease the pain of "reporting"-style ad-hoc SQL queries in Acti
 
 *Cons*: Your reports are ultimately instances of some model - but most reports are not that at all! They're aggregate views over your models, and trying to cram them into existing instances forces you to conflate two very distinct concepts in the domain.
 
-== Even Fuglier: Query straight from the connection, then use the raw result or OpenStruct it in order to achieve some measure of separation
+== Even Fuglier: Query straight from the connection, then use the raw result or OpenStruct in order to achieve some measure of separation
 
 *Example*:
 
@@ -78,24 +78,24 @@ Reports inherit from Bisque::Report, and have the following API:
 Every report *must* have a query. Define it here, using colon-prefixed words to designate parameters
 
 ==== Bisque::Report.defaults
-This method takes a hash of defaults, if any, for the parameters in your query. Each parameter must either have some default set for it, or be passed a value at runtime (see instantiatino below)
+This method takes a hash of defaults - if extant - for the parameters in your query. Each parameter must either have some default value, or be passed a value at instantiation (see below)
 
 ==== Bisque::Report.rows
-If you wish to define custom methods on each individual row item of the report, define them here, and they will be evaluated in the context of the dynamically generated row class (which will be namespaced the same as the report class and named <YourReportClassName>Row).
+If you wish to define custom methods on each individual row of the report, define them here; they will be evaluated in the context of the dynamically generated row class (which will be namespaced identically to the report class itself,  and named <YourReportClassName>Row).
 
 === Step 2: Instantiate the report
-To use run a given report, just create a new instance of it. Each report instance is enumerable and so may be iterated over as usual.
+To run a given report, just create a new instance of it. Each report instance is enumerable and so may be iterated over as usual.
 
   report = FooReport.new :customer_id => 42
 
-You must provide a hash of values for each parameter (that doesn't have a default) defined in the query, or a Bisque::MissingParameterException will be raised and the report will not be executed.
+You must provide a hash of values for each parameter defined in the query without a default value, or a Bisque::MissingParameterException will be raised and the report will not be executed.
 
-If you have defined any custom row methods (via the rows block discussed above), you may call them on each item of the iterator as one would expect:
+If you have defined any custom row methods via the rows block discussed above, you may call them on each item of the iterator as one would expect:
 
   puts report.first.total_in_cents
 
 == In closing
-For the time being, Bisque supports PostgreSQL exclusively (db-agnositicism is broken due to the necessities associated with typecasting dynamically selected values), because I virtually never use anything else and wanted this gem out there ASAP for my own purposes. I sincerely doubt I'll ever get around to extending it for support of other AR-supported dbs, but if one of you fine folks would like to do so, submit a pull request as described below and I'll happily include it. Of course, any other improvements, feature requests, etc. will be considered and taken into account - I would like to see this grow into a highly versatile tool, so suggest away!
+For the time being, Bisque supports PostgreSQL exclusively because I virtually never use anything else and wanted this gem out there ASAP for my own purposes (db-agnositicism is broken due to the particulars associated with typecasting dynamically selected values). I sincerely doubt I'll ever get around to extending it for support of other AR-supported dbs, but if one of you fine folks would like to do so, submit a pull request as described below and I'll happily include it. Of course, any other improvements, feature requests, etc. will be considered and taken into account - I would like to see this grow into a highly versatile tool, so suggest away!
 
 == Contributing to bisque
 
@@ -107,6 +107,12 @@ For the time being, Bisque supports PostgreSQL exclusively (db-agnositicism is b
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== TODO:
+* PostgreSQL views and "pseudo-materialized" views. Maybe a DSL for defining triggers, etc therefor. Dunno, have to think about it - the materialized views typically work perfectly well when implemented as read-only models. (and you get associations that way)
+* Maybe parameter validation of some sort - would that be necessary?
+* Implement some kind of pagination
+* Refine DSL and performance improvements - not sure architecture is the most ideal, but designed top-down and seems to work ok.
+
 == Copyright
 
 Copyright (c) 2012 Jeremy Holland. See LICENSE.txt for

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bisque.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bisque"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Holland"]
-  s.date = "2012-09-01"
+  s.date = "2013-07-04"
   s.description = "Bisque exists to ease the organizational pain of having to attach reporting and ad-hoc queries to ActiveRecord models in order to get any class-like behavior out of them by providing a new class and DSL for that express purpose."
   s.email = "jeremy@jeremypholland.com"
   s.extra_rdoc_files = [
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/awebneck/bisque"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.23"
   s.summary = "A simple gem for ease of use in generating reports with ActiveRecord"
 
   if s.respond_to? :specification_version then

data/lib/bisque/report.rb

@@ -10,7 +10,7 @@ module Bisque
       self.class.params.each do |param|
         value = @params[param]
         raise Bisque::MissingParameterException, "Missing parameter :#{param} for construction of #{self.class} - please provide a value for this parameter to the constructor or define a default." if value.nil?
-        @sql.gsub!(/:#{param}/, sanitize_and_sqlize(value))
+        @sql.gsub!(/(?<!:):#{param}/, sanitize_and_sqlize(value))
       end
       @results = ActiveRecord::Base.connection.execute @sql
       extract_datatypes
@@ -112,7 +112,7 @@ module Bisque
       def query(qstr=nil)
         if qstr
           @qstr = qstr.strip
-          @params = qstr.scan(/:\w+/).map { |p| p.gsub(/:/,'').intern }
+          @params = qstr.scan(/(?<!:):\w+/).map { |p| p.gsub(/:/,'').intern }
         else
           raise Bisque::MissingQueryException, "Bisque Report #{self} missing query definition." if @qstr.nil?
           @qstr

data/spec/spec_helper.rb

@@ -34,6 +34,7 @@ end
 RSpec.configure do |config|
   dir = File.dirname(__FILE__)
   dbconfig = {
+     'host' => '127.0.0.1',
      'adapter' => 'postgresql',
      'encoding' => 'unicode',
      'database' => 'bisque_development',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bisque
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &18252960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *18252960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &18531220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18531220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18529960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *18529960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &18527080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *18527080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &18524720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *18524720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &19469800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *19469800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &18445260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18445260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &18443840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18443840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &18441760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18441760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bisque exists to ease the organizational pain of having to attach reporting
   and ad-hoc queries to ActiveRecord models in order to get any class-like behavior
   out of them by providing a new class and DSL for that express purpose.
@@ -156,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3233801833892750029
+      hash: -194881109709687049
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple gem for ease of use in generating reports with ActiveRecord