angellist-style 1.0.2

data/.ruby-version

@@ -0,0 +1 @@
+2.4.5

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in angellist-style.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    angellist-style (1.0.2)
+      activesupport (= 5.1.7)
+      rubocop
+      rubocop-rails
+      rubocop-rspec
+      rubocop-thread_safety
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    rubocop-thread_safety (0.3.4)
+      rubocop (>= 0.51.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  angellist-style!
+  bundler
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/README.adoc

@@ -0,0 +1,154 @@
+:toc:
+
+= `angellist-style`
+
+image:https://github.com/venturehacks/angellist-style/workflows/Run%20RSpecs/badge.svg[link="https://github.com/venturehacks/angellist-style/actions?query=workflow%3A%22Run+RSpecs%22"]
+image:https://badge.fury.io/rb/angellist-style.svg["Gem Version", link="https://badge.fury.io/rb/angellist-style"]
+
+This gem encapsulates linter rules for https://docs.rubocop.org/en/stable/[rubocop] that can be applied to any Ruby application or service within AngelList stack. It comes with a multiple config files which deactivate some of RuboCop's features. It is meant as a less restrictive foundation that you can use directly or base your style discussions on.
+
+IMPORTANT: The gems' ruleset also loads the https://relaxed.ruby.style/[relaxed ruby style] guide version 2.5, saved into a local file `.rubocop_relaxed.yml`.
+
+== Public Service Announcement
+
+=== The Merits of Linting
+
+image:https://thumbs.gfycat.com/CheerfulAbandonedAmethystsunbird-size_restricted.gif[width=335, title="Developers, Developers, Developers!", border="1"]
+
+The debate is over: automatic formatters and linters have won, period. You can argue with a bus or a mountain, but you won't win that argument. Same here.
+
+Please use rubocop to auto-correct your PRs.
+
+ * It's good for you,
+ * It's good for other developers who will be reading your code,
+ * It's good for the business, and
+ * It's good for the tests.
+
+=== Challenging the Status Quo
+
+There are many scenarios where you may disagree with a given rule, either in general, or in a specific context.
+
+Here are your choices:
+
+. For in-place overrides that only happen once or twice, use in-line comments to disable and immediately re-enable the rule:
++
+[source,ruby]
+----
+# lib/path/to-my-file.rb
+# rubocop: disable Metrics/MethodLength
+def very_long_method
+  # very long body [snip]
+end
+# rubocop: enable Metrics/MethodLength
+----
++
+. For per-file or folder rule overrides, add them to your local `.rubocop.yml`:
++
+[source,yaml]
+----
+# .rubocop.yml
+Metrics/MethodLength:
+  Exclude:
+    - lib/path/to-my-file.rb
+----
++
+. Add an entire rule overide into your local `.rubocop.yml` file:
++
+[source,yaml]
+----
+# .rubocop.yml
+Metrics/MethodLength:
+  Exclude:
+    - lib/path/to-my-file.rb
+----
++
+. Finally, if you want to propose a global change with one or more rules, dependencies, or exclusions, add your change to the appropriate file under `config/`, submit a pull request, and then announce your proposal and the PR in the appropriate Slack channel (you might want to create a poll). Once you are done receiving the feedback — move forward appropriately.
+
+== Scope
+
+This gem is released as a public ruby gem (available at https://rubygems.org/gems/angellist-style[rubygems]) for ease of deployment.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'angellist-style'
+----
+
+And then execute:
+
+ $ bundle install
+
+Alternatively, run:
+
+ $ gem install angellist-style -N
+
+== Usage
+
+To use the styles contained in this gem, add this to your `.rubocop.yml`:
+
+[source,yaml]
+----
+inherit_gem:
+  angellist-style:
+    - .rubocop.yml
+
+# Local overrides.
+Namespace/Rule1:
+  Enabled: false
+
+Namespace/Rule2:
+  Enabled: false
+
+# ... etc ....
+----
+
+=== Applying Partial Rulesets
+
+While not recommended, you can load the rule overrides only for certain Rubocop top-level categories, which are all grouped in YAML files under the `config/` folder.
+
+If you inspect the file `.rubocop_angellist.yml`, you'll see the full list of rule files that is being included.
+
+Here we show a version you'd specify in your project's `.rubocop.yml`.  If you prefer not to apply some of the categories, just delete the corresponding line that you do not want to include:
+
+[source,yaml]
+----
+inherit_gem:
+angellist-style:
+- .rubocop_relaxed.yml
+- config/require.yml
+- config/all_cops.yml
+- config/layout.yml
+- config/lint.yml
+- config/metrics.yml
+- config/naming.yml
+- config/rails.yml
+- config/rspec.yml
+- config/security.yml
+- config/style.yml
+----
+
+=== Generating a TODO File
+
+Rubocop can generate a local "TODO" file, which you can check-in — *this alllows you to run rubocop on CI and have it pass all the legacy code, but fail any new code that does not satisfy the linter.*
+
+[source, bash]
+$ bundle exec rubocop --auto-gen-config
+
+=== Building the Gem
+
+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.
+
+Gem management is provided by Rake tasks:
+
+* To install this gem onto your local machine, run `bundle exec rake install`.
+
+* If you have not yet authenticated with rubygems.org, make sure to create an account, and protect it with the MFA. Then
+
+* 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 tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/venturehacks/angellist-style.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/angellist-style.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/angellist/style/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "angellist-style"
+  spec.version       = AngelList::Style::VERSION
+  spec.authors       = ["Konstantin Gredeskoul", "AngelList Developers"]
+  spec.email         = ["kigster@gmail.com", "dev@angel.co"]
+
+  spec.summary       = 'Contains rubocop style decisions to be used across all Ruby projects.'
+  spec.description   = 'Contains rubocop style decisions to be used across all Ruby projects.'
+  spec.homepage      = "https://github.com/venturehacks/angellist-style"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/venturehacks/angellist-style/tree/master/CHANGELOG.adoc"
+
+  # 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(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '5.1.7'
+  spec.add_dependency 'rubocop'
+  spec.add_dependency 'rubocop-rails'
+  spec.add_dependency 'rubocop-rspec'
+  spec.add_dependency 'rubocop-thread_safety'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "angellist/style"
+
+# 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/all_cops.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRailsVersion: 5.1.71
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - app/views/**/*
+    - script/**/*
+    - vendor/**/*
+    - "**/node_modules/**/*"
+    - node-server/**/*
+    - tmp/**/*

data/config/layout.yml

@@ -0,0 +1,11 @@
+Layout/LeadingCommentSpace:
+  Exclude:
+    - spec/
+
+Layout/LineLength:
+  Max: 160
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+

data/config/lint.yml

@@ -0,0 +1,24 @@
+#    when ...
+#      # noop
+#    when ...
+# is ok to do
+Lint/EmptyWhen:
+  Enabled: false
+
+# Cop disables would require an re-enable - usually those are not needed b/c of scope or file end.
+# Enforcing them creates a lot of noise in the codebase
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+
+# We should always inherit from StandardError, not from Exception.
+#   In those cases we can disable this rule locally
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+# This breaks for us with Psych
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true

data/config/metrics.yml

@@ -0,0 +1,32 @@
+# Complexity Score Rating: from 15 to 50
+Metrics/AbcSize:
+  Max: 50
+
+# 'Block has too many lines'
+Metrics/BlockLength:
+  Exclude:
+    - "**/*.gemspec"
+    - "**/Gemfile"
+    - spec
+    - test
+    - app/controllers
+
+# 'Class definition is too long'
+Metrics/ClassLength:
+  Enabled: false
+
+# 'Method has too many lines' from 10 to 50
+Metrics/MethodLength:
+  Max: 50
+
+# 'Module has too many lines' from 100 to 500
+Metrics/ModuleLength:
+  Max: 250
+
+# Number of linearly independent paths through a method, 6 to 20
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+# From 7 to 20
+Metrics/PerceivedComplexity:
+  Max: 20

data/config/naming.yml

@@ -0,0 +1,28 @@
+# @andreasklinger: is_foobar is fine in graphql types - `?` does not work
+#   Normally we'd use `Exclude:\n\t- app/graphql/` but unfortunately for some reason
+#   the `Exclude` is ignored. Hence disabled for now.
+Naming/PredicateName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/angellist-style.rb
+
+# some_var_1 is an ok name
+Naming/VariableNumber:
+  Enabled: false
+
+# Fundraising uses `fc` as very common variable name
+Naming/MethodParameterName:
+  AllowedNames:
+    - io
+    - id
+    - to
+    - by
+    - 'on'
+    - in
+    - at
+    - ip
+    - db # --- until here defaults
+    - fc # needed by Fundraising
+    - jp # common name for job pairing

data/config/rails.yml

@@ -0,0 +1,42 @@
+Rails:
+  Enabled: true
+
+Rails/DynamicFindBy:
+  Whitelist:
+    - find_by_sql
+    - find_by_sql_with_read_from_replica
+    - find_by_sql_without_read_from_replica
+    - find_by_hash # See if we can get rid of these ones
+    - find_by_city
+    - find_by_slug
+    - find_by_username
+    - find_by_username!
+    - find_by_usernames
+    - find_by_usernames!
+    - find by_any_company_name
+    - find_by_domain
+    - find_by_token
+    - find_by_company_name
+    - find_by_name
+    - find_by_name_prefix_search
+    - find_by_any_email
+    - find_by_id
+    - find_by_encoded_id
+    - find_by_url
+    - find_by_startup_id
+    - find_by_lead_id
+    - find_by_target_company_id
+    - find_by_email_or_user
+    - find_by_any_company_name
+
+# @andreasklinger: html_safe is fine - we just have to be careful when using it.
+Rails/OutputSafety:
+  Enabled: false
+
+# Currently we have no timezone set in the application.
+# We need to fix this before we can enforce this rule
+Rails/TimeZone:
+  Enabled: false
+
+Rails/ActiveRecordOverride:
+  Enabled: false