bundler-ri 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aaafcdd90268bda86bf7c039c956432ff4cebaf5ddef7fde68ed293cc57aada
-  data.tar.gz: c0eb7b1c3fed3995a9caf396374dbd743faf49dc7e6d957b68954b5fa4246e91
+  metadata.gz: e20850cc5c40c8956e3a50cf6c4aa297a60a98c01e7a060b6e013a7b4293df5f
+  data.tar.gz: 48c2c0765c72c5e3162894693ea86119ea4a188a54f0e7b7db6b6f51e06bfdf5
 SHA512:
-  metadata.gz: 9648c1197c8df7e39e06d5dbeea25aadf2d2798fec5c42378a0625dbf9d6c81dbcce42e8bdeb0543bf2924c7cbce894e9207df93fcb238b0626a12924a67d5f9
-  data.tar.gz: 0a735338428d972a131cc3c5b55f2795462f353d6d2ce1e64be65dd94f1901eee4392c04eb575b4607071406b6984bdfaef383313f2decb350aa78bc01695d1e
+  metadata.gz: 255138dc53a7524d3ed5c05ca2c8913947ad3409e63d6fa97e59a1e2037776990d3b110a158ce84fd780ecf658fecb0bd17c3211711bcf50b0c83066041065c6
+  data.tar.gz: ba116a44f8389a20d43b0258d98553c89b4500207425bfad18668964b9e9022dfaad6c0bf1a3b89bafc4c8f0b0883f7db8c70cdeed47b340c3e2c168255d7794

data/README.md

@@ -25,8 +25,7 @@ See: https://guides.rubygems.org/bundler_plugins/
 ### TODO
 
 * tests
-* don't regenerate docs we've already generated
-* transitive dependencies (some things like `rails` really rely on them)
+* handle rdoc finickiness
 
 ## Contributing
 

data/lib/bundler/ri.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "rdoc"
+require "digest/sha2"
 
 module Bundler
   class RI < Plugin::API
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
 
     def self.register
       Bundler::Plugin.add_command("ri", Command)
@@ -14,24 +15,16 @@ module Bundler
     end
 
     module Helpers
-      def ri_path
-        Bundler::Plugin.root.join("ri")
-      end
-
-      def ri_path_for(dep)
-        ri_path.join(resolved_name_for(dep))
+      def plugin_data_path
+        Bundler::Plugin.root.join("bundler-ri")
       end
 
-      def resolved_name_for(dep)
-        abs_path_for(dep).split("/").last
+      def ri_path
+        plugin_data_path.join("ri")
       end
 
-      def abs_path_for(dep)
-        if dep.source
-          Bundler.root.to_s
-        else
-          dep.to_spec.full_gem_path
-        end
+      def checksum_path
+        plugin_data_path.join("checksum")
       end
     end
 
@@ -41,7 +34,7 @@ module Bundler
       def exec(command, args)
         raise BundlerError.new("must run command 'ri' in root") unless SharedHelpers.in_bundle?
 
-        Bundler.definition.dependencies.map { ri_path_for(_1).to_s }.each do |p|
+        Dir.glob(ri_path.join("*")).select do |p|
           next unless File.directory?(p)
 
           args << "--doc-dir"
@@ -59,32 +52,76 @@ module Bundler
         @deps = deps
       end
 
+      def checksum_for(spec)
+        normalized_filenames = RDoc::RDoc.new.tap { _1.options = RDoc::Options.new }.gather_files([spec.full_gem_path])
+        content = normalized_filenames.map { |f| File.read(f) }.join("\n")
+        ::Digest::SHA256.hexdigest(content)
+      end
+
+      def checksum_path_for(spec)
+        checksum_path.join(slug(spec))
+      end
+
+      def slug(spec)
+        "#{spec.name}-#{spec.version}"
+      end
+
       def run
-        puts "bundler-ri: installing ri docs"
+        FileUtils.mkdir_p checksum_path
+        current_gems = []
+
+        Bundler.ui.info "bundler-ri: installing ri docs"
+
+        Bundler.load.specs.materialized_for_all_platforms.each do |spec|
+          Bundler.ui.debug "installing docs for #{slug(spec)}"
+          current_gems << slug(spec)
+
+          new_checksum = checksum_for(spec)
+          Bundler.ui.debug "checksum: #{spec.full_gem_path} -> #{new_checksum}"
 
-        current_docs = []
+          old_checksum = begin
+            File.read(checksum_path_for(spec))
+          rescue
+            ""
+          end
 
-        @deps.each do |dep|
-          src_path = abs_path_for(dep).to_s
-          doc_path = ri_path_for(dep).to_s
+          if old_checksum == new_checksum
+            Bundler.ui.debug "checksums match, skipping"
+            next
+          end
+
+          Bundler.ui.debug "checksum mismatch, regenerating ri docs"
+
+          src_path = spec.full_gem_path
+          doc_path = ri_path.join(slug(spec)).to_s
 
           RDoc::RDoc.new.document(
             [
               "--root", src_path,
               "-o", doc_path,
+              "-x", %q(\.rbs\z),
               "-r",
               "-q"
             ]
           )
 
-          current_docs << doc_path
+          File.write(checksum_path_for(spec), new_checksum)
         end
 
-        puts "bundler-ri: docs installed"
-        current_docs.each { puts _1 }
+        Bundler.ui.info "bundler-ri: docs installed"
 
         Dir.glob(ri_path.join("*")).each do |p|
-          FileUtils.rm_rf(p) unless current_docs.include? p
+          unless current_gems.include?(File.basename(p))
+            Bundler.ui.debug "deleting stale ri data: #{p}"
+            FileUtils.rm_rf(p)
+          end
+        end
+
+        Dir.glob(checksum_path.join("*")).each do |p|
+          unless current_gems.include?(File.basename(p))
+            Bundler.ui.debug "deleting stale ri data: #{p}"
+            FileUtils.rm_rf(p)
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bundler-ri
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Aidan Coyle