danger-jazzy 0.1.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+.yardoc/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased][]
+
+## [0.1.1][] (2016-11-09)
+* Bugfixes.
+
+## [0.1.0][] (2016-11-06)
+* Initial release!

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-jazzy.gemspec
+gemspec
+
+gem 'chandler', '~> 0.5.0'

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Frederik Wallner <frederik.wallner@gmail.com>
+
+MIT License
+
+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,26 @@
+### jazzy
+This is a danger plugin to check for undocumented symbols via Jazzy.
+
+<blockquote>Warn about undocumented symbols.
+  <pre>
+jazzy.warn_of_undocumented</pre>
+</blockquote>
+
+<blockquote>Write a custom message for undocumented symbols.
+  <pre>
+jazzy.undocumented do |file,line|
+    message("You forgot to document this", file:file, line:line)
+end</pre>
+</blockquote>
+
+
+#### Attributes
+
+`path_to_docs` - Path to the docs folder, defaults to 'docs/'.
+
+
+#### Methods
+
+`warn_of_undocumented` - Warns about undocumented symbols.
+
+`undocumented` - Finds and yields information about undocumented symbols.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-jazzy.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jazzy/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-jazzy'
+  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.homepage      = 'https://github.com/fwal/danger-jazzy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_runtime_dependency 'json', '~> 1.8'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_jazzy.rb

@@ -0,0 +1 @@
+require 'jazzy/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+require 'jazzy/symbol'
+require 'jazzy/undocumented_reader'
+require 'jazzy/plugin'

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/plugin.rb

@@ -0,0 +1,61 @@
+module Danger
+  # This is a danger plugin to check for undocumented symbols via Jazzy.
+  #
+  # @example Warn about undocumented symbols.
+  #
+  #          jazzy.warn_of_undocumented
+  #
+  # @example Write a custom message for undocumented symbols.
+  #
+  #          jazzy.undocumented do |file,line|
+  #              message("You forgot to document this", file:file, line:line)
+  #          end
+  #
+  # @see  fwal/danger-jazzy
+  # @tags jazzy, docs, documentation
+  #
+  class DangerJazzy < Plugin
+    DEFAULT_MESSAGE = 'Undocumented symbol.'.freeze
+
+    # Path to the docs folder, defaults to 'docs/'.
+    # @return   [String]
+    attr_accessor :path_to_docs
+
+    # Warns about undocumented symbols.
+    # @return  [void]
+    def warn_of_undocumented
+      undocumented.each do |item|
+        warn DEFAULT_MESSAGE, file: item.file, line: item.line
+      end
+    end
+
+    # Returns a list of undocumented symbols in the current diff.
+    # @return [Array of symbol]
+    def undocumented
+      return unless File.exist? undocumented_path
+      load_undocumented if @undocumented.nil?
+      @undocumented
+    end
+
+    private
+
+    def docs_path
+      @path_to_docs || 'docs/'
+    end
+
+    def undocumented_path
+      File.join(docs_path, 'undocumented.json')
+    end
+
+    def files_of_interest
+      git.modified_files + git.added_files
+    end
+
+    def load_undocumented
+      reader = UndocumentedReader.new(undocumented_path)
+      @undocumented = reader.undocumented_symbols.select do |item|
+        files_of_interest.include?(item.file)
+      end
+    end
+  end
+end

data/lib/jazzy/symbol.rb

@@ -0,0 +1,3 @@
+module Danger
+  Symbol = Struct.new(:file, :line, :symbol, :symbol_kind, :warning)
+end

data/lib/jazzy/undocumented_reader.rb

@@ -0,0 +1,37 @@
+module Danger
+  # Reads undocumented.json file created by jazzy
+  class UndocumentedReader
+    def initialize(path)
+      load(path)
+    end
+
+    def undocumented_symbols
+      @data['warnings'].map do |item|
+        next unless item_valid? item
+        Symbol.new(
+          item_file(item),
+          item['line'],
+          item['symbol'],
+          item['symbol_kind'],
+          item['warning']
+        )
+      end
+    end
+
+    private
+
+    def load(path)
+      @data = JSON.parse(File.read(path))
+      @working_path = Pathname.new(@data['source_directory'])
+    end
+
+    def item_file(item)
+      path = Pathname.new(item['file'])
+      path.relative_path_from(@working_path).to_s
+    end
+
+    def item_valid?(item)
+      item['warning'] == 'undocumented'
+    end
+  end
+end

data/spec/fixtures/undocumented.json

@@ -0,0 +1,19 @@
+{
+  "warnings": [
+    {
+      "file": "/MyFile.swift",
+      "line": 4,
+      "symbol": "MyClass.doStuff()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/MyOtherFile.swift",
+      "line": 2,
+      "symbol": "MyStruct.handleThing()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    }
+  ],
+  "source_directory": "/"
+}

data/spec/jazzy_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerJazzy do
+    it 'should be a plugin' do
+      expect(Danger::DangerJazzy.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.jazzy
+        @default_message = 'Undocumented symbol.'
+      end
+
+      context 'changed files contains undocumented symbols' do
+        before do
+          modified = Git::Diff::DiffFile.new(
+            'base',
+            path:  'OldFile.swift',
+            patch: '- //old'
+          )
+          added = Git::Diff::DiffFile.new(
+            'base',
+            path:  'MyFile.swift',
+            patch: '+ //new'
+          )
+
+          allow(@dangerfile.git).to receive(:diff_for_file)
+            .with('OldFile.swift').and_return(modified)
+
+          allow(@dangerfile.git).to receive(:diff_for_file)
+            .with('MyFile.swift').and_return(added)
+
+          allow(@dangerfile.git).to receive(:modified_files)
+            .and_return(['OldFile.swift'])
+
+          allow(@dangerfile.git).to receive(:added_files)
+            .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])
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+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 ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# 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'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: danger-jazzy
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Frederik Wallner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of danger-jazzy.
+email:
+- frederik.wallner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-jazzy.gemspec
+- lib/danger_jazzy.rb
+- lib/danger_plugin.rb
+- lib/jazzy/gem_version.rb
+- lib/jazzy/plugin.rb
+- lib/jazzy/symbol.rb
+- lib/jazzy/undocumented_reader.rb
+- spec/fixtures/undocumented.json
+- spec/jazzy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fwal/danger-jazzy
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A longer description of danger-jazzy.
+test_files:
+- spec/fixtures/undocumented.json
+- spec/jazzy_spec.rb
+- spec/spec_helper.rb