best_boy 1.3.0 → 2.0.0

data/app/views/best_boy/best_boy_events/details.html.erb

@@ -18,30 +18,26 @@
           <th colspan="2">day</th>
         </tr>
       </thead>
-      <tbody>
-        <% @event_source_counts_per_group.each do |event_source_string, group_hash| %>
+      <% if available_event_sources.first.present? %>
+        <tbody>
+          <% @sourced_occurrences.keys.each do |source| %>
           <tr>
-            <td><%= event_source_string %></td>
-            <% group_hash.each do |group, counter| %>
-              <td><%= counter %></td>
-              <td><%= number_to_percentage(counter.to_f / detail_count * 100, :precision => 2) %></td>
+            <td><%= source %><dd/td>
+            <% @sourced_occurrences[source].keys.reverse.each do |time_period| %>
+              <td><%= @sourced_occurrences[source][time_period]  %></td>
+              <td><%= relative_occurrences(@sourced_occurrences[source], time_period) %></td>
             <% end %>
           </tr>
-        <% end %>
-      </tbody>
+          <% end %>
+        </tbody>
+      <% end %>
       <tfoot>
         <tr>
-          <th>Total</th>
-          <th><%= result = @event_source_counts_per_group.values.inject(0){|sum, hash| sum += hash['overall'].to_i; sum} %></th>
-          <th><%= number_to_percentage(result.to_f / detail_count * 100, :precision => 2) %></th>
-          <th><%= result = @event_source_counts_per_group.values.inject(0){|sum, hash| sum += hash['year'].to_i; sum} %></th>
-          <th><%= number_to_percentage(result.to_f / detail_count * 100, :precision => 2) %></th>
-          <th><%= result = @event_source_counts_per_group.values.inject(0){|sum, hash| sum += hash['month'].to_i; sum} %></th>
-          <th><%= number_to_percentage(result.to_f / detail_count * 100, :precision => 2) %></th>
-          <th><%= result = @event_source_counts_per_group.values.inject(0){|sum, hash| sum += hash['week'].to_i; sum} %></th>
-          <th><%= number_to_percentage(result.to_f / detail_count * 100, :precision => 2) %></th>
-          <th><%= result = @event_source_counts_per_group.values.inject(0){|sum, hash| sum += hash['day'].to_i; sum} %></th>
-          <th><%= number_to_percentage(result.to_f / detail_count * 100, :precision => 2) %></th>
+          <th>All</th>
+          <% @occurrences[params[:event]].keys.reverse.each do |time_period| %>
+            <th><%= @occurrences[params[:event]][time_period]  %></th>
+            <th><%= relative_occurrences(@occurrences[params[:event]], time_period)%></th>
+          <% end %>
         </tr>
       </tfoot>
     </table>
@@ -68,15 +64,25 @@
         </tr>
       </thead>
       <tbody>
-        <% @event_sources_counts_per_month.each do |event_source_string, month_hash| %>
-          <tr>
-            <td><%= event_source_string %></td>
-            <% month_hash.each do |month, counter| %>
-              <td><%= counter %></td>
-            <% end %>
-          </tr>
+        <% if available_event_sources? %>
+          <% @event_selected_year_occurrences.keys.reject { |k| k == "All" }.each do |source| %>
+            <tr>
+              <td><%= source %></td>
+              <% @event_selected_year_occurrences[source].keys.reject.each do |month| %>
+                <td><%= @event_selected_year_occurrences[source][month] %></td>
+              <% end %>
+            </tr>
+          <% end %>
         <% end %>
       </tbody>
+      <tfoot>
+        <tr>
+          <td><strong>All</strong></td>
+          <% @event_selected_year_occurrences["All"].keys.each do |month| %>
+            <td><%= @event_selected_year_occurrences["All"][month] %></td>
+          <% end %>
+        </tr>
+      </tfoot>
     </table>
   </div>
-</div>
+</div>

data/app/views/best_boy/best_boy_events/monthly_details.html.erb

@@ -24,20 +24,20 @@
       <thead>
         <tr>
           <th>Event Source</th>
-          <% (1..(Time.days_in_month("1-#{current_month}-#{current_year}".to_time.month))).each do |day| %>
-            <td><%= day %></td>
+          <% days_of(current_month).each do |day| %>
+            <td><%= day.strftime("%d") %></td>
           <% end %>
         </tr>
       </thead>
       <tbody>
-        <% @event_sources_counts_per_day.each do |event_source_string, day_hash| %>
+        <% @selected_month_occurrences.keys.each do |source| %>
           <tr>
-            <td><%= event_source_string %></td>
-            <% day_hash.each do |day, counter| %>
-              <td><%= counter %></td>
-            <% end %>
+            <td><%= source %></td>
+            <% @selected_month_occurrences[source].keys.each do |day| %>
+              <td><%= @selected_month_occurrences[source][day] %></td>
+            <% end%>
           </tr>
-        <% end %>
+        <% end%>
       </tbody>
     </table>
   </div>
@@ -48,4 +48,4 @@
     <div id='chart'></div>
     <%= render_chart(@chart, 'chart') %>
   </div>
-</div>
+</div>

data/app/views/best_boy/best_boy_events/stats.html.erb

@@ -15,29 +15,30 @@
         </tr>
       </thead>
       <tbody>
-        <% @event_counts_per_group.each do |event_string, group_hash| %>
+        <% @occurrences.keys.each do |key| %>
           <tr>
-            <td><%= link_to event_string, best_boy_admin_details_path(:event => event_string, :owner_type => current_owner_type) %></td>
-            <% group_hash.each do |group, counter| %>
-              <td><%= counter %></td>
-            <% end %>
+            <td><%= link_to key, best_boy_admin_details_path(:event => key, :owner_type => current_owner_type) %></td>
+            <td><%= @occurrences[key][:overall] %></td>
+            <td><%= @occurrences[key][:yearly] %></td>
+            <td><%= @occurrences[key][:monthly] %></td>
+            <td><%= @occurrences[key][:weekly] %> </td>
+            <td><%= @occurrences[key][:daily] %></td>
           </tr>
         <% end %>
       </tbody>
       <tfoot>
         <tr>
           <th>Total</th>
-          <th><%= @event_counts_per_group.values.inject(0){|sum, hash| sum += hash['overall'].to_i; sum} %></th>
-          <th><%= @event_counts_per_group.values.inject(0){|sum, hash| sum += hash['year'].to_i; sum} %></th>
-          <th><%= @event_counts_per_group.values.inject(0){|sum, hash| sum += hash['month'].to_i; sum} %></th>
-          <th><%= @event_counts_per_group.values.inject(0){|sum, hash| sum += hash['week'].to_i; sum} %></th>
-          <th><%= @event_counts_per_group.values.inject(0){|sum, hash| sum += hash['day'].to_i; sum} %></th>
+          <th><%= @this_year_totals[:overall] %></th>
+          <th><%= @this_year_totals[:yearly] %></th>
+          <th><%= @this_year_totals[:monthly] %></th>
+          <th><%= @this_year_totals[:weekly] %></th>
+          <th><%= @this_year_totals[:daily] %></th>
         </tr>
       </tfoot>
     </table>
   </div>
 </div>
-
 <div class="span12">
   <div class="well">
     <h3 class="pull-left">Statistics for <%= current_year %> per month</h3>
@@ -57,23 +58,23 @@
         </tr>
       </thead>
       <tbody>
-        <% @event_counts_per_month.each do |event_string, month_hash| %>
+        <% @selected_year_occurrences.keys.each do |event| %>
           <tr>
-            <td><%= event_string %></td>
-            <% month_hash.each do |month, counter| %>
-              <td><%= counter %></td>
+            <td><%= event %></td>
+            <% @selected_year_occurrences[event].keys.each do |month| %>
+              <td><%= @selected_year_occurrences[event][month] %></td>
             <% end %>
           </tr>
         <% end %>
       </tbody>
       <tfoot>
         <tr>
-          <th>Total</th>
-          <% (1..12).to_a.map(&:to_s).each do |month_no| %>
-            <th><%= @event_counts_per_month.values.inject(0){|sum, hash| sum += hash[month_no].to_i; sum} %></th>
+          <th><strong>Total</strong></th>
+          <% @selected_year_totals.keys.each do |month| %>
+            <th><%= @selected_year_totals[month] %></th>
           <% end %>
         </tr>
       </tfoot>
     </table>
   </div>
-</div>
+</div>

data/lib/best_boy/engine.rb

@@ -18,6 +18,8 @@ module BestBoy
       if BestBoy.orm == :active_record
         require "best_boy/models/active_record/best_boy_event.rb"
         require "best_boy/models/active_record/best_boy/eventable.rb"
+        require "best_boy/models/active_record/best_boy_day_report.rb"
+        require "best_boy/models/active_record/best_boy_month_report.rb"
         ActiveRecord::Base.send(:include, BestBoy::Eventable)
       else
         raise "Sorry, best_boy actually only supports ActiveRecord ORM."

data/lib/best_boy/models/active_record/best_boy/eventable.rb

@@ -52,6 +52,25 @@ module BestBoy
       best_boy_event = BestBoyEvent.new(:event => type, :event_source => source)
       best_boy_event.owner = self
       best_boy_event.save
+      report type, source
+    end
+
+    def report type, source = nil
+      month_report             = BestBoy::MonthReport.current_or_create_for(self.class.to_s, type)
+      month_report_with_source = BestBoy::MonthReport.current_or_create_for(self.class.to_s, type, source) if source.present?
+
+      day_report             = BestBoy::DayReport.current_or_create_for(self.class.to_s, type)
+      day_report_with_source = BestBoy::DayReport.current_or_create_for(self.class.to_s, type, source) if source.present?
+
+      increment_occurrences_in_reports month_report, month_report_with_source, day_report, day_report_with_source
+    end
+
+    def increment_occurrences_in_reports(month_report, month_report_with_source, day_report, day_report_with_source)
+      day_report_with_source.increment!(:occurrences) if day_report_with_source.present?
+      month_report_with_source.increment!(:occurrences) if month_report_with_source.present?
+
+      day_report.increment!(:occurrences)
+      month_report.increment!(:occurrences)
     end
   end
 end

data/lib/best_boy/models/active_record/best_boy_day_report.rb

@@ -0,0 +1,65 @@
+module BestBoy
+  class DayReport < ActiveRecord::Base
+
+    # db configuration
+    #
+    #
+
+    self.table_name = "best_boy_day_reports"
+
+    # associations
+    #
+    #
+
+    belongs_to :owner, polymorphic: true
+    belongs_to :month_report
+
+    # validations
+    #
+    #
+
+    validates :month_report_id, :owner_type, :event, presence: true
+
+    # scopes
+    #
+    #
+
+    scope :created_on, ->(date) { where(created_at: date.beginning_of_day..date.end_of_day) }
+    scope :week,       ->       { where(created_at: Time.zone.now.beginning_of_week..Time.zone.now)   }
+
+    # class methods
+    #
+    #
+
+    def self.current_for(date, owner, type, source = nil)
+      self.for(owner, type, source).created_on(date)
+    end
+
+    def self.current_or_create_for(owner, type, source = nil)
+      day_report = self.current_for(Time.zone.now, owner, type, source).last
+      day_report.present? ? day_report : self.create_for(owner, type, source)
+    end
+
+    def self.create_for(owner, type, source = nil)
+      month_report = BestBoy::MonthReport.current_or_create_for(owner, type, source)
+      BestBoy::DayReport.create(
+        owner_type:  owner,
+        event:      type,
+        month_report_id: month_report.to_param,
+        event_source:    source
+      )
+    end
+
+    def self.for(owner, type, source = nil)
+      self.where(owner_type: owner, event: type, event_source: source)
+    end
+
+    def self.daily_occurrences_for(owner, type, source = nil, date)
+      self.created_on(date).for(owner, type, source).sum(:occurrences)
+    end
+
+    def self.weekly_occurrences_for(owner, type, source = nil)
+      self.week.for(owner, type, source).sum(:occurrences)
+    end
+  end
+end

data/lib/best_boy/models/active_record/best_boy_event.rb

@@ -10,14 +10,4 @@ class BestBoyEvent < ActiveRecord::Base
   #
   validates :event, :presence => true
 
-  # scopes
-  #
-  #
-
-  scope :per_day, lambda { |date| where("best_boy_events.created_at BETWEEN ? AND ?", date.beginning_of_day, date.end_of_day) }
-  scope :per_week, lambda { |date| where("best_boy_events.created_at BETWEEN ? AND ?", date.beginning_of_week, date.end_of_week) }
-  scope :per_month, lambda { |date| where("best_boy_events.created_at BETWEEN ? AND ?", date.beginning_of_month, date.end_of_month) }
-  scope :per_year, lambda { |date| where("best_boy_events.created_at BETWEEN ? AND ?", date.beginning_of_year, date.end_of_year) }
-
-
-end
+end

data/lib/best_boy/models/active_record/best_boy_month_report.rb

@@ -0,0 +1,63 @@
+module BestBoy
+  class MonthReport < ActiveRecord::Base
+
+    # db configuration
+    #
+    #
+
+    self.table_name = "best_boy_month_reports"
+
+    # associations
+    #
+    #
+
+    belongs_to :owner, polymorphic: true
+    has_many :day_reports
+
+    # validations
+    #
+    #
+
+    validates :owner_type, :event, presence: true
+
+    # scopes
+    #
+    #
+
+    scope :created_on, ->(date)                 { where(created_at: date.beginning_of_day..date.end_of_day) }
+    scope :between,    ->(start_date, end_date) { where(created_at: start_date.beginning_of_day..end_date.end_of_day) }
+
+    # class methods
+    #
+    #
+
+    def self.current_for(date, owner, type, source = nil)
+      self.for(owner, type, source).between(date.beginning_of_month, date)
+    end
+
+    def self.current_or_create_for(owner, type, source = nil)
+      month_report = self.current_for(Time.zone.now, owner, type, source).last
+      month_report.present? ? month_report : self.create_for(owner, type, source)
+    end
+
+    def self.create_for(owner, type, source = nil)
+      BestBoy::MonthReport.create(owner_type: owner.to_s, event: type, event_source: source)
+    end
+
+    def self.for(owner, type, source = nil)
+      self.where(owner_type: owner, event: type, event_source: source)
+    end
+
+    def self.monthly_occurrences_for(owner, type, source = nil, date)
+      self.for(owner, type, source).between(date.beginning_of_month, date.end_of_month).sum(:occurrences)
+    end
+
+    def self.yearly_occurrences_for(owner, type, source = nil, date)
+      self.for(owner, type, source).between(date.beginning_of_year, date).sum(:occurrences)
+    end
+
+    def self.overall_occurrences_for(owner, type, source = nil)
+      self.for(owner, type, source).sum(:occurrences)
+    end
+  end
+end

data/lib/best_boy/version.rb

@@ -1,3 +1,3 @@
 module BestBoy
-  VERSION = "1.3.0"
+  VERSION = "2.0.0"
 end

data/lib/generators/active_record/best_boy_generator.rb

@@ -14,7 +14,10 @@ module ActiveRecord
       end
 
       def create_migration_file
-        %w(create_best_boy_events_table.rb add_event_source_to_best_boy_events_table.rb).each do |migration_file|
+        %w( create_best_boy_events_table.rb
+            add_event_source_to_best_boy_events_table.rb
+            create_best_boy_reports.rb
+          ).each do |migration_file|
           destination = "db/migrate/#{migration_file.sub(%r\.rb$\, '')}"
           if not self.class.migration_exists?(File.dirname(destination), File.basename(destination))
             migration_template migration_file, destination

data/lib/generators/active_record/templates/create_best_boy_reports.rb

@@ -0,0 +1,30 @@
+class CreateBestBoyReports < ActiveRecord::Migration
+  def self.up
+    create_table :best_boy_day_reports, :force => true do |t|
+      t.string  :owner_type
+      t.string  :event
+      t.string  :event_source
+      t.integer :month_report_id
+      t.integer :occurrences, default: 0
+      t.timestamps
+    end
+    add_index :best_boy_day_reports, [:owner_type, :event, :event_source], :name => :index_best_boy_day_reports_aggregated_columns
+    add_index :best_boy_day_reports, :created_at
+    add_index :best_boy_day_reports, :month_report_id
+
+    create_table :best_boy_month_reports, :force => true do |t|
+      t.string  :owner_type
+      t.string  :event
+      t.string  :event_source
+      t.integer :occurrences, default: 0
+      t.timestamps
+    end
+    add_index :best_boy_month_reports, [:owner_type, :event, :event_source], :name => :index_best_boy_month_reports_aggregated_columns
+    add_index :best_boy_month_reports, :created_at
+  end
+
+  def self.down
+    drop_table :best_boy_month_reports
+    drop_table :best_boy_day_reports
+  end
+end

data/lib/tasks/recover_report_history.rake

@@ -0,0 +1,146 @@
+namespace :best_boy do
+  desc "Creates consistent structure of DayReports and MonthReports for a given set of events"
+  task :recover_report_history, [:date]  => :environment do |t, args|
+
+    # helper methods
+    #
+    #
+
+    def month_report_id_for(year, owner_type, source, event)
+      date = Date.parse("#{year}-01-01")
+      BestBoy::MonthReport.where(created_at:   date.beginning_of_day..date.end_of_year.end_of_day,
+                                 owner_type:   owner_type,
+                                 event_source: source,
+                                 event:        event).first.id
+    end
+
+    def flush
+      print "."
+      STDOUT.flush
+    end
+
+    # Read optional date
+    #
+    #
+
+    start = args.date.present? ? Date.parse(args.date) : nil
+
+    puts ""
+    puts "> Destroying all reports ..."
+    puts ">... that where created after beginning of day #{start}" if start.present?
+    puts ""
+
+    # Destroy all existing reports
+    #
+    #
+
+    if start.present?
+      BestBoy::MonthReport.between(start, Date.today).destroy_all
+      BestBoy::DayReport.where(created_at: start.beginning_of_day..Date.today.end_of_day).destroy_all
+    else
+      BestBoy::MonthReport.destroy_all
+      BestBoy::DayReport.destroy_all
+    end
+
+    puts ""
+    puts "> Selected report data has been destroyed."
+    puts ""
+
+    owner_types             = BestBoyEvent.order(:owner_type).uniq.pluck(:owner_type)
+    available_events        = {}
+    available_event_sources = {}
+
+    owner_types.each do |owner_type|
+      available_events.merge!(        { owner_type => BestBoyEvent.where(owner_type: owner_type).order(:event).uniq.pluck(:event) } )
+      available_event_sources.merge!( { owner_type => BestBoyEvent.where(owner_type: owner_type).order(:event_source).uniq.pluck(:event_source) } ) # explicitly including nil
+    end
+
+    start = BestBoyEvent.order('created_at ASC').first.created_at.to_date unless start.present?
+    days  = (start..BestBoyEvent.order('created_at ASC').last.created_at.to_date)
+
+    puts ""
+    puts "> Start creating new reports for #{days.count} days ..."
+    puts ""
+
+    days.each do |day|
+      owner_types.each do |owner_type|
+        available_events[owner_type].each do |event|
+          available_event_sources[owner_type].each do |source|
+
+            base_scope = BestBoyEvent.where(owner_type: owner_type, event: event, event_source: source).order('created_at DESC')
+
+            # Create MonthReports when...
+            # - diving into loop initially or
+            # - a new month starts
+
+            if day.day == 1 || days.first == day
+
+              # Check if Events occured during the whole month.
+              # If any, create MonthReports.
+
+              month_scope         = base_scope.where(created_at: day.beginning_of_month.beginning_of_day..day.end_of_month.end_of_day)
+              monthly_occurrences = month_scope.count
+
+              if monthly_occurrences > 0
+                artifical_created_at = month_scope.first.created_at
+                if source.present?
+                  month_report_with_source = BestBoy::MonthReport.new
+                  month_report_with_source.owner_type = owner_type
+                  month_report_with_source.event = event
+                  month_report_with_source.event_source = source
+                  month_report_with_source.occurrences = monthly_occurrences
+                  month_report_with_source.created_at = artifical_created_at
+                  month_report_with_source.save!
+                end
+
+                month_report_without_source = BestBoy::MonthReport.new
+                month_report_without_source.owner_type = owner_type
+                month_report_without_source.event = event
+                month_report_without_source.event_source = nil
+                month_report_without_source.occurrences = monthly_occurrences
+                month_report_without_source.created_at = artifical_created_at
+                month_report_without_source.save!
+              end
+            end
+
+            # Create DayReports if Events occured that specific day
+            #
+            #
+
+            day_scope         = base_scope.where(created_at: day.beginning_of_day..day.end_of_day)
+            daily_occurrences = day_scope.count
+
+            if daily_occurrences > 0
+              if source.present?
+                day_report_with_source = BestBoy::DayReport.new
+                day_report_with_source.owner_type = owner_type
+                day_report_with_source.event = event
+                day_report_with_source.event_source = source
+                day_report_with_source.occurrences = daily_occurrences
+                day_report_with_source.created_at = day_scope.first.created_at
+                day_report_with_source.month_report_id = month_report_id_for(day.year, owner_type, source, event)
+                day_report_with_source.save!
+              end
+
+              day_report_without_source = BestBoy::DayReport.new
+              day_report_without_source.owner_type = owner_type
+              day_report_without_source.event = event
+              day_report_without_source.event_source = nil
+              day_report_without_source.occurrences = daily_occurrences
+              day_report_without_source.created_at = day_scope.first.created_at
+              day_report_without_source.month_report_id = month_report_id_for(day.year, owner_type, nil, event)
+              day_report_without_source.save!
+            end
+          end
+        end
+      end
+
+      flush
+    end
+
+    puts ""
+    puts ""
+    puts "> Reports recovered. Done!"
+    puts ""
+  end
+end