reportable 1.1.0 → 1.1.2

data/HISTORY.md

@@ -1,3 +1,13 @@
+v1.1.2
+------
+
+* pushed a faulty version to Rubygems - need to use a new version number for the fixed version
+
+v1.1.1
+------
+
+* not including the whole Saulabs::Reportable namespace into ActiveRecord anymore.
+
 v1.1.0
 ------
 

data/generators/reportable_jquery_flot_assets/reportable_jquery_flot_assets_generator.rb

@@ -1,4 +1,4 @@
-if Saulabs::Reportable::IS_RAILS3
+if Saulabs::Reportable::RailsAdapter::IS_RAILS3
 
   class ReportableJqueryFlotAssetsGenerator < Rails::Generators::Base
 

data/generators/reportable_migration/reportable_migration_generator.rb

@@ -1,4 +1,4 @@
-if Saulabs::Reportable::IS_RAILS3
+if Saulabs::Reportable::RailsAdapter::IS_RAILS3
 
   class ReportableMigrationGenerator < Rails::Generators::Base
 

data/generators/reportable_raphael_assets/reportable_raphael_assets_generator.rb

@@ -1,4 +1,4 @@
-if Saulabs::Reportable::IS_RAILS3
+if Saulabs::Reportable::RailsAdapter::IS_RAILS3
 
   class ReportableRaphaelAssetsGenerator < Rails::Generators::Base
 

data/lib/saulabs/reportable.rb

@@ -5,63 +5,69 @@ module Saulabs
 
   module Reportable
 
-    IS_RAILS3 = defined?(Rails) && Rails::VERSION::MAJOR >= 3
-
-    require 'saulabs/reportable/railtie' if IS_RAILS3
-
-    # Extends the {Saulabs::Reportable::ClassMethods#reportable} method into +base+.
+    # The adapter connects Reportable and Rails.
     #
-    def self.included(base)
-      base.extend ClassMethods
-    end
+    module RailsAdapter
 
-    module ClassMethods
+      IS_RAILS3 = defined?(Rails) && Rails::VERSION::MAJOR >= 3
 
-      # 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
+      require 'saulabs/reportable/railtie' if IS_RAILS3
+
+      # Extends the {Saulabs::Reportable::ClassMethods#reportable} method into +base+.
       #
-      #  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
-          report_klass = if options.delete(:cumulate)
-            Saulabs::Reportable::CumulatedReport
-          else
-            Saulabs::Reportable::Report
-          end
-          define_method("#{name.to_s}_report".to_sym) do |*args|
-            report = report_klass.new(self, name, options)
-            raise ArgumentError.new unless args.empty? || (args.length == 1 && args.first.is_a?(Hash))
-            report.run(args.first || {})
+      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
+            report_klass = if options.delete(:cumulate)
+              Saulabs::Reportable::CumulatedReport
+            else
+              Saulabs::Reportable::Report
+            end
+            define_method("#{name.to_s}_report".to_sym) do |*args|
+              report = report_klass.new(self, name, options)
+              raise ArgumentError.new unless args.empty? || (args.length == 1 && args.first.is_a?(Hash))
+              report.run(args.first || {})
+            end
           end
         end
+
       end
 
     end

data/rails/init.rb

@@ -3,7 +3,7 @@ require 'saulabs/reportable'
 require 'saulabs/reportable/report_tag_helper'
 
 ActiveRecord::Base.class_eval do
-  include Saulabs::Reportable
+  include Saulabs::Reportable::RailsAdapter
 end
 
 ActionView::Base.class_eval do

data/spec/db/schema.rb

@@ -25,7 +25,7 @@ ActiveRecord::Schema.define(:version => 1) do
     :grouping,
     :aggregation,
     :conditions
-  ], :name => :name_model_grouping_agregation
+  ], :name => 'name_model_grouping_agregation'
   add_index :reportable_cache, [
     :model_name,
     :report_name,
@@ -33,6 +33,6 @@ ActiveRecord::Schema.define(:version => 1) do
     :aggregation,
     :conditions,
     :reporting_period
-  ], :unique => true, :name => :name_model_grouping_aggregation_period
+  ], :unique => true, :name => 'name_model_grouping_aggregation_period'
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reportable
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Marco Otte-Witte
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-26 00:00:00 +02:00
+date: 2010-06-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency