bundler-dependency_graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c475e34f8059c0ad08d811041f2530b17a30e488
+  data.tar.gz: 00e106e8f36fa38b464eea212d1d497e9554ab15
+SHA512:
+  metadata.gz: a7a71c073cf97f6ef282c92595db67193d2efb142e22230521a80226b186d84ae1c996fe0967ca87d87153665c0d06d07341a13f64aa20ab4e8193d0880098a3
+  data.tar.gz: 1fc4c2df009eb97a59d25d7d312a317053a1b3cf46e29ae79c12679f5bae759a05a447a5d0ed3f057ae1f31c01cc5e2ebd93156417968ad2706e640af95c452b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kerrizor@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kerri Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Bundler::DependencyGraph
+
+A bundler plugin that generates a visual representation of your gem dependencies.
+
+## Installation
+
+
+  $ bundle plugin install bundler-dependency_graph --git "https://github.com/kerrizor/bundler-dependency_graph"
+
+## Usage
+
+  $ bundle graph
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bundler-dependency_graph. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundler/dependency_graph"
+
+# 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/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/bundler-dependency_graph.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bundler/dependency_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bundler-dependency_graph"
+  spec.version       = Bundler::DependencyGraph::VERSION
+  spec.authors       = ["Kerri Miller", "Whitney-Rose Levis"]
+  spec.email         = ["kerrizor@kerrizor.com", "whitney@nird.us"]
+
+  spec.summary       = %q{Generate a visual representation of your gem dependencies.}
+  spec.description   = %q{A bundler plugin that generates a visual representation of your gem dependencies.}
+  spec.homepage      = "https://github.com/kerrizor/bundler-dependency_graph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/bundler/dependency_graph.rb

@@ -0,0 +1,3 @@
+require "bundler/dependency_graph/version"
+require "bundler/dependency_graph/graph_builder"
+require "bundler/dependency_graph/graph"

data/lib/bundler/dependency_graph/graph.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+require "set"
+module Bundler
+  module DependencyGraph
+    class Graph
+      GRAPH_NAME = :Gemfile
+
+      def initialize(env, output_file, show_version = false, show_requirements = false, output_format = "png", without = [])
+        @env               = env
+        @output_file       = output_file
+        @show_version      = show_version
+        @show_requirements = show_requirements
+        @output_format     = output_format
+        @without_groups    = without.map(&:to_sym)
+
+        @groups            = []
+        @relations         = Hash.new {|h, k| h[k] = Set.new }
+        @node_options      = {}
+        @edge_options      = {}
+
+        _populate_relations
+      end
+
+      attr_reader :groups, :relations, :node_options, :edge_options, :output_file, :output_format
+
+      def viz
+        GraphVizClient.new(self).run
+      end
+
+    private
+
+      def _populate_relations
+        parent_dependencies = _groups.values.to_set.flatten
+        loop do
+          break if parent_dependencies.empty?
+
+          tmp = Set.new
+          parent_dependencies.each do |dependency|
+            child_dependencies = spec_for_dependency(dependency).runtime_dependencies.to_set
+            @relations[dependency.name] += child_dependencies.map(&:name).to_set
+            tmp += child_dependencies
+
+            @node_options[dependency.name] = _make_label(dependency, :node)
+            child_dependencies.each do |c_dependency|
+              @edge_options["#{dependency.name}_#{c_dependency.name}"] = _make_label(c_dependency, :edge)
+            end
+          end
+          parent_dependencies = tmp
+        end
+      end
+
+      def _groups
+        relations = Hash.new {|h, k| h[k] = Set.new }
+        @env.current_dependencies.each do |dependency|
+          dependency.groups.each do |group|
+            next if @without_groups.include?(group)
+
+            relations[group.to_s].add(dependency)
+            @relations[group.to_s].add(dependency.name)
+
+            @node_options[group.to_s] ||= _make_label(group, :node)
+            @edge_options["#{group}_#{dependency.name}"] = _make_label(dependency, :edge)
+          end
+        end
+        @groups = relations.keys
+        relations
+      end
+
+      def _make_label(symbol_or_string_or_dependency, element_type)
+        case element_type.to_sym
+        when :node
+          if symbol_or_string_or_dependency.is_a?(Gem::Dependency)
+            label = symbol_or_string_or_dependency.name.dup
+            label << "\n#{spec_for_dependency(symbol_or_string_or_dependency).version}" if @show_version
+          else
+            label = symbol_or_string_or_dependency.to_s
+          end
+        when :edge
+          label = nil
+          if symbol_or_string_or_dependency.respond_to?(:requirements_list) && @show_requirements
+            tmp = symbol_or_string_or_dependency.requirements_list.join(", ")
+            label = tmp if tmp != ">= 0"
+          end
+        else
+          raise ArgumentError, "2nd argument is invalid"
+        end
+        label.nil? ? {} : { :label => label }
+      end
+
+      def spec_for_dependency(dependency)
+        @env.requested_specs.find {|s| s.name == dependency.name }
+      end
+
+      class GraphVizClient
+        def initialize(graph_instance)
+          @graph_name    = graph_instance.class::GRAPH_NAME
+          @groups        = graph_instance.groups
+          @relations     = graph_instance.relations
+          @node_options  = graph_instance.node_options
+          @edge_options  = graph_instance.edge_options
+          @output_file   = graph_instance.output_file
+          @output_format = graph_instance.output_format
+        end
+
+        def g
+          @g ||= ::GraphViz.digraph(@graph_name, :concentrate => true, :normalize => true, :nodesep => 0.55) do |g|
+            g.edge[:weight]   = 2
+            g.edge[:fontname] = g.node[:fontname] = "Arial, Helvetica, SansSerif"
+            g.edge[:fontsize] = 12
+          end
+        end
+
+        def run
+          @groups.each do |group|
+            g.add_nodes(
+              group, {
+                :style     => "filled",
+                :fillcolor => "#B9B9D5",
+                :shape     => "box3d",
+                :fontsize  => 16
+              }.merge(@node_options[group])
+            )
+          end
+
+          @relations.each do |parent, children|
+            children.each do |child|
+              if @groups.include?(parent)
+                g.add_nodes(child, { :style => "filled", :fillcolor => "#B9B9D5" }.merge(@node_options[child]))
+                g.add_edges(parent, child, { :constraint => false }.merge(@edge_options["#{parent}_#{child}"]))
+              else
+                g.add_nodes(child, @node_options[child])
+                g.add_edges(parent, child, @edge_options["#{parent}_#{child}"])
+              end
+            end
+          end
+
+          if @output_format.to_s == "debug"
+            $stdout.puts g.output :none => String
+            Bundler.ui.info "debugging bundle viz..."
+          else
+            begin
+              g.output @output_format.to_sym => "#{@output_file}.#{@output_format}"
+              Bundler.ui.info "#{@output_file}.#{@output_format}"
+            rescue ArgumentError => e
+              $stderr.puts "Unsupported output format. See Ruby-Graphviz/lib/graphviz/constants.rb"
+              raise e
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bundler/dependency_graph/graph_builder.rb

@@ -0,0 +1,38 @@
+module Bundler
+  module DependencyGraph
+    class GraphBuilder
+      Bundler::Plugin::API.command "graph", self
+
+      def exec(command, args)
+        puts "Currently unimplented; use `bundle viz` to generate your graphs for now."
+
+        require "graphviz"
+
+        # Temporarily assign default values to incoming args. In Bundler, these
+        #   are handled by Thor, but we're not entirely sure how the
+        #   Bundler::Plugin::API passes them (or doesn't) to plugins
+
+        options = {}
+        options[:file]         = "gem_graph"
+        options[:format]       = "png"
+        options[:requirements] = false
+        options[:version]      = false
+        options[:without]      = []
+
+        options[:without] = options[:without].join(":").tr(" ", ":").split(":")
+        output_file = File.expand_path(options[:file])
+
+        graph = Graph.new(Bundler.load, output_file, options[:version], options[:requirements], options[:format], options[:without])
+        graph.viz
+      rescue LoadError => e
+        Bundler.ui.error e.inspect
+        Bundler.ui.warn "Make sure you have the graphviz ruby gem. You can install it with:"
+        Bundler.ui.warn "`gem install ruby-graphviz`"
+      rescue StandardError => e
+        raise unless e.message =~ /GraphViz not installed or dot not in PATH/
+        Bundler.ui.error e.message
+        Bundler.ui.warn "Please install GraphViz. On a Mac with Homebrew, you can run `brew install graphviz`."
+      end
+    end
+  end
+end

data/lib/bundler/dependency_graph/version.rb

@@ -0,0 +1,5 @@
+module Bundler
+  module DependencyGraph
+    VERSION = "0.1.0"
+  end
+end

data/plugins.rb

@@ -0,0 +1 @@
+require "bundler/dependency_graph"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: bundler-dependency_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kerri Miller
+- Whitney-Rose Levis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: A bundler plugin that generates a visual representation of your gem dependencies.
+email:
+- kerrizor@kerrizor.com
+- whitney@nird.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundler-dependency_graph.gemspec
+- lib/bundler/dependency_graph.rb
+- lib/bundler/dependency_graph/graph.rb
+- lib/bundler/dependency_graph/graph_builder.rb
+- lib/bundler/dependency_graph/version.rb
+- plugins.rb
+homepage: https://github.com/kerrizor/bundler-dependency_graph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Generate a visual representation of your gem dependencies.
+test_files: []