iruby-dependencies 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b76ab22b037f610fc159aac6166d675e654f9fc
-  data.tar.gz: f3a1bb3b000f5e7dc8ed7f9cbbf2de3fe4243e2f
+SHA256:
+  metadata.gz: 93eac5474a61ffd224821a9423743f211683c362693002c0ae970fbab4e0df0a
+  data.tar.gz: 0375f511e0d79f2e52fa5e678d22a9e85b8c1e695ffa4a5d8db730ccdb43804a
 SHA512:
-  metadata.gz: 20a85f396522977a3f7889a62a531839f11ff052fa7d699054d8a1eca67b4c47f8f7ef84adb638afd5f01175f92c0dd80a4e166ddda818acfecccb5c5db704e4
-  data.tar.gz: 63063d28dd6f671dd9fd1d144b738e0cb480ddda8d64fcb1ad25e4d5fb59904e7dd4365326f6c8217987151aaca611c394109c40c1fa5dc7baaac714e18a0fe1
+  metadata.gz: 5a26e060f1a74f083fcfa074e8872f918ae254a152c32c30c815f84b0886c4f83d0af36a2fed25de7128fcd948fdfd9bd4600cfbd152ab4c8412fb7694b55cc3
+  data.tar.gz: aeb5d7547d3168b0ebbc9debb36438e04b8cd2212ad6c290ee8fcb45dc29c989ad597c4f4aebae573f57e643123b22cd8de9dc8a020ff97e67a04a281cec8b24

data/README.md

@@ -1,6 +1,6 @@
 # IRuby::Dependencies
 
-`IRuby::Dependencies` is a module for injecting Ruby dependencies into Jupyter Notebooks. For example, 
+`IRuby::Dependencies` is a thin wrapper around [bundler/inline](https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html) for injecting Ruby dependencies into Jupyter Notebooks along with their system dependencies. For example, 
 
 ```ruby 
 require 'iruby/dependencies'
@@ -11,10 +11,6 @@ dependencies do
 end
 ```
 
-## RubyGems Compatability 
-
-There are issues with **rerunning** dependency blocks on machine with RubyGem versions greater than 2.4.5.1. 
-
 ## Installation
 
 ```bash
@@ -25,15 +21,13 @@ You'll have to restart any IRuby kernels already running.
 
 ## Configuration
 
-`IRuby::Dependencies` reads in configuration from Bundler (see `bundle config`). The following configuration parameters are available:
+Most Jupyter notebooks run in highly reproducible environments (e.g. Docker containers). An `IRuby::Dependencies` can be created that maps gems to the commands that must be executed before that gem can be installed. The config location should be saved as a [Bundler config](https://bundler.io/v2.1/bundle_config.html) with the key `dependencies.config`. The config location can be a local file path or URL. For example:
 
-| Key | Description |
-| ------ | ----------- |
-| `dependencies.require` | A colon-separated list of gems to require before running a dependency block. This can be used to load plugins automatically |
-| `dependencies.mypki` | Use MyPKI to pull from a PKI-enabled gem server |
-| `dependencies.config` | The URL to pull a remote iruby-dependencies config as JSON.|
+```bash
+$ bundle config dependencies.config /home/jovyan/dependencies.config
+```
 
-Remote configurations are generally used to install gem dependencies. For example:
+RemThe config file itself is a JSON file that maps gem names to commands that should be executed before the gem is installed. For instance, in a CentOS/RHEL environment, the config entry would install the `gsl` YUM package before installing the `gsl` RubyGem:
 
 ```json
 { 
@@ -43,19 +37,8 @@ Remote configurations are generally used to install gem dependencies. For exampl
 }
 ```
 
-This configuration will install the `gsl` yum package if the user uses `IRuby::Dependencies` to install the `gsl` gem. 
-
 ## Usage
 
-`IRuby::Dependencies` uses the [Bundler Gemfile syntax](http://bundler.io/v1.5/gemfile.html) with some additional methods:
-
-| Method | Description |
-| ------ | ----------- |
-| `script <url>` | Loads the javascript at the given url into the notebook as a `script` tag |
-| `define <hash>` | Defines alternate paths for requirejs modules. Keys are modules, values are paths |
-| `exec <string>` | Executes the system command, for example `yum install gsl` |
-| `css <string>` | Loads the stylesheet at the given url into the notebook as a `link` tag 
-
 To see the normal bundler output, pass `verbose: true` to the dependencies method: 
 
 ```
@@ -63,8 +46,4 @@ dependencies verbose: true do
   gem 'http'
   gem 'addressable'
 end
-```
-
-## Active Gems
-
-When `IRuby::Dependencies` is first loaded, it saves a list of all active gems, which are added to the dependency bundle. For example, since IRuby uses multi_json, the multi_json gem is always included in the bundle. Active gems cannot be removed and their versions are fixed. If you need a different version of an active gem, install it on the command line and restart the kernel. To reduce the number of active gems, `require 'iruby/dependencies'` as early in your notebook as possible. 
+```

data/iruby-dependencies.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "iruby", "~> 0.3"
-  spec.add_dependency "multi_json", "~> 1.13"
-  spec.add_dependency "bundler", "~> 1.16"
+  spec.add_dependency "iruby", "~> 0.4"
+  spec.add_dependency "bundler", "~> 2"
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
 end

data/lib/iruby/dependencies.rb

@@ -1,82 +1,78 @@
-require 'bundler'
-
-# require 'mypki' if requested so it is an active gem
-if Bundler.settings['dependencies.mypki']
-  require 'mypki' 
-  require 'erector'
-end
-
-if gems = Bundler.settings['dependencies.require']
-  gems.split(':').each {|gem| require gem}
-end
-
-require 'iruby/dependencies/dsl'
-require 'iruby/dependencies/config'
-require 'iruby/dependencies/shared_helpers'
-require 'iruby/dependencies/version'
+require 'net/https'
+require 'bundler/inline'
 
 module IRuby
-  module Dependencies
-    ACTIVE_GEMS = {}
+  class Dependencies
+    def initialize config, verbose: false, &block
+      @config = config
+      @verbose = verbose 
 
-    # this code is taken from bundler/inline with small changes
-    def self.dependencies verbose: false, &gemfile
-      if ACTIVE_GEMS.empty?
-        ACTIVE_GEMS.merge! Gem.loaded_specs.map{|n,s| [n,s.version.to_s]}.to_h
-      end
+      instance_eval &block
 
-      Bundler.ui = verbose ? Bundler::UI::Shell.new : nil
-      MyPKI.init if Bundler.settings['dependencies.mypki']
-      
-      warn 'Dependencies installing. This could take a minute ...'
-      old_root = Bundler.method(:root)
-      
-      def Bundler.root
-        Bundler::SharedHelpers.pwd.expand_path
+      gemfile do 
+        # tell bundler to use our gem sources
+        Gem.sources.each {|source| source source.to_s}
+        instance_eval &block
       end
-      
-      ENV['BUNDLE_GEMFILE'] ||= 'Gemfile'
-
-      builder = Dsl.new
-      builder.instance_eval(&gemfile)
+    end
 
-      Gem::ConfigFile.new ['sources']
-      Gem.sources.each {|s| builder.source s}
+    def gem name, *args
+      send *@config[name] if @config[name]
+    end
 
-      ACTIVE_GEMS.each do |name,version|
-        builder.gem name, version, require: false
+    def exec string
+      stdout, stderr, exit_status = Open3.capture3(string)
+
+      if exit_status.success?
+        if @verbose 
+          Bundler.ui.info stdout unless stdout.empty?
+          Bundler.ui.warn stderr unless stderr.empty?
+        end
+      else
+        puts stdout unless stdout.empty?
+        warn stderr unless stderr.empty?
+        raise "\"exec '#{string}'\" failed on dependency installation"
       end
+    end
 
-      Config.process builder
-      definition = builder.to_definition(nil, true)
-
-      def definition.lock(*); end
-      definition.validate_ruby!
-
-      Bundler::Installer.install(Bundler.root, definition, :system => true)
-
-      runtime = Bundler::Runtime.new(nil, definition)
-      runtime.setup.require
-
-      bundler_module = class << Bundler; self; end
-      bundler_module.send(:define_method, :root, old_root)
+    # gemfiles allow specifying alternate sources for gems
+    # make sure we check the block for gems in those sources
+    def source &block
+      instance_eval &block if block_given?
+    end
 
-      html = IRuby.html <<-HTML
-        <div style='
-          margin: -0.4em; 
-          padding: 0.4em; 
-          background: rgba(0, 255, 0, .3); 
-          font-family: monospace;
-        '>
-          Dependencies successfully installed.
+    def to_html
+      <<-HTML
+        <div style='background: rgba(0,255,0,0.3);
+                    font-family: monospace;
+                    padding: 5px;'>
+          <b>Dependencies successfully installed!</b>
         </div>
       HTML
-
-      IRuby.display html; nil
     end
   end
 end
 
-def dependencies *args, &block
-  IRuby::Dependencies.dependencies *args, &block
+def dependencies **params, &block
+  config={}
+
+  begin 
+    if config_path = Bundler.settings['dependencies.config']
+      uri = URI config_path
+  
+      json = case uri.scheme
+        when /http/
+          Net::HTTP.get(uri)
+        else 
+          File.read(uri.path)
+        end
+  
+      config = JSON.parse(json)
+    end
+  
+  rescue => ex
+    warn "iruby-dependencies could not load #{config_path}: #{ex.message}"
+  end
+
+  IRuby::Dependencies.new config, **params, &block
 end

data/lib/iruby/dependencies/version.rb

@@ -1,5 +1,5 @@
 module IRuby
-  module Dependencies
-    VERSION = "2.1.0"
+  class Dependencies
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iruby-dependencies
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kyle King
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iruby
@@ -16,57 +16,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '0'
+description:
 email:
 - kylejking@gmail.com
 executables: []
@@ -82,15 +82,12 @@ files:
 - bin/setup
 - iruby-dependencies.gemspec
 - lib/iruby/dependencies.rb
-- lib/iruby/dependencies/config.rb
-- lib/iruby/dependencies/dsl.rb
-- lib/iruby/dependencies/shared_helpers.rb
 - lib/iruby/dependencies/version.rb
 homepage: https://github.com/jupyter-gallery/iruby-dependencies
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: IRuby::Dependencies is a module for injecting Ruby dependencies into Jupyter
   Notebooks

data/lib/iruby/dependencies/config.rb

@@ -1,46 +0,0 @@
-require 'net/https'
-require 'multi_json'
-
-module IRuby
-  module Dependencies
-    class Config
-      def self.process builder
-        if url = Bundler.settings['dependencies.config']
-          begin 
-            uri = URI Bundler.settings['dependencies.config']
-            config = MultiJson.load(Net::HTTP.get(uri))
-          rescue => ex
-            warn "Could not fetch remote IRuby::Dependencies config from #{url}: #{ex.message}"
-          else
-            loop do 
-              gem_added = false
-
-              if commands = config.delete('*')
-                commands.each do |command|
-                  method, *args = command
-                  builder.send method, *args
-                  gem_added ||= method == 'gem'
-                end
-              end
-
-              definition = builder.to_definition nil, true
-              definition.resolve_remotely!
-              
-              definition.specs.each do |spec|
-                if commands = config.delete(spec.name)
-                  commands.each do |command|
-                    method, *args = command
-                    builder.send method, *args
-                    gem_added ||= method == 'gem'
-                  end
-                end
-              end
-
-              break unless gem_added
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/iruby/dependencies/dsl.rb

@@ -1,96 +0,0 @@
-require 'open3'
-
-module IRuby
-  module Dependencies
-    class Dsl < ::Bundler::Dsl
-      def config hash
-        hash.each do |key,value|
-          Bundler.settings[key] = value
-        end
-      end
-
-      def exec string
-        stdout, stderr, exit_status = Open3.capture3(string)
-
-        if exit_status.success?
-          Bundler.ui.info stdout unless stdout.empty?
-          Bundler.ui.warn stderr unless stderr.empty?
-        else
-          puts stdout unless stdout.empty?
-          warn stderr unless stderr.empty?
-          raise "\"exec '#{string}'\" failed on dependency installation"
-        end
-      end
-
-      def eval string
-        super string
-      end
-
-      def css *paths
-        paths.each do |path|
-          url = full_url path
-          html = "<link rel='stylesheet' href='#{url}'>"
-          IRuby.display IRuby.html(html)
-        end
-      end
-
-      def define hash
-        mapped = hash.map do |mod,path|
-          [mod, full_url(path)]
-        end.to_h
-
-        js = <<-JS
-          requirejs.config({
-            map: {
-              '*': #{MultiJson.dump(mapped)}
-            }
-          });
-        JS
-
-        IRuby.display IRuby.javascript(js)
-      end
-
-      def script *paths
-        paths.each do |path|
-          url = full_url path
-          html = "<script src='#{url}'></script>"
-          IRuby.display IRuby.html(html)
-        end
-      end
-
-      def url url
-        @url = url
-      end
-
-      def gem name, *args
-        if version = ACTIVE_GEMS[name]
-          options = args.last.is_a?(Hash) ? args.pop.dup : {}
-
-          unless args.empty? or args == [version]
-            raise GemfileError, "The IRuby runtime has already loaded #{name}-#{version}. If you need a different version, you'll need to install it manually and restart IRuby."
-          else
-            super name, [version], options
-          end
-        else
-          super name, *args
-        end
-      end
-
-      private 
-
-      def full_url path
-        if path[/^https?:/]
-          path
-        else
-          if @url
-            File.join @url, path
-          elsif url = Bundler.settings['dependencies.url']
-            File.join url, path
-          else
-            raise "Cannot inject #{path} without a base url"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/iruby/dependencies/shared_helpers.rb

@@ -1,7 +0,0 @@
-module Bundler
-  # https://github.com/bundler/bundler/issues/4837
-  module SharedHelpers
-    def clean_load_path
-    end
-  end
-end