harri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a94855b52e7d80f6cee4012850ab58e20b9a9432c8c8cd6f86885606ab0696d8
+  data.tar.gz: f963fb0f1e3ffa283bf7fb8721ce6aa4da5783040c6c1772c2326e42d4562ec1
+SHA512:
+  metadata.gz: eea4d8878af6d4c0e661208909eec2450a7aace2c77bc1b32d2e9e6e81e8fd450d4ab1ec09bb478cd16ab3df9ab152397b093de8c2aa2f65ef0a542ce774869a
+  data.tar.gz: 91fac66571b31e73139e8235af2a30d9bbf51269371e8bad9220099d9d5649122a73f9a40955c6b9ab4b41c3d264de22f5e6af6e3608c4e11e2f579d48201b3d

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-04
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in harri.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    harri (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  harri!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 rhizomic
+
+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,50 @@
+# Harri: HAskell Remove Redundant Imports
+
+Do you ever wish GHC would stop harrying you about unused imports and remove
+them for you?
+
+This tool does just that.
+
+## Installation
+
+    $ gem install harri
+
+## Usage
+
+Simply pass a log containing the `STDERR` output from `GHC`, and `harri` will
+auto-strip the unused imports from the affected files:
+
+    $ harri -f ghcid.txt
+
+Note that the files mentioned in the log are considered _relative_ to the 
+location of the log itself.
+
+## 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 the created tag, 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/rhizomic/harri. 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/rhizomic/harri/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 Harri project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/rhizomic/harri/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: %i[test]

data/exe/harri

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(__dir__ + "/../lib")
+
+require "harri"
+require "harri/version"
+
+require "filewatcher"
+require "optparse"
+
+class CLI
+  def self.parse_options(args)
+    options = {}
+
+    option_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: harri -f FILE"
+
+      opts.separator ""
+
+      opts.separator "Example:"
+      opts.separator "  $ harri -f ghcid.txt"
+
+      opts.separator ""
+
+      opts.separator "Options:"
+
+      opts.on("-v", "--version", "Print the version") do |v|
+        puts "Harri v#{Harri::Version::VERSION}"
+        exit
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on("-f", "--file FILE", "The file containing GHC errors") do |file|
+        options[:file] = file
+      end
+    end
+
+    option_parser.parse!(args)
+
+    options
+  end
+end
+
+ARGV << "-h" if ARGV.empty? && $stdin.tty?
+cli_options = CLI.parse_options ARGV
+
+error_dir = File.expand_path(File.dirname(cli_options[:file]))
+error_log = File.read cli_options[:file]
+unused_import_errors = Harri.parse_unused_import_errors_from_log error_log
+
+unused_import_errors.each do |import_info|
+  source_location = File.join error_dir, import_info[:file]
+
+  file_contents = File.read source_location
+  replaced = Harri.remove_unused_imports file_contents, import_info
+  File.write source_location, replaced
+end

data/harri.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/harri/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "harri"
+  spec.version = Harri::Version::VERSION
+  spec.authors = ["rhizomic"]
+
+  spec.summary = "Removes redundant Haskell imports."
+  spec.description = "Harri: HAskell Remove Redundant Imports. A way to get GHC to stop harrying you about them."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/rhizomic/harri"
+  spec.metadata["changelog_uri"] = "https://github.com/rhizomic/harri/blob/master/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/harri/collector.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "./regexes"
+
+module Harri
+  module Collector
+    # This function gathers all of the lines describing an error that involves an
+    # unused import.
+    #
+    # An error involving unused imports could look something like this:
+    #
+    #   src/Module/TypeGenerator/Generate.hs:31:1: error: [-Wunused-imports, -Werror=unused-imports]
+    #       The import of ‘Alpha.Beta.Status’ is redundant
+    #         except perhaps to import instances from ‘Alpha.Beta.Status’
+    #       To import instances alone, use: import Alpha.Beta.Status()
+    #      |
+    #   31 | import Alpha.Beta.Status
+    #      | ^^^^^^^^^^^^^^^^^^^^^^^^
+    #
+    # That will occur when an entire module is redundant. If specific imports
+    # from within a module are redundant, the error could look something like
+    # this:
+    #
+    #   src/Module/TypeGenerator/OtherGenerator.hs:31:1: error: [-Wunused-imports, -Werror=unused-imports]
+    #       The import of ‘RedundantImport,
+    #                      AnotherRedundantImport, unusedFunction’
+    #       from module ‘Alpha.Beta.Status.Types’ is redundant
+    #      |
+    #   31 | import Alpha.Beta.Status.Types ( ImportantImport, RedundantImport, UsedImport, AnotherRedundantImport, unusedFunction,)
+    #      | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    #
+    # Note that the first line always contains the name of the file, the line
+    # number (and column number) where it occurs, and an optional error marker.
+    # What follows is a textual description of the error, followed by a preview
+    # of the source where it occurs. This function will capture all of these
+    # lines.
+    #
+    # For completion's sake, here's an example of an unrelated error:
+    #
+    #   src/Module/TypeGenerator/Generate.hs:712:14: error:
+    #       Not in scope: type constructor or class ‘Foo’
+    #       |
+    #   712 |   doSomething @Foo
+    #       |
+    #
+    # This function will filter out any errors that are not related to unused
+    # imports.
+    def self.gather_unused_import_errors(text)
+      dealing_with_unused_import = false
+      unused_import_errors = []
+      current_error = []
+
+      text.each_line do |line|
+        if is_start_of_an_error? line
+          # We've encountered an error, so add the prior error lines (if there were
+          # any) to our collection.
+          if !current_error.empty?
+            unused_import_errors << current_error
+            current_error = []
+          end
+
+          # Keep track of whether or not we're dealing with an unused import.
+          # This is useful to know if we need to capture this and subsequent lines.
+          dealing_with_unused_import = is_unused_import_error? line
+        end
+
+        # If we're _not_ dealing with an unused import, continue to the next
+        # iteration.
+        next if !dealing_with_unused_import
+
+        # Otherwise, add the line to our current list of error lines.
+        current_error << line
+      end
+
+      # We've processed all of the lines; make sure to add the prior error lines
+      # (if there were any) to our collection.
+      if !current_error.empty?
+        unused_import_errors << current_error
+      end
+
+      unused_import_errors
+    end
+
+    # Determines if the provided line is the beginning of a new error.
+    def self.is_start_of_an_error?(line)
+      line =~ Harri::Regexes::START_ERROR_REGEX
+    end
+
+    # Determines if the provided line is the beginning of an "unused import"
+    # error.
+    def self.is_unused_import_error?(line)
+      line =~ Harri::Regexes::UNUSED_IMPORT_ERROR_REGEX
+    end
+  end
+end

data/lib/harri/parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "./regexes"
+
+module Harri
+  module Parser
+    # Given an "unused import" error stanza, parses the involved filename,
+    # module, and unused imports.
+    def self.parse_unused_import_error(lines)
+      first_line = lines[0]
+      remaining_lines = lines.drop 1
+
+      file = first_line.match(Harri::Regexes::START_ERROR_REGEX)[1]
+
+      error = remaining_lines.map(&:strip).join " "
+
+      redundant_module_match = error.match Harri::Regexes::ENTIRE_MODULE_REDUNDANT_REGEX
+      if redundant_module_match
+        {
+          file: file,
+          module: redundant_module_match[1],
+          imports: []
+        }
+      else
+        redundant_imports_match = error.match Harri::Regexes::REDUNDANT_IMPORTS_WITHIN_MODULE_REGEX
+        {
+          file: file,
+          module: redundant_imports_match[2],
+          imports: redundant_imports_match[1].split(",").map(&:strip)
+        }
+      end
+    end
+  end
+end

data/lib/harri/processor.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "./regexes"
+
+module Harri
+  module Processor
+    # Removes the redundant imports from a string.
+    def self.remove_imports(text, import_info)
+      import_regex = Harri::Regexes.import_declaration_regex import_info[:module]
+      match = text.match import_regex
+
+      return text if !match
+
+      if import_info[:imports].empty?
+        # There are no imports, so the whole module is redundant.
+        text.sub(/^#{Regexp.quote(match[0])}/, "")
+      else
+        # Filter out specific imports within the module.
+        filtered_imports = import_info[:imports].reduce(match[0]) do |result, import|
+          reference_regex = Harri::Regexes.named_reference_regex import
+          result.sub reference_regex, ""
+        end
+        text.sub match[0], filtered_imports
+      end
+    end
+  end
+end

data/lib/harri/regexes.rb

@@ -0,0 +1,60 @@
+module Harri
+  module Regexes
+    # Intended to capture the first line of an error within GHC's output.
+    START_ERROR_REGEX = %r{
+      (.*\.hs)  # filename
+      :         # literal colon
+      \d+       # line number
+      :         # literal colon
+      \d+       # column number
+      :         # literal colon
+      \s        # space
+      error:.*  # literal "error:" with possible marker
+    }x
+
+    # Intended to capture an unused import error within GHC's output.
+    UNUSED_IMPORT_ERROR_REGEX = %r{
+      .*\.hs                                         # filename
+      :                                              # literal colon
+      \d+                                            # line number
+      :                                              # literal colon
+      \d+                                            # column number
+      :                                              # literal colon
+      \s                                             # space
+      error:                                         # literal "error:"
+      \s                                             # space
+      \[-Wunused-imports,\s-Werror=unused-imports\]  # literal "[-Wunused-imports, -Werror=unused-imports]"
+    }x
+
+    # Intended to capture the scenario when an entire module is redundant.
+    ENTIRE_MODULE_REDUNDANT_REGEX = /The import of ‘(.+)’ is redundant except.*/
+
+    # Intended to capture the scenario when specific imports within a module are redundant.
+    REDUNDANT_IMPORTS_WITHIN_MODULE_REGEX = /The import of ‘(.+)’ from module ‘(.+)’ is redundant.*/
+
+    # Intended to capture a full import declaration within a Haskell module.
+    def self.import_declaration_regex(module_name)
+      %r{
+        ^import                           # literal "import"
+        \s+                               # one or more spaces
+        (?:qualified\s*)?                 # zero or one literal "qualified" with optional space afterwards
+        #{Regexp.quote module_name}       # match "import `module_name`" at start of line
+        \s*                               # optional space
+        (?:qualified\s*)?                 # zero or one literal "qualified" with optional space afterwards
+        (?:as\s+[A-Z]+[a-zA-Z0-9.]*\s*)?  # zero or one literal "as `module_name`" with optional space afterwards
+        (?:hiding\s*)?                    # zero or one literal "hiding" with optional space afterwards
+        (?:(\((?>[^)(]+|\g<1>)*\)))?      # zero or one list of imports (see https://stackoverflow.com/a/35271017)
+        \n?                               # zero or one linebreak
+      }x
+    end
+
+    # Intended to capture a named reference within an import declaration.
+    def self.named_reference_regex(reference)
+      %r{
+        \b#{Regexp.quote reference}\b  # match "`reference`" exactly as a single word
+        (?:\s*,?)?                     # zero or one instances of optional space followed by zero or one comma
+        \s*                            # optional space
+      }x
+    end
+  end
+end

data/lib/harri/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Harri
+  module Version
+    VERSION = "0.1.0"
+  end
+end

data/lib/harri.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "harri/collector"
+require_relative "harri/parser"
+require_relative "harri/processor"
+require_relative "harri/version"
+
+module Harri
+  class Error < StandardError; end
+
+  # Parses the unused import errors from a log. This will return something
+  # that looks like this:
+  #
+  # ```
+  #   [
+  #     {
+  #       file:    # the filename where the error is occurring
+  #       module:  # the involved module name
+  #       imports: # the list of unused imports (if empty, the entire module is
+  #                  redundant)
+  #     }
+  #   ]
+  # ```
+  def self.parse_unused_import_errors_from_log(log_contents)
+    errors = Harri::Collector.gather_unused_import_errors log_contents
+    errors.map do |error|
+      Harri::Parser.parse_unused_import_error error
+    end
+  end
+
+  # Removes the redundant imports from a string.
+  def self.remove_unused_imports(text, import_info)
+    Harri::Processor.remove_imports text, import_info
+  end
+end

data/sig/harri.rbs

@@ -0,0 +1,4 @@
+module Harri
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: harri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rhizomic
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-14 00:00:00.000000000 Z
+dependencies: []
+description: 'Harri: HAskell Remove Redundant Imports. A way to get GHC to stop harrying
+  you about them.'
+email:
+executables:
+- harri
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/harri
+- harri.gemspec
+- lib/harri.rb
+- lib/harri/collector.rb
+- lib/harri/parser.rb
+- lib/harri/processor.rb
+- lib/harri/regexes.rb
+- lib/harri/version.rb
+- sig/harri.rbs
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rhizomic/harri
+  changelog_uri: https://github.com/rhizomic/harri/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Removes redundant Haskell imports.
+test_files: []