rubocop-grape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c384295c459e02395aee22afb61dce8fe77a11603b72c57188ea65761bc981c2
+  data.tar.gz: ff1aff8360ad4014f513af0a5312e5647f866e602e513580509854577dff21be
+SHA512:
+  metadata.gz: 4f8488742a3f79cfdd660154d4ed29db6f8f6797356f945d7761815a53bda297f459fd8d5a77b81928814da124679cc4c38232b089ff5d0a95304d1db3a1bb58
+  data.tar.gz: 17561aee4d974b9b8642a0ca6e40be8c289e4b6ac942971fe61a022daa69224970f2bff7677be52788332e127a5cdabd4b4d5b07a17c9ac8e21ca64ce59b80e2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Akito Hikasa
+
+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,35 @@
+# RuboCop::Grape
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/grape`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-grape'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-grape
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-grape.

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop-grape'
+
+require 'irb'
+ARGV.clear
+
+IRB.start(__FILE__)

data/config/default.yml

@@ -0,0 +1,4 @@
+Grape/RouteParamType:
+  Enabled: true
+  Safe: false
+  VersionAdded: '0.1'

data/lib/rubocop/cop/grape/route_param_type.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # Checks whether type is specified at points where `Grape::API#route_param` is called.
+      #
+      # @example
+      #
+      #   # bad
+      #   route_param :id
+      #
+      #   # good
+      #   route_param :id, type: Integer
+      #   route_param :filename, type: String
+      #   route_param :status, type: String, desc: 'Resource Status'
+      #
+      class RouteParamType < Base
+        MSG = 'Define Parameter Type'
+
+        def_node_matcher :route_param?, <<~RUBY
+          (send _ :route_param ({sym str} _) ...)
+        RUBY
+
+        def_node_matcher :include_key_type?, <<~RUBY
+          (pair (sym :type) _)
+        RUBY
+
+        def on_send(node)
+          return unless route_param?(node)
+
+          options = node.children.last.children
+          return if options.any? { |clild_node| include_key_type?(clild_node) }
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'grape/route_param_type'

data/lib/rubocop/grape/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Grape
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Grape
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/grape.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'grape/version'
+
+module RuboCop
+  # RuboCop Grape project namespace
+  module Grape
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-grape.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/grape'
+require_relative 'rubocop/grape/version'
+require_relative 'rubocop/grape/inject'
+
+RuboCop::Grape::Inject.defaults!
+
+require_relative 'rubocop/cop/grape_cops'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-grape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akito Hikasa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Automatic Grape code style checking tool.
+  A RuboCop extension focused on enforcing Grape best practices and coding conventions.
+email:
+- wetsand.wfs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- config/default.yml
+- lib/rubocop-grape.rb
+- lib/rubocop/cop/grape/route_param_type.rb
+- lib/rubocop/cop/grape_cops.rb
+- lib/rubocop/grape.rb
+- lib/rubocop/grape/inject.rb
+- lib/rubocop/grape/version.rb
+homepage: https://github.com/kakubin/rubocop-grape
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kakubin/rubocop-grape
+  source_code_uri: https://github.com/kakubin/rubocop-grape
+  changelog_uri: https://github.com/kakubin/rubocop-grape/blob/master/CHANGELOG.md
+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.3.7
+signing_key:
+specification_version: 4
+summary: Automatice Grape code style checking tool.
+test_files: []