danger-jazzy 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db4b71747b0acf87ce07d1b553e8a8a22575506c
-  data.tar.gz: 55ac443df45ae24bf49c03bca9f5aeb210a142c4
+  metadata.gz: b99f453de87c08e5609f3fd5d714600d9908dcd2
+  data.tar.gz: 43b3498db32cea77056c88bf2e4a2706e64e35b4
 SHA512:
-  metadata.gz: 9d0d09d7462955ff4aec1b25d1af88804cdca4beb62b7c3aa0b396485dc5ce94f2af60cd6ebbfd3ec4af29a570946dd34c22176ec54ba6fafd0b25b4636a8e25
-  data.tar.gz: b62f90b18fb9cffbdb10fc6bd11f6c1c9f838c0bb598253e5cd364089093b17f7a0679bd3cb15d811490f9ca3b4ff386bcfb4a1bcbc343334c277d128989eb3d
+  metadata.gz: 1729ec2ee260dfc2bd76ab05d3dd40c319622c55d7319f806b1e269c5047f8dece18394fdad9150ad206d16c10ff39ac81ed4d1e17a1e5bc4c048472ccdc866a
+  data.tar.gz: d319abe887ab76084131e7efe97db43ece579ad211866d182f7c4079e43ed3fc7fc8e2ab8ce40cd4c5543fe31c638f2915c827c4195ba6aacdfbae476ba1f741

data/.rubocop.yml

@@ -22,3 +22,9 @@ Style/SpecialGlobalVars:
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 90
+
+Metrics/AbcSize:
+  Max: 20

data/README.md

@@ -20,14 +20,14 @@ jazzy.check fail: :all</pre>
 jazzy.check warn: :modified</pre>
 </blockquote>
 
-<blockquote>Write a custom message for undocumented symbols in modified files.
+<blockquote>Write custom handling for undocumented symbols in modified files.
   <pre>
 jazzy.undocumented.each do |item|
     message "You forgot to document this", file:item.file, line:item.line
 end</pre>
 </blockquote>
 
-<blockquote>Write a custom message for undocumented symbols in all files.
+<blockquote>Write a custom handling for undocumented symbols in all files.
   <pre>
 jazzy.undocumented(:all).each do |item|
     message "You forgot to document this", file:item.file, line:item.line
@@ -39,6 +39,12 @@ end</pre>
 
 `path` - Path to the docs folder, defaults to 'docs/'.
 
+`ignore` - List of files to ignore, defaults to [].
+
+`message` -  Message to display, defaults to `Undocumented symbol %<symbol>s in *%<file>s*`.
+
+`inline_message` - Message to display inline, defaults to `Undocumented symbol %<symbol>s`.
+
 
 #### Methods
 

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/jazzy/plugin.rb

@@ -1,5 +1,4 @@
 module Danger
-  # rubocop:disable Metrics/LineLength
   # This is a danger plugin to check for undocumented symbols via Jazzy.
   #
   # @example Fail on undocumented symbols in modified files.
@@ -29,14 +28,27 @@ module Danger
   # @see  fwal/danger-jazzy
   # @tags jazzy, docs, documentation
   #
-  # rubocop:enable Metrics/LineLength
   class DangerJazzy < Plugin
-    DEFAULT_MESSAGE = 'Undocumented symbol.'.freeze
+    DEFAULT_MESSAGE = 'Undocumented symbol `%<symbol>s` in *%<file>s*'.freeze
+    DEFAULT_INLINE_MESSAGE = 'Undocumented symbol `%<symbol>s`'.freeze
 
     # Path to the docs folder, defaults to 'docs/'.
     # @return   [String]
     attr_accessor :path
 
+    # List of files to ignore, defaults to [].
+    # @return   [[String]]
+    attr_accessor :ignore
+
+    # Message to display, defaults to 'Undocumented symbol `%<symbol>s` in *%<file>s*'.
+    # @return   [String]
+    attr_accessor :message
+
+    # Message to display inline,
+    # defaults to 'Undocumented symbol `%<symbol>s`'.
+    # @return   [String]
+    attr_accessor :inline_message
+
     # Checks files for modified symbols.
     #
     # Takes a hash with the following keys:
@@ -79,6 +91,18 @@ module Danger
       @path || 'docs/'
     end
 
+    def ignored_files
+      @ignore || []
+    end
+
+    def message_template
+      @message || DEFAULT_MESSAGE
+    end
+
+    def inline_message_template
+      @inline_message || DEFAULT_INLINE_MESSAGE
+    end
+
     def undocumented_path
       File.join(docs_path, 'undocumented.json')
     end
@@ -90,6 +114,8 @@ module Danger
     def load_undocumented(scope)
       reader = UndocumentedReader.new(undocumented_path)
       @undocumented[scope] = reader.undocumented_symbols.select do |item|
+        next unless !item.nil? && item.file
+        next if ignored_files.include? item.file
         if scope == :modified
           files_of_interest.include?(item.file)
         else
@@ -108,15 +134,23 @@ module Danger
 
     def fail_check
       undocumented(fail_scope).each do |item|
-        # rubocop:disable Style/SignalException
-        fail DEFAULT_MESSAGE, file: item.file, line: item.line
-        # rubocop:enable Style/SignalException
+        # rubocop:disable Style/SignalException, Style/GuardClause
+        if item.file.nil? || item.line.nil?
+          fail message_template % item.to_h
+        else
+          fail inline_message_template % item.to_h, file: item.file, line: item.line
+        end
+        # rubocop:enable Style/SignalException, Style/GuardClause
       end
     end
 
     def warn_check
       undocumented(warn_scope).each do |item|
-        warn DEFAULT_MESSAGE, file: item.file, line: item.line
+        if item.file.nil? || item.line.nil?
+          warn message_template % item.to_h
+        else
+          warn inline_message_template % item.to_h, file: item.file, line: item.line
+        end
       end
     end
   end

data/lib/jazzy/undocumented_reader.rb

@@ -26,7 +26,9 @@ module Danger
     end
 
     def item_file(item)
-      path = Pathname.new(item['file'])
+      file = item['file']
+      return unless file
+      path = Pathname.new(file)
       path.relative_path_from(@working_path).to_s
     end
 

data/spec/fixtures/undocumented.json

@@ -13,6 +13,34 @@
       "symbol": "MyStruct.handleThing()",
       "symbol_kind": "source.lang.swift.decl.function.method.instance",
       "warning": "undocumented"
+    },
+    {
+      "file": "/MyOtherFile.swift",
+      "line": 12,
+      "symbol": "MyStruct.handleThing()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "other"
+    },
+    {
+      "file": "/MyExtensionFile.swift",
+      "line": null,
+      "symbol": "MyClass",
+      "symbol_kind": "source.lang.swift.decl.extension",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/MyExtensionFile.swift",
+      "line": null,
+      "symbol": "MyClass",
+      "symbol_kind": "source.lang.swift.decl.extension",
+      "warning": "undocumented"
+    },
+    {
+      "file": null,
+      "line": null,
+      "symbol": null,
+      "symbol_kind": null,
+      "warning": "undocumented"
     }
   ],
   "source_directory": "/"

data/spec/jazzy_spec.rb

@@ -15,9 +15,11 @@ module Danger
         @my_plugin = @dangerfile.jazzy
         @default_message = 'Undocumented symbol.'
         @my_plugin.path = 'spec/fixtures'
+        @my_plugin.message = @default_message
+        @my_plugin.inline_message = @default_message
       end
 
-      context 'changed files contains undocumented symbols' do
+      context 'containing changed files with undocumented symbols' do
         before do
           modified = Git::Diff::DiffFile.new(
             'base',
@@ -48,27 +50,27 @@ module Danger
         end
 
         it 'can find undocumented symbols in all files' do
-          expect(@my_plugin.undocumented(:all).length).to eq(2)
+          expect(@my_plugin.undocumented(:all).length).to eq(4)
         end
 
-        it 'fails on undocumented symbols only in modified files by default' do
+        it 'fails only in modified files by default' do
           @my_plugin.check
           expect(@dangerfile.status_report[:errors]).to eq([@default_message])
         end
 
-        it 'does not warn on undocumented symbols by default' do
+        it 'does not warn by default' do
           @my_plugin.check
           expect(@dangerfile.status_report[:warnings]).to eq([])
         end
 
-        it 'can fail on undocumented symbols in all files' do
+        it 'can fail in all files' do
           @my_plugin.check fail: :all
-          expect(@dangerfile.status_report[:errors]).to eq([@default_message, @default_message])
+          expect(@dangerfile.status_report[:errors].length).to eq(4)
         end
 
-        it 'can warn on undocumented symbols in all files' do
+        it 'can warn in all files' do
           @my_plugin.check warn: :all
-          expect(@dangerfile.status_report[:warnings]).to eq([@default_message, @default_message])
+          expect(@dangerfile.status_report[:warnings].length).to eq(4)
         end
 
         it 'does not fail if there is no undocumented json' do
@@ -76,6 +78,34 @@ module Danger
           @my_plugin.check
           expect(@dangerfile.status_report[:errors]).to eq([])
         end
+
+        it 'ignores files listed in ignore' do
+          @my_plugin.ignore = ['MyFile.swift']
+          @my_plugin.check
+          expect(@dangerfile.status_report[:errors]).to eq([])
+        end
+
+        it 'uses templates for violations' do
+          @my_plugin.inline_message = '%<symbol>s in %<file>s'
+          @my_plugin.check
+          expect(@dangerfile.status_report[:errors]).to eq(
+            ['MyClass.doStuff() in MyFile.swift']
+          )
+        end
+
+        it 'can switch template' do
+          @my_plugin.ignore = ['MyFile.swift']
+          @my_plugin.message = '%<symbol>s in %<file>s'
+          @my_plugin.inline_message = '%<symbol>s'
+          @my_plugin.check fail: :all
+
+          fixture = [
+            'MyStruct.handleThing()',
+            'MyClass in MyExtensionFile.swift',
+            'MyClass in MyExtensionFile.swift'
+          ]
+          expect(@dangerfile.status_report[:errors]).to eq(fixture)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jazzy
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Frederik Wallner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A danger plugin for validating documentation generated with jazzy