danger-readme_docs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58106df39465d90d9fbba9602d7bab3701a1cfd3fcbeeb878d3f709cda5d0b82
-  data.tar.gz: f540679e69b67767fd3f980f5817a3a94fccfba6247f896f5e36a0830d7a261a
+  metadata.gz: 5ca6cfba023e02c516e194c0874490f0ddeeeee3b7de498aef92152875cf06f9
+  data.tar.gz: eb7079d740da7eda311ee493bb089a45e48cd2656df9ddbda24f0d18c0beadda
 SHA512:
-  metadata.gz: 92f651df1d3e3836b69961dfcb76b85a55254f0c48b0aa8db237cec4e71c4cc8a328922b4272a240d74bb7607f35aa91f4e3b0145fead9c4d5e9dba9d4439ee5
-  data.tar.gz: fdc897be18f2cedcbfc5b5b2d1fa05808bdd4cc6696137cc9c52386445eae8b7ed8da65c00f019af04126ea4655c471e6f3758565178d719319075a4c8eeb9f5
+  metadata.gz: bec4286eb58ccc246a66c369a737ae513a0c0356cad27f2abe3ea80ec5317e545ac59107936253cc932bdeeae227b7b83a4253457d4bdad40d70c1b1f22568c0
+  data.tar.gz: b285a1f7855fa3a0880a84d0031252831ae90206dd2813f2054555fdaa2f527f1e9dd44834b7954c38f3fc6a25f5b5101cc2b32278ea8b42122ac7db00e4743e

data/.rubocop.yml

@@ -3,10 +3,10 @@
 # If you don't like these settings, just delete this file :)
 
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.6
 
 Style/StringLiterals:
-  EnforcedStyle: double_quotes
+  EnforcedStyle: single_quotes
   Enabled: true
 
 # kind_of? is a good way to check a type
@@ -14,7 +14,7 @@ Style/ClassCheck:
   EnforcedStyle: kind_of?
 
 # It's better to be more explicit about the type
-Style/BracesAroundHashParameters:
+Layout/AccessModifierIndentation:
   Enabled: false
 
 # specs sometimes have useless assignments, which is fine
@@ -23,10 +23,10 @@ Lint/UselessAssignment:
     - '**/spec/**/*'
 
 # We could potentially enable the 2 below:
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 # HoundCI doesn't like this rule
@@ -130,7 +130,7 @@ Style/MixinGrouping:
 Style/FileName:
   Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Style/SpecialGlobalVars:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-readme_docs (0.0.1)
+    danger-readme_docs (0.0.2)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -133,7 +133,6 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
-  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (~> 2.0)
@@ -141,11 +140,11 @@ DEPENDENCIES
   guard (~> 2.14)
   guard-rspec (~> 4.7)
   listen (= 3.0.7)
-  pry
+  pry (~> 0.14.0)
   rake (~> 10.0)
   rspec (~> 3.4)
-  rubocop
-  yard
+  rubocop (~> 1.12.0)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
-   2.2.13
+   2.2.12

data/lib/danger_plugin.rb

@@ -1 +1,3 @@
-require "readme_docs/plugin"
+# frozen_string_literal: true
+
+require 'readme_docs/plugin'

data/lib/danger_readme_docs.rb

@@ -1 +1,3 @@
-require "readme_docs/gem_version"
+# frozen_string_literal: true
+
+require 'readme_docs/gem_version'

data/lib/readme_docs/gem_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ReadmeDocs
-  VERSION = "0.0.1".freeze
+  VERSION = '0.0.2'
 end

data/lib/readme_docs/plugin.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 module Danger
-  # This is your plugin class. Any attributes or methods you expose here will
-  # be available from within your Dangerfile.
-  #
-  # To be published on the Danger plugins site, you will need to have
-  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
-  # for generating documentation from your plugin source, and you can verify
-  # by running `danger plugins lint` or `bundle exec rake spec`.
+  # Check markdown files inside main README.md.
+  # Results are passed out as a string with warning.
   #
-  # You should replace these comments with a public description of your library.
+  # @example Running linter
   #
-  # @example Ensure people are well warned about merging on Mondays
+  #          # Runs a linter
+  #          readme_docs.lint
   #
-  #          my_plugin.warn_on_mondays
-  #
-  # @see  Mikhail Georgievskiy/danger-readme_docs
+  # @see  https://github.com/mikhailushka
   # @tags monday, weekends, time, rattata
   #
   class DangerReadmeDocs < Plugin
+    # Lints the globbed markdown files. Will fail if changed file was not added in main README.md.
+    # Generates a `string` with warning.
+    #
+    # @param   [String] files
+    #          A globbed string which should return the files that you want to lint, defaults to nil.
+    #          if nil, modified and added files from the diff will be used.
+    # @return  [void]
+    #
     def lint
       forgotten_files = []
 
@@ -27,7 +31,7 @@ module Danger
         file_expand_path = File.path(file)
         # unless include because excludes for string available in rails >= 4.0.2
         forgotten_files << file_expand_path unless main_readme_content.include?(file_expand_path)
-        
+
         warn(warning_generator(forgotten_files)) if forgotten_files.any?
       end
     end
@@ -36,7 +40,7 @@ module Danger
 
     # memoize file content
     def main_readme_content
-      @main_readme ||= File.read('README.md')
+      @main_readme_content ||= File.read('README.md')
     end
 
     def changed_files

data/spec/readme_docs_spec.rb

@@ -1,15 +1,17 @@
-require File.expand_path("../spec_helper", __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('spec_helper', __dir__)
 
 module Danger
   describe Danger::DangerReadmeDocs do
-    it "should be a plugin" do
+    it 'should be a plugin' do
       expect(Danger::DangerReadmeDocs.new(nil)).to be_a Danger::Plugin
     end
 
     #
     # You should test your custom attributes and methods here
     #
-    describe "with Dangerfile" do
+    describe 'with Dangerfile' do
       subject do
         @readme_docs.lint
         @readme_docs.status_report[:warnings]
@@ -40,7 +42,7 @@ module Danger
         let(:fake_main_readme) { '# Test' }
         let(:warnings) do
           [
-            "Please add mentions of sub readme files " \
+            'Please add mentions of sub readme files ' \
             "in main README.md:\n **spec/fixtures/README.md**"
           ]
         end
@@ -49,7 +51,7 @@ module Danger
 
         context 'when files are not readable' do
           let(:is_files_readable) { false }
-  
+
           it { is_expected.to be_empty }
         end
       end

data/spec/spec_helper.rb

@@ -1,28 +1,30 @@
-require "pathname"
-ROOT = Pathname.new(File.expand_path("../../", __FILE__))
-$:.unshift((ROOT + "lib").to_s)
-$:.unshift((ROOT + "spec").to_s)
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "pry"
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('..', __dir__))
+$:.unshift("#{ROOT}lib")
+$:.unshift("#{ROOT}spec")
 
-require "rspec"
-require "danger"
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
 
 if `git remote -v` == ''
-  puts "You cannot run tests without setting a local git remote on this repo"
+  puts 'You cannot run tests without setting a local git remote on this repo'
   puts "It's a weird side-effect of Danger's internals."
   exit(0)
 end
 
 # Use coloured output, it's the best.
 RSpec.configure do |config|
-  config.filter_gems_from_backtrace "bundler"
+  config.filter_gems_from_backtrace 'bundler'
   config.color = true
   config.tty = true
 end
 
-require "danger_plugin"
+require 'danger_plugin'
 
 # These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
 # If you are expanding these files, see if it's already been done ^.
@@ -40,7 +42,7 @@ def testing_ui
 
   cork = Cork::Board.new(out: @output)
   def cork.string
-    out.string.gsub(/\e\[([;\d]+)?m/, "")
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
   end
   cork
 end
@@ -50,11 +52,11 @@ end
 # running a PR on TravisCI
 def testing_env
   {
-    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
-    "TRAVIS_PULL_REQUEST" => "800",
-    "TRAVIS_REPO_SLUG" => "artsy/eigen",
-    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
-    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
   }
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-readme_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mikhail Georgievskiy
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Danger plugin to validate sub README mention in main README file