activewarehouse 0.1.0

data/generators/cube/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveWarehouse::Cube
+  
+end

data/generators/cube/templates/unit_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/generators/dimension/USAGE

@@ -0,0 +1 @@
+./script/generate dimension NAME

data/generators/dimension/dimension_generator.rb

@@ -0,0 +1,46 @@
+class DimensionGenerator < Rails::Generator::NamedBase
+  attr_accessor :file_name
+  
+  default_options :skip_migration => false
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @name = @name.tableize.singularize
+    @table_name = "#{@name}_dimension"
+    @class_name = "#{@name.camelize}Dimension"
+    @file_name = "#{@class_name.tableize.singularize}"
+  end
+  
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}", "#{class_name}Test"
+      
+      # Create required directories if necessary
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+      
+      # Generate the files
+      m.template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'unit_test.rb', File.join('test/unit', class_path, "#{file_name}_test.rb")
+      m.template 'fixture.yml', File.join('test/fixtures', class_path, "#{table_name}.yml")
+      
+      # Generate the migration unless :skip_migration option is specified
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_name.gsub(/\//, '_')}"
+      end
+    end
+  end
+  
+  protected
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this dimension") { |v| options[:skip_migration] = v }
+    end
+end

data/generators/dimension/templates/fixture.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+first:
+  id: 1
+another:
+  id: 2

data/generators/dimension/templates/migration.rb

@@ -0,0 +1,20 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    fields = {
+      # Add dimension attributes here as name => type
+      # Example: :store_name => :string
+    }
+    create_table :<%= table_name %> do |t|
+      fields.each do |name,type|
+        t.column name, type
+      end
+    end
+    fields.each do |name,type|
+      add_index :<%= table_name %>, name unless type == :text      
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/dimension/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveWarehouse::Dimension
+  
+end

data/generators/dimension/templates/unit_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/generators/fact/USAGE

@@ -0,0 +1 @@
+./script/generate fact NAME

data/generators/fact/fact_generator.rb

@@ -0,0 +1,46 @@
+class FactGenerator < Rails::Generator::NamedBase
+  attr_accessor :file_name
+  
+  default_options :skip_migration => false
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @name = @name.underscore
+    @table_name = "#{@name}_facts"
+    @class_name = "#{@name.camelize}Fact"
+    @file_name = "#{@class_name.tableize.singularize}"
+  end
+  
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}", "#{class_name}Test"
+      
+      # Create required directories if necessary
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+      
+      # Generate the files
+      m.template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'unit_test.rb', File.join('test/unit', class_path, "#{file_name}_test.rb")
+      m.template 'fixture.yml', File.join('test/fixtures', class_path, "#{table_name}.yml")
+      
+      # Generate the migration unless :skip_migration option is specified
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_name.gsub(/\//, '_').pluralize}"
+      end
+    end
+  end
+  
+  protected
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this fact") { |v| options[:skip_migration] = v }
+    end
+end

data/generators/fact/templates/fixture.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+first_fact:
+  id: 1
+second_fact:
+  id: 2

data/generators/fact/templates/migration.rb

@@ -0,0 +1,11 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/fact/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveWarehouse::Fact
+  
+end

data/generators/fact/templates/unit_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/install.rb

@@ -0,0 +1,5 @@
+# migrate
+#puts "Migrating ActiveWarehouse"
+#migration_directory = File.join(File.dirname(__FILE__), 'db', 'migrations')
+#ActiveRecord::Migrator.migrate(migration_directory, nil)
+# puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/active_warehouse.rb

@@ -0,0 +1,65 @@
+#--
+# Copyright (c) 2006 Anthony Eden
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless defined?(ActiveSupport)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../activesupport/lib")  
+    require 'active_support'  
+  rescue LoadError
+    require 'rubygems'
+    require_gem 'activesupport'
+  end
+end
+
+unless defined?(ActiveRecord)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
+    require 'active_record'
+  rescue LoadError
+    require 'rubygems'
+    require_gem 'activerecord'
+  end
+end
+
+unless defined?(ActionView)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../actionpack/lib")
+    require 'action_pack'
+    require 'action_controller'
+    require 'action_view'
+  rescue LoadError
+    require 'rubygems'
+    require_gem 'actionpack'
+  end
+end
+  
+
+require 'active_warehouse/version'
+require 'active_warehouse/core_ext'
+require 'active_warehouse/model'
+require 'active_warehouse/view'
+require 'active_warehouse/builder'
+require 'active_warehouse/migrations'

data/lib/active_warehouse/builder.rb

@@ -0,0 +1,2 @@
+require 'active_warehouse/builder/date_dimension_builder'
+require 'active_warehouse/builder/random_data_builder'

data/lib/active_warehouse/builder/date_dimension_builder.rb

@@ -0,0 +1,65 @@
+module ActiveWarehouse
+  module Builder
+    class DateDimensionBuilder
+      attr_accessor :start_date, :end_date, :holiday_indicators
+      cattr_accessor :weekday_indicators
+      @@weekday_indicators = ['Weekend','Weekday','Weekday','Weekday','Weekday','Weekday','Weekend']
+        
+      def initialize(start_date=Time.now.years_ago(5), end_date=Time.now)
+        @start_date = start_date
+        @end_date = end_date
+        @holiday_indicators = []
+      end
+      
+      # Returns an array of hashes representing records in the dimension
+      # The values for each record are accessed by name
+      def build(options={})
+        records = []
+        date = start_date
+        while date <= end_date
+          record = {}
+          record[:date] = date.strftime("%m/%d/%Y")
+          record[:full_date_description] = date.strftime("%B %d,%Y")
+          record[:day_of_week] = date.strftime("%A")
+          #record[:day_number_in_epoch] = date.to_i / 24
+          #record[:week_number_in_epoch] = date.to_i / (24 * 7)
+          #record[:month_number_in_epoch] = date.to_i / (24 * 7 * 30)
+          record[:day_number_in_calendar_month] = date.day
+          record[:day_number_in_calendar_year] = date.yday
+          record[:day_number_in_fiscal_month] = date.day # should this be different from CY?
+          record[:day_number_in_fiscal_year] = date.fiscal_year_yday
+          #record[:last_day_in_week_indicator] = 
+          #record[:last_day_in_month_indicator] =
+          #record[:calendar_week_ending_date] = 
+          record[:calendar_week] = "Week #{date.week}"
+          record[:calendar_week_number_in_year] = date.week
+          record[:calendar_month_name] = date.strftime("%B")
+          record[:calendar_month_number_in_year] = date.month
+          record[:calendar_year_month] = date.strftime("%Y-%m")
+          record[:calendar_quarter] = "Q#{date.quarter}"
+          record[:calendar_year_quarter] = "#{date.strftime('%Y')}-#{record[:calendar_quarter]}"
+          #record[:calendar_half_year] = 
+          record[:calendar_year] = "#{date.year}"
+          record[:fiscal_week] = "FY Week #{date.fiscal_year_week}"
+          record[:fiscal_week_number_in_year] = date.fiscal_year_week
+          record[:fiscal_month] = date.fiscal_year_month
+          record[:fiscal_month_number_in_year] = date.fiscal_year_month
+          record[:fiscal_year_month] = "FY#{date.fiscal_year}-" + date.fiscal_year_month.to_s.rjust(2, '0')
+          record[:fiscal_quarter] = "FY Q#{date.fiscal_year_quarter}"
+          record[:fiscal_year_quarter] = "FY#{date.fiscal_year}-Q#{date.fiscal_year_quarter}"
+          #record[:fiscal_half_year] = 
+          record[:fiscal_year] = "FY#{date.fiscal_year}"
+          record[:holiday_indicator] = holiday_indicators.include?(date) ? 'Holiday' : 'Nonholiday'
+          record[:weekday_indicator] = weekday_indicators[date.wday]
+          record[:selling_season] = 'None'
+          record[:major_event] = 'None'
+          record[:sql_date_stamp] = date
+          
+          records << record
+          date = date.tomorrow
+        end
+        records
+      end
+    end
+  end
+end

data/lib/active_warehouse/builder/random_data_builder.rb

@@ -0,0 +1,13 @@
+module ActiveWarehouse
+  module Builder
+    class RandomDataBuilder
+      def initialize
+        
+      end
+      
+      def build(options={})
+        
+      end
+    end
+  end
+end

data/lib/active_warehouse/core_ext.rb

@@ -0,0 +1 @@
+require 'active_warehouse/core_ext/time'

data/lib/active_warehouse/core_ext/time.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/time/calculations'
+
+class Time#:nodoc:
+  include ActiveWarehouse::CoreExtensions::Time::Calculations
+end

data/lib/active_warehouse/core_ext/time/calculations.rb

@@ -0,0 +1,40 @@
+module ActiveWarehouse #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Time #:nodoc:
+      # Enables the use of time calculations within Time itself
+      module Calculations
+        def week
+          cyw = ((yday - 1) / 7) + 1
+          cyw = 52 if cyw == 53
+          cyw
+        end
+        def quarter
+          ((month - 1) / 3) + 1
+        end
+        def fiscal_year_week(offset_month=10)
+          fyw = ((fiscal_year_yday(offset_month) - 1) / 7) + 1
+          fyw = 52 if fyw == 53
+          fyw
+        end
+        def fiscal_year_month(offset_month=10)
+          shifted_month = month - (offset_month - 1)
+          shifted_month += 12 if shifted_month < 0
+          shifted_month
+        end
+        def fiscal_year_quarter(offset_month=10)
+          ((fiscal_year_month(offset_month) - 1) / 3) + 1
+        end
+        def fiscal_year(offset_month=10)
+          month >= offset_month ? year + 1 : year
+        end
+        def fiscal_year_yday(offset_month=10)
+          offset_days = 0
+          1.upto(offset_month - 1) { |m| offset_days += ::Time.days_in_month(m, year) }
+          shifted_year_day = yday - offset_days
+          shifted_year_day += 365 if shifted_year_day <= 0
+          shifted_year_day
+        end
+      end
+    end
+  end
+end

data/lib/active_warehouse/migrations.rb

@@ -0,0 +1,65 @@
+module ActiveWarehouse #:nodoc:
+  # Responsible for migrating ActiveWarehouse
+  class Migrator < ActiveRecord::Migrator
+    
+    class << self
+      def schema_info_table_name #:nodoc:
+        ActiveRecord::Base.table_name_prefix + 'activewarehouse_schema_info' + ActiveRecord::Base.table_name_suffix
+      end
+      
+      def current_version #:nodoc:
+        result = ActiveRecord::Base.connection.select_one("SELECT version FROM #{schema_info_table_name}")
+        if result
+          result['version'].to_i
+        else
+          # There probably isn't an entry for this plugin in the migration info table.
+          # We need to create that entry, and set the version to 0
+          ActiveRecord::Base.connection.execute("INSERT INTO #{schema_info_table_name} (version) VALUES (0)")      
+          0
+        end
+      end    
+    end
+    
+    def set_schema_version(version)
+      ActiveRecord::Base.connection.update("UPDATE #{self.class.schema_info_table_name} SET version = #{down? ? version.to_i - 1 : version.to_i}")
+    end
+  end
+end
+
+module ActiveRecord #:nodoc:
+  module ConnectionAdapters #:nodoc:
+    module SchemaStatements #:nodoc:
+      def initialize_schema_information_with_activewarehouse
+        initialize_schema_information_without_activewarehouse
+        
+        begin
+          execute "CREATE TABLE #{ActiveWarehouse::Migrator.schema_info_table_name} (version #{type_to_sql(:integer)})"
+        rescue ActiveRecord::StatementInvalid
+          # Schema has been initialized
+        end
+      end
+      alias_method_chain :initialize_schema_information, :activewarehouse
+      
+      def dump_schema_information_with_activewarehouse
+        schema_information = []
+        
+        dump = dump_schema_information_without_activewarehouse
+        schema_information << dump if dump
+        
+        begin
+          plugins = ActiveRecord::Base.connection.select_all("SELECT * FROM #{ActiveWarehouse::Migrator.schema_info_table_name}")
+          plugins.each do |plugin|
+            if (version = plugin['version'].to_i) > 0
+              schema_information << "INSERT INTO #{ActiveWarehouse::Migrator.schema_info_table_name} (version) VALUES (#{version})"
+            end
+          end
+        rescue ActiveRecord::StatementInvalid 
+          # No Schema Info
+        end
+        
+        schema_information.join("\n")
+      end
+      alias_method_chain :dump_schema_information, :activewarehouse
+    end
+  end
+end