irails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc76a46d914cf5aa4b54c6165d94c77b2c40b98
+  data.tar.gz: dec155c6c6712bdb415f239e84e1b22dbab8260f
+SHA512:
+  metadata.gz: 636f4db27153185d8b6b74fc6a6254c40cb171e248009588f943bf67f02d5689b54bba649bbb503a7dfc252ddc7060f1acd61bfd2b94ec76a40b5e19c6ab147e
+  data.tar.gz: f7fe77f37c16cc1f2bfa569a31ddd293bf0e423c25c959497a64ced3e31ff52ed28238696984c5971bcfb7381dc68eec616e4125197adbaddbe6cbd518a249fc

data/.gitignore

@@ -0,0 +1,16 @@
+.ipynb_checkpoints/
+*.gem
+*.rbc
+*.log
+.bundle
+.config
+.yardoc
+Gemfile.lock
+coverage
+doc/
+pkg
+rdoc
+test/tmp
+test/version_tmp
+tmp
+venv

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0
+
+before_install:
+  - "sudo apt-get install libzmq3-dev"
+  - "sudo pip install 'ipython[notebook]'"
+
+script: bundle exec rake
+
+notifications:
+  irc: "chat.freenode.net#sciruby"

data/CONTRIBUTORS

@@ -0,0 +1,19 @@
+Carlos Agarie <carlos.agarie@gmail.com>
+Damián Silvani <munshkr@gmail.com>
+Dangyi Liu <LeedyPKU@gmail.com>
+Daniel Mendler <mail@daniel-mendler.de>
+Dimitris Zorbas <zorbash@skroutz.gr>
+Domitry <domitry@gmail.com>
+Jan Vlnas <git@jan.vlnas.cz>
+John Woods <jwoods@vt.edu>
+Josh Adams <josh@isotope11.com>
+Julia Evans <julia@jvns.ca>
+martin sarsale <martin@properati.com>
+Matthias Bussonnier <bussonniermatthias@gmail.com>
+Michael Hauser-Raspe <michael.hauser-raspe@cantab.net>
+MinRK <benjaminrk@gmail.com>
+Naoki Nishida <domitry@gmail.com>
+Robby Clements <rclements@isotope11.com>
+Spacewander <spacewanderlzx@gmail.com>
+Takahiro Satoh <zalt50cc@gmail.com>
+Robert Haines <robert.haines@manchester.ac.uk>

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+gemspec
+
+group :pry do
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'awesome_print'
+end
+
+group :plot do
+  gem 'gnuplot'
+  gem 'rubyvis'
+  gem 'nyaplot', github: 'domitry/nyaplot'
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2015 IRuby contributors and the Ruby Science Foundation
+
+MIT License
+
+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,46 @@
+# IRails
+
+This is a Ruby kernel for IPython/Jupyter and is part of [SciRuby](http://scirails.com/). You can try it at [try.jupyter.org](http://try.jupyter.org/).
+
+![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
+
+### Quick start
+
+At first install IPython/Jupyter. I recommend an installation using virtualenv.
+
+    apt-get install python3-dev virtualenv libzmq3-dev
+    virtualenv -p python3 venv
+    source venv/bin/activate
+    pip install 'ipython[notebook]'
+
+After that, install the Ruby gem.
+
+    gem install irails
+
+Now you can run irails with:
+
+    irails
+    irails notebook
+
+Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/scirails-notebooks/master/getting_started.ipynb)
+and the [collection of notebooks](https://github.com/SciRuby/scirails-notebooks/) which includes a Dockerfile to create a containerized installation of irails
+and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/scirails-notebooks/).
+
+
+### Required dependencies
+
+* IPython/Jupyter >= 3.0.0
+* libzmq >= 3.2
+* Ruby >= 2.1.0
+
+### Authors
+
+See the [CONTRIBUTORS](CONTRIBUTORS) file.
+
+### License
+
+Copyright © 2013-15, Hiroshi Kajisha, IRuby contributors and the Ruby Science Foundation.
+
+All rights reserved.
+
+IRuby, along with [SciRuby](http://scirails.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+
+begin
+  require 'bundler/gem_tasks'
+rescue Exception
+end
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: 'test'

data/bin/irails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(__dir__ + '/../lib')
+require 'irails/command'
+IRails::Command.new(ARGV).run

data/irails.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/irails/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name          = 'irails'
+  s.date          = Date.today.to_s
+  s.version       = IRails::VERSION
+  s.authors       = ['Hiroshi Kajisha', 'Daniel Mendler', 'The SciRuby developers']
+  s.email         = ['kajisha@gmail.com', 'mail@daniel-mendler.de']
+  s.summary       = 'Rails Kernel for Jupyter'
+  s.description   = 'A Rails kernel for Jupyter frontends (e.g. notebook). Try it at try.jupyter.org.'
+  s.homepage      = 'https://github.com/kajisha/irails'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^test/})
+  s.require_paths = %w(lib)
+
+  m = "Consider installing the optional dependencies to get additional functionality:\n"
+  File.read('Gemfile').scan(/gem\s+'(.*?)'/) { m << "  * #{$1}\n" }
+  s.post_install_message = m << "\n"
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+
+  s.add_runtime_dependency 'bond'
+  s.add_runtime_dependency 'rbczmq'
+  s.add_runtime_dependency 'multi_json'
+  s.add_runtime_dependency 'mimemagic'
+  s.add_runtime_dependency 'rails'
+end

data/lib/irails/assets/kernel.css

@@ -0,0 +1 @@
+/* Placeholder for Ruby kernel.css */

data/lib/irails/assets/kernel.js

@@ -0,0 +1,15 @@
+// Ruby kernel.js
+
+define(['base/js/namespace'], function(IPython) {
+    "use strict";
+    var onload = function() {
+	IPython.CodeCell.options_default['cm_config']['indentUnit'] = 2;
+	var cells = IPython.notebook.get_cells();
+        for (var i in cells){
+            var c = cells[i];
+            if (c.cell_type === 'code')
+                c.code_mirror.setOption('indentUnit', 2);
+        }
+    }
+    return {onload:onload};
+});

data/lib/irails/backend.rb

@@ -0,0 +1,82 @@
+module IRails
+  In, Out = [nil], [nil]
+  ::In, ::Out = In, Out
+
+  module History
+    def eval(code, store_history)
+      b = TOPLEVEL_BINDING
+
+      b.local_variable_set(:_ih, In)  unless b.local_variable_defined?(:_ih)
+      b.local_variable_set(:_oh, Out) unless b.local_variable_defined?(:_oh)
+
+      out = super
+
+      # TODO Add IRails.cache_size which controls the size of the Out array
+      # and sets the oldest entries and _<n> variables to nil.
+      if store_history
+        b.local_variable_set("_#{Out.size}", out)
+        b.local_variable_set("_i#{In.size}", code)
+
+        Out << out
+        In << code
+
+        b.local_variable_set(:___,  Out[-3])
+        b.local_variable_set(:__,   Out[-2])
+        b.local_variable_set(:_,    Out[-1])
+        b.local_variable_set(:_iii, In[-3])
+        b.local_variable_set(:_ii,  In[-2])
+        b.local_variable_set(:_i,   In[-1])
+      end
+
+      out
+    end
+  end
+
+  class PlainBackend
+    prepend History
+
+    def initialize
+      require 'bond'
+      Bond.start(debug: true)
+    end
+
+    def eval(code, store_history)
+      TOPLEVEL_BINDING.eval(code)
+    end
+
+    def complete(code)
+      Bond.agent.call(code, code)
+    end
+  end
+
+  class PryBackend
+    prepend History
+
+    def initialize
+      require 'pry'
+      Pry.pager = false # Don't use the pager
+      Pry.print = proc {|output, value|} # No result printing
+      Pry.exception_handler = proc {|output, exception, _| }
+      reset
+    end
+
+    def eval(code, store_history)
+      @pry.last_result = nil
+      unless @pry.eval(code)
+        reset
+        raise SystemExit
+      end
+      raise @pry.last_exception if @pry.last_result_is_exception?
+      @pry.push_initial_binding unless @pry.current_binding # ensure that we have a binding
+      @pry.last_result
+    end
+
+    def complete(code)
+      @pry.complete(code)
+    end
+
+    def reset
+      @pry = Pry.new(output: $stdout, target: TOPLEVEL_BINDING)
+    end
+  end
+end

data/lib/irails/comm.rb

@@ -0,0 +1,46 @@
+module IRails
+  # Comm is a new messaging system for bidirectional communication.
+  # Both kernel and front-end listens for messages.
+  class Comm
+    attr_writer :on_msg, :on_close
+
+    class << self
+      def target; @target ||= {} end
+      def comm;   @comm   ||= {} end
+    end
+
+    def initialize(target_name, comm_id = SecureRandom.uuid)
+      @target_name, @comm_id = target_name, comm_id
+    end
+
+    def open(**data)
+      Kernel.instance.session.send(:publish, :comm_open, comm_id: @comm_id, data: data, target_name: @target_name)
+      Comm.comm[@comm_id] = self
+    end
+
+    def send(**data)
+      Kernel.instance.session.send(:publish, :comm_msg, comm_id: @comm_id, data: data)
+    end
+
+    def close(**data)
+      Kernel.instance.session.send(:publish, :comm_close, comm_id: @comm_id, data: data)
+      Comm.comm.delete(@comm_id)
+    end
+
+    def on_msg(&b)
+      @on_msg = b
+    end
+
+    def on_close(&b)
+      @on_close = b
+    end
+
+    def handle_msg(data)
+      @on_msg.call(data) if @on_msg
+    end
+
+    def handle_close(data)
+      @on_close.call(data) if @on_close
+    end
+  end
+end

data/lib/irails/command.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+require 'multi_json'
+
+module IRails
+  class Command
+    def initialize(args)
+      @args = args
+
+      ipython_dir = ENV['IPYTHONDIR'] || '~/.ipython'
+      @args.each do |arg|
+        ipython_dir = $1 if arg =~ /\A--ipython-dir=(.*)\Z/
+      end
+      @kernel_dir = File.join(File.expand_path(ipython_dir), 'kernels', 'rails')
+      @kernel_file = File.join(@kernel_dir, 'kernel.json')
+      @irails_path = File.expand_path $0
+
+      require './config/boot'
+      require './config/application'
+
+      Rails.application.require_environment!
+    end
+
+    def run
+      case @args.first
+      when 'version', '-v', '--version'
+        require 'irails/version'
+        puts "IRails #{IRails::VERSION}, Rails #{Rails.version}"
+      when 'help', '-h', '--help'
+        print_help
+      when 'register'
+        if registered_irails_path && !@args.include?('--force')
+          STDERR.puts "#{@kernel_file} already exists!\nUse --force to force a register."
+          exit 1
+        end
+        register_kernel
+      when 'unregister'
+        unregister_kernel
+      when 'kernel'
+        run_kernel
+      else
+        run_ipython
+      end
+    end
+
+    private
+
+    def print_help
+      puts %{
+Usage:
+    irails register        Register IRails kernel in #{@kernel_file}.
+    irails unregister      Unregister IRails kernel.
+    irails console         Launch the IRails terminal-based console.
+    irails notebook        Launch the IRails HTML notebook server.
+    ...                   Same as IPython.
+
+Please note that IRails accepts the same parameters as IPython.
+Try `ipython help` for more information.
+}
+    end
+
+    def run_kernel
+      require 'irails/logger'
+      IRails.logger = MultiLogger.new(*Logger.new(STDOUT))
+      @args.reject! {|arg| arg =~ /\A--log=(.*)\Z/ && IRails.logger.loggers << Logger.new($1) }
+      IRails.logger.level = @args.delete('--debug') ? Logger::DEBUG : Logger::INFO
+
+      raise(ArgumentError, 'Not enough arguments to the kernel') if @args.size < 2 || @args.size > 4
+      config_file, boot_file, working_dir = @args[1..-1]
+      Dir.chdir(working_dir) if working_dir
+
+      require boot_file if boot_file
+      check_bundler {|e| IRails.logger.warn "Could not load bundler: #{e.message}\n#{e.backtrace.join("\n")}" }
+
+      require 'irails'
+      Kernel.new(config_file).run
+    rescue Exception => e
+      IRails.logger.fatal "Kernel died: #{e.message}\n#{e.backtrace.join("\n")}"
+      raise
+    end
+
+    def check_version
+      required = '3.0.0'
+      version = `ipython --version`.chomp
+      if version < required
+        STDERR.puts "Your IPython version #{version} is too old, at least #{required} is required"
+        exit 1
+      end
+    end
+
+    def run_ipython
+      # If no command is given, we use the console to launch the whole 0MQ-client-server stack
+      @args = %w(console) + @args if @args.first.to_s !~ /\A\w/
+      @args += %w(--kernel ruby) if %w(console qtconsole).include? @args.first
+
+      check_version
+      check_registered_kernel
+      check_bundler {|e| STDERR.puts "Could not load bundler: #{e.message}" }
+
+      Kernel.exec('ipython', *@args)
+    end
+
+    def check_registered_kernel
+      if kernel = registered_irails_path
+        STDERR.puts "#{@irails_path} differs from registered path #{registered_irails_path}.
+This might not work. Run 'irails register --force' to fix it." if @irails_path != kernel
+      else
+        register_kernel
+      end
+    end
+
+    def check_bundler
+      require 'bundler'
+      raise %q{irails is missing from Gemfile. This might not work.
+Add `gem 'irails'` to your Gemfile to fix it.} unless Bundler.definition.dependencies.any? {|s| s.name == 'irails' }
+      Bundler.setup
+    rescue LoadError
+    rescue Exception => e
+      yield(e)
+    end
+
+    def register_kernel
+      FileUtils.mkpath(@kernel_dir)
+      File.write(@kernel_file, MultiJson.dump(argv: [ @irails_path, 'kernel', '{connection_file}' ],
+                                              display_name: "Rails #{::Rails.version}", language: 'ruby'))
+      FileUtils.copy(Dir[File.join(__dir__, 'assets', '*')], @kernel_dir) rescue nil
+    end
+
+    def registered_irails_path
+      File.exist?(@kernel_file) && MultiJson.load(File.read(@kernel_file))['argv'].first
+    end
+
+    def unregister_kernel
+      FileUtils.rm_rf(@kernel_dir)
+    end
+  end
+end