libyear-bundler 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19cf55f9516aaf1b3ea4e870df4786d871844aec
-  data.tar.gz: 1f9ed94b7ce2d79bdebbb07fa8d59e2d7bfc6d5c
+SHA256:
+  metadata.gz: 6605cda8b92cd002e2b1a536a716ba50d8c0df4b550db28f6b0be4760d7734f7
+  data.tar.gz: eec844bd3aaf31c95fc29827ca6a33166da392ab799a03b3b3b5269cc5507fe7
 SHA512:
-  metadata.gz: '09111fa6dbb524adb6f3a6af71f2fcd4803451f22e3d6d289cb61d8ef926553c781ddd3b801f33d7bbb7d957ea8fac52388982d752bb96625feedb3fd304aca2'
-  data.tar.gz: 7c9f3884523e18478563d45d5f35ef4f34f8b5d60d5fca78c369420a32dd3de6d3070e298347cc15d486c80405e357e0926b140abaf07e3d8d7a515dd664a91e
+  metadata.gz: 555318739eb3506de90e6d21f103fbb8ce2c0bd4225595830465c0aae476a906d55ffcf534e375925146c695348bbca975fe75ef962752bb4d41f474b6308b2d
+  data.tar.gz: a1fe20a4d14b170ccc8b10949868cf859382135651ec799bd1c0bfff4c588a5b92e63d7bf347cc0987feb4aa8199966e986b56d797d30828e9b01b3fb64cde72

data/lib/libyear_bundler/bundle_outdated.rb

@@ -11,8 +11,9 @@ module LibyearBundler
     # Format of `bundle outdated --parseable` (BOP)
     BOP_FMT = /\A(?<name>[^ ]+) \(newest (?<newest>[^,]+), installed (?<installed>[^,)]+)/
 
-    def initialize(gemfile_path)
+    def initialize(gemfile_path, release_date_cache)
       @gemfile_path = gemfile_path
+      @release_date_cache = release_date_cache
     end
 
     def execute
@@ -27,7 +28,8 @@ module LibyearBundler
         gem = ::LibyearBundler::Models::Gem.new(
           match['name'],
           match['installed'],
-          match['newest']
+          match['newest'],
+          @release_date_cache
         )
         gems.push(gem)
       end

data/lib/libyear_bundler/cli.rb

@@ -2,6 +2,7 @@ require "bundler/cli"
 require "bundler/cli/outdated"
 require "libyear_bundler/bundle_outdated"
 require "libyear_bundler/options"
+require "libyear_bundler/release_date_cache"
 require "libyear_bundler/report"
 require 'libyear_bundler/models/ruby'
 
@@ -27,6 +28,12 @@ module LibyearBundler
       else
         print report.to_s
       end
+
+      # Update cache
+      cache_path = @options.cache_path
+      if cache_path && release_date_cache
+        release_date_cache.save(cache_path)
+      end
     end
 
     private
@@ -54,7 +61,15 @@ module LibyearBundler
     end
 
     def bundle_outdated
-      BundleOutdated.new(@gemfile_path).execute
+      BundleOutdated.new(@gemfile_path, release_date_cache).execute
+    end
+
+    def release_date_cache
+      @_release_date_cache ||= begin
+        path = @options.cache_path
+        return if path.nil?
+        ReleaseDateCache.load(path)
+      end
     end
 
     def report
@@ -63,7 +78,7 @@ module LibyearBundler
 
     def ruby
       lockfile = @gemfile_path + '.lock'
-      ::LibyearBundler::Models::Ruby.new(lockfile)
+      ::LibyearBundler::Models::Ruby.new(lockfile, release_date_cache)
     end
 
     def grand_total

data/lib/libyear_bundler/models/gem.rb

@@ -7,10 +7,39 @@ module LibyearBundler
     # Logic and information pertaining to the installed and newest versions of
     # a gem
     class Gem
-      def initialize(name, installed_version, newest_version)
+      def initialize(name, installed_version, newest_version, release_date_cache)
+        unless release_date_cache.nil? || release_date_cache.is_a?(ReleaseDateCache)
+          raise TypeError, 'Invalid release_date_cache'
+        end
         @name = name
         @installed_version = installed_version
         @newest_version = newest_version
+        @release_date_cache = release_date_cache
+      end
+
+      class << self
+        def release_date(gem_name, gem_version)
+          dep = nil
+          begin
+            dep = ::Bundler::Dependency.new(gem_name, gem_version)
+          rescue ::Gem::Requirement::BadRequirementError => e
+            $stderr.puts "Could not find release date for: #{gem_name}"
+            $stderr.puts(e)
+            $stderr.puts(
+              "Maybe you used git in your Gemfile, which libyear doesn't support " \
+              "yet. Contributions welcome."
+            )
+            return nil
+          end
+          tuples, _errors = ::Gem::SpecFetcher.fetcher.search_for_dependency(dep)
+          if tuples.empty?
+            $stderr.puts "Could not find release date for: #{gem_name}"
+            return nil
+          end
+          tup, source = tuples.first # Gem::NameTuple
+          spec = source.fetch_spec(tup) # raises Gem::RemoteFetcher::FetchError
+          spec.date.to_date
+        end
       end
 
       def installed_version
@@ -18,7 +47,11 @@ module LibyearBundler
       end
 
       def installed_version_release_date
-        release_date(name, installed_version)
+        if @release_date_cache.nil?
+          self.class.release_date(name, installed_version)
+        else
+          @release_date_cache[name, installed_version]
+        end
       end
 
       def installed_version_sequence_index
@@ -45,7 +78,11 @@ module LibyearBundler
       end
 
       def newest_version_release_date
-        release_date(name, newest_version)
+        if @release_date_cache.nil?
+          self.class.release_date(name, newest_version)
+        else
+          @release_date_cache[name, newest_version]
+        end
       end
 
       def version_number_delta
@@ -74,31 +111,6 @@ module LibyearBundler
           parsed_response.map { |version| version['number'] }
         end
       end
-
-      # Known issue: Probably performs a network request every time, unless
-      # there's some kind of caching.
-      def release_date(gem_name, gem_version)
-        dep = nil
-        begin
-          dep = ::Bundler::Dependency.new(gem_name, gem_version)
-        rescue ::Gem::Requirement::BadRequirementError => e
-          $stderr.puts "Could not find release date for: #{gem_name}"
-          $stderr.puts(e)
-          $stderr.puts(
-            "Maybe you used git in your Gemfile, which libyear doesn't support " \
-              "yet. Contributions welcome."
-          )
-          return nil
-        end
-        tuples, _errors = ::Gem::SpecFetcher.fetcher.search_for_dependency(dep)
-        if tuples.empty?
-          $stderr.puts "Could not find release date for: #{gem_name}"
-          return nil
-        end
-        tup, source = tuples.first # Gem::NameTuple
-        spec = source.fetch_spec(tup) # raises Gem::RemoteFetcher::FetchError
-        spec.date.to_date
-      end
     end
   end
 end

data/lib/libyear_bundler/models/ruby.rb

@@ -15,8 +15,78 @@ module LibyearBundler
       RUBY_VERSION_DATA_URL = "https://raw.githubusercontent.com/ruby/" \
         "www.ruby-lang.org/master/_data/releases.yml".freeze
 
-      def initialize(lockfile)
+      def initialize(lockfile, release_date_cache)
+        unless release_date_cache.nil? || release_date_cache.is_a?(ReleaseDateCache)
+          raise TypeError, 'Invalid release_date_cache'
+        end
         @lockfile = lockfile
+        @release_date_cache = release_date_cache
+      end
+
+      class << self
+        # We'll only consider non-prerelease versions when analyzing ruby version,
+        # which we also implcitly do for gem versions because that's bundler's
+        # default behavior
+        #
+        # @return [Array<String>]
+        def all_stable_versions
+          all_versions.reject do |version|
+            ::Gem::Version.new(version).prerelease?
+          end
+        end
+
+        def newest_version
+          ::Gem::Version.new(all_stable_versions.first)
+        end
+
+        def newest_version_release_date
+          if @release_date_cache.nil?
+            release_date(newest_version)
+          else
+            @release_date_cache[name, newest_version]
+          end
+        end
+
+        def newest_version_sequence_index
+          all_stable_versions.find_index(newest_version.to_s)
+        end
+
+        def release_date(version_obj)
+          version = version_obj.to_s
+          v = all_stable_versions.detect { |ver| ver == version }
+
+          if v.nil?
+            raise format('Cannot determine release date for ruby %s', version)
+          end
+
+          # YAML#safe_load provides an already-parsed Date object, so the following
+          # is a Date object
+          v['date']
+        end
+
+        private
+
+        # The following URL is the only official, easily-parseable document with
+        # Ruby version information that I'm aware of, but is not supported as such
+        # (https://github.com/ruby/www.ruby-lang.org/pull/1637#issuecomment-344934173).
+        # It's been recommend that ruby-lang.org provide a supported document:
+        # https://github.com/ruby/www.ruby-lang.org/pull/1637#issuecomment-344934173
+        # TODO: Use supported document with version information if it becomes
+        # available.
+        #
+        # @return [Array<String>]
+        def all_versions
+          @_all_versions ||= begin
+            uri = ::URI.parse(RUBY_VERSION_DATA_URL)
+            response = ::Net::HTTP.get_response(uri)
+            # The Date object is passed through here due to a bug in
+            # YAML#safe_load
+            # https://github.com/ruby/psych/issues/262
+            ::YAML
+              .safe_load(response.body, [Date])
+              .map { |release| release['version'] }
+          end
+        end
       end
 
       def installed_version
@@ -28,13 +98,17 @@ module LibyearBundler
       end
 
       def installed_version_release_date
-        release_date(installed_version.to_s)
+        if @release_date_cache.nil?
+          self.class.release_date(installed_version)
+        else
+          @release_date_cache[name, installed_version]
+        end
       end
 
       def libyears
         ::LibyearBundler::Calculators::Libyear.calculate(
-          release_date(installed_version.to_s),
-          release_date(newest_version.to_s)
+          installed_version_release_date,
+          self.class.newest_version_release_date
         )
       end
 
@@ -42,12 +116,16 @@ module LibyearBundler
         'ruby'
       end
 
+      # Simply delegates to class method, but we still need it to conform to
+      # the interface expected by `Report#meta_line_summary`.
       def newest_version
-        ::Gem::Version.new(all_stable_versions.first)
+        self.class.newest_version
       end
 
+      # Simply delegates to class method, but we still need it to conform to
+      # the interface expected by `Report#meta_line_summary`.
       def newest_version_release_date
-        release_date(newest_version.to_s)
+        self.class.newest_version_release_date
       end
 
       def outdated?
@@ -57,65 +135,21 @@ module LibyearBundler
       def version_number_delta
         ::LibyearBundler::Calculators::VersionNumberDelta.calculate(
           installed_version,
-          newest_version
+          self.class.newest_version
         )
       end
 
       def version_sequence_delta
         ::LibyearBundler::Calculators::VersionSequenceDelta.calculate(
           installed_version_sequence_index,
-          newest_version_sequence_index
+          self.class.newest_version_sequence_index
         )
       end
 
       private
 
-      # The following URL is the only official, easily-parseable document with
-      # Ruby version information that I'm aware of, but is not supported as such
-      # (https://github.com/ruby/www.ruby-lang.org/pull/1637#issuecomment-344934173).
-      # It's been recommend that ruby-lang.org provide a supported document:
-      # https://github.com/ruby/www.ruby-lang.org/pull/1637#issuecomment-344934173
-      # TODO: Use supported document with version information if it becomes
-      # available.
-      def all_versions
-        @_all_versions ||= begin
-          uri = ::URI.parse(RUBY_VERSION_DATA_URL)
-          response = ::Net::HTTP.get_response(uri)
-          # The Date object is passed through here due to a bug in
-          # YAML#safe_load
-          # https://github.com/ruby/psych/issues/262
-          ::YAML.safe_load(response.body, [Date])
-            .map { |release| release['version'] }
-        end
-      end
-
-      # We'll only consider non-prerelease versions when analyzing ruby version,
-      # which we also implcitly do for gem versions because that's bundler's
-      # default behavior
-      def all_stable_versions
-        all_versions.reject do |version|
-          ::Gem::Version.new(version).prerelease?
-        end
-      end
-
       def installed_version_sequence_index
-        all_stable_versions.index(installed_version.to_s)
-      end
-
-      def newest_version_sequence_index
-        all_stable_versions.find_index(newest_version.to_s)
-      end
-
-      def release_date(version)
-        v = all_stable_versions.detect { |ver| ver == version }
-
-        if v.nil?
-          raise format('Cannot determine release date for ruby %s', version)
-        end
-
-        # YAML#safe_load provides an already-parsed Date object, so the following
-        # is a Date object
-        v['date']
+        self.class.all_stable_versions.index(installed_version.to_s)
       end
 
       def shell_out_to_ruby
@@ -142,6 +176,8 @@ module LibyearBundler
         ::Bundler::RubyVersion.from_string(ruby_version_string).gem_version
       end
 
+      # TODO: this path should probably be relative to `@lockfile` instead
+      # TODO: of being relative to the current working directory.
       def version_from_ruby_version_file
         return unless ::File.exist?('.ruby-version')
         ::Gem::Version.new(::File.read('.ruby-version').strip)

data/lib/libyear_bundler/options.rb

@@ -31,6 +31,10 @@ https://github.com/jaredbeck/libyear-bundler/
           @options.send('versions?=', true)
         end
 
+        opts.on('--cache=CACHE_PATH', 'Use a cache across runs') do |cache_path|
+          @options.cache_path = cache_path
+        end
+
         opts.on('--libyears', '[default] Calculate libyears out-of-date') do
           @options.send('libyears?=', true)
         end

data/lib/libyear_bundler/release_date_cache.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+
+module LibyearBundler
+  # A cache of release dates by name and version, for both gems and rubies.
+  class ReleaseDateCache
+    # @param data [Hash<String,Date>]
+    def initialize(data)
+      raise TypeError unless data.is_a?(Hash)
+      @data = data
+    end
+
+    def [](name, version)
+      key = format('%s-%s', name, version)
+      if @data.key?(key)
+        @data[key]
+      else
+        @data[key] = release_date(name, version)
+      end
+    end
+
+    class << self
+      def load(path)
+        if File.exist?(path)
+          new(YAML.safe_load(File.read(path), [Date]))
+        else
+          new({})
+        end
+      end
+    end
+
+    def save(path)
+      content = YAML.dump(@data)
+      begin
+        File.write(path, content)
+      rescue StandardError => e
+        warn format('Unable to update cache: %s, %s', path, e.message)
+      end
+    end
+
+    private
+
+    def release_date(name, version)
+      if name == 'ruby'
+        Models::Ruby.release_date(version)
+      else
+        Models::Gem.release_date(name, version)
+      end
+    end
+  end
+end

data/lib/libyear_bundler/version.rb

@@ -1,3 +1,3 @@
 module LibyearBundler
-  VERSION = "0.5.3".freeze
+  VERSION = "0.6.0".freeze
 end

data/libyear-bundler.gemspec

@@ -23,10 +23,14 @@ Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables = ["libyear-bundler"]
   spec.require_paths = ["lib"]
+
+  # We deliberately support dead rubies, as long as possible. It's important
+  # that people with badly out-of-date systems can still measure how bad they
+  # are.
   spec.required_ruby_version = ">= 2.1"
 
-  # We will support bundler 1 as long as we can. It's important that people
-  # with badly out-of-date systems can still measure how bad they are.
+  # We will support bundler 1 as long as we can. See `required_ruby_version`
+  # above.
   spec.add_dependency "bundler", ">= 1.14", "< 3"
 
   spec.add_development_dependency "rspec", "~> 3.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libyear-bundler
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/libyear_bundler/models/gem.rb
 - lib/libyear_bundler/models/ruby.rb
 - lib/libyear_bundler/options.rb
+- lib/libyear_bundler/release_date_cache.rb
 - lib/libyear_bundler/report.rb
 - lib/libyear_bundler/version.rb
 - libyear-bundler.gemspec
@@ -100,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: A simple measure of dependency freshness