best_boy 1.3.0 → 2.0.0

data/spec/models/best_boy_event_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe BestBoyEvent, 'with creating' do
+  it "should have valid model" do
+    example = TestEvent.create
+    best_boy_event = BestBoyEvent.create(:event => "create")
+    best_boy_event.owner = example
+    best_boy_event.should be_valid
+  end
+end
+
+describe BestBoyEvent, 'with associations' do
+  it { should belong_to(:owner) }
+end
+
+describe BestBoyEvent, 'with validations' do
+  it "should require a event" do
+    BestBoyEvent.create(:event => "").should_not be_valid
+  end
+end

data/spec/models/day_report_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe BestBoy::DayReport do
+
+  let(:owner) { TestEvent.create }
+  let(:month_report) do
+    BestBoy::MonthReport.create({
+      owner_type: owner.class.to_param,
+      event:     "create"
+    })
+  end
+  let(:day_report) do
+     BestBoy::DayReport.create({
+      owner_type:  owner.class.to_param,
+      event:      "create",
+      month_report_id: month_report.to_param
+    })
+  end
+
+  subject { day_report }
+
+  context "with associations" do
+    it { expect(subject).to belong_to(:month_report) }
+  end
+
+  context "with validations" do
+    it "validates presence of attributes" do
+      expect(subject).to validate_presence_of(:month_report_id)
+      expect(subject).to validate_presence_of(:owner_type)
+      expect(subject).to validate_presence_of(:event)
+    end
+  end
+
+  context "with scopes" do
+    it "aggregates DayReports of specific day" do
+      collection = BestBoy::DayReport.order('created_at DESC')
+      expect(collection.created_on(Time.now)).to include(day_report)
+      expect(collection.created_on(1.day.ago)).to_not include(day_report)
+    end
+
+    it "aggregates DayReports of last week" do
+      Time.zone = "Berlin"
+
+      report_from_last_week = BestBoy::DayReport.create({owner_type: "TestEvent", event: "create"}).tap { |e| e.created_at = 8.days.ago; e.save }
+      report_from_this_week = BestBoy::DayReport.create({owner_type: "TestEvent", event: "create", month_report_id: month_report.id })
+
+      collection = BestBoy::DayReport.order('created_at DESC')
+      expect(collection.week).to include(report_from_this_week)
+      expect(collection.week).not_to include(report_from_last_week)
+    end
+
+  end
+
+  context "with class methods" do
+    describe "#current_for" do
+      context "when day_report exists" do
+        Time.zone = "Berlin"
+
+        existing_report      = BestBoy::DayReport.create_for("ExampleClass", "create")
+        existing_with_source = BestBoy::DayReport.create_for("ExampleClass", "create", "api")
+
+        demanded             = BestBoy::DayReport.current_for(Time.now, "ExampleClass", "create").last
+        demanded_with_source = BestBoy::DayReport.current_for(Time.now, "ExampleClass", "create", "api").last
+
+        it { expect(demanded).to be_eql existing_report }
+        it { expect(demanded_with_source).to be_eql existing_with_source }
+      end
+
+      context "when no today's day_report is present" do
+        it "delivers empty ActiceRecord::Relation" do
+          expect(BestBoy::DayReport.current_for(Time.now, "GibberishClass", "create")).to be_empty
+        end
+      end
+
+    end
+
+    describe "#current_or_create_for" do
+      context "when day_report exists" do
+        Time.zone = "Berlin"
+
+        owner               = TestEvent.create
+        existing_report      = BestBoy::DayReport.create_for(owner.class.to_s, "create")
+        existing_with_source = BestBoy::DayReport.create_for(owner.class.to_s, "create", "api")
+
+        demanded             = BestBoy::DayReport.current_or_create_for(owner.class.to_s, "create")
+        demanded_with_source = BestBoy::DayReport.current_or_create_for(owner.class.to_s, "create", "api")
+
+        it { expect(demanded).to be_eql existing_report }
+        it { expect(demanded_with_source).to be_eql existing_with_source }
+      end
+
+      context "when no today's day_report is present" do
+        it "creates a new month_report" do
+          BestBoy::DayReport.destroy_all
+          scope = BestBoy::DayReport.where(owner_type: TestEvent.to_s, event: "create")
+          expect{ BestBoy::DayReport.current_or_create_for(owner.class.to_s, "create") }.to change(scope.created_on(Time.now), :count).by(1)
+        end
+      end
+    end
+
+    describe "#create_for" do
+      owner          = TestEvent.create
+      report             = BestBoy::DayReport.create_for(owner.class.to_s, "create")
+      report_with_source = BestBoy::DayReport.create_for(owner.class.to_s, "create", "api")
+
+      it { expect(report).to be_valid }
+      it { expect(report.owner_type).to be_eql(owner.class.to_s) }
+      it { expect(report.event_source).to be_nil }
+
+      it { expect(report_with_source).to be_valid }
+      it { expect(report_with_source.owner_type).to be_eql(owner.class.to_s) }
+      it { expect(report_with_source.event_source).to be_eql("api") }
+    end
+  end
+end

data/spec/models/eventable_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe BestBoy::Eventable do
+  before(:each) do
+    @example = TestEvent.create
+  end
+
+  it "should send valid create event" do
+    best_boy_event = @example.best_boy_events.first.should_not be_nil
+  end
+
+  it "should send valid destroy event" do
+    @example.destroy
+    BestBoyEvent.where(:owner_type => "User", :event => "destroy").should_not be_nil
+  end
+
+  it "should be an eventable" do
+    @example.respond_to?("eventable?").should eql(true)
+  end
+
+  context "with reporting" do
+    let(:month_report) do
+      BestBoy::MonthReport.where(
+        owner_type: @example.class,
+        event: 'create'
+      ).first
+    end
+    let(:day_report) do
+      BestBoy::DayReport.where(
+        owner_type: @example.class,
+        event: 'create'
+      ).first
+    end
+    it "loads reports" do
+      expect(month_report).to be_present
+      expect(day_report).to be_present
+    end
+
+    it "increases occurrence counter when a new instance is created" do
+      BestBoy::MonthReport.any_instance.should_receive(:increment!).and_return(true)
+      BestBoy::DayReport.any_instance.should_receive(:increment!).and_return(true)
+      TestEvent.create
+    end
+
+    it "increases occurrence counter when an instance is destroyed" do
+      BestBoy::MonthReport.any_instance.should_receive(:increment!).and_return(true)
+      BestBoy::DayReport.any_instance.should_receive(:increment!).and_return(true)
+      TestEvent.first.destroy
+    end
+  end
+end

data/spec/models/month_report_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe BestBoy::MonthReport do
+
+  let(:owner) { TestEvent.create }
+  let(:month_report) do
+    BestBoy::MonthReport.create({
+      owner_type: owner.class.to_param,
+      event:     "create"
+    })
+  end
+
+  subject { month_report }
+
+  describe "with associations" do
+    it { expect(subject).to have_many(:day_reports) }
+  end
+
+  describe "with validations" do
+    it "validates presence of attributes" do
+      expect(subject).to validate_presence_of(:owner_type)
+      expect(subject).to validate_presence_of(:event)
+    end
+  end
+
+  context "with scopes" do
+    it "aggregates MonthReports of specific month" do
+      collection = BestBoy::MonthReport.order('created_at DESC')
+      expect(collection.between(Time.now.beginning_of_month, Time.now)).to include(month_report)
+      expect(collection.between(2.month.ago.beginning_of_month, 2.month.ago)).to_not include(month_report)
+    end
+
+    it "aggregates MonthReports of specific month period" do
+      report_from_first_month = BestBoy::MonthReport.create({owner_type: "TestEvent", event: "create"}).tap { |e| e.created_at = 2.month.ago; e.save }
+      report_from_last_month = BestBoy::MonthReport.create({owner_type: "TestEvent", event: "create"}).tap { |e| e.created_at = 1.month.ago }
+
+      collection = BestBoy::MonthReport.order('created_at DESC')
+      expect(collection.between(3.month.ago, Time.now)).to include(report_from_first_month)
+      expect(collection.between(3.month.ago, Time.now)).to include(report_from_last_month)
+      expect(collection.between(1.month.ago, Time.now)).to_not include(report_from_first_month)
+      expect(collection.between(3.month.ago, 2.month.ago)).to_not include(report_from_last_month)
+      expect(collection.between(6.month.ago, 4.month.ago)).to_not include(report_from_last_month)
+    end
+
+    it "aggregates MonthReports of specific day" do
+      collection = BestBoy::MonthReport.order('created_at DESC')
+      expect(collection.created_on(Time.now)).to include(month_report)
+      expect(collection.created_on(1.day.ago)).to_not include(month_report)
+    end
+  end
+
+  context "with class methods" do
+    describe "#current_for" do
+      context "when day_report exists" do
+        existing_report      = BestBoy::MonthReport.create_for("TestEventClass", "create")
+        existing_with_source = BestBoy::MonthReport.create_for("TestEventClass", "create", "api")
+
+        demanded             = BestBoy::MonthReport.current_for(Time.now, "TestEventClass", "create").last
+        demanded_with_source = BestBoy::MonthReport.current_for(Time.now, "TestEventClass", "create", "api").last
+
+        it { expect(demanded).to be_eql existing_report }
+        it { expect(demanded_with_source).to be_eql existing_with_source }
+      end
+
+      context "when no today's day_report is present" do
+        it "delivers empty ActiceRecord::Relation" do
+          expect(BestBoy::MonthReport.current_for(Time.now, "GibberishClass", "create")).to be_empty
+        end
+      end
+    end
+
+    describe "#current_or_create_for" do
+      context "when month_report exists" do
+        owner            = TestEvent.create
+        existing_report      = BestBoy::MonthReport.create_for(owner.class, "create")
+        existing_with_source = BestBoy::MonthReport.create_for(owner.class, "create", "api")
+
+        demanded              = BestBoy::MonthReport.current_or_create_for(owner.class, "create")
+        demanded_with_source  = BestBoy::MonthReport.current_or_create_for(owner.class, "create", "api")
+
+        it { expect(demanded).to eql existing_report }
+        it { expect(demanded_with_source).to eql existing_with_source }
+      end
+
+      context "when no month_report is present" do
+        it "creates a new month_report" do
+          BestBoy::MonthReport.destroy_all
+          scope = BestBoy::MonthReport.where(owner_type: TestEvent.to_s, event: "create")
+          expect(scope.between(Time.now.beginning_of_month, Time.now)).to be_empty
+          expect{ BestBoy::MonthReport.current_or_create_for(owner.class, "create") }.to change(scope.between(Time.now.beginning_of_month, Time.now), :count).by(1)
+        end
+      end
+    end
+
+    describe "#create_for" do
+      owner          = TestEvent.create
+      report             = BestBoy::MonthReport.create_for(owner.class, "create")
+      report_with_source = BestBoy::MonthReport.create_for(owner.class, "create", "api")
+
+      it { expect(report).to be_valid }
+      it { expect(report_with_source).to be_valid }
+
+      it { expect(report.owner_type).to be_eql(owner.class.to_s) }
+      it { expect(report_with_source.owner_type).to be_eql(owner.class.to_s) }
+
+      it { expect(report.event).to be_eql("create") }
+      it { expect(report_with_source.event).to be_eql("create") }
+
+      it { expect(report.event_source).to be_nil }
+      it { expect(report_with_source.event_source).to eql "api" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,51 +1,107 @@
-require 'rubygems'
-require 'bundler'
-require 'active_record'
-require 'active_support'
-require "best_boy/models/active_record/best_boy_event.rb"
-require "best_boy/models/active_record/best_boy/eventable.rb"
-require "best_boy/controllers/best_boy_controller.rb"
-require 'rspec'
-require 'rspec/autorun'
+# require 'rubygems'
+# require 'bundler'
+# require 'active_record'
+# require 'active_support'
+# 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"
+# require "best_boy/controllers/best_boy_controller.rb"
+# require 'rspec'
+# require 'rspec/autorun'
+# require 'shoulda'
+
+# root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+# ActiveRecord::Base.establish_connection(
+#   :adapter => "sqlite3",
+#   :database => "#{root}/db/bestboy.db"
+# )
+# ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'examples'")
+# ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'best_boy_events'")
+# ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'best_boy_day_reports'")
+# ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'best_boy_month_reports'")
+# ActiveRecord::Schema.define do
+#   self.verbose = false
+
+#   create_table :best_boy_events, :force => true do |t|
+#     t.integer :owner_id
+#     t.string :owner_type
+#     t.string :event
+#     t.string :event_source
+#     t.timestamps
+#   end
+#   add_index :best_boy_events, :owner_id
+#   add_index :best_boy_events, :owner_type
+#   add_index :best_boy_events, [:owner_id, :owner_type]
+#   add_index :best_boy_events, :event
+
+#   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
+#   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_day_reports, :created_at
+#   add_index :best_boy_month_reports, :created_at
+
+#   create_table :examples, :force => true do |t|
+#     t.timestamps
+#   end
+# end
+
+# ActiveRecord::Base.send(:include, BestBoy::Eventable)
+
+# RSpec.configure do |config|
+#   config.mock_with :rspec
+#   config.include BestBoyController::InstanceMethods
+# end
+
+# Rspec Setup for rails engines accoring to http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
 require 'shoulda'
 
-root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => "#{root}/db/bestboy.db"
-)
-ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'examples'")
-ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'best_boy_events'")
-ActiveRecord::Schema.define do
-  self.verbose = false
-
-  create_table :best_boy_events, :force => true do |t|
-    t.integer :owner_id
-    t.string :owner_type
-    t.string :event
-    t.string :event_source
-    t.timestamps
-  end
-  add_index :best_boy_events, :owner_id
-  add_index :best_boy_events, :owner_type
-  add_index :best_boy_events, [:owner_id, :owner_type]
-  add_index :best_boy_events, :event
-
-  create_table :examples, :force => true do |t|
-    t.timestamps
-  end
-end
+Rails.backtrace_cleaner.remove_silencers!
 
-ActiveRecord::Base.send(:include, BestBoy::Eventable)
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
   config.mock_with :rspec
-  config.include BestBoyController::InstanceMethods
-end
 
-class Dummy
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
 end
 
 class Example < ActiveRecord::Base
   has_a_best_boy
-end
+end