loglevel 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f7aa16f419c37f168c98409956cfa25b9cee845
-  data.tar.gz: 0ada2cc16ef1b3fa9527c438e26858d4dae83cea
+  metadata.gz: '029c298d5ce2f964647c947a95ef214d6e5d207e'
+  data.tar.gz: d5ea7fa65220d6a76e5ca9ed49f0526bcfc86747
 SHA512:
-  metadata.gz: dab91b3da3a07b99134fe9bec53ac2a2020d9edf37b7dcc1c94f0b254c90a4221aea2ea065545e19a4ec74b0b5e70775ff6071a090112d40358a418dfb941454
-  data.tar.gz: 0eff2e99f03b5d23abb3f65382996f5681fed4c53e5bad3e8514bcbc4bc0598eb1e29a996f7ab71f8a3f71580b96fde0c9be0c4cd9f68779d206bf9126517440
+  metadata.gz: 0fee1924b678abc449656572d8103141563cf35dde619e94ecd6e80ca17a885ca5775e5593d53c70a30408fd1aeba82824f50419540e828924353ce3c2ee1e67
+  data.tar.gz: c109086212ea09e5b46d188a1147c8492697d13f1b541e692597c2c634932822abad34d495c7e19777a4fab1b02e74e29c8673870c576730fd294a12c6fc4426

data/.rubocop.yml

@@ -1,6 +1,8 @@
 ---
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.2
   DisplayCopNames: true
   Exclude:
     - 'tmp/**/*'
@@ -19,21 +21,17 @@ StringLiterals:
   Enabled: true
 
 DotPosition:
-  Description: 'Checks the position of the dot in multi-line method calls.'
   EnforcedStyle: leading
   Enabled: true
 
 ClassAndModuleChildren:
-  Description: 'Checks style of children classes and modules.'
   EnforcedStyle: nested
   Enabled: true
 
 Documentation:
-  Description: 'Document classes and non-namespace modules.'
   Enabled: false
 
 FileName:
-  Description: 'Use snake_case for source file names.'
   Enabled: true
 
 LineLength:
@@ -41,11 +39,9 @@ LineLength:
   Enabled: true
 
 Style/ExtraSpacing:
-  Description: 'Do not use unnecessary spacing.'
   Enabled: true
 
 Lint/LiteralInInterpolation:
-  Description: 'Avoid interpolating literals in strings'
   AutoCorrect: true
 
 Style/ModuleFunction:

data/CHANGELOG.md

@@ -1,8 +1,58 @@
 # Change Log
 
-## [Unreleased](https://github.com/dominicsayers/loglevel/tree/HEAD)
+## [v1.0.1](https://github.com/dominicsayers/loglevel/tree/v1.0.1) (2017-05-03)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v1.0.0...v1.0.1)
 
-[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.1.1...HEAD)
+**Closed issues:**
+
+- Include the rubocop rspec gem and improve the code quality of the specs [\#5](https://github.com/dominicsayers/loglevel/issues/5)
+
+**Merged pull requests:**
+
+- Release v1.0.1 [\#6](https://github.com/dominicsayers/loglevel/pull/6) ([dominicsayers](https://github.com/dominicsayers))
+
+## [v1.0.0](https://github.com/dominicsayers/loglevel/tree/v1.0.0) (2017-04-12)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.6...v1.0.0)
+
+**Merged pull requests:**
+
+- Refactor to simplify class structure [\#3](https://github.com/dominicsayers/loglevel/pull/3) ([dominicsayers](https://github.com/dominicsayers))
+
+## [v0.4.6](https://github.com/dominicsayers/loglevel/tree/v0.4.6) (2017-04-11)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.5...v0.4.6)
+
+## [v0.4.5](https://github.com/dominicsayers/loglevel/tree/v0.4.5) (2017-04-10)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.4...v0.4.5)
+
+## [v0.4.4](https://github.com/dominicsayers/loglevel/tree/v0.4.4) (2017-04-10)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.2...v0.4.4)
+
+## [v0.4.2](https://github.com/dominicsayers/loglevel/tree/v0.4.2) (2017-04-10)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.1...v0.4.2)
+
+## [v0.4.1](https://github.com/dominicsayers/loglevel/tree/v0.4.1) (2017-04-10)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.4.0...v0.4.1)
+
+## [v0.4.0](https://github.com/dominicsayers/loglevel/tree/v0.4.0) (2017-04-10)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.3.0...v0.4.0)
+
+## [v0.3.0](https://github.com/dominicsayers/loglevel/tree/v0.3.0) (2017-04-05)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.2.4...v0.3.0)
+
+## [v0.2.4](https://github.com/dominicsayers/loglevel/tree/v0.2.4) (2017-04-01)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.2.3...v0.2.4)
+
+## [v0.2.3](https://github.com/dominicsayers/loglevel/tree/v0.2.3) (2017-03-31)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.2.2...v0.2.3)
+
+## [v0.2.2](https://github.com/dominicsayers/loglevel/tree/v0.2.2) (2017-03-31)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.2.1...v0.2.2)
+
+## [v0.2.1](https://github.com/dominicsayers/loglevel/tree/v0.2.1) (2017-03-31)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/dominicsayers/loglevel/tree/v0.2.0) (2017-03-31)
+[Full Changelog](https://github.com/dominicsayers/loglevel/compare/v0.1.1...v0.2.0)
 
 **Merged pull requests:**
 
@@ -18,4 +68,4 @@
 ## [v0.1.0](https://github.com/dominicsayers/loglevel/tree/v0.1.0) (2017-03-29)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -1,24 +1,23 @@
-# frozen_string_literal: true
-
 source 'https://rubygems.org'
 gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'bundler'
-  gem 'gem-release'
-  gem 'github_changelog_generator'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
+  gem 'bundler', require: false
+  gem 'gem-release', require: false
+  gem 'github_changelog_generator', require: false
+  gem 'guard', require: false
+  gem 'guard-rspec', require: false
+  gem 'guard-rubocop', require: false
+  gem 'guard-rubycritic', require: false
+  gem 'rubocop-rspec', require: false
 end
 
 group :test do
-  gem 'codeclimate-test-reporter'
-  gem 'coveralls'
-  gem 'fuubar'
-  gem 'rake' # Workaround for a bug in Rainbow 2.2.1 https://github.com/sickill/rainbow/issues/44
-  gem 'rspec'
-  gem 'rspec_junit_formatter'
-  gem 'simplecov'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'coveralls', require: false
+  gem 'fuubar', require: false
+  gem 'rspec', require: false
+  gem 'rspec_junit_formatter', require: false
+  gem 'simplecov', '~> 0.14', require: false
 end

data/Guardfile

@@ -1,10 +1,3 @@
-# frozen_string_literal: true
-
-guard :rubocop do
-  watch(/.+\.rb$/)
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-
 guard(
   :rspec,
   all_after_pass: true,
@@ -12,7 +5,17 @@ guard(
   cmd: 'NO_SIMPLECOV=true bundle exec rspec --fail-fast --format documentation'
 ) do
   watch(%r{spec/.+_spec\.rb$})
-  watch(%r{lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb') { 'spec' }
   watch(%r{^spec/support/.+\.rb$}) { 'spec' }
 end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rubycritic do
+  watch(%r{^app/(.+)\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+end

data/README.md

@@ -36,7 +36,6 @@ Here are the available settings:
 
 | Option    | Description                                 |
 | --------- | ------------------------------------------- |
-| HELP      | Show these options                          |
 | FATAL     | Equivalent to config.log_level = :fatal     |
 | ERROR     | Equivalent to config.log_level = :error     |
 | WARN      | Equivalent to config.log_level = :warn      |

data/lib/loglevel.rb

@@ -2,15 +2,17 @@ require 'loglevel/exception'
 require 'loglevel/constants'
 require 'loglevel/loggable_classes'
 
+# Sets up any loggable classes to the log level you specify in an environment
+# variable
 module Loglevel
   extend self
 
   def setup
-    loggable_classes.each(&:setup)
+    loggable_classes.each(&:check)
   end
 
   def debug
-    loggable_classes.map { |c| { name: c.class_name, logger: c.logger.class, level: c.level.level_name } }
+    loggable_classes.map(&:debug)
   end
 
   def device
@@ -20,10 +22,4 @@ module Loglevel
   def loggable_classes
     @loggable_classes ||= LoggableClasses.clone # More testable
   end
-
-  def name_to_class(class_name, exception_class)
-    Object.const_get(class_name)
-  rescue NameError => exception
-    Loglevel::Exception.handle_bad_class(class_name, exception, exception_class)
-  end
 end

data/lib/loglevel/constants.rb

@@ -1,6 +1,7 @@
+# :reek:TooManyConstants { max_constants: 7 }
 module Loglevel
   LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
-  LOGLEVELS.each_with_index { |k, v| const_set(k, v) }
+  LOGLEVELS.each_with_index { |key, value| const_set(key, value) }
 
   ENV_VAR_LEVEL   = 'LOGLEVEL'.freeze
   ENV_VAR_LOGGER  = 'LOGGER'.freeze

data/lib/loglevel/exception.rb

@@ -1,15 +1,16 @@
 module Loglevel
   # Local exception classes to make handling exceptions easier
   class Exception < RuntimeError
+    # We've been asked to setting up logging for an unknown class
     UnknownLoggableClass = Class.new(self)
+    # We can't instantiate the defined logger class
     UnknownLoggerClass = Class.new(self)
+    # The class we've been asked to set up logging for doesn't understand
+    # logging
     ClassNotLoggable = Class.new(self)
 
     def self.handle_bad_class(class_name, exception, exception_class)
-      raise exception unless  exception.class == NameError &&
-                              class_name.respond_to?(:split) &&
-                              exception.message =~ /.+constant.+#{class_name.split(Loglevel::SRO).first}/
-
+      raise exception unless exception.class == NameError && exception.message =~ /.+constant.+/
       raise exception_class, class_name
     end
   end

data/lib/loglevel/loggable_class.rb

@@ -2,15 +2,14 @@ require 'loglevel/loggable_class/level'
 require 'loglevel/loggable_class/smart_logger'
 
 module Loglevel
+  # An instance of a class that can be logged, i.e. has a #logger and a #logger=
+  # method
   class LoggableClass
     attr_reader :class_name, :logger
     alias to_s class_name
 
-    def setup
-      self.logger = smart_logger.create
-      logger.level = level.value
-      klass.logger = logger
-      additional_http_setup
+    def check
+      # No checks implemented yet
     end
 
     def level
@@ -25,18 +24,39 @@ module Loglevel
       @http ||= canonical_name == '::HttpLogger'
     end
 
+    def debug
+      { name: class_name, logger: logger.class, level: level.level_name }
+    end
+
     private
 
     attr_writer :logger
 
     def initialize(class_name)
       @class_name = class_name
-      raise Loglevel::Exception::ClassNotLoggable, class_name unless klass.respond_to?(:logger=)
+      http? ? http_setup : regular_setup
+    rescue NoMethodError => exception
+      raise unless exception.message =~ /undefined method `logger='/
+      raise Loglevel::Exception::ClassNotLoggable, class_name
     end
 
-    def additional_http_setup
-      return unless http?
+    # Setup for regular classes where we are setting the level of message we
+    # want to see
+    def regular_setup
+      self.logger = smart_logger
+      logger.level = level.value
+      klass.logger = logger
+    end
+
+    # Setup for HttpLogger. Here we are setting the level at which to log HTTP
+    # interactions
+    def http_setup
+      return unless http? && settings.http?
+      regular_setup
+      additional_http_setup
+    end
 
+    def additional_http_setup
       klass.level = level.level_name.downcase.to_sym
       klass.log_response_body = settings.response_body?
       klass.log_headers = settings.request_headers?
@@ -44,11 +64,13 @@ module Loglevel
     end
 
     def klass
-      @klass ||= Loglevel.name_to_class(canonical_name, Loglevel::Exception::UnknownLoggableClass)
+      @klass ||= canonical_name.to_class Loglevel::Exception::UnknownLoggableClass
     end
 
     def canonical_name
-      @canonical_name ||= class_name[0, 2] == Loglevel::SRO ? class_name : "#{Loglevel::SRO}#{class_name}"
+      @canonical_name ||= Loglevel::Name.new(
+        class_name[0, 2] == Loglevel::SRO ? class_name : "#{Loglevel::SRO}#{class_name}"
+      )
     end
 
     def settings
@@ -56,7 +78,7 @@ module Loglevel
     end
 
     def smart_logger
-      @smart_logger ||= SmartLogger.clone # More testable
+      @smart_logger ||= SmartLogger.clone.create # More testable
     end
   end
 end

data/lib/loglevel/loggable_class/level.rb

@@ -2,6 +2,7 @@ require 'loglevel/settings'
 
 module Loglevel
   class LoggableClass
+    # The current log level
     class Level
       def value
         @value ||= Loglevel.const_get level_name
@@ -15,9 +16,7 @@ module Loglevel
 
       extend Forwardable
 
-      def_delegators :loggable_class, :active_record?, :http?
-
-      attr_reader :loggable_class
+      def_delegators :@loggable_class, :active_record?, :http?
 
       def initialize(loggable_class, settings = nil)
         @loggable_class = loggable_class
@@ -25,11 +24,11 @@ module Loglevel
       end
 
       def http_level_name
-        @http_level_name ||= 'FATAL' if loggable_class.http? && !settings.http?
+        @http_level_name ||= 'DEBUG' if http? && !settings.http?
       end
 
       def active_record_level_name
-        @active_record_level_name ||= 'FATAL' if loggable_class.active_record? && !settings.active_record?
+        @active_record_level_name ||= 'FATAL' if active_record? && !settings.active_record?
       end
 
       def environment_level_name

data/lib/loglevel/loggable_class/smart_logger.rb

@@ -1,5 +1,6 @@
 module Loglevel
   class LoggableClass
+    # The most appropriate logging class for this environment
     class SmartLogger
       class << self
         def create
@@ -17,11 +18,11 @@ module Loglevel
         end
 
         def logger_class
-          @logger_class ||= loglevel.name_to_class(class_name, Loglevel::Exception::UnknownLoggerClass)
+          @logger_class ||= class_name.to_class Loglevel::Exception::UnknownLoggerClass
         end
 
         def class_name
-          @class_name ||= environment_class_name || rails_class_name || 'Logger'
+          @class_name ||= Loglevel::Name.new(environment_class_name || rails_class_name || 'Logger')
         end
 
         def environment_class_name

data/lib/loglevel/loggable_classes.rb

@@ -1,6 +1,9 @@
 require 'loglevel/loggable_class'
+require 'loglevel/name'
 
 module Loglevel
+  # An enumerable holding all classes that can be logged in the current
+  # environment
   module LoggableClasses
     class << self
       extend Forwardable

data/lib/loglevel/name.rb

@@ -0,0 +1,20 @@
+module Loglevel
+  # Like a string, but it can safely instantiate a class from itself
+  class Name
+    extend Forwardable
+
+    def_delegators :@string, :to_str, :==
+
+    def to_class(exception_class)
+      Object.const_get(self)
+    rescue NameError => exception
+      Loglevel::Exception.handle_bad_class(self, exception, exception_class)
+    end
+
+    private
+
+    def initialize(string)
+      @string = string
+    end
+  end
+end

data/lib/loglevel/settings.rb

@@ -1,4 +1,5 @@
 module Loglevel
+  # Parses the environment variable into usable settings
   module Settings
     extend self
 

data/lib/loglevel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loglevel
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loglevel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dominic Sayers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to control logging at runtime with an environment variable
 email:
@@ -17,12 +17,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .codeclimate.yml
-- .gitignore
-- .hound.yml
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -38,6 +38,7 @@ files:
 - lib/loglevel/loggable_class/level.rb
 - lib/loglevel/loggable_class/smart_logger.rb
 - lib/loglevel/loggable_classes.rb
+- lib/loglevel/name.rb
 - lib/loglevel/settings.rb
 - lib/loglevel/version.rb
 - loglevel.gemspec
@@ -52,12 +53,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []