lapidarius 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c2f5e0adba9a26b9c587019623572558703d340
+  data.tar.gz: 57c04cf09af054ce51b002eace5c90ee4a77000b
+SHA512:
+  metadata.gz: 4321b2c5a80c88fd794683dc3a9a4905beda4e9fcc655c0cd6fa1445fb023456bdb22d38d8f4e68a5c8e9fcf406ceefa248c0923355eefff708dc69f50577852
+  data.tar.gz: 45033c48b91c70b94e6c60af650084e0a38945aae9942e7d8ef8ab0962924f9c08b8bf9ebc5f55aa6cf0f39e82c9e77824595d500c04bb66500c281ba7017253

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.1
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem_dependencies.gemspec
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+## Table of Contents
+
+* [Scope](#scope)
+  * [Alternatives](#alternatives)
+    * [gem dep](#gem-dep)
+    * [bundle viz](#bundle-viz)
+* [Usage](#usage)
+  * [Unique dependencies](#unique-dependencies)
+  * [Recursive print](#recursive-print)
+  * [Warning](#warning)
+
+## Scope
+This gem is aimed to list recursively the **runtime dependencies** footprint of the specified gem.
+
+### Alternatives
+Some alternatives exists: 
+
+#### gem dep
+The standard *gem dep* command just unearth one level of dependencies.
+
+#### bundle viz
+The *bundle viz* command relies on the Gemfile and the [graphviz](http://www.graphviz.org/) library to generate a visual representation of the gem inter-dependencies.  
+While it is great to visualize inter-dependencies, i have hard times figuring out gem's  runtime footprint.
+
+## Usage
+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.
+
+### Unique dependencies
+The command outcome includes all of the unique (by name) nested runtime dependencies:
+```
+$ ./bin/lapidarius --gem=grape
+
+grape (0.17.0)              20
+------------------------------
+activesupport (>= 0)
+builder (>= 0)
+hashie (>= 2.1.0)
+multi_json (>= 1.3.2)
+multi_xml (>= 0.5.2)
+mustermann19 (~> 0.4.3)
+rack (>= 1.3.0)
+rack-accept (>= 0)
+virtus (>= 1.0.0)
+concurrent-ruby (>= 1.0.2, ~> 1.0)
+i18n (~> 0.7)
+minitest (~> 5.1)
+tzinfo (~> 1.1)
+thread_safe (~> 0.1)
+enumerable-lazy (>= 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:  
+```
+$ ./bin/lapidarius --gem=sinatra --recursive
+
+sinatra (1.4.7)              3
+------------------------------
+rack (~> 1.5)
+rack-protection (~> 1.4)
+  rack (>= 0)
+tilt (< 3, >= 1.3)
+
+```
+
+### Warning
+Consider only the gems installed on your system are scanned for their own dependencies, no remote fetching is performed.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lapidarius"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/lapidarius

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "lapidarius"
+
+Lapidarius::CLI.new(ARGV.clone).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lapidarius.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lapidarius/version"
+
+Gem::Specification.new do |s|
+  s.name = "lapidarius"
+  s.version = Lapidarius::VERSION
+  s.authors = ["costajob"]
+  s.email = ["costajob@gmail.com"]
+  s.homepage = "https://github.com/costajob/lapidarius"
+  s.summary = "A tiny library to visualize and count gem dependencies recursively"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.1.8"
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.12"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/lapidarius.rb

@@ -0,0 +1,5 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "lapidarius/version"
+require "lapidarius/cli"

data/lib/lapidarius/cli.rb

@@ -0,0 +1,51 @@
+require "optparse"
+require "lapidarius/cutter"
+require "lapidarius/renderer"
+
+module Lapidarius
+  class CLI
+    class NoGemError < ArgumentError; end
+
+    def initialize(args, io = STDOUT)
+      @args = args
+      @io = io
+      @gem = nil
+      @recursive = nil
+    end
+
+    def call(cmd_klass = Command)
+      parser.parse!(@args)
+      fail NoGemError, "please specify the name of an installed gem!" unless @gem
+      gem = cutter(cmd_klass).call
+      renderer(gem).call(@io)
+    end
+
+    private def parser
+      OptionParser.new do |opts|
+        opts.banner = "Usage: ./bin/lapidarius --gem=sinatra --recursive"
+
+        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
+        end
+      end
+    end
+
+    private def cutter(cmd_klass)
+      @cutter = Lapidarius::Cutter.new(gem: @gem, cmd_klass: cmd_klass)
+    end
+
+    private def renderer(gem)
+      Lapidarius::Renderer::new(gem: gem, recursive: @recursive)
+    end
+  end
+end
+

data/lib/lapidarius/command.rb

@@ -0,0 +1,18 @@
+require "rubygems/commands/dependency_command"
+require "lapidarius/ui"
+
+module Lapidarius
+  class Command
+    def initialize(dep_klass: ::Gem::Commands::DependencyCommand, ui_klass: UI)
+      @dep = dep_klass.new
+      @dep.ui = ui_klass.new
+    end
+
+    def call(gem)
+      @dep.ui.clear!
+      @dep.invoke(gem)
+      @dep.ui.out
+    end
+  end
+end
+

data/lib/lapidarius/cutter.rb

@@ -0,0 +1,38 @@
+require "lapidarius/gem"
+require "lapidarius/command"
+
+module Lapidarius
+  class Cutter
+    DEVELOPMENT = "development"
+
+    def initialize(gem:, cmd_klass: Command)
+      @gem = gem
+      @cmd = cmd_klass.new
+    end
+
+    def call(src = cmd, gem = nil)
+      tokens = tokenize(src)
+      token = tokens.shift
+      gem ||= Gem.factory(token)
+      tokens.each do |t|
+        dep = Gem.factory(t)
+        next unless dep
+        gem << dep
+        call(cmd(dep.name), dep)
+      end
+      gem
+    end
+
+    private def tokenize(src)
+      src = src.split(/\n\n/).first
+      src.split("\n").tap do |tokens|
+        tokens.map!(&:strip)
+        tokens.reject! { |token| token.match(/#{DEVELOPMENT}/) }
+      end
+    end
+
+    private def cmd(gem = @gem)
+      @cmd.call(gem)
+    end
+  end
+end

data/lib/lapidarius/gem.rb

@@ -0,0 +1,70 @@
+module Lapidarius
+  class Gem
+    class KindError < ArgumentError; end
+
+    LEVEL_DEPTH = 5
+
+    def self.factory(name)
+      name.match(/Gem ([a-z0-9\-_]+)-(\d{1,2}\.\d{1,3}\.\d{1,2})/) do |m|
+        return new(name: m[1], version: m[2])
+      end
+      name.match(/([a-z0-9\-_]+) \(([0-9~<>=, \.]+)\)/) do |m|
+        return new(name: m[1], version: m[2])
+      end
+    end
+
+    attr_reader :name, :version, :deps
+
+    def initialize(name:, version:, deps: [])
+      @name = name
+      @version = version
+      @deps = deps
+    end
+
+    def <<(dep)
+      fail KindError, "#{dep.inspect} is not a valid gem" unless gem?(dep)
+      @deps << dep
+    end
+
+    def ==(gem)
+      return false unless gem?(gem)
+      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
+      "#{name} (#{version})"
+    end
+
+    def deep_count
+      flatten_deps.size
+    end
+
+    protected def flatten_deps
+      deps.reduce(deps) do |acc, dep|
+        acc.concat dep.flatten_deps
+      end.tap do |deps|
+        deps.flatten!
+        deps.uniq!(&:name)
+      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
+  end
+end

data/lib/lapidarius/renderer.rb

@@ -0,0 +1,39 @@
+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
+      header
+      body
+      @out
+    end
+
+    private def header
+      @out << ("\n#{@gem.fullname}".ljust(28) << "#{@gem.deep_count}".rjust(3))
+      @out << hr
+    end
+
+    private def 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

data/lib/lapidarius/ui.rb

@@ -0,0 +1,24 @@
+require "stringio"
+
+module Lapidarius
+  class UI
+    def initialize
+      @io = StringIO.new
+    end
+
+    def say(statement)
+      @io.puts statement
+    end
+
+    def out
+      @io.string.strip
+    end
+
+    def clear!
+      @io.reopen("")
+    end
+
+    def terminate_interaction(code = 0)
+    end
+  end
+end

data/lib/lapidarius/version.rb

@@ -0,0 +1,3 @@
+module Lapidarius
+  VERSION = "1.0.0"
+end

data/tags

@@ -0,0 +1,33 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+<<	./lib/lapidarius/gem.rb	/^    def <<(dep)$/;"	f	class:Lapidarius
+==	./lib/lapidarius/gem.rb	/^    def ==(gem)$/;"	f	class:Lapidarius
+Cutter	./lib/lapidarius/cutter.rb	/^  class Cutter$/;"	c	class:Lapidarius
+Cutter	./spec/mocks.rb	/^  class Cutter$/;"	c	class:Lapidarius
+Env	./lib/lapidarius/env.rb	/^  module Env$/;"	m	class:Lapidarius
+Gem	./lib/lapidarius/gem.rb	/^  class Gem$/;"	c	class:Lapidarius
+KindError	./lib/lapidarius/gem.rb	/^    class KindError < ArgumentError; end$/;"	c	class:Lapidarius.Gem
+Lapidarius	./lib/lapidarius/cutter.rb	/^module Lapidarius$/;"	m
+Lapidarius	./lib/lapidarius/env.rb	/^module Lapidarius$/;"	m
+Lapidarius	./lib/lapidarius/gem.rb	/^module Lapidarius$/;"	m
+Lapidarius	./lib/lapidarius/renderer.rb	/^module Lapidarius$/;"	m
+Lapidarius	./lib/lapidarius/version.rb	/^module Lapidarius$/;"	m
+Lapidarius	./spec/mocks.rb	/^module Lapidarius$/;"	m
+NoEntGemError	./lib/lapidarius/renderer.rb	/^    class NoEntGemError< ArgumentError; end$/;"	c	class:Lapidarius.Renderer
+Renderer	./lib/lapidarius/renderer.rb	/^  class Renderer$/;"	c	class:Lapidarius
+call	./lib/lapidarius/cutter.rb	/^    def call(src = cmd, gem = nil)$/;"	f	class:Lapidarius.Cutter
+call	./lib/lapidarius/renderer.rb	/^    def call(io = STDOUT)$/;"	f	class:Lapidarius.Renderer
+cmd	./spec/mocks.rb	/^    def cmd(gem = @gem)$/;"	f	class:Lapidarius.Cutter
+deps	./lib/lapidarius/gem.rb	/^    def deps(env = :all)$/;"	f	class:Lapidarius
+development?	./lib/lapidarius/gem.rb	/^    def development?$/;"	f
+factory	./lib/lapidarius/gem.rb	/^    def self.factory(name)$/;"	F	class:Lapidarius.Gem
+initialize	./lib/lapidarius/cutter.rb	/^    def initialize(gem:, include_dev: false)$/;"	f	class:Lapidarius.Cutter
+initialize	./lib/lapidarius/gem.rb	/^    def initialize(name:, version:, env: Env::RUNTIME, deps: [])$/;"	f	class:Lapidarius
+initialize	./lib/lapidarius/renderer.rb	/^    def initialize(gem)$/;"	f	class:Lapidarius.Renderer
+out	./lib/lapidarius/renderer.rb	/^    def out$/;"	f	class:Lapidarius.Renderer
+runtime?	./lib/lapidarius/gem.rb	/^    def runtime?$/;"	f
+to_s	./lib/lapidarius/gem.rb	/^    def to_s$/;"	f	class:Lapidarius

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: lapidarius
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- costajob
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- costajob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/lapidarius
+- bin/setup
+- lapidarius.gemspec
+- lib/lapidarius.rb
+- lib/lapidarius/cli.rb
+- lib/lapidarius/command.rb
+- lib/lapidarius/cutter.rb
+- lib/lapidarius/gem.rb
+- lib/lapidarius/renderer.rb
+- lib/lapidarius/ui.rb
+- lib/lapidarius/version.rb
+- tags
+homepage: https://github.com/costajob/lapidarius
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A tiny library to visualize and count gem dependencies recursively
+test_files: []