loglevel 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d42d88fe631ce356e355059ad3fbd73a5b653f8
-  data.tar.gz: 8d2d36d8d28f46c09ac78a64504f9fb0fd76c012
+  metadata.gz: 1bd8c2f39f120e520842eba218003ea8b70ae4e8
+  data.tar.gz: 7e36d867091c81a083582f5ccf0c61681406aebf
 SHA512:
-  metadata.gz: c83779e2323cfd93d9b24c15c402bbacbd63c6fd67ad267abaf734b7de947757c46a5e2664c251bc5b5376197e31e135cb18d46ffc357c64dc8782853d429d56
-  data.tar.gz: db73609a238674d3d3683d8618dfd141725125ca635bc20da3a67452e39218217505e8404aeccba5096b270803e14363adefd2713e66c664a111eb9826d8f660
+  metadata.gz: d041a8329f0bd72c8fff3d2d7463810222aedbeb806856fcf84b8a04b3aac9fe52a4d81cf494d9baf1db74a93d125a07029a93057df6388b5c15c1811e6791d9
+  data.tar.gz: 6b0ac0586984255775ea12f64bf834e4900c65d3ea26d3e1409bfc8f1270d85784abdbd54367e8ccfc1dfefe752572cdd8d13af0b145ae1d0f68daec210c597d

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- script/
+- spec/

data/CHANGELOG.md

@@ -2,7 +2,14 @@
 
 ## [Unreleased](https://github.com/dominicsayers/loglevel/tree/HEAD)
 
-[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.1.0...HEAD)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.1.1...HEAD)
+
+**Merged pull requests:**
+
+- Loglevel release [\#2](https://github.com/dominicsayers/loglevel/pull/2) ([dominicsayers](https://github.com/dominicsayers))
+
+## [v0.1.1](https://github.com/dominicsayers/loglevel/tree/v0.1.1) (2017-03-29)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.1.0...v0.1.1)
 
 **Merged pull requests:**
 

data/README.md

@@ -3,8 +3,8 @@
 [![Gem version](https://badge.fury.io/rb/loglevel.svg)](https://rubygems.org/gems/loglevel)
 [![Gem downloads](https://img.shields.io/gem/dt/loglevel.svg)](https://rubygems.org/gems/loglevel)
 [![Build Status](https://travis-ci.org/dominicsayers/loglevel.svg?branch=master)](https://travis-ci.org/dominicsayers/loglevel)
-[![Code quality](http://img.shields.io/codeclimate/github/dominicsayers/loglevel.svg?style=flat)](https://codeclimate.com/github/dominicsayers/loglevel)
-[![Coverage Status](https://coveralls.io/repos/github/dominicsayers/loglevel/badge.svg?branch=master)](https://coveralls.io/github/dominicsayers/loglevel?branch=master)
+[![Code Climate](https://codeclimate.com/github/dominicsayers/loglevel/badges/gpa.svg)](https://codeclimate.com/github/dominicsayers/loglevel)
+[![Test Coverage](https://codeclimate.com/github/dominicsayers/loglevel/badges/coverage.svg)](https://codeclimate.com/github/dominicsayers/loglevel/coverage)
 [![Dependency Status](https://gemnasium.com/badges/github.com/dominicsayers/loglevel.svg)](https://gemnasium.com/github.com/dominicsayers/loglevel)
 [![Security](https://hakiri.io/github/dominicsayers/loglevel/master.svg)](https://hakiri.io/github/dominicsayers/loglevel/master)
 

data/lib/loglevel.rb

@@ -3,88 +3,102 @@ require 'loglevel/active_record'
 require 'loglevel/http_logger'
 require 'loglevel/help'
 
-module Loglevel
+class Loglevel
   ENV_VAR_LEVEL   = 'LOGLEVEL'.freeze
   ENV_VAR_LOGGER  = 'LOGLEVEL_LOGGER'.freeze
   ENV_VAR_DEVICE  = 'LOGLEVEL_DEVICE'.freeze
   ENV_VAR_CLASSES = 'LOGLEVEL_CLASSES'.freeze
-  LOG_LEVELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
+  LOGLEVELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
 
   class << self
-    attr_reader :classes
-    attr_writer :logger
-
     def setup
-      return unless ENV[ENV_VAR_LEVEL]
+      new
+    end
+  end
 
-      @classes = Loglevel::Classes.new.classes
-      @settings = nil
-      @logger = nil
-      @log_level = nil
+  attr_reader :classes
+  attr_writer :logger
 
-      setup_active_record
-      setup_http_logger
-      setup_remaining_classes
+  def logger
+    @logger ||= logger_class.new device
+  end
 
-      help if help?
-    end
+  def level
+    @level ||= logger_class.const_get level_name
+  end
 
-    def logger
-      @logger ||= logger_class.new log_device
-    end
+  private
 
-    def log_level
-      @log_level ||= logger_class.const_get log_level_name
-    end
+  def initialize
+    return unless ENV[ENV_VAR_LEVEL]
 
-    private
+    @classes = Loglevel::Classes.new.classes
+    @settings = nil
+    @logger = nil
+    @level = nil
 
-    include Loglevel::ActiveRecord
-    include Loglevel::HttpLogger
-    include Loglevel::Help
+    setup_classes
+    announce
+  end
 
-    # Setup any other classes (e.g. Rails)
-    def setup_remaining_classes
-      classes.each do |klass|
-        klass.logger = logger
-        klass.logger.level = log_level
-      end
-    end
+  def setup_classes
+    @classes_to_setup = @classes.dup
+    setup_active_record
+    setup_http_logger
+    setup_remaining_classes
+  end
 
-    def log_level_name
-      (LOG_LEVELS & settings).first || 'INFO'
+  # Setup any other classes (e.g. Rails)
+  def setup_remaining_classes
+    @classes_to_setup.each do |klass|
+      klass.logger = logger
+      klass.logger.level = level
     end
+  end
 
-    def logger_class
-      Object.const_get ENV.fetch(ENV_VAR_LOGGER, 'Logger')
-    end
+  def announce
+    help if help?
+    puts inspect if level_name == 'DEBUG'
+    puts debug if lookup('__DEBUG')
+  end
 
-    def log_device
-      %w(STDOUT STDERR).include?(log_device_name) ? Object.const_get(log_device_name) : log_device_name
-    end
+  def level_name
+    (LOGLEVELS & settings).first || 'INFO'
+  end
 
-    def log_device_name
-      ENV.fetch(ENV_VAR_DEVICE, 'STDOUT')
-    end
+  def logger_class
+    Object.const_get ENV.fetch(ENV_VAR_LOGGER, 'Logger')
+  end
 
-    # Implementing as a method in case someone wants to detect the OS and make
-    # an OS-dependent null device
-    def null_device
-      @null_device ||= '/dev/null'
-    end
+  def device
+    %w(STDOUT STDERR).include?(device_name) ? Object.const_get(device_name) : device_name
+  end
 
-    def null_logger
-      @null_logger ||= logger_class.new null_device
-    end
+  def device_name
+    ENV.fetch(ENV_VAR_DEVICE, 'STDOUT')
+  end
 
-    def settings
-      @settings ||= ENV.fetch(ENV_VAR_LEVEL, '').upcase.split(',')
-    end
+  # Implementing as a method in case someone wants to detect the OS and make
+  # an OS-dependent null device
+  def null_device
+    @null_device ||= '/dev/null'
+  end
 
-    def lookup(setting)
-      settings.include?(setting)
-    end
+  def null_logger
+    @null_logger ||= logger_class.new null_device
+  end
+
+  def lookup(setting)
+    settings.include?(setting)
   end
+
+  def settings
+    @settings ||= ENV.fetch(ENV_VAR_LEVEL, '').upcase.split(',')
+  end
+
+  include Loglevel::ActiveRecord
+  include Loglevel::HttpLogger
+  include Loglevel::Help
 end
 
 Loglevel.setup

data/lib/loglevel/active_record.rb

@@ -1,18 +1,20 @@
 # ActiveRecord-specific settings
-module Loglevel
+class Loglevel
   module ActiveRecord
+    private
+
     def active_record?
       !lookup('NOAR')
     end
 
     def setup_active_record
-      return unless defined?(::ActiveRecord::Base) && classes.delete(::ActiveRecord::Base)
+      return unless defined?(::ActiveRecord::Base) && @classes_to_setup.delete(::ActiveRecord::Base)
       active_record? ? setup_active_record_logger_to_log : setup_active_record_logger_not_to_log
     end
 
     def setup_active_record_logger_to_log
       ::ActiveRecord::Base.logger = logger
-      ::ActiveRecord::Base.logger.level = log_level
+      ::ActiveRecord::Base.logger.level = level
     end
 
     def setup_active_record_logger_not_to_log

data/lib/loglevel/classes.rb

@@ -1,4 +1,4 @@
-module Loglevel
+class Loglevel
   class Classes
     attr_reader :classes
 

data/lib/loglevel/help.rb

@@ -1,10 +1,6 @@
 # Help
-module Loglevel
+class Loglevel
   module Help
-    def help?
-      lookup('HELP') || settings == ['TRUE']
-    end
-
     def help
       logger.info <<-HELP.gsub('        ', '')
         Usage: DEBUG=SETTING,SETTING,SETTING rails server
@@ -24,5 +20,27 @@ module Loglevel
         HTTP messages will only be shown if http_logger gem is present
       HELP
     end
+
+    def inspect
+      "#<#{self.class}: logger=#{logger_class}, device=#{device_name}, level=#{level_name}, settings=#{settings}>"
+    end
+
+    def debug
+      debug = classes.map do |klass|
+        l = klass.logger
+        d = l.instance_variable_get('@logdev')
+        f = d.filename || d.dev || 'nil'
+        v = self.class::LOGLEVELS[l.level]
+        "#{klass}: logger=#{l.class}, device=#{f}, level=#{v}"
+      end
+
+      debug.join("\n")
+    end
+
+    private
+
+    def help?
+      lookup('HELP') || settings == ['TRUE']
+    end
   end
 end

data/lib/loglevel/http_logger.rb

@@ -1,6 +1,8 @@
 # HttpLogger-specific settings
-module Loglevel
+class Loglevel
   module HttpLogger
+    private
+
     def http?
       !lookup('NOHTTP')
     end
@@ -14,13 +16,13 @@ module Loglevel
     end
 
     def setup_http_logger
-      return unless defined?(::HttpLogger) && classes.delete(::HttpLogger)
+      return unless defined?(::HttpLogger) && @classes_to_setup.delete(::HttpLogger)
       http? ? setup_http_logger_to_log : setup_http_logger_not_to_log
     end
 
     def setup_http_logger_to_log
       ::HttpLogger.logger = logger
-      ::HttpLogger.level = log_level_name.downcase.to_sym
+      ::HttpLogger.level = level_name.downcase.to_sym
       ::HttpLogger.log_response_body = response_body?
       ::HttpLogger.log_headers = request_headers?
       ::HttpLogger.ignore = [/9200/, /7474/] # ignore Elasticsearch & Neo4J

data/lib/loglevel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Loglevel
-  VERSION = '0.1.1'.freeze
+class Loglevel
+  VERSION = '0.2.1'.freeze
 end

data/script/console

@@ -1,2 +1,2 @@
 #!/bin/sh
-bundle exec irb -rubygems -I lib -r loglevel.rb
+bundle exec irb -rubygems -I lib -r logger.rb -r loglevel.rb

data/spec/loglevel/active_record_spec.rb

@@ -29,16 +29,15 @@ RSpec.describe Loglevel::ActiveRecord do
   end
 
   context 'NOAR' do
-    before do
-      ENV.store Loglevel::ENV_VAR_LEVEL, 'noAR' # the capitalization is intentional
-      Loglevel.setup
-    end
+    let(:loglevel) { Loglevel.setup }
 
+    before { ENV.store Loglevel::ENV_VAR_LEVEL, 'noAR' } # the capitalization is intentional
     after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
     it 'has the expected ActiveRecord settings' do
-      expect(::ActiveRecord::Base.logger).to eq Loglevel.send(:null_logger)
-      expect(::ActiveRecord::Base.logger.level).to eq Logger.const_get('FATAL')
+      loglevel # force instantiation
+      expect(::ActiveRecord::Base.logger).to eq loglevel.send(:null_logger)
+      expect(::ActiveRecord::Base.logger.level).to eq ::Logger.const_get('FATAL')
     end
   end
 end

data/spec/loglevel/help_spec.rb

@@ -1,27 +1,78 @@
 RSpec.describe Loglevel::Help do
   context 'HELP' do
     before do
+      class MyLogDevice
+        attr_reader :filename, :dev
+
+        def initialize(device)
+          @dev = device
+        end
+      end
+
       class MyLogger
         INFO = 1
         attr_accessor :level
 
-        def initialize(device); end
+        def initialize(device)
+          @logdev = MyLogDevice.new(device)
+        end
 
         def info(message); end
       end
 
       ENV.store Loglevel::ENV_VAR_LOGGER, 'MyLogger'
+      ENV.store Loglevel::ENV_VAR_DEVICE, 'MyDevice'
       ENV.store Loglevel::ENV_VAR_LEVEL, 'Help' # the capitalization is intentional
     end
 
     after do
       ENV.delete Loglevel::ENV_VAR_LOGGER
+      ENV.delete Loglevel::ENV_VAR_DEVICE
       ENV.delete Loglevel::ENV_VAR_LEVEL
+      Object.send(:remove_const, :MyLogger)
+      Object.send(:remove_const, :MyLogDevice)
     end
 
     it 'has the expected ActiveRecord settings' do
       expect_any_instance_of(MyLogger).to receive(:info).once
       Loglevel.setup
     end
+
+    it 'shows information about itself' do
+      expect(Loglevel.setup.inspect).to eq(
+        '#<Loglevel: logger=MyLogger, device=MyDevice, level=INFO, settings=["HELP"]>'
+      )
+    end
+
+    it 'shows debugging information about itself' do
+      class MyClass
+        class << self
+          attr_accessor :logger
+        end
+      end
+
+      class Rails < MyClass; end
+
+      module ActiveRecord
+        class Base < Rails; end
+      end
+
+      class HttpLogger < Rails
+        class << self
+          attr_accessor :level, :log_response_body, :log_headers, :ignore
+        end
+      end
+
+      expect(Loglevel.setup.debug).to eq <<-DEBUG.gsub('        ', '').chomp
+        Rails: logger=MyLogger, device=MyDevice, level=INFO
+        ActiveRecord::Base: logger=MyLogger, device=MyDevice, level=INFO
+        HttpLogger: logger=MyLogger, device=MyDevice, level=INFO
+      DEBUG
+
+      Object.send(:remove_const, :MyClass)
+      Object.send(:remove_const, :Rails)
+      Object.send(:remove_const, :ActiveRecord)
+      Object.send(:remove_const, :HttpLogger)
+    end
   end
 end

data/spec/loglevel/http_logger_spec.rb

@@ -29,15 +29,14 @@ RSpec.describe Loglevel::HttpLogger do
   end
 
   context 'NOHTTP' do
-    before do
-      ENV.store Loglevel::ENV_VAR_LEVEL, 'noHttp' # the capitalization is intentional
-      Loglevel.setup
-    end
+    let(:loglevel) { Loglevel.setup }
 
+    before { ENV.store Loglevel::ENV_VAR_LEVEL, 'NoHttp' } # the capitalization is intentional
     after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
     it 'has the expected HttpLogger settings' do
-      expect(::HttpLogger.logger).to eq Loglevel.send(:null_logger)
+      loglevel # force instantiation
+      expect(::HttpLogger.logger).to eq loglevel.send(:null_logger)
       expect(::HttpLogger.level).to eq :fatal
     end
   end

data/spec/loglevel_spec.rb

@@ -29,14 +29,14 @@ RSpec.describe Loglevel do
   end
 
   context 'no environment variable' do
-    before { Loglevel.setup }
+    let(:loglevel) { Loglevel.setup }
 
     it 'has the expected logger class' do
-      expect(Loglevel.send(:logger_class)).to eq Loglevel.send(:logger_class)
+      expect(loglevel.send(:logger_class)).to eq ::Logger
     end
 
     it 'has the expected device' do
-      expect(Loglevel.send(:log_device)).to eq STDOUT
+      expect(loglevel.send(:device)).to eq STDOUT
     end
 
     it 'has the expected log level' do
@@ -56,32 +56,33 @@ RSpec.describe Loglevel do
   end
 
   context 'defaults' do
-    before do
-      ENV.store Loglevel::ENV_VAR_LEVEL, 'INFO'
-      Loglevel.setup
-    end
+    let(:loglevel) { Loglevel.setup }
 
+    before { ENV.store Loglevel::ENV_VAR_LEVEL, 'INFO' }
     after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
     it 'has the expected logger class' do
-      expect(Loglevel.send(:logger_class)).to eq ::Logger
+      expect(loglevel.send(:logger_class)).to eq ::Logger
     end
 
     it 'has the expected device' do
-      expect(Loglevel.send(:log_device)).to eq STDOUT
+      expect(loglevel.send(:device)).to eq STDOUT
     end
 
     it 'has the expected log level' do
-      expect(Rails.logger).to eq Loglevel.logger
-      expect(Rails.logger.level).to eq Logger.const_get('INFO')
+      loglevel # force instantiation
+      expect(Rails.logger).to eq loglevel.logger
+      expect(Rails.logger.level).to eq ::Logger.const_get('INFO')
     end
 
     it 'has the expected ActiveRecord::Base settings' do
-      expect(::ActiveRecord::Base.logger).to eq Loglevel.logger
-      expect(::ActiveRecord::Base.logger.level).to eq Logger.const_get('INFO')
+      loglevel # force instantiation
+      expect(::ActiveRecord::Base.logger).to eq loglevel.logger
+      expect(::ActiveRecord::Base.logger.level).to eq ::Logger.const_get('INFO')
     end
 
     it 'has the expected HttpLogger settings' do
+      loglevel # force instantiation
       expect(::HttpLogger.level).to eq :info
       expect(::HttpLogger.log_response_body).to be_truthy
       expect(::HttpLogger.log_headers).to be_truthy
@@ -111,44 +112,39 @@ RSpec.describe Loglevel do
     end
 
     context 'HTTP and ActiveRecord' do
-      before do
-        ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN'
-        Loglevel.setup
-      end
+      let(:loglevel) { Loglevel.setup }
 
-      after do
-        ENV.delete Loglevel::ENV_VAR_LEVEL
-      end
+      before { ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN' }
+      after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
       it 'has the expected logger class' do
-        expect(Loglevel.send(:logger_class)).to eq ::MyLogger
+        expect(loglevel.send(:logger_class)).to eq ::MyLogger
       end
 
       it 'has the expected device' do
-        expect(Loglevel.send(:log_device)).to eq STDERR
+        expect(loglevel.send(:device)).to eq STDERR
       end
 
       it 'has the expected log level' do
-        expect(Rails.logger).to eq Loglevel.logger
-        expect(Rails.logger.level).to eq Logger.const_get('WARN')
+        loglevel # force instantiation
+        expect(Rails.logger).to eq loglevel.logger
+        expect(Rails.logger.level).to eq ::Logger.const_get('WARN')
       end
     end
 
     context 'HTTP but not ActiveRecord' do
-      before do
-        ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN,NOBODY,NOHEADERS,NOAR'
-        Loglevel.setup
-      end
+      let(:loglevel) { Loglevel.setup }
 
-      after do
-        ENV.delete Loglevel::ENV_VAR_LEVEL
-      end
+      before { ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN,NOBODY,NOHEADERS,NOAR' }
+      after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
       it 'has the expected ActiveRecord::Base settings' do
-        expect(::ActiveRecord::Base.logger).to eq Loglevel.send(:null_logger)
+        loglevel # force instantiation
+        expect(::ActiveRecord::Base.logger).to eq loglevel.send(:null_logger)
       end
 
       it 'has the expected HttpLogger settings' do
+        loglevel # force instantiation
         expect(::HttpLogger.level).to eq :warn
         expect(::HttpLogger.log_response_body).to be_falsey
         expect(::HttpLogger.log_headers).to be_falsey
@@ -157,21 +153,19 @@ RSpec.describe Loglevel do
     end
 
     context 'ActiveRecord but not HTTP' do
-      before do
-        ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN,NOHTTP'
-        Loglevel.setup
-      end
+      let(:loglevel) { Loglevel.setup }
 
-      after do
-        ENV.delete Loglevel::ENV_VAR_LEVEL
-      end
+      before { ENV.store Loglevel::ENV_VAR_LEVEL, 'WARN,NOHTTP' }
+      after { ENV.delete Loglevel::ENV_VAR_LEVEL }
 
       it 'has the expected ActiveRecord::Base settings' do
-        expect(::ActiveRecord::Base.logger).to eq Loglevel.logger
-        expect(::ActiveRecord::Base.logger.level).to eq Logger.const_get('WARN')
+        loglevel # force instantiation
+        expect(::ActiveRecord::Base.logger).to eq loglevel.logger
+        expect(::ActiveRecord::Base.logger.level).to eq ::Logger.const_get('WARN')
       end
 
       it 'has the expected HttpLogger settings' do
+        loglevel # force instantiation
         expect(::HttpLogger.level).to eq :fatal
         expect(::HttpLogger.log_response_body).to be_falsey
         expect(::HttpLogger.log_headers).to be_falsey

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loglevel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Dominic Sayers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to interact with Mailchimp through their API v3
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .codeclimate.yml
 - .gitignore
 - .hound.yml
 - .rspec
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: 'Example: mailchimp.lists("My first list").member("ann@example.com")'