rubocop-highlands 1.0.0

data/spec/rubocop/cop/highlands/simple_unless_spec.rb

@@ -0,0 +1,36 @@
+describe RuboCop::Cop::Highlands::SimpleUnless do
+  subject(:cop) { described_class.new }
+
+  it 'rejects unless with multiple conditionals' do
+    source = [
+      'unless boolean_condition || another_method',
+      '  return true',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'allows if with multiple conditionals' do
+    source = [
+      'if boolean_condition || another_method',
+      '  return true',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows with modifier if operator conditional' do
+    source = [
+      'unless boolean_condition',
+      '  return true',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/highlands/spec_constant_assignment_spec.rb

@@ -0,0 +1,80 @@
+describe RuboCop::Cop::Highlands::SpecConstantAssignment do
+  subject(:cop) { described_class.new }
+
+  it 'rejects constant definition inside of a describe block' do
+    source = [
+      'describe Someclass do',
+      '  CONSTANT = 5',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'allows constant defined inside of a module' do
+    source = [
+      'module Someclass',
+      '  CONSTANT = 5',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows constant defined in global space' do
+    source = [
+      'CONSTANT = 5',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'rejects constant assignment inside a before block' do
+    source = [
+      'describe Someclass do',
+      '  before { CONSTANT = 5 }',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'rejects namespaced constant assignment inside a before block' do
+    source = [
+      'describe Someclass do',
+      '  before { MyModule::CONSTANT = 5 }',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'rejects constant assignment inside it block' do
+    source = [
+      'describe Someclass do',
+      '  it "tests stuff" do',
+      '    CONSTANT = 5',
+      '  end',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'allows let statements that do not assign constants' do
+    source = [
+      'describe Someclass do',
+      '  let(:constant) { 5 }',
+      'end',
+    ].join("\n")
+
+    inspect_source(source)
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/highlands/unsafe_yaml_marshal_spec.rb

@@ -0,0 +1,50 @@
+describe RuboCop::Cop::Highlands::UnsafeYamlMarshal do
+  subject(:cop) { described_class.new }
+
+  context 'send' do
+    it 'rejects YAML.load' do
+      source = [
+        'def some_method(a)',
+        '  YAML.load(a)',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.message).to match(/`safe_load`, `parse`, `parse_file`/)
+    end
+
+    it 'rejects Psych.load' do
+      source = [
+        'def some_method(a)',
+        '  Psych.load(a)',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.message).to match(/`safe_load`, `parse`, `parse_file`/)
+    end
+
+    it 'accepts YAML.safe_load' do
+      source = [
+        'def some_method(a)',
+        '  YAML.safe_load(a)',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses.size).to eql(0)
+    end
+
+    it 'rejects on Marshal.load' do
+      source = [
+        'def some_method(a)',
+        '  Marshal.load(a)',
+        'end',
+      ].join("\n")
+      inspect_source(source)
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.message).to match(
+        /`Marshal.load` on untrusted input can lead to remote code execution/
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubocop'
+require 'rubocop/rspec/support'
+require 'pry'
+
+module SpecHelper
+  ROOT = Pathname.new(__FILE__).parent.freeze
+end
+
+# Load in Rubocop cops
+require File.expand_path('lib/rubocop-highlands')
+
+spec_helper_glob = File.expand_path('{support,shared}/*.rb', SpecHelper::ROOT)
+Dir.glob(spec_helper_glob).map(&method(:require))
+
+RSpec.configure do |config|
+  config.order = :random
+
+  # Define spec metadata for all rspec cop spec files
+  cop_specs = 'spec/rubocop/cop/rspec/'
+  config.define_derived_metadata(file_path: /\b#{cop_specs}/) do |metadata|
+    # Attach metadata that signals the specified code is for an RSpec only cop
+    metadata[:rspec_cop] = true
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect # Disable `should`
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect # Disable `should_receive` and `stub`
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-highlands
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Church of the Highlands - Digital Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |2
+      A plugin for RuboCop code style enforcing & linting tool. It includes Rubocop configuration
+      used at Church of the Highlands and a few custom rules that have caused internal issues at
+      Church of the Highlands but are not supported by core Rubocop.
+email:
+- info@churchofthehighlands.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- config/default.yml
+- config/rubocop-bundler.yml
+- config/rubocop-gemspec.yml
+- config/rubocop-highlands.yml
+- config/rubocop-layout.yml
+- config/rubocop-lint.yml
+- config/rubocop-metrics.yml
+- config/rubocop-naming.yml
+- config/rubocop-performance.yml
+- config/rubocop-rails.yml
+- config/rubocop-rspec.yml
+- config/rubocop-security.yml
+- config/rubocop-style.yml
+- lib/rubocop-highlands.rb
+- lib/rubocop/cop/highlands/class_name.rb
+- lib/rubocop/cop/highlands/class_or_module_declared_in_wrong_file.rb
+- lib/rubocop/cop/highlands/const_assigned_in_wrong_file.rb
+- lib/rubocop/cop/highlands/continuation_slash.rb
+- lib/rubocop/cop/highlands/default_scope.rb
+- lib/rubocop/cop/highlands/factory_attr_references_class.rb
+- lib/rubocop/cop/highlands/factory_class_use_string.rb
+- lib/rubocop/cop/highlands/mass_assignment_accessible_modifier.rb
+- lib/rubocop/cop/highlands/module_method_in_wrong_file.rb
+- lib/rubocop/cop/highlands/no_timeout.rb
+- lib/rubocop/cop/highlands/opt_arg_parameters.rb
+- lib/rubocop/cop/highlands/phrase_bundle_keys.rb
+- lib/rubocop/cop/highlands/risky_activerecord_invocation.rb
+- lib/rubocop/cop/highlands/rspec_describe_or_context_under_namespace.rb
+- lib/rubocop/cop/highlands/rspec_environment_modification.rb
+- lib/rubocop/cop/highlands/simple_modifier_conditional.rb
+- lib/rubocop/cop/highlands/simple_unless.rb
+- lib/rubocop/cop/highlands/spec_constant_assignment.rb
+- lib/rubocop/cop/highlands/unsafe_yaml_marshal.rb
+- lib/rubocop/highlands.rb
+- lib/rubocop/highlands/inflections.rb
+- lib/rubocop/highlands/inject.rb
+- lib/rubocop/highlands/rails_autoloading.rb
+- lib/rubocop/highlands/version.rb
+- rubocop-highlands.gemspec
+- spec/rubocop/cop/highlands/class_name_spec.rb
+- spec/rubocop/cop/highlands/class_or_module_declared_in_wrong_file_spec.rb
+- spec/rubocop/cop/highlands/const_assigned_in_wrong_file_spec.rb
+- spec/rubocop/cop/highlands/continuation_slash_spec.rb
+- spec/rubocop/cop/highlands/default_scope_spec.rb
+- spec/rubocop/cop/highlands/factory_attr_references_class_spec.rb
+- spec/rubocop/cop/highlands/factory_class_use_string_spec.rb
+- spec/rubocop/cop/highlands/mass_assignment_accessible_modifier_spec.rb
+- spec/rubocop/cop/highlands/module_method_in_wrong_file_spec.rb
+- spec/rubocop/cop/highlands/no_timeout_spec.rb
+- spec/rubocop/cop/highlands/opt_arg_parameter_spec.rb
+- spec/rubocop/cop/highlands/phrase_bundle_keys_spec.rb
+- spec/rubocop/cop/highlands/risky_activerecord_invocation_spec.rb
+- spec/rubocop/cop/highlands/rspec_describe_or_context_under_namespace_spec.rb
+- spec/rubocop/cop/highlands/rspec_environment_modification_spec.rb
+- spec/rubocop/cop/highlands/simple_modifier_conditional_spec.rb
+- spec/rubocop/cop/highlands/simple_unless_spec.rb
+- spec/rubocop/cop/highlands/spec_constant_assignment_spec.rb
+- spec/rubocop/cop/highlands/unsafe_yaml_marshal_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/highlands/ruby
+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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Custom code style checking for Church of the Highlands.
+test_files: []