danger-spelling 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c00f343a9b9ba9b4c615a3ff5581e9d17193fc8da79167ee9b664384e926bfe1
+  data.tar.gz: cdd9b031a3167fc8428c9dc7f7d36f75ee6be0b62b04a10669588ab08bbd5f90
+SHA512:
+  metadata.gz: aea7441a74f7cd79bd26959ba900094dc497442ab0c8924293037f65679760af2454ddbe83b00edf18dadc8d3803c7f36194356f9aaddda24007a0688457ab3a
+  data.tar.gz: 28ad9975295d71e8365607f90cbe6a66930e87930d398d7e94d7ec214216ac5a78e6fe4ad433285d9b840157f237ea18d5aeb8978b432a6da9554c16bc7c4293

data/.github/workflows/branch-checks.yml

@@ -0,0 +1,26 @@
+name: Branch Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - name: Danger Report
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec danger
+        timeout-minutes: 10
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}

data/.gitignore

@@ -0,0 +1 @@
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Changelog
+
+### 0.0.1 - Next
+
+* Your contribution here.
+
+* Implelemted pyspelling as a danger plugin - [@HamstringAssassin](https://github.com/HamstringAssassin).

data/Dangerfile

@@ -0,0 +1,10 @@
+gemfile_updated = !git.modified_files.grep(/Gemfile/).empty?
+
+# Leave warning, if Gemfile changes
+warn 'The `Gemfile` was updated' if gemfile_updated
+
+# Rubocop lint
+rubocop.lint
+
+# CHANGELOG CHECKS
+changelog.check!

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-spelling.gemspec
+gemspec
+
+# Danger plugins to run as part of CI
+gem 'danger-changelog', '~> 0.6.0'
+gem 'danger-rubocop'

data/Gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    danger-spelling (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.4.5)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-changelog (0.6.1)
+      danger-plugin-api (~> 1.0)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    danger-rubocop (0.10.0)
+      danger
+      rubocop (~> 1.0)
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.10.2)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.22.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-changelog (~> 0.6.0)
+  danger-rubocop
+  danger-spelling!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.2.26

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022 HammyAssassin <alanoc83@gmail.com>
+
+MIT License
+
+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,127 @@
+
+
+### spelling
+
+This is a Danger plugin that wraps the python library pyspelling and some of its usage.
+The pyspelling results are posted to the pull request as a comment with the spelling mistake, file path &
+line number where the spelling mistake was found.
+
+It has some dependencies that should be installed prior to running.
+
+* [pyspelling](https://facelessuser.github.io/pyspelling/)
+* [aspell](http://aspell.net)
+* **OR**
+* [hunspell](http://hunspell.github.io)
+
+Your repository will also require a .pyspelling.yml file to be present. This .pyspelling.yml can be basic,
+but it will require a name and source property.
+
+There are several ways to use this danger plugin
+
+added in the given pull request.
+         spelling.name = "test_matrix"
+         spelling.check_spelling
+
+request, excluding some specific file names
+         spelling.ignored_files = ["Gemfile"]
+         spelling.name = "test_matrix"
+         spelling.check_spelling
+
+request, excluding some specific file names and excluding some words
+         spelling.ignored_words = ["HammyAssassin"]
+         spelling.ignored_files = ["Gemfile"]
+         spelling.name = "test_matrix"
+         spelling.check_spelling
+
+<blockquote>execute pyspelling matrix with the name 'test_matrix' on all files modified or
+  <pre></pre>
+</blockquote>
+
+<blockquote>execute pyspelling matrix with the name 'test_matrix' on all files modified or added in the given pull
+  <pre></pre>
+</blockquote>
+
+<blockquote>execute pyspelling matrix with the name 'test_matrix' on all files modified or added in the given pull
+  <pre></pre>
+</blockquote>
+
+
+
+#### Attributes
+
+`ignored_words` - Allows you to ignore certain words that might otherwise be detected as a spelling error.
+default value is [] when its nil
+
+`ignored_files` - Allows you to ignore certain files that might otherwise be scanned by pyspelling.
+The default value is [] for when its nil
+
+`name` - **required** The name of the test matrix in your .pyspelling.yml
+An exception will be raised if this is not specified in your Danger file.
+
+
+
+
+#### Methods
+
+`check_spelling` - Checks the spelling of all files added or modified in a given pull request. This will fail if
+pyspelling cannot be installed if not installed already. It will fail if `aspell` or `hunspell`
+are not detected.
+
+It will also fail if the required parameter `name` hasn't been specificed in the Danger file.
+
+
+modified files will be scanned.
+
+`update_message_for_issues` - **Internal Method**
+
+Updates the message that will eventually be posted as a comment a pull request with
+a new line for each time the spelling error has been detected.
+
+`pyspelling_results` - **Internal Method**
+
+Runs pyspelling on the test matrix name provided with any files given.
+
+`git_check` - **Internal Method**
+
+Check on the git service used. Will raise an error if using bitbucket as it currently doesnt support that.
+
+`check_for_dependancies` - **Internal Method**
+
+Check for dependencies. Raises exception if pyspelling, hunspell or aspell are not installed.
+
+`ignore_line` - **Internal Method**
+
+Checks if a given line can be ignored if it contains expected pyspelling output.
+
+`remove_ignored_words` - **Internal Method**
+
+Removes some standard words in the pyspelling results.
+Words provided in `ignored_words` will also be removed from the results array.
+
+`pyspelling_installed?` - **Internal Method**
+
+Checks of pyspelling is installed.
+
+`aspell_installed?` - **Internal Method**
+
+Checks if aspell is installed.
+
+`hunspell_installed?` - **Internal Method**
+
+Checks if Hunspell is installed.
+
+`aspell_hunspell_installed?` - **Internal Method**
+
+checks if aspell and hunspell are installed.
+
+`get_files` - **Internal Method**
+
+Gets a file list of the files provided or finds modified and added files to scan.
+If files are provided via `ignored_files` they will be removed from the final returned
+list.
+
+Will raise an exception if no files are found.
+
+
+
+

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+desc "Ensure that the plugin passes `danger plugins lint`"
+task :spec_docs do
+  sh "bundle exec danger plugins lint"
+end

data/danger-spelling.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spelling/gem_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-spelling"
+  spec.version       = Spelling::VERSION
+  spec.authors       = ["HammyAssassin"]
+  spec.email         = ["alanoc83@gmail.com"]
+  spec.description   = "A Danger plugin for pyspelling."
+  spec.summary       = "danger-spelling uses pyspelling to scan files changed for spelling mistakes."
+  spec.homepage      = "https://github.com/HammyAssassin/danger-spelling"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
+
+  # General ruby development
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # Testing support
+  spec.add_development_dependency "rspec", "~> 3.4"
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency "listen", "3.0.7"
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spelling/plugin"

data/lib/danger_spelling.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "spelling/gem_version"

data/lib/spelling/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spelling
+  VERSION = "0.0.1"
+end