rubocop-commsworld 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 374d2d6eafeef975e8184d38aa1059c70cbef90a89cbd276b7cee732e0de400a
+  data.tar.gz: 4f86a3cd035d2e8093e665436bae6e1a3e657142dcf711e916f5072b79919679
+SHA512:
+  metadata.gz: 8a020086169ec13ff991a489ab4d4d559c0a6550babcbb89aa47726866a2c1f0591c6e8e4127e2ef834f0658e48ab765716378a24875e5c4b3fac9b0ff64a760
+  data.tar.gz: 691679633cc03c77072a040f96c9952e3cc3385604362139b25cf490b21e9879ddac3f916b30c63dcf23ab831b0b17fd30a9df02079d712e5647e4b1fdef6d45

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-commsworld.rb

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-commsworld.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    rubocop-commsworld (0.1.0)
+      rubocop (~> 1.8.1)
+      rubocop-rails (~> 2.5)
+      rubocop-rspec (~> 1.41.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.41.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop-commsworld!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Commsworld Limited
+
+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,58 @@
+# rubocop-commsworld
+
+Common [rubocop] configuration and custom cops.
+Replaces [commsworld/house-style] which was config-only.
+
+## Installation
+
+Add the gem as a dependency to your project's `Gemfile`:
+
+```ruby
+gem "rubocop-commsworld", github: "commsworld/rubocop-commsworld", group: [:development, :test]
+```
+
+And install with `bundle install`.
+
+## Usage
+
+Configure rubocop in your project by creating a file in the root directory of the project, `.rubocop.yml`:
+
+```yml
+require:
+  - rubocop-commsworld
+  - rubocop-rails
+  - rubocop-rspec
+```
+
+## Cops
+
+### Commsworld/UnspecifiedModelPrivacy
+
+Issues an offence when a class is defined within a module which does not have an adjacent privacy definition.
+By default, configured to only run on `app/models`.
+
+The motivation is to enforce the use of [Private ActiveRecord models] where appropriate.
+
+```ruby
+# bad
+module Things
+  class Thing < ApplicationRecord
+  end
+end
+
+# good
+module Things
+  class Thing < ApplicationRecord
+  end
+
+  private_constant :Thing # or public_constant
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License].
+
+[rubocop]: https://github.com/rubocop-hq/rubocop
+[commsworld/house-style]: https://github.com/commsworld/house-style
+[Private ActiveRecord models]: https://kellysutton.com/2019/10/29/taming-large-rails-codebases-with-private-activerecord-models.html

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task new_cop: :environment, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = "your_id" if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/commsworld_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/commsworld"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/default.yml

@@ -0,0 +1,7 @@
+Commsworld/UnspecifiedModelPrivacy:
+  Description: Identifies classes within modules which don't have an adjacent `private_constant` or `public_constant` declaration.
+  Enabled: Yes
+  VersionAdded: 0.1.0
+  Include:
+    - app/models/**/*.rb
+

data/config/house-style.yml

@@ -0,0 +1,154 @@
+AllCops:
+  DisplayCopNames: yes
+  DisplayStyleGuide: yes
+  Exclude:
+    - bin/*
+    - node_modules/**/*
+  ExtraDetails: yes
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - db/**/*.rb
+
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - db/**/*.rb
+
+Layout/FirstArrayElementIndentation:
+  Enabled: no
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - db/**/*.rb
+    - config/**/*.rb
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: no
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    - db/**/*.rb
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - db/**/*.rb
+
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - db/**/*.rb
+
+Lint/MissingSuper:
+  Enabled: no
+
+Lint/UnusedBlockArgument:
+  Enabled: no
+
+Metrics/BlockLength:
+  Exclude:
+    - db/**/*.rb
+    - lib/tasks/**/*.rake
+    - spec/**/*_spec.rb
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - db/**/*.rb
+
+Rails/Delegate:
+  Enabled: no
+
+Rails/LexicallyScopedActionFilter:
+  Exclude:
+    - app/controllers/application_controller.rb
+    - app/controllers/concerns/**/*.rb
+
+Rails/Output:
+  Exclude:
+    - db/seeds/**/*.rb
+    - db/seeds.rb
+
+RSpec/ContextWording:
+  Exclude:
+    - spec/features/**/*_spec.rb
+    - spec/system/**/*_spec.rb
+    - spec/support/**/*.rb
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/features/**/*_spec.rb
+    - spec/system/**/*_spec.rb
+    - spec/support/**/*.rb
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/components/**/*_spec.rb
+    - spec/support/**/*.rb
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - app/components/**/*.rb
+
+Style/ConditionalAssignment:
+  Enabled: no
+
+Style/Documentation:
+  # TODO: It might be a good idea to enable this for specific paths
+  Enabled: no
+
+Style/EmptyElse:
+  Enabled: no
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: no
+
+Style/HashAsLastArrayItem:
+  Enabled: no
+
+Style/HashSyntax:
+  Exclude:
+    - db/**/*.rb
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericLiterals:
+  Exclude:
+    - db/**/*.rb
+
+Style/RedundantFetchBlock:
+  Enabled: no
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: yes
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  Enabled: no
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/lib/rubocop-commsworld.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/commsworld"
+require_relative "rubocop/commsworld/version"
+require_relative "rubocop/commsworld/inject"
+
+RuboCop::Commsworld::Inject.defaults!
+# TODO: Add a setting which allows using the cops in this gem without loading the house style.
+RuboCop::Commsworld::Inject.house_style!
+
+require_relative "rubocop/cop/commsworld_cops"

data/lib/rubocop/commsworld.rb

@@ -0,0 +1,10 @@
+require "rubocop/commsworld/version"
+
+module RuboCop
+  module Commsworld
+    class Error < StandardError; end
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+
+    private_constant(:PROJECT_ROOT)
+  end
+end

data/lib/rubocop/commsworld/inject.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Commsworld
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        inject! PROJECT_ROOT.join("config", "default.yml").to_s
+      end
+
+      def self.house_style!
+        inject! PROJECT_ROOT.join("config", "house-style.yml").to_s
+      end
+
+      def self.inject!(path)
+        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/commsworld/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Commsworld
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rubocop/cop/commsworld/unspecified_model_privacy.rb

@@ -0,0 +1,50 @@
+module RuboCop
+  module Cop
+    module Commsworld
+      class UnspecifiedModelPrivacy < Cop
+        MSG = "Specify an access modifier for namespaced class `%<class_name>s` with either " \
+              "`private_constant :%<class_name>s` or `public_constant :%<class_name>s`".freeze
+
+        def_node_matcher :private_constant_declaration?, <<~PATTERN
+          (send _ :private_constant _)
+        PATTERN
+
+        def_node_matcher :public_constant_declaration?, <<~PATTERN
+          (send _ :public_constant _)
+        PATTERN
+
+        def on_class(node)
+          return unless module_scope?(node)
+
+          klass_name = node.identifier.node_parts.last
+
+          node.parent.each_child_node do |child|
+            next unless private_constant_declaration?(child) || public_constant_declaration?(child)
+            return if klass_name == child.arguments.first.value
+          end
+
+          add_offense(node, message: message(node))
+        end
+
+        private
+
+        def message(node)
+          klass_name = node.identifier.node_parts.last
+
+          format(MSG, class_name: klass_name)
+        end
+
+        def module_scope?(node)
+          return unless node.parent
+
+          case node.parent.type
+          when :begin
+            module_scope?(node.parent)
+          when :module
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/commsworld_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commsworld/unspecified_model_privacy"

data/rubocop-commsworld.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/rubocop/commsworld/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-commsworld"
+  spec.version       = RuboCop::Commsworld::VERSION
+  spec.authors       = ["Lewis Eason"]
+  spec.email         = ["lewis.eason@commsworld.com"]
+
+  spec.summary       = "Commsworld rubocop config and cops"
+  spec.homepage      = "https://github.com/commsworld/rubocop-commsworld"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop", "~> 1.8.1"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.5"
+  spec.add_runtime_dependency "rubocop-rspec", "~> 1.41.0"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec", "~> 3.10"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-commsworld
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lewis Eason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.41.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.41.0
+- !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: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: 
+email:
+- lewis.eason@commsworld.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- config/house-style.yml
+- lib/rubocop-commsworld.rb
+- lib/rubocop/commsworld.rb
+- lib/rubocop/commsworld/inject.rb
+- lib/rubocop/commsworld/version.rb
+- lib/rubocop/cop/commsworld/unspecified_model_privacy.rb
+- lib/rubocop/cop/commsworld_cops.rb
+- rubocop-commsworld.gemspec
+homepage: https://github.com/commsworld/rubocop-commsworld
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Commsworld rubocop config and cops
+test_files: []