danger-readme_docs 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ca6cfba023e02c516e194c0874490f0ddeeeee3b7de498aef92152875cf06f9
-  data.tar.gz: eb7079d740da7eda311ee493bb089a45e48cd2656df9ddbda24f0d18c0beadda
+  metadata.gz: ef1f1fd7610512787d6d22e7510e6b11297876ba60d1c513bc4a6a86cfed68d0
+  data.tar.gz: 7017fec86fec91021161055fb561b07eae96c31b3282f2131d133e7b8d232028
 SHA512:
-  metadata.gz: bec4286eb58ccc246a66c369a737ae513a0c0356cad27f2abe3ea80ec5317e545ac59107936253cc932bdeeae227b7b83a4253457d4bdad40d70c1b1f22568c0
-  data.tar.gz: b285a1f7855fa3a0880a84d0031252831ae90206dd2813f2054555fdaa2f527f1e9dd44834b7954c38f3fc6a25f5b5101cc2b32278ea8b42122ac7db00e4743e
+  metadata.gz: 0710efade43d95fcd94c4d27251d0b205d6b6fc2a2ef15be18ac79958539d76a8ad183f7f4f7ae01146434a8f5fa3530e35104d3457bdaa9ab7bbfe4f96a6a59
+  data.tar.gz: c86f53c02c4583f309838cc41e1d24761cddc19652a4b663a604c46248a5cbea779e6044e609ce95b7c0f60a9a892e666a31b821b30b692721a1229ebf09c552

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-readme_docs (0.0.2)
+    danger-readme_docs (0.1.0)
       danger-plugin-api (~> 1.0)
 
 GEM

data/danger-readme_docs.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.4'
 
   # Linting code and docs
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency 'rubocop', '~> 1.12.0'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'
@@ -44,5 +44,5 @@ Gem::Specification.new do |spec|
   #    binding.pry
   #
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry', '~> 0.14.0'
 end

data/lib/readme_docs/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReadmeDocs
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/readme_docs/plugin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Danger
-  # Check markdown files inside main README.md.
+  # Check readme files with any extesion inside main README.md.
   # Results are passed out as a string with warning.
   #
   # @example Running linter
@@ -13,7 +13,7 @@ module Danger
   # @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.
+    # Lints the globbed readme files. Will fail if changed file was not added in main README.md.
     # Generates a `string` with warning.
     #
     # @param   [String] files
@@ -25,22 +25,25 @@ module Danger
       forgotten_files = []
 
       changed_files.each do |file|
-        next unless File.readable?(file)
-        next unless file.end_with?('.md')
+        next unless valid_file?(file)
 
         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?
+        forgotten_files << file_expand_path unless main_readme_content.include?(file_expand_path.downcase)
       end
+
+      warn(warning_generator(forgotten_files)) if forgotten_files.any?
     end
 
     private
 
+    def valid_file?(file)
+      File.readable?(file) &&
+        File.basename(file, File.extname(file)).downcase == 'readme'
+    end
+
     # memoize file content
     def main_readme_content
-      @main_readme_content ||= File.read('README.md')
+      @main_readme_content ||= File.read('README.md').downcase
     end
 
     def changed_files
@@ -48,7 +51,8 @@ module Danger
     end
 
     def warning_generator(files)
-      "Please add mentions of sub readme files in main README.md:\n **#{files.join('<br/>')}**"
+      'Please add mentions of sub readme files ' \
+      "in main README.md:\n **#{files.join('<br/>')}**"
     end
   end
 end

data/spec/readme_docs_spec.rb

@@ -33,21 +33,56 @@ module Danger
       it { is_expected.to be_empty }
 
       context 'when yml file changed' do
-        let(:fake_new_readme_path) { 'spec/fixtures/some.yml' }
+        let(:fake_main_readme) { '# Test \n spec/fixtures/README.yml' }
+        let(:fake_new_readme_path) { 'spec/fixtures/readme.yml' }
 
         it { is_expected.to be_empty }
       end
 
-      context 'without mention in main README' do
+      context 'when file is not readme' do
+        let(:fake_main_readme) { '# Test' }
+        let(:fake_new_readme_path) { 'spec/fixtures/readmessio.yml' }
+
+        it { is_expected.to be_empty }
+      end
+
+      context 'when file name added in lower case' do
+        let(:fake_main_readme) { '# Test \n spec/fixtures/readme.md' }
+        let(:fake_new_readme_path) { 'spec/fixtures/README.md' }
+
+        it { is_expected.to be_empty }
+      end
+
+      context 'when with multiple readmes' do
         let(:fake_main_readme) { '# Test' }
-        let(:warnings) do
+        let(:fake_new_readmes) do
           [
-            'Please add mentions of sub readme files ' \
-            "in main README.md:\n **spec/fixtures/README.md**"
+            'spec/fixtures/README.md',
+            'spec/random/README.md',
+            'random/random/README.md'
           ]
         end
+        let(:warning) do
+          'Please add mentions of sub readme files ' \
+          "in main README.md:\n **spec/fixtures/README.md<br/>" \
+          'spec/random/README.md<br/>random/random/README.md**'
+        end
+
+        before do
+          allow(@readme_docs.git).to receive(:modified_files).and_return(fake_new_readmes)
+        end
+
+        it { is_expected.to eq([warning]) }
+      end
+
+      context 'without mention in main README' do
+        let(:fake_main_readme) { '# Test' }
+        let(:warning) do
+          'Please add mentions of sub readme files ' \
+          "in main README.md:\n **spec/fixtures/README.md**"
+        end
 
-        it { is_expected.to eq(warnings) }
+        it { is_expected.to eq([warning]) }
 
         context 'when files are not readable' do
           let(:is_files_readable) { false }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-readme_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Mikhail Georgievskiy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -70,30 +70,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 description:
 email:
 - m.georgievskiy@rambler-co.ru