best_boy 0.0.3 → 0.1.0

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+/db

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.0
+
+* added backend
+* added dependency kaminari for backend pagination
+* extended specs
+
 ## 0.0.3
 
 * added rspec tests

data/README.md

@@ -27,6 +27,20 @@ Generate the BestBoyEvent table migration
 
     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
+
+See usage section for version information.
+
 Run the migration
 
     rake db:migrate
@@ -46,6 +60,7 @@ In controller context:
     best_boy_event object, event
 
 This will log custom events for a object and a event phrase.
+
 If no Object is given, it will raise an exception as well as if no event is provided.
 
 
@@ -61,7 +76,26 @@ BestBoyEvent table
 Getting BestBoyEvents
 ---------------------
 
-The table is namespaced, so you can access for statistics maybe with BestBoy::BestBoyEvent.where...
+BestBoy comes with an admin interface, largely configurable to fit right into your existing application.
+
+Following configurations can be done:
+
+    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.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
+
+
+Used gems and resource
+----------------------
+[Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4
+
+[Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style
 
 Thanks
 ------

data/app/controllers/best_boy/best_boy_events_controller.rb

@@ -0,0 +1,65 @@
+module BestBoy
+  class BestBoyEventsController < BestBoy.base_controller.constantize
+
+    before_filter BestBoy.before_filter if BestBoy.before_filter.present?
+    skip_before_filter BestBoy.skip_before_filter if BestBoy.skip_before_filter.present?
+
+    layout 'best_boy_backend'
+
+    helper_method :available_owner_types, :available_events, :available_years, :current_owner_type, :current_event, :current_year, :collection, :statistics, :stats_by_event_and_month
+
+    private
+
+    def current_owner_type
+      @current_owner_type ||= available_owner_types.include?(params[:owner_type]) ? params[:owner_type] : available_owner_types.first
+    end
+
+    def current_event
+      @current_event ||= available_events.include?(params[:event]) ? params[:event] : nil
+    end
+
+    def current_date
+      @current_date ||= Date.strptime(params[:date], "%d-%m-%Y") if params[:date] rescue nil
+    end
+
+    def current_year
+      @current_year ||= available_years.include?(params[:year]) ? params[:year] : Time.zone.now.year
+    end
+
+    def available_owner_types
+      @available_owner_types ||= BestBoyEvent.select("DISTINCT best_boy_events.owner_type").order("best_boy_events.owner_type ASC").map(&:owner_type)
+    end
+
+    def available_events
+      @available_events ||= BestBoyEvent.where("best_boy_events.owner_type = ?", current_owner_type).select("best_boy_events.event").order("best_boy_events.event ASC").group("best_boy_events.event").map(&:event)
+    end
+
+    def available_years
+      @available_years = (BestBoyEvent.order("best_boy_events.created_at ASC").first.created_at.to_date.year..Time.zone.now.year).map{ |year| year.to_s } rescue [Time.zone.now.year]
+    end
+
+    def collection
+      @best_boy_events ||= (
+        scope = BestBoyEvent.where("best_boy_events.owner_type = ?", current_owner_type)
+        scope = scope.where("best_boy_events.event = ?", current_event) if current_event.present?
+        scope = scope.per_day(current_date) if current_date.present?
+        scope = scope.order("best_boy_events.created_at DESC, best_boy_events.event ASC")
+        scope.page(params[:page]).per(50)
+      )
+    end
+
+    def statistics
+      @statistics = Array.new
+      available_events.each do |event|
+        scope = BestBoyEvent.where("best_boy_events.owner_type = ? AND best_boy_events.event = ?", current_owner_type, event)
+        @statistics.push([event, scope.count] + %w(year month week day).map{ |delimiter| scope.send("per_#{delimiter}", Time.zone.now).count })
+      end
+      @statistics
+    end
+
+    def stats_by_event_and_month event, month
+      date = "1-#{month}-#{current_year}".to_time
+      BestBoyEvent.where("best_boy_events.owner_type = ? AND best_boy_events.event = ?", current_owner_type, event).per_month(date).count
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<div class="span12">
+  <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, (referrer == "stats") ? best_boy_admin_stats_path(:owner_type => owner_type) : best_boy_admin_lists_path(:owner_type => owner_type) %>
+      </li>
+    <% end %>
+  </ul>
+</div>

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

@@ -0,0 +1,6 @@
+<div class="span12">
+  <div class="hero-unit">
+    <h2>BestBoy Administation Center</h1>
+    <p>BestBoy provides several statistics and logs for you. You can access yearly, monthly, weekly and day statistics for your logged events per owner class. In the list and logs section you can see realtime events and search for date and events for each owner class.</p>
+  </div>
+</div>

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

@@ -0,0 +1,43 @@
+<%= render "navigation", :referrer => "lists" %>
+<% content_for :stylesheets do %>
+  <%= stylesheet_link_tag "bootstrap_datepicker" %>
+<% end %>
+<% content_for :javascripts do %>
+  <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" %>
+  <%= javascript_include_tag "bootstrap_datepicker" %>
+  <script type="text/javascript">
+    $(function(){$('#dp1').datepicker().on('changeDate', function(){$('#list-form').submit();})});
+  </script>
+<% end %>
+
+<div class="span12">
+  <div class="well">
+    <h3 class="pull-left">Log</h3>
+    <div class="pull-right">
+      <%= form_tag best_boy_admin_lists_path, :method => :get, :id => "list-form" do %>
+        <div class="input-append date pull-left span3" id="dp1" data-date="<%= params[:date].present? ? params[:date] : l(Time.zone.now, :format => "%d-%m-%Y") %>" data-date-format="dd-mm-yyyy">
+          <input name="date" class="span2" size="16" type="text" value="<%= params[:date] %>" readonly="readonly">
+          <span class="add-on"><i class="icon-th"></i></span>
+        </div>
+        <%= select_tag :event, options_for_select([["all Events", nil]] + available_events, :selected => current_event), :onchange => "submit();", :class => "span4" %>
+      <% end %>
+    </div>
+    <table class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Event</th>
+          <th>created_at</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% collection.each do |best_boy_event| %>
+          <tr>
+            <td><%= best_boy_event.event %></td>
+            <td><%= best_boy_event.created_at %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+    <%= paginate collection %>
+  </div>
+</div>

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

@@ -0,0 +1,60 @@
+<%= render "navigation", :referrer => "stats" %>
+
+<div class="span12">
+  <div class="well">
+    <h3>Statistics</h3>
+    <table class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Event</th>
+          <th>overall</th>
+          <th>year</th>
+          <th>month</th>
+          <th>week</th>
+          <th>day</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% statistics.each do |best_boy_event| %>
+          <tr>
+            <% (0..5).each do |key| %>
+              <td><%= best_boy_event[key] %></td>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<div class="span12">
+  <div class="well">
+    <h3 class="pull-left">Statistics for <%= current_year %> per month</h3>
+    
+    <div class="pull-right">
+      <%= form_tag best_boy_admin_stats_path, :method => :get do %>
+        <%= select_tag :year, options_for_select(available_years, :selected => current_year), :onchange => "submit();" %>
+      <% end %>
+    </div>
+    <table class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Event</th>
+          <% %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec).each do |month| %>
+            <th><%= month %></th>
+          <% end %>
+        </tr>
+      </thead>
+      <tbody>
+        <% available_events.each do |event| %>
+          <tr>
+            <td><%= event %></td>
+            <% %w(1 2 3 4 5 6 7 8 9 10 11 12).each do |month| %>
+              <td><%= stats_by_event_and_month event, month %></td>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/app/views/layouts/best_boy_backend.html.erb

@@ -0,0 +1,62 @@
+<!doctype html>
+<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7" lang="en"> <![endif]-->
+<!--[if IE 7]>    <html class="no-js lt-ie9 lt-ie8" lang="en"> <![endif]-->
+<!--[if IE 8]>    <html class="no-js lt-ie9" lang="en"> <![endif]-->
+<!-- Consider adding a manifest.appcache: h5bp.com/d/Offline -->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
+  <head>
+    <meta charset="utf-8">
+    <meta content='IE=edge,chrome=1' http-equiv='X-UA-Compatible'>
+    <meta name="description" content="">
+    <meta name="viewport" content="width=device-width">
+    <title>BBAC - BestBoy Administration Center</title>
+    <%= csrf_meta_tag %>
+    <%= stylesheet_link_tag("bootstrap", :media => "all") %>
+    <%= yield :stylesheets %>
+    <%= yield :javascripts %>
+    <style>
+      /* FIX for kaminari gem */
+      nav.pagination {
+        text-align: center;
+      }
+        span.current, 
+        span.gap a {
+          float: left;
+          padding: 0 9px;
+          line-height: 34px;
+          text-decoration: none;
+          border: 1px solid #DDD;
+          border-left-width: 0;
+        }
+        span.current {
+          border: 1px solid #DDD;
+          color: #999;
+          cursor: default;
+          background-color: whiteSmoke;
+        }
+    </style>
+  </head>
+  <body style="padding-top: 60px;">
+    <div class="navbar navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <%= link_to "BBAC", best_boy_admin_path, :class => "brand" %>
+          <ul class="nav">
+            <li><%= link_to "Statistics", best_boy_admin_stats_path %></li>
+            <li><%= link_to "List & Logs", best_boy_admin_lists_path %></li>
+          </ul>
+          <% if BestBoy.custom_redirect.present? %>
+            <p class="navbar-text pull-right"><%= link_to("back", Rails.application.routes.recognize_path(BestBoy.custom_redirect)) %></p>
+          <% end %>
+        </div>
+      </div>
+    </div>
+
+    <div class="container">
+      <div class="row">
+        <%= yield %>
+      </div>
+    </div>
+    <%= yield :javascripts %>
+  </body>
+</html>

data/best_boy.gemspec

@@ -16,12 +16,15 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "best_boy"
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_development_dependency("bundler", ">= 1.0.0")
-  s.add_development_dependency('activerecord', '>= 3.0.0')
-  s.add_development_dependency('activesupport', '>= 3.0.0')
-  s.add_development_dependency('sqlite3', '>= 1.3.4')
-  s.add_development_dependency("rake")  
-  s.add_development_dependency("rspec")
+  s.add_dependency('kaminari')
+
+  s.add_development_dependency('bundler', '~> 1.1.0')
+  s.add_development_dependency('activerecord')
+  s.add_development_dependency('activesupport')
+  s.add_development_dependency('sqlite3', '~> 1.3.6')
+  s.add_development_dependency('rake', '~> 0.9.2.2')  
+  s.add_development_dependency('rspec', '~> 2.10.0')
+  s.add_development_dependency('shoulda', '~> 3.0.1')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do |map|
+  get "best_boy_admin" => "best_boy/best_boy_events#index", :as => :best_boy_admin
+  get "best_boy_admin/stats" => "best_boy/best_boy_events#stats", :as => :best_boy_admin_stats
+  get "best_boy_admin/lists" => "best_boy/best_boy_events#lists", :as => :best_boy_admin_lists
+end

data/lib/best_boy.rb

@@ -2,8 +2,12 @@ require "best_boy/engine.rb"
 
 module BestBoy
   # Define ORM
-  mattr_accessor :orm
+  mattr_accessor :orm, :base_controller, :before_filter, :skip_before_filter, :custom_redirect
   @@orm = :active_record
+  @@base_controller = "ApplicationController"
+  @@before_filter = nil
+  @@skip_before_filter = nil
+  @@custom_redirect = nil
 
   # Load configuration from initializer
   def self.setup

data/{app → lib/best_boy}/controllers/best_boy_controller.rb

@@ -12,4 +12,4 @@ module BestBoyController
       end
     end
   end
-end
+end

data/lib/best_boy/engine.rb

@@ -3,8 +3,8 @@ require "rails"
 
 module BestBoy
   class Engine < Rails::Engine
+
     initializer 'best_boy.model' do |app|
-      require "#{root}/app/models/best_boy/eventable.rb"
       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"
@@ -15,9 +15,11 @@ module BestBoy
     end
 
     initializer 'best_boy.controller' do
+      require "best_boy/controllers/best_boy_controller.rb"
       ActiveSupport.on_load(:action_controller) do
         include BestBoyController::InstanceMethods
       end
     end
+
   end
 end

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

@@ -2,6 +2,10 @@ module BestBoy
   module Eventable
     extend ActiveSupport::Concern
 
+    def eventable?
+      true
+    end
+
     module ClassMethods
       def has_a_best_boy
         # meta programming

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

@@ -1,4 +1,5 @@
 class BestBoyEvent < ActiveRecord::Base
+  
   # associations
   #
   #
@@ -9,9 +10,18 @@ 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) }
+
   # attributes
   #
   #
-  attr_accessible :owner_id, :owner_type, :event
+  attr_accessible :owner_id, :owner_type, :event, :updated_at, :created_at
   
 end

data/lib/best_boy/version.rb

@@ -1,3 +1,3 @@
 module BestBoy
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/generators/best_boy_generator.rb

@@ -6,6 +6,12 @@ module BestBoy
 
       def copy_config_file
         template 'best_boy.rb', 'config/initializers/best_boy.rb'
+        template 'bootstrap/glyphicons-halflings-white.png', 'public/images/bootstrap/glyphicons-halflings-white.png'
+        template 'bootstrap/glyphicons-halflings.png', 'public/images/bootstrap/glyphicons-halflings.png'
+        template 'bootstrap/bootstrap.css', 'public/stylesheets/bootstrap.css'
+        #datepicker by Stefan Petre (http://www.eyecon.ro/bootstrap-datepicker)
+        template 'bootstrap/bootstrap_datepicker.css', 'public/stylesheets/bootstrap_datepicker.css' 
+        template 'bootstrap/bootstrap_datepicker.js', 'public/javascripts/bootstrap_datepicker.js'
       end
     end
   end