iruby-dependencies 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d776a0bfc545dece58b742386bcee7eecb9c4069
+  data.tar.gz: e71834db955a0085aafa2380abde5b25602294f3
+SHA512:
+  metadata.gz: e8a0c38a50b91bb020a58987cc117756bcf18381045e0d646456a27fe07a6f24beea8f5899e0d350ea58fb4e12bfc175bbff39dd20dd36ccb275307d98fa4cd0
+  data.tar.gz: 0be6783def0c53f6cf176225f14af3f9cec3de9371f8a5914e2ef2c93598014dccfa5aed2f2da6bba25e330178e3878567b3bee9fecc33e9596a78b43e6ccd7c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iruby-dependencies.gemspec
+gemspec
+
+gem 'pry', group: 'development'
+gem 'ffi-rzmq', group: 'development'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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,44 @@
+# IRuby::Dependencies
+
+IRuby::Dependencies is a module for injecting Ruby dependencies into Jupyter Notebooks. For example, 
+
+```ruby 
+require 'iruby/dependencies'
+
+dependencies do 
+  gem 'http'
+  gem 'addressable'
+end
+```
+
+## Installation
+
+```bash
+$ gem install iruby-dependencies
+```
+
+You'll have to restart any IRuby kernels already running. 
+
+## 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` | 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: 
+
+```
+dependencies verbose: true do 
+  gem 'http'
+  gem 'addressable'
+end
+```
+
+## Active Gems
+
+Gems active at the time IRuby::Dependencies are added to the dependency bundle. This means that you cannot specify a different version of a gem already being used by IRuby. If you really need a different version of that gem, install it on the command line and restart the kernel.  

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iruby/dependencies"
+
+# 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

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/iruby-dependencies.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iruby/dependencies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iruby-dependencies"
+  spec.version       = IRuby::Dependencies::VERSION
+  spec.authors       = ["Kyle King"]
+  spec.email         = ["kylejking@gmail.com"]
+
+  spec.summary       = %q{IRuby::Dependencies is a module for injecting Ruby dependencies into Jupyter Notebooks}
+  spec.homepage      = "https://github.com/kylekyle/iruby-dependencies"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "iruby"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/iruby/dependencies.rb

@@ -0,0 +1,77 @@
+require 'bundler'
+require 'iruby/dependencies/dsl'
+require 'iruby/dependencies/config'
+require 'iruby/dependencies/version'
+
+module IRuby
+  module Dependencies
+    paths = Gem.path.map {|p| File.join p, 'gems'}
+
+    ACTIVE_GEMS = $LOAD_PATH.each_with_object({}) do |path,hash|
+      paths.each do |gem_path|
+        match = path.match /#{gem_path}\/((?:\w|-)+)-((?:\d+\.?)+)/
+        hash.merge! Hash[*match.captures] unless match.nil?
+      end
+    end
+
+    # this code is taken from bundler/inline with small changes
+    def self.dependencies verbose: false, &gemfile
+      warn 'Dependencies installing. This could take a minute ...'
+
+      Bundler.ui = verbose ? Bundler::UI::Shell.new : nil
+
+      if Bundler.settings['dependencies.mypki']
+        require 'mypki'
+        MyPKI.init
+      end
+
+      old_root = Bundler.method(:root)
+      
+      def Bundler.root
+        Bundler::SharedHelpers.pwd.expand_path
+      end
+      
+      ENV['BUNDLE_GEMFILE'] ||= 'Gemfile'
+
+      builder = Dsl.new
+      builder.instance_eval(&gemfile)
+
+      Gem.sources.each {|s| builder.source s}
+
+      ACTIVE_GEMS.each do |name,version|
+        builder.gem name, version
+      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)
+
+      html = IRuby.html <<-HTML
+        <div style='
+          margin: -0.4em; 
+          padding: 0.4em; 
+          background: rgba(0, 255, 0, .3); 
+          font-family: monospace;
+        '>
+          Dependencies successfully installed.
+        </div>
+      HTML
+
+      IRuby.display html; nil
+    end
+  end
+end
+
+def dependencies *args, &block
+  IRuby::Dependencies.dependencies *args, &block
+end

data/lib/iruby/dependencies/config.rb

@@ -0,0 +1,45 @@
+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.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

@@ -0,0 +1,96 @@
+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/version.rb

@@ -0,0 +1,5 @@
+module IRuby
+  module Dependencies
+    VERSION = "2.0.0"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: iruby-dependencies
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Kyle King
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- kylejking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iruby-dependencies.gemspec
+- lib/iruby/dependencies.rb
+- lib/iruby/dependencies/config.rb
+- lib/iruby/dependencies/dsl.rb
+- lib/iruby/dependencies/version.rb
+homepage: https://github.com/kylekyle/iruby-dependencies
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: IRuby::Dependencies is a module for injecting Ruby dependencies into Jupyter
+  Notebooks
+test_files: []