saddler-reporter-support 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6851e629d8a3ccd548179f3306bb04e2668a278
-  data.tar.gz: e869a1862e4490b6ae59accea7d6677eede631f3
+  metadata.gz: 8b503863e8c84a172963159aac112e6c9705b88b
+  data.tar.gz: c65a738b05a5d4e6d4ebcd2c8bdcf32740af221e
 SHA512:
-  metadata.gz: daacb9d2245a6aee4cbbc5f806c604126a22414d785144e7bd0275485aef120d2056559fe608782c99ed3c64a21dcfac3f14a1726bcb78cd2830d5e612ef3005
-  data.tar.gz: 2d1174cd66707c10a1d114eb685022eab569f8a7aac012ef81a736aadc8aae715a070089c4dcef0098f5b505f8d73ee9ea8c6a1db4a3339c72eed17fe8086517
+  metadata.gz: e31d7b315cee815b6e8898b1a99fd5c87a4c73f8fd7225459aedaddf796cd138f4bb49346c1f7a6add184aa0f63e206268630ff089aa562d8a9c1a4d00d31166
+  data.tar.gz: bccff7aa1a1e8710b6e7c20eb3aded3796b78503deaaba78abb238c84b473795c6a8571a189a9f809a4371211c4a3c537e25a3bf97f7d979013358c72572ef34

data/.conventional-changelog.context.js

@@ -0,0 +1,17 @@
+'use strict';
+var execSync = require('child_process').execSync;
+var URI = require('urijs');
+
+var gemspec = JSON.parse(execSync('bundle exec parse-gemspec-cli saddler-reporter-support.gemspec'));
+var homepageUrl = gemspec.homepage;
+var url = new URI(homepageUrl);
+var host = url.protocol() + '://' + url.authority();
+var owner = url.pathname().split('/')[1];
+var repository = url.pathname().split('/')[2];
+
+module.exports = {
+  version: gemspec.version,
+  host: host,
+  owner: owner,
+  repository: repository
+};

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/node_modules/

data/.rubocop.yml

@@ -12,6 +12,3 @@ Metrics/LineLength:
 Style/FileName:
   Exclude:
     - exe/*
-
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/.travis.yml

@@ -1,15 +1,17 @@
-language: ruby
+language: "ruby"
 sudo: false
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
+  - "1.9"
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "ruby-head"
+matrix:
+  allow_failures:
+    - rvm: "ruby-head"
 before_install:
-  - gem update bundler
+  - "gem update bundler"
+  - "bin/setup"
 notifications:
   email:
     - ogataken@gmail.com
-branches:
-  only:
-    - master

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in saddler-reporter-support.gemspec
 gemspec
+
+gem 'rubocop'
+gem 'yard'
+gem 'parse_gemspec-cli'

data/README.md

@@ -1,7 +1,45 @@
 # Saddler::Reporter::Support
 
-[![Gem Version](http://img.shields.io/gem/v/saddler-reporter-support.svg?style=flat)](http://badge.fury.io/rb/saddler-reporter-support)
-[![Build Status](http://img.shields.io/travis/packsaddle/ruby-saddler-reporter-support/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-saddler-reporter-support)
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
+
+> Interface for saddler-reporter. And utilities for saddler-reporter.
+
+
+## API
+
+Interface for saddler-reporter.
+
+### #initialize(output)
+
+#### output
+
+Type: `#puts`
+
+output interface (defaults to: $stdout)
+
+
+### #report(messages, options) -> void
+
+#### messages
+
+Type: `String`
+
+reporting message. checkstyle format.
+
+#### options
+
+Type: `Hash`
+
+options from saddler cli.
+
+
+And more *[details][docs-url]*.
+
+
+## Changelog
+
+[changelog.md](./changelog.md).
+
 
 ## Installation
 
@@ -19,12 +57,14 @@ Or install it yourself as:
 
     $ gem install saddler-reporter-support
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 1. Fork it ( https://github.com/packsaddle/ruby-saddler-reporter-support/fork )
@@ -32,3 +72,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+## License
+
+© [sanemat](http://sane.jp)
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[travis-url]: https://travis-ci.org/packsaddle/ruby-saddler-reporter-support
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-saddler-reporter-support/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/saddler-reporter-support
+[gem-image]: http://img.shields.io/gem/v/saddler-reporter-support.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/saddler-reporter-support
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb']
+DOC_OPTIONS = ['--debug', '--verbose']
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/bin/setup

@@ -1,7 +1,15 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
+#!/usr/bin/env ruby
 
-bundle install
-
-# Do any other automated setup that you need to do here
+require 'open3'
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(bundle install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(npm install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end

data/changelog.md

@@ -0,0 +1,4 @@
+<a name="0.1.1"></a>
+## [0.1.1](https://github.com/packsaddle/ruby-saddler-reporter-support/compare/v0.1.0...v0.1.1) (2015-09-30)
+
+* Improve document

data/lib/saddler/reporter/support/version.rb

@@ -1,7 +1,7 @@
 module Saddler
   module Reporter
     module Support
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

data/lib/saddler/reporter/support.rb

@@ -4,41 +4,180 @@ require 'saddler/reporter/support/version'
 
 module Saddler
   module Reporter
+    # Interface for saddler-reporter. And utilities for saddler-reporter
     module Support
+      # Interface for saddler-reporter
+      #
+      # @param output [Object] output interface (defaults to: $stdout).
+      #   Use StringIO for testing.
       def initialize(output)
         @output = output
       end
 
-      def report(messages, _options)
+      # Interface for saddler-reporter
+      #
+      # @param messages [String] reporting message. checkstyle format.
+      # @param options [Hash] options from saddler cli.
+      #
+      # @return [void]
+      def report(messages, options) # rubocop:disable Style/UnusedMethodArgument
         @output.puts messages
       end
 
-      # {"checkstyle"=>
-      #    {"file"=>
-      #       [{"error"=>
-      #           [{"@column"=>"4",
-      #             "@line"=>"22",
-      #             "@message"=>"Assignment Branch Condition size for report is too high. [34.34/15]",
-      #             "@severity"=>"info",
-      #             "@source"=>"com.puppycrawl.tools.checkstyle.Metrics/AbcSize"},
-      #            {"@column"=>"4",
-      #             "@line"=>"22",
-      #             "@message"=>"Cyclomatic complexity for report is too high. [10/6]",
-      #             "@severity"=>"info",
-      #             "@source"=>"com.puppycrawl.tools.checkstyle.Metrics/CyclomaticComplexity"},
-      #            {"@column"=>"6",
-      #             "@line"=>"39",
-      #             "@message"=>"Use space after control keywords.",
-      #             "@severity"=>"info",
-      #             "@source"=>"com.puppycrawl.tools.checkstyle.Style/SpaceAfterControlKeyword"}],
-      #         "@name"=>"/Users/sane/work/ruby-study/saddler/lib/saddler/cli.rb"},
-      #        {"@name"=>"/Users/sane/work/ruby-study/saddler/lib/saddler/reporter.rb"}]}}
+      # Parser from xml to Plain Old Ruby Object with Nori
+      #
+      # @example one file no error
+      #   xml = <<-XML
+      #   <?xml version='1.0' encoding='UTF-8'?>
+      #   <checkstyle version='4.3'>
+      #     <file name='/home/travis/build/jser/jser.github.io/_i18n/ja/_posts/2015/2015-09-16-react-0.14-eslint-1.4-es5.md'/>
+      #   </checkstyle>
+      #   XML
+      #
+      #   parse(xml)
+      #   #=>
+      #   {
+      #     'checkstyle' => {
+      #       'file' => {
+      #         '@name' => '/home/travis/build/jser/jser.github.io/_i18n/ja/_posts/2015/2015-09-16-react-0.14-eslint-1.4-es5.md'
+      #       },
+      #       '@version' => '4.3'
+      #     }
+      #   }
+      #
+      # @example one foile one error
+      #   xml = <<-XML
+      #   <?xml version='1.0'?>
+      #   <checkstyle>
+      #     <file name='lib/example/travis_ci.rb'>
+      #       <error column='120' line='7' message='Line is too long. [164/120]' severity='info' source='com.puppycrawl.tools.checkstyle.Metrics/LineLength'/>
+      #     </file>
+      #   </checkstyle>
+      #   XML
+      #
+      #   parse(xml)
+      #   #=>
+      #   {
+      #     'checkstyle' => {
+      #       'file' => {
+      #         'error' => {
+      #           '@column' => '120',
+      #           '@line' => '7',
+      #           '@message' => 'Line is too long. [164/120]',
+      #           '@severity' => 'info',
+      #           '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/LineLength'
+      #         },
+      #         '@name' => 'lib/example/travis_ci.rb'
+      #       }
+      #     }
+      #   }
+      #
+      # @example two files multi errors
+      #   xml = <<-XML
+      #   <?xml version='1.0'?>
+      #   <checkstyle>
+      #     <file name='example/invalid.rb'>
+      #       <error line='3' column='100' severity='info' message='Line is too long. [187/100]' source='com.puppycrawl.tools.checkstyle.Metrics/LineLength'/>
+      #     </file>
+      #     <file name='lib/checkstyle_filter/git/cli.rb'>
+      #       <error line='14' column='6' severity='info' message='Assignment Branch Condition size for diff is too high. [38.21/15]' source='com.puppycrawl.tools.checkstyle.Metrics/AbcSize'/>
+      #       <error line='14' column='6' severity='info' message='Cyclomatic complexity for diff is too high. [9/6]' source='com.puppycrawl.tools.checkstyle.Metrics/CyclomaticComplexity'/>
+      #       <error line='14' column='6' severity='info' message='Method has too many lines. [26/10]' source='com.puppycrawl.tools.checkstyle.Metrics/MethodLength'/>
+      #       <error line='14' column='6' severity='info' message='Perceived complexity for diff is too high. [10/7]' source='com.puppycrawl.tools.checkstyle.Metrics/PerceivedComplexity'/>
+      #       <error line='65' column='8' severity='info' message='Assignment Branch Condition size for file_element_error_line_no_in_modified? is too high. [16.16/15]' source='com.puppycrawl.tools.checkstyle.Metrics/AbcSize'/>
+      #       <error line='65' column='8' severity='info' message='Method has too many lines. [14/10]' source='com.puppycrawl.tools.checkstyle.Metrics/MethodLength'/>
+      #     </file>
+      #   </checkstyle>
+      #   XML
+      #
+      #   parse(xml)
+      #   #=>
+      #   {
+      #     'checkstyle' => {
+      #       'file' => [
+      #         {
+      #           'error' => {
+      #             '@line' => '3',
+      #             '@column' => '100',
+      #             '@severity' => 'info',
+      #             '@message' => 'Line is too long. [187/100]',
+      #             '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/LineLength'
+      #           },
+      #           '@name' => 'example/invalid.rb'
+      #         },
+      #         {
+      #           'error' => [
+      #             {
+      #               '@line' => '14',
+      #               '@column' => '6',
+      #               '@severity' => 'info',
+      #               '@message' => 'Assignment Branch Condition size for diff is too high. [38.21/15]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/AbcSize'
+      #             },
+      #             {
+      #               '@line' => '14',
+      #               '@column' => '6',
+      #               '@severity' => 'info',
+      #               '@message' => 'Cyclomatic complexity for diff is too high. [9/6]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/CyclomaticComplexity'
+      #             },
+      #             {
+      #               '@line' => '14',
+      #               '@column' => '6',
+      #               '@severity' => 'info',
+      #               '@message' => 'Method has too many lines. [26/10]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/MethodLength'
+      #             },
+      #             {
+      #               '@line' => '14',
+      #               '@column' => '6',
+      #               '@severity' => 'info',
+      #               '@message' => 'Perceived complexity for diff is too high. [10/7]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/PerceivedComplexity'
+      #             },
+      #             {
+      #               '@line' => '65',
+      #               '@column' => '8',
+      #               '@severity' => 'info',
+      #               '@message' => 'Assignment Branch Condition size for file_element_error_line_no_in_modified? is too high. [16.16/15]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/AbcSize'
+      #             },
+      #             {
+      #               '@line' => '65',
+      #               '@column' => '8',
+      #               '@severity' => 'info',
+      #               '@message' => 'Method has too many lines. [14/10]',
+      #               '@source' => 'com.puppycrawl.tools.checkstyle.Metrics/MethodLength'
+      #             }
+      #           ],
+      #           '@name' => 'lib/checkstyle_filter/git/cli.rb'
+      #         }
+      #       ]
+      #     }
+      #   }
+      #
+      # @param xml [String] xml string
+      #
+      # @return [Object] parsed
+      #
+      # @see ::Nori#parse
+      # @see https://github.com/savonrb/nori
       def parse(xml)
         Nori
           .new(parser: :rexml)
           .parse(xml)
       end
 
+      # @example absolute path
+      #   Dir.pwd #=> '/foo/bar'
+      #   file_relative_path_string('/foo/bar/baz') #=> 'baz'
+      #
+      # @example relative path
+      #   file_relative_path_string('./bar') #=> 'bar'
+      #
+      # @param file_name [String, #to_str] file path
+      #
+      # @return [String] file's relative path string from current
       def file_relative_path_string(file_name)
         if Pathname.new(file_name).absolute?
           Pathname.new(file_name).relative_path_from(Pathname.new(Dir.pwd)).to_s

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "conventional-changelog": "0.4.3",
+    "npm-check-updates": "^2.2.3",
+    "urijs": "^1.16.1"
+  },
+  "scripts": {
+    "changelog": "conventional-changelog -i changelog.md --overwrite --preset angular --context .conventional-changelog.context.js",
+    "ncu": "ncu -u"
+  }
+}

data/saddler-reporter-support.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['sanemat']
   spec.email         = ['o.gata.ken@gmail.com']
 
-  spec.summary       = 'Utilities for saddler-reporter'
-  spec.description   = 'Utilities for saddler-reporter'
+  spec.summary       = 'Interface for saddler-reporter. And utilities for saddler-reporter.'
+  spec.description   = 'Interface for saddler-reporter. And utilities for saddler-reporter.'
   spec.homepage      = 'https://github.com/packsaddle/ruby-saddler-reporter-support'
   spec.license       = 'MIT'
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'nori'
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'test-unit'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saddler-reporter-support
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +66,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Utilities for saddler-reporter
+description: Interface for saddler-reporter. And utilities for saddler-reporter.
 email:
 - o.gata.ken@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rubocop.yml"
 - ".tachikoma.yml"
@@ -84,8 +85,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - lib/saddler/reporter/support.rb
 - lib/saddler/reporter/support/version.rb
+- package.json
 - saddler-reporter-support.gemspec
 homepage: https://github.com/packsaddle/ruby-saddler-reporter-support
 licenses:
@@ -110,5 +113,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Utilities for saddler-reporter
+summary: Interface for saddler-reporter. And utilities for saddler-reporter.
 test_files: []
+has_rdoc: