pronto-docslint 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 904dd389bf8771794aa839c1db9fc4932d0282aeb41dc512f18b385f5af63486
+  data.tar.gz: ed7ee25312757f7bed05d9b7635137701198ed8bb72c99c98f16fbf6b86c07bf
+SHA512:
+  metadata.gz: 75461c40447727e1033d7a7428b1a6c540f7238f86b66001c641260d1c42ec2063302530fd687c8d1b64b88b83d3dbb0f86c785d78ee24e2700407eb39c6ea01
+  data.tar.gz: 6e50a5c552f1c6d4de9fbf913b195fe19a8f467e68d3015ff4fe2d1001faf324eded08900ded7e44236fd4819a65b25bdb5f2c872c862fcaacdb60462bdf85a6

data/README.md

@@ -0,0 +1,29 @@
+# Pronto Docslint
+
+[![Build Status](https://travis-ci.org/samesystem/pronto-docslint.svg?branch=master)](https://travis-ci.org/samesystem/pronto-docslints)
+[![codecov](https://codecov.io/gh/samesystem/pronto-docslint/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/pronto-docslint)
+
+Pronto runner for documentation checker
+
+## Example configuration:
+
+```yaml
+# .pronto_docslint.yml
+additions_treshold: 2
+deletions_treshold: 2
+watched_file_extensions:
+  - rb
+  - js
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samesystem/pronto-docslint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the pronto-docslint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/samesystem/pronto-docslint/blob/master/CODE_OF_CONDUCT.md).

data/lib/pronto/docslint.rb

@@ -0,0 +1,71 @@
+require 'pronto'
+require 'shellwords'
+
+module Pronto
+  class Docslint < Runner
+    CONFIG_FILE = '.pronto_docslint.yml'.freeze
+    CONFIG_KEYS = %w[watched_file_extensions additions_treshold deletions_treshold]
+
+    attr_reader :watched_file_extensions, :additions_treshold, :deletions_treshold
+
+    def run
+      return [] if no_patches? || documentation_exists?
+
+      prepare_config
+      meaningful_patches.map { |patch| new_message(patch) }.compact
+    end
+
+    private
+
+    def no_patches?
+      !@patches || @patches.count.zero?
+    end
+
+    def documentation_exists?
+      @patches.any? { |patch| patch.delta.new_file[:path].match?(/\.md$/) }
+    end
+
+    def meaningful_patches
+      extentions = /^app\/.*\.(#{watched_file_extensions.join('|')})$/
+      @patches
+        .select { |patch| !patch.delta.deleted? }
+        .select { |patch| patch.additions > additions_treshold || patch.deletions > deletions_treshold }
+        .select { |patch| patch.delta.new_file[:path].match?(extentions) }
+    end
+
+    def new_message(patch)
+      path = patch.delta.new_file[:path]
+      watched_extensions = watched_file_extensions.map { |ext| "`#{ext}`" }.join(',')
+      offence = "Changes on #{watched_extensions} files requires documentation changes.."
+      line = patch.added_lines.first || patch.deleted_lines.first
+      Message.new(path, line, :warning, offence, nil, self.class)
+    end
+
+    def prepare_config
+      read_config
+      fill_empty_settings_with_default_values
+    end
+
+    def read_config
+      config_file = File.join(git_repo_path, CONFIG_FILE)
+      return unless File.exist?(config_file)
+
+      config = YAML.load_file(config_file)
+
+      CONFIG_KEYS.each do |config_key|
+        next unless config[config_key]
+        instance_variable_set("@#{config_key}", config[config_key])
+      end
+    end
+
+    def fill_empty_settings_with_default_values
+      @watched_file_extensions ||= %w[js rb]
+      @additions_treshold ||= 1
+      @deletions_treshold ||= 1
+    end
+
+    def git_repo_path
+      @git_repo_path ||= Rugged::Repository.discover(File.expand_path(Dir.pwd)).workdir
+    end
+  end
+end

data/lib/pronto/docslint/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module DocslintVersion
+    VERSION = '0.0.7'.freeze
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: pronto-docslint
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Justinas Matulevicius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+description: 
+email: justinas@samesystem.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/pronto/docslint.rb
+- lib/pronto/docslint/version.rb
+homepage: https://github.com/samesystem/pronto-docslint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Pronto runner for documentation existance.
+test_files: []