danger-prose 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baec8d353bfa0f99782d3fa6774635e2415726a1
-  data.tar.gz: bc3d97b3f5800b04dab5103c20c3e1423ae91b65
+  metadata.gz: cbe1a62aa5863906f879c31de1e4a73bc60cba7d
+  data.tar.gz: 4374a4456fcefe699660edf4ad3dcde8fbe2911e
 SHA512:
-  metadata.gz: fee815fd988fbfd0a085c06a9d65fcda49d7275829175662f09104279fe2a0f0814e259ac780ed717bb00717e3839665353446cf06757be99736ef3526ca4377
-  data.tar.gz: 5bed58cfa62e809440227c39e7fa19946c8d1fe4a7dfdfa1167e7a454dd388c5f6059085cb2bce06096ecc0ad00c98e759974ffe5e547e4bbf4eac8047cc69db
+  metadata.gz: 4dbb3ac28eeff44f3c1d7ba4f374011520b81d8aa2b7ef199ea0f9e075c396dc706ebfb1727cef203cf87dc3e21674fea0f4765b535d56155140f2dff9235419
+  data.tar.gz: 1e5a007df22b038d54b87a6919f3693a3a89d3609680bd59ca5b561b2ba515b467a4074c44ce485c6a3ec58ed6d4caac03a265137f2e75472274f3cad1a51655

data/.travis.yml

@@ -10,4 +10,4 @@ rvm:
 
 script:
     - bundle exec rake spec
-    # - bundle exec danger plugin lint
+    - bundle exec danger plugin lint

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-prose (0.0.1)
+    danger-prose (2.0.0)
       danger
 
 GEM
@@ -14,7 +14,7 @@ GEM
     colored (1.2)
     cork (0.1.0)
       colored (~> 1.2)
-    danger (0.8.3)
+    danger (0.8.5)
       claide (~> 1.0)
       colored (~> 1.2)
       cork (~> 0.1)
@@ -91,6 +91,7 @@ GEM
     slop (3.6.0)
     terminal-table (1.6.0)
     thor (0.19.1)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -108,6 +109,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.4)
+  yard (~> 0.8)
 
 BUNDLED WITH
    1.12.5

data/Guardfile

@@ -3,8 +3,8 @@
 
 # To run, use `bundle exec guard`.
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements

data/README.md

@@ -6,16 +6,44 @@ A description of danger-proselint.
 
     $ gem install danger-proselint
 
-## Usage
 
-Add it to your Dangerfile
 
-``` ruby
-# Look through all changed Markdown files
-markdown_files = (modified_files + added_files).select do |line|
-  line.start_with?("_posts") && (line.end_with?(".markdown") || line.end_with?(".md"))
-end
+### prose
 
-# will check any .markdown files in this PR with proselint
-proselint.lint_files markdown_files
-```
+Lint markdown files inside your projects.
+This is done using the [proselint](http://proselint.com) python egg.
+Results are passed out as a table in markdown.
+
+<blockquote>Specifying custom CocoaPods installation options
+  <pre>
+# Runs a linter with comma style disabled
+proselint.disable_linters = ["misc.scare_quotes", "misc.tense_present"]
+proselint.lint_files "_posts/*.md"
+
+# Runs a linter with all styles, on modified and added markdown files in this PR
+proselint.lint_files</pre>
+</blockquote>
+
+
+
+#### Attributes
+<tr>
+`disable_linters` - Allows you to disable a collection of linters from running. Doesn't work yet.
+You can get a list of [them here](https://github.com/amperser/proselint#checks)
+defaults to `["misc.scare_quotes", "typography.symbols"]` when it's nil.
+<tr>
+`ignored_words` - Allows you to add a collection of words to skip in spellchecking.
+defaults to `[""]` when it's nil.
+
+
+
+#### Methods
+
+`lint_files` - Lints the globbed markdown files. Will fail if `proselint` cannot be installed correctly.
+Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files.
+
+`proselint_installed?` - Determine if proselint is currently installed in the system paths.
+
+`mdspell_installed?` - Determine if mdspell is currently installed in the system paths.
+
+`check_spelling` - Runs a markdown-specific spell checker, against a corpus of `.markdown` and `.md` files.

data/Rakefile

@@ -1,13 +1,5 @@
 require 'bundler/gem_tasks'
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-
 task default: :spec
-
-task :spec do
-  Rake::Task['specs'].invoke
-end
-
-task :default => :spec
-

data/danger-prose.gemspec

@@ -8,35 +8,37 @@ Gem::Specification.new do |spec|
   spec.version       = DangerProse::VERSION
   spec.authors       = ['David Grandinetti', 'Orta Therox']
   spec.email         = ['dbgrandi@gmail.com', 'orta.therox@gmail.com']
-  spec.description   = %q{A danger plugin for working with bodies of markdown prose.}
-  spec.summary       = %q{A danger plugin for working with bodies of markdown prose.}
+  spec.description   = 'A danger plugin for working with bodies of markdown prose.'
+  spec.summary       = 'A danger plugin for working with bodies of markdown prose.'
   spec.homepage      = 'https://github.com/dbgrandi/danger-prose'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'danger'
 
+  # Let's you test your plugin via the linter
+  spec.add_development_dependency "yard", '~> 0.8'
+
   # General ruby development
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'
 
   #  Testing support
-  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
 
   # Makes testing easy via `bundle exec guard`
-  spec.add_development_dependency "guard", '~> 2.14'
-  spec.add_development_dependency "guard-rspec", '~> 4.7'
-  
+  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'
+  spec.add_development_dependency 'listen', '3.0.7'
 
   # This gives you the chance to run a REPL inside your test
-  # via 
+  # via
   #    binding.pry
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency "pry"
-
+  spec.add_development_dependency 'pry'
 end

data/lib/danger_plugin.rb

@@ -1,72 +1,82 @@
-module Danger
+require 'json'
 
+module Danger
   # Lint markdown files inside your projects.
   # This is done using the [proselint](http://proselint.com) python egg.
   # Results are passed out as a table in markdown.
   #
-  # @example Specifying custom CocoaPods installation options
+  # @example Running linter with custom disabled linters
+  #
+  #          # Runs a linter with comma style and tense present disabled
+  #          prose.disable_linters = ["misc.scare_quotes", "misc.tense_present"]
+  #          prose.lint_files "_posts/*.md"
+  #
+  # @example Running linter with default linters
+  #
+  #          # Runs a linter with all styles, on modified and added markdown files in this PR
+  #          prose.lint_files
+  #
+  # @example Running the spell checker
+  #
+  #          # Runs a spell checker on all files in `_post`
+  #          prose.check_spelling "_posts/*.md"
   #
-  #          # Runs a linter with comma style disabled
-  #          proselint.disable_linters = [“misc.scare_quotes”, "misc.tense_present"]
-  #          proselint.lint_files “_posts/*.md”
+  # @example Running the spell checker, with some words whitelisted
   #
-  #          # Runs a linter with all styles, on modified and added markpown files in this PR
-  #          proselint.lint_files
+  #          prose.ignored_words = ["orta", "artsy"]
+  #          prose.lint_files
   #
   # @see  artsy/artsy.github.io
   # @tags blogging, blog, writing, jekyll, middleman, hugo, metalsmith, gatsby, express
   #
   class DangerProse < Plugin
-
-    # Allows you to disable a collection of linters from being ran.
+    # Allows you to disable a collection of linters from running. Doesn't work yet.
     # You can get a list of [them here](https://github.com/amperser/proselint#checks)
+    # defaults to `["misc.scare_quotes", "typography.symbols"]` when it's nil.
+    #
+    # @return   [Array<String>]
     attr_accessor :disable_linters
 
-    # Lints the globbed files, will only fail if `proselint` cannot be installed correctly.
-    # Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files. 
+    # Lints the globbed markdown files. Will fail if `proselint` cannot be installed correctly.
+    # Generates a `markdown` list of warnings for the prose in a corpus of .markdown and .md files.
     #
     # @param   [String] files
     #          A globbed string which should return the files that you want to lint, defaults to nil.
     #          if nil, modified and added files from the diff will be used.
     # @return  [void]
     #
-    def lint_files(files=nil)
+    def lint_files(files = nil)
       # Installs a prose checker if needed
-      system "pip install --user proselint" unless proselint_installed?
+      system 'pip install --user proselint' unless proselint_installed?
 
       # Check that this is in the user's PATH after installing
-      unless proselint_installed?
-        fail "proselint is not in the user's PATH, or it failed to install"
-        return
-      end
+      raise "proselint is not in the user's PATH, or it failed to install" unless proselint_installed?
 
       # Either use files provided, or use the modified + added
-      markdown_files = files ? Dir.glob(files) : (modified_files + added_files)
-      markdown_files.select! do |line| (line.end_with?(".markdown") || line.end_with?(".md")) end
-
-      # TODO create the disabled linters JSON in ~/.proselintrc
-      # using @disable_linter
+      markdown_files = get_files files
 
-      # Convert paths to proselint results
-      require 'json'
-      result_jsons = Hash[markdown_files.uniq.collect { |v| [v, JSON.parse(`proselint #{v} --json`.strip) ] }]
-      proses = result_jsons.select { |path, prose| prose['data']['errors'].count }
+      proses = {}
+      to_disable = disable_linters || ["misc.scare_quotes", "typography.symbols"]
+      with_proselint_disabled(to_disable) do
+        # Convert paths to proselint results
+        result_jsons = Hash[markdown_files.uniq.collect { |v| [v, get_proselint_json(v)] }]
+        proses = result_jsons.select { |_, prose| prose['data']['errors'].count }
+      end
 
       # Get some metadata about the local setup
-      current_branch = env.request_source.pr_json["head"]["ref"]
       current_slug = env.ci_source.repo_slug
 
       # We got some error reports back from proselint
       if proses.count > 0
         message = "### Proselint found issues\n\n"
         proses.each do |path, prose|
-          github_loc = "/#{current_slug}/tree/#{current_branch}/#{path}"
+          github_loc = "/#{current_slug}/tree/#{github.branch_for_head}/#{path}"
           message << "#### [#{path}](#{github_loc})\n\n"
 
           message << "Line | Message | Severity |\n"
           message << "| --- | ----- | ----- |\n"
 
-          prose["data"]["errors"].each do |error|
+          prose['data']['errors'].each do |error|
             message << "#{error['line']} | #{error['message']} | #{error['severity']}\n"
           end
         end
@@ -81,5 +91,111 @@ module Danger
     def proselint_installed?
       `which proselint`.strip.empty? == false
     end
+
+    # Determine if mdspell is currently installed in the system paths.
+    # @return  [Bool]
+    #
+    def mdspell_installed?
+      `which mdspell`.strip.empty? == false
+    end
+
+    # Allows you to add a collection of words to skip in spellchecking.
+    # defaults to `[""]` when it's nil.
+    # @return [Array<String>]
+    attr_accessor :ignored_words
+
+    # Runs a markdown-specific spell checker, against a corpus of `.markdown` and `.md` files.
+    #
+    # @param   [String] files
+    #          A globbed string which should return the files that you want to spell check, defaults to nil.
+    #          if nil, modified and added files from the diff will be used.
+    # @return  [void]
+    #
+    def check_spelling(files = nil)
+      # Installs my fork of the spell checker if needed
+      # my fork has line numbers + indexes
+      system "npm install -g orta/node-markdown-spellcheck" unless mdspell_installed?
+
+      # Check that this is in the user's PATH after installing
+      raise "mdspell is not in the user's PATH, or it failed to install" unless mdspell_installed?
+
+      markdown_files = get_files files
+
+      skip_words = ignored_words || []
+      File.write(".spelling", skip_words.join("\n"))
+      result_texts = Hash[markdown_files.uniq.collect { |md| [md, `mdspell #{md} -r`.strip] }]
+      spell_issues = result_texts.select { |path, output| output.include? "spelling errors found" }
+      File.unlink(".spelling")
+
+      # Get some metadata about the local setup
+      current_slug = env.ci_source.repo_slug
+
+      if spell_issues.count > 0
+        message = "### Spell Checker found issues\n\n"
+        spell_issues.each do |path, output|
+          github_loc = "/#{current_slug}/tree/#{github.branch_for_head}/#{path}"
+          message << "#### [#{path}](#{github_loc})\n\n"
+
+          message << "Line | Typo |\n"
+          message << "| --- | ------ |\n"
+
+          output.lines[1..-3].each do |line|
+            index_info = line.strip.split("|").first
+            index_line, index = index_info.split(":").map { |n| n.to_i }
+
+            file = File.read(path)
+
+            unknown_word = file[index..-1].split(" ").first
+
+            error_text = line.strip.split("|")[1..-1].join("|").strip
+            error = error_text.gsub(unknown_word, "**" + unknown_word + "**")
+
+            message << "#{index_line} | #{error} | \n"
+          end
+          markdown message
+        end
+      end
+    end
+
+    private
+    # Creates a temporary proselint settings file
+    # @return  void
+    #
+    def with_proselint_disabled(disable_linters)
+      # Create the disabled linters JSON in ~/.proselintrc
+      proselint_template = File.join(File.dirname(__FILE__), 'proselintrc')
+      proselintJSON = JSON.parse(File.read(proselint_template))
+
+      # Disable individual linters
+      disable_linters.each do |linter|
+        proselintJSON['checks'][linter] = false
+      end
+
+      # Re-save the new JSON into the home dir
+      temp_proselint_rc_path = File.join(Dir.home, '.proselintrc')
+      File.write(temp_proselint_rc_path, JSON.pretty_generate(proselintJSON))
+
+      # Run the closure
+      yield
+
+      # Delete .proselintrc
+      File.unlink temp_proselint_rc_path
+    end
+
+    def get_files files
+      # Either use files provided, or use the modified + added
+      markdown_files = files ? Dir.glob(files) : (git.modified_files + git.added_files)
+      markdown_files.select { |line| line.end_with? '.markdown', '.md' }
+    end
+
+    # Always returns a hash, regardless of whether the command gives JSON, weird data, or no response
+    def get_proselint_json path
+      json = `proselint "#{path}" --json`.strip
+      if json[0] == "{" and json[-1] == "}"
+        JSON.parse json
+      else
+        {}
+      end
+    end
   end
 end

data/lib/proselintrc

@@ -0,0 +1,82 @@
+{
+    "max_errors": 1000,
+    "checks": {
+        "airlinese.misc"                : true,
+        "annotations.misc"              : true,
+        "archaism.misc"                 : true,
+        "cliches.hell"                  : true,
+        "cliches.misc"                  : true,
+        "consistency.spacing"           : true,
+        "consistency.spelling"          : true,
+        "corporate_speak.misc"          : true,
+        "cursing.filth"                 : true,
+        "cursing.nfl"                   : false,
+        "cursing.nword"                 : true,
+        "dates_times.am_pm"             : true,
+        "dates_times.dates"             : true,
+        "hedging.misc"                  : true,
+        "hyperbole.misc"                : true,
+        "jargon.misc"                   : true,
+        "lexical_illusions.misc"        : true,
+        "links.broken"                  : false,
+        "malapropisms.misc"             : true,
+        "misc.apologizing"              : true,
+        "misc.back_formations"          : true,
+        "misc.bureaucratese"            : true,
+        "misc.but"                      : true,
+        "misc.capitalization"           : true,
+        "misc.chatspeak"                : true,
+        "misc.commercialese"            : true,
+        "misc.composition"              : true,
+        "misc.currency"                 : true,
+        "misc.debased"                  : true,
+        "misc.false_plurals"            : true,
+        "misc.illogic"                  : true,
+        "misc.inferior_superior"        : true,
+        "misc.latin"                    : true,
+        "misc.many_a"                   : true,
+        "misc.metaconcepts"             : true,
+        "misc.metadiscourse"            : true,
+        "misc.narcisissm"               : true,
+        "misc.not_guilty"               : true,
+        "misc.phrasal_adjectives"       : true,
+        "misc.preferred_forms"          : true,
+        "misc.pretension"               : true,
+        "misc.professions"              : true,
+        "misc.punctuation"              : true,
+        "misc.scare_quotes"             : true,
+        "misc.suddenly"                 : true,
+        "misc.tense_present"            : true,
+        "misc.waxed"                    : true,
+        "misc.whence"                   : true,
+        "mixed_metaphors.misc"          : true,
+        "mondegreens.misc"              : true,
+        "needless_variants.misc"        : true,
+        "nonwords.misc"                 : true,
+        "oxymorons.misc"                : true,
+        "psychology.misc"               : true,
+        "redundancy.misc"               : true,
+        "redundancy.ras_syndrome"       : true,
+        "skunked_terms.misc"            : true,
+        "spelling.able_atable"          : true,
+        "spelling.able_ible"            : true,
+        "spelling.athletes"             : true,
+        "spelling.em_im_en_in"          : true,
+        "spelling.er_or"                : true,
+        "spelling.in_un"                : true,
+        "spelling.misc"                 : true,
+        "security.credit_card"          : true,
+        "security.password"             : true,
+        "sexism.misc"                   : true,
+        "terms.animal_adjectives"       : true,
+        "terms.denizen_labels"          : true,
+        "terms.eponymous_adjectives"    : true,
+        "terms.venery"                  : true,
+        "typography.diacritical_marks"  : true,
+        "typography.exclamation"        : true,
+        "typography.symbols"            : true,
+        "uncomparables.misc"            : true,
+        "weasel_words.misc"             : true,
+        "weasel_words.very"             : true
+    }
+}

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DangerProse
-  VERSION = "1.0.0".freeze
+  VERSION = '2.0.0'.freeze
 end

data/spec/danger_plugin_spec.rb

@@ -1,58 +1,103 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 module Danger
-  describe Prose do
+  describe DangerProse do
     it 'is a plugin' do
       expect(Danger::DangerProse < Danger::Plugin).to be_truthy
     end
-    
+
     describe 'with Dangerfile' do
       before do
         @dangerfile = testing_dangerfile
         @prose = testing_dangerfile.prose
       end
 
-      it "handles proselint not being installed" do
-        allow(@prose).to receive(:`).with("which proselint").and_return("")
-        expect(@prose.proselint_installed?).to be_falsy
-      end
+      describe 'linter' do
+        it 'handles proselint not being installed' do
+          allow(@prose).to receive(:`).with('which proselint').and_return('')
+          expect(@prose.proselint_installed?).to be_falsy
+        end
+
+        it 'handles proselint being installed' do
+          allow(@prose).to receive(:`).with('which proselint').and_return('/bin/thing/proselint')
+          expect(@prose.proselint_installed?).to be_truthy
+        end
+
+        describe :lint_files do
+          before do
+            # So it doesn't try to install on your computer
+            allow(@prose).to receive(:`).with('which proselint').and_return('/bin/thing/proselint')
+
+            # Proselint returns JSON data, which is nice 👍
+            errors = '[{"start": 1441, "replacements": null, "end": 1445, "severity": "warning", "extent": 4, "column": 1, "message": "!!! is hyperbolic.", "line": 46, "check": "hyperbolic.misc"}]'
+            proselint_response = '{"status" : "success", "data" : { "errors" : ' + errors + '}}'
+
+            # This is where we generate our JSON
+            allow(@prose).to receive(:`).with('proselint "spec/fixtures/blog_post.md" --json').and_return(proselint_response)
+
+            # it's worth noting - you can call anything on your plugin that a Dangerfile responds to
+            # The request source's PR JSON typically looks like
+            # https://raw.githubusercontent.com/danger/danger/bffc246a11dac883d76fc6636319bd6c2acd58a3/spec/fixtures/pr_response.json
+
+            @prose.env.request_source.pr_json = { head: { ref: 'my_fake_branch' } }
+          end
+
+          it 'handles a known JSON report from proselint' do
+            @prose.lint_files('spec/fixtures/*.md')
+            output = @prose.status_report[:markdowns].first
 
-      it "handles proselint being installed" do
-        allow(@prose).to receive(:`).with("which proselint").and_return("/bin/thing/proselint")
-        expect(@prose.proselint_installed?).to be_truthy
+            # A title
+            expect(output).to include('Proselint found issues')
+            # A warning
+            expect(output).to include('!!! is hyperbolic. | warning')
+            # A link to the file inside the fixtures dir
+            expect(output).to include('[spec/fixtures/blog_post.md](/artsy/eigen/tree/my_fake_branch/spec/fixtures/blog_post.md)')
+          end
+        end
       end
 
-      describe :lint_files do
-        it "handles a known JSON report from proselint" do
-          # So it doesn't try to install on your computer
-          allow(@prose).to receive(:`).with("which proselint").and_return("/bin/thing/proselint")
-
-          # Proselint returns JSON data, which is nice 👍
-          errors = '[{"start": 1441, "replacements": null, "end": 1445, "severity": "warning", "extent": 4, "column": 1, "message": "!!! is hyperbolic.", "line": 46, "check": "hyperbolic.misc"}]'
-          proselint_response = '{"status" : "success", "data" : { "errors" : ' + errors + '}}'
-
-          # This is where we generate our JSON
-          allow(@prose).to receive(:`).with("proselint spec/fixtures/blog_post.md --json").and_return(proselint_response)
-
-          # it's worth noting - you can call anything on your plugin that a Dangerfile responds to
-          # The request source's PR JSON typically looks like
-          # https://raw.githubusercontent.com/danger/danger/bffc246a11dac883d76fc6636319bd6c2acd58a3/spec/fixtures/pr_response.json 
-          @prose.env.request_source.pr_json = { "head" => { "ref" => "my_fake_branch" }}
-
-          # Do it
-          @prose.lint_files("spec/fixtures/*.md")
-
-          output = @prose.status_report[:markdowns].first
-          
-          # A title
-          expect(output).to include("Proselint found issues")
-          # A warning
-          expect(output).to include("!!! is hyperbolic. | warning")
-          # A link to the file inside the fixtures dir
-          expect(output).to include("[spec/fixtures/blog_post.md](/artsy/eigen/tree/my_fake_branch/spec/fixtures/blog_post.md)")
+      describe 'spell checking' do
+        it 'handles proselint not being installed' do
+          allow(@prose).to receive(:`).with('which mdspell').and_return('')
+          expect(@prose.mdspell_installed?).to be_falsy
+        end
+
+        it 'handles proselint being installed' do
+          allow(@prose).to receive(:`).with('which mdspell').and_return('/bin/thing/mdspell')
+          expect(@prose.mdspell_installed?).to be_truthy
+        end
+
+        describe 'full command' do
+          before do
+            # So it doesn't try to install on your computer
+            allow(@prose).to receive(:`).with('which mdspell').and_return('/bin/thing/mdspell')
+
+            # mdspell returns JSON data, which is nice 👍
+            proselint_response = "    spec/fixtures/blog_post.md\n        1:27 | This post intentional left blank-ish.\n        4:84 | Here's a tpyo - it should registor.\n        4:101 | Here's a tpyo - it should registor.\n\n >> 3 spelling errors found in 1 file"
+
+            # This is where we generate our JSON
+            allow(@prose).to receive(:`).with('mdspell spec/fixtures/blog_post.md -r').and_return(proselint_response)
+
+            # it's worth noting - you can call anything on your plugin that a Dangerfile responds to
+            # The request source's PR JSON typically looks like
+            # https://raw.githubusercontent.com/danger/danger/bffc246a11dac883d76fc6636319bd6c2acd58a3/spec/fixtures/pr_response.json
+
+            @prose.env.request_source.pr_json = { head: { ref: 'my_fake_branch' } }
+          end
+
+          it 'handles a known JSON report from mdspell' do
+            @prose.check_spelling('spec/fixtures/*.md')
+            output = @prose.status_report[:markdowns].first
+
+            # A title
+            expect(output).to include('Spell Checker found issues')
+            # A typo, in bold
+            expect(output).to include('**tpyo**')
+            # A link to the file inside the fixtures dir
+            expect(output).to include('[spec/fixtures/blog_post.md](/artsy/eigen/tree/my_fake_branch/spec/fixtures/blog_post.md)')
+          end
         end
       end
     end
   end
 end
- 

data/spec/fixtures/blog_post.md

@@ -1 +1,4 @@
-This post intentional left blank-ish.
+This post intentional left blank-ish.
+And this is to trigger a warning!!!
+
+Here's a tpyo - it should registor.

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 ROOT = Pathname.new(File.expand_path('../../', __FILE__))
-$:.unshift((ROOT + 'lib').to_s)
-$:.unshift((ROOT + 'spec').to_s)
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
 
 RSpec.configure do |config|
- # Use color in STDOUT
+  # Use color in STDOUT
   config.color = true
 end
 
@@ -26,11 +26,11 @@ end
 # running a PR on TravisCI
 def testing_env
   {
-    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
-    "TRAVIS_PULL_REQUEST" => "800",
-    "TRAVIS_REPO_SLUG" => "artsy/eigen",
-    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
-    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
   }
 end
 
@@ -38,4 +38,4 @@ end
 def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-prose
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - David Grandinetti
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +155,7 @@ files:
 - Rakefile
 - danger-prose.gemspec
 - lib/danger_plugin.rb
+- lib/proselintrc
 - lib/version.rb
 - spec/danger_plugin_spec.rb
 - spec/fixtures/blog_post.md
@@ -165,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A danger plugin for working with bodies of markdown prose.