chicagowarehouse 0.4.3 → 0.4.4

data/Rakefile

@@ -14,7 +14,7 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name              = "chicagowarehouse"
-  gem.version           = "0.4.3"
+  gem.version           = "0.4.4"
   gem.summary           = "Ruby Data Warehousing"
   gem.description       = "Simple Data Warehouse toolkit for ruby"
   gem.author            = "Roland Swingler"

data/chicagowarehouse.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "chicagowarehouse"
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roland Swingler"]
-  s.date = "2013-04-16"
+  s.date = "2013-07-24"
   s.description = "Simple Data Warehouse toolkit for ruby"
   s.email = "roland.swingler@gmail.com"
   s.extra_rdoc_files = [

data/lib/chicago/database/schema_generator.rb

@@ -43,7 +43,8 @@ module Chicago
                        }]
         }
 
-        t[:columns] += table.columns.map {|c| c.visit(self) }
+        t[:columns] += table.columns.reject(&:calculated?).
+          map {|c| c.visit(self) }
         t[:columns] << {
           :name => :_inserted_at,
           :column_type => :timestamp,

data/lib/chicago/schema/column.rb

@@ -34,6 +34,8 @@ module Chicago
       # internal:: the column is for internal use only, and shouldn't
       #   be displayed/used directly in a user context
       # optional:: the column isn't expected to be populated.
+      # calculation:: the column is not stored in the database, but
+      #   calculated on demand
       #
       # @api private
       def initialize(name, column_type, opts={})
@@ -58,6 +60,7 @@ module Chicago
           column_type == :binary
         @optional    = !! (@opts.has_key?(:optional) ? @opts[:optional] : 
                            @opts[:null])
+        @calculation = @opts[:calculation]
       end
 
       # Returns the type of this column. This is an abstract type,
@@ -76,6 +79,9 @@ module Chicago
       # Returns the explicit default as set in the database, or nil.
       attr_reader :default
 
+      # Returns the Sequel calculation for this column.
+      attr_reader :calculation
+
       # Returns the calculated default value.
       #
       # This may be different from the explicit default - for example
@@ -99,6 +105,7 @@ module Chicago
         end
       end
 
+      # The human-friendly label for counting items in this column.
       attr_reader :countable_label
 
       alias :database_name :name
@@ -110,7 +117,7 @@ module Chicago
 
       # Returns true if this column should be indexed
       def indexed?
-        ! descriptive?
+        ! (descriptive? || calculated?)
       end
 
       # Returns true if this column is optional.
@@ -138,10 +145,16 @@ module Chicago
         @descriptive
       end
 
+      # Returns true if this column is unique.
       def unique?
         @unique
       end
 
+      # Returns true if this column is calculated.
+      def calculated?
+        !! @calculation
+      end
+
       # Returns true if both definition's attributes are equal.
       def ==(other)
         other.kind_of?(self.class) && 

data/lib/chicago/schema/query_column.rb

@@ -33,7 +33,9 @@ module Chicago
         if column.kind_of?(Chicago::Schema::Dimension)
           DimensionAsColumn.new(owner, column, column_alias)
         elsif owner.kind_of?(Chicago::Schema::Dimension) && owner.identifiable? && owner.identifiers.include?(column.name)
-          DimensionIdentifierColumn.new(owner, column, column_alias)          
+          DimensionIdentifierColumn.new(owner, column, column_alias)
+        elsif column.calculated?
+          VirtualColumn.new(owner, column, column_alias)
         else
           QualifiedColumn.new(owner, column, column_alias)
         end
@@ -91,6 +93,19 @@ module Chicago
       end
     end
 
+    # Allows querying a column that doesn't exist in the database, but
+    # is defined as a calculation in the column definition.
+    class VirtualColumn < QualifiedColumn
+      def initialize(owner, column, column_alias)
+        super(owner, column, column_alias)
+        @select_name = @column.calculation
+      end
+
+      def group_name
+        nil
+      end
+    end
+
     # @abstract
     class CalculatedColumn < QueryColumn
       def self.make(operation, column)

data/spec/database/schema_generator_spec.rb

@@ -14,7 +14,10 @@ describe Chicago::Database::SchemaGenerator do
       @fact = schema.define_fact(:sales) do
         dimensions :customer, :product
         degenerate_dimensions { string :reference }
-        measures { integer :quantity }
+        measures { 
+          integer :quantity 
+          integer :calculated, :calculation => 1 + 1
+        }
         natural_key :customer, :reference
       end
     end
@@ -58,6 +61,10 @@ describe Chicago::Database::SchemaGenerator do
       subject.visit_fact(@fact)[:facts_sales][:columns].should include({:name => :quantity, :column_type => :integer, :null => true, :unsigned => false})
     end
 
+    it "should not output calculated columns" do
+      subject.visit_fact(@fact)[:facts_sales][:columns].any? {|c| c[:name] == :calculated }.should_not be_true
+    end
+
     it "should define non-unique indexes for every dimension" do
       subject.visit_fact(@fact)[:facts_sales][:indexes].should == {
         :product_idx => { :columns => :product_dimension_id, :unique => false },

data/spec/query_spec.rb

@@ -41,6 +41,7 @@ describe Chicago::Query do
       measures do
         integer :total
         decimal :vat_rate
+        decimal :vat, :calculation => :sum.sql_function(:total) * :vat_rate
       end
     end
 
@@ -185,6 +186,12 @@ describe Chicago::Query do
         should == [:stddev_samp.sql_function(:total.qualify(:sales)).as("sales.total.stddev".to_sym)]
     end
 
+    it "selects an explicit sum of a column" do
+      @q.select({:column => "sales.vat"})
+      @q.dataset.opts[:select].
+        should == [(:sum.sql_function(:total) * :vat_rate).as("sales.vat".to_sym)]
+    end
+
     it "selects an explicit distinct count, via a dimension reference" do
       @q.select({:column => "sales.product.type", :op => "count"})
       @q.dataset.sql.should =~ /COUNT\(DISTINCT `product`\.`type`\)/i

data/spec/schema/column_spec.rb

@@ -81,6 +81,10 @@ describe Chicago::Schema::Column do
     described_class.new(:username, :string, :descriptive => true).should_not be_indexed
   end
 
+  it "should not be indexed if calculated" do
+    described_class.new(:username, :string, :calculation => 1).should_not be_indexed
+  end
+
   it "should be numeric if an integer" do
     described_class.new(:username, :integer).should be_numeric
   end
@@ -175,6 +179,12 @@ describe Chicago::Schema::Column do
     visitor.should_receive(:visit_column).with(column)
     column.visit(visitor)
   end
+
+  it "may be calculated" do
+    column = described_class.new(:foo, :integer, :calculation => 1 + 1)
+    column.should be_calculated
+    column.calculation.should_not be_nil
+  end
 end
 
 describe "Chicago::Schema::Column#to_hash" do

data/spec/schema/query_column_spec.rb

@@ -4,7 +4,7 @@ require 'chicago/schema/query_column'
 describe Chicago::Schema::QueryColumn do
   describe "a standard column" do
     let(:owner) { stub(:owner).as_null_object }
-    let(:column) { stub(:column).as_null_object }
+    let(:column) { stub(:column, :calculated? => false).as_null_object }
     subject { described_class.column(owner, column, "foo.bar") }
     
     it "should have a column alias" do
@@ -37,6 +37,36 @@ describe Chicago::Schema::QueryColumn do
     end
   end
 
+  describe "a virtual column generated from calculation" do
+    let(:calculation) { stub(:calculation).as_null_object }
+    let(:owner) { stub(:owner).as_null_object }
+    let(:column) { stub(:column, :calculated? => true, :calculation => calculation).as_null_object }
+    subject { described_class.column(owner, column, "foo.bar") }
+
+    it "should have a column alias" do
+      subject.column_alias.should == "foo.bar"
+    end
+
+    it "has an owner" do
+      subject.owner.should == owner
+    end
+
+    it "has a sequel qualified name for use in SELECT statements" do
+      owner.stub(:name).and_return(:foo)
+      column.stub(:name).and_return(:bar)
+      subject.select_name.should == calculation
+    end
+
+    it "not be grouped" do
+      subject.group_name.should be_nil
+    end
+
+    it "delegates label to the decorated column" do
+      column.should_receive(:label).and_return("Bar")
+      subject.label.should == "Bar"
+    end
+  end
+
   describe "a dimension column" do
     let(:owner) { stub(:owner).as_null_object }
     let(:column) { stub(:column).as_null_object }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chicagowarehouse
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 4
-  - 3
-  version: 0.4.3
+  - 4
+  version: 0.4.4
 platform: ruby
 authors: 
 - Roland Swingler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-04-16 00:00:00 Z
+date: 2013-07-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement