danger-spec_postfix 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e736b77f25af05815d0056f34d6f08cf661b778d2eff55666bdec6aa3609943
-  data.tar.gz: 91597c48664c538ff8610390155d172013a6fe49f00016a8fed348e12b72312e
+  metadata.gz: cb88efc2559876baef00d2c8339fc8c331ba086443dda16b240c04fa669f41b6
+  data.tar.gz: da7ccb91e79a960316d896c479e6ea93537f18311d52f257d71cab25a4655e33
 SHA512:
-  metadata.gz: 99ea9aed38ed6d1439fdcd1abb4bfa18a83a5ee04a049a94c6286d7e6f7b45a0a11a0fbc51e24ffe3182aedd5e1d9e190eccd4394e875cbbbad469ccaf91e36b
-  data.tar.gz: 073f9ad0dabe33fc140126b7091d8caf63695235e8ba5125bc6f867e6d073d6a7bcd4371d4352fba7d986a790c6dd48b3c8ba0c7c89392b9fcaa758956491fbf
+  metadata.gz: c8dcbd37fc22a213ee5ad3c43b7333f6bbf100c14c6e7da372a83828337e66c89a525bc088609fc195707cc864c4b6cac15714ffaf2a1273352b59a900d6e68f
+  data.tar.gz: 51f52ec49624703032a7be42cb99f59a86550bc1e5a7e27da2b9195724030685afbc155f6005de08b85ba1462782d10d9f9e772f48219ebcc60395471ba7c287

data/Gemfile.lock

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

data/README.md

@@ -12,15 +12,9 @@ Danger plugin to validate sub README mention in main README file
 
     spec_postfix.lint
 
-## 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
+    spec_postfix.lint(exceptions: ['rails_helper.rb', 'rails_helper.rb', 'spec/factories/', 'spec/support/'])
 
 ## Development
 

data/lib/spec_postfix/gem_version.rb

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

data/lib/spec_postfix/plugin.rb

@@ -1,39 +1,19 @@
 # frozen_string_literal: true
 
-require 'active_support/configurable'
-
-# Adding plugin
 module Danger
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield configuration
-  end
-
-  # Adding opportunity to maintain exceptions list for plugin.
-  class Configuration
-    include ::ActiveSupport::Configurable
-
-    config_accessor(:spec_postfix_exceptions) do
-      ['spec/shared_examples/', 'spec/factories/', 'spec/support/', 'spec/rails_helper.rb', 'spec/spec_helper.rb']
-    end
-  end
-
   # 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.
   # @return  [void]
   #
   class DangerSpecPostfix < Plugin
-    def lint
+    def lint(exceptions: [])
       changed_files.select { |f| f.match?(%r{^spec/.*rb$}) }
                    .reject { |f| f.end_with?('_spec.rb') }
-                   .reject { |f| Danger.configuration.spec_postfix_exceptions.any? { |e| f.start_with?(e) } }
+                   .reject { |f| exceptions.any? { |e| f.start_with?(e) } }
                    .each   { |f| warn(warning_generator(f)) }
     end
 

data/spec/spec_postfix_spec.rb

@@ -36,10 +36,9 @@ module Danger
       end
 
       context 'when is irrelevant (exceptions)' do
-        before do
-          Danger.configure do |config|
-            config.spec_postfix_exceptions = 'not_tests/'
-          end
+        subject do
+          @spec_postfix.lint(exceptions: ['not_tests/'])
+          @spec_postfix.status_report[:warnings]
         end
 
         let(:file_path) { 'not_tests/factory.rb' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-spec_postfix
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Igor Udalov
@@ -174,25 +174,16 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - danger-spec_postfix.gemspec
-- danger_plugin.rb
-- danger_spec_postfix.rb
-- gem_version.rb
 - lib/danger_plugin.rb
 - lib/danger_spec_postfix.rb
 - lib/spec_postfix/gem_version.rb
 - lib/spec_postfix/plugin.rb
-- plugin.rb
 - spec/spec_helper.rb
 - spec/spec_postfix_spec.rb
-- spec_helper.rb
-- spec_postfix/gem_version.rb
-- spec_postfix/plugin.rb
-- spec_postfix_spec.rb
 homepage: https://github.com/rambler-digital-solutions/danger-spec_postfix
 licenses:
 - MIT

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Rambler Digital Solutions
-
-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/danger_plugin.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_postfix/plugin'

data/danger_spec_postfix.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_postfix/gem_version'

data/gem_version.rb

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

data/plugin.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/configurable'
-
-module Danger
-  # Check that all test files in spec/ folder have `_spec` postfix.
-  # Results are passed out as a string with warning.
-  #
-  # @example Running linter
-  #
-  #          # Runs a linter
-  #          spec_postfix.lint
-  #
-  class DangerSpecPostfix < Plugin
-    # Lints the test files. Will fail if any has no '_spec' postfix.
-    # Generates a `string` with warning.
-    #
-    # @param   [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.
-    # @return  [void]
-    #
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
-
-    def self.configure
-      yield configuration
-    end
-
-    def lint
-      changed_files.select { |f| f.match?(%r{^spec/.*rb$}) }
-                   .reject { |f| f.end_with?('_spec.rb') }
-                   .reject { |f| DangerSpecPostfix.configuration.exceptions.any? { |e| f.start_with?(e) } }
-                   .each   { |f| warn(warning_generator(f)) }
-    end
-
-    private
-
-    def changed_files
-      (git.modified_files + git.added_files)
-    end
-
-    def warning_generator(file)
-      "Tests should have `_spec` postfix: #{file}"
-    end
-  end
-
-  class DangerSpecPostfix
-    class Configuration
-      include ::ActiveSupport::Configurable
-
-      config_accessor(:exceptions) do
-        ['spec/shared_examples/', 'spec/factories/', 'spec/support/', 'spec/rails_helper.rb', 'spec/spec_helper.rb']
-      end
-    end
-  end
-end

data/spec_helper.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-ROOT = Pathname.new(File.expand_path('..', __dir__))
-$LOAD_PATH.unshift("#{ROOT}lib")
-$LOAD_PATH.unshift("#{ROOT}spec")
-
-require 'bundler/setup'
-require 'pry'
-
-require 'rspec'
-require 'danger'
-
-if `git remote -v` == ''
-  puts 'You cannot run tests without setting a local git remote on this repo'
-  puts "It's a weird side-effect of Danger's internals."
-  exit(0)
-end
-
-# 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

data/spec_postfix/gem_version.rb

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

data/spec_postfix/plugin.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/configurable'
-
-module Danger
-  # Check that all test files in spec/ folder have `_spec` postfix.
-  # Results are passed out as a string with warning.
-  #
-  # @example Running linter
-  #
-  #          # Runs a linter
-  #          spec_postfix.lint
-  #
-  class DangerSpecPostfix < Plugin
-    # Lints the test files. Will fail if any has no '_spec' postfix.
-    # Generates a `string` with warning.
-    #
-    # @param   [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.
-    # @return  [void]
-    #
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
-
-    def self.configure
-      yield configuration
-    end
-
-    def lint
-      changed_files.select { |f| f.match?(%r{^spec/.*rb$}) }
-                   .reject { |f| f.end_with?('_spec.rb') }
-                   .reject { |f| DangerSpecPostfix.configuration.exceptions.any? { |e| f.start_with?(e) } }
-                   .each   { |f| warn(warning_generator(f)) }
-    end
-
-    private
-
-    def changed_files
-      (git.modified_files + git.added_files)
-    end
-
-    def warning_generator(file)
-      "Tests should have `_spec` postfix: #{file}"
-    end
-  end
-
-  class DangerSpecPostfix
-    class Configuration
-      include ::ActiveSupport::Configurable
-
-      config_accessor(:exceptions) do
-        ['spec/shared_examples/', 'spec/factories/', 'spec/support/', 'spec/rails_helper.rb', 'spec/spec_helper.rb']
-      end
-    end
-  end
-end

data/spec_postfix_spec.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('spec_helper', __dir__)
-
-module Danger
-  describe Danger::DangerSpecPostfix do
-    it 'is a plugin' do
-      expect(described_class.new(nil)).to be_a Danger::Plugin
-    end
-
-    describe 'with Dangerfile' do
-      let(:file_path) { nil }
-
-      before do
-        @spec_postfix = testing_dangerfile.spec_postfix
-
-        allow(@spec_postfix.git).to receive(:added_files).and_return([])
-        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' }
-
-        it { is_expected.to be_empty }
-      end
-
-      context 'with no _spec' do
-        let(:file_path) { 'spec/models/my_test.rb' }
-
-        it { is_expected.to eq(["Tests should have `_spec` postfix: #{file_path}"]) }
-      end
-
-      context 'when is irrelevant (exceptions)' do
-        before do
-          described_class.configure do |config|
-            config.exceptions = 'not_tests/'
-          end
-        end
-
-        let(:file_path) { 'not_tests/factory.rb' }
-
-        it { is_expected.to be_empty }
-      end
-    end
-  end
-end