best_boy 2.2.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c48525e82d4a49337c3940ecf10eb160d8dd1a
-  data.tar.gz: 412a38e42807d9fe19fa22667bc668feff7833c3
+  metadata.gz: 60316e2e138902bed41149f69236093c10dc2b42
+  data.tar.gz: 345c8c5a0ccd9f0652e823019e6f0d87a179a1ce
 SHA512:
-  metadata.gz: 43395b950a37ae16e7ae958e4c252b37d4651cdcb828bfdbd092d1542e2f7122202e1541e53effd78ec457af1920b0b8e84cffe7b5e66f92135bf0f9db76c91c
-  data.tar.gz: d687c76b054a487e8f27a8f165dc8ad30c205d284971526c97e89447a8ea56599f83b301910fc62a0b91c775b58384a85314873ae9ee1514213b64ac23ea2a85
+  metadata.gz: b917b25c4104b2e57ddf5e6bb752fc44d5be357f48913ac42d8609f767b1e8ee5aaa3dacb90dc51671f826da60571f7789fec3d878b2bfa048535981b3bd8a26
+  data.tar.gz: 4192cdb814d7f125b2be3bb41d32aa9e8d357cd20905cfd4bfb935926d3784138f9e291c779f1cb26cb72f180fdc320feb633160bf97ad260749e8829a36a202

data/README.md

@@ -6,20 +6,29 @@ best_boy
 [![best_boy API Documentation](https://www.omniref.com/ruby/gems/best_boy.png)](https://www.omniref.com/ruby/gems/best_boy)
 
 A simple event driven logging for ActiveRecord models.
+BestBoy is able to log model-based "create", "update" and "delete" events as well as custom events triggered in controller actions.
+It uses its own polymorphic database table to log each event.
 
 
-What does this gem do?
+Rails version support
 ----------------------
 
-best_boy logs "create" and "delete" events as well as custom events triggered by controller actions. It uses its own polymorphic database table to log each event.
-At the moment, best_boy only provides support for ActiveRecord models.
+BestBoy 3 and above only supports Rails >= 4.1
 
 
-Rails version support
+Changes in version 3
 ----------------------
 
-best_boy supports rails 3.2.x in its versions 1.1.x. At this point there is a feature stop and it will only provide fixes for its current features.
-Rails 4.0 support is provided in best_boy's versions 1.2.0 up to the current version.
+Best Boy version 3 comes with some backward incompatible changes. However, it's totally worth it because BestBoy now follows all the best practices of a rails engine.
+This and additional changes of version 3 include
+
+* Uses rails engine naming conventions with an isolated ``BestBoy`` namespace
+* serving the necessary migrations from the engines migration folder
+* serving all assets via the asset pipeline (used to be a opt-in before)
+* removes unnecessary generator boilerplate and config options
+* uses the newest Bootstrap version (3)
+* allows per class extending instead of polluting the whole app
+* answers to xml requests for easy EXCEL integration
 
 
 Installation
@@ -33,93 +42,18 @@ Install it with Bundler
 
     bundle install
 
-If you do NOT want to use the asset-pipeline, run the generator as followed
-
-    rails g best_boy
-
-This will install following files into your application
-
-    config/initializers/best_boy.rb
-
-    db_migrate/create_best_boy_events_table.rb
-
-    public/javascripts/bootstrap_datepicker.js
-
-    public/stylesheets/bootstrap.css
-
-    public/stylesheets/bootstrap_datepicker.css
-
-In case you want the gem be compatible with the asset-pipeline, add a flag to the generator call:
-
-    rails g best_boy --asset
-
-See usage section for version information.
-
-Run the migration
-
-    rake db:migrate
-
-
-Changelog
----------
-#### 2.2.3
-* Rename ``report``method to a more best_boy specific ``trigger_best_boy_event_report`
-
-#### 2.2.2
-* Fix dependency bug with kaminari
-
-#### 2.2.1
-* flexibilized report creation method to create reports for a specific date
-* no compatibility with Ruby 1.9.3
-
-#### 2.2.0
-* Updated dependencies for rspec and kaminari
-* Make recover_report_history rake task a noop for no previously tracked BestBoyEvents
-* Bugfix for report recovery rake task
-* use appraisal for testing against different gemsets and Ruby versions
-
-#### 2.1.3
-* Compatible with Rails 4.1
-* Loosened kaminari dependency requirements
-
-#### 2.1.0
-* Code cleanup - now compatible with RSpec 3 syntax
-* Support a "dry-run" test mode
-* Reduce public methods added by `BestBoy::Eventable` ([#4](https://github.com/Absolventa/best_boy/issues/4))
-* Remove mass-assignments that could cause problems with the protected_attributes gem [#8](https://github.com/Absolventa/best_boy/issues/8)
-* Do not expose mixed-in controller method ([#9](https://github.com/Absolventa/best_boy/issues/9)))
-* Avoid potential name clashes for callbacks switch ([#10](https://github.com/Absolventa/best_boy/issues/10))
-
-
-Upgrading to Version 2
---------------------------------
-
-From v2.x, BestBoy uses aggregated tables for the admin panel. You need
-to copy the new migrations to your app by running
-
-    rails g best_boy --asset
-
-again. This generator will also ask you to overwrite your existing initializer - just
-reject this pressing 'n' for not overwriting your settings. Don't forget to run
-
-    rake db:migrate
-
-and
+Install the migrations
 
-    rake best_boy:recover_report_history
-
-in the context of your mother app afterwards. See also section "Some thoughts about Performance"
-for more details about new data organization.
+    rake best_boy:install:migrations
 
+Mount the best boy backend in your routes.rb
 
-Update to fit the asset-pipeline
---------------------------------
+    mount BestBoy::Engine => "/best_boy"
 
-If you were using the gem without asset-pipeline and want to update your project to fit new rails versions, simply delete all best_boy files in your public folder.
+Run the generator to create your best_boy config file:
 
-If you need to precompile assets, maybe for deployment on heroku cedar stack, please add the following flag to your best_boy initializer.
+    rails g best_boy:install
 
-    config.precompile_assets = true
 
 
 Usage
@@ -127,21 +61,28 @@ Usage
 
 In model context:
 
+    include BestBoy::Eventable
     has_a_best_boy
 
-This will log "create" and "delete" event for each instance.
+This will log "create" and "delete" events for each instance.
 
-If you do not want to selflog create and delete events, maybe because you will sort it semantically with a create source, just deactivate the callback logging by setting the parameter :disable_callbacks to true.
+If you do not want to selflog those events, maybe because you will sort it semantically with a create source, just deactivate the callback logging by setting the parameter :disable_callbacks to true.
 
-    has_a_best_boy :disable_callbacks => true
+    include BestBoy::Eventable
+    has_a_best_boy disable_callbacks: true
 
 In controller context:
 
+    # in application_controller.rb or the relevant controller
+    include BestBoy::Controller
+
+    # in a resource specific controller
     best_boy_event object, event, event_source = nil
 
-This will log custom events for a object and a event phrase. You can specify this event with a event_source parameter to log maybe seperate create actions.
+This will log custom events for an object and an event phrase. You can specify this event with an event_source parameter to log maybe seperate create actions.
+
+If no object or event is given an exception will be raised.
 
-If no Object is given, it will raise an exception as well as if no event is provided.
 
 #### Test mode
 
@@ -162,15 +103,6 @@ Conversely, you can also sandbox a specific code block:
     end
 
 
-BestBoyEvent table
-------------------
-
-    t.integer   "owner_id"      # owner model id
-    t.string    "owner_type"    # owner model class type
-    t.string    "event"         # event (create, delete)
-    t.string    "event_source"  # event_source parameter for specific action tracking
-    t.datetime  "updated_at"    # last update timestamp
-    t.datetime  "created_at"    # creation timestamp
 
 Getting BestBoyEvents
 ---------------------
@@ -179,17 +111,12 @@ BestBoy comes with an admin interface, largely configurable to fit right into yo
 
 Following configurations can be done:
 
-    config.precompile_assets    "boolean"                   # default: false                        # if you need best_boy to precompile its assets for the asset-pipeline
-    config.orm                  "symbole"                   # default: :active_record               # for now only active_record is supported
     config.base_controller      "String"                    # default: "ApplicationController"      # declare with Controller should be inherited
     config.before_filter        "comma separated symbols"   # default: nil                          # declare before_filter to use inherited before_filters in admin section
     config.skip_before_filter   "comma separated symbols"   # default: nil                          # declare skip_before_filter to skip inherited before_filters in admin section
     config.skip_after_filter    "comma separated symbols"   # default: nil                          # declare skip_after_filter to skip inherited after_filters in admin section
     config.custom_redirect      "relative path as String"   # default: nil                          # set a path to return back to your existing backend
 
-After installation you can access it through:
-
-    <your application path>/best_boy_admin
 
 Some thoughts about Performance
 -------------------------------
@@ -207,21 +134,58 @@ If you're upgrading BestBoy from an older version, there
 is a rake task for 'recovering' these report structure for
 an existing set of events. Simply run
 
-    bundle exec rake best_boy:recover_report_history
+    rake best_boy:recover_report_history
 
 If you want to recover this report structure not for the whole lifetime,
 you can pass a date as argument to the rake task call:
 
-    bundle exec rake best_boy:recover_report_history['2010-02-01']
+    rake best_boy:recover_report_history['2010-02-01']
 
 The latter would destroy and recover the all reports created after
 beginning of Feb 1st, 2010 up to now.
 
 Budget some time for this task, since it can take long if your BestBoyEvent table has grown very big.
 
+
+Changelog
+---------
+#### 3.0.0
+* Major engine cleanup. Aims Rails >= 4.1 from now on.
+* Includes backward incompatible changes. See above hint for more information.
+
+#### 2.2.3
+* Rename ``report`` method to a more best_boy specific ``trigger_best_boy_event_report`
+
+#### 2.2.2
+* Fix dependency bug with kaminari
+
+#### 2.2.1
+* flexibilized report creation method to create reports for a specific date
+* no compatibility with Ruby 1.9.3
+
+#### 2.2.0
+* Updated dependencies for rspec and kaminari
+* Make recover_report_history rake task a noop for no previously tracked BestBoyEvents
+* Bugfix for report recovery rake task
+* use appraisal for testing against different gemsets and Ruby versions
+
+#### 2.1.3
+* Compatible with Rails 4.1
+* Loosened kaminari dependency requirements
+
+#### 2.1.0
+* Code cleanup - now compatible with RSpec 3 syntax
+* Support a "dry-run" test mode
+* Reduce public methods added by `BestBoy::Eventable` ([#4](https://github.com/Absolventa/best_boy/issues/4))
+* Remove mass-assignments that could cause problems with the protected_attributes gem [#8](https://github.com/Absolventa/best_boy/issues/8)
+* Do not expose mixed-in controller method ([#9](https://github.com/Absolventa/best_boy/issues/9)))
+* Avoid potential name clashes for callbacks switch ([#10](https://github.com/Absolventa/best_boy/issues/10))
+
+
+
 Used gems and resources
 -----------------------
-* [Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4
+* [Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 3
 * [Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style
 * [Winston Teo Yong Wei](https://github.com/winston/google_visualr) Google_Visualr in its version 2.1.2
 
@@ -235,7 +199,7 @@ Contributors in alphabetic order
 
 Thanks
 ------
-We ♥ PRs – thanks to everyone contributing to this project. Big thanks to each contributor on Impressionist. This gem helped me ([cseydel](https://github.com/cseydel)) a long way to get here in modelling and creating a gem.
+We ♥ PRs – thanks to everyone contributing to this project.
 
 
 See [LICENSE.txt](https://raw.github.com/Absolventa/best_boy/master/LICENSE.txt) for usage and licensing details.

data/app/assets/javascripts/best_boy/best_boy.js

@@ -10,4 +10,3 @@
 // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
 // GO AFTER THE REQUIRES BELOW.
 //
-//= require best_boy/bootstrap_datepicker

data/app/assets/stylesheets/best_boy/base.sass

@@ -0,0 +1,21 @@
+body
+  padding-top: 60px
+
+//reset pagination for kamiari
+nav.pagination
+  text-align: center
+  span
+    float: left
+    border: 1px solid #ddd
+    padding: 6px 12px
+    position: relative
+    line-height: 24px
+    a
+      text-decoration: none
+      background-color: #fff
+  span.current
+    background-color: whiteSmoke
+    color: #999
+    cursor: default
+  span.gap
+    padding: 6px 12px

data/app/assets/stylesheets/best_boy/best_boy.css

@@ -8,7 +8,5 @@
  * You're free to add application-wide styles to this file and they'll appear at the top of the
  * compiled file, but it's generally better to create a new file per style scope.
  *
- *= require_self
- *= require best_boy/bootstrap
- *= require best_boy/bootstrap_datepicker
+ *= require best_boy/base
 */

data/app/controllers/best_boy/{best_boy_events_controller.rb → events_controller.rb}

@@ -1,12 +1,12 @@
 module BestBoy
-  class BestBoyEventsController < BestBoy.base_controller.constantize
+  class EventsController < BestBoy.base_controller.constantize
 
     before_action BestBoy.before_filter if BestBoy.before_filter.present?
 
     skip_before_filter BestBoy.skip_before_filter if BestBoy.skip_before_filter.present?
     skip_after_filter BestBoy.skip_after_filter if BestBoy.skip_after_filter.present?
 
-    layout 'best_boy_backend'
+    layout 'best_boy/best_boy'
 
 
     helper BestBoy::BestBoyViewHelper
@@ -146,7 +146,7 @@ module BestBoy
     end
 
     def chart_for(data)
-      @chart = GoogleVisualr::Interactive::AreaChart.new(data, { width: 900, height: 240, title: "" })
+      @chart = GoogleVisualr::Interactive::AreaChart.new(data, { width: 1100, height: 300, title: "" })
     end
 
     def row_values_for(day)
@@ -285,7 +285,7 @@ module BestBoy
         instance_variable_set(instance_var, value)
       end
 
-      scope = BestBoyEvent
+      scope = BestBoy::Event
       scope = scope.where(owner_type: @owner_type) if @owner_type.present?
       scope = scope.where(event: @event) if @event.present?
       scope = scope.where(event_source: @event_source) if @event_source.present?

data/app/models/best_boy/event.rb

@@ -0,0 +1,29 @@
+module BestBoy
+  class Event < ActiveRecord::Base
+
+    include BestBoy::ObeysTestMode
+
+    # db configuration
+    #
+    #
+
+    self.table_name = "best_boy_events"
+
+    # associations
+    #
+    #
+    belongs_to :owner, polymorphic: true
+
+    # validations
+    #
+    #
+    validates :event, presence: true
+
+    # scopes
+    #
+    #
+
+    scope :per_day, ->(date) { where(created_at: date.beginning_of_day..date.end_of_day ) }
+
+  end
+end

data/app/views/best_boy/events/_navigation.html.erb

@@ -0,0 +1,11 @@
+<div class="row">
+  <div class="col-md-12">
+    <ul class="nav nav-tabs">
+      <% available_owner_types.each do |owner_type| %>
+        <li class="<%= (current_owner_type == owner_type) ? 'active' : nil %>">
+          <%= link_to owner_type, send("#{referrer}_events_path", owner_type: owner_type) %>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>

data/app/views/best_boy/events/charts.html.erb

@@ -0,0 +1,33 @@
+<% content_for :javascripts do %>
+  <%= javascript_include_tag "https://www.google.com/jsapi" %>
+<% end %>
+
+<div class="row">
+  <div class="col-md-12">
+    <%= form_tag charts_events_path, method: :get, id: "chart-form" do %>
+      <div class="form-group">
+        <div class="col-md-3">
+          <%= select_tag :owner_type, options_for_select([["Owner", nil]] + available_owner_types, selected: params[:owner_type]), onchange: "submit();", class: "form-control" %>
+        </div>
+        <div class="col-md-3">
+          <%= select_tag :event, options_for_select([["Event", nil]] + available_events, selected: params[:event]), onchange: "submit();", class: "form-control" %>
+        </div>
+        <div class="col-md-3">
+          <%= select_tag :event_source, options_for_select([["Event Source", nil]] + available_event_sources, selected: params[:event_source]), onchange: "submit();", class: "form-control" %>
+        </div>
+        <div class="col-md-3">
+          <%= select_tag :time_interval, options_for_select([["Time Interval", nil], ["yearly", "year"], ["monthly", "month"], ["weekly", "week"]], selected: params[:time_interval]), onchange: "submit();", class: "form-control" %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="well">
+      <div id='chart'></div>
+      <%= render_chart(@chart, 'chart') %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,98 @@
+<div class="row">
+  <div class="col-md-12">
+    <div class="well">
+      <%= link_to "<< back to stats", stats_events_path(owner_type: current_owner_type) %>
+    </div>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="well">
+      <h3>Detailed Statistics</h3>
+      <table class="table table-striped table-bordered">
+        <thead>
+          <tr>
+            <th>Source</th>
+            <th colspan="2">overall</th>
+            <th colspan="2">year</th>
+            <th colspan="2">month</th>
+            <th colspan="2">week</th>
+            <th colspan="2">day</th>
+          </tr>
+        </thead>
+        <% if available_event_sources.first.present? %>
+          <tbody>
+            <% @sourced_occurrences.keys.each do |source| %>
+            <tr>
+              <td><%= source %></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 %>
+        <tfoot>
+          <tr>
+            <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>
+    </div>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="well">
+      <div class="row">
+        <div class="col-md-10">
+          <h3>Detailed Statistics for <%= current_year %> per month</h3>
+        </div>
+        <div class="col-md-2">
+          <%= form_tag details_events_path, method: :get do %>
+            <%= hidden_field_tag :owner_type, current_owner_type %>
+            <%= hidden_field_tag :event, current_event %>
+            <%= select_tag :year, options_for_select(available_years, selected: current_year), onchange: "submit();", class: "form-control" %>
+          <% end %>
+        </div>
+      </div>
+      <table class="table table-striped table-bordered">
+        <thead>
+          <tr>
+            <th>Event Source</th>
+            <% month_name_array.each do |month| %>
+              <th><%= link_to month, monthly_details_events_path(owner_type: current_owner_type, event: current_event, month: month, year: current_year, time_interval: "month") %></th>
+            <% end %>
+          </tr>
+        </thead>
+        <tbody>
+          <% 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>