vls 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1ba8a8da9aef839b7e2fab7a318d45f38a07ce1
-  data.tar.gz: d0ff1d7cc5271118b71b3e13292f3200cb4afdf7
+  metadata.gz: ddf99496065f624a2b98d4bdf73233b619e3e42d
+  data.tar.gz: 8eecdac22d3507bfffd0364aa20ee96a17f9bbe2
 SHA512:
-  metadata.gz: bc0964310a2146bbd0d031bb4417e8d6b16d2c6f2b71a4b5fd1e19877a01c28f7afb27c7d2e4e0280f65e15209bc264ff678b84d6618aee1fc27dc1897754702
-  data.tar.gz: b941d86543bb3616620c563d82821014e96a1d81dceefd7dd771e037ee0b3f29538c7b26709ae2eaf880e8f5fb1acdbe05a56e91d7b2b579b036c1bf45e9a821
+  metadata.gz: 78608e23c2555a9f291c39a212868d8ff1eba1993064c5ccd8776b518826aea6aceff463d488c56fcbc66cce4e9e3b1143d8ac0e361daad174d805f7f4ec3b54
+  data.tar.gz: 503caa9869416aa4a34497ec745f026c2cd22e1379e05cece281689b1b76bfa298ae59158ce335a2b394ab8a8f1753a494e049a90f845f628bc1622dbb0a8530

data/README.md

@@ -71,6 +71,105 @@ Note that the vls method does 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.
 
+## The Rails Console
+
+If the vls gem has been added to a rails project, its functionality is also
+easily accessed via the rails console:
+
+    $ rails console
+
+followed by
+
+```ruby
+VersionLS.ls
+```
+
+will create a formatted listing of the modules with version info of the module
+load out of the web site. For example:
+
+    $ rails console
+    Loading development environment (Rails 4.2.6)
+    irb(main):001:0> VersionLS.ls
+    ActionDispatch::Journey::Router, 2.0.0
+    ActionMailer, 4.2.6
+    ActionPack, 4.2.6
+    ActionView, 4.2.6
+    ActiveJob, 4.2.6
+    ActiveModel, 4.2.6
+    ActiveRecord, 4.2.6
+    ActiveSupport, 4.2.6
+    ActiveSupport::Logger, 1.2.7
+    Arel, 6.0.3
+    Bundler, 1.11.2
+    Coffee::Rails, 4.1.1
+    Concurrent, 1.0.1
+    Erubis, 2.7.0
+    ExecJS, 2.6.0
+    Gem, 2.2.2
+    I18n, 0.7.0
+    IRB::ReadlineInputMethod, 5.2
+    JSON, 1.8.3
+    Jquery::Rails, 4.1.1
+    Logger, 1.2.7
+    Loofah, 2.0.3
+    MIME::Type, 2.99.1
+    MIME::Types, 2.99.1
+    MIME::Types::WarnLogger, 1.2.7
+    Mail, 2.6.3
+    MultiJson, 1.11.2
+    Nokogiri, 1.6.7.2
+    OpenSSL, 1.1.0
+    PG, 0.18.4
+    Psych, 2.0.5
+    Rack, 1.3
+    Rack::Test, 0.6.3
+    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
+    Readline, 5.2
+    Sass, 3.4.21 (Selective Steve)
+    Sass::Rails, 5.0.4
+    Sprockets, 3.5.2
+    Sprockets::Cache, 3.0
+    Sprockets::ClosureCompressor, 1
+    Sprockets::CoffeeScriptProcessor, 1
+    Sprockets::DirectiveProcessor, 1
+    Sprockets::EcoProcessor, 1
+    Sprockets::EjsProcessor, 1
+    Sprockets::Rails, 3.0.4
+    Sprockets::SassCompressor, 1
+    Sprockets::UglifierCompressor, 1
+    Sprockets::YUICompressor, 1
+    TZInfo::Data, 1.2016.2
+    ThreadSafe, 0.3.5
+    Tilt, 2.0.2
+    Turbolinks, 2.5.3
+    URI, 0.9.11
+    URI::FTP, 0.9.11
+    URI::GID, 0.9.11
+    URI::Generic, 0.9.11
+    URI::HTTP, 0.9.11
+    URI::HTTPS, 0.9.11
+    URI::LDAP, 0.9.11
+    URI::LDAPS, 0.9.11
+    URI::MailTo, 0.9.11
+    Uglifier, 2.7.2
+    Zlib, 0.6.0
+    => nil
+    irb(main):002:0>
+
+## 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
+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.
+
 ## Contributing
 
 #### Plan A

data/bin/vls

@@ -1,39 +1,56 @@
 #!/usr/bin/env ruby
-#
-# The vls command line utility script.
-#
+#The vls command line utility script.
 
-require 'vls'
+require_relative '../lib/vls'
 
-puts "vls (VersionLS): #{VersionLS::VERSION}"
-puts
+def vls_show_header
+  puts "vls (VersionLS): #{VersionLS::VERSION}"
+  puts
+end
 
-if ARGV.empty?
-  puts "Usage template:"
-  puts "$ vls <names>"
-  puts " <names> are gems/files to be required before modules are listed."
+def vls_show_help
+  vls_show_header
+  puts VersionLS::DESCRIPTION
   puts
-  puts "Note:"
+  puts "Usage template:"
+  puts "$ vls <options> <names>"
+  puts "\n<options>"
+  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."
-else
-  no_good = false
-
-  ARGV.each do |pkg|
-    begin
-      if pkg.downcase.end_with?('.rb')
-        require Dir.getwd + '/' + pkg
-      else
-        require pkg
-      end
-    rescue LoadError, StandardError => error
-      puts "Error loading #{pkg}, #{error.message}"
-      no_good = true
-    end
+  exit
+end
+
+load_list, no_header = [], false
+
+ARGV.each do |arg|
+  case arg
+  when "--help", "-h", "-?"
+    vls_show_help
+  when "--raw", "-r"
+    no_header = true
+  else
+    load_list << arg
   end
+end
 
-  exit if no_good
+vls_show_help   if     load_list.empty?
+vls_show_header unless no_header
+errors_found = false
 
-  VersionLS.vls.each do |mod|
-    puts "#{mod[0]}, #{mod[1]}"
+load_list.each do |pkg|
+  begin
+    if pkg.downcase.end_with?('.rb')
+      require Dir.getwd + '/' + pkg
+    else
+      require pkg
+    end
+  rescue LoadError, StandardError => error
+    puts "Error loading #{pkg}, #{error.message}"
+    errors_found = true
   end
 end
+
+VersionLS.ls unless errors_found

data/lib/vls.rb

@@ -1,43 +1,16 @@
 # coding: utf-8
 
+require_relative "vls/monkey_patch"
 require_relative "vls/version"
 
-#An addition to the Object class for vls support.
-class Object
-  #Get the vls version string from this module.
-  def to_vls_version_string
-    "version #{self.class} ???"
-  end
-end
-
-#An addition to the String class for vls support.
-class String
-  #Get this string as a vls version string.
-  def to_vls_version_string
-    self
-  end
-end
-
-#An addition to the Module class for vls support.
-class Module
-  #Get the vls version string from this module.
-  def to_vls_version_string
-    self::STRING
-  rescue
-    "version #{self} ???"
-  end
-end
-
-#An addition to the Array class for vls support.
-class Array
-  #Get the vls version string from this array.
-  def to_vls_version_string
-    (1..5) === self.length ? self.join('.') : super
-  end
-end
-
 # 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]}"}
+    nil
+  end
+
   #Execute the core of the vls command and return an array of
   #[module, version] arrays.
   def self.vls
@@ -54,11 +27,13 @@ module VersionLS
 
   #Get a list of modules that have VERSION info.
   def self.modules
-    mods = ObjectSpace.each_object(Module).select do |mod|
-      mod.const_defined?("VERSION")
-    end.sort do
-      |first, second| first.name <=> second.name
-    end
+    mods = ObjectSpace.each_object(Module).
+           select do |mod|
+             mod.const_defined?("VERSION")
+           end.
+           sort do |first, second|
+             first.name <=> second.name
+           end
 
     mods - [VersionLS]
   end

data/lib/vls/monkey_patch.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+#An addition to the Object class for vls support.
+class Object
+  #Get the vls version string from this module.
+  def to_vls_version_string
+    "version #{self.class} ???"
+  end
+end
+
+#An addition to the String class for vls support.
+class String
+  #Get this string as a vls version string.
+  def to_vls_version_string
+    self
+  end
+end
+
+#An addition to the Module class for vls support.
+class Module
+  #Get the vls version string from this module.
+  def to_vls_version_string
+    self::STRING
+  rescue
+    "version #{self} ???"
+  end
+end
+
+#An addition to the Array class for vls support.
+class Array
+  #Get the vls version string from this array.
+  def to_vls_version_string
+    (1..5) === self.length ? self.join('.') : super
+  end
+end

data/lib/vls/version.rb

@@ -1,3 +1,6 @@
 module VersionLS
-  STRING = VERSION = "0.3.3"
+  STRING = VERSION = "0.3.4"
+
+  DESCRIPTION = "A command line utility that lists the versions of " +
+                "modules used by the specified gems/ruby files."
 end

data/vls.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Camilleri"]
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
-  spec.description   = "A command line utility that lists the versions of " +
-                       "modules used by the specified gems/ruby files."
+  spec.description   = VersionLS::DESCRIPTION
   spec.summary       = "A version listing utility"
   spec.homepage      = "http://teuthida-technologies.com/"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vls
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,7 @@ files:
 - README.md
 - bin/vls
 - lib/vls.rb
+- lib/vls/monkey_patch.rb
 - lib/vls/version.rb
 - rakefile.rb
 - reek.txt