best_boy 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df256db90741885d7f20f019b73c86e8f851fefd
-  data.tar.gz: ae53aea37dfaead5373d31a14281eeedfa59f34d
+  metadata.gz: d1ce44945739f534f6c56910503f9f0b408955d0
+  data.tar.gz: 39836bfe40b0ce0e2acf1aa3ae33221763b95ea6
 SHA512:
-  metadata.gz: 9ad46cda0b5953f853af5d3797932510d8f299c3e2b4cc035f24d0a9f1790da9d340c5a0cbfaa59fea3c70bf96ef185a6e9784825ef5bbc96d27707062aaa0ab
-  data.tar.gz: 1420badd4a1bac8e586d1ea7362af3fea44a18543c539dfc76ce766af58336fe72527e97a0ac55edc79260dcc318c6b1baee47165427d2f6fe3662f321a0de63
+  metadata.gz: b211c7f6f6b6cb1135415d5a50d3f4f674a7d4f96a7de9087cd994d04610455722eecab5b7a8ee9646959ac5ac7e87828eaff757b673000a0bdf6403985739c8
+  data.tar.gz: 45d8ece941242fdb99260083e9672b3dc45de514c0d7729e91e49124e81037c777d14c29d8a03fa68113400c2dbdd847811c7e5129d562cd8a88570d533dbdf7

data/README.md

@@ -3,6 +3,7 @@ best_boy
 [![Build Status](https://secure.travis-ci.org/Absolventa/best_boy.png?branch=master)](https://secure.travis-ci.org/Absolventa/best_boy)
 [![Dependency Status](https://gemnasium.com/Absolventa/best_boy.png)](https://gemnasium.com/Absolventa/best_boy)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Absolventa/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.
 
@@ -61,12 +62,14 @@ Run the migration
 
 Changelog
 ---------
+#### 2.2.1
+* flexibilized report creation method to create reports for a specific date
+
 #### 2.2.0
 * Updated dependencies for rspec and kaminari
 * Make recover_report_history rake task a noop for no previously tracked BestBoyEvents
-
-#### 2.1.4
 * Bugfix for report recovery rake task
+* use appraisal for testing against different gemsets and Ruby versions
 
 #### 2.1.3
 * Compatible with Rails 4.1

data/lib/best_boy/engine.rb

@@ -17,6 +17,7 @@ module BestBoy
     initializer 'best_boy.model' do |app|
       if BestBoy.orm == :active_record
         require "best_boy/models/active_record/best_boy/obeys_test_mode.rb"
+        require "best_boy/models/active_record/best_boy/reporting.rb"
         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"

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

@@ -2,6 +2,7 @@ module BestBoy
   class DayReport < ActiveRecord::Base
 
     include BestBoy::ObeysTestMode
+    include BestBoy::Reporting
 
     # db configuration
     #
@@ -33,37 +34,28 @@ module BestBoy
     #
     #
 
-    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
+    class << self
 
-    def self.create_for(owner, type, source = nil)
-      month_report = BestBoy::MonthReport.current_or_create_for(owner, type, source)
-      day_report   = BestBoy::DayReport.new
+      def create_for(owner, type, source = nil, date = Time.zone.now)
+        month_report = BestBoy::MonthReport.current_or_create_for(owner, type, source, date)
+        day_report   = BestBoy::DayReport.new
 
-      day_report.owner_type      = owner
-      day_report.event           = type
-      day_report.month_report_id = month_report.id
-      day_report.event_source    = source
+        day_report.owner_type      = owner
+        day_report.event           = type
+        day_report.month_report_id = month_report.id
+        day_report.event_source    = source
+        day_report.created_at      = date
 
-      day_report.save ? day_report : nil
-    end
+        day_report.save ? day_report : nil
+      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 daily_occurrences_for(owner, type, source = nil, date)
+        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)
+      def weekly_occurrences_for(owner, type, source = nil)
+        week.for(owner, type, source).sum(:occurrences)
+      end
     end
   end
 end

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

@@ -28,6 +28,11 @@ module BestBoy
       create_best_boy_event_with_type(type, source)
     end
 
+    def report(klass: self.class.to_s, type: '', source: nil, date: Time.zone.now)
+      BestBoy::MonthReport.current_or_create_for(klass, type, source, date).increment!(:occurrences)
+      BestBoy::DayReport.current_or_create_for(klass, type, source, date).increment!(:occurrences)
+    end
+
     private
 
     def trigger_create_event
@@ -40,7 +45,7 @@ module BestBoy
       create_best_boy_event_with_type "destroy"
     end
 
-    def create_best_boy_event_with_type type, source = nil
+    def create_best_boy_event_with_type(type, source = nil)
       raise "nil event is not allowed" if type.blank?
       best_boy_event = BestBoyEvent.new do |bbe|
         bbe.event        = type
@@ -48,25 +53,10 @@ module BestBoy
         bbe.owner        = self
       end
       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
+      report(type: type, source: source) if source.present?
+      report(type: type, source: nil)
     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/month_report.rb

@@ -2,6 +2,7 @@ module BestBoy
   class MonthReport < ActiveRecord::Base
 
     include BestBoy::ObeysTestMode
+    include BestBoy::Reporting
 
     # db configuration
     #
@@ -33,37 +34,29 @@ module BestBoy
     #
     #
 
-    def self.current_for(date, owner, type, source = nil)
-      self.for(owner, type, source).between(date.beginning_of_month, date)
-    end
+    class << self
 
-    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 create_for(owner, type, source = nil, date = Time.zone.now)
+        month_report              = BestBoy::MonthReport.new
+        month_report.owner_type   = owner.to_s
+        month_report.event        = type
+        month_report.event_source = source
+        month_report.created_at   = date || Time.zone.now
 
-    def self.create_for(owner, type, source = nil)
-      month_report = BestBoy::MonthReport.new
-      month_report.owner_type   = owner.to_s
-      month_report.event        = type
-      month_report.event_source = source
-      month_report.save ? month_report : nil
-    end
+        month_report.save ? month_report : nil
+      end
 
-    def self.for(owner, type, source = nil)
-      self.where(owner_type: owner, event: type, event_source: source)
-    end
+      def monthly_occurrences_for(owner, type, source = nil, date)
+        MonthReport.for(owner, type, source).between(date.beginning_of_month, date.end_of_month).sum(:occurrences)
+      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 yearly_occurrences_for(owner, type, source = nil, date)
+        MonthReport.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)
+      def overall_occurrences_for(owner, type, source = nil)
+        MonthReport.for(owner, type, source).sum(:occurrences)
+      end
     end
   end
 end

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

@@ -0,0 +1,25 @@
+module BestBoy
+  module Reporting
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+
+        def current_for(date, owner, type, source = nil)
+          self.for(owner, type, source).created_on(date)
+        end
+
+        def current_or_create_for(owner, type, source = nil, date = Time.zone.now)
+          report = current_for(date, owner, type, source).last
+          report.present? ? report : create_for(owner, type, source, date)
+        end
+
+        def for(owner, type, source = nil)
+          where(owner_type: owner, event: type, event_source: source)
+        end
+
+      end
+    end
+
+  end
+end

data/lib/best_boy/version.rb

@@ -1,3 +1,3 @@
 module BestBoy
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: best_boy
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
-- Christoph Seydel, Robin Neumann, Daniel Schoppmann
+- Christoph Seydel, Carsten Zimmermann, Robin Neumann, Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,7 +37,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.14.1
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.1
   type: :runtime
@@ -47,7 +47,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.14.1
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.1
 - !ruby/object:Gem::Dependency
@@ -106,6 +106,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +183,7 @@ files:
 - lib/best_boy/models/active_record/best_boy/eventable.rb
 - lib/best_boy/models/active_record/best_boy/month_report.rb
 - lib/best_boy/models/active_record/best_boy/obeys_test_mode.rb
+- lib/best_boy/models/active_record/best_boy/reporting.rb
 - lib/best_boy/models/active_record/best_boy_event.rb
 - lib/best_boy/version.rb
 - lib/generators/active_record/best_boy_generator.rb
@@ -203,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: a simple event driven logging for models