quickfix_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a464000edd8b10c8a089604971668774b2291e56817e274ce8e24675ee5201db
+  data.tar.gz: 9ff5e11cf4d342e2614543408a95e3dcd3582fcbaf94100318dcdcd3076bffc0
+SHA512:
+  metadata.gz: 768cae8e6dae2a10c733b8b39ae2cf3d0d33ca920736af5ee1543e9b6dd2e120c2f79a8ee8c42f0dc670ec3daeefbfed4260fa7b5e428b20ecb84cb397ed58ef
+  data.tar.gz: a64dcba120202c3570ad0c0a7bc0a766984f98217cfc39828faca73a45a927fcb7e35fd4f4d682a952c2d6de207d17ba748ca9abfa32b174f60be878a7f2b3c4

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in quickfix_formatter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Cameron
+
+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,41 @@
+# QuickfixFormatter
+
+Easily integrate the vim quickfix list with your failing rspec tests. Just add this gem, set it as one of your
+formatters (`--format QuickfixFormatter`)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add quickfix_formatter
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install quickfix_formatter
+
+## Usage
+
+Add `--format QuickfixFormatter` to `.rspec` or in the command line. There are two configurable settings, shown below
+with their default values.
+
+`quickfix_output_file` is a string that represents the location the quickfix file is written to.
+`quickfix_silence`, when set to `true`, will supress the text that prints after writing the file.
+
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+  config.quickfix_output_file = "tmp/quickfix.out"
+  config.quickfix_silence     = false
+end
+```
+
+Once `rspec` has written the output file, you can load it with `:cfile <path to file>`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ckolkey/quickfix_formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/quickfix_formatter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require "rspec/core/formatters/base_formatter"
+
+::RSpec.configuration.add_setting :quickfix_output_file, default: "tmp/quickfix.out"
+::RSpec.configuration.add_setting :quickfix_silence,     default: false
+
+# Writes the failures in a format consumable by the vim quickfix list
+class QuickfixFormatter < RSpec::Core::Formatters::BaseFormatter
+  ::RSpec::Core::Formatters.register self, :dump_failures
+
+  def dump_failures(notification)
+    File.write(
+      config.quickfix_output_file,
+      notification.failed_examples.map(&method(:line_output)).join
+    )
+
+    puts(text_output) unless config.quickfix_silence
+  end
+
+  private
+
+  def line_output(example)
+    filepath          = example.metadata[:absolute_file_path]
+    line_number       = example.metadata[:line_number]
+    group_description = example.example_group.description
+
+    "#{filepath}:#{line_number}: #{group_description}: #{example.description}\n"
+  end
+
+  def text_output
+    ::RSpec::Core::Formatters::ConsoleCodes.wrap("\nQuickfix written to: '#{config.quickfix_output_file}'", :blue)
+  end
+
+  def config
+    ::RSpec.configuration
+  end
+end

data/quickfix_formatter.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name                          = "quickfix_formatter"
+  spec.version                       = "0.1.0"
+  spec.authors                       = ["Cameron"]
+  spec.email                         = ["cameron.kolkey@gmail.com"]
+  spec.summary                       = "Format rspec output for vim quickfix consumption"
+  spec.homepage                      = "https://www.github.com/ckolkey/quickfix_formatter"
+  spec.license                       = "MIT"
+  spec.required_ruby_version         = ">= 3.0.0"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["changelog_uri"]     = spec.homepage
+  spec.require_paths                 = ["lib"]
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+
+  spec.add_dependency "rspec", ">= 3.12.0"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: quickfix_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+description:
+email:
+- cameron.kolkey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quickfix_formatter.rb
+- quickfix_formatter.gemspec
+homepage: https://www.github.com/ckolkey/quickfix_formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.github.com/ckolkey/quickfix_formatter
+  source_code_uri: https://www.github.com/ckolkey/quickfix_formatter
+  changelog_uri: https://www.github.com/ckolkey/quickfix_formatter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Format rspec output for vim quickfix consumption
+test_files: []