danger-jazzy 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35d58202f487e509470c90aab65fa9cea18e90a0
-  data.tar.gz: 05dfed94d0ae49d856ace9152dc9baf416239af6
+  metadata.gz: e8bb53cde4ba129560e1f27e05941d12307f34ac
+  data.tar.gz: d73cfb80d5771789f127f82a92a461c2e55f487a
 SHA512:
-  metadata.gz: 0a10983eb00e1005984ce3ac4bf313c40d08a2c9b85404e304f79d21bc96ce892b15a0ca36af22e3fc98c94dff97fd48e92b7bb71440729f45c07d87a30e5775
-  data.tar.gz: 53c25744ba1dd7f8822344160fc678b4029125c2dfd00155247e26995268681320523fce11b928938f0bd39830704279d91cb46750ddae4f24d73691f6fb6218
+  metadata.gz: 5471744bf514104875f84a8f6a60755b8cb6e3ee126331930031111bb4e75208d15becd15c3fcb5be878a9683e7b5cb29278090c79bf3d457bd95223537ede85
+  data.tar.gz: cc5e4e7196b8ffe0bfc3bc1502ea5aee9c2d23677e965ac4a4bbb4fa12177b9824058911bfb9e80cf03972529d722778dbba11f1e35c64f9e9ba3cae160e9a03

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 .idea/
 .yardoc/
 Gemfile.lock
+coverage/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+    - 'spec/fixtures/**/*'
+    - 'lib/danger/plugin_support/plugin_parser.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/*'
+    - 'danger-jazzy.gemspec'
+
+Style/IfUnlessModifier:
+  Exclude:
+    - 'Gemfile'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'danger-jazzy.gemspec'

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased][]
 
+## [1.0.0][] (2016-11-22)
+* Completely new api!
+
 ## [0.1.1][] (2016-11-09)
 * Bugfixes.
 

data/Gemfile

@@ -3,4 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in danger-jazzy.gemspec
 gemspec
 
-gem 'chandler', '~> 0.5.0'
+if RUBY_VERSION == '2.3.1'
+  gem 'chandler', '~> 0.5.0'
+end

data/README.md

@@ -1,26 +1,58 @@
 ### jazzy
 This is a danger plugin to check for undocumented symbols via Jazzy.
 
-<blockquote>Warn about undocumented symbols.
+<blockquote>Fail on undocumented symbols in modified files.
   <pre>
-jazzy.warn_of_undocumented</pre>
+jazzy.check</pre>
 </blockquote>
 
-<blockquote>Write a custom message for undocumented symbols.
+<blockquote>Fail on undocumented symbols in all files.
   <pre>
-jazzy.undocumented do |file,line|
-    message("You forgot to document this", file:file, line:line)
+jazzy.check fail: :all</pre>
+</blockquote>
+
+<blockquote>Warn about undocumented symbols in modified files.
+  <pre>
+jazzy.check warn: :modified</pre>
+</blockquote>
+
+<blockquote>Write a custom message 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.
+  <pre>
+jazzy.undocumented(:all).each do |item|
+    message "You forgot to document this", file:item.file, line:item.line
 end</pre>
 </blockquote>
 
 
 #### Attributes
 
-`path_to_docs` - Path to the docs folder, defaults to 'docs/'.
+`path` - Path to the docs folder, defaults to 'docs/'.
 
 
 #### Methods
 
-`warn_of_undocumented` - Warns about undocumented symbols.
+`check` - Checks files for modified symbols.
+
+Takes a hash with the following keys:
+
+ * `fail`
+ * `warn`
+
+Available scopes:
+
+ * `modified`
+ * `all`
+
+`undocumented` - Returns a list of undocumented symbols in the current diff.
+
+Available scopes:
 
-`undocumented` - Finds and yields information about undocumented symbols.
+ * `modified`
+ * `all`

data/danger-jazzy.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jazzy::VERSION
   spec.authors       = ['Frederik Wallner']
   spec.email         = ['frederik.wallner@gmail.com']
-  spec.description   = %q{A short description of danger-jazzy.}
-  spec.summary       = %q{A longer description of danger-jazzy.}
+  spec.description   = 'A danger plugin for validating documentation generated with jazzy'
+  spec.summary       = 'A danger plugin for validating documentation generated with jazzy'
   spec.homepage      = 'https://github.com/fwal/danger-jazzy'
   spec.license       = 'MIT'
 
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
   spec.add_runtime_dependency 'json', '~> 1.8'
 
@@ -31,6 +33,7 @@ Gem::Specification.new do |spec|
   # Linting code and docs
   spec.add_development_dependency 'rubocop', '~> 0.41'
   spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'coveralls', '~> 0.8.15'
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.1.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/jazzy/plugin.rb

@@ -1,46 +1,82 @@
 module Danger
+  # rubocop:disable Metrics/LineLength
   # This is a danger plugin to check for undocumented symbols via Jazzy.
   #
-  # @example Warn about undocumented symbols.
+  # @example Fail on undocumented symbols in modified files.
   #
-  #          jazzy.warn_of_undocumented
+  #          jazzy.check
   #
-  # @example Write a custom message for undocumented symbols.
+  # @example Fail on undocumented symbols in all files.
   #
-  #          jazzy.undocumented do |file,line|
-  #              message("You forgot to document this", file:file, line:line)
+  #          jazzy.check fail: :all
+  #
+  # @example Warn about undocumented symbols in modified files.
+  #
+  #          jazzy.check warn: :modified
+  #
+  # @example Write a custom message for undocumented symbols in modified files.
+  #
+  #          jazzy.undocumented.each do |item|
+  #              message "You forgot to document this", file:item.file, line:item.line
+  #          end
+  #
+  # @example Write a custom message for undocumented symbols in all files.
+  #
+  #          jazzy.undocumented(:all).each do |item|
+  #              message "You forgot to document this", file:item.file, line:item.line
   #          end
   #
   # @see  fwal/danger-jazzy
   # @tags jazzy, docs, documentation
   #
+  # rubocop:enable Metrics/LineLength
   class DangerJazzy < Plugin
     DEFAULT_MESSAGE = 'Undocumented symbol.'.freeze
 
     # Path to the docs folder, defaults to 'docs/'.
     # @return   [String]
-    attr_accessor :path_to_docs
+    attr_accessor :path
 
-    # Warns about undocumented symbols.
-    # @return  [void]
-    def warn_of_undocumented
-      undocumented.each do |item|
-        warn DEFAULT_MESSAGE, file: item.file, line: item.line
-      end
+    # Checks files for modified symbols.
+    #
+    # Takes a hash with the following keys:
+    #
+    #  * `fail`
+    #  * `warn`
+    #
+    # Available scopes:
+    #
+    #  * `modified`
+    #  * `all`
+    #
+    # @param [Hash] config
+    # @return [void]
+    def check(config = {})
+      @config = config
+      fail_check
+      warn_check
     end
 
     # Returns a list of undocumented symbols in the current diff.
+    #
+    # Available scopes:
+    #
+    #  * `modified`
+    #  * `all`
+    #
+    # @param [Key] scope
     # @return [Array of symbol]
-    def undocumented
-      return unless File.exist? undocumented_path
-      load_undocumented if @undocumented.nil?
-      @undocumented
+    def undocumented(scope = :modified)
+      return [] unless scope != :ignore && File.exist?(undocumented_path)
+      @undocumented = { modified: [], all: [] } if @undocumented.nil?
+      load_undocumented(scope) if @undocumented[scope].empty?
+      @undocumented[scope]
     end
 
     private
 
     def docs_path
-      @path_to_docs || 'docs/'
+      @path || 'docs/'
     end
 
     def undocumented_path
@@ -51,10 +87,36 @@ module Danger
       git.modified_files + git.added_files
     end
 
-    def load_undocumented
+    def load_undocumented(scope)
       reader = UndocumentedReader.new(undocumented_path)
-      @undocumented = reader.undocumented_symbols.select do |item|
-        files_of_interest.include?(item.file)
+      @undocumented[scope] = reader.undocumented_symbols.select do |item|
+        if scope == :modified
+          files_of_interest.include?(item.file)
+        else
+          true
+        end
+      end
+    end
+
+    def fail_scope
+      @config[:fail] || :modified
+    end
+
+    def warn_scope
+      @config[:warn] || :ignore
+    end
+
+    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
+      end
+    end
+
+    def warn_check
+      undocumented(warn_scope).each do |item|
+        warn DEFAULT_MESSAGE, file: item.file, line: item.line
       end
     end
   end

data/spec/jazzy_spec.rb

@@ -14,6 +14,7 @@ module Danger
         @dangerfile = testing_dangerfile
         @my_plugin = @dangerfile.jazzy
         @default_message = 'Undocumented symbol.'
+        @my_plugin.path = 'spec/fixtures'
       end
 
       context 'changed files contains undocumented symbols' do
@@ -42,10 +43,38 @@ module Danger
             .and_return(['MyFile.swift'])
         end
 
-        it 'Warns on undocumented symbols' do
-          @my_plugin.path_to_docs = 'spec/fixtures'
-          @my_plugin.warn_of_undocumented
-          expect(@dangerfile.status_report[:warnings]).to eq([@default_message])
+        it 'finds undocumented symbols only in modified files by default' do
+          expect(@my_plugin.undocumented.length).to eq(1)
+        end
+
+        it 'can find undocumented symbols in all files' do
+          expect(@my_plugin.undocumented(:all).length).to eq(2)
+        end
+
+        it 'fails on undocumented symbols 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
+          @my_plugin.check
+          expect(@dangerfile.status_report[:warnings]).to eq([])
+        end
+
+        it 'can fail on undocumented symbols in all files' do
+          @my_plugin.check fail: :all
+          expect(@dangerfile.status_report[:errors]).to eq([@default_message, @default_message])
+        end
+
+        it 'can warn on undocumented symbols in all files' do
+          @my_plugin.check warn: :all
+          expect(@dangerfile.status_report[:warnings]).to eq([@default_message, @default_message])
+        end
+
+        it 'does not fail if there is no undocumented json' do
+          @my_plugin.path = 'spec/empty'
+          @my_plugin.check
+          expect(@dangerfile.status_report[:errors]).to eq([])
         end
       end
     end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ require 'pry'
 require 'rspec'
 require 'danger'
 
+require 'coveralls'
+Coveralls.wear!
+
 # Use coloured output, it's the best.
 RSpec.configure do |config|
   config.filter_gems_from_backtrace 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jazzy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Frederik Wallner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A short description of danger-jazzy.
+description: A danger plugin for validating documentation generated with jazzy
 email:
 - frederik.wallner@gmail.com
 executables: []
@@ -172,6 +186,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -201,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -212,7 +227,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A longer description of danger-jazzy.
+summary: A danger plugin for validating documentation generated with jazzy
 test_files:
 - spec/fixtures/undocumented.json
 - spec/jazzy_spec.rb