bundler-why 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac50c4e539f7928944ee960faba8a98ceb9eb3f5ca06135efd684f385e81b420
+  data.tar.gz: b93ed4b008830ff44fc8138568cf6ec33fe345164eb93e1c765ecfdea6a47553
+SHA512:
+  metadata.gz: 6146c6debba323e2325ff5000a99e15dc3434669bfab9a83354928e7cfdf15bc9be50847bda681a3158e73b99d26047b944af78bc71019ce77b7fbe8e1b8377d
+  data.tar.gz: 0561dc31c1f1567c1d806045471f827ff08a55c40d404dc263cc09116e5aef51d38ee9c970817bd18101ba83bb7632b8ad3c77f53e5b3b831c36545804e51659

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+This project does not accept contributions at this time.
+
+These notes are for my own reference.
+
+## Local development
+
+The "Running your plugin locally" section of the 
+[How to write a Bundler plugin][1] instructions seems to be wrong, per 
+https://github.com/rubygems/rubygems/issues/3209#issuecomment-652107633
+
+However, `--git` seems to work. So, I open two tabs, one in the bundler-why
+directory, the second in some project `banana` with a meaningful gemfile.
+
+To test a change, in the first tab I make a WIP commit then in the second tab I
+
+```
+rm -rf /Users/jared/git/banana/.bundle/plugin
+bundler plugin install bundler-why \
+  --git file:///Users/jared/git/bundler-why \
+  --verbose --retry=1
+bundle why tzinfo
+```
+
+Deleting the `plugin` directory is a workaround for the fact that [bundler
+does not provide a command to uninstall plugins][2].
+
+[1]: https://bundler.io/v2.0/guides/bundler_plugins.html
+[2]: https://github.com/rubygems/rubygems/issues/3187

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bundler-why.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.md

@@ -0,0 +1,65 @@
+Do No Harm License
+
+**Preamble**
+
+Most software today is developed with little to no thought of how it will be used, or the consequences for our society and planet.
+
+As software developers, we engineer the infrastructure of the 21st century. We recognise that our infrastructure has great power to shape the world and the lives of those we share it with, and we choose to consciously take responsibility for the social and environmental impacts of what we build.
+
+We envisage a world free from injustice, inequality, and the reckless destruction of lives and our planet. We reject slavery in all its forms, whether by force, indebtedness, or by algorithms that hack human vulnerabilities. We seek a world where humankind is at peace with our neighbours, nature, and ourselves. We want our work to enrich the physical, mental and spiritual wellbeing of all society.
+
+We build software to further this vision of a just world, or at the very least, to not put that vision further from reach.
+
+**Terms**
+
+*Copyright* (c) *(year)* *(owner)*. All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+4. This software must not be used by any organisation, website, product or service that:
+
+   a) lobbies for, promotes, or derives a majority of income from actions that support or contribute to:
+      * sex trafficking
+      * human trafficking
+      * slavery
+      * indentured servitude
+      * gambling
+      * tobacco
+      * adversely addictive behaviours
+      * nuclear energy
+      * warfare
+      * weapons manufacturing
+      * war crimes
+      * violence (except when required to protect public safety)
+      * burning of forests
+      * deforestation
+      * hate speech or discrimination based on age, gender, gender identity, race, sexuality, religion, nationality
+
+   b) lobbies against, or derives a majority of income from actions that discourage or frustrate:
+      * peace
+      * access to the rights set out in the Universal Declaration of Human Rights and the Convention on the Rights of the Child
+      * peaceful assembly and association (including worker associations)
+      * a safe environment or action to curtail the use of fossil fuels or prevent climate change
+      * democratic processes
+
+5. All redistribution of source code or binary form, including any modifications must be under these terms. You must inform recipients that the code is governed by these conditions, and how they can obtain a copy of this license. You may not attempt to alter the conditions of who may/may not use this software.
+
+We define:
+
+**Forests** to be 0.5 or more hectares of trees that were either planted more than 50 years ago or were not planted by humans or human made equipment.
+
+**Deforestation** to be the clearing, burning or destruction of 0.5 or more hectares of forests within a 1 year period.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+**Attribution**
+
+Do No Harm License [Contributor Covenant][homepage], (pre 1.0),
+available at https://github.com/raisely/NoHarm
+
+[homepage]: https://github.com/raisely/NoHarm

data/README.md

@@ -0,0 +1,46 @@
+# Bundler::Why
+
+Explains the presence of a dependency.
+
+```bash
+bundle why tzinfo
+ransack -> activesupport -> tzinfo
+rspec-rails -> activesupport -> tzinfo
+business_time -> tzinfo
+...
+```
+
+## License
+
+[Do No Harm License][LICENSE.md]
+
+By using this software you accept the terms of the license.
+
+## Installation
+
+```bash
+bundler plugin install bundler-why
+```
+
+## Usage
+
+Specify the name of one gem. There are no options.
+
+## Contributing
+
+This project does not accept contributions at this time.
+
+## Graphs are the coolest
+
+If you like [graphs][1], you'll enjoy knowing that Bundler uses a [directed
+acyclic graph][2] and `why` is printing all [directed paths][3] to the specified
+gem.
+
+## Inspired by
+
+[`yarn why`][4]
+
+[1]: https://en.wikipedia.org/wiki/Graph_(discrete_mathematics)
+[2]: https://en.wikipedia.org/wiki/Directed_acyclic_graph
+[3]: https://en.wikipedia.org/wiki/Path_(graph_theory)
+[4]: https://classic.yarnpkg.com/en/docs/cli/why

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundler/why"
+
+# 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(__FILE__)

data/bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+ruby -I test test/bundler/why_test.rb

data/bundler-why.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/bundler/why/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "bundler-why"
+  spec.licenses = ['Nonstandard']
+  spec.version = ::Bundler::Why.gem_version.to_s
+  spec.authors = ["Jared Beck"]
+  spec.email = ["jared@jaredbeck.com"]
+  spec.summary = 'Explains the presence of a dependency.'
+  spec.homepage = 'https://github.com/jaredbeck/bundler-why'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.
+      split("\x0").
+      reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/bundler/why.rb

@@ -0,0 +1,8 @@
+require "bundler/why/command"
+require "bundler/why/version"
+
+module Bundler
+  module Why
+    class Error < StandardError; end
+  end
+end

data/lib/bundler/why/command.rb

@@ -0,0 +1,75 @@
+require 'byebug'
+$stdout.sync = true
+
+module Bundler
+  module Why
+    class Command < ::Bundler::Plugin::API
+      command "why"
+
+      def exec(command, args)
+        if args.length == 1
+          why(args.first)
+        else
+          warn 'Usage: bundle why gemname'
+        end
+      end
+
+      private
+
+      # `Bundler.load` is a memoized method, so it's OK if we call it a few
+      # times.
+      # @return Bundler::Runtime
+      def runtime
+        Bundler.load
+      end
+
+      # @param spec_set Bundler::SpecSet
+      # @param gem_name String
+      # @return Bundler::StubSpecification
+      def find_one_spec_in_set(spec_set, gem_name)
+        specs = runtime.specs[gem_name]
+        if specs.length == 1
+          specs.first
+        else
+          raise Error, format(
+            'Expected gem name to match exactly 1 spec, got %d',
+            specs.length
+          )
+        end
+      end
+
+      # @param path Array[Bundler::StubSpecification]
+      # @void
+      def print_path(path)
+        puts path.map(&:name).join(' -> ')
+      end
+
+      # @param gem_name String
+      # @void
+      def why(gem_name)
+        spec_set = runtime.specs
+        spec = find_one_spec_in_set(spec_set, gem_name)
+        traverse(spec_set, spec)
+      end
+
+      # @param spec_set Bundler::SpecSet
+      # @param parent Bundler::StubSpecification
+      # @param path Array[Bundler::StubSpecification]
+      # @void
+      def traverse(spec_set, parent, path = [parent])
+        children = spec_set.select { |s|
+          s.dependencies.any? { |d|
+            d.type == :runtime && d.name == parent.name
+          }
+        }
+        if children.empty?
+          print_path(path)
+        else
+          children.each do |child|
+            traverse(spec_set, child, [child].concat(path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bundler/why/version.rb

@@ -0,0 +1,7 @@
+module Bundler
+  module Why
+    def self.gem_version
+      ::Gem::Version.new('0.1.0')
+    end
+  end
+end

data/plugins.rb

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: bundler-why
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jared@jaredbeck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- bin/console
+- bin/test
+- bundler-why.gemspec
+- lib/bundler/why.rb
+- lib/bundler/why/command.rb
+- lib/bundler/why/version.rb
+- plugins.rb
+homepage: https://github.com/jaredbeck/bundler-why
+licenses:
+- Nonstandard
+metadata:
+  homepage_uri: https://github.com/jaredbeck/bundler-why
+  source_code_uri: https://github.com/jaredbeck/bundler-why
+  changelog_uri: https://github.com/jaredbeck/bundler-why
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Explains the presence of a dependency.
+test_files: []