danger-spec_postfix 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb88efc2559876baef00d2c8339fc8c331ba086443dda16b240c04fa669f41b6
-  data.tar.gz: da7ccb91e79a960316d896c479e6ea93537f18311d52f257d71cab25a4655e33
+  metadata.gz: acf829f0845c574d42a1fb15cc83470b25574042efd05749ec3b533bde18dcaf
+  data.tar.gz: fc48c175541ec881fc91779b353201bfa7556b0a51ec4dd673db0d37724a1478
 SHA512:
-  metadata.gz: c8dcbd37fc22a213ee5ad3c43b7333f6bbf100c14c6e7da372a83828337e66c89a525bc088609fc195707cc864c4b6cac15714ffaf2a1273352b59a900d6e68f
-  data.tar.gz: 51f52ec49624703032a7be42cb99f59a86550bc1e5a7e27da2b9195724030685afbc155f6005de08b85ba1462782d10d9f9e772f48219ebcc60395471ba7c287
+  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.4)
+    danger-spec_postfix (0.0.6)
       danger-plugin-api (~> 1.0)
 
 GEM

data/README.md

@@ -1,20 +1,43 @@
-# danger-readme_docs
+# danger-spec_postfix
 
-Danger plugin to validate sub README mention in main README file
+Danger plugin to validate files (or directories) naming.
 
 ## Installation
 
     $ gem install danger-spec_postfix
 
-## Usage
+## Example of usage
 
-    Add this to your Dangerfile:
+    1. Add lint to your Dangerfile (specifying what you want to check and how)
 
-    spec_postfix.lint
+    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:
 
-    spec_postfix.lint(exceptions: ['rails_helper.rb', 'rails_helper.rb', 'spec/factories/', 'spec/support/'])
+    ```
+    options = {
+      message: 'Tests should have `_spec` postfix',
+      scope: %r{spec/},
+      match: %r{_spec.rb$}
+      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.4'
+  VERSION = '0.0.6'
 end

data/lib/spec_postfix/plugin.rb

@@ -1,20 +1,23 @@
 # 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
   #          A globbed string which should return the files that you want to lint, defaults to nil.
   #          if nil, modified and added files from the diff will be used.
+  # @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 want to get some directories or files out of scope.
   # @return  [void]
   #
   class DangerSpecPostfix < Plugin
-    def lint(exceptions: [])
-      changed_files.select { |f| f.match?(%r{^spec/.*rb$}) }
-                   .reject { |f| f.end_with?('_spec.rb') }
-                   .reject { |f| exceptions.any? { |e| f.start_with?(e) } }
-                   .each   { |f| warn(warning_generator(f)) }
+    def lint(scope:, match:, message:, exception: nil)
+      wrong_files = changed_files.select { |f| f.match?(scope) }.reject { |f| f.match?(match) }
+      wrong_files = wrong_files.reject { |f| f.match?(exception) } if exception
+      wrong_files.each { |f| warn("#{message}: #{f}") }
     end
 
     private
@@ -22,9 +25,5 @@ module Danger
     def changed_files
       (git.modified_files + git.added_files)
     end
-
-    def warning_generator(file)
-      "Tests should have `_spec` postfix: #{file}"
-    end
   end
 end

data/spec/spec_postfix_spec.rb

@@ -9,7 +9,21 @@ module Danger
     end
 
     describe 'with Dangerfile' do
-      let(:file_path) { nil }
+      subject do
+        @spec_postfix.lint(options)
+        @spec_postfix.status_report[:warnings]
+      end
+
+      let(:message) { 'Tests should have `_spec` postfix' }
+      let(:scope) { %r{spec/} }
+      let(:match) { %r{_spec.rb$} }
+      let(:options) do
+        {
+          message: message,
+          scope: scope,
+          match: match
+        }
+      end
 
       before do
         @spec_postfix = testing_dangerfile.spec_postfix
@@ -18,32 +32,31 @@ module Danger
         allow(@spec_postfix.git).to receive(:modified_files).and_return([file_path])
       end
 
-      subject do
-        @spec_postfix.lint
-        @spec_postfix.status_report[:warnings]
-      end
-
-      context 'with _spec' do
-        let(:file_path) { 'spec/models/my_test_spec.rb' }
+      context 'when match' do
+        let(:file_path) { 'spec/some_test_spec.rb' }
 
         it { is_expected.to be_empty }
       end
 
-      context 'with no _spec' do
-        let(:file_path) { 'spec/models/my_test.rb' }
+      context 'when not match' do
+        let(:file_path) { 'spec/some_test.rb' }
 
-        it { is_expected.to eq(["Tests should have `_spec` postfix: #{file_path}"]) }
-      end
+        it { is_expected.to eq(["#{message}: #{file_path}"]) }
 
-      context 'when is irrelevant (exceptions)' do
-        subject do
-          @spec_postfix.lint(exceptions: ['not_tests/'])
-          @spec_postfix.status_report[:warnings]
-        end
+        context 'with exception' do
+          let(:options) do
+            {
+              message: message,
+              scope: scope,
+              match: match,
+              exception: exception
+            }
+          end
+          let(:file_path) { 'spec/spec_helper.rb' }
+          let(:exception) { Regexp.union(%r{spec/factories}, %r{spec_helper.rb}) }
 
-        let(:file_path) { 'not_tests/factory.rb' }
-
-        it { is_expected.to be_empty }
+          it { is_expected.to be_empty }
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-spec_postfix
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  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