vls 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17db29744dbbccea1c7827ffdb8ae7949c7e9995
-  data.tar.gz: a958d743642683678a760339c8c8240721ae5e93
+  metadata.gz: f00674ec64efd09019927af8a965dd74bb0eb4a7
+  data.tar.gz: 4e34a3c7ede30d8d205cad663b494ff7a6a0b9ae
 SHA512:
-  metadata.gz: 2b9b80c584773aa52d4dac99761c254f66a66bed1b5516922d9f1cabf7d4d7bb3d7e1a2154d1bf7f09a7fe6d299c2133dccd6003196293b5eae6a96d8a846228
-  data.tar.gz: 02f4781c24339dd1323489353d383be4b2f81ebd7a5ec868c90660bd8dae843e4328c2d9f4959fecb43bdb505558487ffaca2d42bcc6b98a68295a26ec6e084c
+  metadata.gz: f9232aed7288924b26178cee63a2a276ea49a44181c85077832e6d026eb3f8008f7564c61b3d9ba030b2a89f4b004fea6e054d0189f871f5cf8c5fac28945726
+  data.tar.gz: d2d4d3b9f2b4f4fce35209fed9fab50a53b970c9e8f5e2de8cbad1a97de95cde72917e489da195e4c2e26e890a367bc026a4143371e7e3c500fc859fc758809f

data/README.md

@@ -25,16 +25,30 @@ The vls gem itself is found at: ( https://rubygems.org/gems/vls )
 
 ## Usage
 
-The vls utility is normally used at the command line. The basic usage template
+The vls utility is normally used at the command line. The usage template
 is:
 
-    $ vls <names>
+    vls (VersionLS): 0.3.6
 
-where names is a list of gems and/or files to be required before the
-module/classes are displayed with their VERSION information. For example:
+    A command line utility that lists the versions of modules used by the specified
+    gems/ruby files.
+
+    Usage: $ vls <options> <names>
+
+    <options>
+      --filter, -f <s/r> = Filter results by string or regular expression.
+      --help, -h, -?     = Display this text and exit.
+      --raw,  -r         = Display results with no header text.
+
+    <names> are gems/files to be required before modules are listed.
+
+    Note:
+     To specify a file instead of a gem, a '.rb' extension is required.
+
+For example:
 
     $ vls rails
-    vls (VersionLS): 0.3.0
+    vls (VersionLS): 0.3.6
 
     ActionPack, 4.2.6
     ActiveSupport, 4.2.6
@@ -53,7 +67,7 @@ In order to use relative paths instead of the gem search path, the .rb extension
 needs to be specified on the target file.
 
     $ vls ruby_sscanf.rb
-    vls (VersionLS): 0.3.0
+    vls (VersionLS): 0.3.6
 
     FormatEngine, 0.7.2
     Gem, 2.2.2
@@ -62,7 +76,7 @@ needs to be specified on the target file.
 The vls utility is also available for use within an application. It may be
 accessed with:
 ```ruby
-module_version_list = VersionLS.vls
+module_version_list = VersionLS.vls(filter=/./)
 ```
 This returns an array of entries, sorted by module name, consisting of an
 array with the module and a string with its version. Also, the Object class
@@ -70,7 +84,7 @@ is monkey patched with the vls method that outputs the information to the
 console.
 
 ```ruby
-vls
+vls(filter=/./)
 ```
 
 Note that these methods do not accept a list of modules to be required. It
@@ -79,6 +93,8 @@ would have already been loaded. In addition, the vls listing to the console
 has no header information. If this is desired, the application should do a
 puts of the appropriate descriptive text.
 
+Both of these methods _do_ take an optional filter string or regular expression.
+
 ## The Rails Console
 
 If the vls gem has been added to a rails project (in its Gemfile), its
@@ -168,6 +184,19 @@ load out of the web site. For example:
     => nil
     irb(main):002:0>
 
+Of course, filtering is available at this level too:
+
+    irb(main):003:0> vls 'Rails'
+    Coffee::Rails, 4.1.1
+    Jquery::Rails, 4.1.1
+    Rails, 4.2.6
+    Rails::Html::FullSanitizer, 1.0.3
+    Rails::Html::LinkSanitizer, 1.0.3
+    Rails::Html::Sanitizer, 1.0.3
+    Rails::Html::WhiteListSanitizer, 1.0.3
+    Sass::Rails, 5.0.4
+    Sprockets::Rails, 3.0.4
+
 ## Usage in Rails Views
 
 It is also possible to incorporate vls data into a view using the VersionLS.vls

data/bin/vls

@@ -12,25 +12,32 @@ def vls_show_help
   puts VersionLS::DESCRIPTION
   puts "\nUsage: $ vls <options> <names>"
   puts "\n<options>"
-  puts "  --help, -h, -? = Display this text and exit."
-  puts "  --raw,  -r     = Display results with no header text."
+  puts "  --filter, -f <s/r> = Filter results by string or regular expression."
+  puts "  --help, -h, -?     = Display this text and exit."
+  puts "  --raw,  -r         = Display results with no header text."
   puts "\n<names> are gems/files to be required before modules are listed."
   puts "\nNote:"
   puts " To specify a file instead of a gem, a '.rb' extension is required."
   exit
 end
 
-load_list, no_header = [], false
+load_list, no_header, special, option_args = [], false, false, {filter: "/./"}
 
 #Process the script argument list.
 ARGV.each do |arg|
-  case arg
-  when "--help", "-h", "-?"
-    vls_show_help
-  when "--raw", "-r"
-    no_header = true
+  if special
+    option_args[special], special = arg, false
   else
-    load_list << arg
+    case arg
+    when "--filter", "-f"
+      special = :filter
+    when "--help", "-h", "-?"
+      vls_show_help
+    when "--raw", "-r"
+      no_header = true
+    else
+      load_list << arg
+    end
   end
 end
 
@@ -52,4 +59,6 @@ load_list.each do |pkg|
   end
 end
 
-VersionLS.ls unless errors_found
+filter = option_args[:filter]
+filter = Regexp.new(filter[1...-1]) if /^\/.*\/$/ =~ filter
+VersionLS.print_vls(filter) unless errors_found

data/lib/vls.rb

@@ -6,15 +6,19 @@ require_relative "vls/version"
 # The Version LiSt utility module.
 module VersionLS
   #Perform a Versioned LiSt to the console.
-  def self.ls
-    vls.each{|mod| puts "#{mod[0]}, #{mod[1]}"}
+  #<br>Parameters
+  #* filter - a string or regex used to filter the list of modules.
+  def self.print_vls(filter)
+    vls(filter).each{|mod| puts "#{mod[0]}, #{mod[1]}"}
     nil
   end
 
   #Execute the core of the vls command and return an array of
   #[module, version] arrays.
-  def self.vls
-    modules.map do |mod|
+  #<br>Parameters
+  #* filter - a string or regex used to filter the list of modules.
+  def self.vls(filter=/./)
+    modules(filter).map do |mod|
       begin
         version = mod::VERSION
       rescue
@@ -26,10 +30,15 @@ module VersionLS
   end
 
   #Get a list of modules that have VERSION info.
-  def self.modules
+  #<br>Parameters
+  #* filter - a string or regex used to filter the list of modules.
+  #<br>Returns
+  #* An array of module objects.
+  def self.modules(filter)
     mods = ObjectSpace.each_object(Module).
            select do |mod|
-             mod.const_defined?("VERSION")
+             mod.const_defined?("VERSION") &&
+             mod.name.partition(filter)[1] != ""
            end.
            sort do |first, second|
              first.name <=> second.name

data/lib/vls/monkey_patch.rb

@@ -8,8 +8,10 @@ class Object
   end
 
   #A simple shortcut method for ease of use in irb and rails console.
-  def vls
-    VersionLS.ls
+  #<br>Endemic Code Smells
+  #* :reek:UtilityFunction
+  def vls(filter=/./)
+    VersionLS.ls(filter)
   end
 end
 

data/lib/vls/version.rb

@@ -1,5 +1,5 @@
 module VersionLS
-  STRING = VERSION = "0.3.5"
+  STRING = VERSION = "0.3.6"
 
   DESCRIPTION = "A command line utility that lists the versions of " +
                 "modules used by the specified gems/ruby files."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vls
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler