path_expander 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb707e47c24f77a4b4a2d23c8db936f9b6d0b9db
+  data.tar.gz: f69d58051c1c4a8d38e7c762bf164cc4b2b96055
+SHA512:
+  metadata.gz: c91cc5482ca821c474986e05cfc0d1b337f1cd9c2632fd323578e9f0a5e8789825204c9ebd748d26ca7b97bb184225555c96459724cfd1b6f88dbb43b3f1661f
+  data.tar.gz: 0b50d8770583b077005a75039a972ca2b7f1e1b4f766c8d0772f891b2a43972bc5157433a1ae51a1511de430d6538dfbe7a28197cb043b2e9bb7f67023e167cb

data/.autotest

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+  at.add_exception "tmp"
+
+  # at.extra_files << "../some/external/dependency.rb"
+  #
+  # at.libs << ":../some/external"
+  #
+  # at.add_exception "vendor"
+  #
+  # at.add_mapping(/dependency.rb/) do |f, _|
+  #   at.files_matching(/test_.*rb$/)
+  # end
+  #
+  # %w(TestA TestB).each do |klass|
+  #   at.extra_class_map[klass] = "test/test_misc.rb"
+  # end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2016-05-11
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/path_expander.rb
+test/test_bad.rb
+test/test_path_expander.rb

data/README.rdoc

@@ -0,0 +1,74 @@
+= path_expander
+
+home :: https://github.com/seattlerb/path_expander
+rdoc :: http://docs.seattlerb.org/path_expander
+
+== DESCRIPTION:
+
+PathExpander helps pre-process command-line arguments expanding
+directories into their constituent files. It further helps by
+providing additional mechanisms to make specifying subsets easier
+with path subtraction and allowing for command-line arguments to be
+saved in a file.
+
+NOTE: this is NOT an options processor. It is a path processor
+(basically everything else besides options). It does provide a
+mechanism for pre-filtering cmdline options, but not with the intent
+of actually processing them in PathExpander. Use OptionParser to
+deal with options either before or after passing ARGV through
+PathExpander.
+
+== FEATURES/PROBLEMS:
+
+* Processes command-line arguments.
+* Expands directories into files using custom globs.
+* Allows for negation of files.
+* Allows for use of files as persisted args.
+* Provides a .ignore mechanism for lightweight persistent exclusion.
+
+== SYNOPSIS:
+
+    class MyPathExpander < PathExpander
+      MY_GLOB = "**/*.rb"
+
+      def initialize args = ARGV
+        super args, TEST_GLOB
+      end
+    end
+
+    MyPathExpander.new(ARGV, my_glob).process.each do |f|
+      # do something with each file
+    end
+
+== REQUIREMENTS:
+
+* ruby
+
+== INSTALL:
+
+* sudo gem install path_expander
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, seattle.rb
+
+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/Rakefile

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :isolate
+Hoe.plugin :seattlerb
+Hoe.plugin :rdoc
+
+# Hoe.plugin :compiler
+# Hoe.plugin :doofus
+# Hoe.plugin :email
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :history
+# Hoe.plugin :inline
+# Hoe.plugin :isolate
+# Hoe.plugin :minitest
+# Hoe.plugin :perforce
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rdoc
+# Hoe.plugin :seattlerb
+
+Hoe.spec "path_expander" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
+
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/lib/path_expander.rb

@@ -0,0 +1,165 @@
+##
+# PathExpander helps pre-process command-line arguments expanding
+# directories into their constituent files. It further helps by
+# providing additional mechanisms to make specifying subsets easier
+# with path subtraction and allowing for command-line arguments to be
+# saved in a file.
+#
+# NOTE: this is NOT an options processor. It is a path processor
+# (basically everything else besides options). It does provide a
+# mechanism for pre-filtering cmdline options, but not with the intent
+# of actually processing them in PathExpander. Use OptionParser to
+# deal with options either before or after passing ARGV through
+# PathExpander.
+
+class PathExpander
+  VERSION = "1.0.0" # :nodoc:
+
+  ##
+  # The args array to process.
+
+  attr_accessor :args
+
+  ##
+  # The glob used to expand dirs to files.
+
+  attr_accessor :glob
+
+  ##
+  # Create a new path expander that operates on args and expands via
+  # glob as necessary.
+
+  def initialize args, glob
+    self.args = args
+    self.glob = glob
+  end
+
+  ##
+  # Takes an array of paths and returns an array of paths where all
+  # directories are expanded to all files found via the glob provided
+  # to PathExpander.
+
+  def expand_dirs_to_files *dirs
+    dirs.flatten.map { |p|
+      if File.directory? p then
+        Dir[File.join(p, glob)]
+      else
+        p
+      end
+    }.flatten
+  end
+
+  ##
+  # Process a file into more arguments. Override this to add
+  # additional capabilities.
+
+  def process_file path
+    File.readlines(path).map(&:chomp)
+  end
+
+  ##
+  # Enumerate over args passed to PathExpander and return a list of
+  # files and flags to process. Arguments are processed as:
+  #
+  # @file_of_args :: Read the file and append to args.
+  # -file_path    :: Subtract path from file to be processed.
+  # -dir_path     :: Expand and subtract paths from files to be processed.
+  # -not_a_path   :: Add to flags to be processed.
+  # dir_path      :: Expand and add to files to be processed.
+  # file_path     :: Add to files to be processed.
+  #
+  # See expand_dirs_to_files for details on how expansion occurs.
+  #
+  # Subtraction happens last, regardless of argument ordering.
+
+  def process_args
+    pos_files = []
+    neg_files = []
+    flags     = []
+
+    args.each do |arg|
+      case arg
+      when /^@(.*)/ then # push back on, so they can have dirs/-/@ as well
+        args.concat process_file $1
+      when /^-(.*)/ then
+        if File.exist? $1 then
+          neg_files += expand_dirs_to_files($1)
+        else
+          flags << arg
+        end
+      else
+        if File.exist? arg then
+          pos_files += expand_dirs_to_files(arg)
+        else
+          flags << arg
+        end
+      end
+    end
+
+    [pos_files - neg_files, flags]
+  end
+
+  ##
+  # Process over flags and treat any special ones here. Returns an
+  # array of the flags you haven't processed.
+  #
+  # This version does nothing. Subclass and override for
+  # customization.
+
+  def process_flags flags
+    flags
+  end
+
+  ##
+  # Top-level method processes args. It replaces args' contents with a
+  # new array of flags to process and returns a list of files to
+  # process. Eg
+  #
+  #     PathExpander.new(ARGV).process.each do |f|
+  #       puts "./#{f}"
+  #     end
+
+  def process
+    files, flags = process_args
+
+    args.replace process_flags flags
+
+    files.uniq
+  end
+
+  ##
+  # A file filter mechanism similar to, but not as extensive as,
+  # .gitignore files:
+  #
+  # + If a pattern does not contain a slash, it is treated as a shell glob.
+  # + If a pattern ends in a slash, it matches on directories (and contents).
+  # + Otherwise, it matches on relative paths.
+  #
+  # File.fnmatch is used throughout, so glob patterns work for all 3 types.
+  #
+  # Takes a list of +files+ and either an io or path of +ignore+ data
+  # and returns a list of files left after filtering.
+
+  def filter_files files, ignore
+    ignore_paths = if ignore.respond_to? :read then
+                     ignore.read
+                   elsif File.exists? ignore then
+                     File.read ignore
+                   end
+
+    if ignore_paths then
+      nonglobs, globs = ignore_paths.split("\n").partition { |p| p.include? "/" }
+      dirs, ifiles    = nonglobs.partition { |p| p.end_with? "/" }
+      dirs            = dirs.map { |s| s.chomp "/" }
+
+      only_paths = File::FNM_PATHNAME
+      files = files.reject { |f|
+        dirs.any?     { |i| File.fnmatch?(i, File.dirname(f), only_paths) } ||
+          globs.any?  { |i| File.fnmatch?(i, f) } ||
+          ifiles.any? { |i| File.fnmatch?(i, f, only_paths) }
+      }
+    end
+
+    files
+  end
+end

data/test/test_bad.rb

@@ -0,0 +1 @@
+# ignore me. just for filtering

data/test/test_path_expander.rb

@@ -0,0 +1,131 @@
+require "minitest/autorun"
+require "path_expander"
+
+class TestPathExpander < Minitest::Test
+  attr_accessor :args
+  attr_accessor :expander
+
+  def setup
+    self.args = []
+
+    self.expander = PathExpander.new args, "*.rb"
+  end
+
+  def assert_filter_files exp, filter, files = %w[test/dog_and_cat.rb]
+    ignore = StringIO.new filter
+    act = expander.filter_files files, ignore
+    assert_equal exp, act
+  end
+
+  def assert_process_args exp_files, exp_args, *args
+    expander.args.concat args
+
+    assert_equal [exp_files, exp_args], expander.process_args
+  end
+
+  def test_expand_dirs_to_files
+    exp = %w[test/test_bad.rb test/test_path_expander.rb]
+
+    assert_equal exp, expander.expand_dirs_to_files("test")
+    assert_equal %w[Rakefile], expander.expand_dirs_to_files("Rakefile")
+  end
+
+  def test_filter_files_dir
+    assert_filter_files [], "test/"
+  end
+
+  def test_filter_files_files
+    assert_filter_files [], "test/*.rb"
+
+    example = %w[test/file.rb test/sub/file.rb top/test/perf.rb]
+
+    assert_filter_files example[1..-1], "test/*.rb", example
+  end
+
+  def test_filter_files_glob
+    assert_filter_files [], "test*"
+    assert_filter_files [], "test*", ["test/lib/woot.rb"]
+    assert_filter_files [], "*.rb"
+    assert_filter_files [], "*dog*.rb"
+  end
+
+  def test_filter_files_glob_miss
+    miss = %w[test/dog_and_cat.rb]
+    assert_filter_files miss, "test"
+    assert_filter_files miss, "nope"
+  end
+
+  def test_process
+    self.args.concat %w[test --seed 42]
+
+    act = expander.process
+
+    assert_equal %w[test/test_bad.rb test/test_path_expander.rb], act
+    assert_equal %w[--seed 42], expander.args
+    assert_equal %w[--seed 42], args # affected our original array (eg, ARGV)
+  end
+
+  def with_tempfile *lines
+    require "tempfile"
+
+    Tempfile.open("tmp") do |f|
+      f.puts lines
+      f.flush
+      f.rewind
+
+      yield f
+    end
+  end
+
+  def test_process_args_at
+    with_tempfile %w[test -test/test_bad.rb --seed 24] do |f|
+      assert_process_args(%w[test/test_path_expander.rb],
+                          %w[--seed 24],
+                          "@#{f.path}")
+    end
+  end
+
+  def test_process_args_dash_dir
+    assert_process_args(%w[],
+                        %w[],
+                        "test", "-test")
+  end
+
+  def test_process_args_dash_file
+    assert_process_args(%w[test/test_path_expander.rb],
+                        %w[],
+                        "test", "-test/test_bad.rb")
+
+  end
+
+  def test_process_args_dash_other
+    assert_process_args(%w[],
+                        %w[--verbose],
+                        "--verbose")
+  end
+
+  def test_process_args_dir
+    assert_process_args(%w[test/test_bad.rb test/test_path_expander.rb],
+                        %w[],
+                        "test")
+  end
+
+  def test_process_args_file
+    assert_process_args(%w[test/test_path_expander.rb],
+                        %w[],
+                        "test/test_path_expander.rb")
+  end
+
+  def test_process_args_other
+    assert_process_args(%w[],
+                        %w[42],
+                        "42")
+  end
+
+  def test_process_flags
+    exp = %w[a b c]
+    act = expander.process_flags %w[a b c]
+
+    assert_equal exp, act
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: path_expander
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Davis
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBAzANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTE1MDkxOTIwNTEyMloXDTE2MDkxODIwNTEyMlowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQB+Hx8xUgrpZa4P8H8gR8zme5kISwQrG80MbpqJV6/G3/ZicRFhN5sjwu0uHGue
+  bd9Cymf6oIRwHVarJux2M32T6bL07Hmi07w2QaPc3MnMKB/D46SRZ2JSSGPFRBTc
+  SilobMRoGs/7B15uGFUEnNrCB/ltMqhwwSx1r++UQPfeySHEV9uqu03E5Vb7J37O
+  2Er6PLXHRiYsIycD1LkMi6YnixdITRHmrqJYE2rsjaIfpIehiusVAPHkNf7qbpHq
+  qx3h45R1CAsObX0SQDIT+rRbQrtKz1GHIZTOFYvEJjUY1XmRTZupD3CJ8Q7sDqSy
+  NLq5jm1fq6Y9Uolu3RJbmycf
+  -----END CERTIFICATE-----
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.15'
+description: |-
+  PathExpander helps pre-process command-line arguments expanding
+  directories into their constituent files. It further helps by
+  providing additional mechanisms to make specifying subsets easier
+  with path subtraction and allowing for command-line arguments to be
+  saved in a file.
+
+  NOTE: this is NOT an options processor. It is a path processor
+  (basically everything else besides options). It does provide a
+  mechanism for pre-filtering cmdline options, but not with the intent
+  of actually processing them in PathExpander. Use OptionParser to
+  deal with options either before or after passing ARGV through
+  PathExpander.
+email:
+- ryand-ruby@zenspider.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- .autotest
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/path_expander.rb
+- test/test_bad.rb
+- test/test_path_expander.rb
+homepage: https://github.com/seattlerb/path_expander
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: PathExpander helps pre-process command-line arguments expanding directories
+  into their constituent files
+test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+�V�[�F͜!yľ!l��N�5[�)�%htK4��!�����/�>���{�^P()�4&�
+���X�^�j*���
+n�.�^A����?N�;�d����"k��ρ��ʣ�($(�z�@�|���x��c�� �׊$ �6I+y�AR���Zj�;K�y�����؟�vf��.{�T��������{t92��h̐9S��P�v���#�̸|����Ⳕ��H����/Ч�����@%0%Bv3��^�+��