standard-custom 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56e0ad2fc723b5eee60721c0055e0018cca4f821c2bc221d948af237477e37ff
+  data.tar.gz: bf33319f64c41836cf4f180e2be5813ee5204aaa534a4b5a1a17253771b0e2f1
+SHA512:
+  metadata.gz: 176c874493500639accf836bb8f67f739e924e34160607c3c180f25c02dcbcca9303ed40b35d0c5abfe35c0d344b79c338819cfafc3aedee4db74e7d62da49e4
+  data.tar.gz: ede82211fde07bf36596c24b18e0d5e30958345f2664853586c8d5a29b21cc90ee5a90acbc10e28081151fc2634fd6827df480b039e44586212f1dd8ae43050f

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0]
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gemspec
+gem "rake"
+gem "minitest"
+gem "standard"
+gem "m"
+
+group :test do
+  gem "rubocop", "~> 1.48.1"
+end
+
+gem "lint_roller", path: "../lint_roller"

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: ../lint_roller
+  specs:
+    lint_roller (1.0.0)
+
+PATH
+  remote: .
+  specs:
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.26.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  lint_roller!
+  m
+  minitest
+  rake
+  rubocop (~> 1.48.1)
+  standard
+  standard-custom!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Test Double, Inc.
+
+Portions of these files Copyright (c) 2012-18 Bozhidar Batsov:
+  - lib/standard/cop/block_single_line_braces.rb
+  - test/cop_invoker.rb
+
+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,22 @@
+# standard-custom
+
+This gem provides a [lint_roller](https://github.com/standardrb/lint_roller)
+plugin configuration for the
+[rubocop-custom](https://github.com/rubocop/rubocop-custom) ruleset.
+It, along with
+[standard-performance](https://github.com/standardrb/standard-performance), is
+configured by default by the [Standard Ruby
+gem](https://github.com/standardrb/standard)
+
+In general, if you're using Standard, you won't need to install or configure
+this gem manually, so there's not much to cover in this README!
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+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/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard:fix]

data/config/base.yml

@@ -0,0 +1,2 @@
+Standard/BlockSingleLineBraces:
+  Enabled: true

data/config/ruby-2.2.yml

@@ -0,0 +1,4 @@
+inherit_from: ./base.yml
+
+Custom/ConcurrentMonotonicTime:
+  Enabled: false

data/lib/standard/cop/block_single_line_braces.rb

@@ -0,0 +1,96 @@
+# Check for uses of braces around single line blocks, but allows either
+# braces or do/end for multi-line blocks.
+#
+# @example
+#   # bad - single line block
+#   items.each do |item| item / 5 end
+#
+#   # good - single line block
+#   items.each { |item| item / 5 }
+#
+module RuboCop::Cop
+  module Standard
+    class BlockSingleLineBraces < RuboCop::Cop::Base
+      extend RuboCop::Cop::AutoCorrector
+
+      def on_send(node)
+        return unless node.arguments?
+        return if node.parenthesized?
+        return if node.operator_method? || node.assignment_method?
+
+        node.arguments.each do |arg|
+          get_blocks(arg) do |block|
+            # If there are no parentheses around the arguments, then braces
+            # and do-end have different meaning due to how they bind, so we
+            # allow either.
+            ignore_node(block)
+          end
+        end
+      end
+
+      def on_block(node)
+        return if ignored_node?(node)
+        return if proper_block_style?(node)
+
+        message = message(node)
+        add_offense(node.loc.begin, message: message) do |corrector|
+          autocorrect(corrector, node)
+        end
+      end
+
+      private
+
+      def get_blocks(node, &block)
+        case node.type
+        when :block
+          yield node
+        when :send
+          get_blocks(node.receiver, &block) if node.receiver
+        when :hash
+          # A hash which is passed as method argument may have no braces
+          # In that case, one of the K/V pairs could contain a block node
+          # which could change in meaning if do...end replaced {...}
+          return if node.braces?
+
+          node.each_child_node { |child| get_blocks(child, &block) }
+        when :pair
+          node.each_child_node { |child| get_blocks(child, &block) }
+        end
+      end
+
+      def proper_block_style?(node)
+        node.multiline? || node.braces?
+      end
+
+      def message(node)
+        "Prefer `{...}` over `do...end` for single-line blocks."
+      end
+
+      def autocorrect(corrector, node)
+        return if correction_would_break_code?(node)
+
+        replace_do_end_with_braces(corrector, node.loc)
+      end
+
+      def correction_would_break_code?(node)
+        return unless node.keywords?
+
+        node.send_node.arguments? && !node.send_node.parenthesized?
+      end
+
+      def replace_do_end_with_braces(corrector, loc)
+        b = loc.begin
+        e = loc.end
+
+        corrector.insert_after(b, " ") unless whitespace_after?(b, 2)
+
+        corrector.replace(b, "{")
+        corrector.replace(e, "}")
+      end
+
+      def whitespace_after?(range, length = 1)
+        /\s/.match?(range.source_buffer.source[range.begin_pos + length, 1])
+      end
+    end
+  end
+end

data/lib/standard/custom/plugin.rb

@@ -0,0 +1,30 @@
+module Standard::Custom
+  class Plugin < LintRoller::Plugin
+    def initialize(config)
+      @config = config
+    end
+
+    def about
+      LintRoller::About.new(
+        name: "standard-custom",
+        version: VERSION,
+        homepage: "https://github.com/testdouble/standard-custom",
+        description: "Custom rules defined by the Standard Ruby project as part of the default ruleset"
+      )
+    end
+
+    def supported?(context)
+      true
+    end
+
+    def rules(context)
+      require_relative "../cop/block_single_line_braces"
+
+      LintRoller::Rules.new(
+        type: :path,
+        config_format: :rubocop,
+        value: Pathname.new(__dir__).join("../../../config/base.yml")
+      )
+    end
+  end
+end

data/lib/standard/custom/version.rb

@@ -0,0 +1,5 @@
+module Standard
+  module Custom
+    VERSION = "1.0.0"
+  end
+end

data/lib/standard/custom.rb

@@ -0,0 +1,9 @@
+require "lint_roller"
+
+require_relative "custom/version"
+require_relative "custom/plugin"
+
+module Standard
+  module Custom
+  end
+end

data/lib/standard-custom.rb

@@ -0,0 +1 @@
+require_relative "standard/custom"

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: standard-custom
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Searls
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/base.yml
+- config/ruby-2.2.yml
+- lib/standard-custom.rb
+- lib/standard/cop/block_single_line_braces.rb
+- lib/standard/custom.rb
+- lib/standard/custom/plugin.rb
+- lib/standard/custom/version.rb
+homepage: https://github.com/standardrb/standard-custom
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/standardrb/standard-custom
+  source_code_uri: https://github.com/standardrb/standard-custom
+  changelog_uri: https://github.com/standardrb/standard-custom/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: Standard::Custom::Plugin
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Plugin containing implementations of custom cops that are bundled as defaults
+  in Standard Ruby
+test_files: []