gemfilelint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08f43710d45876141d5a462ef860d5d52f3b782af673be0f8cf5bde39ea269bc'
+  data.tar.gz: a81951955e4d2a60b4771ebc45f7adbd9a6150f14de2f34f162497ef7fbb2d00
+SHA512:
+  metadata.gz: fb7f7ebdd672f505a5a1dbb91cc36dfc2ddafabfa470101931b05253f51a3e33df82175a5f0c06789d93455aefdce3cff1cbc839178b0a27f2c9c83354442237
+  data.tar.gz: 6aac9050ccf83d666dc9f640e0f0bc95fbd56ecec061d90f7da8ef2b8ae958406ec41b4e7bcc3de3df787046e68c596750225895fd86f96dc7ae181ca37c6578

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Main
+on: push
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - run: bundle config path vendor/bundle
+    - run: bundle install --jobs 4 --retry 3
+    - run: bundle exec rubocop --parallel
+    - run: bundle exec rake test
+      env:
+        CI: true

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.mergify.yml

@@ -0,0 +1,10 @@
+pull_request_rules:
+  - name: Automatically merge dependencies
+    conditions:
+      - base=master
+      - label=dependencies
+      - status-success=CI
+    actions:
+      merge:
+        strict: true
+      delete_head_branch: {}

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.7
+  Exclude:
+  - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StructInheritance:
+  Enabled: false

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 kevin.deisz@gmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    gemfilelint (0.1.0)
+      bundler
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.80.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, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gemfilelint!
+  minitest
+  rake
+  rubocop
+
+BUNDLED WITH
+   2.1.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Kevin Deisz
+
+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,41 @@
+# Gemfile lint
+
+Lint your Gemfile! This will find common spelling mistakes in gems and remote sources so that you don't accidentally download code from places that you don't mean to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemfilelint'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gemfilelint
+
+## Usage
+
+Run the `gemfilelint` executable either in the root of your repository that contains a Gemfile or specify a path to one.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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 [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/gemfilelint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kddeisz/gemfilelint/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Gemfilelint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kddeisz/gemfilelint/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gemfilelint'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/load-pg-dump

@@ -0,0 +1,98 @@
+#!/bin/sh
+
+##############################################################################
+# This script will download the most recently weekly dump listed on
+# https://rubygems.org/pages/data and load it into a postgresql database.
+#
+# Assumptions:
+#
+# 1) a 'postgres' user exists your postgresql instance
+#    The dump script explicitly assigns ownership to the 'postgres' user, and
+#    so the 'postgres' user should exist
+# 2) the user you pass with the -u option is a postgres super user
+#
+# Notes:
+#
+#  * This script will drop and create the database, so buyer beware.
+#
+##############################################################################
+
+# variables
+public_tar=
+pg_database=rubygems
+pg_user=postgres
+download=false
+
+base_url="https://s3-us-west-2.amazonaws.com/rubygems-dumps/"
+prefix="production/public_postgresql"
+
+## Usage info
+show_help() {
+  cat << EOF
+Usage: ${0##*/} [-h] [-c] [-d DATABASE] [-u USER] FILE
+Load a rubygems.org postgresql dump into a datatbase.
+    -h          display this help and exit
+    -c          download the latest file to FILE
+    -d DATABASE load the data into this database (default: rubygems)
+    -u USER     connect to postgresql using this username (default: postgres)
+Example: ./load-pg-dump -d rubygems_development ~/Downloads/public_postgresql.tar
+EOF
+}
+
+OPTIND=1
+while getopts "hcd:u:" opt; do
+    case "$opt" in
+        h)
+            show_help
+            exit 0
+            ;;
+        c)  download=true
+            ;;
+        d)  pg_database=$OPTARG
+            ;;
+        u)  pg_user=$OPTARG
+            ;;
+        '?')
+            show_help >&2
+            exit 1
+            ;;
+    esac
+done
+shift "$((OPTIND-1))" # Shift off the options and optional
+
+public_tar=$1
+if [ -z "$public_tar" ]; then
+  show_help >&2
+  exit 1
+fi
+
+if $download; then
+  key=$(curl -s "${base_url}?prefix=${prefix}" | sed -ne 's/.*<Key>\(.*\)<\/Key>.*/\1/p')
+  latest_url="${base_url}${key}"
+  echo "Downloading ${latest_url} to ${public_tar}"
+  curl --progress-bar "${latest_url}" > ${public_tar}
+fi
+
+printf 'Loading "%s" into database "%s" as user "%s"\n', "$public_tar", "$pg_database", "$pg_user"
+
+echo "Droppping database $pg_database"
+dropdb -U $pg_user $pg_database
+
+echo "Creating database $pg_database"
+createdb -U $pg_user $pg_database
+
+echo "Adding hstore extension"
+psql -q -U $pg_user -d $pg_database -c "CREATE EXTENSION IF NOT EXISTS hstore;"
+
+echo "Loading the data from $public_tar"
+tar xOf "$public_tar" public_postgresql/databases/PostgreSQL.sql.gz | \
+  gunzip -c | \
+  psql --username $pg_user --dbname $pg_database
+
+echo "Extracting the names of the top downloaded gems"
+psql \
+  --username $pg_user \
+  -dbname $pg_database \
+  -c "COPY (SELECT name FROM rubygems INNER JOIN gem_downloads ON rubygems.id = gem_downloads.rubygem_id GROUP BY rubygems.id ORDER BY SUM(count) DESC NULLS LAST LIMIT 1000) TO '$PWD/lib/gems.txt' (format text);"
+
+echo "Done."

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/gemfilelint

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path(File.join('..', 'lib'), __dir__))
+require 'gemfilelint'
+
+exit Gemfilelint.lint(ARGV[0] || 'Gemfile')

data/gemfilelint.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gemfilelint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gemfilelint'
+  spec.version       = Gemfilelint::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['kevin.deisz@gmail.com']
+
+  spec.summary       = 'Lint your Gemfile!'
+  spec.homepage      = 'https://github.com/kddeisz/gemfilelint'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler'
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/gemfilelint.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'bundler'
+require 'bundler/similarity_detector'
+
+require 'gemfilelint/version'
+
+module Gemfilelint
+  module Offenses
+    class Dependency < Struct.new(:name, :suggestions)
+      def to_s
+        <<~ERR
+          Gem \"#{name}\" is possibly misspelled, suggestions:
+          #{suggestions.map { |suggestion| "   * #{suggestion}" }.join("\n")}"
+        ERR
+      end
+    end
+
+    class Remote < Struct.new(:name, :suggestions)
+      def to_s
+        <<~ERR
+          Source \"#{name}\" is possibly misspelled, suggestions:
+          #{suggestions.map { |suggestion| "   * #{suggestion}" }.join("\n")}
+        ERR
+      end
+    end
+  end
+
+  class Linter
+    class SpellChecker
+      attr_reader :detector, :haystack
+
+      def initialize(haystack)
+        @detector = Bundler::SimilarityDetector.new(haystack)
+        @haystack = haystack
+      end
+
+      def correct(needle)
+        return [] if haystack.include?(needle)
+
+        detector.similar_words(needle)
+      end
+    end
+
+    module ANSIColor
+      CODES = { green: 32, magenta: 35 }.freeze
+
+      refine String do
+        def colorize(code)
+          "\033[#{CODES[code]}m#{self}\033[0m"
+        end
+      end
+    end
+
+    using ANSIColor
+
+    attr_reader :dependency_checker, :remote_checker, :logger
+
+    def initialize
+      common_gems = File.read(File.expand_path('gems.txt', __dir__)).split("\n")
+
+      @dependency_checker = SpellChecker.new(common_gems)
+      @remote_checker = SpellChecker.new(['https://rubygems.org/'])
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def lint(path, logger: nil)
+      logger ||= make_logger
+
+      logger.info("Inspecting gemfile at #{path}\n")
+      offenses = []
+
+      each_offense_for(path) do |offense|
+        if offense
+          offenses << offense
+          logger.info('W'.colorize(:magenta))
+        else
+          logger.info('.'.colorize(:green))
+        end
+      end
+
+      logger.info("\n")
+      return 0 if offenses.empty?
+
+      prefix = 'W'.colorize(:magenta)
+      messages = offenses.map { |offense| "#{prefix}: #{offense}\n" }
+      logger.info("\nOffenses:\n\n#{messages.join}\n")
+
+      1
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    def make_logger
+      Logger.new(STDOUT).tap do |logger|
+        logger.level = :info
+        logger.formatter = ->(*, message) { message }
+      end
+    end
+
+    def each_offense_for(path)
+      dsl = Bundler::Dsl.new
+      dsl.eval_gemfile(path)
+
+      # Lol wut, there has got to be a better way to do this
+      source_list = dsl.instance_variable_get(:@sources)
+      rubygems = source_list.instance_variable_get(:@rubygems_aggregate)
+
+      dsl.dependencies.each do |dependency|
+        yield dependency_offense_for(dependency.name)
+      end
+
+      rubygems.remotes.each do |remote|
+        yield remote_offense_for(remote.to_s)
+      end
+    end
+
+    def dependency_offense_for(name)
+      corrections = dependency_checker.correct(name)
+      Offenses::Dependency.new(name, corrections.first(5)) if corrections.any?
+    end
+
+    def remote_offense_for(uri)
+      corrections = remote_checker.correct(uri)
+      Offenses::Remote.new(uri, corrections) if corrections.any?
+    end
+  end
+
+  def self.lint(path, logger: nil)
+    Linter.new.lint(path, logger: logger)
+  end
+end