warnings_logger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4212c6b04c9e279f94862a0f2f4b91c32f673edb8496243cd1827b8f288a3317
-  data.tar.gz: 8497994515a8223fa011f24801f63a485af6af2ba011f2b5d18c2ab50b20ed89
+  metadata.gz: 529052ada7a035ccb7a33a4cd72242645341d81fa40b2d6b6f68557f956e26bc
+  data.tar.gz: d6f27ae8d65273e4de47830c604f2074e225fa615ecdf2e4306b31297c750e6d
 SHA512:
-  metadata.gz: 58243246de25954f2bc8febee114b3a07189fed4ef8abc19249f445fbf851b2bf658c8c1d2e077f7314010ccabf3037064095d7d00642e378bee2eb9153cd3c6
-  data.tar.gz: 2e42de94cc388528cb3f20e374accf6ade750443b29793e2c24fc68c97e479848b37c6a4618fdc0843ad485c9f495212442ca3befdf090df6a732d36fb7dea65
+  metadata.gz: 2573cad3bcc255ba50262f721a110450f6884115fb11029a6752805df94d1302facb7156d6385195fa8f7eac516573e67838a3e690bac7deae5a84d8c2d2574e
+  data.tar.gz: 0a4df5f4bf66b422c4793d96ee2f55baf0c00f4e20026e5c6d64c192689ef449b89b681557cd7e3bdaa7c6f736a821a6a13c9da484e57f57aff4fe82e596d526

data/.gitignore

@@ -1,11 +1,10 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
+spec/examples.txt

data/.rubocop.yml

@@ -2,20 +2,23 @@
 AllCops:
   Exclude:
     - db/schema.rb
+  NewCops: enable
   TargetRubyVersion: 2.5
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 Layout/ClassStructure:
   Enabled: true
+Layout/CommentIndentation:
+  Enabled: false
 Layout/DotPosition:
-  EnforcedStyle: trailing
+  EnforcedStyle: leading
 Layout/InitialIndentation:
   Enabled: false
-Layout/IndentArray:
-  EnforcedStyle: "consistent"
-Layout/IndentHash:
-  EnforcedStyle: "consistent"
-Layout/IndentHeredoc:
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/HeredocIndentation:
   Enabled: false
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
@@ -23,11 +26,13 @@ Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 Layout/SpaceInLambdaLiteral:
   Enabled: false
+Layout/SpaceInsideRangeLiteral:
+  Enabled: false
 Layout/SpaceInsideStringInterpolation:
   Enabled: false
 Lint/AssignmentInCondition:
   Enabled: false
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 Lint/RequireParentheses:
   Enabled: false
@@ -35,17 +40,24 @@ Metrics/AbcSize:
   Max: 32
 Metrics/BlockLength:
   ExcludedMethods:
-    - describe
     - context
+    - define
+    - describe
     - it
-    - colored
+    - shared_context
+    - shared_examples
+    - shared_examples_for
 Metrics/ClassLength:
   Enabled: false
-Metrics/LineLength:
+Metrics/CyclomaticComplexity:
+  Max: 15
+Layout/LineLength:
   Max: 80
   IgnoredPatterns:
-    - "^\\s*describe"
+    - "^\\s*RSpec.describe"
+    - "^\\s*class [\\w:]+ < [\\w:]+"
     - "^\\s*context"
+    - "^\\s*describe"
     - "^\\s*it"
 Metrics/MethodLength:
   Enabled: false
@@ -53,25 +65,39 @@ Metrics/ModuleLength:
   Enabled: false
 Metrics/ParameterLists:
   CountKeywordArgs: false
+Metrics/PerceivedComplexity:
+  Max: 15
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/BinaryOperatorParameterName:
+  Enabled: false
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 Naming/PredicateName:
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
     - is_
   Exclude:
     - spec/**/*
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
+  Enabled: false
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+Style/AccessModifierDeclarations:
   Enabled: false
 Style/Alias:
   Enabled: false
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+Style/CaseEquality:
+  Enabled: false
 Style/CollectionMethods:
   Enabled: true
 Style/Documentation:
   Enabled: false
 Style/EachWithObject:
   Enabled: false
+Style/EmptyElse:
+  Enabled: false
 Style/EmptyMethod:
   EnforcedStyle: expanded
 Style/FormatString:
@@ -94,6 +120,8 @@ Style/NegatedIf:
   Enabled: false
 Style/NegatedWhile:
   Enabled: false
+Style/NumericPredicate:
+  Enabled: false
 Style/OneLineConditional:
   Enabled: false
 Style/PercentLiteralDelimiters:
@@ -102,6 +130,8 @@ Style/PreferredHashMethods:
   Enabled: false
 Style/RaiseArgs:
   Enabled: false
+Style/RedundantRegexpCharacterClass:
+  Enabled: false
 Style/SafeNavigation:
   Enabled: false
 Style/Send:
@@ -119,12 +149,12 @@ Style/StringMethods:
 Style/SymbolArray:
   Enabled: false
 Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: comma
+  EnforcedStyleForMultiline: no_comma
 Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
+  EnforcedStyleForMultiline: no_comma
 Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
-Style/UnneededCondition:
+  EnforcedStyleForMultiline: no_comma
+Style/RedundantCondition:
   Enabled: false
 Style/WhileUntilModifier:
   Enabled: false

data/Gemfile

@@ -3,3 +3,11 @@ source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+gem "bundler"
+gem "pry-byebug"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "snowglobe", github: "mcmire/snowglobe"
+gem "super_diff"

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Elliot Winkler
+Copyright (c) 2019-2020 Elliot Winkler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -25,14 +25,14 @@ gem install warnings_logger
 ## Usage
 
 To use this gem, place the following in `spec/spec_helper.rb` or
-`test/test_helper.rb`, replacing `<project name>` with the name of the gem
-you're developing:
+`test/test_helper.rb`, replacing your project name as needed:
 
 ``` ruby
-WarningsLogger::Spy.call(
-  project_name: '<project name>',
-  project_directory: Pathname.new('../..').expand_path(__FILE__),
-)
+WarningsLogger.configure do |config|
+  config.project_name = "my_project_name_goes_here"
+  config.project_directory = Pathname.new("..").expand_path(__dir__)
+end
+WarningsLogger.enable
 ```
 
 We also recommend you run your tests by enabling warnings in general. For RSpec
@@ -42,9 +42,9 @@ means updating your Rake::Task::TestTask by setting `t.verbose = true` and
 setting `$VERBOSE = true` in your test helper.
 
 With the above code in place, now when you run your tests, if your gem emits any
-warnings, they will be written to a file (which is printed to your terminal) and
-the exit code of the test run will be 1. This helps you ensure that your gem is
-warning-free before you release a new version.
+warnings, they will be written to a file, and the exit code of the test run will
+be 1, so that your CI will fail the build. This helps you ensure that your gem
+is warning-free before you release a new version.
 
 ## Developing
 
@@ -53,5 +53,5 @@ warning-free before you release a new version.
 
 ## Author/License
 
-Snowglobe is © 2019 Elliot Winkler (<elliot.winkler@gmail.com>) and is released
-under the [MIT license](LICENSE).
+Snowglobe is © 2019-2020 Elliot Winkler (<elliot.winkler@gmail.com>) and is
+released under the [MIT license](LICENSE).

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/warnings_logger.rb

@@ -1,6 +1,26 @@
-require_relative "warnings_logger/configuration"
-require_relative "warnings_logger/filesystem"
-require_relative "warnings_logger/partitioner"
-require_relative "warnings_logger/reader"
-require_relative "warnings_logger/reporter"
-require_relative "warnings_logger/spy"
+require "warnings_logger/configuration"
+require "warnings_logger/filesystem"
+require "warnings_logger/partitioner"
+require "warnings_logger/reader"
+require "warnings_logger/reporter"
+require "warnings_logger/spy"
+
+module WarningsLogger
+  class << self
+    attr_writer :configuration
+
+    def configure(&block)
+      configuration.update!(&block)
+    end
+
+    def configuration
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      @configuration ||= Configuration.new
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+    end
+
+    def enable
+      WarningsLogger::Spy.enable(configuration)
+    end
+  end
+end

data/lib/warnings_logger/configuration.rb

@@ -1,10 +1,54 @@
+require "pathname"
+
 module WarningsLogger
   class Configuration
-    attr_reader :project_name, :project_directory
+    attr_writer :project_name
+
+    def initialize
+      @project_name = nil
+      @project_directory = nil
+    end
+
+    def update!
+      yield self
+    end
+
+    def project_name
+      if @project_name
+        @project_name
+      else
+        raise NotConfiguredError.new(<<~EXAMPLE)
+          WarningsLogger.configure do |config|
+            config.project_name = "your_project_name"
+          end
+        EXAMPLE
+      end
+    end
+
+    def project_directory
+      if @project_directory
+        @project_directory
+      else
+        raise NotConfiguredError.new(<<~EXAMPLE)
+          WarningsLogger.configure do |config|
+            config.project_directory = "/path/to/your/project/directory"
+          end
+        EXAMPLE
+      end
+    end
+
+    def project_directory=(path)
+      @project_directory = Pathname.new(path)
+    end
+
+    class NotConfiguredError < StandardError
+      def initialize(example)
+        super(<<~MESSAGE)
+          You need to configure WarningsLogger before you can use it! For example:
 
-    def initialize(project_name:, project_directory:)
-      @project_name = project_name
-      @project_directory = project_directory
+          #{example}
+        MESSAGE
+      end
     end
   end
 end

data/lib/warnings_logger/filesystem.rb

@@ -2,12 +2,8 @@ require "fileutils"
 
 module WarningsLogger
   class Filesystem
-    ROOT_TEMPORARY_DIRECTORY = Pathname.new("/tmp/warnings_logger")
-
     def initialize(configuration)
-      @temporary_directory = ROOT_TEMPORARY_DIRECTORY.join(
-        configuration.project_name,
-      )
+      @configuration = configuration
       @files_by_name = Hash.new do |hash, name|
         hash[name] = file_for(name)
       end
@@ -35,7 +31,7 @@ module WarningsLogger
 
     private
 
-    attr_reader :temporary_directory, :files_by_name
+    attr_reader :configuration, :files_by_name
 
     def file_for(name)
       path_for(name).open("w+")
@@ -44,5 +40,9 @@ module WarningsLogger
     def path_for(name)
       temporary_directory.join("#{name}.txt")
     end
+
+    def temporary_directory
+      configuration.project_directory.join("tmp/warnings_logger")
+    end
   end
 end

data/lib/warnings_logger/reporter.rb

@@ -23,34 +23,41 @@ module WarningsLogger
 
     def_delegators :configuration, :project_name
 
-    def_delegators :filesystem, :warnings_file,
-      :relevant_warnings_file, :irrelevant_warnings_file
+    def_delegators(
+      :filesystem,
+      :warnings_file,
+      :relevant_warnings_file,
+      :irrelevant_warnings_file
+    )
 
-    def_delegators :partitioner, :relevant_warning_groups,
+    def_delegators(
+      :partitioner,
+      :relevant_warning_groups,
       :irrelevant_warning_groups
+    )
 
     def reporting_all_groups
       if relevant_warning_groups.any? || irrelevant_warning_groups.any?
-        puts
+        warn ""
         yield
-        puts "All warnings were written to #{warnings_file.path}."
-        puts
+        warn "All warnings were written to #{warnings_file.path}."
+        warn ""
       end
     end
 
     def report_relevant_warning_groups
       if relevant_warning_groups.any?
-        print_divider("-", 75, header: " #{project_name} warnings:")
+        print_divider("-", 75, header: " #{project_name} warnings: ")
         relevant_warning_groups.each do |group|
           group.each do |line|
             relevant_warnings_file.puts(line)
-            puts line
+            warn line
           end
         end
         print_divider("-", 75)
-        puts(
+        warn(
           "#{project_name} warnings written to " +
-          "#{relevant_warnings_file.path}.",
+          "#{relevant_warnings_file.path}."
         )
       end
     end
@@ -62,29 +69,29 @@ module WarningsLogger
             irrelevant_warnings_file.puts(line)
           end
         end
-        puts(
+        warn(
           "Non #{project_name} warnings were raised during the test run. " +
-          "These have been written to #{irrelevant_warnings_file.path}.",
+          "These have been written to #{irrelevant_warnings_file.path}."
         )
       end
     end
 
     def print_divider(character, count, options = {})
-      puts
+      warn
 
       if options[:header]
         first_count = 10
-        second_count = options[:header].length - first_count
+        second_count = count - options[:header].length - first_count
         string =
           horizontal_rule(character, first_count) +
           options[:header] +
           horizontal_rule(character, second_count)
-        puts string
+        warn string
       else
-        puts horizontal_rule(character, count)
+        warn horizontal_rule(character, count)
       end
 
-      puts
+      warn
     end
 
     def horizontal_rule(character, count)

data/lib/warnings_logger/spy.rb

@@ -3,9 +3,19 @@ require "forwardable"
 module WarningsLogger
   # Adapted from <http://myronmars.to/n/dev-blog/2011/08/making-your-gem-warning-free>
   class Spy
-    def self.call(args)
-      configuration = Configuration.new(args)
-      new(configuration).call
+    # DEPRECATED
+    def self.call(**options)
+      WarningsLogger.configure do |config|
+        options.each do |key, value|
+          config.public_send("#{key}=", value)
+        end
+      end
+
+      WarningsLogger.enable
+    end
+
+    def self.enable(configuration)
+      new(configuration).enable
     end
 
     extend Forwardable
@@ -15,19 +25,21 @@ module WarningsLogger
       @reader = Reader.new(filesystem)
       @partitioner = Partitioner.new(
         configuration: configuration,
-        reader: reader,
+        reader: reader
       )
       @reporter = Reporter.new(
         configuration: configuration,
         filesystem: filesystem,
-        partitioner: partitioner,
+        partitioner: partitioner
       )
+
+      @original_stderr = nil
     end
 
-    def call
+    def enable
       filesystem.prepare
       capture_warnings
-      report_warnings_at_exit
+      report_warnings_after_tests_run
     end
 
     private
@@ -36,17 +48,48 @@ module WarningsLogger
 
     def_delegators :filesystem, :warnings_file
 
-    def_delegators :partitioner, :relevant_warning_groups,
+    def_delegators(
+      :partitioner,
+      :relevant_warning_groups,
       :irrelevant_warning_groups
+    )
 
     def capture_warnings
+      @original_stderr = $stderr.dup
       $stderr.reopen(warnings_file.path)
     end
 
-    def report_warnings_at_exit
-      at_exit do
-        printing_exceptions do
-          report_and_exit
+    def release_warnings
+      $stderr.reopen(@original_stderr)
+    end
+
+    def report_warnings_after_tests_run
+      spy = self
+
+      if should_integrate_with_rspec?
+        RSpec.configure do |config|
+          config.after(:suite) do
+            spy.instance_eval do
+              release_warnings
+              printing_exceptions do
+                report_and_possibly_fail
+              end
+            end
+          end
+        end
+      elsif should_integrate_with_minitest?
+        Minitest.after_run do
+          release_warnings
+          printing_exceptions do
+            report_and_possibly_fail
+          end
+        end
+      else
+        at_exit do
+          release_warnings
+          printing_exceptions do
+            report_and_possibly_fail
+          end
         end
       end
     end
@@ -54,21 +97,21 @@ module WarningsLogger
     def printing_exceptions
       yield
     rescue StandardError => error
-      puts "\n--- ERROR IN AT_EXIT --------------------------------"
-      puts "#{error.class}: #{error.message}"
-      puts error.backtrace.join("\n")
-      puts "-----------------------------------------------------"
+      warn "\n--- ERROR IN AT_EXIT --------------------------------"
+      warn "#{error.class}: #{error.message}"
+      warn error.backtrace.join("\n")
+      warn "-----------------------------------------------------"
       raise error
     end
 
-    def report_and_exit
+    def report_and_possibly_fail
       reader.read
       partitioner.partition
 
       if relevant_warning_groups.any?
         report_warnings_and_fail
       else
-        print_warnings_and_fail
+        print_warnings
       end
     end
 
@@ -77,9 +120,17 @@ module WarningsLogger
       exit(1)
     end
 
-    def print_warnings_and_fail
+    def print_warnings
       filesystem.warnings_file.rewind
       puts filesystem.warnings_file.read
     end
+
+    def should_integrate_with_rspec?
+      defined?(RSpec)
+    end
+
+    def should_integrate_with_minitest?
+      defined?(Minitest) && Minitest.class_variable_get("@@installed_at_exit")
+    end
   end
 end

data/lib/warnings_logger/version.rb

@@ -1,3 +1,3 @@
 module WarningsLogger
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/warnings_logger.gemspec

@@ -36,8 +36,4 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,58 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: warnings_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Elliot Winkler
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+date: 2020-08-23 00:00:00.000000000 Z
+dependencies: []
+description:
 email:
 - elliot.winkler@gmail.com
 executables: []
@@ -60,9 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -83,7 +39,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/mcmire/warnings_logger
   source_code_uri: https://github.com/mcmire/warnings_logger
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,9 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Easily log warnings in your gems
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 1.17.3