trick_bag 0.65.1 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19559dbd27a0d1a9b604eea19d6a0b18174fdf8b
-  data.tar.gz: 75d5d546726b5fdbec43dec86e31d566fb08de13
+  metadata.gz: 1d232e6acd5101ddede4f818540a495f8cb9a454
+  data.tar.gz: b8b773b9d5b40ec1e7e8fe2d61888d59d9a35be0
 SHA512:
-  metadata.gz: 42afa58dbeafba8498181647aedc4c7ef9b3ea08dedef5603ba5b9f2e5e2a791c0fa4c878237b2017e2a169a08bafb71066f6b7d376522029a76ba1b39682690
-  data.tar.gz: 15b6948e4aeadb0f9f948d6a9242f87a60dac0b94ed95aa910dcabf36660ba909c8d47760cb3ac47d6a8b97884b3f6ba78ed069239020620fa31b76297a465ed
+  metadata.gz: d90de4a2b882180737bc7ac377b75521e173b1796be0c1204a37a617c3221dfd3140fd391e3da8e9de2c19dff4c16c2b9b05011dc06fabd76a9324cf924aba75
+  data.tar.gz: e9d782a5aebcd295387481e6551600747f36539b3ae20a31f4f6db69ec659efd04ac2ee35f3643781ddffa45fcbcbbbad49adbf32a0c1efaaa9d3fa252b29f8f

data/RELEASE_NOTES.md

@@ -1,8 +1,24 @@
+## v0.66.0
+
+* Add TrickBag::Io::Gitignore.list_ignored_files.
+
+
+
+## v0.65.1
+
+* Fix bug in TrickBag::Validations when raise_on_missing_keys was passed an array.
+
+
+## v0.65.0
+* Add ability to pass values through print() to TextModeStatusUpdater's text generator. Version 0.65.0.
+
+
 ## v0.64.5
 
 * Modified .travis.yml. as per suggestion on web to fix bundler problem:
 NoMethodError: undefined method `spec' for nil:NilClass
 
+
 ## v0.64.4
 
 * Fix net-ssh version error on Ruby versions < 2.  v0.64.2 did not work.

data/lib/trick_bag/enumerables/file_line_reader.rb

@@ -22,7 +22,7 @@ class FileLineReader
 
   attr_reader :filespec, :start_and_max
 
-  # @param filespec - the file from which to read domain names; blank/empty lines and lines
+  # @param filespec - the file from which to read lines; blank/empty lines and lines
   #                   with the first nonblank character == '#' will be ignored.
   # @param start_pos - the record number, zero offset, at which to begin each() processing
   # @param max_count - the maximum number of records to be served by each()

data/lib/trick_bag/io/gitignore.rb

@@ -0,0 +1,41 @@
+module TrickBag
+module Io
+
+# This module implements in Ruby the behavior of git's handling of the .gitignore file.
+# It assumes that the current working directory is the directory of the .gitignore file.
+
+module Gitignore
+
+  module_function
+
+  # Lists files that exist that would be ignored by git based on the .gitignore file
+  # You may provide an Enumerable with the values that would normally be in the .gitignore file.
+  def list_ignored_files(ignore_spec = File.readlines('.gitignore'))
+    ignore_list = ignore_spec.each_with_object([]) do |exclude_mask, ignore_list|
+      exclude_mask << '**/*' if exclude_mask[-1] == '/'
+      exclude_files = Dir.glob(exclude_mask, File::FNM_DOTMATCH)
+      ignore_list.concat(exclude_files)
+    end
+
+    ignore_list.sort!
+    ignore_list.uniq!
+    ignore_list.delete('.')
+    ignore_list.delete('..')
+    ignore_list.reject! { |filespec| File.directory?(filespec) }
+    ignore_list
+  end
+
+
+  # Lists files that exist that would *NOT* be ignored by git based on the .gitignore file
+  # You may provide an Enumerable with the values that would normally be in the .gitignore file.
+  def list_included_files(ignore_spec = File.readlines('.gitignore'))
+    all_files = Dir.glob('**/*', File::FNM_DOTMATCH).reject do |filespec|
+      File.directory?(filespec)
+    end
+    all_files - list_ignored_files(ignore_spec)
+  end
+end
+
+end
+end
+

data/lib/trick_bag/io/temp_files.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 module TrickBag
 module Io
 module TempFiles

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = '0.65.1'
-end
+  VERSION = '0.66.0'
+end

data/spec/trick_bag/io/gitignore_spec.rb

@@ -0,0 +1,138 @@
+require 'set'
+require 'tmpdir'
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/trick_bag/io/gitignore'
+
+GI=TrickBag::Io::Gitignore
+
+describe TrickBag::Io::Gitignore do
+  shared_examples_for 'testing a pair' do |ignore_spec, expected_result, filename|
+    let(:ignored_files)  { GI.list_ignored_files }
+    let(:in_ignore_list) { ignored_files.include?(filename) }
+    let(:error_message) do
+      "filename: '#{filename}', ignore_spec: #{ignore_spec}, expected result: #{expected_result}, got: #{in_ignore_list}, ignored files: #{ignored_files}"
+    end
+
+    around do |example|
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          File.write('.gitignore', ignore_spec.join("\n"))
+          Dir.mkdir('a_dir')        # for some but not all tests
+          Dir.mkdir('.hidden_dir')  # for some but not all tests
+          FileUtils.touch(filename) # for some but not all tests
+          example.run
+        end
+      end
+    end
+
+    it { expect(in_ignore_list).to eq(expected_result), error_message }
+  end
+
+  context 'handling a nonhidden file in the root directory', :aggregate_failures do
+    test_inputs = [
+        [[],             false],
+        [['target'],     true],
+        [['**/*arge*'],  true],
+        [['*'],          true],
+        [['*arge*'],     true],
+    ]
+
+    test_inputs.each do |(ignore_spec, expected_result)|
+      context do # without a context block the way that rspec expands the examples causes the parameters to overwrite each other
+        include_examples 'testing a pair', ignore_spec, expected_result, 'target'
+      end
+    end
+  end
+
+  context 'handling a hidden file in the root directory', :aggregate_failures do
+    test_inputs = [
+        [[],             false],
+        [['.target'],    true],
+        [['**/*arge*'],  true],
+        [['**/.targe*'], true],
+        [['*'],          true],
+        [['*arge*'],     true],
+    ]
+
+    test_inputs.each do |(ignore_spec, expected_result)|
+      context do # without a context block the way that rspec expands the examples causes the parameters to overwrite each other
+        include_examples 'testing a pair', ignore_spec, expected_result, '.target'
+      end
+    end
+  end
+
+  context 'handling hidden files in subdirectories of hidden directories', :aggregate_failures do
+    test_inputs = [
+        [[],                  false],
+        [['.hidden_dir'],     false],
+        [['.hidden_dir/'],    true],
+        [['hidden_dir/'],     false],
+        [['.hidden_dir/.*'],  true],
+        [['.hidden_dir/.hidden_file'],  true],
+    ]
+
+    test_inputs.each do |(ignore_spec, expected_result)|
+      context do # without a context block the way that rspec expands the examples causes the parameters to overwrite each other
+        include_examples 'testing a pair', ignore_spec, expected_result, '.hidden_dir/.hidden_file'
+      end
+    end
+  end
+
+  it 'should take an Enumerable that is not an Array' do
+    GI.list_ignored_files(Set.new(['target']))
+  end
+
+  context 'directories should not be included', :aggregate_failures do
+    context { include_examples 'testing a pair', ['*'], false, 'a_dir' }
+    context { include_examples 'testing a pair', ['*'], false, '.hidden_dir' }
+  end
+
+  context 'includes should be all files not in ignore list', :aggregate_failures do
+    test_inputs = [
+        [],
+        ['*'],
+        ['**/*'],
+        ['x/y/z'],
+        ['x/y/z/*'],
+        ['x/y/z/**/*'],
+        ['x/y/z/**/deep'],
+        ['.hidden_dir'],
+        ['.hidden_dir/'],
+        ['hidden_dir/'],
+        ['.hidden_dir/.*'],
+        ['.hidden_dir/.hidden_file'],
+    ]
+
+    around do |example|
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          %w(a_dir  .hidden_dir  x/y/z).each { |dirspec| FileUtils.mkdir_p(dirspec) }
+          %w(root  a_dir/sub  .hidden_dir/.hidden_file  x/y/z/deep).each { |f| FileUtils.touch(f) }
+          File.write('.gitignore', ignore_spec.join("\n"))
+          example.run
+        end
+      end
+    end
+
+    test_inputs.each do |ignore_spec|
+      context do
+        let(:ignore_spec)    { ignore_spec }
+        let(:ignored_files)  { GI.list_ignored_files(ignore_spec).sort }
+        let(:included_files) { GI.list_included_files(ignore_spec).sort }
+        let(:intersection)   { included_files & ignored_files }
+        let(:union)          { (included_files | ignored_files).sort }
+        let(:all_files) do
+          Dir.glob('**/*', File::FNM_DOTMATCH).reject do |filespec|
+            File.directory?(filespec)
+          end.sort
+        end
+
+        it { expect(intersection).to eq([]),
+            "expected no overlap between ignored and included for #{ignore_spec}, got #{intersection}" }
+        it { expect(union).to eq(all_files),
+            "expected ignored and included to contain all files for #{ignore_spec}, but neither contained: #{all_files - union}" }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.65.1
+  version: 0.66.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -150,6 +150,7 @@ files:
 - lib/trick_bag/formatters/erb_renderer.rb
 - lib/trick_bag/formatters/formatters.rb
 - lib/trick_bag/functional/functional.rb
+- lib/trick_bag/io/gitignore.rb
 - lib/trick_bag/io/temp_files.rb
 - lib/trick_bag/io/text_mode_status_updater.rb
 - lib/trick_bag/meta/classes.rb
@@ -183,6 +184,7 @@ files:
 - spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/functional/functional_spec.rb
+- spec/trick_bag/io/gitignore_spec.rb
 - spec/trick_bag/io/temp_files_spec.rb
 - spec/trick_bag/io/text_mode_status_updater_spec.rb
 - spec/trick_bag/meta/classes_spec.rb
@@ -221,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Miscellaneous general useful tools.
@@ -239,6 +241,7 @@ test_files:
 - spec/trick_bag/formatters/erb_renderer_spec.rb
 - spec/trick_bag/formatters/formatters_spec.rb
 - spec/trick_bag/functional/functional_spec.rb
+- spec/trick_bag/io/gitignore_spec.rb
 - spec/trick_bag/io/temp_files_spec.rb
 - spec/trick_bag/io/text_mode_status_updater_spec.rb
 - spec/trick_bag/meta/classes_spec.rb