rubocop-markdown_formatter 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 516b2809ec44509b1c700e09128c5a238b9b643d
+  data.tar.gz: 66d9ff086cfaa508a3b8b8e7aada54607466df87
+SHA512:
+  metadata.gz: f9a8f8f5f78fe7f9670ddb5248c0557f8783c652d202df70a56e5c9f6852ab5405a769062afa5508e713b7a9548beab26b4bb11ef1f59db184b3d859d5a54f0f
+  data.tar.gz: 0761fa892d71d2c4ef05bba07f8dda4f78a177d6c16aaa67ab56dacb8da2d13933ddeb038e6cf669e7f0fd970d3c817c2b2df6a111d830a277ab97706fd6a2e5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Martin Manelli
+
+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,22 @@
+# RuboCop Markdown Formatter (WIP)
+
+A formatter for [RuboCop](https://github.com/bbatsov/rubocop) that spits [Markdown](http://commonmark.org/).
+It requires RuboCop version 0.23.0 or above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubocop-markdown_formatter'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install rubocop-markdown_formatter
+
+## Usage
+
+    rubocop --require rubocop/formatter/markdown_formatter --format RuboCop::Formatter::MarkdownFormatter

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/lib/rubocop/formatter/markdown_formatter.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'rubocop/formatter/text_util'
+
+module RuboCop
+  module Formatter
+    # This formatter outputs in Markdown format
+    # See: http://spec.commonmark.org/
+    class MarkdownFormatter < BaseFormatter
+      include PathUtil, TextUtil
+
+      def started(_target_files)
+        @report = {}
+      end
+
+      def file_finished(file, offenses)
+        @report[file] = offenses
+      end
+
+      def finished(inspected_files)
+        return if inspected_files.empty?
+        render_markdown(@report)
+      end
+
+      private
+
+      def render_markdown(report)
+        report.each do |file, offenses|
+          output.puts file_offenses(file, offenses)
+          offenses.each do |offense|
+            output.puts line_offense(offense)
+            output.puts markdown_code(offense)
+          end
+          output.puts '---'
+          output.puts
+        end
+      end
+
+      def file_offenses(file, offenses)
+        offenses_count = pluralize(offenses.count, 'offense', no_for_zero: true)
+
+        "### #{smart_path(file)} - #{offenses_count}"
+      end
+
+      def line_offense(offense)
+        severity = offense.severity.name.capitalize
+
+        # http://spec.commonmark.org/0.21/#backslash-escapes
+        message = offense.message.gsub(/\p{S}/u, '\\\1')
+
+        "#### Line ##{offense.line} - **#{severity}:** _#{message}_"
+      end
+
+      def markdown_code(offense)
+        source_line = offense.location.source_line
+        return if source_line.empty?
+
+        "```\n#{source_line}\n```"
+      end
+
+      def smart_path(path)
+        path.start_with?(Dir.pwd) ? relative_path(path) : path
+      end
+    end
+  end
+end

data/rubocop-markdown_formatter.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'rubocop-markdown_formatter'
+  s.version       = '0.0.1.pre'
+  s.summary       = 'A RuboCop formatter that outputs in Markdown'
+  s.author        = 'Martin Manelli'
+  s.email         = 'manelli.ml@gmail.com'
+  s.homepage      = 'http://github.com/manelli/rubocop-markdown_formatter'
+  s.license       = 'MIT'
+
+  s.files = %w(
+    lib/rubocop/formatter/markdown_formatter.rb
+    spec/rubocop/formatter/markdown_formatter_spec.rb
+    Rakefile
+    LICENSE
+    README.md
+    rubocop-markdown_formatter.gemspec
+  )
+
+  s.add_dependency 'rubocop', '>= 0.23.0'
+  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rspec', '~> 3.2.0'
+
+  s.required_ruby_version = '>= 1.9.3'
+end

data/spec/rubocop/formatter/markdown_formatter_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'rubocop'
+require_relative '../../../lib/rubocop/formatter/markdown_formatter'
+
+module RuboCop
+  module Formatter
+    describe MarkdownFormatter do
+      # TODO
+      skip
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-markdown_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Martin Manelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email: manelli.ml@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubocop/formatter/markdown_formatter.rb
+- rubocop-markdown_formatter.gemspec
+- spec/rubocop/formatter/markdown_formatter_spec.rb
+homepage: http://github.com/manelli/rubocop-markdown_formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A RuboCop formatter that outputs in Markdown
+test_files: []