nucop-cops 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783eebd292d89fd9712f9f247249407e807afc0df09c20b5ed26bee92bab72fb
+  data.tar.gz: f12a4a355141d167e466415a2e8818fc4ca41aba64c17ec072507ac272d77d85
+SHA512:
+  metadata.gz: 9427af1245874bc0c1504dff7d004c51db2c39ca03c57806c4de2596597abc5ed4e298022d42de75888407544ab272d4d6bc51dbcc4628c729b7d463a542c99d
+  data.tar.gz: 64620e5c1e287e7b38cadc2de0f709a777c338e1c369abcdabe07a104b06028cb99ad53c70b9c649df91eac22e74e73cd85f7f251683b1114c81f61a15d2e577

data/lib/nucop/cops/explicit_factory_bot_usage.rb

@@ -0,0 +1,40 @@
+module Nucop
+  # This cop looks for usages of `FactoryGirl.create`, etc.
+  # See FactoryBotHelper::FACTORY_BOT_METHODS constant for a complete list.
+  #
+  # The factory methods listed are included everywhere, so referencing the constant should rarely be necessary.
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   job = FactoryGirl.create(:job, project: project)
+  #   FactoryGirl.build(:project, code: "Super Project")
+  #
+  #   # good
+  #
+  #   job = create(:job, project: project)
+  #   build(:project, code: "Super Project")
+  class ExplicitFactoryBotUsage < ::RuboCop::Cop::Base
+    extend RuboCop::Cop::AutoCorrector
+    include Helpers::FilePathHelper
+
+    MSG = "Do not explicitly use `%<constant>s` to build objects. The factory method `%<method>s` is globally available."
+
+    def_node_matcher :explicit_factory_bot_usage, <<~PATTERN
+      (send (const nil? {:FactoryGirl :FactoryBot}) {#{Helpers::FactoryBotHelper.factory_bot_methods_pattern}} ...)
+    PATTERN
+
+    def on_send(node)
+      explicit_factory_bot_usage(node) do
+        add_offense(node, message: format(MSG, constant: node.receiver.const_name, method: node.method_name)) do |corrector|
+          corrector.replace(node.source_range, node.source.sub(/(?:FactoryGirl|FactoryBot)[.]/, ""))
+        end
+      end
+    end
+
+    def relevant_file?(file)
+      acceptance_or_spec_file?(file) && super
+    end
+  end
+end

data/lib/nucop/cops/no_core_method_overrides.rb

@@ -0,0 +1,31 @@
+module Nucop
+  # This cop looks for core method overrides
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   def blank?
+  #     # ...
+  #   end
+  #
+  #   # good
+  #
+  #   def anything_other_than_blank?
+  #     # ...
+  #   end
+  #
+  class NoCoreMethodOverrides < ::RuboCop::Cop::Base
+    MSG = "Core method overridden".freeze
+
+    def_node_matcher :core_methods, <<~PATTERN
+      (def ${:present? :blank? :empty?} ...)
+    PATTERN
+
+    def on_def(node)
+      core_methods(node) do |method|
+        add_offense(node, message: format(MSG, method: method))
+      end
+    end
+  end
+end

data/lib/nucop/cops/no_wip_specs.rb

@@ -0,0 +1,35 @@
+module Nucop
+  # This cop looks for WIP specs
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   it "tests some stuff", :wip do
+  #     # ...
+  #   end
+  #
+  #   # good
+  #
+  #   it "tests some stuff" do
+  #     # ...
+  #   end
+  #
+  class NoWipSpecs < ::RuboCop::Cop::Base
+    MSG = "WIP spec found".freeze
+
+    def_node_matcher :wip_it_specs_present?, <<~PATTERN
+      (send nil? :it ... (sym :wip))
+    PATTERN
+
+    def_node_matcher :wip_describe_specs_present?, <<~PATTERN
+      (send nil? :describe ... (sym :wip))
+    PATTERN
+
+    def on_send(node)
+      return unless wip_it_specs_present?(node) || wip_describe_specs_present?(node)
+
+      add_offense(node)
+    end
+  end
+end

data/lib/nucop/cops/ordered_hash.rb

@@ -0,0 +1,36 @@
+module Nucop
+  # This cop looks for usages of `ActiveSupport::OrderedHash`
+  #
+  # Hashes in Ruby (since 1.9) enumerate their keys in the order they are
+  # inserted:
+  #
+  # "Hashes enumerate their values in the order that the corresponding keys were inserted."
+  # http://ruby-doc.org/core-2.1.6/Hash.html
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   hash = ActiveSupport::OrderedHash.new
+  #
+  #   # good
+  #
+  #   hash = {}
+  class OrderedHash < ::RuboCop::Cop::Base
+    extend RuboCop::Cop::AutoCorrector
+
+    MSG = "Ruby hashes after 1.9 enumerate keys in order of insertion"
+
+    def_node_matcher :ordered_hash_usage, <<~PATTERN
+      (send (const (const nil? :ActiveSupport) :OrderedHash) :new)
+    PATTERN
+
+    def on_send(node)
+      ordered_hash_usage(node) do
+        add_offense(node, message: MSG) do |corrector|
+          corrector.replace(node.source_range, "{}")
+        end
+      end
+    end
+  end
+end

data/lib/nucop/cops/release_toggles_use_symbols.rb

@@ -0,0 +1,43 @@
+module Nucop
+  # This cop checks that a symbol is used when using a Release Toggle name
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   release_toggle_enabled?("move_out_of_wip_autocomplete")
+  #   release_toggle_enabled_for_any_site?("versioned_production_specification_ui")
+  #   ReleaseToggles.enabled?("test_toggle", site_id: current_user.site_id)
+  #   ReleaseToggles.disabled?("test_toggl"e, site_id: current_user.site_id)
+  #   ReleaseToggles.enable("test_toggle", site_id: current_user.site_id)
+  #   ReleaseToggles.disable!("test_toggle", site_id: current_user.site_id)
+  #
+  #   # good
+  #
+  #   release_toggle_enabled?(:move_out_of_wip_autocomplete)
+  #
+  class ReleaseTogglesUseSymbols < ::RuboCop::Cop::Base
+    extend RuboCop::Cop::AutoCorrector
+
+    MSG = "Use a symbol when referring to a Release Toggle's by name".freeze
+
+    def_node_matcher :test_helper?, <<~PATTERN
+      (send nil? {:release_toggle_enabled? :release_toggle_enabled_for_any_site?} (str _))
+    PATTERN
+
+    def_node_matcher :release_toggles_public_api_method?, <<~PATTERN
+      (send (const nil? :ReleaseToggles) {:enabled? :disabled? :enable :disable :enable! :disable!} (str _) ...)
+    PATTERN
+
+    def on_send(node)
+      test_helper?(node) { add_offense(node, message: MSG, location: node.children[2].loc.expression) }
+      release_toggles_public_api_method?(node) do
+        add_offense(node, message: MSG, location: node.children[2].loc.expression) do |corrector|
+          toggle_name = node.children[2].value
+
+          corrector.replace(node.children[2].source_range, ":#{toggle_name}")
+        end
+      end
+    end
+  end
+end

data/lib/nucop/cops/shadowing_factory_bot_creation_methods.rb

@@ -0,0 +1,37 @@
+module Nucop
+  # This cop looks for defined methods in spec files that would shadow methods defined in FactoryBot::Syntax::Methods.
+  # See FactoryBotHelper::FACTORY_BOT_METHODS constant for a complete list.
+  #
+  # @example
+  #
+  #   # bad
+  #
+  #   def create(args)
+  #     ...
+  #   end
+  #
+  #   # good
+  #
+  #   def create_transfer_pallet(args)
+  #     ...
+  #   end
+  class ShadowingFactoryBotCreationMethods < ::RuboCop::Cop::Base
+    include Helpers::FilePathHelper
+
+    MSG = "Method `%<method>s` shadows a FactoryBot method. Please rename it to be more specific."
+
+    def_node_matcher :factory_bot_methods, <<~PATTERN
+      (def ${#{Helpers::FactoryBotHelper.factory_bot_methods_pattern}} ...)
+    PATTERN
+
+    def on_def(node)
+      factory_bot_methods(node) do |method|
+        add_offense(node, message: format(MSG, method: method))
+      end
+    end
+
+    def relevant_file?(file)
+      acceptance_or_spec_file?(file) && super
+    end
+  end
+end

data/lib/nucop/helpers/factory_bot_helper.rb

@@ -0,0 +1,30 @@
+module Nucop
+  module Helpers
+    module FactoryBotHelper
+      module_function
+
+      FACTORY_BOT_METHODS = [
+        :build,
+        :build_list,
+        :build_pair,
+
+        :create,
+        :create_list,
+        :create_pair,
+
+        :build_stubbed,
+        :build_stubbed_list,
+        :build_stubbed_pair,
+
+        :attributes_for,
+        :attributes_for_list,
+        :attributes_for_pair
+      ]
+      private_constant :FACTORY_BOT_METHODS
+
+      def factory_bot_methods_pattern
+        FACTORY_BOT_METHODS.map(&:inspect).join(" ")
+      end
+    end
+  end
+end

data/lib/nucop/helpers/file_path_helper.rb

@@ -0,0 +1,13 @@
+module Nucop
+  module Helpers
+    module FilePathHelper
+      def acceptance_or_spec_file?(filepath)
+        Pathname.new(filepath).fnmatch?(File.join("**", "{spec,acceptance}", "**"), File::FNM_EXTGLOB)
+      end
+
+      def support_file?(filepath)
+        Pathname.new(filepath).fnmatch?(File.join("**", "support", "**"), File::FNM_EXTGLOB)
+      end
+    end
+  end
+end

data/lib/nucop/version.rb

@@ -0,0 +1,3 @@
+module Nucop
+  VERSION = "1.0.0"
+end

data/lib/nucop.rb

@@ -0,0 +1,9 @@
+require "nucop/version"
+
+require "rubocop"
+
+Dir[File.join(__dir__, "nucop/helpers/**/*.rb")].each { |f| require f }
+Dir[File.join(__dir__, "nucop/cops/**/*.rb")].each { |f| require f }
+
+module Nucop
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: nucop-cops
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Schweier
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+email:
+- jasons@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nucop.rb
+- lib/nucop/cops/explicit_factory_bot_usage.rb
+- lib/nucop/cops/no_core_method_overrides.rb
+- lib/nucop/cops/no_wip_specs.rb
+- lib/nucop/cops/ordered_hash.rb
+- lib/nucop/cops/release_toggles_use_symbols.rb
+- lib/nucop/cops/shadowing_factory_bot_creation_methods.rb
+- lib/nucop/helpers/factory_bot_helper.rb
+- lib/nucop/helpers/file_path_helper.rb
+- lib/nucop/version.rb
+homepage: https://rubygems.org/gems/nucop-cops
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nulogy/nucop-cops
+  changelog_uri: https://github.com/nulogy/nucop-cops/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/nulogy/nucop-cops/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.4
+specification_version: 4
+summary: Custom RuboCop cops for Nulogy's Ruby projects.
+test_files: []