danger-spec_postfix 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f994553adae976417f7e7b521b26896c1268ea3a84b33a0f194bea84cc3b1575
-  data.tar.gz: 8bd8f8b3c83d9f5cb819e8d903034ae60e5327ead7e8b86a3f456c017b4ad1db
+  metadata.gz: acf829f0845c574d42a1fb15cc83470b25574042efd05749ec3b533bde18dcaf
+  data.tar.gz: fc48c175541ec881fc91779b353201bfa7556b0a51ec4dd673db0d37724a1478
 SHA512:
-  metadata.gz: 7896330e819c4184977dc42df31fccfd4e5ca336b99a76be90eaa0a1cd78888e9ae860ba3b6f3fc3ad4e8ffc393cecbb749820011801acbe1ae09dc1c06fd18d
-  data.tar.gz: 1e42be75ca36f539a36d73dfc4c40c1237202d0ff38155fdd0beef76f81f606242852b6ddbbb924cafbf74e3445927da1da470fe9c8f1bca2a595c401985d34a
+  metadata.gz: 4a629d1298c250bbcfdebb1d117a021de6760d23b6e5081110e9b36e9dc46f480eb2e449ae53fb534ceb286a71456c1ce2d2f76401719ba5df45f2fcf1c86d8d
+  data.tar.gz: cd7976ffc6b336ad6293dba8fc7bafe1962d85426b6833d86e245ad014c7bb2e590f07dbb80ff6f2d6263922356410f0f81578236cd79e8681146c21c1cdacbf

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+usage.rb
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-spec_postfix (0.0.5)
+    danger-spec_postfix (0.0.6)
       danger-plugin-api (~> 1.0)
 
 GEM

data/README.md

@@ -8,17 +8,22 @@ Danger plugin to validate files (or directories) naming.
 
 ## Example of usage
 
-    Add to your Dangerfile:
+    1. Add lint to your Dangerfile (specifying what you want to check and how)
 
+    For example in order to make sure that all tests in your 'spec/' folder have required postfix '_spec' (this is the purpose plugin was initially built for) add:
+
+    ```
     options = {
       message: 'Tests should have `_spec` postfix',
       scope: %r{spec/},
       match: %r{_spec.rb$}
     }
     spec_postfix.lint(options)
+    ```
 
     You can also pass `exceptions` param in order to skip irrelevant files or directories:
 
+    ```
     options = {
       message: 'Tests should have `_spec` postfix',
       scope: %r{spec/},
@@ -26,6 +31,13 @@ Danger plugin to validate files (or directories) naming.
       exception: Regexp.union(%r{rails_helper.rb}, %r{rails_helper.rb}, %{spec/factories/}, %r{spec/support/})
     }
     spec_postfix.lint(options)
+    ```
+
+    2. Get warnings:
+
+    ```
+    "Tests should have `_spec` postfix: spec/models/test_without_postfix.rb"
+    ```
 
 ## Development
 

data/danger-spec_postfix.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = SpecPostfix::VERSION
   spec.authors       = ['Igor Udalov']
   spec.email         = ['i.udalov@rambler-co.ru']
-  spec.summary       = "Danger plugin to validate '_spec' postfix in tests"
+  spec.summary       = "Danger plugin to validate files (or directories) naming."
   spec.homepage      = 'https://github.com/rambler-digital-solutions/danger-spec_postfix'
   spec.license       = 'MIT'
 

data/lib/spec_postfix/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpecPostfix
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/spec_postfix/plugin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Danger
-  # Lints the test files. Will fail if any has no '_spec' postfix.
+  # Lints files (or directories) naming.
   # Generates a `string` with warning.
   #
   # @param   [Array<String>] files
@@ -10,7 +10,7 @@ module Danger
   # @param   scope [Regexp] Scope of check
   # @param   match [Regexp] Pattern to match
   # @param   message [String] Warn message
-  # @param   exception [Regexp] Not required. In case you get some directories or files out of scope.
+  # @param   exception [Regexp] Not required. In case you want to get some directories or files out of scope.
   # @return  [void]
   #
   class DangerSpecPostfix < Plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-spec_postfix
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Igor Udalov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -171,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -206,7 +207,7 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Danger plugin to validate '_spec' postfix in tests
+summary: Danger plugin to validate files (or directories) naming.
 test_files:
 - spec/spec_helper.rb
 - spec/spec_postfix_spec.rb