panolint-rails 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eabecb526f72e01fc078002d2ffee5ce0cdda1d8e19c294fe4267a36d622dae0
+  data.tar.gz: a0a46683cf950c7ac987de944789e77a9caf3eac272a85afb9d06096ce6f3bcd
+SHA512:
+  metadata.gz: e4e211b1d8dbbac468238e27bfab59ed8d238fee82b2d54a9d79291da1e5d072356e5038dc9e206488d82b4955747567594013b64867e1c05ea944528b7afdb2
+  data.tar.gz: b4a07d9512749ac2283227d3955234e41c2bc85270ee0cac5a659b7198b2de648dca8c40e45104ea9a6a6467afa582a386d349f86049cc92065e927ef5148c37

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "00:00"
+    timezone: America/New_York
+  open-pull-requests-limit: 99
+  labels:
+  - dependencies
+  allow:
+  - dependency-type: direct

data/.github/workflows/dependabot-prs.yml

@@ -0,0 +1,41 @@
+name: Dependabot Pull Request
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, labeled]
+jobs:
+  build:
+    if: startsWith(github.head_ref, 'dependabot/')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get unique committers
+        id: unique-committers
+        run: echo "::set-output name=committers::$(gh pr view $PR_URL --json commits --jq '[.commits.[] | .authors.[] | .login] | unique')"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.PANORAMA_BOT_RW_TOKEN}}
+      # The last step enables auto-merge in certain situations, but we don't want dependabots that require
+      # additional work to accidentally get merged before code review so we turn it off here.
+      - name: Disable auto-merge if there are commits from someone other than Dependabot
+        if: steps.unique-committers.outputs.committers != '["dependabot[bot]"]'
+        run: gh pr merge --disable-auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.PANORAMA_BOT_RW_TOKEN}}
+      - name: Approve and merge Dependabot PRs for development dependencies
+        # Auto-merge the PR if either:
+        # a) it has the `development-dependencies` label, which we add for certain
+        #    categories of PRs (see `.github/dependabot.yml`), OR
+        # b) Dependabot has categorized it as a `direct:development` dependency,
+        #    meaning it's in the Gemfile in a `development` or `test` group
+        #
+        # Note that we also do nothing when the PR has already had auto-merge
+        # enabled, to prevent scenarios where this check runs many times (for
+        # instance, because removing `Needs QA` triggers another run, or because
+        # other PRs are merging and causing this to rebase and trigger another
+        # run) and then approves the PR many times, which is confusing and looks
+        # awkward.
+        if: ${{ github.actor == 'dependabot[bot]' && !github.event.pull_request.auto_merge }}
+        run: gh pr merge --auto --merge "$PR_URL" && gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.PANORAMA_BOT_RW_TOKEN}}

data/.github/workflows/tests.yml

@@ -0,0 +1,12 @@
+name: Main
+on: push
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: bundle exec rubocop --config "$(bundle show panolint-ruby)/panolint-ruby-rubocop.yml"

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@panoramaed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem "panolint-ruby", github: "panorama-ed/panolint-ruby", branch: "main"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present Panorama Education
+
+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,54 @@
+# panolint-rails
+
+[![Build Status](https://github.com/panorama-ed/panolint-rails/workflows/Main/badge.svg)](https://github.com/panorama-ed/panolint-rails/actions)
+
+A small gem containing rules for linting Ruby on Rails code at Panorama Education.
+
+This gem inherits RuboCop configuration from [panolint-ruby](https://github.com/panorama-ed/panolint-ruby) so it should be used *in place of* (not in combination with) `panolint-ruby`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem "panolint-rails", git: "https://github.com/panorama-ed/panolint-rails.git", branch: "main"
+```
+
+And then execute:
+
+    $ bundle
+
+**Do not install this gem from RubyGems**, as updates are only pushed to this repo. We have only pushed an initial version to RubyGems to avoid supply chain attacks from malicious squatters.
+
+## Usage
+
+### `Brakeman`
+
+You can use `panolint-rails`'s `brakeman` configuration in your project by pointing the `brakeman` run at the configuration file in this repo:
+
+```
+$ bundle exec brakeman -c "$(bundle show brakeman)/brakeman.yml"
+```
+
+### `RuboCop`
+
+You can use `panolint-rails`'s RuboCop configuration in your project with the following addition to the top of your project's `.rubocop.yml`:
+
+```
+inherit_gem:
+  panolint-rails: panolint-rails-rubocop.yml
+```
+
+This gem uses a gem-specific named file instead of the traditional `.rubocop.yml` due to a [previous issue](https://github.com/rubocop/rubocop/issues/4154#issuecomment-316004878) with RuboCop extensions in VS Code [reading the wrong repository's `.rubocop.yml` file](https://github.com/panorama-ed/panolint/pull/95).
+
+## Contributing
+
+While this gem is intended for internal use by Panorama Education engineers, bug reports and pull requests are welcome on GitHub at https://github.com/panorama-ed/panolint-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `panolint-rails`'s project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/panorama-ed/panolint-rails/blob/master/CODE_OF_CONDUCT.md).

data/brakeman.yml

@@ -0,0 +1,13 @@
+---
+:ensure_latest: true # From brakeman --help: "Fail when Brakeman is outdated"
+:run_all_checks: true # "Run all default and optional checks"
+:branch_limit: -1 # "Limit depth of values in branches (-1 for no limit)"
+
+# The Brakeman wiki says this option "enables deeper data flow analysis by
+# allowing Brakeman to inspect called methods and attempt to determine the
+# return value of the call."
+:interprocedural: true
+:additional_libs_path:
+# This ensures Brakeman is run on all files, not just those in standard Rails
+# directories.
+- .

data/panolint-rails-rubocop.yml

@@ -0,0 +1,25 @@
+# These are the default code conventions for Panorama Rails projects.
+#
+# You can use this in your project's .rubocop.yml with the following at the top:
+#
+#     inherit_gem:
+#       panolint-rails: panolint-rails-rubocop.yml
+#
+# This allows you to selectively override settings in projects.
+
+inherit_gem:
+  panolint-ruby: panolint-ruby-rubocop.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - "db/schema.rb"
+    - "db/migrate/**/*"
+  NewCops: enable
+
+Rails/I18nLocaleTexts:
+  Enabled: false

data/panolint-rails.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "panolint-rails"
+  spec.version       = "0"
+  spec.authors       = ["Amy Lieberman"]
+  spec.email         = ["alieberman@panoramaed.com"]
+
+  spec.summary       = "Rules for linting Rails code at Panorama Education. "\
+                       "Use the latest git commit of this gem instead of the "\
+                       "version pushed to RubyGems."
+  spec.homepage      = "https://github.com/panorama-ed/panolint-rails"
+  spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+
+  spec.add_dependency "brakeman", "5.4.1"
+  spec.add_dependency "rubocop-rails", "2.19.1"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: panolint-rails
+version: !ruby/object:Gem::Version
+  version: '0'
+platform: ruby
+authors:
+- Amy Lieberman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.19.1
+description:
+email:
+- alieberman@panoramaed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/dependabot-prs.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- brakeman.yml
+- panolint-rails-rubocop.yml
+- panolint-rails.gemspec
+homepage: https://github.com/panorama-ed/panolint-rails
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Rules for linting Rails code at Panorama Education. Use the latest git commit
+  of this gem instead of the version pushed to RubyGems.
+test_files: []