warnings_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4212c6b04c9e279f94862a0f2f4b91c32f673edb8496243cd1827b8f288a3317
+  data.tar.gz: 8497994515a8223fa011f24801f63a485af6af2ba011f2b5d18c2ab50b20ed89
+SHA512:
+  metadata.gz: 58243246de25954f2bc8febee114b3a07189fed4ef8abc19249f445fbf851b2bf658c8c1d2e077f7314010ccabf3037064095d7d00642e378bee2eb9153cd3c6
+  data.tar.gz: 2e42de94cc388528cb3f20e374accf6ade750443b29793e2c24fc68c97e479848b37c6a4618fdc0843ad485c9f495212442ca3befdf090df6a732d36fb7dea65

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,132 @@
+---
+AllCops:
+  Exclude:
+    - db/schema.rb
+  TargetRubyVersion: 2.5
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/ClassStructure:
+  Enabled: true
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/InitialIndentation:
+  Enabled: false
+Layout/IndentArray:
+  EnforcedStyle: "consistent"
+Layout/IndentHash:
+  EnforcedStyle: "consistent"
+Layout/IndentHeredoc:
+  Enabled: false
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/HandleExceptions:
+  Enabled: false
+Lint/RequireParentheses:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 32
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+    - it
+    - colored
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 80
+  IgnoredPatterns:
+    - "^\\s*describe"
+    - "^\\s*context"
+    - "^\\s*it"
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+Naming/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+  Exclude:
+    - spec/**/*
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Style/Alias:
+  Enabled: false
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+Style/CollectionMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/FormatString:
+  EnforcedStyle: percent
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LineEndConcatenation:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NegatedIf:
+  Enabled: false
+Style/NegatedWhile:
+  Enabled: false
+Style/OneLineConditional:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/PreferredHashMethods:
+  Enabled: false
+Style/RaiseArgs:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/Send:
+  Enabled: true
+Style/SignalException:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/StringMethods:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/UnneededCondition:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/WordArray:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Warnings Logger
+
+Easily log warnings in your gems.
+
+## Installation
+
+Add this line to your gem's gemspec:
+
+```ruby
+spec.add_development_dependency('warnings_logger')
+```
+
+If you have a Gemfile, run:
+
+``` bash
+bundle install
+```
+
+Or, install the gem yourself:
+
+``` bash
+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:
+
+``` ruby
+WarningsLogger::Spy.call(
+  project_name: '<project name>',
+  project_directory: Pathname.new('../..').expand_path(__FILE__),
+)
+```
+
+We also recommend you run your tests by enabling warnings in general. For RSpec
+this means updating the RSpec::Core::RakeTask by setting `config.warnings =
+true` and setting `$VERBOSE = true` in your spec helper. For Minitest, this
+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.
+
+## Developing
+
+* `bin/setup` to get started
+* `bundle exec rake release` to release a new version
+
+## Author/License
+
+Snowglobe is © 2019 Elliot Winkler (<elliot.winkler@gmail.com>) and is released
+under the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/warnings_logger.rb

@@ -0,0 +1,6 @@
+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"

data/lib/warnings_logger/configuration.rb

@@ -0,0 +1,10 @@
+module WarningsLogger
+  class Configuration
+    attr_reader :project_name, :project_directory
+
+    def initialize(project_name:, project_directory:)
+      @project_name = project_name
+      @project_directory = project_directory
+    end
+  end
+end

data/lib/warnings_logger/filesystem.rb

@@ -0,0 +1,48 @@
+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,
+      )
+      @files_by_name = Hash.new do |hash, name|
+        hash[name] = file_for(name)
+      end
+    end
+
+    def prepare
+      if temporary_directory.exist?
+        temporary_directory.rmtree
+      end
+
+      temporary_directory.mkpath
+    end
+
+    def warnings_file
+      files_by_name["all_warnings"]
+    end
+
+    def irrelevant_warnings_file
+      files_by_name["irrelevant_warnings"]
+    end
+
+    def relevant_warnings_file
+      files_by_name["relevant_warnings"]
+    end
+
+    private
+
+    attr_reader :temporary_directory, :files_by_name
+
+    def file_for(name)
+      path_for(name).open("w+")
+    end
+
+    def path_for(name)
+      temporary_directory.join("#{name}.txt")
+    end
+  end
+end

data/lib/warnings_logger/partitioner.rb

@@ -0,0 +1,30 @@
+require "forwardable"
+
+module WarningsLogger
+  class Partitioner
+    extend Forwardable
+
+    attr_reader :relevant_warning_groups, :irrelevant_warning_groups
+
+    def initialize(configuration:, reader:)
+      @configuration = configuration
+      @reader = reader
+    end
+
+    def partition
+      @relevant_warning_groups, @irrelevant_warning_groups =
+        warning_groups.partition { |group| relevant_warnings?(group) }
+    end
+
+    private
+
+    attr_reader :configuration, :reader
+
+    def_delegators :configuration, :project_directory
+    def_delegators :reader, :warning_groups
+
+    def relevant_warnings?(lines_in_group)
+      lines_in_group[0].start_with?("#{project_directory}/lib")
+    end
+  end
+end

data/lib/warnings_logger/reader.rb

@@ -0,0 +1,56 @@
+require "forwardable"
+
+module WarningsLogger
+  class Reader
+    extend Forwardable
+
+    attr_reader :warning_groups
+
+    def initialize(filesystem)
+      @filesystem = filesystem
+      @current_group = []
+      @warning_groups = []
+    end
+
+    def read
+      warnings_file.rewind
+
+      warnings_file.each_line do |line|
+        process_line(line)
+      end
+
+      add_group(current_group)
+    end
+
+    private
+
+    attr_reader :filesystem, :current_group
+
+    def_delegators :filesystem, :warnings_file
+
+    def process_line(line)
+      if start_of_group?(line)
+        add_group(current_group)
+        @current_group = []
+      end
+
+      current_group << line
+    end
+
+    def start_of_group?(line)
+      line =~ /^\S/
+    end
+
+    def add_group(group)
+      unless group.empty? || group_already_added?(group)
+        warning_groups << group
+      end
+    end
+
+    def group_already_added?(group_to_be_added)
+      warning_groups.any? do |group|
+        group == group_to_be_added
+      end
+    end
+  end
+end

data/lib/warnings_logger/reporter.rb

@@ -0,0 +1,94 @@
+require "forwardable"
+
+module WarningsLogger
+  class Reporter
+    extend Forwardable
+
+    def initialize(configuration:, filesystem:, partitioner:)
+      @configuration = configuration
+      @filesystem = filesystem
+      @partitioner = partitioner
+    end
+
+    def report
+      reporting_all_groups do
+        report_relevant_warning_groups
+        report_irrelevant_warning_groups
+      end
+    end
+
+    private
+
+    attr_reader :configuration, :filesystem, :partitioner
+
+    def_delegators :configuration, :project_name
+
+    def_delegators :filesystem, :warnings_file,
+      :relevant_warnings_file, :irrelevant_warnings_file
+
+    def_delegators :partitioner, :relevant_warning_groups,
+      :irrelevant_warning_groups
+
+    def reporting_all_groups
+      if relevant_warning_groups.any? || irrelevant_warning_groups.any?
+        puts
+        yield
+        puts "All warnings were written to #{warnings_file.path}."
+        puts
+      end
+    end
+
+    def report_relevant_warning_groups
+      if relevant_warning_groups.any?
+        print_divider("-", 75, header: " #{project_name} warnings:")
+        relevant_warning_groups.each do |group|
+          group.each do |line|
+            relevant_warnings_file.puts(line)
+            puts line
+          end
+        end
+        print_divider("-", 75)
+        puts(
+          "#{project_name} warnings written to " +
+          "#{relevant_warnings_file.path}.",
+        )
+      end
+    end
+
+    def report_irrelevant_warning_groups
+      if irrelevant_warning_groups.any?
+        irrelevant_warning_groups.each do |group|
+          group.each do |line|
+            irrelevant_warnings_file.puts(line)
+          end
+        end
+        puts(
+          "Non #{project_name} warnings were raised during the test run. " +
+          "These have been written to #{irrelevant_warnings_file.path}.",
+        )
+      end
+    end
+
+    def print_divider(character, count, options = {})
+      puts
+
+      if options[:header]
+        first_count = 10
+        second_count = options[:header].length - first_count
+        string =
+          horizontal_rule(character, first_count) +
+          options[:header] +
+          horizontal_rule(character, second_count)
+        puts string
+      else
+        puts horizontal_rule(character, count)
+      end
+
+      puts
+    end
+
+    def horizontal_rule(character, count)
+      character * count
+    end
+  end
+end

data/lib/warnings_logger/spy.rb

@@ -0,0 +1,85 @@
+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
+    end
+
+    extend Forwardable
+
+    def initialize(configuration)
+      @filesystem = Filesystem.new(configuration)
+      @reader = Reader.new(filesystem)
+      @partitioner = Partitioner.new(
+        configuration: configuration,
+        reader: reader,
+      )
+      @reporter = Reporter.new(
+        configuration: configuration,
+        filesystem: filesystem,
+        partitioner: partitioner,
+      )
+    end
+
+    def call
+      filesystem.prepare
+      capture_warnings
+      report_warnings_at_exit
+    end
+
+    private
+
+    attr_reader :filesystem, :reader, :partitioner, :reporter
+
+    def_delegators :filesystem, :warnings_file
+
+    def_delegators :partitioner, :relevant_warning_groups,
+      :irrelevant_warning_groups
+
+    def capture_warnings
+      $stderr.reopen(warnings_file.path)
+    end
+
+    def report_warnings_at_exit
+      at_exit do
+        printing_exceptions do
+          report_and_exit
+        end
+      end
+    end
+
+    def printing_exceptions
+      yield
+    rescue StandardError => error
+      puts "\n--- ERROR IN AT_EXIT --------------------------------"
+      puts "#{error.class}: #{error.message}"
+      puts error.backtrace.join("\n")
+      puts "-----------------------------------------------------"
+      raise error
+    end
+
+    def report_and_exit
+      reader.read
+      partitioner.partition
+
+      if relevant_warning_groups.any?
+        report_warnings_and_fail
+      else
+        print_warnings_and_fail
+      end
+    end
+
+    def report_warnings_and_fail
+      reporter.report
+      exit(1)
+    end
+
+    def print_warnings_and_fail
+      filesystem.warnings_file.rewind
+      puts filesystem.warnings_file.read
+    end
+  end
+end

data/lib/warnings_logger/version.rb

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

data/warnings_logger.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "warnings_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "warnings_logger"
+  spec.version = WarningsLogger::VERSION
+  spec.authors = ["Elliot Winkler"]
+  spec.email = ["elliot.winkler@gmail.com"]
+
+  spec.summary = "Easily log warnings in your gems"
+  spec.homepage = "https://github.com/mcmire/warnings_logger"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/mcmire/warnings_logger"
+  else
+    raise(
+      "RubyGems 2.0 or newer is required to protect against public gem " +
+      "pushes.",
+    )
+  end
+
+  # Specify which files should be added to the gem when it is released. The `git
+  # ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  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

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: warnings_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elliot Winkler
+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: 
+email:
+- elliot.winkler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/setup
+- lib/warnings_logger.rb
+- lib/warnings_logger/configuration.rb
+- lib/warnings_logger/filesystem.rb
+- lib/warnings_logger/partitioner.rb
+- lib/warnings_logger/reader.rb
+- lib/warnings_logger/reporter.rb
+- lib/warnings_logger/spy.rb
+- lib/warnings_logger/version.rb
+- warnings_logger.gemspec
+homepage: https://github.com/mcmire/warnings_logger
+licenses: []
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Easily log warnings in your gems
+test_files: []