lapidarius 2.1.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7710821237e08e7528d2d68e033af6d44c20e33d
-  data.tar.gz: 5c349cf60b82a03b47531a7d7695adffb4abec9e
+  metadata.gz: 047e73cb5b2d4a23b395e2780448ba0f60bc322d
+  data.tar.gz: 4309e419d45fbb06bb9b8db9c20c6ff6b55480af
 SHA512:
-  metadata.gz: 469186864c12e739586fece5372397f816b6946f4f6872448f39c085da92601ff2a256715f1768877a355fcee45b5069c9c8c386afdc40a4b4b17f88f2a94e69
-  data.tar.gz: 9759cf03c8d0b1d46fdd73c7e4a173dbdda758682e92b96e222b6f48241edc7d19c437e1523efbe926c3b729129258c3437aab526f8a65a454c270fd3e3ef809
+  metadata.gz: 118527bfce62dba8aaa7a7bd4f905eb2bc1d460aaa82f116252f6c18a7c6f257e51a47c9343cba978aa0698bb3021a86b3e61539b468325da219cdc5a00d8611
+  data.tar.gz: 458a14c7713453b520691ae574f825b372fca8a3b3efc15508b9fd2991f8b200e1302b11a0c7dbef50342d91fdfe879042fd8e75580371b79556e02c9b25dafc

data/README.md

@@ -6,8 +6,7 @@
     * [bundle viz](#bundle-viz)
 * [Usage](#usage)
   * [Warning](#warning)
-  * [Unique dependencies](#unique-dependencies)
-  * [Recursive print](#recursive-print)
+  * [Output](#output)
 
 ## Scope
 This gem is aimed to list recursively the **runtime dependencies** footprint of the specified gem.
@@ -26,43 +25,20 @@ While it is great to visualize inter-dependencies, i have hard times figuring ou
 The library relies on the *Gem::Commands::DependencyCommand* class (the one invoked by the *gem dep* command line), invoking it recursively to deeply fetch dependencies.
 
 ### Warning
-Consider only the gems installed on your system are scanned for their own dependencies, no remote fetching is performed.
+Consider only the gems installed on your system are scanned.  
+No remote fetching is performed.
 
-### Unique dependencies
-The command outcome includes all of the unique (by name) nested runtime dependencies:
+### Output
+The output of the library mimics the `tree` shell utility that lists file system nested entries.  
+Although all of the nested runtime dependencies are included in the output, just the unique ones are counted:
 ```
-$ lapidarius --gem=grape
-
-grape (1.0.1)               16
-------------------------------
-activesupport (>= 0)
-builder (>= 0)
-mustermann-grape (~> 1.0.0)
-rack (>= 1.3.0)
-rack-accept (>= 0)
-virtus (>= 1.0.0)
-i18n (~> 0.7)
-minitest (~> 5.1)
-thread_safe (>= 0.3.4, ~> 0.3)
-tzinfo (~> 1.1)
-mustermann (~> 1.0.0)
-axiom-types (~> 0.1)
-coercible (~> 1.0)
-descendants_tracker (>= 0.0.3, ~> 0.0)
-equalizer (>= 0.0.9, ~> 0.0)
-ice_nine (~> 0.11.0)
-```
-
-### Recursive print
-To print dependencies hierarchy recursively, provide the *--recursive* flag. Duplicates are not counted:  
-```
-$ lapidarius --gem=sinatra --recursive
-
-sinatra (1.4.7)              3
-------------------------------
-rack (~> 1.5)
-rack-protection (~> 1.4)
-  rack (>= 0)
-tilt (< 3, >= 1.3)
-
+$ lapidarius --gem=sinatra
+sinatra (2.0.0)
+├── mustermann (~> 1.0)
+├── rack (~> 2.0)
+├── rack-protection (= 2.0.0)
+│   └── rack (>= 0)
+└── tilt (~> 2.0)
+
+4 runtime dependencies
 ```

data/lib/lapidarius/cli.rb

@@ -1,6 +1,5 @@
 require "optparse"
 require "lapidarius/cutter"
-require "lapidarius/renderer"
 
 module Lapidarius
   class CLI
@@ -8,30 +7,25 @@ module Lapidarius
       @args = args
       @io = io
       @gem = nil
-      @recursive = nil
     end
 
     def call(cmd_klass = Command)
       parser.parse!(@args)
       return @io.puts("specify gem name as: '-g gem_name'") unless @gem
       obj = Lapidarius::Cutter.new(@gem, cmd_klass).call
-      Lapidarius::Renderer::new(obj, @recursive).call(@io)
+      @io.puts Lapidarius::Tree::new(obj).out
     rescue Gem::NotInstalledError => e
       @io.puts e.message.sub("specified", "\e[1m#{@gem}\e[0m")
     end
 
     private def parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: ./bin/lapidarius --gem=sinatra --recursive"
+        opts.banner = "Usage: ./bin/lapidarius --gem=sinatra"
 
         opts.on("-gGEM", "--gem=GEM", "The gem name to scan") do |gem|
           @gem = gem
         end
 
-        opts.on("-r", "--recursive", "Print dependencies recursively") do |recursive|
-          @recursive = recursive
-        end
-
         opts.on("-h", "--help", "Prints this help") do
           @io.puts opts
           exit

data/lib/lapidarius/gem.rb

@@ -1,13 +1,18 @@
+require "forwardable"
+require "lapidarius/tree"
+
 module Lapidarius
   class Gem
+    extend Forwardable
+
+    def_delegators :@deps, :size, :each_with_index
+
     class KindError < ArgumentError; end
     class NotInstalledError < ArgumentError; end
 
-    LEVEL_DEPTH = 5
-
     def self.factory(token)
       token.match(/^No gems found matching/) do |m|
-        fail NotInstalledError, "no version of specified gem is installed!"
+        fail NotInstalledError, "no version of specified gem installed"
       end
       token.match(/Gem ([a-zA-Z0-9\-_]+)-(.+)/) do |m|
         return new(name: m[1], version: m[2])
@@ -35,22 +40,11 @@ module Lapidarius
       gem.name == name && gem.version == version
     end
 
-    def to_s(recursive: false)
-      return fullname unless recursive
-      fullname.tap do |s|
-        deps.each do |dep|
-          s << "\n"
-          s << indentation
-          s << dep.to_s(recursive: recursive)
-        end
-      end
-    end
-
-    def fullname
+    def to_s
       "#{name} (#{version})"
     end
 
-    def deep_count
+    def count
       flatten_deps.size
     end
 
@@ -63,10 +57,6 @@ module Lapidarius
       end
     end
 
-    private def indentation
-      " " * (caller.size / LEVEL_DEPTH)
-    end
-
     private def gem?(gem)
       %i{name version deps}.all? { |msg| gem.respond_to?(msg) }
     end

data/lib/lapidarius/tree.rb

@@ -0,0 +1,39 @@
+require "ostruct"
+
+module Lapidarius
+  class Tree
+    CURVED = "└── "
+    EMPTY = "    "
+    NESTED = "├── "
+    STRAIGHT = "│   "
+
+    def initialize(gem)
+      @gem = gem
+      @out = []
+    end
+
+    def out
+      return @out unless @out.empty?
+      @out.tap do |out|
+        out << @gem
+        recurse
+        out << ""
+        out << "#{@gem.count} runtime dependencies"
+      end
+    end
+
+    private def recurse(gem = @gem, prefix = "")
+      last_index = gem.size - 1
+      gem.each_with_index do |dep, i|
+        pointer, preadd = branches(i == last_index)
+        @out << "#{prefix}#{pointer}#{dep}"
+        recurse(dep, "#{prefix}#{preadd}") if dep.size > 0
+      end
+    end
+    
+    private def branches(last)
+      return [CURVED, EMPTY] if last
+      [NESTED, STRAIGHT]
+    end
+  end
+end

data/lib/lapidarius/version.rb

@@ -1,3 +1,3 @@
 module Lapidarius
-  VERSION = "2.1.2"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lapidarius
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.1.0
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,7 +74,7 @@ files:
 - lib/lapidarius/command.rb
 - lib/lapidarius/cutter.rb
 - lib/lapidarius/gem.rb
-- lib/lapidarius/renderer.rb
+- lib/lapidarius/tree.rb
 - lib/lapidarius/ui.rb
 - lib/lapidarius/version.rb
 homepage: https://github.com/costajob/lapidarius

data/lib/lapidarius/renderer.rb

@@ -1,39 +0,0 @@
-module Lapidarius
-  class Renderer
-    class NoEntGemError< ArgumentError; end
-
-    def initialize(gem, recursive = false)
-      fail NoEntGemError, "gem not found on this system!" unless gem
-      @gem = gem
-      @recursive = recursive
-      @out = []
-    end
-
-    def call(io = STDOUT)
-      io.puts out
-    end
-
-    def out
-      collect_header
-      collect_body
-      @out
-    end
-
-    private def collect_header
-      @out << ("\n#{@gem.fullname}".ljust(29) << "\e[1m#{@gem.deep_count}\e[0m".rjust(3))
-      @out << hr
-    end
-
-    private def collect_body
-      return if @gem.deps.empty?
-      @gem.deps.each do |dep|
-        @out << dep.to_s(recursive: @recursive)
-      end
-      @out << "\n"
-    end
-
-    private def hr
-      "#{"-" * 30}\n"
-    end
-  end
-end