raygun4ruby 3.0.0 → 3.2.3.pre

data/spec/rails_helper.rb

@@ -0,0 +1,4 @@
+ENV['RAILS_ENV'] ||= 'test'
+require 'dummy/config/environment'
+
+require 'rspec/rails'

data/{specs → spec}/raygun/breadcrumbs/breadcrumb_spec.rb

@@ -1,4 +1,4 @@
-require_relative "../../spec_helper"
+require "spec_helper"
 
 module Raygun
   module Breadcrumbs
@@ -10,7 +10,7 @@ module Raygun
 
           subject.message = message
 
-          subject.message.must_equal(message)
+          expect(subject.message).to eq(message)
         end
 
         it 'has a category' do
@@ -18,7 +18,7 @@ module Raygun
 
           subject.category = category
 
-          subject.category.must_equal(category)
+          expect(subject.category).to eq(category)
         end
 
         it 'has a level' do
@@ -26,7 +26,7 @@ module Raygun
 
           subject.level = level
 
-          subject.level.must_equal(level)
+          expect(subject.level).to eq(level)
         end
 
         it 'has a timestamp' do
@@ -34,7 +34,7 @@ module Raygun
 
           subject.timestamp = timestamp
 
-          subject.timestamp.must_equal(timestamp)
+          expect(subject.timestamp).to eq(timestamp)
         end
 
         it 'has metadata' do
@@ -42,7 +42,7 @@ module Raygun
 
           subject.metadata = metadata
 
-          subject.metadata.must_equal(metadata)
+          expect(subject.metadata).to eq(metadata)
         end
 
         it 'has a class_name' do
@@ -50,7 +50,7 @@ module Raygun
 
           subject.class_name = class_name
 
-          subject.class_name.must_equal(class_name)
+          expect(subject.class_name).to eq(class_name)
         end
 
         it 'has a method_name' do
@@ -58,7 +58,7 @@ module Raygun
 
           subject.method_name = method_name
 
-          subject.method_name.must_equal(method_name)
+          expect(subject.method_name).to eq(method_name)
         end
 
         it 'has a line_number' do
@@ -66,7 +66,7 @@ module Raygun
 
           subject.line_number = line_number
 
-          subject.line_number.must_equal(line_number)
+          expect(subject.line_number).to eq(line_number)
         end
       end
 
@@ -98,35 +98,72 @@ module Raygun
         let(:payload) { breadcrumb.build_payload }
 
         it "joins the class name, method name and line number together" do
-          payload[:location].must_equal("HomeController:index:17")
+          expect(payload[:location]).to eq("HomeController:index:17")
         end
 
         it "does not include the method name and line number if the class name is missing" do
           breadcrumb.class_name = nil
 
-          payload.has_key?(:location).must_equal(false)
+          expect(payload.has_key?(:location)).to eq(false)
         end
 
         it "does not inlcude the line number if is it missing" do
           breadcrumb.line_number = nil
 
-          payload[:location].must_equal("HomeController:index")
+          expect(payload[:location]).to eq("HomeController:index")
         end
 
         it "does not include keys in payload with nil values" do
           breadcrumb.metadata = nil
           breadcrumb.category = nil
 
-          payload.key?(:CustomData).must_equal(false)
-          payload.key?(:category).must_equal(false)
+          expect(payload.key?(:CustomData)).to eq(false)
+          expect(payload.key?(:category)).to eq(false)
         end
 
         it 'includes the rest of the fields' do
-          payload[:message].must_equal('test')
-          payload[:category].must_equal('test')
-          payload[:level].must_equal(1)
-          payload[:timestamp].wont_be_nil
-          payload[:CustomData].must_equal(foo: 'bar')
+          expect(payload[:message]).to eq('test')
+          expect(payload[:category]).to eq('test')
+          expect(payload[:level]).to eq(1)
+          expect(payload[:timestamp]).to_not eq(nil)
+          expect(payload[:CustomData]).to eq(foo: 'bar')
+        end
+      end
+
+      describe "#size" do
+        before do
+          Timecop.freeze
+          Store.initialize
+        end
+        after do
+          Timecop.return
+          Store.clear
+        end
+
+        let(:message) { "This is a breadcrumb message" }
+
+        let(:breadcrumb) do
+          Store.record(
+            message: message,
+            category: "test",
+            level: :info,
+            class_name: "HomeController",
+            method_name: "index",
+            line_number: 17,
+            metadata: {
+              foo: 'bar'
+            }
+          )
+
+          Store.stored[0]
+        end
+
+        let(:size) { breadcrumb.size }
+
+        it "returns the estimated size of the breadcrumb" do
+          # Can't check all the fields but message so assume a standard 100 length for all of them
+          # The message should be the bulk of large breadcrumbs anyway
+          expect(size).to eq(message.length + 100)
         end
       end
     end

data/{specs → spec}/raygun/breadcrumbs/store_spec.rb

@@ -1,6 +1,4 @@
-require "minitest/autorun"
-require "minitest/pride"
-require_relative "../../spec_helper"
+require "spec_helper"
 
 module Raygun
   module Breadcrumbs
@@ -10,39 +8,39 @@ module Raygun
 
       describe "#initialize" do
         before do
-          subject.stored.must_equal(nil)
+          expect(subject.stored).to eq(nil)
 
           subject.initialize
         end
 
         it "creates the store on the current Thread" do
-          subject.stored.must_equal([])
+          expect(subject.stored).to eq([])
         end
 
         it "does not effect other threads" do
           Thread.new do
-            subject.stored.must_equal(nil)
+            expect(subject.stored).to eq(nil)
           end.join
         end
       end
 
-      describe "any?" do
+      describe "#any?" do
         it "returns true if any breadcrumbs have been logged" do
           subject.initialize
 
           subject.record(message: "test")
 
-          subject.any?.must_equal(true)
+          expect(subject.any?).to eq(true)
         end
 
         it "returns false if none have been logged" do
           subject.initialize
 
-          subject.any?.must_equal(false)
+          expect(subject.any?).to eq(false)
         end
 
         it "returns false if the store is uninitialized" do
-          subject.any?.must_equal(false)
+          expect(subject.any?).to eq(false)
         end
       end
 
@@ -54,18 +52,42 @@ module Raygun
         it "resets the store back to nil" do
           subject.clear
 
-          subject.stored.must_equal(nil)
+          expect(subject.stored).to eq(nil)
         end
       end
 
       describe "#should_record?" do
         it "returns false when the log level is above the breadcrumbs level" do
-          Raygun.configuration.stubs(:breadcrumb_level).returns(:error)
+          allow(Raygun.configuration).to receive(:breadcrumb_level).and_return(:error)
 
           crumb = Breadcrumb.new
           crumb.level = :warning
 
-          assert_equal false, subject.send(:should_record?, crumb)
+          expect(subject.send(:should_record?, crumb)).to eq(false)
+        end
+      end
+
+      describe "#take_until_size" do
+        before do
+          subject.initialize
+        end
+
+        it "takes the most recent breadcrumbs until the size limit is reached" do
+          subject.record(message: '1' * 100)
+          subject.record(message: '2' * 100)
+          subject.record(message: '3' * 100)
+
+          crumbs = subject.take_until_size(500)
+
+          expect(crumbs.length).to eq(2)
+          expect(crumbs[0].message).to eq('2' * 100)
+          expect(crumbs[1].message).to eq('3' * 100)
+        end
+
+        it "does not crash with no recorded breadcrumbs" do
+          crumbs = subject.take_until_size(500)
+
+          expect(crumbs).to eq([])
         end
       end
 
@@ -86,28 +108,28 @@ module Raygun
         it "gets stored" do
           subject.record(message: "test")
 
-          subject.stored.length.must_equal(1)
-          subject.stored[0].message.must_equal("test")
+          expect(subject.stored.length).to eq(1)
+          expect(subject.stored[0].message).to eq("test")
         end
 
         it "automatically sets the class name" do
           Foo.new.bar
 
           bc = subject.stored[0]
-          bc.class_name.must_equal("Raygun::Breadcrumbs::Foo")
+          expect(bc.class_name).to eq("Raygun::Breadcrumbs::Foo")
         end
 
         it "automatically sets the method name" do
           Foo.new.bar
 
           bc = subject.stored[0]
-          bc.method_name.must_equal("bar")
+          expect(bc.method_name).to eq("bar")
         end
 
         it "does not set the method name if it is already set" do
           subject.record(message: 'test', method_name: "foo")
 
-          subject.stored[0].method_name.must_equal("foo")
+          expect(subject.stored[0].method_name).to eq("foo")
         end
 
 
@@ -116,7 +138,7 @@ module Raygun
             Foo.new.bar
 
             bc = subject.stored[0]
-            bc.timestamp.must_equal(Time.now.utc.to_i)
+            expect(bc.timestamp).to eq(Time.now.utc.to_i)
           end
         end
 
@@ -126,21 +148,21 @@ module Raygun
           Timecop.freeze do
             subject.record(message: 'test', timestamp: time)
 
-            subject.stored[0].timestamp.wont_equal(Time.now.utc)
+            expect(subject.stored[0].timestamp).to_not eq(Time.now.utc)
           end
         end
 
         it "sets the log level to :info if one is not supplied" do
           Foo.new.bar
 
-          subject.stored[0].level.must_equal(:info)
+          expect(subject.stored[0].level).to eq(:info)
         end
 
         it "does not record the breadcrumb if should_record? is false" do
-          subject.stubs(:should_record?).returns(false)
+          expect(subject).to receive(:should_record?).and_return(false)
           Foo.new.bar
 
-          subject.stored.length.must_equal(0)
+          expect(subject.stored.length).to eq(0)
         end
       end
     end

data/{specs → spec}/raygun/raygun_spec.rb

@@ -1,5 +1,4 @@
-require_relative '../spec_helper'
-require 'stringio'
+require 'spec_helper'
 
 describe Raygun do
   let(:failsafe_logger) { FakeLogger.new }
@@ -8,6 +7,7 @@ describe Raygun do
     context 'send in background' do
       before do
         Raygun.setup do |c|
+          c.silence_reporting = false
           c.send_in_background = true
           c.api_url = 'http://example.api'
           c.api_key = 'foo'
@@ -28,23 +28,20 @@ describe Raygun do
 
           # Occasionally doesn't write to the failsafe logger, add small timeout to add some safety
           sleep 0.1
-          failsafe_logger.get.must_match /Problem reporting exception to Raygun/
+          expect(failsafe_logger.get).to match /Problem reporting exception to Raygun/
         end
       end
     end
   end
 
   describe '#reset_configuration' do
+    subject { Raygun.reset_configuration }
     it 'clears any customized configuration options' do
       Raygun.setup do |c|
         c.api_url = 'http://test.api'
       end
 
-      Raygun.configuration.api_url.must_equal 'http://test.api'
-
-      Raygun.reset_configuration
-
-      Raygun.configuration.api_url.must_equal Raygun.default_configuration.api_url
+      expect { subject }.to change { Raygun.configuration.api_url }.from('http://test.api').to(Raygun.default_configuration.api_url)
     end
   end
 end

data/{specs → spec}/services/apply_whitelist_filter_to_payload_spec.rb

@@ -1,4 +1,4 @@
-require_relative "../spec_helper"
+require "spec_helper"
 
 module Raygun
   module Services
@@ -20,7 +20,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
 
         it "filters out keys that are set to false" do
@@ -31,7 +31,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
       end
 
@@ -61,7 +61,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
 
         it "filters out a nested hash if the whitelist does not contain it" do
@@ -72,7 +72,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
 
         it "handles nested hashes when the whitelist is set to allow the whole hash" do
@@ -89,7 +89,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
 
         it "handles nested hashes when the whitelist is set to not allow the whole hash" do
@@ -104,7 +104,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
       end
 
@@ -124,7 +124,7 @@ module Raygun
 
           new_payload = service.call(shape, payload)
 
-          new_payload.must_equal(expected)
+          expect(new_payload).to eq(expected)
         end
       end
 
@@ -244,7 +244,7 @@ module Raygun
 
         new_payload = service.call(shape, payload)
 
-        new_payload.must_equal(expected)
+        expect(new_payload).to eq(expected)
       end
     end
   end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+#require 'rubygems'
+
+require 'timecop'
+require 'webmock/rspec'
+
+# Coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'support/fake_logger'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  # config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  # config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end