cleanup_vendor 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24cac3d82b1d43e2442215768b8537b1f09f6a5fbaf5ddcd2d7ff9956ed363c1
-  data.tar.gz: 229cec236efa8bc3a7b8bf1bbe2fc5e1c974168aceec2420b386656f731de1b2
+  metadata.gz: eba65f3da4adaa212b9caf6fb3821e66c6460ced2f6f21a62fdb291bda286fc4
+  data.tar.gz: 547e614403d033939588b3fb26ee1382656fe5d9ae10345253d12aaf1fc93e37
 SHA512:
-  metadata.gz: ed7a4eefbed3e5b8682fcf0181a47778d6292d40827ad5441820080a6c9a64c16a32798adcad3b71b316fa7cf3bc7f29d56ddd5a972ae35cca446209dbb41765
-  data.tar.gz: 7ac1613c439b7dcf2d44a5b782612fbceb55e77702077dc30e79372094c9194e703c60fc6cc430e87083b8d6d62a384f68dbbd627b23845d7ac151d1c3f2be35
+  metadata.gz: 6d9e1d4067aac018e4daf4ccd5dfcfd6317a95e1f8e90f6aaeae4a176e70f92193f7ae0fa543dfac6376d9ceff2247e47e5f85b95ec29965fe2f355158d101fc
+  data.tar.gz: 7eaa95c21c8bbde09677cf0270679baf38494f77c16ada25ee7b0090864e390e45320060633bd549bb624b623968c15cd00fb030ac9013adca485c310042c912

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Update the RubyGems system software
+      run: gem update --system
+    - name: Update Bundler
+      run: bundle update --bundler
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.rubocop.yml

@@ -1,19 +1,23 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
-    - 'bin/**/*'
-    - 'vendor/**/*'
-    - 'vendor.test/**/*'
+    - "bin/**/*"
+    - "vendor/**/*"
+    - "vendor.test/**/*"
 
 Layout/LineLength:
   Exclude:
-    - 'exe/cleanup_vendor'
+    - "exe/cleanup_vendor"
   Max: 128
 
 Metrics/BlockLength:
   Exclude:
-    - 'exe/cleanup_vendor'
-    - 'spec/**/*'
+    - "exe/cleanup_vendor"
+    - "spec/**/*"
 
 Style/AccessModifierDeclarations:
   Enabled: false
@@ -27,4 +31,7 @@ Style/HashTransformValues:
   Enabled: true
 Style/StderrPuts:
   Exclude:
-    - 'lib/cleanup_vendor.rb'
+    - "lib/cleanup_vendor.rb"
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/Gemfile.lock

@@ -1,76 +1,83 @@
 PATH
   remote: .
   specs:
-    cleanup_vendor (0.4.0)
+    cleanup_vendor (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    byebug (11.1.1)
-    coderay (1.1.2)
-    diff-lcs (1.3)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    gem-release (2.1.1)
-    jaro_winkler (1.5.4)
+    gem-release (2.2.0)
     json (2.3.0)
-    method_source (0.9.2)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.8.0)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    pry-doc (1.0.0)
+      pry (~> 0.13.0)
+    pry-doc (1.1.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
     rainbow (3.0.0)
+    regexp_parser (2.0.0)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.5.2)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.0.1)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.6.1)
-    yard (0.9.24)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.1)
   cleanup_vendor!
   gem-release (~> 2.1)
   pry-byebug (~> 3.8)
   pry-doc (~> 1.0)
   rspec (~> 3.0)
-  rubocop (~> 0.80.1)
-  simplecov (~> 0.17.1)
+  rubocop (~> 1.5.2)
+  rubocop-rspec (~> 2.0, >= 2.0.1)
+  simplecov (= 0.17.1)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -5,7 +5,9 @@
 [![Test Coverage](https://codeclimate.com/github/raszi/cleanup_vendor/badges/coverage.svg)](https://codeclimate.com/github/raszi/cleanup_vendor)
 [![Gem Version](https://badge.fury.io/rb/cleanup_vendor.svg)](https://badge.fury.io/rb/cleanup_vendor)
 
-This gem was created to help minimizing the size of your docker images.
+This gem was created to help minimizing the size of your Docker images by removing the unnecessary files in the production environment.
+
+Files like build leftovers, test files, CI configurations, etc. You can check the [`defaults.yml`](lib/defaults.yml) for the exact list.
 
 ## Installation
 
@@ -34,11 +36,66 @@ RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without
   bundle exec cleanup_vendor --summary
 ```
 
-## Development
+To make it even smaller you can create a separate group in your `Gemfile` for this gem and remove that in the next step:
+
+```ruby
+group :build do
+  gem 'cleanup_vendor'
+end
+```
+
+Then modify the previous command to something like this:
+
+```Dockerfile
+RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without development test && \
+  bundle exec cleanup_vendor --summary && \
+  bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without build development test && \
+  bundle clean --force
+```
+
+If you are using multi-stage builds then you don't need to combine the commands into one `RUN` procedure:
+
+```Dockerfile
+RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without development test
+RUN bundle exec cleanup_vendor --summary
+RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without build development test
+RUN bundle clean --force
+```
+
+### Defaults
+
+Please consult the [`defaults.yml`](lib/defaults.yml) file to see what files will be removed if the command executed without overrides.
+
+Please note that patterns like `**/*.rb` will match every file with `.rb` extension recursively but a pattern like `Makefile` or `*.txt*` will be only applied if there is a gemspec file in that directory.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Overrides
+
+The CLI supports multiple convenient options:
+
+```
+Usage: cleanup_vendor [options]
+
+Specific options:
+    -v, --[no-]verbose               Run verbosely
+    -0, --null                       Print the pathname of the removed file to standard output, followed by an ASCII NUL character (character code 0).
+        --dry-run                    Do not delete files
+    -s, --summary                    Display a summary after execution
+    -d, --directory PATTERN          Match on directory
+    -f, --extension PATTERN          Match on file
+    -e  --exclude pattern            Exclude pattern from matching
+    -h, --help                       Show this message
+    -V, --version                    Show version
+```
+
+### Override Examples
+
+This example excludes a file from the Password Strength gem
+```
+bundle exec cleanup_vendor --dry-run --verbose -e '**/password_strength*/*/common.txt' 
+```
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 

data/cleanup_vendor.gemspec

@@ -23,11 +23,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.required_ruby_version = '~> 2.5'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'gem-release', '~> 2.1'
   spec.add_development_dependency 'pry-byebug', '~> 3.8'
   spec.add_development_dependency 'pry-doc', '~> 1.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.80.1'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'rubocop', '~> 1.5.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0', '>= 2.0.1'
+  spec.add_development_dependency 'simplecov', '= 0.17.1'
 end

data/exe/cleanup_vendor

@@ -39,6 +39,11 @@ opt_parser = OptionParser.new do |opts|
     options[:files] << pattern
   end
 
+  opts.on('-e', '--exclude PATTERN', 'Exclude pattern from matching') do |pattern|
+    options[:exclude] ||= []
+    options[:exclude] << pattern
+  end
+
   opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit

data/lib/cleanup_vendor.rb

@@ -32,9 +32,10 @@ module CleanupVendor
       raise Error, 'Not a directory' unless File.directory?(dir.to_s)
       return to_enum(:filter, dir, opts) unless block_given?
 
-      files, directories, filtered = get_options(opts)
+      files, directories, filtered, exclude = get_options(opts)
 
       Path.new(dir).recursive_entries do |path|
+        next if path.match?(exclude)
         next if path.include?(filtered)
         next unless path.file? && path.match?(files) || path.directory? && path.match?(directories)
 
@@ -45,7 +46,7 @@ module CleanupVendor
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def get_options(options)
-      options.values_at(:files, :directories, :filtered).map do |v|
+      options.values_at(:files, :directories, :filtered, :exclude).map do |v|
         (v || []).to_set
       end
     end

data/lib/cleanup_vendor/path.rb

@@ -14,7 +14,9 @@ module CleanupVendor
 
     def match?(patterns)
       patterns.any? do |p|
-        p.start_with?('**') && fnmatch?(p, File::FNM_EXTGLOB) || basename.fnmatch?(p, File::FNM_EXTGLOB) && gem_level?
+        p.eql?(self) ||
+          p.start_with?('**') && fnmatch?(p, File::FNM_EXTGLOB) ||
+          basename.fnmatch?(p, File::FNM_EXTGLOB) && gem_level?
       end
     end
 

data/lib/cleanup_vendor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CleanupVendor
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/defaults.yml

@@ -1,12 +1,15 @@
 directories:
-  - "spec"
-  - "coverage"
   - "**/.circleci"
   - "**/.config"
-  - "**/.{git,github}"
   - "**/.idea"
-  - "**/.{npm,yarn}"
   - "**/.yardoc"
+  - "**/.{git,github}"
+  - "**/.{npm,yarn}"
+  - "Gemfile"
+  - "Rakefile"
+  - "coverage"
+  - "spec"
+  - "test"
 files:
   - "**/.DS_Store"
   - "**/*.{c,cpp,h,hpp,java,log,markdown,md,mk,o,orig,rdoc,txt}"
@@ -16,10 +19,11 @@ files:
   - "**/*.{gcov,gem}"
   - "**/*.{log,markdown,md,rdoc,txt,yardopts}"
   - "**/*.{bak,orig}"
-  - "**/{CHANGELOG,LICENSE,MIT-LICENSE,NEWS,README,TODO}"
+  - "**/{CHANGELOG,CHANGES,LICENSE,MIT-LICENSE,NEWS,README,TODO}"
   - "**/.{gitkeep,gitignore,gitmodules}"
   - "**/.keep"
   - "**/{Dockerfile,.dockerignore}"
+  - "**/Guardfile"
   - "**/.{appveyor,codeclimate,hound,travis}.yml"
   - "**/.{ruby-gemset,ruby-version,rvm}"
   - "**/.{rspec,rspec_status}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cleanup_vendor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - KARASZI István
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -86,26 +86,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.1
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.1
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.17.1
 description: Removes unnecessary files which are not required in production environment.
@@ -116,6 +136,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -142,16 +164,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: This gem helps to cleanup vendor directory