danger-spec_postfix 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7013f18e0074dbc9108182afd4409ee9457760bcf0114a3a107c4fc448ac2a3
-  data.tar.gz: 4530c9d8fdc42da2af6dc6d68e01f213fbb71b3c4fe536b182859e1f4addcb1c
+  metadata.gz: f994553adae976417f7e7b521b26896c1268ea3a84b33a0f194bea84cc3b1575
+  data.tar.gz: 8bd8f8b3c83d9f5cb819e8d903034ae60e5327ead7e8b86a3f456c017b4ad1db
 SHA512:
-  metadata.gz: 4989e8df6156ddec96e0ec46563fe823a162449de773e6f6a69e3bcde7e2fd2475c26a20ce100cd3fcad8d54025fb7c9bfc78357a13add250c04897fd9f642fe
-  data.tar.gz: 825eaf57bc666f914692af8879725ab03becca562a71aad50751b8f0a856e7e7b3eff3b60e1bcd7e8966139542cb2bfa6ef26cead6974bbac9b02e4c05336bd1
+  metadata.gz: 7896330e819c4184977dc42df31fccfd4e5ca336b99a76be90eaa0a1cd78888e9ae860ba3b6f3fc3ad4e8ffc393cecbb749820011801acbe1ae09dc1c06fd18d
+  data.tar.gz: 1e42be75ca36f539a36d73dfc4c40c1237202d0ff38155fdd0beef76f81f606242852b6ddbbb924cafbf74e3445927da1da470fe9c8f1bca2a595c401985d34a

data/Gemfile.lock

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

data/README.md

@@ -1,26 +1,31 @@
-# 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:
+    Add to your Dangerfile:
 
-    spec_postfix.lint
+    options = {
+      message: 'Tests should have `_spec` postfix',
+      scope: %r{spec/},
+      match: %r{_spec.rb$}
+    }
+    spec_postfix.lint(options)
 
-## Configuration
+    You can also pass `exceptions` param in order to skip irrelevant files or directories:
 
-    By default some of files and folders are out of scope. You can configure your own custom list of exceptions.
-
-    #config/initializers/danger/danger_spec_postfix.rb
-
-    Danger::DangerSpecPostfix.configure do |config|
-      config.exceptions = ['rails_helper.rb', 'rails_helper.rb']
-    end
+    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)
 
 ## Development
 

data/lib/spec_postfix/gem_version.rb

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

data/lib/spec_postfix/plugin.rb

@@ -4,17 +4,20 @@ module Danger
   # Lints the test files. Will fail if any has no '_spec' postfix.
   # Generates a `string` with warning.
   #
-  # @param   [String] files
+  # @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 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-spec_postfix
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Igor Udalov