reportable 1.0.0

data/HISTORY.md

@@ -0,0 +1,4 @@
+v1.0.0
+------
+
+* Initial release of the new Reportable gem (formerly known as the ReportsAsSparkline plugin)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Marco Otte-Witte, Martin Kavalar
+
+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.

data/README.md

@@ -0,0 +1,88 @@
+Reportable
+==========
+
+Reportable allows for the easy creation of reports based on `ActiveRecord` models.
+
+
+Usage
+-----
+
+Usage is pretty easy. To declare a report on a model, simply define that the model provides a report:
+
+    class User < ActiveRecord::Base
+
+      reportable :registrations, :aggregation => :count
+
+    end
+
+The `reportable` method takes a bunch more options which are described in the [API docs](http://rdoc.info/projects/saulabs/reportable). For example you could generate a report on
+the number of updated users records per second or the number of registrations of users that have a last name that starts with `'A'` per month:
+
+    class User < ActiveRecord::Base
+
+      reportable :last_name_starting_with_a_registrations, :aggregation => :count, :grouping => :month, :conditions => ["last_name LIKE 'A%'"]
+
+      reportable :updated_per_second, :aggregation => :count, :grouping => :second, :date_column => :updated_at
+
+    end
+
+For every declared report a method is generated on the model that returns the date:
+
+    User.registrations_report
+
+    User.last_name_starting_with_a_registrations_report
+
+    User.updated_per_second_report
+
+
+Working with the data
+---------------------
+
+The data is returned as an `Array` of `Array`s of `DateTime`s and `Float`s, e.g.:
+
+    [
+      [DateTime.now,          1.0],
+      [DateTime.now - 1.day,  2.0],
+      [DateTime.now - 2.days, 3.0]
+    ]
+
+Reportable provides a helper method to generate a sparkline image from this data that you can use in your views:
+
+    <%= sparkline_tag(User.registrations_report) %>
+
+
+Installation
+------------
+
+To install Reportable, simply run
+
+    [sudo] gem install reportable
+
+and add it to your application's dependencies in your `environment.rb`:
+
+    config.gem 'reportable', :lib => 'saulabs/reportable'
+
+When you installed the gem, you have to generate the migration that creates Reportable's cache table:
+
+    ./script/generate reportable_migration create_reportable_cache
+
+and migrate:
+
+    rake db:migrate
+
+
+Plans
+-----
+
+* add support for Oracle and MSSQL
+* add support for DataMapper
+* add more options to generate graphs from the data
+* add the option to generate textual reports on the command line
+
+
+Authors
+-------
+
+© 2008-2010 Marco Otte-Witte (<http://simplabs.com>), Martin Kavalar (<http://www.sauspiel.de>)
+
+Released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+Bundler.setup
+Bundler.require
+
+require 'spec/rake/spectask'
+require 'simplabs/excellent/rake'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.rcov_opts  << '--exclude "gems/*,spec/*,init.rb"'
+  t.rcov       = true
+  t.rcov_dir   = 'doc/coverage'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb', '-', 'HISTORY.md']
+  t.options = ['--no-private', '--title', 'Reportable Documentation']
+end
+
+Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
+  t.paths = %w(lib)
+end

data/generators/reportable_migration/reportable_migration_generator.rb

@@ -0,0 +1,9 @@
+class ReportableMigrationGenerator < Rails::Generator::NamedBase
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.erb', 'db/migrate'
+    end
+  end
+
+end

data/generators/reportable_migration/templates/migration.erb

@@ -0,0 +1,40 @@
+class <%= class_name %> < ActiveRecord::Migration
+
+  def self.up
+    create_table :reportable_cache, :force => true do |t|
+      t.string   :model_name,       :null => false
+      t.string   :report_name,      :null => false
+      t.string   :grouping,         :null => false
+      t.string   :aggregation,      :null => false
+      t.string   :condition,        :null => false
+      t.float    :value,            :null => false, :default => 0
+      t.datetime :reporting_period, :null => false
+
+      t.timestamps
+    end
+
+    add_index :reportable_cache, [
+      :model_name,
+      :report_name,
+      :grouping,
+      :aggregation,
+      :condition
+    ], :name => :name_model_grouping_agregation
+    add_index :reportable_cache, [
+      :model_name,
+      :report_name,
+      :grouping,
+      :aggregation,
+      :condition,
+      :reporting_period
+    ], :unique => true, :name => :name_model_grouping_aggregation_period
+  end
+
+  def self.down
+    remove_index :reportable_cache, :name => :name_model_grouping_agregation
+    remove_index :reportable_cache, :name => :name_model_grouping_aggregation_period
+
+    drop_table :reportable_cache
+  end
+
+end

data/lib/saulabs/reportable.rb

@@ -0,0 +1,63 @@
+module Saulabs
+
+  module Reportable
+
+    # Extends the {Saulabs::Reportable::ClassMethods#reportable} method into +base+.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # Generates a report on a model. That report can then be executed via the new method +<name>_report+ (see documentation of {Saulabs::Reportable::Report#run}).
+      # 
+      # @param [String] name
+      #   the name of the report, also defines the name of the generated report method (+<name>_report+)
+      # @param [Hash] options
+      #   the options to generate the reports with
+      #
+      # @option options [Symbol] :date_column (created_at)
+      #   the name of the date column over that the records are aggregated
+      # @option options [String, Symbol] :value_column (:id)
+      #   the name of the column that holds the values to aggregate when using a calculation aggregation like +:sum+
+      # @option options [Symbol] :aggregation (:count)
+      #   the aggregation to use (one of +:count+, +:sum+, +:minimum+, +:maximum+ or +:average+); when using anything other than +:count+, +:value_column+ must also be specified
+      # @option options [Symbol] :grouping (:day)
+      #   the period records are grouped in (+:hour+, +:day+, +:week+, +:month+); <b>Beware that <tt>reportable</tt> treats weeks as starting on monday!</b>
+      # @option options [Fixnum] :limit (100)
+      #   the number of reporting periods to get (see +:grouping+)
+      # @option options [Hash] :conditions ({})
+      #   conditions like in +ActiveRecord::Base#find+; only records that match these conditions are reported;
+      # @option options [Boolean] :live_data (false)
+      #   specifies whether data for the current reporting period is to be read; <b>if +:live_data+ is +true+, you will experience a performance hit since the request cannot be satisfied from the cache alone</b>
+      # @option options [DateTime, Boolean] :end_date (false)
+      #   when specified, the report will only include data for the +:limit+ reporting periods until this date.
+      #
+      # @example Declaring reports on a model
+      #
+      #  class User < ActiveRecord::Base
+      #    reportable :registrations, :aggregation => :count
+      #    reportable :activations,   :aggregation => :count, :date_column => :activated_at
+      #    reportable :total_users,   :cumulate => true
+      #    reportable :rake,          :aggregation => :sum,   :value_column => :profile_visits
+      #  end
+      def reportable(name, options = {})
+        (class << self; self; end).instance_eval do
+          define_method "#{name.to_s}_report".to_sym do |*args|
+            if options.delete(:cumulate)
+              report = Saulabs::Reportable::CumulatedReport.new(self, name, options)
+            else
+              report = Saulabs::Reportable::Report.new(self, name, options)
+            end
+            raise ArgumentError.new unless args.length == 0 || (args.length == 1 && args[0].is_a?(Hash))
+            report.run(args.length == 0 ? {} : args[0])
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/saulabs/reportable/cumulated_report.rb

@@ -0,0 +1,42 @@
+module Saulabs
+
+  module Reportable
+
+    # A special report class that cumulates all data (see {Saulabs::Reportable::Report})
+    #
+    # @example Cumulated reports as opposed to regular reports
+    #
+    #  [[<DateTime today>, 1], [<DateTime yesterday>, 2], etc.]
+    #  [[<DateTime today>, 3], [<DateTime yesterday>, 2], etc.]
+    #
+    class CumulatedReport < Report
+
+      # Runs the report (see {Saulabs::Reportable::Report#run})
+      #
+      def run(options = {})
+        cumulate(super, options_for_run(options))
+      end
+
+      private
+
+        def cumulate(data, options)
+          first_reporting_period = ReportingPeriod.first(options[:grouping], options[:limit], options[:end_date])
+          acc = initial_cumulative_value(first_reporting_period.date_time, options)
+          result = []
+          data.each do |element|
+            acc += element[1].to_f
+            result << [element[0], acc]
+          end
+          result
+        end
+
+        def initial_cumulative_value(date, options)
+          conditions = setup_conditions(nil, date, options[:conditions])
+          @klass.send(@aggregation, @value_column, :conditions => conditions)
+        end
+
+    end
+
+  end
+
+end

data/lib/saulabs/reportable/grouping.rb

@@ -0,0 +1,140 @@
+module Saulabs
+
+  module Reportable
+
+    # The grouping specifies which records are grouped into one {Saulabs::Reportable::ReportingPeriod}.
+    #
+    class Grouping
+
+      # Initializes a new grouping.
+      #
+      # @param [Symbol] identifier
+      #   the identifier of the grouping (one of +:hour+, +:day+, +:week+ or +:month+)
+      #
+      def initialize(identifier)
+        raise ArgumentError.new("Invalid grouping #{identifier}") unless [:hour, :day, :week, :month].include?(identifier)
+        @identifier = identifier
+      end
+
+      # Gets the identifier of the grouping.
+      #
+      # @return [Symbol]
+      #   the identifier of the grouping.
+      #
+      def identifier
+        @identifier
+      end
+
+      # Gets an array of date parts from a DB string.
+      #
+      # @param [String] db_string
+      #   the DB string to get the date parts from
+      #
+      # @return [Array<Fixnum>]
+      #   array of numbers that represent the values of the date
+      #
+      def date_parts_from_db_string(db_string)
+        case ActiveRecord::Base.connection.adapter_name
+          when /mysql/i
+            from_mysql_db_string(db_string)
+          when /sqlite/i
+            from_sqlite_db_string(db_string)
+          when /postgres/i
+            from_postgresql_db_string(db_string)
+        end
+      end
+
+      # Converts the grouping into a DB specific string that can be used to group records.
+      #
+      # @param [String] date_column
+      #   the name of the DB column that holds the date
+      #
+      def to_sql(date_column)
+        case ActiveRecord::Base.connection.adapter_name
+          when /mysql/i
+            mysql_format(date_column)
+          when /sqlite/i
+            sqlite_format(date_column)
+          when /postgres/i
+            postgresql_format(date_column)
+        end
+      end
+
+      private
+
+        def from_mysql_db_string(db_string)
+          if @identifier == :week
+            parts = [db_string[0..3], db_string[4..5]].map(&:to_i)
+          else
+            db_string.split('/').map(&:to_i)
+          end
+        end
+
+        def from_sqlite_db_string(db_string)
+          if @identifier == :week
+            parts = db_string.split('-').map(&:to_i)
+            date = Date.new(parts[0], parts[1], parts[2])
+            return [date.cwyear, date.cweek]
+          end
+          db_string.split('/').map(&:to_i)
+        end
+
+        def from_postgresql_db_string(db_string)
+          case @identifier
+            when :hour
+              return (db_string[0..9].split('-') + [db_string[11..12]]).map(&:to_i)
+            when :day
+              return db_string[0..9].split('-').map(&:to_i)
+            when :week
+              parts = db_string[0..9].split('-').map(&:to_i)
+              date = Date.new(parts[0], parts[1], parts[2])
+              return [date.cwyear, date.cweek]
+            when :month
+              return db_string[0..6].split('-')[0..1].map(&:to_i)
+          end
+        end
+
+        def mysql_format(date_column)
+          case @identifier
+            when :hour
+              "DATE_FORMAT(#{date_column}, '%Y/%m/%d/%H')"
+            when :day
+              "DATE_FORMAT(#{date_column}, '%Y/%m/%d')"
+            when :week
+              "YEARWEEK(#{date_column}, 3)"
+            when :month
+              "DATE_FORMAT(#{date_column}, '%Y/%m')"
+          end
+        end
+
+        def sqlite_format(date_column)
+          case @identifier
+            when :hour
+              "strftime('%Y/%m/%d/%H', #{date_column})"
+            when :day
+              "strftime('%Y/%m/%d', #{date_column})"
+            when :week
+              "date(#{date_column}, 'weekday 0')"
+            when :month
+              "strftime('%Y/%m', #{date_column})"
+          end
+        end
+
+        def postgresql_format(date_column)
+          case @identifier
+            when :hour
+              "date_trunc('hour', #{date_column})"
+            when :day
+              "date_trunc('day', #{date_column})"
+            when :week
+              "date_trunc('week', #{date_column})"
+            when :month
+              "date_trunc('month', #{date_column})"
+          end
+        end
+
+    end
+
+  end
+
+end

data/lib/saulabs/reportable/report.rb

@@ -0,0 +1,165 @@
+module Saulabs
+
+  module Reportable
+
+    # The Report class that does all the data retrieval and calculations.
+    #
+    class Report
+
+      # the model the report works on (This is the class you invoke {Saulabs::Reportable::ClassMethods#reportable} on)
+      #
+      attr_reader :klass
+
+      # the name of the report (as in {Saulabs::Reportable::ClassMethods#reportable})
+      #
+      attr_reader :name
+
+      # the name of the date column over that the records are aggregated
+      #
+      attr_reader :date_column
+
+      # the name of the column that holds the values to aggregate when using a calculation aggregation like +:sum+
+      #
+      attr_reader :value_column
+
+      # the aggregation to use (one of +:count+, +:sum+, +:minimum+, +:maximum+ or +:average+); when using anything other than +:count+, +:value_column+ must also be specified
+      #
+      attr_reader :aggregation
+
+      # options for the report
+      #
+      attr_reader :options
+
+      # Initializes a new {Saulabs::Reportable::Report}
+      #
+      # @param [Class] klass
+      #   the model the report works on (This is the class you invoke {Saulabs::Reportable::ClassMethods#reportable} on)
+      # @param [String] name
+      #   the name of the report (as in {Saulabs::Reportable::ClassMethods#reportable})
+      # @param [Hash] options
+      #   options for the report creation
+      #
+      # @option options [Symbol] :date_column (created_at)
+      #   the name of the date column over that the records are aggregated
+      # @option options [String, Symbol] :value_column (:id)
+      #   the name of the column that holds the values to aggregate when using a calculation aggregation like +:sum+
+      # @option options [Symbol] :aggregation (:count)
+      #   the aggregation to use (one of +:count+, +:sum+, +:minimum+, +:maximum+ or +:average+); when using anything other than +:count+, +:value_column+ must also be specified
+      # @option options [Symbol] :grouping (:day)
+      #   the period records are grouped in (+:hour+, +:day+, +:week+, +:month+); <b>Beware that <tt>reportable</tt> treats weeks as starting on monday!</b>
+      # @option options [Fixnum] :limit (100)
+      #   the number of reporting periods to get (see +:grouping+)
+      # @option options [Hash] :conditions ({})
+      #   conditions like in +ActiveRecord::Base#find+; only records that match these conditions are reported;
+      # @option options [Boolean] :live_data (false)
+      #   specifies whether data for the current reporting period is to be read; <b>if +:live_data+ is +true+, you will experience a performance hit since the request cannot be satisfied from the cache alone</b>
+      # @option options [DateTime, Boolean] :end_date (false)
+      #   when specified, the report will only include data for the +:limit+ reporting periods until this date.
+      #
+      def initialize(klass, name, options = {})
+        ensure_valid_options(options)
+        @klass        = klass
+        @name         = name
+        @date_column  = (options[:date_column] || 'created_at').to_s
+        @aggregation  = options[:aggregation] || :count
+        @value_column = (options[:value_column] || (@aggregation == :count ? 'id' : name)).to_s
+        @options = {
+          :limit      => options[:limit] || 100,
+          :conditions => options[:conditions] || [],
+          :grouping   => Grouping.new(options[:grouping] || :day),
+          :live_data  => options[:live_data] || false,
+          :end_date   => options[:end_date] || false
+        }
+        @options.merge!(options)
+        @options.freeze
+      end
+
+      # Runs the report and returns an array of array of DateTimes and Floats
+      #
+      # @param [Hash] options
+      #   options to run the report with
+      #
+      # @option options [Symbol] :grouping (:day)
+      #   the period records are grouped in (+:hour+, +:day+, +:week+, +:month+); <b>Beware that <tt>reportable</tt> treats weeks as starting on monday!</b>
+      # @option options [Fixnum] :limit (100)
+      #   the number of reporting periods to get (see +:grouping+)
+      # @option options [Hash] :conditions ({})
+      #   conditions like in +ActiveRecord::Base#find+; only records that match these conditions are reported;
+      # @option options [Boolean] :live_data (false)
+      #   specifies whether data for the current reporting period is to be read; <b>if +:live_data+ is +true+, you will experience a performance hit since the request cannot be satisfied from the cache alone</b>
+      # @option options [DateTime, Boolean] :end_date (false)
+      #   when specified, the report will only include data for the +:limit+ reporting periods until this date.
+      #
+      # @return [Array<Array<DateTime, Float>>]
+      #   the result of the report as pairs of {DateTime}s and {Float}s
+      #
+      def run(options = {})
+        options = options_for_run(options)
+        ReportCache.process(self, options) do |begin_at, end_at|
+          read_data(begin_at, end_at, options)
+        end
+      end
+
+      private
+
+        def options_for_run(options = {})
+          options = options.dup
+          ensure_valid_options(options, :run)
+          options.reverse_merge!(@options)
+          options[:grouping] = Grouping.new(options[:grouping]) unless options[:grouping].is_a?(Grouping)
+          return options
+        end
+
+        def read_data(begin_at, end_at, options)
+          conditions = setup_conditions(begin_at, end_at, options[:conditions])
+          @klass.send(@aggregation,
+            @value_column,
+            :conditions => conditions,
+            :group      => options[:grouping].to_sql(@date_column),
+            :order      => "#{options[:grouping].to_sql(@date_column)} ASC",
+            :limit      => options[:limit]
+          )
+        end
+
+        def setup_conditions(begin_at, end_at, custom_conditions = [])
+          conditions = [@klass.send(:sanitize_sql_for_conditions, custom_conditions) || '']
+          conditions[0] += "#{(conditions[0].blank? ? '' : ' AND ')}#{ActiveRecord::Base.connection.quote_table_name(@klass.table_name)}.#{ActiveRecord::Base.connection.quote_column_name(@date_column.to_s)} "
+          conditions[0] += if begin_at && end_at
+            'BETWEEN ? AND ?'
+          elsif begin_at
+            '>= ?'
+          elsif end_at
+            '<= ?'
+          else
+            raise ArgumentError.new('You must pass either begin_at, end_at or both to setup_conditions.')
+          end
+          conditions << begin_at if begin_at
+          conditions << end_at if end_at
+          conditions
+        end
+
+        def ensure_valid_options(options, context = :initialize)
+          case context
+            when :initialize
+              options.each_key do |k|
+                raise ArgumentError.new("Invalid option #{k}!") unless [:limit, :aggregation, :grouping, :date_column, :value_column, :conditions, :live_data, :end_date].include?(k)
+              end
+              raise ArgumentError.new("Invalid aggregation #{options[:aggregation]}!") if options[:aggregation] && ![:count, :sum, :maximum, :minimum, :average].include?(options[:aggregation])
+              raise ArgumentError.new('The name of the column holding the value to sum has to be specified for aggregation :sum!') if [:sum, :maximum, :minimum, :average].include?(options[:aggregation]) && !options.key?(:value_column)
+            when :run
+              options.each_key do |k|
+                raise ArgumentError.new("Invalid option #{k}!") unless [:limit, :conditions, :grouping, :live_data, :end_date].include?(k)
+              end
+          end
+          raise ArgumentError.new('Options :live_data and :end_date may not both be specified!') if options[:live_data] && options[:end_date]
+          raise ArgumentError.new("Invalid grouping #{options[:grouping]}!") if options[:grouping] && ![:hour, :day, :week, :month].include?(options[:grouping])
+          raise ArgumentError.new("Invalid conditions: #{options[:conditions].inspect}!") if options[:conditions] && !options[:conditions].is_a?(Array) && !options[:conditions].is_a?(Hash)
+          raise ArgumentError.new("Invalid end date: #{options[:end_date].inspect}; must be a DateTime!") if options[:end_date] && !options[:end_date].is_a?(DateTime) && !options[:end_date].is_a?(Time)
+          raise ArgumentError.new('End date may not be in the future!') if options[:end_date] && options[:end_date] > DateTime.now
+        end
+
+    end
+
+  end
+
+end