log_switch 0.4.0 → 1.1.0

data/log_switch.gemspec

@@ -1,37 +1,38 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'log_switch/version'
 
 Gem::Specification.new do |s|
-  s.name = "log_switch"
+  s.name = 'log_switch'
   s.version = LogSwitch::VERSION
-  s.authors = ["Steve Loveless"]
-  s.homepage = %q(http://github.com/turboladen/log_switch)
-  s.email = %w(steve.loveless@gmail.com)
-  s.summary = %q(Extends a class for singleton style logging that can easily be
-                 turned on and off.)
-  s.description = %q(Extends a class for singleton style logging that can 
-                     easily be turned on and off.)
-
-  s.required_rubygems_version = ">=1.8.0"
-  s.files = Dir.glob("{lib,spec}/**/*") +
-    Dir.glob("*.rdoc") +
-    %w(.gemtest Gemfile log_switch.gemspec Rakefile)
-
-  s.test_files = Dir.glob("{spec}/**/*")
-  s.require_paths = %w(lib)
-
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", ">= 2.6.0"
-
-  if RUBY_VERSION > '1.9'
-    s.add_development_dependency "simplecov"
-
-    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
-      s.add_development_dependency("tailor", ">=1.1.2")
-    end
-  end
-
-  s.add_development_dependency "yard", ">= 0.7.2"
+  s.authors = ['Steve Loveless']
+  s.homepage = 'https://github.com/turboladen/log_switch'
+  s.email = %w[steve.loveless@gmail.com]
+  s.summary = 'Extends a class for singleton style logging that can easily be
+                 turned on and off.'
+  s.description = 'Extends a class for singleton style logging that can
+                     easily be turned on and off.'
+
+  s.license = 'Unlicense'
+  s.required_ruby_version = '>= 3.3'
+
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/turboladen/log_switch',
+    'changelog_uri' => "https://github.com/turboladen/log_switch/blob/v#{LogSwitch::VERSION}/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.files = Dir.glob('{lib,spec}/**/*') +
+            %w[CHANGELOG.md Gemfile LICENSE README.md log_switch.gemspec Rakefile]
+
+  s.require_paths = %w[lib]
+
+  s.add_dependency 'logger', '~> 1.5'
+
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.13'
+  s.add_development_dependency 'rubocop', '~> 1.88'
+  s.add_development_dependency 'simplecov', '~> 1.0'
+  s.add_development_dependency 'yard', '~> 0.9'
 end
-

data/spec/log_switch_spec.rb

@@ -1,121 +1,131 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
 
-describe Kernel do
-  def self.get_requires
-    Dir[File.dirname(__FILE__) + '/../lib/log_switch/**/*.rb']
-  end
+require 'spec_helper'
 
-  # Try to require each of the files in LogSwitch
-  get_requires.each do |r|
-    it "should require #{r}" do
+class IncluderClass; include LogSwitch; end
 
-      # A require returns true if it was required, false if it had already been
-      # required, and nil if it couldn't require.
-      Kernel.require(r.to_s).should_not be_nil
+describe LogSwitch do
+  before { LogSwitch.reset_config! }
+  specify { expect(LogSwitch::VERSION).to eq '1.1.0' }
+
+  describe 'base class methods' do
+    describe '.included' do
+      it 'sets @includers on the class object that extended' do
+        expect(described_class.instance_variable_get(:@includers))
+          .to include(IncluderClass)
+      end
     end
-  end
-end
 
-describe LogSwitch do
-  around :each do |example|
-    class MyClass; extend LogSwitch; end;
-    example.run
-    MyClass.reset_config!
+    describe '.logger' do
+      it 'is a Logger by default' do
+        expect(described_class.logger).to be_a Logger
+      end
+    end
   end
 
-  it { LogSwitch::VERSION.should == '0.4.0' }
+  describe IncluderClass do
+    subject { IncluderClass.new }
 
-  describe ".extend_object" do
-    it "sets @extender on the class object that extended" do
-      LogSwitch.instance_variable_get(:@extender).should == MyClass
+    describe '.logging_enabled?' do
+      specify { expect(described_class).to respond_to(:logging_enabled?) }
+
+      it 'defaults to false' do
+        expect(described_class.logging_enabled?).to eq false
+      end
+
+      it 'can be set to true' do
+        described_class.logging_enabled = true
+        expect(described_class).to be_logging_enabled
+      end
     end
-  end
 
-  describe ".extender" do
-    it "returns LogSwitch's @extender" do
-      LogSwitch.extender.should == LogSwitch.instance_variable_get(:@extender)
+    describe '.logger' do
+      it 'is a Logger by default' do
+        expect(described_class.logger).to be_a Logger
+      end
     end
-  end
 
-  describe ".log" do
-    it "can log at any log level" do
-      logger = double "Logger"
-      logger.should_receive(:send).with(:meow, "stuff")
-      MyClass.logger = logger
-      MyClass.log("stuff", :meow)
+    describe '.default_log_level' do
+      it 'defaults to :debug' do
+        expect(described_class.default_log_level).to eq :debug
+      end
     end
 
-    it "raises when log_level isn't a Symbol" do
-      expect { MyClass.log("stuff", "meow") }.to raise_error NoMethodError
+    describe '.log_class_name?' do
+      specify { expect(described_class).to respond_to(:log_class_name?) }
     end
 
-    it "can take a block" do
-      object = Object.new
-      object.stub :test_in_block
-      object.should_receive(:test_in_block)
+    describe '.log_class_name' do
+      specify { expect(described_class).to respond_to(:log_class_name) }
 
-      MyClass.log('hi') { object.test_in_block }
+      it 'defaults to true' do
+        expect(described_class.log_class_name).to eq true
+      end
 
-      object.unstub :test_in_block
+      it 'can be set to false' do
+        pending "Can't figure out why this doesn't pass. It works live..."
+        described_class.log_class_name = false
+        expect(described_class.log_class_name).to eq false
+      end
     end
 
-    context "with .before" do
-      it "calls the @before_block if that's set" do
-        MyClass.before { puts "This is also before" }
-        MyClass.instance_variable_get(:@before_block).should_receive(:call).once
-        MyClass.log 'hi'
+    describe '.before_log' do
+      it 'assigns the given block to @before_block' do
+        described_class.before_log = proc { "I'm a block" }
+        expect(described_class.before_log).to be_a Proc
       end
     end
 
-    context "can log non-String objects" do
-      it "an Array of various object types" do
-        array = [1, 'stuff', { :two => 2 }]
-        MyClass.logger.should_receive(:send).with(:debug, array)
-        expect { MyClass.log array }.to_not raise_exception
+    describe '#log' do
+      let(:logger) do
+        double 'Logger'
       end
 
-      it "an Exception" do
-        ex = StandardError.new("Test error.")
-        MyClass.logger.should_receive(:send).with(:debug, ex)
-        expect { MyClass.log ex }.to_not raise_exception
+      let(:object) do
+        o = Object.new
+        allow(o).to receive :test_in_block
+        o
       end
-    end
-  end
 
-  describe ".log?" do
-    specify { MyClass.log?.should be_true }
+      # before do
+      #   described_class.logger = logger
+      # end
 
-    specify {
-      MyClass.log = false
-      MyClass.log?.should be_false
-    }
-  end
+      it 'can log at any log level' do
+        # expect(logger).to receive(:send).with(:meow, "<IncluderClass> stuff")
+        subject.log('stuff', :meow)
+      end
 
-  describe ".logger" do
-    it "is a Logger by default" do
-      MyClass.logger.should be_a Logger
-    end
-  end
+      it 'can take a block' do
+        allow(logger).to receive(:send).with(:debug, '<IncluderClass> hi')
+        expect(object).to receive(:test_in_block)
+        subject.log('hi') { object.test_in_block }
+      end
 
-  describe ".log_level" do
-    it "defaults to :debug" do
-      MyClass.log_level.should == :debug
-    end
-  end
+      context 'with .before_log' do
+        it "calls the @before_block if that's set" do
+          allow(logger).to receive(:send).with(:debug, '<IncluderClass> hi')
+          described_class.before_log = proc { puts 'This is also before' }
+          expect(described_class.before_log).to receive(:call).once
+          subject.log 'hi'
+        end
+      end
 
-  describe ".before" do
-    it "assigns the given block to @before_block" do
-      MyClass.before { "I'm a block" }
-      MyClass.instance_variable_get(:@before_block).should be_a Proc
+      context 'can log non-String objects' do
+        it 'an Array of various object types' do
+          array = [1, 'stuff', { two: 2 }]
+          message = "<IncluderClass> #{array}"
+          allow(logger).to receive(:send).with(:debug, message)
+          expect { subject.log array }.to_not raise_exception
+        end
+
+        it 'an Exception' do
+          ex = StandardError.new('Test error.')
+          message = "<IncluderClass> #{ex.message}"
+          allow(logger).to receive(:send).with(:debug, message)
+          expect { subject.log ex }.to_not raise_exception
+        end
+      end
     end
   end
-
-  describe ".log_class_name?" do
-    specify { MyClass.log_class_name?.should be_false }
-
-    specify {
-      MyClass.log_class_name = true
-      MyClass.log_class_name?.should be_true
-    }
-  end
 end

data/spec/spec_helper.rb

@@ -1,18 +1,10 @@
-if RUBY_VERSION > '1.9'
-  require 'simplecov'
+# frozen_string_literal: true
 
-  class SimpleCov::Formatter::MergedFormatter
-    def format(result)
-      SimpleCov::Formatter::HTMLFormatter.new.format(result)
-    end
-  end
+require 'simplecov'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
-
-  SimpleCov.start do
-    add_filter "/spec"
-  end
+SimpleCov.start do
+  skip '/spec'
 end
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
 require 'log_switch'