bundler-as_of 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bfce3407202aaf89329a360e43325983dfc934b0513dab48db6e192198c40a6
+  data.tar.gz: 6c792de9b55a63ec0b7fdb4ad025e46e77c8336fc0e1e938924c9f0a8ef87a49
+SHA512:
+  metadata.gz: 2f54bd7c187a5837a4b39e8bd21b6cfff7c4128c86d6552f275f867ebac3b7c2e2c2674e8ed800d24c5ab0d112d751c5b5ae48855b10602e5c4d766333996457
+  data.tar.gz: fab4d6ed5775fa363dca6b0f2afdb9fcd81df06df323f42f6771e93f36f7f081dab5495a289bbc9a02415f1fd1f8f410d84f0c9ff06aa303da8a3a3f1193a565

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mike.dalessio@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bundler-as_of.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mike Dalessio
+
+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,99 @@
+# Bundler::AsOf
+
+Bundler::AsOf allows you to `bundle install` dependencies as of a certain date in the past.
+
+This is intended for use with old projects that have not been well-maintained and that won't bundle or won't run today using recent releases (but were able to be bundled on some date in the past).
+
+
+## Inspiration
+
+Inspiration for this came from [@Schwad](https://github.com/Schwad) and his [`portal_gun`](https://github.com/Schwad/portal_gun) project. Also a bunch of old mdpress presentations that I have sitting around in Dropbox were motivating.
+
+
+## How Does It Work?
+
+`bundler-as_of` is a [Bundler plugin](https://bundler.io/bundle_plugin.html) that uses a `before-install-all` hook to modify the dependencies that Bundler installs and writes to the lockfile.
+
+It traverses the full dependency graph (including transitive dependencies) and whenever possible, resolves the version to the latest release that both:
+
+1. satisfies the version requirements specified (if any)
+2. existed as-of the date specified
+
+So, more specifically, `bundler-as_of` will try to avoid any releases that were made _after_ the specified date.
+
+Occasionally, `bundler-as_of` may not be able to find a dependency that meets both of these criteria, and in that case will print a warning and will not modify the dependency.
+
+
+## Usage
+
+First, install this gem as a bundler plugin. I haven't packaged a gem yet, so the best thing to do right now is bundle from git:
+
+``` sh
+bundle plugin install --git=https://github.com/flavorjones/bundler-as_of --branch=main bundler-as_of
+```
+
+(Note that bundler plugins are project-specific and are installed into the `.bundler` subdirectory.)
+
+Second, pick a date and run `bundle install`:
+
+``` ruby
+BUNDLE_AS_OF=2013-11-11 bundle install
+```
+
+You should see something like this as the output:
+
+``` text
+$ BUNDLE_AS_OF=2013-09-22 bundle install
+NOTE: bundler-as_of: bundling dependencies as of 2013-09-22 ...
+NOTE: bundler-as_of: resolving xml-focus [">= 0"] to 0.0.1 released on 2013-08-07
+NOTE: bundler-as_of: resolving rake [">= 0"] to 10.1.0 released on 2013-06-20
+NOTE: bundler-as_of: resolving rspec [">= 0"] to 2.14.1 released on 2013-07-11
+NOTE: bundler-as_of: resolving nokogiri [">= 0"] to 1.6.0 released on 2013-06-10
+NOTE: bundler-as_of: resolving rspec-core ["~> 2.14.0"] to 2.14.5 released on 2013-08-14
+NOTE: bundler-as_of: resolving rspec-expectations ["~> 2.14.0"] to 2.14.2 released on 2013-08-15
+NOTE: bundler-as_of: resolving rspec-mocks ["~> 2.14.0"] to 2.14.3 released on 2013-08-09
+NOTE: bundler-as_of: resolving mini_portile ["~> 0.5.0"] to 0.5.1 released on 2013-07-07
+NOTE: bundler-as_of: resolving diff-lcs ["< 2.0", ">= 1.1.3"] to 1.2.4 released on 2013-04-21
+Fetching gem metadata from https://rubygems.org/.......
+Resolving dependencies...
+Using rake 10.1.0
+Using bundler 2.2.30
+Using diff-lcs 1.2.4
+Using mini_portile 0.5.1
+Using rspec-mocks 2.14.3
+Using rspec-core 2.14.5
+Using rspec-expectations 2.14.2
+Using nokogiri 1.6.0
+Using rspec 2.14.1
+Using xml-focus 0.0.1
+Bundle complete! 9 Gemfile dependencies, 10 gems now installed.
+Use `bundle info [gemname]` to see where a bundled gem is installed.
+```
+
+## Tips
+
+Once you find a date that works, you may want to use something like [`direnv`](https://direnv.net/) to "remember" the date by automatically loading that environment variable when you `cd` into the project directory.
+
+
+## This Gem Won't Help You With ...
+
+### ... finding and using the right Ruby version
+
+`bundler-as_of` only resolves gem dependencies as of the given date, and doesn't do anything (yet?) to make sure you're using a version of Ruby that existed on that date.
+
+A manual alternative is to use a table of [Ruby version release dates](https://www.ruby-lang.org/en/downloads/releases/) and then run everything in the [Ruby dockerhub OCI images](https://hub.docker.com/_/ruby) for the particular version you want to use.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/bundler-as_of. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/flavorjones/bundler-as_of/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in the Bundler::AsOf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/flavorjones/bundler-as_of/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/as_of"
+
+# 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/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/lib/bundler/as_of/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bundler
+  module AsOf
+    VERSION = "0.1.0"
+  end
+end

data/lib/bundler/as_of.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "date"
+require "open-uri"
+require "json"
+require "set"
+
+module Bundler
+  module AsOf
+    BUNDLE_AS_OF = "BUNDLE_AS_OF"
+
+    class InstallModifier
+      def initialize
+        @modified_dependencies = {} # name => modified Bundler::Dependency
+      end
+
+      def modify_dependencies(dependencies)
+        if as_of_date.nil?
+          warn("NOTE: bundler-as_of is installed but #{BUNDLE_AS_OF} is not set")
+          return
+        end
+        warn("NOTE: bundler-as_of: bundling dependencies as of #{as_of_date} ...")
+
+        resolve_transitive_dependencies(dependencies)
+
+        dependencies.clear
+        @modified_dependencies.each do |name, dep|
+          dependencies << dep
+        end
+      end
+
+      def resolve_transitive_dependencies(dependencies)
+        queued = dependencies.dup
+
+        while !queued.empty?
+          resolving = queued
+          queued = []
+
+          resolving.each do |dependency|
+            if dependency.name == "bundler"
+              raise(BundlerError, "ERROR: please remove bundler from the Gemfile or gemspec")
+            end
+
+            next if @modified_dependencies.key?(dependency.name)
+
+            orig_req = dependency.requirements_list
+            release = VersionFinder.new(dependency, as_of_date).resolve
+            if release
+              warn("NOTE: bundler-as_of: resolving #{dependency.name} #{orig_req} to #{release.version} released on #{release.date}")
+              @modified_dependencies[release.name] = Bundler::Dependency.new(release.name, release.version)
+
+              release.dependencies.each do |transitive_name, transitive_req|
+                transitive_dep = Gem::Dependency.new(transitive_name, transitive_req.split(","))
+                queued << transitive_dep
+              end
+            else
+              warn("NOTE: bundler-as_of: WARNING: could not resolve #{dependency.name} to a version matching #{dependency.requirements_list} from #{as_of_date}")
+              @modified_dependencies[dependency.name] = dependency
+            end
+          end
+        end
+      end
+
+      def as_of_date
+        return nil if as_of_env.nil?
+
+        @as_of_date ||= begin
+          Date.parse(as_of_env)
+        rescue Date::Error
+          raise(BundlerError, "ERROR: bundler-as_of could not parse #{BUNDLE_AS_OF}=#{as_of_env.inspect}")
+        end
+      end
+
+      def as_of_env
+        ENV[BUNDLE_AS_OF]
+      end
+    end
+
+    class VersionFinder
+      def initialize(dependency, as_of_date)
+        @dependency = dependency
+        @as_of_date = as_of_date
+      end
+
+      def resolve
+        releases.each do |release|
+          next if release.prerelease
+          return release if @dependency.requirement.satisfied_by?(release.version)
+        end
+        nil
+      end
+
+      def releases
+        gem_releases
+          .select { |r| r.date <= @as_of_date }
+          .sort_by { |r| [r.date, r.version] }
+          .reverse
+      end
+
+      def gem_releases
+        @gem_releases ||=
+          JSON.parse(::URI.parse(gem_url).open.read)
+            .map { |r| ReleaseWrapper.new(@dependency.name, r) }
+      end
+
+      def gem_url
+        @gem_url ||= "https://rubygems.org/api/v1/versions/#{@dependency.name}.json"
+      end
+    end
+
+    class ReleaseWrapper
+      attr_reader :name, :version, :date, :prerelease
+      def initialize(name, release_json)
+        @name = name
+        @version = Gem::Version.new(release_json["number"])
+        @date = Date.parse(release_json["created_at"])
+        @prerelease = release_json["prerelease"]
+      end
+
+      def to_s
+        [name, version.to_s, date.to_s, prerelease, dependencies.to_s].to_s
+      end
+
+      def dependencies
+        gem_info.find { |info| info[:number] == version.to_s }[:dependencies] || []
+      end
+
+      def gem_info
+        @gem_info ||= Marshal.load(::URI.parse(gem_url).open.read)
+      end
+
+      def gem_url
+        @gem_url ||= "https://rubygems.org/api/v1/dependencies?gems=#{name}"
+      end
+    end
+  end
+end
+
+Bundler::Plugin.add_hook("before-install-all") do |dependencies|
+  Bundler::AsOf::InstallModifier.new.modify_dependencies(dependencies)
+end
+
+require_relative "as_of/version"

data/plugins.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/as_of"

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bundler-as_of
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Dalessio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: |2
+      Resolve gem dependencies as-of a date in the past. Intended to resurrect older projects with
+      out-of-date dependencies.
+email:
+- mike.dalessio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/bundler/as_of.rb
+- lib/bundler/as_of/version.rb
+- plugins.rb
+homepage: https://github.com/flavorjones/bundler-as_of
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flavorjones/bundler-as_of
+  rubygems_mfa_required: 'true'
+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.2.32
+signing_key: 
+specification_version: 4
+summary: Resolve gem dependencies as-of a date in the past.
+test_files: []