bundler-stats 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2759369de6f085751c3c523a46b935fe5a5d9ca6
-  data.tar.gz: 1889fbb9f46a05b076af3ce0522bcb32b811ac8f
+  metadata.gz: 650453abe6418815db38bb8315026008b6282a2e
+  data.tar.gz: e0c227cb7275fe768990d93289880ddcf8474733
 SHA512:
-  metadata.gz: b500aed73652a0c28d8fc6558d96a37ebcf6b1c5df86b7ae5e7b335acd6326d122c7e101f99f46ae3e7c5954c10406bd0ad579a07a3c7e60093c6b701be3ac08
-  data.tar.gz: af29e97ae66a15ac098558f834d505e34286267be9ba9acf3650da791135a13b036b1c5cc1b69ade3c9d9e0d8a312a061f22736473070c31e5df0efca9f80d3b
+  metadata.gz: f3b6a623d44ea2ccdd2abc04baf6fc9867ff08f9d47349238fe2491f8167c4cc9223752bb4a0a811dfcda412710f201392ea586a81f27410e9b919bf248b0320
+  data.tar.gz: 17293fae4fb428291ef79c7a37183ae865a24a3f65e63fca364e01cb6f2f89af29825cb9f7e897ac9ddb1cd09dc0c55cc7b1660cb1e1fdb540fe5e08b9d0b87c

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+Changelog
+=============
+
+## [1.1.0] - 2018-03-15
+### Added
+
+- Adds a way to view dependency version restrictions for a given gem, by @olivierlacan
+
+## [1.0.0] - 2016-04-13
+### Added
+
+- Base library, woo!
+- List all transitive dependencies and how many other deps rely on them
+- View list of Github-specified dependencies
+- Traverses from your current location to the Gemfile
+- JSON and table outputters

data/README.md

@@ -1,21 +1,25 @@
 Bundler Stats
 =============
 
-You remember that time someone yanked their library and the entire Node
-universe fell apart? Yeah, me too. And all the thinkpieces that came out just
-aftward were right: you should be careful about what you include in your
-project.
+You remember that time [someone yanked their library](http://blog.npmjs.org/post/141577284765/kik-left-pad-and-npm)
+and the entire Node universe fell apart? Yeah, me too. And all the
+[thinkpieces](http://www.haneycodes.net/npm-left-pad-have-we-forgotten-how-to-program/)
+that came out just afterward were right: you should be careful about
+what dependencies you include in your project.
 
-This project gives you some tools you can use with your existing Gemfile to
-determine which gems are including long trees of data, and which you can
-potentially remove.
+This project gives you some tools you can use with an existing Gemfile to
+determine which gems are including long trees of their own dependencies,
+and which you can potentially remove.
+
+This is an exploratory tool, and I'd be interested to hear what other criteria
+would be useful in determining what tools to remove.
 
 Installation
 ------------
 
 You don't need to include `bundler-stats` in your Gemfile, just
 `gem install bundler-stats`. Unless you wanted to build automation around its
-usage, in which case, add it to your Gemfile instead. 
+usage, in which case, add it to your Gemfile instead.
 
 
 Usage
@@ -23,14 +27,86 @@ Usage
 
     > bundle-stats help
       Commands:
-        bundle-stats help [COMMAND]  # Describe available commands or one specific command
-        bundle-stats show TARGET     # Prints the dependency tree for a single gem in your Gemfile
-        bundle-stats stats           # Displays basic stats about the gems in your Gemfile
-        bundle-stats version         # Prints the bundler-stats version
-
-Or just run `bundle-stats` anywhere within your ruby project. You can emit JSON
-for automatic consumption with `-f json`.
-
+        bundle-stats help [COMMAND]   # Describe available commands or one specific command
+        bundle-stats show TARGET      # Prints the dependency tree for a single gem in your Gemfile
+        bundle-stats stats            # Displays basic stats about the gems in your Gemfile
+        bundle-stats version          # Prints the bundler-stats version
+        bundle-stats versions TARGET  # Shows versions requirements for target in other dependencies
+
+The most obvious thing to do is run the command by itself, which should help identify problem areas:
+
+    > bundle-stats
+
+    +------------------------------|-----------------|-----------------+
+    | Name                         | Total Deps      | 1st Level Deps  |
+    +------------------------------|-----------------|-----------------+
+    ... omitted stuff here ...
+    | fog                          | 15              | 6               |
+    | fancybox2-rails              | 15              | 1               |
+    | quiet_assets                 | 15              | 1               |
+    | coffee-rails                 | 18              | 2               |
+    | angular-rails-templates      | 19              | 3               |
+    | devise                       | 19              | 6               |
+    | rspec-rails                  | 20              | 7               |
+    | sass-rails                   | 21              | 4               |
+    | foundation-icons-sass-rails  | 22              | 2               |
+    | rails                        | 29              | 9               |
+    | angular_rails_csrf           | 30              | 1               |
+    | ngannotate-rails             | 31              | 2               |
+    | activeadmin                  | 48              | 12              |
+    +------------------------------|-----------------|-----------------+
+
+    Declared Gems:     35
+    Total Gems:        113
+
+    Unpinned Versions: 30
+    Github Refs:       1
+
+It looks like activeadmin is a huge problem. Use `show` to investigate:
+
+    > bundle-stats show activeadmin
+    bundle-stats for activeadmin
+
+    depended upon by (0) |
+    depends on (48)      | arbre, bourbon, coffee-rails, formtastic, formtastic_i18n, inherited_resources, jquery-rails, jquery-ui-rails, kaminari, rails, ransack, sass-rails, activesupport, i18n, json, minitest, thread_safe, tzinfo, sass, thor, coffee-script, railties, coffee-script-source, execjs, actionpack, rake, actionview, rack, rack-test, builder, erubis, has_scope, responders, actionmailer, activemodel, activerecord, bundler, sprockets-rails, mail, mime-types, treetop, polyglot, arel, sprockets, hike, multi_json, tilt, polyamorous
+    unique to this (12)   | arbre, bourbon, formtastic, formtastic_i18n, inherited_resources, jquery-rails, jquery-ui-rails, kaminari, ransack, has_scope, bundler, polyamorous
+
+Removing the dep will only actually remove 12 gems. The rest are shared dependencies with rails. We can also omit trees we aren't going to remove (hi rails) by not following them:
+
+    > bundle-stats show sass-rails --nofollow="railties,activesupport,actionpack"
+    bundle-stats for sass-rails
+
+    depended upon by (2) | activeadmin, foundation-icons-sass-rails
+    depends on (10)      | railties, sass, sprockets, sprockets-rails, hike, multi_json, rack, tilt, actionpack, activesupport
+    unique to this (0)   |
+
+To consume information with a build job or somesuch, all commands can emit JSON:
+
+    > bundle-stats show sass-rails --nofollow="railties,activesupport,actionpack" -f json
+    {
+      "name": "sass-rails",
+      "total_dependencies": 10,
+      "first_level_dependencies": 4,
+      "top_level_dependencies": {
+        "activeadmin": "activeadmin (1.0.0.pre)",
+        "foundation-icons-sass-rails": "foundation-icons-sass-rails (3.0.0)"
+      },
+      "transitive_dependencies": [
+        "railties (< 5.0, >= 4.0.0)",
+        "sass (~> 3.2.0)",
+        "sprockets (<= 2.11.0, ~> 2.8)",
+        "sprockets-rails (~> 2.0)",
+        "hike (~> 1.2)",
+        "multi_json (~> 1.0)",
+        "rack (~> 1.0)",
+        "tilt (!= 1.3.0, ~> 1.1)",
+        "actionpack (>= 3.0)",
+        "activesupport (>= 3.0)"
+      ],
+      "potential_removals": [
+
+      ]
+    }
 
 Contributing
 ------------
@@ -46,6 +122,7 @@ Credits
 Thanks to the many kind people at [RailsCamp East 2016](http://east.railscamp.com)
 for the help, the ideas, and the support.
 
+Thanks to Isaac Bowen for being pedantic about speeling.
 
 License
 -------

data/lib/bundler/stats/calculator.rb

@@ -29,6 +29,12 @@ module Bundler
         })
       end
 
+      def versions(target)
+        @tree.version_requirements(target).merge({
+          potential_removals: @remover.potential_removals(target)
+        })
+      end
+
       def stats
         { summary: summary,
           gems: gem_stats

data/lib/bundler/stats/cli.rb

@@ -38,6 +38,20 @@ module Bundler
         end
       end
 
+      desc 'versions TARGET', 'Shows versions requirements for target in other dependencies'
+      method_option :format, aliases: "-f", description: "Output format, either JSON or text"
+      method_option :nofollow, description: "A comma delimited list of dependencies not to follow."
+      def versions(target)
+        calculator = build_calculator(options)
+        stats = calculator.versions(target)
+
+        if options[:format] =~ /json/i
+          say JSON.pretty_generate(stats)
+        else
+          draw_versions(stats, target)
+        end
+      end
+
       desc 'version', 'Prints the bundler-stats version'
       def version
         say "bundler-stats #{VERSION}"
@@ -70,6 +84,20 @@ module Bundler
         say ""
       end
 
+      def draw_versions(stats, target)
+        say "bundle-stats for #{target}"
+        say ""
+        say "depended upon by (#{stats[:top_level_dependencies].count}):\n"
+        say "+------------------------------|-------------------+"
+        say "| Name                         | Required Version  |"
+        say "+------------------------------|-------------------+"
+        stats[:top_level_dependencies].each do |stat_line|
+          say "| %-28s | %-17s |" % [stat_line[:name], stat_line[:version]]
+        end
+        say "+------------------------------|-------------------+"
+        say ""
+      end
+
       def build_calculator(options)
         if !options[:nofollow].nil?
           skiplist = options[:nofollow].gsub(/\s+/, '').split(",")

data/lib/bundler/stats/tree.rb

@@ -21,6 +21,16 @@ class Bundler::Stats::Tree
     }
   end
 
+  def version_requirements(target)
+    transitive_dependencies = transitive_dependencies(target)
+    { name: target,
+      total_dependencies: transitive_dependencies.count,
+      first_level_dependencies: first_level_dependencies(target).count,
+      top_level_dependencies: reverse_dependencies_with_versions(target),
+      transitive_dependencies: transitive_dependencies,
+    }
+  end
+
   def first_level_dependencies(target)
     raise ArgumentError, "Unknown gem #{target}" unless @tree.has_key? target
     @tree[target].dependencies
@@ -50,6 +60,24 @@ class Bundler::Stats::Tree
     end
   end
 
+  def reverse_dependencies_with_versions(target)
+    @tree.map do |name, dep|
+      transitive_dependencies(name).map do |transitive_dependency|
+        if transitive_dependency.name == target
+          {
+            name: dep.name,
+            version: transitive_dependency.requirement.to_s,
+            requirement: transitive_dependency.requirement
+          }
+        else
+          nil
+        end
+      end
+    end.flatten.compact.sort do |a,b|
+      a[:requirement].as_list <=> b[:requirement].as_list
+    end
+  end
+
   private
 
   def specs_as_tree(specs)

data/lib/bundler/stats/version.rb

@@ -1,6 +1,6 @@
 module Bundler
   module Stats
     # bundler-stats version
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/spec/lib/bundler/stats/calculator_spec.rb

@@ -100,4 +100,22 @@ describe Bundler::Stats::Calculator do
       expect(target).to include(:github)
     end
   end
+
+  context "#versions" do
+    it "is a hash" do
+      calculator = subject.new(gemfile_path, lockfile_path)
+      versions = calculator.versions("depth-one")
+
+      expect(versions).to be_a(Hash)
+      expect(versions[:top_level_dependencies]).to eq([])
+    end
+
+    it "returns for second-level deps" do
+      calculator = subject.new(gemfile_path, lockfile_path)
+      versions = calculator.versions("depth-two")
+
+      expect(versions).to be_a(Hash)
+      expect(versions[:top_level_dependencies].map(&:name)).to include("depth-one")
+    end
+  end
 end

data/spec/lib/bundler/stats/tree_spec.rb

@@ -124,6 +124,16 @@ describe Bundler::Stats::Tree do
     end
   end
 
+  context "#version_requirements" do
+    it "is a hash with some keys" do
+      tree = subject.new(parser)
+
+      target = tree.version_requirements("depth-one")
+
+      expect(target).to be_a(Hash)
+    end
+  end
+
   context "skip lists" do
     it "still includes the skipped entry" do
       tree = subject.new(parser, skiplist: ["depth-three"])

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: bundler-stats
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 description: Looks through your lockfile and tries to identify problematic use of
@@ -87,10 +87,12 @@ executables:
 - bundle-stats
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - README.md
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -119,17 +121,17 @@ 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.0.14
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Dependency investigation for Bundler