danger-suggester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 914c57b0044329d100595db51bd52d30c73c31f2
+  data.tar.gz: 8c7216939ba27bcf0d7c07f59b5d95f3009048c1
+SHA512:
+  metadata.gz: 86deaebae81b426eea652bd67e1724a1d271b582977367b99a1919abab4bbe33c42107fbe026d25fd935a44513c875d292671252876beb63ffc29144a2ffaf90
+  data.tar.gz: 8e94a4dd2d0110dc41b26c7fd4fe4258466c4e140533d1db34775c39f0d9e4a27959288053498c89b2058539b1b317136e4fdf051e322a4e337a3e54b40d7191

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+jobs:
+  danger:
+    machine: true
+    steps:
+      - checkout
+      - run:
+          command: gem install bundler -v 1.17.1
+          name: gem install bundler -v 1.17.1
+      - run:
+          command: bundle install
+          name: bundle install
+      - run:
+          command: bundle exec rubocop --auto-correct
+          name: rubocop
+      - run:
+          command: bundle exec danger
+          name: danger
+          when: always
+  rspec:
+    machine: true
+    steps:
+      - checkout
+      - run:
+          command: gem install bundler -v 1.17.1
+          name: gem install bundler -v 1.17.1
+      - run:
+          command: bundle install
+          name: bundle install
+      - run:
+          command: bundle exec rspec
+          name: rspec
+  rubocop:
+    machine: true
+    steps:
+      - checkout
+      - run:
+          command: gem install bundler -v 1.17.1
+          name: gem install bundler -v 1.17.1
+      - run:
+          command: bundle install
+          name: bundle install
+      - run:
+          command: bundle exec rubocop
+          name: rubocop
+version: 2
+workflows:
+  version: 2
+  test:
+    jobs:
+      - danger
+      - rspec
+      - rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 - 2018-11-15
+
+### Added
+
+- Add features to suggest code changes through inline comments in pull requests.

data/Dangerfile

@@ -0,0 +1 @@
+suggester.suggest

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in danger-suggester.gemspec
+gemspec
+
+gem 'pry'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    danger-suggester (0.1.0)
+      danger
+      git_diff
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.8.0)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1.5)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    diff-lcs (1.3)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    git (1.5.0)
+    git_diff (0.4.1)
+    jaro_winkler (1.5.1)
+    kramdown (1.17.0)
+    method_source (0.9.2)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  danger-suggester!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ryo Nakamura
+
+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,48 @@
+# Danger::Suggester
+
+[![CircleCI](https://circleci.com/gh/r7kamura/danger-suggester.svg?style=svg)](https://circleci.com/gh/r7kamura/workflows/danger-suggester)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/r7kamura/danger-suggester)
+
+A Danger plug-in to suggest code changes through inline comments in pull requests.
+
+## Requirements
+
+- Ruby 2.2 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'danger-suggester'
+```
+
+And then execute:
+
+```
+bundle
+```
+
+Or install it yourself as:
+
+```
+gem install danger-suggester
+```
+
+## Usage
+
+Add this line to your application's Dangerfile:
+
+```ruby
+suggester.suggest
+```
+
+And then execute `danger` after correcting code by some linter tools (e.g. `rubocop --auto-correct`).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/danger-suggester.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'danger/suggester'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/danger-suggester.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'danger/suggester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-suggester'
+  spec.version       = Danger::Suggester::VERSION
+  spec.authors       = ['Ryo Nakamura']
+  spec.email         = ['r7kamura@gmail.com']
+
+  spec.summary       = 'A Danger plug-in to suggest code changes through inline comments in pull requests.'
+  spec.homepage      = 'https://github.com/r7kamura/danger-suggester'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'danger'
+  spec.add_dependency 'git_diff'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/danger/danger_suggester.rb

@@ -0,0 +1,73 @@
+require 'danger'
+require 'danger/suggester/file'
+require 'danger/suggester/suggestion'
+require 'git_diff'
+
+module Danger
+  class DangerSuggester < ::Danger::Plugin
+    def suggest
+      suggestions_for_added_lines.each do |suggestion|
+        markdown(
+          suggestion.message,
+          file: suggestion.path,
+          line: suggestion.line
+        )
+      end
+    end
+
+    private
+
+    # @return [Hash{String => Array<Integer>}]
+    def added_lines_in_commits
+      @added_lines_in_commits ||= begin
+        origin = ::Hash.new do |hash, key|
+          hash[key] = []
+        end
+        ::GitDiff.from_string(diff_string_from_commits).files.each_with_object(origin) do |file, result|
+          result[file.b_path] = file.hunks.flat_map do |hunk|
+            hunk.lines.grep(::GitDiff::Line::Addition).map do |line|
+              line.line_number.right
+            end
+          end
+        end
+      end
+    end
+
+    # @return [String]
+    def diff_string_from_commits
+      git.diff.patch
+    end
+
+    # @return [String]
+    def diff_string_from_unstaged_changes
+      `git diff`
+    end
+
+    # @return [Array<Danger::Suggester::File>]
+    def files
+      ::GitDiff.from_string(diff_string_from_unstaged_changes).files.map do |file|
+        ::Danger::Suggester::File.new(file)
+      end
+    end
+
+    # @return [Array<Danger::Suggester::Suggestion>]
+    def suggestions_for_added_lines
+      suggestions_for_unstaged_changes.select do |suggestion|
+        added_lines_in_commits[suggestion.path].include?(suggestion.line)
+      end
+    end
+
+    # @return [Array<Danger::Suggester::Suggestion>]
+    def suggestions_for_unstaged_changes
+      files.select(&:suggestible?).flat_map do |file|
+        file.changes.select(&:suggestible?).map do |change|
+          ::Danger::Suggester::Suggestion.new(
+            content: change.added_content,
+            line: change.first_line_number,
+            path: file.a_path
+          )
+        end
+      end
+    end
+  end
+end

data/lib/danger/suggester.rb

@@ -0,0 +1 @@
+require 'danger/suggester/version'

data/lib/danger/suggester/change.rb

@@ -0,0 +1,44 @@
+require 'git_diff'
+
+module Danger
+  module Suggester
+    class Change
+      # @param [Array<GitDiff::Line::Context>]
+      def initialize(chunks)
+        @chunks = chunks
+      end
+
+      # @return [String]
+      def added_content
+        added_lines.map do |line|
+          line.content[1..-1]
+        end.join("\n")
+      end
+
+      # @return [Integer]
+      def first_line_number
+        @chunks.first.line_number.left
+      end
+
+      # @return [Boolean]
+      def suggestible?
+        deleted_lines.count == 1
+      end
+
+      private
+
+      def added_lines
+        @chunks.drop_while do |line|
+          line.is_a?(::GitDiff::Line::Deletion)
+        end
+      end
+
+      # @return [Integer]
+      def deleted_lines
+        @chunks.take_while do |line|
+          line.is_a?(::GitDiff::Line::Deletion)
+        end
+      end
+    end
+  end
+end

data/lib/danger/suggester/file.rb

@@ -0,0 +1,41 @@
+require 'danger/suggester/hunk'
+
+module Danger
+  module Suggester
+    class File
+      # @param [GitDiff::File] file
+      def initialize(file)
+        @file = file
+      end
+
+      # @return [String]
+      def a_path
+        @file.a_path
+      end
+
+      # @return [Array<Danger::Suggester::Change>]
+      def changes
+        hunks.flat_map(&:changes)
+      end
+
+      # @return [Boolean]
+      def suggestible?
+        !renamed?
+      end
+
+      private
+
+      # @return [Array<Danger::Suggester::Hunk>]
+      def hunks
+        @file.hunks.map do |hunk|
+          ::Danger::Suggester::Hunk.new(hunk)
+        end
+      end
+
+      # @return [Boolean]
+      def renamed?
+        @file.a_path != @file.b_path
+      end
+    end
+  end
+end

data/lib/danger/suggester/hunk.rb

@@ -0,0 +1,37 @@
+require 'danger/suggester/change'
+require 'git_diff'
+
+module Danger
+  module Suggester
+    class Hunk
+      # @param [GitDiff::Hunk] hunk
+      def initialize(hunk)
+        @hunk = hunk
+      end
+
+      # @return [Array<Danger::Suggester::Change>]
+      def changes
+        chunks_without_context.map do |chunk|
+          ::Danger::Suggester::Change.new(chunk)
+        end
+      end
+
+      # @return [Array<Array<GitDiff::Line::Context>>]
+      def chunks
+        @hunk.lines.chunk_while do |a, b|
+          a.instance_of?(::GitDiff::Line::Context) && b.instance_of?(::GitDiff::Line::Context) ||
+            a.instance_of?(::GitDiff::Line::Deletion) && b.instance_of?(::GitDiff::Line::Deletion) ||
+            a.instance_of?(::GitDiff::Line::Deletion) && b.instance_of?(::GitDiff::Line::Addition) ||
+            a.instance_of?(::GitDiff::Line::Addition) && b.instance_of?(::GitDiff::Line::Addition)
+        end
+      end
+
+      # @return [Array<Array<GitDiff::Line::Context>>]
+      def chunks_without_context
+        chunks.reject do |chunk|
+          chunk.first.instance_of?(::GitDiff::Line::Context)
+        end
+      end
+    end
+  end
+end

data/lib/danger/suggester/suggestion.rb

@@ -0,0 +1,25 @@
+module Danger
+  module Suggester
+    class Suggestion
+      # @return [Integer]
+      attr_reader :line
+
+      # @param [String]
+      attr_reader :path
+
+      # @param [String] content
+      # @param [Integer] line
+      # @param [String] path
+      def initialize(content:, line:, path:)
+        @content = content
+        @line = line
+        @path = path
+      end
+
+      # @return [String]
+      def message
+        "```suggestion\n#{@content}\n```"
+      end
+    end
+  end
+end

data/lib/danger/suggester/version.rb

@@ -0,0 +1,5 @@
+module Danger
+  module Suggester
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'danger/danger_suggester'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: danger-suggester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-14 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: git_diff
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dangerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- danger-suggester.gemspec
+- lib/danger/danger_suggester.rb
+- lib/danger/suggester.rb
+- lib/danger/suggester/change.rb
+- lib/danger/suggester/file.rb
+- lib/danger/suggester/hunk.rb
+- lib/danger/suggester/suggestion.rb
+- lib/danger/suggester/version.rb
+- lib/danger_plugin.rb
+homepage: https://github.com/r7kamura/danger-suggester
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Danger plug-in to suggest code changes through inline comments in pull
+  requests.
+test_files: []