git_diff_parser 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dbd2e853cc2f2a086d9d7ca049d8d08a2c4ea20
-  data.tar.gz: 49457d76b8459a35bb7e4cd2a1ebf75c7a26648d
+  metadata.gz: 5b9c1edf73e6e914929331d565114ba7f3514aba
+  data.tar.gz: 07cf0a06016067f4139ddc4e1b62abb2af88e250
 SHA512:
-  metadata.gz: 9e2321ec9eaa16a52fd5f6c554177ed8cd1b3a49033a058c47c48cf4d3744d29cd30b130dc35cea2be204a43ab5e810e2b938f573d614940dcb711c738055d41
-  data.tar.gz: 3c4d956af424439d973aaed32f0884374a51bc05378d0d7015fa52c1db9dcd9d674cb7f4220b6116401288f230e41b1aa519320d4bc8c8e92353759f58e0c9fe
+  metadata.gz: b18677c9b988875a4eba90a303b72c41943579367e300b7c39d6423dc092f58912cf22df02ffce849c320cd9392cd8177afb7be35c8de67a4d6aae8b483f2b82
+  data.tar.gz: fc63c6812d623d479e6b2e73eebc35f47941f29b5c4d9c8f9bece40d7bcf90a6aa65fd0a5a230420596c1f63de57822a5ba29dea7e4fd328b9f991b59389caa7

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 git_diff_parser.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

@@ -4,3 +4,6 @@ source 'https://rubygems.org'
 gemspec
 gem 'byebug' if RUBY_VERSION >= '2.0.0'
 gem 'pry'
+gem 'rubocop'
+gem 'yard'
+gem 'parse_gemspec-cli'

data/README.md

@@ -1,9 +1,9 @@
 # GitDiffParser
 
-[![Gem Version](http://img.shields.io/gem/v/git_diff_parser.svg?style=flat)](http://badge.fury.io/rb/git_diff_parser)
-[![Build Status](http://img.shields.io/travis/packsaddle/ruby-git_diff_parser/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-git_diff_parser)
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
+
+> Parse `git diff` into patches and lines.
 
-Parser for `git diff`.
 
 ## Examples
 
@@ -95,6 +95,17 @@ patch.changed_lines
 # @content="+          body = concat_body(data)\n", @patch_position=13>]
 ```
 
+
+## API
+
+And more *[details][docs-url]*.
+
+
+## Changelog
+
+[changelog.md](./changelog.md).
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -111,12 +122,14 @@ Or install it yourself as:
 
     $ gem install git_diff_parser
 
+
 ## 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-git_diff_parser/fork )
@@ -125,10 +138,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+
 ## License
+
 ### git_diff_parser
 Copyright (c) 2015 sanemat. [Licensed under the MIT license](./LICENSE)
 
+
 ### original [thoughtbot/hound](https://github.com/thoughtbot/hound)
 
 Copyright (c) 2014 thoughtbot, inc. [Licensed under the MIT license](./thoughtbot-hound/LICENSE)
@@ -136,3 +152,11 @@ Copyright (c) 2014 thoughtbot, inc. [Licensed under the MIT license](./thoughtbo
 * lib/git_diff_parser/line.rb <- app/models/line.rb
 * lib/git_diff_parser/patch.rb <- app/models/patch.rb
 * spec/git_diff_parser/patch_spec.rb <- spec/models/patch_spec.rb
+
+
+[travis-url]: https://travis-ci.org/packsaddle/ruby-git_diff_parser
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-git_diff_parser/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/git_diff_parser
+[gem-image]: http://img.shields.io/gem/v/git_diff_parser.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/git_diff_parser
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,12 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 
 task default: :spec
+
+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="2.1.3"></a>
+## [2.1.3](https://github.com/packsaddle/ruby-git_diff_parser/compare/v2.1.2...v2.1.3) (2015-10-01)
+
+* Improve document

data/git_diff_parser.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['sanemat']
   spec.email         = ['o.gata.ken@gmail.com']
 
-  spec.summary       = 'Parser for `git diff`.'
-  spec.description   = 'Parse `git diff` result.'
+  spec.summary       = 'Parse `git diff` into patches and lines.'
+  spec.description   = 'Parse `git diff` into patches and lines.'
   spec.homepage      = 'https://github.com/packsaddle/ruby-git_diff_parser'
   spec.license       = 'MIT'
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
     .grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '>= 0'
+  spec.add_development_dependency 'rake', '>= 0'
+  spec.add_development_dependency 'rspec', '>= 0'
 end

data/lib/git_diff_parser.rb

@@ -4,7 +4,12 @@ require 'git_diff_parser/patch'
 require 'git_diff_parser/patches'
 require 'git_diff_parser/diff_parser'
 
+# Parse `git diff` into patches and lines
 module GitDiffParser
+
+  # @param contents [String] `git diff` result.
+  #
+  # @return [Patches<Patch>] parsed patches and lines
   def self.parse(contents)
     DiffParser.parse(contents)
   end

data/lib/git_diff_parser/diff_parser.rb

@@ -1,5 +1,11 @@
 module GitDiffParser
+  # Parse entire `git diff` into Patches and Patch
   class DiffParser
+    # Parse entire `git diff` into Patches and Patch
+    #
+    # @param contents [String] `git diff` result
+    #
+    # @return [Patches<Patch>] parsed object
     def self.parse(contents)
       body = false
       file_name = ''

data/lib/git_diff_parser/line.rb

@@ -1,7 +1,16 @@
 module GitDiffParser
+  # Parsed line
   class Line
     attr_reader :number, :patch_position
+    # @!attribute [r] number
+    #   @return [Integer] line number
+    # @!attribute [r] patch_position
+    #   @return [Integer] line patch position
 
+    # @param options [Hash] this is not options
+    # @option options [Integer] :number line number (required)
+    # @option options [String] :content content (required)
+    # @option options [Integer] :patch_position patch position (required)
     def initialize(options = {})
       fail(ArgumentError('number is required')) unless options[:number]
       fail(ArgumentError('content is required')) unless options[:content]
@@ -11,6 +20,7 @@ module GitDiffParser
       @patch_position = options[:patch_position]
     end
 
+    # @return [Boolean] true if line changed
     def changed?
       true
     end

data/lib/git_diff_parser/patch.rb

@@ -1,17 +1,58 @@
 module GitDiffParser
+  # Parsed patch
   class Patch
     RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
     MODIFIED_LINE = /^\+(?!\+|\+)/
     NOT_REMOVED_LINE = /^[^-]/
 
     attr_accessor :file, :body, :secure_hash
+    # @!attribute [rw] file
+    #   @return [String, nil] file path or nil
+    # @!attribute [rw] body
+    #   @return [String, nil] patch section in `git diff` or nil
+    #   @see #initialize
+    # @!attribute [rw] secure_hash
+    #   @return [String, nil] target sha1 hash or nil
 
+    # @param body [String] patch section in `git diff`.
+    #   GitHub's pull request file's patch.
+    #   GitHub's commit file's patch.
+    #
+    #    <<-BODY
+    #    @@ -11,7 +11,7 @@ def valid?
+    #
+    #       def run
+    #         api.create_pending_status(*api_params, 'Hound is working...')
+    #    -    @style_guide.check(pull_request_additions)
+    #    +    @style_guide.check(api.pull_request_files(@pull_request))
+    #         build = repo.builds.create!(violations: @style_guide.violations)
+    #         update_api_status(build)
+    #       end
+    #    @@ -19,6 +19,7 @@ def run
+    #       private
+    #
+    #       def update_api_status(build = nil)
+    #    +    # might not need this after using Rubocop and fetching individual files.
+    #         sleep 1
+    #         if @style_guide.violations.any?
+    #           api.create_failure_status(*api_params, 'Hound does not approve', build_url(build))
+    #    BODY
+    #
+    # @param options [Hash] options
+    # @option options [String] :file file path
+    # @option options [String] 'file' file path
+    # @option options [String] :secure_hash target sha1 hash
+    # @option options [String] 'secure_hash' target sha1 hash
+    #
+    # @see https://developer.github.com/v3/repos/commits/#get-a-single-commit
+    # @see https://developer.github.com/v3/pulls/#list-pull-requests-files
     def initialize(body, options = {})
       @body = body || ''
       @file = options[:file] || options['file'] if options[:file] || options['file']
       @secure_hash = options[:secure_hash] || options['secure_hash'] if options[:secure_hash] || options['secure_hash']
     end
 
+    # @return [Array<Line>] changed lines
     def changed_lines
       line_number = 0
 
@@ -35,10 +76,14 @@ module GitDiffParser
       end
     end
 
+    # @return [Array<Integer>] changed line numbers
     def changed_line_numbers
       changed_lines.map(&:number)
     end
 
+    # @param line_number [Integer] line number
+    #
+    # @return [Integer, nil] patch position
     def find_patch_position_by_line_number(line_number)
       target = changed_lines.find { |line| line.number == line_number }
       return nil unless target

data/lib/git_diff_parser/patches.rb

@@ -1,26 +1,37 @@
 require 'delegate'
 module GitDiffParser
+  # The array of patch
   class Patches < DelegateClass(Array)
+    # @return [Patches<Patch>]
     def self.[](*ary)
       new(ary)
     end
 
+    # @return [Patches<Patch>]
     def initialize(*args)
       super Array.new(*args)
     end
 
+    # @return [Array<String>] file path
     def files
       map(&:file)
     end
 
+    # @return [Array<String>] target sha1 hash
     def secure_hashes
       map(&:secure_hash)
     end
 
+    # @param file [String] file path
+    #
+    # @return [Patch, nil]
     def find_patch_by_file(file)
       find { |patch| patch.file == file }
     end
 
+    # @param secure_hash [String] target sha1 hash
+    #
+    # @return [Patch, nil]
     def find_patch_by_secure_hash(secure_hash)
       find { |patch| patch.secure_hash == secure_hash }
     end

data/lib/git_diff_parser/version.rb

@@ -1,3 +1,3 @@
 module GitDiffParser
-  VERSION = '2.1.2'
+  VERSION = '2.1.3'
 end

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"
+  }
+}

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: git_diff_parser
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,13 +52,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Parse `git diff` result.
+description: Parse `git diff` into patches and lines.
 email:
 - o.gata.ken@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -71,6 +72,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - git_diff_parser.gemspec
 - lib/git_diff_parser.rb
 - lib/git_diff_parser/diff_parser.rb
@@ -78,6 +80,7 @@ files:
 - lib/git_diff_parser/patch.rb
 - lib/git_diff_parser/patches.rb
 - lib/git_diff_parser/version.rb
+- package.json
 - thoughtbot-hound/LICENSE
 homepage: https://github.com/packsaddle/ruby-git_diff_parser
 licenses:
@@ -102,5 +105,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Parser for `git diff`.
+summary: Parse `git diff` into patches and lines.
 test_files: []
+has_rdoc: