reporter 0.0.1

data/lib/reporter/support/time_range.rb

@@ -0,0 +1,62 @@
+module Reporter::Support::TimeRange
+
+	def time_range?
+		valid_types = [Date, DateTime, Time, ActiveSupport::TimeWithZone]
+		return false unless valid_types.include?(self.begin.class)
+		return false unless valid_types.include?(self.end.class)
+		true
+	end
+
+	def human_name
+		return inspect unless time_range?
+		b = test_begin_ends(self.begin)
+		e = test_begin_ends(self.end)
+
+		if self.begin.year == self.end.year
+			if b[:by] and e[:ey]
+				return self.begin.strftime("%Y")
+			elsif b[:bq] and e[:eq]
+				bq = get_quarter(self.begin)
+				eq = get_quarter(self.end)
+				if bq == eq
+					return I18n.t("time_range.quarter", :year => self.begin.year, :quarter => bq, :default => "q%{quarter} %{year}")
+				else
+					return I18n.t("time_range.multi_quarter", :year => self.begin.year,
+												:begin_quarter => bq, :end_quarter => eq, :default => "q%{begin_quarter} .. q%{end_quarter} %{year}")
+				end
+			elsif b[:bm] and e[:em]
+				if self.begin.month == self.end.month
+					return self.begin.strftime("%b '%y")
+				else
+					return "#{self.begin.strftime("%b")} .. #{self.end.strftime("%b '%y")}"
+				end
+			end
+		else # multi year
+			if b[:by] and e[:ey]
+				return "#{self.begin.strftime("'%y")} .. #{self.end.strftime("'%y")}"
+			else
+				return inspect
+			end
+		end
+	end
+
+	private
+
+	def get_quarter(date)
+		qs = [3, 6, 9, 12]
+		q = qs.detect { |q| date.month <= q }
+		(qs.index q) + 1
+	end
+
+	def test_begin_ends(date)
+		r = {}
+		["year", "quarter", "month", "week"].each do |element|
+			r["b#{element.first}".to_sym] = (date.send("at_beginning_of_#{element}".to_sym) == date)
+			r["e#{element.first}".to_sym] = (date.send("at_end_of_#{element}".to_sym) == date)
+		end
+		r
+	end
+
+end
+
+Range.send(:include, Reporter::Support::TimeRange)

data/lib/reporter/time_iterator.rb

@@ -0,0 +1,85 @@
+module Reporter::TimeIterator
+
+	public
+
+	VALID_TIME_STEP_SIZES = :total, :year, :quarter, :month, :week, :day
+
+	def iterate_time axis, *steps, &block
+		options = steps.extract_options!
+		scope = data_source.scopes.get axis
+		raise "Scope is not of Date type" unless scope.is_a? Reporter::Scope::DateScope
+		steps.each do |step|
+			raise "invalid stepsize: #{step}. must be one of #{VALID_TIME_STEP_SIZES.inspect}" unless VALID_TIME_STEP_SIZES.include? step
+		end
+		date_tree = build_date_tree steps
+		iterate_date_tree scope, date_tree, scope.limit, &block
+		scope.change nil
+	end
+
+	private
+
+	DATE_PART_VALUES = {
+					:total => 6,
+					:year => 5,
+					:quarter => 4,
+					:month => 3,
+					:week => 2,
+					:day => 1
+	}
+
+	def build_date_tree date_parts
+		date_parts = date_parts.dup
+		return nil if date_parts.empty?
+		# [6, 4, 3, 5]
+		# 2010 - 2011, q1, 1,2,3, q2, 4,5,6, q3, 7,8,9, q4, 10,11,12, 2010, q1, 1,2,3, q2, 4,5,6, q3, 7,8,9, q4, 10,11,12, 2011
+		date_coded = date_parts.collect { |part| DATE_PART_VALUES[part] }
+		if date_coded.first == date_coded.max
+			parent = date_parts.shift
+			{:children_first => false, :name => parent, :children => build_date_tree(date_parts)}
+		elsif date_coded.last == date_coded.max
+			parent = date_parts.pop
+			{:children_first => true, :name => parent, :children => build_date_tree(date_parts)}
+		else
+			raise "invalid sequence: #{date_parts.inspect}"
+		end
+	end
+
+	def iterate_date_tree scope, tree, time_frame, &block
+		iterate_time_periods time_frame, tree[:name] do |new_time_frame, optimization|
+			iterate_date_tree scope, tree[:children], time_frame, &block if tree[:children_first] and tree[:children]
+			scope.change new_time_frame
+			@time_iteration_row ||= Reporter::TimeOptimizedResultRow.new(self, nil, scope, time_frame)
+			@time_iteration_row.current_iteration = optimization
+			@time_iteration_row.scope = data_source.scopes.current_scope
+			yield @time_iteration_row
+			iterate_date_tree scope, tree[:children], time_frame, &block if !tree[:children_first] and tree[:children]
+		end
+	end
+
+	def iterate_time_periods period, block_type, &block
+		if block_type == :total
+			yield period
+			return
+		end
+		advancement, filter = case block_type
+			when :year : [{ :years => 1 }, [:year]]
+			when :quarter : [{ :months => 3 }, [:quarter, :year]]
+			when :month : [{ :months => 1 }, [:month, :year]]
+			when :week : [{ :weeks => 1 }, [:week, :year]]
+			when :day : [{ :days => 1 }, [:day, :month, :year]]
+			else raise "Unsupported type: #{block_type}"
+		end
+		iterate_period = period.begin.send("beginning_of_#{block_type}".to_sym) .. period.begin.send("end_of_#{block_type}".to_sym)
+		optimization = { :type => block_type, :filter => filter, :period => {} }
+
+		while iterate_period.begin < period.end
+			optimization[:period] = {}
+			optimization[:filter].each { |field| optimization[:period][field] = iterate_period.begin.send(field) }
+
+			yield iterate_period, optimization
+			iterate_period = iterate_period.begin.advance(advancement).send("beginning_of_#{block_type}".to_sym) ..
+							iterate_period.end.advance(advancement).send("end_of_#{block_type}".to_sym)
+		end
+	end
+
+end

data/lib/reporter/time_optimized_result_row.rb

@@ -0,0 +1,39 @@
+class Reporter::TimeOptimizedResultRow < Reporter::ResultRow
+
+	def initialize(data_set, scope_serialization, scope, period)
+		super data_set, scope_serialization
+		@scope = scope
+		@period = period
+		@active_scope = nil
+	end
+
+	attr_accessor :current_iteration
+
+	def scope= scope
+		@scope_serialization = scope
+	end
+
+	def [] field
+		field_cache[field] ||= {}
+		preload_time_period_values_for field unless field_cache[field].has_key? current_iteration[:type]
+		field_cache[field][current_iteration[:type]] ||= {}
+		field_cache[field][current_iteration[:type]][current_iteration[:period]] ||= load_field_values(field)[field]
+	end
+
+	private
+
+	attr_reader :data_set, :scope_serialization, :period
+
+	def preload_time_period_values_for(field_name)
+		#Rails.logger.info "Trying to pre-load data for #{field_name} for the period of #{period} in chunks of #{current_iteration[:filter].to_sentence}"
+
+		field = data_set.data_structure.fields[field_name]
+		if field.respond_to? :preload_for_period
+			#Rails.logger.info "Preloading possible for #{field_name}!"
+			field_cache[field_name] ||= {}
+			field_cache[field_name][current_iteration[:type]] = \
+				field.preload_for_period data_set.data_source, {}, period, current_iteration[:filter], @scope
+		end
+	end
+
+end

data/lib/reporter/value.rb

@@ -0,0 +1,36 @@
+class Reporter::Value
+
+	def initialize(field_alias, field_human_name, value, human_value, description, source_link)
+		@field_alias = field_alias
+		@field_human_name = field_human_name || field_alias
+		@value = value
+		@human_value = human_value
+		@description = description
+		@source_link = source_link
+	end
+
+	attr_reader :field_alias, :field_human_name
+	attr_accessor :value, :description, :source_link
+	attr_writer :human_value
+
+	def human_value
+		@human_value || value
+	end
+
+	def to_s
+		human_value
+	end
+
+	def as_percentage
+		if @value.is_a? Numeric
+			"%.2f %%" % (@value * 100.0)
+		end
+	end
+
+	def round(precision = 2)
+		if @value.is_a? Numeric
+			"%.#{precision}f" % @value
+		end
+	end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: reporter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthijs Groen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+description: "\n      Reporter adds a consistent way to build reports.\n    "
+email: matthijs.groen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/reporter/data_set.rb
+- lib/reporter/data_source.rb
+- lib/reporter/data_source/active_record_source.rb
+- lib/reporter/data_source/scoping.rb
+- lib/reporter/data_structure.rb
+- lib/reporter/field/average_field.rb
+- lib/reporter/field/base.rb
+- lib/reporter/field/calculation_field.rb
+- lib/reporter/field/count_field.rb
+- lib/reporter/field/field.rb
+- lib/reporter/field/formula_field.rb
+- lib/reporter/field/sum_field.rb
+- lib/reporter/formula.rb
+- lib/reporter/result_row.rb
+- lib/reporter/scope/base.rb
+- lib/reporter/scope/date_scope.rb
+- lib/reporter/scope/reference_scope.rb
+- lib/reporter/support/time_range.rb
+- lib/reporter/time_iterator.rb
+- lib/reporter/time_optimized_result_row.rb
+- lib/reporter/value.rb
+has_rdoc: true
+homepage: http://github.com/matthijsgroen/reporter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Report builder.
+test_files: []
+