danger-prose 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baec8d353bfa0f99782d3fa6774635e2415726a1
+  data.tar.gz: bc3d97b3f5800b04dab5103c20c3e1423ae91b65
+SHA512:
+  metadata.gz: fee815fd988fbfd0a085c06a9d65fcda49d7275829175662f09104279fe2a0f0814e259ac780ed717bb00717e3839665353446cf06757be99736ef3526ca4377
+  data.tar.gz: 5bed58cfa62e809440227c39e7fa19946c8d1fe4a7dfdfa1167e7a454dd388c5f6059085cb2bce06096ecc0ad00c98e759974ffe5e547e4bbf4eac8047cc69db

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+.bundle/
+.idea/
+.tm_properties
+vendor

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec
+    # - bundle exec danger plugin lint

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-proselint.gemspec
+gemspec
+
+group :development do
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+end

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    danger-prose (0.0.1)
+      danger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    bacon (1.2.0)
+    claide (1.0.0)
+    coderay (1.1.1)
+    colored (1.2)
+    cork (0.1.0)
+      colored (~> 1.2)
+    danger (0.8.3)
+      claide (~> 1.0)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      faraday (~> 0)
+      git (~> 1)
+      octokit (~> 4.2)
+      redcarpet (~> 3.3)
+      terminal-table (~> 1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.2)
+      mocha (>= 0.13.0)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-table (1.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  bundler (~> 1.3)
+  danger-prose!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  mocha
+  mocha-on-bacon
+  prettybacon
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -0,0 +1,21 @@
+# 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)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # 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) 2016 David Grandinetti <dbgrandi@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,21 @@
+# danger-proselint
+
+A description of danger-proselint.
+
+## Installation
+
+    $ 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
+
+# will check any .markdown files in this PR with proselint
+proselint.lint_files markdown_files
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+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

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-prose'
+  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.homepage      = 'https://github.com/dbgrandi/danger-prose'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'danger'
+
+  # 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'
+
+  # 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 test
+  # via 
+  #    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,85 @@
+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
+  #
+  #          # 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 markpown files in this PR
+  #          proselint.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.
+    # You can get a list of [them here](https://github.com/amperser/proselint#checks)
+    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. 
+    #
+    # @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)
+      # Installs a prose checker if needed
+      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
+
+      # 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
+
+      # 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 }
+
+      # 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}"
+          message << "#### [#{path}](#{github_loc})\n\n"
+
+          message << "Line | Message | Severity |\n"
+          message << "| --- | ----- | ----- |\n"
+
+          prose["data"]["errors"].each do |error|
+            message << "#{error['line']} | #{error['message']} | #{error['severity']}\n"
+          end
+        end
+
+        markdown message
+      end
+    end
+
+    # Determine if proselint is currently installed in the system paths.
+    # @return  [Bool]
+    #
+    def proselint_installed?
+      `which proselint`.strip.empty? == false
+    end
+  end
+end

data/lib/version.rb

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

data/spec/danger_plugin_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Prose 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
+
+      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
+        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)")
+        end
+      end
+    end
+  end
+end
+ 

data/spec/fixtures/blog_post.md

@@ -0,0 +1 @@
+This post intentional left blank-ish.

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+RSpec.configure do |config|
+ # Use color in STDOUT
+  config.color = true
+end
+
+require 'bundler/setup'
+require 'pry'
+
+require 'danger'
+require 'cork'
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface
+def testing_ui
+  Cork::Board.new(silent: true)
+end
+
+# Example environment (ENV) that would come from
+# 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"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: danger-prose
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Grandinetti
+- Orta Therox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A danger plugin for working with bodies of markdown prose.
+email:
+- dbgrandi@gmail.com
+- orta.therox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-prose.gemspec
+- lib/danger_plugin.rb
+- lib/version.rb
+- spec/danger_plugin_spec.rb
+- spec/fixtures/blog_post.md
+- spec/spec_helper.rb
+homepage: https://github.com/dbgrandi/danger-prose
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A danger plugin for working with bodies of markdown prose.
+test_files:
+- spec/danger_plugin_spec.rb
+- spec/fixtures/blog_post.md
+- spec/spec_helper.rb
+has_rdoc: