rubocop-redmine_wiki_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8197b1bf6d047289b5e14df36f53564c4572ab7f
+  data.tar.gz: 2c1c7f42a9630ddf09d84e8e0c5b358f412cee96
+SHA512:
+  metadata.gz: f5c4df7833bb9274cb52eb43400f8e557acbf489876aa3b80f070bbb03a79ffbedf5269f156d98bfd51ac944905ccc0437a58b514e3680185591a8ac9466de65
+  data.tar.gz: e9e0eeb80c9728b2ded73094c756a3189f9c665e4ab25d5759295f869978f40aeedcfacdaa6ea678b9206ede2fbbf4c501303ff69718e3e49c1a9ea0653460d6

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# RuboCop Redmine Wiki Formatter
+
+Redmine Wiki Page Formatter, as an extension to [RuboCop](https://github.com/bbatsov/rubocop).
+
+
+## Installation
+
+Just install the `rubocop-redmine_wiki_formatter` gem
+
+```bash
+gem install rubocop-redmine_wiki_formatter
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```
+gem 'rubocop-redmine_wiki_formatter', require: false
+```
+
+
+## Usage
+
+You need to tell RuboCop to load the RedmineWikiFormatter extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into you `.rubocop.yml`.
+
+```
+require: redmine_wiki_formatter
+```
+
+Now you can run `rubocop --format RuboCop::Formatter::RedmineWikiFormatter` and it will automaticly format the output
+to Redmine's Wiki format.
+
+### Command line
+
+```bash
+rubocop --require redmine_wiki_formatter --format RuboCop::Formatter::RedmineWikiFormatter
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'redmine_wiki_formatter'
+  task.options = ['--format', 'RuboCop::Formatter::RedmineWikiFormatter']
+end
+```
+
+## License
+
+`rubocop-redmine_wiki_formatter` is [MIT licensed](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]

data/lib/redmine_wiki_formatter.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'rubocop'
+
+require 'rubocop/formatter/redmine_wiki_formatter'
+require 'rubocop/redmine_wiki_formatter/version'

data/lib/rubocop/formatter/redmine_wiki_formatter.rb

@@ -0,0 +1,66 @@
+module RuboCop
+  module Formatter
+    # A Redmine wiki formatter that displays only files with offenses.
+    class RedmineWikiFormatter < BaseFormatter
+      include PathUtil, TextUtil
+
+      def started(_target_files)
+        @files = []
+        @total_offense_file_count = 0
+        @total_offense_count = 0
+        @total_correction_count = 0
+        output.printf("h1. RuboCop (version %s) Inspection Report\r\n\r\n", RuboCop::Version::STRING)
+      end
+
+      def file_finished(file, offenses)
+        @files << file
+        return if offenses.empty?
+        @total_offense_file_count += 1
+        count_stats(offenses)
+        report_file(file, offenses)
+      end
+
+      def finished(inspected_files)
+        output.printf("h2. Summary\r\n\r\n")
+        output.printf("* Generated on %s\r\n", DateTime.now)
+        output.printf("* %s inspected, %s detected in %s\r\n", 
+          pluralize(@files.count, 'file'), 
+          pluralize(@total_offense_count, 'offense', no_for_zero: true),
+          pluralize(@total_offense_file_count, 'file'))
+      end
+
+      def report_file(file, offenses)
+        output.puts("h2. #{smart_path(file)} - #{pluralize(offenses.count, 'offense')}\r\n\r\n")
+
+        offenses.each do |o|
+          output.printf("h3. Line %d, Column %d\r\n\r\n%s\r\n", o.line, o.real_column, message(o))
+          output.printf("<pre><code>%s</code></pre>\r\n\r\n", o.location.source_line)
+        end
+        output.printf("\r\n")
+      end
+
+      private
+
+      def count_stats(offenses)
+        @total_offense_count += offenses.count
+        @total_correction_count += offenses.count(&:corrected?)
+      end
+
+      def smart_path(path)
+        # Ideally, we calculate this relative to the project root.
+        base_dir = Dir.pwd
+
+        if path.start_with? base_dir
+          relative_path(path, base_dir)
+        else
+          path
+        end
+      end
+
+      def message(offense)
+        message = offense.corrected? ? '[Corrected] ' : ''
+        message << offense.message
+      end
+    end
+  end
+end

data/lib/rubocop/redmine_wiki_formatter/version.rb

@@ -0,0 +1,8 @@
+module RuboCop
+  module RedmineWikiFormatter
+    # Version information for the Redmine Wiki Formatter RuboCop plugin.
+    module Version
+      STRING = '0.1.0'
+    end
+  end
+end

data/rubocop-redmine_wiki_formatter.gemspec

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rubocop/redmine_wiki_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop-redmine_wiki_formatter'
+  spec.summary = 'Formatter for Redmine Wiki page'
+  spec.description = <<-end_description
+    Formatter for Redmine Wiki page.
+    A formatter for the RuboCop tool that outputs in Redmine Wiki markup.
+  end_description
+  spec.homepage = 'http://github.com/hugoangelo/rubocop-redmine_wiki_formatter'
+  spec.authors = ['Hugo Angelo']
+  spec.email = ['hugoangelo@gmail.com']
+  spec.licenses = ['MIT']
+
+  spec.version = RuboCop::RedmineWikiFormatter::Version::STRING
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.require_paths = ['lib']
+  spec.files = Dir[
+    '{lib,spec}/**/*',
+    '*.md',
+    '*.gemspec',
+    'Gemfile',
+    'Rakefile'
+  ]
+  spec.test_files = Dir['{spec}/**/*']
+  spec.extra_rdoc_files = ['README.md']
+
+  spec.add_development_dependency('rubocop', '~> 0.24')
+  spec.add_development_dependency('rake', '~> 10.1')
+  spec.add_development_dependency('rspec', '~> 3.2')
+end

data/spec/rubocop/formatter/redmine_wiki_formatter_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'stringio'
+require 'fileutils'
+
+module RuboCop
+  module Formatter
+    describe RedmineWikiFormatter do
+      subject(:formatter) { described_class.new(output) }
+      let(:output) { StringIO.new }
+
+      describe '#report_file' do
+        before do
+          formatter.report_file(file, [offense])
+        end
+
+        let(:file) { '/path/to/file' }
+
+        let(:offense) do
+          Cop::Offense.new(:convention, location,
+                           'This is a message.', 'CopName', status)
+        end
+
+        let(:location) do
+          source_buffer = Parser::Source::Buffer.new('test', 1)
+          source_buffer.source = "a\n"
+          Parser::Source::Range.new(source_buffer, 0, 1)
+        end
+
+        let(:status) { :uncorrected }
+
+        context 'the file is under the current working directory' do
+          let(:file) { File.expand_path('spec/spec_helper.rb') }
+
+          it 'prints as relative path' do
+            expect(output.string).to include('h2. spec/spec_helper.rb ')
+          end
+        end
+
+        context 'the file is outside of the current working directory' do
+          let(:file) do
+            tempfile = Tempfile.new('')
+            tempfile.close
+            File.expand_path(tempfile.path)
+          end
+
+          it 'prints as absolute path' do
+            expect(output.string).to include("h2. #{file} ")
+          end
+        end
+
+        context 'when the offense is not corrected' do
+          let(:status) { :uncorrected }
+
+          it 'prints message as-is' do
+            expect(output.string)
+              .to include('This is a message.')
+          end
+        end
+
+        context 'when the offense is automatically corrected' do
+          let(:status) { :corrected }
+
+          it 'prints [Corrected] along with message' do
+            expect(output.string)
+              .to include('[Corrected] This is a message.')
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w{ .. lib }))
+
+require 'rspec'
+require 'rubocop'
+require 'rubocop/formatter/redmine_wiki_formatter'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-redmine_wiki_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hugo Angelo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+      Formatter for Redmine Wiki page.
+      A formatter for the RuboCop tool that outputs in Redmine Wiki markup.
+email:
+- hugoangelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/redmine_wiki_formatter.rb
+- lib/rubocop/formatter/redmine_wiki_formatter.rb
+- lib/rubocop/redmine_wiki_formatter/version.rb
+- rubocop-redmine_wiki_formatter.gemspec
+- spec/rubocop/formatter/redmine_wiki_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/hugoangelo/rubocop-redmine_wiki_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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Formatter for Redmine Wiki page
+test_files:
+- spec/rubocop/formatter/redmine_wiki_formatter_spec.rb
+- spec/spec_helper.rb