lint_roller 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247433b599df47c6817d7afaafd5da089706ebcae854383d12e96c6c9551113a
-  data.tar.gz: 1f6d77951ed64e2f52d5145fed81b8eb0d5ad1befa353e20b3ce65c33d233e50
+  metadata.gz: f2fd0d1d1ea02f68478b1c2494f5653b2bb8eca764d86d1b3879188fa80cf5ec
+  data.tar.gz: 3e2b04be9ea384a8e2a76a370bd41c9265a951f3b49af8377b9108276c20e67d
 SHA512:
-  metadata.gz: d826ec3722b1d85f1f718519ea5958e89dc22878f02e9e6f3b4d601a2a1e8d159be91a0c4f7dc1de0fb5245add220d4d656f6547b6d24f33d6dc84ae77347e09
-  data.tar.gz: d86e1f61d4eb7702014e5509d83a424fa74fb20efcb0209f775213313db90ee4e5cf2446a58038b002efd6532bcc9059fd72cb03dc7ef96f11b84bcc28f2b257
+  metadata.gz: abdb2314cc0b073c2005721ceec4c64587f604f2e1fea24e235a4593b9ba407f3ac73b0540df978ab514365ecebae2a0c06a312961b5eeafa28475718ec1a5f9
+  data.tar.gz: 6759710ae4e8ebe8aae2d57626899a3461b39fc6ffd31255d5dc8855b61998cacadedc3999347b1dcb48139c1e606b1e6450716a5d5de49d96b7faa404e5ca2d

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [1.1.0]
+
+- Add `LintRoller::Support` module of classes designed to make it a little
+easier to author plugins. `MergesUpstreamMetadata#merge` will allow a minimal
+YAML config (say, `standard-sorbet`'s, which only contains `Enabled` values for
+each rule) to merge in any other defaults from a source YAML (e.g.
+`rubocop-sorbet`'s which includes `Description`, `VersionAdded`, and so on).
+This way that metadata is neither absent at runtime nor duplicated in a standard
+plugin that mirrors a rubocop extension
+
 ## [1.0.0]
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lint_roller (1.0.0)
+    lint_roller (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -45,6 +45,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   lint_roller!

data/README.md

@@ -19,7 +19,7 @@ this example plugin for banana-related static analysis:
 
 ```ruby
 module BananaRoller
-  class Plugin
+  class Plugin < LintRoller::Plugin
     # `config' is a Hash of options passed to the plugin by the user
     def initialize(config = {})
       @alternative = config["alternative"] ||= "chocolate"
@@ -36,11 +36,7 @@ module BananaRoller
 
     # `context' is an instance of LintRoller::Context provided by the runner
     def supported?(context)
-      if context.engine == :rubocop
-        true
-      else
-        false
-      end
+      context.engine == :rubocop
     end
 
     # `context' is an instance of LintRoller::Context provided by the runner
@@ -56,14 +52,16 @@ end
 ```
 
 And that's pretty much it. Just a declarative way to identify your plugin,
-detect whether it supports the given context (e.g. the current `runner` and
-`engine` and their respective `_version`s), and then provides your custom
-configuration as a [LintRoller::Rules](lib/lint_roller/rules.rb) object.
+detect whether it supports the given
+[LintRoller::Context](/lib/lint_roller_context.rb) (e.g. the current `runner`
+and `engine` and their respective `_version`s), for which the plugin will
+ultimately its configuration as a [LintRoller::Rules](/lib/lint_roller/rules.rb)
+object.
 
 ## Packaging a plugin in a gem
 
-In order for a formatter to use your plugin, it needs to know where to what path
-to require and the name of your plugin class to instantiate and invoke.
+In order for a formatter to use your plugin, it needs to know what path to
+require as well as the name of the plugin class to instantiate and invoke.
 
 To make this work seamlessly for your users without additional configuration of
 their own, all you need to do is specify a metadata attribute called
@@ -173,4 +171,3 @@ including (but not limited to) one-on-one communications, public posts/comments,
 code reviews, pull requests, and GitHub issues. If violations occur, Test Double
 will take any action they deem appropriate for the infraction, up to and
 including blocking a user from the organization's repositories.
-

data/lib/lint_roller/support/merges_upstream_metadata.rb

@@ -0,0 +1,23 @@
+module LintRoller
+  module Support
+    class MergesUpstreamMetadata
+      def merge(plugin_yaml, upstream_yaml)
+        common_upstream_values = upstream_yaml.select { |key| plugin_yaml.key?(key) }
+
+        plugin_yaml.merge(common_upstream_values) { |key, plugin_value, upstream_value|
+          if plugin_value.is_a?(Hash) && upstream_value.is_a?(Hash)
+            plugin_value.merge(upstream_value) { |sub_key, plugin_sub_value, upstream_sub_value|
+              if plugin_value.key?(sub_key)
+                plugin_sub_value
+              else
+                upstream_sub_value
+              end
+            }
+          else
+            plugin_value
+          end
+        }
+      end
+    end
+  end
+end

data/lib/lint_roller/version.rb

@@ -1,3 +1,3 @@
 module LintRoller
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/lint_roller.rb

@@ -7,5 +7,7 @@ require_relative "lint_roller/rules"
 require_relative "lint_roller/plugin"
 require_relative "lint_roller/error"
 
+require_relative "lint_roller/support/merges_upstream_metadata"
+
 module LintRoller
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lint_roller
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -30,6 +30,7 @@ files:
 - lib/lint_roller/error.rb
 - lib/lint_roller/plugin.rb
 - lib/lint_roller/rules.rb
+- lib/lint_roller/support/merges_upstream_metadata.rb
 - lib/lint_roller/version.rb
 homepage: https://github.com/standardrb/lint_roller
 licenses:
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: A plugin specification for linter and formatter rulesets