gemsolver 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd1bc00574ad277bb5ecd22d84c7c8de6fc57140009245bc75dfd2ca9d186e02
+  data.tar.gz: 10f8060f235b69be05a7ba35885a3840d327fddf28d18ca4f1d752b091a534b9
+SHA512:
+  metadata.gz: 560a4b12aff71e5f38425cc9c84b454919d766cb58632f857377103032d701c39d991ac81667007b36f9b4d64df3da950960652cc512d8f5c46b3069e76c0f92
+  data.tar.gz: 32d0e043c9f8224c9135f9e09b5b931c178e7223ff24d2dc9137a56cfd8c6810c41bcb32754277d073f369501c6689eb828cadfbc493b1d4dfc7cb29e7a790b4

data/README.md

@@ -0,0 +1,48 @@
+# Gem Solver
+Gem Solver is a plugin for Rails that caches Ruby gems from any [rubygems.org](https://rubygems.org) compatible host.
+It is built primarly to work with [GemCache](https://github.com/pinecat/gemcache).
+
+## Installation
+To use GemSolver in your rails project, first:
+```
+bundle add gemsolver
+```
+
+then:
+```
+rails g gemsolver:install
+```
+
+## Usage
+```ruby
+class Gemfu
+  include GemSolver
+
+  attr_reader :name, :requirements, :info_file, :stories, :versions, :version, :info, :quick_file, :gem_file
+
+  def initialize(gem)
+    @name = gem.name
+    @requirements = gem.requirements_list
+
+    @info_file = fetch_info
+    @stories = InfoParser.parse(@info_file)
+    @versions = SemVerParser.new(@stories, @requirements, @name)
+    @version = @versions.available.first
+    @info = InfoParser.info(@version, @stories)
+
+    @quick_file = fetch_quick
+    @gem_file = fetch_gem
+  end
+end
+
+gem = Gem::Dependency.new("colorize", Gem::Requirement.new(["~> 1.0"]))
+gemfu = Gemfu.new(gem)
+
+File.binwrite("path/to/colorize.gem", gemfu.gem_file)
+```
+
+## Contributing
+Bug reports and pull requests are welcome on Github at https://github.com/pinecat/gemsolver/issues and https://github.com/pinecat/gemsolver/pulls, respectively.
+
+## License
+The gem is available as open source under the terms of the [BSD 3-Clause License](https://opensource.org/license/bsd-3-clause/).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/gemsolver/errors.rb

@@ -0,0 +1,28 @@
+module GemSolver
+  #
+  # Raised when /info/<gem> cannot be found on the remote gem host.
+  #
+  class GemNotFoundError < StandardError
+    def initialize(name)
+      super("The '#{name}' gem could not be found on '#{@@host}'")
+    end
+  end
+
+  #
+  # Raised when an unrecognized version constraint is passed in a dependency.
+  #
+  class InvalidVersionConstraintError < StandardError
+    def initialize(operator)
+      super("The semantic versioning contraint '#{operator}' is not recognized")
+    end
+  end
+
+  #
+  # Raised when the version constraints are not inclusive enough to return a version.
+  #
+  class NoAvailableVersionsError < StandardError
+    def initialize(name)
+      super("There are no versions of '#{name}' that meet the specified version constraints")
+    end
+  end
+end

data/lib/gemsolver/parsers/info_parser.rb

@@ -0,0 +1,91 @@
+module GemSolver
+  class InfoParser
+    # The version of the gem from the info entry.
+    attr_reader :version
+
+    # A list of Gem::Dependencies from the info entry.
+    attr_reader :dependencies
+
+    # The SHA256 checksum of the gem from the info entry.
+    attr_reader :checksum
+
+    # The required Ruby version of the gem from the info entry.
+    attr_reader :ruby
+
+    # The required rubygems version of the gem from the info entry.
+    attr_reader :rubygems
+
+    def initialize(entry)
+      # Split line into two parts:
+      # (0) Semantic version and runtime dependencies
+      # (1) Checksum and required ruby/rubygems versions
+      split = entry.split("|")
+      ver_and_deps = split[0].strip
+      sha_and_ruby = split[1].strip
+
+      # Parse each part of the entry in the info file
+      parts = parse_version(ver_and_deps)
+      parse_dependencies(parts)
+      parts = parse_checksum(sha_and_ruby)
+      parts = parse_ruby(parts)
+      parse_rubygems(parts)
+    end
+
+    def self.info(version, stories)
+      stories.each do |s|
+        return s if s.version == version
+      end
+      nil
+    end
+
+    def self.parse(raw)
+      stories = []
+      raw.lines.drop(1).each do |l|
+        stories << new(l)
+      end
+      stories.reverse
+    end
+
+    private
+
+    def parse_version(raw)
+      return if raw.blank?
+
+      parts = raw.split(" ", 2)
+      @version = Gem::Version.new(parts[0])
+      parts.drop(1)
+    end
+
+    def parse_dependencies(parts)
+      return if parts.blank?
+
+      parts = parts.split(",").flatten
+      @dependencies = []
+      parts.each do |p|
+        name, requirements = p.split(":")
+        @dependencies << Gem::Dependency.new(name, requirements)
+      end
+    end
+
+    def parse_checksum(raw)
+      return if raw.blank?
+
+      parts = raw.split(",")
+      @checksum = parts[0].split(":")[1]
+      parts.drop(1)
+    end
+
+    def parse_ruby(parts)
+      return if parts.blank?
+
+      @ruby = Gem::Dependency.new("ruby", parts[0].split(":")[1].split("&"))
+      parts.drop(1)
+    end
+
+    def parse_rubygems(parts)
+      return if parts.blank?
+
+      @rubygems = Gem::Dependency.new("rubygems", parts[0].split(":")[1].split("&"))
+    end
+  end
+end

data/lib/gemsolver/parsers/sem_ver_parser.rb

@@ -0,0 +1,79 @@
+module GemSolver
+  #
+  # Creates a list of appropriate gem and dependency versions
+  # based on semantic versioning requirements. The latest
+  # possible verions will always come first in the list.
+  #
+  class SemVerParser
+    class Constraint
+      def initialize(operator, version)
+        @operator = operator.intern
+        @version = Gem::Version.new(version)
+      end
+
+      def appropriate?(version)
+        version.send(@operator, @version)
+      end
+    end
+
+    # List of appropriate semantic versions, with the latest versions at the front of the list.
+    attr_reader :available
+
+    def initialize(stories, requirements, name)
+      constraints = constrain(requirements)
+
+      @available = []
+      stories.each do |s|
+        one_constraint_failed = false
+        constraints.each do |c|
+          unless c.appropriate?(s.version)
+            one_constraint_failed = true
+            break
+          end
+        end
+        @available << s.version unless one_constraint_failed
+      end
+
+      raise NoAvailableVersionsError.new(name) if @available.blank?
+    end
+
+    private
+
+    def constrain(requirements)
+      constraints = []
+      requirements.each do |r|
+        operator, version = r.split(" ")
+
+        case operator
+        when "~>"
+          # Pessimistic versioning (i.e. approximately greater than)
+          constraints << Constraint.new(">=", version)
+
+          if version.include?("-")
+            version = version.split("-")[0]
+          end
+
+          if version.include?("+")
+            version = version.split("+")[0]
+          end
+
+          mmp = version.split(".").map { |s| s.to_i }
+          mmp.pop unless mmp.length == 1
+          mmp[-1] += 1
+          version = mmp.join(".")
+
+          constraints << Constraint.new("<", version)
+        when ">", ">=", "<", "<="
+          constraints << Constraint.new(operator, version)
+        when "="
+          constraints << Constraint.new("==", version)
+        else
+          raise InvalidVersionConstraintError.new(operator)
+        end
+
+      end
+      constraints
+    end
+
+  end
+end

data/lib/gemsolver/railtie.rb

@@ -0,0 +1,4 @@
+module GemCSolver
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/gemsolver/version.rb

@@ -0,0 +1,3 @@
+module GemSolver
+  VERSION = "0.2.1"
+end

data/lib/gemsolver.rb

@@ -0,0 +1,61 @@
+require "gemsolver/version"
+require "gemsolver/railtie"
+require "gemsolver/errors"
+require "gemsolver/parsers/info_parser"
+require "gemsolver/parsers/sem_ver_parser"
+require "net/http"
+require "stringio"
+require "rubygems/indexer"
+
+module GemSolver
+  #
+  # The host of the remote gem server.
+  # The default is https://rubygems.org.
+  #
+  mattr_accessor :host
+  @@host = "https://rubygems.org"
+
+  #
+  # Set configuration options.
+  # This is typically done in the initializer ('rails g gemcache:install')
+  #
+  def self.setup
+    yield self
+  end
+
+  #
+  # Fetch required gem info file.
+  #
+  # @return [String] The (YAML based?) info file.
+  #
+  def fetch_info
+    info_uri = URI.parse("#{@@host}/info/#{@name}")
+    response = Net::HTTP.get_response(info_uri)
+    raise GemNotFoundError.new(@name) unless response.is_a? Net::HTTPSuccess
+    response.body
+  end
+
+  #
+  # Fetch required gem quick file.
+  #
+  # @return [String] The binary (compressed) quick file.
+  #
+  def fetch_quick
+    quick_uri = URI.parse("#{@@host}/quick/Marshal.4.8/#{@name}-#{@version}.gemspec.rz")
+    response = Net::HTTP.get_response(quick_uri)
+    raise GemNotFoundError.new(@name) unless response.is_a? Net::HTTPSuccess
+    response.body
+  end
+
+  #
+  # Fetch required gem file.
+  #
+  # @return [String] The binary (compressed) gem file.
+  #
+  def fetch_gem
+    gem_uri = URI.parse("#{@@host}/gems/#{@name}-#{@version}.gem")
+    response = Net::HTTP.get_response(gem_uri)
+    raise GemNotFoundError(@name) unless response.is_a? Net::HTTPSuccess
+    response.body
+  end
+end

data/lib/generators/gemcache/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Gemsolver
+  class InstallGenerator < Rails::Generators::Base
+    desc "Create an initializer file for Gem Solver configuration options"
+    def create_initializer_file
+      create_file "config/initializers/gemsolver.rb", <<~RUBY
+        # frozen_string_literal: true
+
+        # GemCache configuration options.
+        GemSolver.setup do |config|
+          # The remote host to cache ruby gems from. This option may be overriden
+          # directly or by setting the 'RAILS_GEMCACHE_HOST' environment
+          # variable. The default option is https://rubygems.org. The remote host
+          # must follow the distrubution pattern of rubygems.org, otherwise
+          # GemCache will be unable to fetch gems from it.
+          config.host = ENV["RAILS_GEMSOLVE_HOST"] || "https://rubygems.org"
+        end
+      RUBY
+    end
+  end
+end

data/lib/tasks/gemcache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :gemcache do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: gemsolver
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Rory Dudley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.7.2
+description: Cache Ruby gems from a rubygems.org compatible host.
+email:
+- rory.dudley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/gemsolver.rb
+- lib/gemsolver/errors.rb
+- lib/gemsolver/parsers/info_parser.rb
+- lib/gemsolver/parsers/sem_ver_parser.rb
+- lib/gemsolver/railtie.rb
+- lib/gemsolver/version.rb
+- lib/generators/gemcache/install_generator.rb
+- lib/tasks/gemcache_tasks.rake
+homepage: https://github.com/pinecat/gemcache
+licenses:
+- BSD 3-Clause
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pinecat/gemcache
+  source_code_uri: https://github.com/pinecat/gemcache
+  changelog_uri: https://github.com/pinecat/gemcache/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Cache Ruby gems.
+test_files: []