reportable 1.0.3 → 1.1.0

data/lib/saulabs/reportable/cumulated_report.rb

@@ -1,3 +1,5 @@
+require 'saulabs/reportable/report'
+
 module Saulabs
 
   module Reportable

data/lib/saulabs/reportable/grouping.rb

@@ -66,7 +66,7 @@ module Saulabs
           if @identifier == :week
             parts = [db_string[0..3], db_string[4..5]].map(&:to_i)
           else
-            db_string.split('/').map(&:to_i)
+            db_string.split(@identifier == :day ? '-' : '/').map(&:to_i)
           end
         end
 
@@ -99,7 +99,7 @@ module Saulabs
             when :hour
               "DATE_FORMAT(#{date_column}, '%Y/%m/%d/%H')"
             when :day
-              "DATE_FORMAT(#{date_column}, '%Y/%m/%d')"
+              "DATE(#{date_column})"
             when :week
               "YEARWEEK(#{date_column}, 3)"
             when :month

data/lib/saulabs/reportable/railtie.rb

@@ -0,0 +1,26 @@
+require 'saulabs/reportable'
+require 'rails'
+
+module Saulabs
+
+  module Reportable
+
+    class Railtie < Rails::Railtie
+
+      GEM_ROOT = File.join(File.dirname(__FILE__), '..', '..', '..')
+
+      initializer 'saulabs.reportable.initialization' do
+        require File.join(GEM_ROOT, 'rails', 'init')
+      end
+
+      generators do
+        require File.join(GEM_ROOT, 'generators', 'reportable_migration', 'reportable_migration_generator')
+        require File.join(GEM_ROOT, 'generators', 'reportable_raphael_assets', 'reportable_raphael_assets_generator')
+        require File.join(GEM_ROOT, 'generators', 'reportable_jquery_flot_assets', 'reportable_jquery_flot_assets_generator')
+      end
+
+    end
+
+  end
+
+end

data/lib/saulabs/reportable/report.rb

@@ -1,3 +1,6 @@
+require 'saulabs/reportable/grouping'
+require 'saulabs/reportable/report_cache'
+
 module Saulabs
 
   module Reportable

data/lib/saulabs/reportable/report_cache.rb

@@ -1,3 +1,6 @@
+require 'saulabs/reportable/reporting_period'
+require 'saulabs/reportable/result_set'
+
 module Saulabs
 
   module Reportable
@@ -9,6 +12,15 @@ module Saulabs
 
       set_table_name :reportable_cache
 
+      validates_presence_of :model_name
+      validates_presence_of :report_name
+      validates_presence_of :grouping
+      validates_presence_of :aggregation
+      validates_presence_of :value
+      validates_presence_of :reporting_period
+
+      attr_accessible :model_name, :report_name, :grouping, :aggregation, :value, :reporting_period, :conditions
+
       self.skip_time_zone_conversion_for_attributes = [:reporting_period]
 
       # Clears the cache for the specified +klass+ and +report+
@@ -84,7 +96,7 @@ module Saulabs
           if options[:live_data]
             result << [current_reporting_period.date_time, find_value(new_data, current_reporting_period)]
           end
-          result
+          Saulabs::Reportable::ResultSet.new(result, report.klass.name, report.name)
         end
 
         def self.find_value(data, reporting_period)

data/lib/saulabs/reportable/report_tag_helper.rb

@@ -0,0 +1,162 @@
+require 'saulabs/reportable/config'
+
+module Saulabs
+
+  module Reportable
+
+    module ReportTagHelper
+
+      # Renders a sparkline with the given data using the google drawing api.
+      #
+      # @param [Array<Array<DateTime, Float>>] data
+      #   an array of report data as returned by {Saulabs::Reportable::Report#run}
+      # @param [Hash] options
+      #   options for the sparkline
+      #
+      # @option options [Fixnum] :width (300)
+      #   the width of the generated image
+      # @option options [Fixnum] :height (34)
+      #   the height of the generated image
+      # @option options [String] :line_color ('0077cc')
+      #   the line color of the generated image
+      # @option options [String] :fill_color ('e6f2fa')
+      #   the fill color of the generated image
+      # @option options [Array<Symbol>] :labels ([])
+      #   the axes to render lables for (Array of +:x+, +:y+, +:r+, +:t+; this is x axis, y axis, right, top)
+      # @option options [String] :alt ('')
+      #   the alt attribute for the generated image
+      # @option options [String] :title ('')
+      #   the title attribute for the generated image
+      #
+      # @return [String]
+      #   an image tag showing a sparkline for the passed +data+
+      #
+      # @example Rendering a sparkline tag for report data
+      #
+      #   <%= google_report_tag(User.registrations_report, :width => 200, :height => 100, :color => '000') %>
+      #
+      def google_report_tag(data, options = {})
+        options.reverse_merge!(Config.google_options)
+        data = data.collect { |d| d[1] }
+        labels = ''
+        unless options[:labels].empty?
+          chxr = {}
+          options[:labels].each_with_index do |l, i|
+            chxr[l] = "#{i}," + ([:x, :t].include?(l) ? "0,#{data.length}" : "#{[data.min, 0].min},#{data.max}")
+          end
+          labels = "&chxt=#{options[:labels].map(&:to_s).join(',')}&chxr=#{options[:labels].collect{|l| chxr[l]}.join('|')}"
+        end
+        title = ''
+        unless options[:title].blank?
+          title = "&chtt=#{options[:title]}"
+        end
+        image_tag(
+          "http://chart.apis.google.com/chart?cht=ls&chs=#{options[:width]}x#{options[:height]}&chd=t:#{data.join(',')}&chco=#{options[:line_color]}&chm=B,#{options[:fill_color]},0,0,0&chls=1,0,0&chds=#{data.min},#{data.max}#{labels}#{title}",
+          :alt   => options[:alt],
+          :title => options[:title]
+        )
+      end
+
+    
+      # Renders a sparkline with the given data using Raphael.
+      #
+      # @param [Array<Array<DateTime, Float>>] data
+      #   an array of report data as returned by {Saulabs::Reportable::Report#run}
+      # @param [Hash] options
+      #   options for width, height, the dom id and the format
+      # @param [Hash] raphael_options
+      #   options that are passed directly to Raphael as JSON
+      #
+      # @option options [Fixnum] :width (300)
+      #   the width of the generated graph
+      # @option options [Fixnum] :height (34)
+      #   the height of the generated graph
+      # @option options [Array<Symbol>] :dom_id ("reportable_#{Time.now.to_i}")
+      #   the dom id of the generated div
+      #
+      # @return [String]
+      #   an div tag and the javascript code showing a sparkline for the passed +data+
+      #
+      # @example Rendering a sparkline tag for report data
+      #
+      #   <%= raphael_report_tag(User.registrations_report, { :width => 200, :height => 100, :format => 'div(100).to_i' }, { :vertical_label_unit => 'registrations' }) %>
+      #
+      def raphael_report_tag(data, options = {}, raphael_options = {})
+        @__raphael_report_tag_count ||= -1
+        @__raphael_report_tag_count += 1
+        default_dom_id = "#{data.model_name.downcase}_#{data.report_name}#{@__raphael_report_tag_count > 0 ? @__raphael_report_tag_count : ''}"
+        options.reverse_merge!(Config.raphael_options.slice(:width, :height, :format))
+        options.reverse_merge!(:dom_id => default_dom_id)
+        raphael_options.reverse_merge!(Config.raphael_options.except(:width, :height, :format))
+        %Q{<div id="#{options[:dom_id]}" style="width:#{options[:width]}px;height:#{options[:height]}px;"></div>
+        <script type="text\/javascript" charset="utf-8">
+          var graph = Raphael('#{options[:dom_id]}');
+          graph.g.linechart(
+            -10, 4, #{options[:width]}, #{options[:height]},
+            #{(0..data.size).to_a.to_json},
+            #{data.map { |d| eval options[:format], d[1].send(:binding) }.to_json},
+            #{raphael_options.to_json}
+          ).hover(function() {
+            this.disc = graph.g.disc(this.x, this.y, 3).attr({fill: "#{options[:hover_fill_color]}", stroke: '#{options[:hover_line_color]}' }).insertBefore(this);
+            this.flag = graph.g.flag(this.x, this.y, this.value || "0", 0).insertBefore(this);
+            if (this.x + this.flag.getBBox().width > this.paper.width) {
+              this.flag.rotate(-180);
+              this.flag.translate(-this.flag.getBBox().width, 0);
+              this.flag.items[1].rotate(180);
+              this.flag.items[1].translate(-5, 0);
+            }
+          }, function() {
+            this.disc.remove();
+            this.flag.remove();
+          });
+        </script>}
+      end
+          
+      # Renders a sparkline with the given data using the jquery flot plugin.
+      #
+      # @param [Array<Array<DateTime, Float>>] data
+      #   an array of report data as returned by {Saulabs::Reportable::Report#run}
+      # @param [Hash] options
+      #   options for width, height, the dom id and the format
+      # @param [Hash] flot_options
+      #   options that are passed directly to Raphael as JSON
+      #
+      # @option options [Fixnum] :width (300)
+      #   the width of the generated graph
+      # @option options [Fixnum] :height (34)
+      #   the height of the generated graph
+      # @option options [Array<Symbol>] :dom_id ("reportable_#{Time.now.to_i}")
+      #   the dom id of the generated div
+      #
+      # @return [String]
+      #   an div tag and the javascript code showing a sparkline for the passed +data+
+      #
+      # @example Rendering a sparkline tag for report data
+      #
+      #   <%= flot_report_tag(User.registrations_report) %>
+      #
+
+      def flot_report_tag(data, options = {}, flot_options = {})
+        @__flot_report_tag_count ||= -1
+        @__flot_report_tag_count += 1
+        default_dom_id = "#{data.model_name.downcase}_#{data.report_name}#{@__flot_report_tag_count > 0 ? @__flot_report_tag_count : ''}"
+        options.reverse_merge!(Config.flot_options.slice(:width, :height, :format))
+        options.reverse_merge!(:dom_id => default_dom_id)
+        flot_options.reverse_merge!(Config.flot_options.except(:width, :height, :format))
+        %Q{<div id="#{options[:dom_id]}" style="width:#{options[:width]}px;height:#{options[:height]}px;"></div>
+        <script type="text\/javascript" charset="utf-8">
+        $(function() {
+          var set = #{data.map{|d| d[1] }.to_json},
+          data = [];
+          for (var i = 0; i < set.length; i++) {
+            data.push([i, set[i]]);
+          }
+          $.plot($('##{options[:dom_id]}'), [data], #{flot_options.to_json});
+        });
+        </script>}
+      end
+    
+    end
+  end
+
+end

data/lib/saulabs/reportable/reporting_period.rb

@@ -71,7 +71,7 @@ module Saulabs
       #
       def self.from_db_string(grouping, db_string)
         parts = grouping.date_parts_from_db_string(db_string)
-        result = case grouping.identifier
+        case grouping.identifier
           when :hour
             self.new(grouping, DateTime.new(parts[0], parts[1], parts[2], parts[3], 0, 0))
           when :day
@@ -81,7 +81,6 @@ module Saulabs
           when :month
             self.new(grouping, Date.new(parts[0], parts[1], 1))
         end
-        result
       end
 
       # Gets the next reporting period.
@@ -112,7 +111,7 @@ module Saulabs
       #
       def ==(other)
         if other.is_a?(Saulabs::Reportable::ReportingPeriod)
-          @date_time.to_s == other.date_time.to_s && @grouping.identifier.to_s == other.grouping.identifier.to_s
+          @date_time == other.date_time && @grouping.identifier == other.grouping.identifier
         elsif other.is_a?(Time) || other.is_a?(DateTime)
           @date_time == parse_date_time(other)
         else

data/lib/saulabs/reportable/result_set.rb

@@ -0,0 +1,40 @@
+module Saulabs
+
+  module Reportable
+
+    # A result set as it is returned by the report methods.
+    # This is basically a subclass of +Array+ that adds two
+    # attributes, +model_name+ and +report_name+ that store
+    # the name of the model and the report the result set
+    # was generated from.
+    #
+    class ResultSet < ::Array
+
+      # the name of the model the result set is based on
+      #
+      attr_reader :model_name
+
+      # the name of the report the result is based on
+      #
+      attr_reader :report_name
+
+      # Initializes a new result set.
+      #
+      # @param [Array] array
+      #   the array that is the actual result
+      # @param [String] model_name
+      #   the name of the model the result set is based on
+      # @param [String] report_name
+      #   the name of the report the result is based on
+      #
+      def initialize(array, model_name, report_name)
+        super(array)
+        @model_name  = model_name
+        @report_name = report_name.to_s
+      end
+
+    end
+
+  end
+
+end

data/rails/init.rb

@@ -1,9 +1,11 @@
+require 'action_view'
 require 'saulabs/reportable'
+require 'saulabs/reportable/report_tag_helper'
 
 ActiveRecord::Base.class_eval do
   include Saulabs::Reportable
 end
 
 ActionView::Base.class_eval do
-  include Saulabs::Reportable::SparklineTagHelper
+  include Saulabs::Reportable::ReportTagHelper
 end

data/spec/boot.rb

@@ -1,14 +1,11 @@
 plugin_root = File.join(File.dirname(__FILE__), '..')
 
-gem 'rails'
-require 'active_record'
-require 'active_support'
-require 'action_controller'
-require 'action_view'
-
 $:.unshift "#{plugin_root}/lib"
 
-RAILS_ROOT = File.expand_path(File.dirname(__FILE__) + '/../')
+Bundler.require
+require 'initializer'
+
+RAILS_ROOT = File.expand_path(File.dirname(__FILE__) + '/../') unless defined?(RAILS_ROOT)
 Rails::Initializer.run(:set_load_path)
 Rails::Initializer.run(:set_autoload_paths)
 Rails::Initializer.run(:initialize_time_zone) do |config|

data/spec/classes/grouping_spec.rb

@@ -23,7 +23,7 @@ describe Saulabs::Reportable::Grouping do
       end
 
       it 'should use DATE_FORMAT with format string "%Y/%m/%d" for grouping :day' do
-        Saulabs::Reportable::Grouping.new(:day).send(:to_sql, 'created_at').should == "DATE_FORMAT(created_at, '%Y/%m/%d')"
+        Saulabs::Reportable::Grouping.new(:day).send(:to_sql, 'created_at').should == "DATE(created_at)"
       end
 
       it 'should use YEARWEEK with mode 3 for grouping :week' do

data/spec/classes/report_cache_spec.rb

@@ -6,6 +6,91 @@ describe Saulabs::Reportable::ReportCache do
     @report = Saulabs::Reportable::Report.new(User, :registrations, :limit => 10)
   end
 
+  describe 'validations' do
+
+    before do
+      @report_cache = Saulabs::Reportable::ReportCache.new(
+        :model_name       => User.name,
+        :report_name      => 'registrations',
+        :grouping         => 'date',
+        :aggregation      => 'count',
+        :value            => 1.0,
+        :reporting_period => '2070/03/23'
+      )
+    end
+
+    it 'should succeed when all required attributes are set' do
+      @report_cache.should be_valid
+    end
+
+    it 'should not succeed when no model_name is set' do
+      @report_cache.model_name = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when a blank model_name is set' do
+      @report_cache.model_name = ''
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when no report_name is set' do
+      @report_cache.report_name = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when a blank report_name is set' do
+      @report_cache.report_name = ''
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when no grouping is set' do
+      @report_cache.grouping = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when a blank grouping is set' do
+      @report_cache.grouping = ''
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when no aggregation is set' do
+      @report_cache.aggregation = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when a blank aggregation is set' do
+      @report_cache.aggregation = ''
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when no value is set' do
+      @report_cache.value = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when no reporting_period is set' do
+      @report_cache.reporting_period = nil
+
+      @report_cache.should_not be_valid
+    end
+
+    it 'should not succeed when a blank reporting_period is set' do
+      @report_cache.reporting_period = ''
+
+      @report_cache.should_not be_valid
+    end
+
+  end
+
   describe '.clear_for' do
 
     it 'should delete all entries in the cache for the klass and report name' do