guard-codespell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7a0af7ae61248ca56109551b7278c033228e23862d3889d1963e5cee801a592
+  data.tar.gz: dc5bacdaddc4a71ce51c18611c8da4b77318fbaee078e1bbca5bb08f43573cde
+SHA512:
+  metadata.gz: 1ec1dfccf2ee53e1f232b60a8f164d2c0e1b27a8f895a0f8dcd993facb7d18709a2dbcb3e92899dfc009515d3114699702b4bfdac0c56e56094f56a76d316b9e
+  data.tar.gz: '052190ab445dc4b81fe9bf04b4e31aefc671100efd49a65b03d43bb0109e64295bcd570df3fe42a4281eff1c505823b5b6828c3e7d5371d4179ff43b3e994693'

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - Initial release - 2021-12-04
+
+In this first release, we have a basic implementation of codespell in a guard environment. 
+
+The only available option for this version is to set the path to a [codespell config file](https://github.com/codespell-project/codespell#using-a-config-file) for the plugin to set the correct usage of codespell. 

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 at guillaume.loubier@hooktstudios.com. 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,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in guard-codespell.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+
+group :development do
+  gem "guard-compat", require: false
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Guillaume Loubier
+
+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 @@
+# guard::codespell
+
+**guard-codespell** helps in keeping your code typo free by running [codespell](https://github.com/codespell-project/codespell) when files are modified
+
+## Installation
+
+Please make sure to have [Guard](https://github.com/guard/guard) and [codespell](https://github.com/codespell-project/codespell) installed before you start.
+
+Add `guard-codespell` to your `Gemfile`.
+
+```ruby
+group :development do
+  gem 'guard-codespell'
+end
+```
+
+and then execute:
+
+```sh
+$ bundle install
+```
+## Usage
+
+See guard documentation for how to [add a guard plugin](https://github.com/guard/guard#add-guard-plugins) and [how to use guard](https://github.com/guard/guard#usage).
+
+## Configuration
+
+Some configuration options are available to use with guard-codespell.
+
+| Option | Type | Description |
+| ----- | ----- | ----- |
+| `all_on_start` | Boolean | Run codespell when starting guard |
+| `config` | String | Path to a [codespell config file](https://github.com/codespell-project/codespell#using-a-config-file) | 
+| `debug` | Boolean | Show the codespell command that is used when guard-codespell runs |
+| `only_git_changes` | Boolean | Only run codespell on files tracked by git (the result of `git status --porcelain` is used to create the list of files to check for errors. | 
+
+Here's an example on how to use those options in your Guardfile
+
+```ruby
+guard :codespell, config: ".codespellrc", debug: true, only_git_changes: true do
+end 
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hooktstudios/guard-codespell. 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/hooktstudios/guard-codespell/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 Guard::Codespell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hooktstudios/guard-codespell/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "guard/codespell"
+
+# 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/guard-codespell.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/guard/codespell/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-codespell"
+  spec.version       = Guard::CodespellVersion::VERSION
+  spec.authors       = ["Guillaume Loubier"]
+  spec.email         = ["guillaume.loubier@hooktstudios.com"]
+
+  spec.summary       = "Guard plugin for codespell"
+  spec.description   = "Guard::Codespell uses codespell to automatically look for typos in your codebase."
+  spec.homepage      = "https://github.com/hooktstudios/guard-codespell"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hooktstudios/guard-codespell"
+  spec.metadata["changelog_uri"] = "https://github.com/hooktstudios/guard-codespell/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "guard", "~> 2.0"
+  spec.add_runtime_dependency "guard-compat", "~> 1.1"
+end

data/lib/guard/codespell/version.rb

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

data/lib/guard/codespell.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "guard/compat/plugin"
+
+module Guard
+  # Service that runs the codespell tool inside guard.
+  # Based on an example from the guard documentation https://github.com/guard/guard/wiki/Create-a-guard
+  class Codespell < Plugin
+    attr_reader :options, :codespell
+
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    def initialize(options = {})
+      super
+      @codespell = codespell_installed?
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    def start
+      run_all if options[:all_on_start]
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    def run_all
+      return warn_codespell_missing unless codespell
+      return run_codespell(changed_files) if options[:only_git_changes]
+
+      run_codespell
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    def run_on_additions(paths)
+      return warn_codespell_missing unless codespell
+
+      run_codespell(paths)
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    def run_on_modifications(paths)
+      return warn_codespell_missing unless codespell
+
+      run_codespell(paths)
+    end
+
+    private
+
+    def run_codespell(paths = [])
+      Guard::Compat::UI.info "Looking for typos with codespell"
+      cmd = build_command(paths)
+      Guard::Compat::UI.info "... running #{cmd}" if options[:debug]
+      system(cmd)
+      Guard::Compat::UI.info "Codespell check finished"
+    end
+
+    def build_command(paths)
+      cmd = []
+      cmd << "codespell"
+      cmd << "--config=#{options[:config]}" if options[:config]
+      cmd << paths.join(" ") if paths.any?
+
+      cmd.join(" ")
+    end
+
+    def codespell_installed?
+      # Based on this script to check if an executable is present in PATH: https://stackoverflow.com/a/5471032
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "codespell#{ext}")
+          return true if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      false
+    end
+
+    def warn_codespell_missing
+      Guard::Compat::UI.warning "Spellcheck failed - guard-codespell cannot find the codespell library."
+      Guard::Compat::UI.warning "Please run `pip install codespell` to resolve this issue."
+    end
+
+    # Fetch a list of changed files from the result of git status
+    def changed_files
+      `git status --porcelain`.lines.map do |line|
+        line.chomp.split("  ").last
+      end
+    end
+  end
+end

data/spec/guard/codespell_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "guard/compat/test/helper"
+require "guard/codespell"
+
+RSpec.describe Guard::Codespell do
+  subject(:guard) { described_class.new(options) }
+
+  let(:paths) { %w[path/to/foo.rb path/to/bar/baz.js] }
+  let(:options) { {} }
+
+  before do
+    allow(guard).to receive(:run_codespell)
+    allow(Guard::Compat::UI).to receive(:info)
+    allow(Guard::Compat::UI).to receive(:warning)
+  end
+
+  shared_examples "a method calling run_codespell with specific paths" do
+    it "calls run_codespell with paths" do
+      guard.public_send(method, paths)
+      expect(guard).to have_received(:run_codespell).with(paths)
+    end
+  end
+
+  shared_examples "a method call when codespell is not installed" do
+    it "returns a warning" do
+      guard.public_send(method, paths)
+      expect(guard).not_to have_received(:run_codespell)
+      expect(Guard::Compat::UI).to have_received(:warning).twice
+    end
+  end
+
+  context "with codespell installed" do
+    before do
+      allow(guard).to receive(:codespell).and_return(true)
+    end
+
+    describe "#run_all" do
+      it "calls run_codespell without any args" do
+        guard.run_all
+        expect(guard).to have_received(:run_codespell).with(no_args)
+      end
+
+      context "when only_git_changes option is set to true" do
+        let(:options) { { only_git_changes: true } }
+
+        it "calls run_codespell without any args" do
+          allow(guard).to receive(:changed_files).and_return(paths)
+
+          guard.run_all
+          expect(guard).to have_received(:run_codespell).with(paths)
+        end
+      end
+    end
+
+    describe "#run_on_additions" do
+      let(:method) { :run_on_additions }
+
+      it_behaves_like "a method calling run_codespell with specific paths"
+    end
+
+    describe "#run_on_modifications" do
+      let(:method) { :run_on_modifications }
+
+      it_behaves_like "a method calling run_codespell with specific paths"
+    end
+  end
+
+  context "with codespell not installed" do
+    before do
+      allow(guard).to receive(:codespell).and_return(false)
+    end
+
+    describe "#run_all" do
+      let(:method) { :run_all }
+
+      it "returns a warning" do
+        guard.run_all
+        expect(guard).not_to have_received(:run_codespell)
+        expect(Guard::Compat::UI).to have_received(:warning).twice
+      end
+    end
+
+    describe "#run_on_additions" do
+      let(:method) { :run_on_additions }
+
+      it_behaves_like "a method call when codespell is not installed"
+    end
+
+    describe "#run_on_modifications" do
+      let(:method) { :run_on_modifications }
+
+      it_behaves_like "a method call when codespell is not installed"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "guard/compat/test/helper"
+require "guard/codespell"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: guard-codespell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Loubier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Guard::Codespell uses codespell to automatically look for typos in your
+  codebase.
+email:
+- guillaume.loubier@hooktstudios.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-codespell.gemspec
+- lib/guard/codespell.rb
+- lib/guard/codespell/version.rb
+- spec/guard/codespell_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hooktstudios/guard-codespell
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hooktstudios/guard-codespell
+  source_code_uri: https://github.com/hooktstudios/guard-codespell
+  changelog_uri: https://github.com/hooktstudios/guard-codespell/CHANGELOG.md
+  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: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Guard plugin for codespell
+test_files:
+- spec/guard/codespell_spec.rb
+- spec/spec_helper.rb