vls 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddf99496065f624a2b98d4bdf73233b619e3e42d
-  data.tar.gz: 8eecdac22d3507bfffd0364aa20ee96a17f9bbe2
+  metadata.gz: 17db29744dbbccea1c7827ffdb8ae7949c7e9995
+  data.tar.gz: a958d743642683678a760339c8c8240721ae5e93
 SHA512:
-  metadata.gz: 78608e23c2555a9f291c39a212868d8ff1eba1993064c5ccd8776b518826aea6aceff463d488c56fcbc66cce4e9e3b1143d8ac0e361daad174d805f7f4ec3b54
-  data.tar.gz: 503caa9869416aa4a34497ec745f026c2cd22e1379e05cece281689b1b76bfa298ae59158ce335a2b394ab8a8f1753a494e049a90f845f628bc1622dbb0a8530
+  metadata.gz: 2b9b80c584773aa52d4dac99761c254f66a66bed1b5516922d9f1cabf7d4d7bb3d7e1a2154d1bf7f09a7fe6d299c2133dccd6003196293b5eae6a96d8a846228
+  data.tar.gz: 02f4781c24339dd1323489353d383be4b2f81ebd7a5ec868c90660bd8dae843e4328c2d9f4959fecb43bdb505558487ffaca2d42bcc6b98a68295a26ec6e084c

data/README.md

@@ -65,23 +65,31 @@ accessed with:
 module_version_list = VersionLS.vls
 ```
 This returns an array of entries, sorted by module name, consisting of an
-array with the module and a string with its version.
+array with the module and a string with its version. Also, the Object class
+is monkey patched with the vls method that outputs the information to the
+console.
 
-Note that the vls method does not accept a list of modules to be required. It
+```ruby
+vls
+```
+
+Note that these methods do not accept a list of modules to be required. It
 is assumed that when embedded within an application, the needed facilities
-would have already been loaded.
+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.
 
 ## The Rails Console
 
-If the vls gem has been added to a rails project, its functionality is also
-easily accessed via the rails console:
+If the vls gem has been added to a rails project (in its Gemfile), its
+functionality is also easily accessed via the rails console:
 
     $ rails console
 
 followed by
 
 ```ruby
-VersionLS.ls
+vls
 ```
 
 will create a formatted listing of the modules with version info of the module
@@ -89,7 +97,7 @@ load out of the web site. For example:
 
     $ rails console
     Loading development environment (Rails 4.2.6)
-    irb(main):001:0> VersionLS.ls
+    irb(main):001:0> vls
     ActionDispatch::Journey::Router, 2.0.0
     ActionMailer, 4.2.6
     ActionPack, 4.2.6
@@ -162,13 +170,12 @@ load out of the web site. For example:
 
 ## Usage in Rails Views
 
-It is also possible to incorporate vls data into a view using the vls method
-in a controller and passing the resultant array of data to a view for
+It is also possible to incorporate vls data into a view using the VersionLS.vls
+method in a controller and passing the resultant array of data to a view for
 rendering in a web page. This may be useful for a diagnostic or informational
-page in the web site.
-
-A detailed examination of this task is beyond the scope of this document and
-readers are advised to consult Ruby on Rails tutorials for more information.
+page in a web site. However, a detailed examination of this task is beyond the
+scope of this document and readers are advised to consult Ruby on Rails
+tutorials for more information.
 
 ## Contributing
 

data/bin/vls

@@ -4,16 +4,13 @@
 require_relative '../lib/vls'
 
 def vls_show_header
-  puts "vls (VersionLS): #{VersionLS::VERSION}"
-  puts
+  print "vls (VersionLS): #{VersionLS::VERSION}\n\n"
 end
 
 def vls_show_help
   vls_show_header
   puts VersionLS::DESCRIPTION
-  puts
-  puts "Usage template:"
-  puts "$ vls <options> <names>"
+  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."
@@ -25,6 +22,7 @@ end
 
 load_list, no_header = [], false
 
+#Process the script argument list.
 ARGV.each do |arg|
   case arg
   when "--help", "-h", "-?"
@@ -40,6 +38,7 @@ vls_show_help   if     load_list.empty?
 vls_show_header unless no_header
 errors_found = false
 
+#Require the specified gems and ruby files.
 load_list.each do |pkg|
   begin
     if pkg.downcase.end_with?('.rb')

data/lib/vls/monkey_patch.rb

@@ -6,6 +6,11 @@ class Object
   def to_vls_version_string
     "version #{self.class} ???"
   end
+
+  #A simple shortcut method for ease of use in irb and rails console.
+  def vls
+    VersionLS.ls
+  end
 end
 
 #An addition to the String class for vls support.

data/lib/vls/version.rb

@@ -1,5 +1,5 @@
 module VersionLS
-  STRING = VERSION = "0.3.4"
+  STRING = VERSION = "0.3.5"
 
   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.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler