rubocop-twirp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fd2c1e5539fcf54151b1a5a5fd90f83f7b841ada41ed672bc791212bc160c40
+  data.tar.gz: 8d61149045abd2246ddf00e30dabd67620b69b49e3212e37d132af265f24c7b7
+SHA512:
+  metadata.gz: ce634e64bdc75f3702aff3d39cbd60373d17c90589aa3eb241116b52eed3bbf579e7ca554d375afbb305787681a9996d93f509fdeb0ce398372315b1dd182ffb
+  data.tar.gz: d51f7c50615aa2fa207c117cfeaf7d7234dd59ff3f6c946964e1c028ebd61bafcdbf9a17d67860ad9efa5fde8209fe06df210e1526552044e42470d30f3a50ea

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+###  v0.0.1  (2023-02-25)
+-
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# TODO: remove hack/fix after twirp 1.10.1
+# https://github.com/github/twirp-ruby/commit/aa4000f8ea9ff84447060ab8a7f425ed70e0bf56
+gem "rack"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    rubocop-twirp (0.0.1)
+      rubocop (>= 1)
+      twirp (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    google-protobuf (3.22.0-x86_64-darwin)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rack (3.0.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.46.0)
+      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.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    twirp (1.10.0)
+      faraday (< 3)
+      google-protobuf (~> 3.0, >= 3.7.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  byebug
+  rack
+  rspec
+  rubocop-twirp!
+  simplecov
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Daniel Pepper
+
+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,39 @@
+rubocop-twirp
+======
+![Gem](https://img.shields.io/gem/dt/rubocop-twirp?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/rubocop-twirp/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rubocop-twirp)
+
+...
+
+[RuboCop](https://github.com/bbatsov/rubocop)
+
+
+
+```ruby
+gem install rubocop-twirp
+
+# or add to your Gemfile
+gem "rubocop-twirp", require: false
+```
+
+Add this to your .rubocop.yml:
+```
+require: rubocop-twirp
+```
+
+Scan for issues
+```
+rubocop -r rubocop-twirp --only Twirp
+```
+
+----
+## Contributing
+
+Yes please  :)
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-feature`)
+1. Ensure the tests pass (`bundle exec rspec`)
+1. Commit your changes (`git commit -am 'awesome new feature'`)
+1. Push your branch (`git push origin my-feature`)
+1. Create a Pull Request

data/config/default.yml

@@ -0,0 +1,7 @@
+Twirp:
+  Enabled: true
+
+Twirp/DeprecatedArguments:
+  Description: 'Use keyword args for `Twirp::ClientResp.new`'
+  Enabled: true
+  VersionAdded: '0.1'

data/lib/rubocop/cop/twirp/deprecated_arguments.rb

@@ -0,0 +1,61 @@
+module RuboCop
+  module Cop
+    module Twirp
+      # Checks that Twirp::ClientResp uses keyword arguments
+      # instead of positional arguments.
+      #
+      # @example
+      #   # bad
+      #   Twirp::ClientResp.new(data, error)
+      #
+      #   # good
+      #   Twirp::ClientResp.new(data: data, error: error)
+      #
+      class DeprecatedArguments < Base
+        RESTRICT_ON_SEND = [:new].freeze
+        POSITIONAL_ARGS = [:data, :error].freeze
+
+        def_node_matcher :pos_args?, <<~PATTERN
+          (send (const (const { nil? cbase } :Twirp) :ClientResp) :new $!hash_type?+)
+        PATTERN
+
+
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = "Positional args are deprecated, use keyword args: " \
+              "`%<class_name>s.%<method_name>s(%<kwargs>s)`"
+
+        def on_send(node)
+          # kwargs were introduced in Twirp v1.10
+          return unless Gem::Version.new(::Twirp::VERSION) >= Gem::Version.new("1.10")
+
+          return unless pos_args?(node)
+
+          kwargs = POSITIONAL_ARGS.map.with_index do |arg, index|
+            "#{arg}: #{node.arguments[index].source}"
+          end.join(", ")
+
+          message = format(
+            MSG,
+            class_name: node.receiver.source,
+            kwargs: kwargs,
+            method_name: node.method_name,
+          )
+
+          offense_range = range_between(
+            node.arguments.first.source_range.begin_pos,
+            node.arguments.last.source_range.end_pos
+          )
+
+          add_offense(
+            offense_range,
+            message: message,
+          ) do |corrector|
+            corrector.replace(offense_range, kwargs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/twirp/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Twirp
+    VERSION = "0.0.1"
+  end
+end

data/lib/rubocop/twirp.rb

@@ -0,0 +1,6 @@
+require "rubocop"
+require "rubocop/twirp/version"
+require "twirp"
+
+# load cops
+Dir["./cop/twirp/**/*.rb", base: __dir__].each { |f| require_relative f }

data/lib/rubocop-twirp.rb

@@ -0,0 +1 @@
+require "rubocop/twirp"

data/rubocop-twirp.gemspec

@@ -0,0 +1,21 @@
+require_relative "lib/rubocop/twirp/version"
+package = RuboCop::Twirp
+
+
+Gem::Specification.new do |s|
+  s.authors     = ["Daniel Pepper"]
+  s.description = "..."
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/rubocop-twirp"
+  s.license     = "MIT"
+  s.name        = File.basename(__FILE__).split(".")[0]
+  s.summary     = package.to_s
+  s.version     = package.const_get "VERSION"
+
+  s.add_dependency "rubocop", ">= 1"
+  s.add_dependency "twirp", ">= 1"
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-twirp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: twirp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "..."
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-twirp.rb
+- lib/rubocop/cop/twirp/deprecated_arguments.rb
+- lib/rubocop/twirp.rb
+- lib/rubocop/twirp/version.rb
+- rubocop-twirp.gemspec
+homepage: https://github.com/dpep/rubocop-twirp
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: RuboCop::Twirp
+test_files: []