gemcache 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c76e76eeb8a93262347ce8fea27326b005c739d7bbc5e5e438ce5fee055b1e2
-  data.tar.gz: 23ecd2076a905c840a542f608c6d62ebb0ca2fd92f856236752450f6a7487b4e
+  metadata.gz: e64ec2ecb946ec1b360a1beab00af993f7c7fc597ae796040f8a6b892018851a
+  data.tar.gz: 9f509214981e8ee07970146974474a2650dc54cf237ccb25b4b6f1c49243ee86
 SHA512:
-  metadata.gz: a3491b0461e394d32e250448f0013cefe756c1d880abaec7892ab52065324ae55fc929965a0a8421e5ce85a8e00c57ecf43eaa7fa078d47a54eb89afd2359509
-  data.tar.gz: 532c782579338c57218880057283d2dcdc98ba069fe50dd22984a59fc81cb1a6c0fb7cc634a099dc57feb0b3156a953ff22e5607b58bd995da9d954310141a01
+  metadata.gz: 7d074637c8654d68f6722a25c7c76dae4478ec202899422f2e56ba6060522ebdb44ea1b05bc3fc71332f174803099b938ae7ee4745e7ec4afe0feb69353c0cce
+  data.tar.gz: ce56c725c268675c94ec0dd840af03c11b30d8ba7853b812a27ffa1bf8074f7ee986c84b5cd9d27802aa81e7eb764b9ca6f15c1f803f2b4c45c55dd214f0444c

data/README.md

@@ -1,31 +1,48 @@
-# Gemcache
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gemcache`. To experiment with that code, run `bin/console` for an interactive prompt.
+# GemCache
+GemCache 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 [GemApi](https://github.com/pinecat/gemapi), which in turn is utilized by [Gemstruct](https://github.com/pinecat/gemstruct).
 
 ## Installation
+To use GemCache in your rails project, first:
+```
+bundle add gemcache
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+then:
+```
+rails g gemcache:install
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
+```ruby
+class Gemfu
+  include GemCache
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+  attr_reader :name, :requirements, :info_file, :stories, :versions, :version, :info, :quick_file, :gem_file
 
-## Usage
+  def initialize(gem)
+    @name = gem.name
+    @requirements = gem.requirements_list
 
-TODO: Write usage instructions here
+    @info_file = fetch_info
+    @stories = InfoParser.parse(@info_file)
+    @versions = SemVerParser.new(@stories, @requirements, @name)
+    @version = @versions.available.first
+    @info = InfoParser.info(@version, @stories)
 
-## Development
+    @quick_file = fetch_quick
+    @gem_file = fetch_gem
+  end
+end
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+gem = Gem::Dependency.new("colorize", Gem::Requirement.new(["~> 1.0"]))
+gemfu = Gemfu.new(gem)
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+File.binwrite("path/to/colorize.gem", gemfu.gem_file)
+```
 
 ## Contributing
+Bug reports and pull requests are welcome on Github at https://github.com/pinecat/gemcache/issues and https://github.com/pinecat/gemcache/pulls, respectively.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemcache.
+## 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

@@ -1,16 +1,3 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
 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: %i[test rubocop]

data/lib/gemcache/errors.rb

@@ -0,0 +1,28 @@
+module GemCache
+  #
+  # 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/gemcache/parsers/info_parser.rb

@@ -0,0 +1,91 @@
+module GemCache
+  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/gemcache/parsers/sem_ver_parser.rb

@@ -0,0 +1,79 @@
+module GemCache
+  #
+  # 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/gemcache/railtie.rb

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

data/lib/gemcache/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
-module Gemcache
-  VERSION = "0.0.1"
+module GemCache
+  VERSION = "0.1.0"
 end

data/lib/gemcache.rb

@@ -1,8 +1,62 @@
-# frozen_string_literal: true
+require "gemcache/version"
+require "gemcache/railtie"
+require "gemcache/errors"
+require "gemcache/parsers/info_parser"
+require "gemcache/parsers/sem_ver_parser"
+require "net/http"
+require "stringio"
+require "rubygems/package"
+require "rubygems/indexer"
 
-require_relative "gemcache/version"
+module GemCache
+  #
+  # The host of the remote gem server.
+  # The default is https://rubygems.org.
+  #
+  mattr_accessor :host
+  @@host = "https://rubygems.org"
 
-module Gemcache
-  class Error < StandardError; end
-  # Your code goes here...
+  #
+  # 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 GemCache
+  class InstallGenerator < Rails::Generators::Base
+    desc "Create an initializer file for Gemcache configuration options"
+    def create_initializer_file
+      create_file "config/initializers/gemcache.rb", <<~RUBY
+        # frozen_string_literal: true
+
+        # GemCache configuration options.
+        GemCache.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_GEMCACHE_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

@@ -1,30 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: gemcache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Rory Dudley
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
-dependencies: []
-description: Cache Ruby gems from an https://rubygems.org compatible host.
+date: 2023-08-24 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:
-- ".rubocop.yml"
-- CHANGELOG.md
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/gemcache.rb
+- lib/gemcache/errors.rb
+- lib/gemcache/parsers/info_parser.rb
+- lib/gemcache/parsers/sem_ver_parser.rb
+- lib/gemcache/railtie.rb
 - lib/gemcache/version.rb
-- sig/gemcache.rbs
+- lib/generators/gemcache/install_generator.rb
+- lib/tasks/gemcache_tasks.rake
 homepage: https://github.com/pinecat/gemcache
 licenses:
 - BSD 3-Clause
@@ -41,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/LICENSE.txt

@@ -1,27 +0,0 @@
-Copyright (c) 2023, Rory Dudley
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/sig/gemcache.rbs

@@ -1,4 +0,0 @@
-module Gemcache
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end