jupyter_on_rails 0.7.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4dd954da8ae0ebe5bad32d7b98acb1dbde79b0f3b6bcd837d019f11085b50f8
-  data.tar.gz: 992c4ab71f53ba0b59752558e7cbaf932de72e9d6db4ac38a4ab5bef595b655c
+  metadata.gz: 84b32009995240fae40e2d80e6a68039ed673f69fe96817b12351e2ee68ef379
+  data.tar.gz: 0bf6f03122bfbe572a61cefb2fbda365bda43e935c199a38fa0e8c2780a9f991
 SHA512:
-  metadata.gz: 48132a0169aad90d07c55297efe02ff154f0883be55efb47380578c3b1c7c953f18b4ab8dd2ad9325af556ce8b92134e2733e7f14472a0d0e29ea6b763c3868c
-  data.tar.gz: 516169086976ad9770c374f0fb481f2b12c6c8cd04b5688e6752f7c72110bd76dd3b459be1d64915829582e1c701d1d0633ae6a726125db296ceaa1731938215
+  metadata.gz: 0ae8424810f441ce8b5aac30a7fce4333a20309fe02b5eee48675c7b1968a74b50b5b5afbaf36019c25c1165f625d6659fa0b7a7f38872d6c1b212d0d66e5b33
+  data.tar.gz: 3c54d670bbd7961a0f82a7e5786e8240d00e3ea28ca5ec372015db907f9ef94b615465d97bb7037053a5b8bfcc178539ef0422a379e0775102eb2f1acbaf1470

data/.rubocop.yml

@@ -1,3 +1,6 @@
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 160
 
@@ -13,6 +16,12 @@ Metrics/AbcSize:
 Metrics/MethodLength:
   Max: 60
 
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
 Style/MultilineTernaryOperator:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jupyter_on_rails (0.7.0)
+    jupyter_on_rails (0.10.0)
       daru
       iruby
       railties
@@ -9,113 +9,176 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3)
-      actionview (= 6.0.3)
-      activesupport (= 6.0.3)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3)
-      activesupport (= 6.0.3)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    backports (3.17.1)
-    bond (0.5.1)
+    ast (2.4.2)
+    async (1.29.0)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.56.2)
+      async (~> 1.25)
+      async-io (~> 1.28)
+      async-pool (~> 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+    async-http-faraday (0.9.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.31.0)
+      async (~> 1.14)
+    async-pool (0.3.6)
+      async (~> 1.25)
+    backports (3.21.0)
     builder (3.2.4)
-    bump (0.9.0)
-    concurrent-ruby (1.1.6)
+    bump (0.10.0)
+    concurrent-ruby (1.1.9)
+    console (1.12.0)
+      fiber-local
     crass (1.0.6)
-    daru (0.2.2)
-      backports
-      packable (~> 1.3.9)
+    daru (0.3)
+      packable (~> 1.3.13)
     data_uri (0.1.0)
-    erubi (1.9.0)
-    faraday (1.0.1)
+    erubi (1.10.0)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
-    github_changelog_generator (1.15.2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    ffi (1.15.4)
+    ffi-rzmq (2.0.7)
+      ffi-rzmq-core (>= 1.0.7)
+    ffi-rzmq-core (1.0.7)
+      ffi
+    fiber-local (1.0.0)
+    github_changelog_generator (1.16.3)
       activesupport
+      async (>= 1.25.0)
+      async-http-faraday
       faraday-http-cache
       multi_json
       octokit (~> 4.6)
       rainbow (>= 2.2.1)
       rake (>= 10.0)
       retriable (~> 3.0)
-    i18n (1.8.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    iruby (0.4.0)
-      bond (~> 0.5)
+    io-console (0.5.9)
+    irb (1.3.7)
+      reline (>= 0.2.7)
+    iruby (0.7.4)
       data_uri (~> 0.1)
-      mimemagic (~> 0.3)
+      ffi-rzmq
+      irb
+      mime-types (>= 3.3.1)
       multi_json (~> 1.11)
-    loofah (2.5.0)
+      native-package-installer
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    multi_json (1.14.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    octokit (4.18.0)
+    native-package-installer (1.1.1)
+    nio4r (2.5.7)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    packable (1.3.13)
+    packable (1.3.15)
       backports
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    public_suffix (4.0.5)
-    rack (2.2.2)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.0)
+    protocol-http1 (0.14.1)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    public_suffix (4.0.6)
+    racc (1.6.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3)
-      actionpack (= 6.0.3)
-      activesupport (= 6.0.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    reline (0.2.7)
+      io-console (~> 0.5)
     retriable (3.1.2)
-    rexml (3.2.4)
-    rubocop (0.83.0)
+    rexml (3.2.5)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.6.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    thor (1.1.0)
+    timers (4.3.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -128,4 +191,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -14,7 +14,10 @@ managing the jupyter configuration installed in user global area (the iruby kern
 
 With this gem, these awkwardness is to solved by following instruments:
   * `rake jupyter:notebook` Railtie command which invokes jupyter at your project root, and
-  * The rails kernel dynamically defined by the rake task which automatically loads your Rails application.
+  * This rake task automatically creates two `iruby` kernels to load your application in Jupyter:
+    * one for normal operation
+    * one for sandbox mode in which everything you do is wrapped in a database transaction that is rolled back when the
+      kernel exits (equivalent to `rails console --sandbox`)
 
 
 ## Prerequisites

data/jupyter_on_rails.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0")
-                     .reject { |f| f.match(%r{^(test|spec|features)/}) }
-                     .reject { |f| f.match(/\.png$/) }
+                     .reject { |f| f.match(%r{^(test|spec|features|\.github)/}) }
+                     .reject { |f| f.match(/(\.gitignore|\.png)$/) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/jupyter_on_rails/{iruby_kernel_extention.rb → initializer.rb}

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
 module JupyterOnRails
-  module IRubyKernelExtention
-    class << self
-      attr_accessor :root, :sandbox
-    end
-
-    def run
+  module Initializer
+    def self.run(root:, sandbox:)
       # Load Daru extensions
       begin
         require 'daru'
@@ -25,22 +21,18 @@ module JupyterOnRails
       end
 
       original = Dir.pwd
-      root = IRubyKernelExtention.root
       Dir.chdir root
       app_file = File.expand_path('config/environment.rb', root)
       require app_file
       Rails.application.require_environment!
       Dir.chdir original
 
-      if IRubyKernelExtention.sandbox
-        ActiveRecord::Base.connection.begin_transaction(joinable: false)
+      return unless sandbox
 
-        at_exit do
-          ActiveRecord::Base.connection.rollback_transaction
-        end
+      ActiveRecord::Base.connection.begin_transaction(joinable: false)
+      at_exit do
+        ActiveRecord::Base.connection.rollback_transaction
       end
-
-      super
     end
   end
 end

data/lib/jupyter_on_rails/kernel.rb

@@ -20,12 +20,25 @@ module JupyterOnRails
     end
 
     def load_extensions
-      require_relative 'iruby_kernel_extention'
-      JupyterOnRails::IRubyKernelExtention.root = @root
-      JupyterOnRails::IRubyKernelExtention.sandbox = @sandbox
+      require_relative 'initializer'
 
       require 'iruby'
-      IRuby::Kernel.instance_eval { prepend JupyterOnRails::IRubyKernelExtention }
+      IRuby::Kernel.events.register(:initialized) do |_kernel|
+        JupyterOnRails::Initializer.run(root: @root, sandbox: @sandbox)
+      end
+
+      IRuby::Display::Registry.instance_eval do
+        match do |obj|
+          obj.is_a?(ActiveRecord::Relation) ||
+            obj.is_a?(::Class) && obj < ActiveRecord::Base && !obj.abstract_class
+        end
+        priority 100
+        format 'text/html' do |obj|
+          n = 10
+          puts "finding top #{n}"
+          obj.limit(n).to_df.to_html
+        end
+      end
     end
   end
 end

data/lib/jupyter_on_rails/railtie/jupyter.rake

@@ -12,7 +12,13 @@ namespace :jupyter do
 
     env = { 'JUPYTER_DATA_DIR' => ipython_dir.to_s }
     commands = %w[jupyter notebook]
-    commands = %w[pipenv run] + commands if (Rails.root / 'Pipfile').exist?
+
+    if (Rails.root / 'pyproject.toml').exist?
+      commands = %w[poetry run] + commands
+    elsif (Rails.root / 'Pipfile').exist?
+      commands = %w[pipenv run] + commands
+    end
+
     Process.exec(env, *commands)
   end
 
@@ -21,6 +27,12 @@ namespace :jupyter do
     root = Rails.root
     ipython_dir = ENV['JUPYTER_DATA_DIR'] || ENV['IPYTHONDIR'] || root / '.ipython'
     ipython_dir = File.absolute_path(ipython_dir.to_s)
+    application_module =
+      if Rails::VERSION::MAJOR >= 6
+        Rails.application.class.module_parent
+      else
+        Rails.application.class.parent
+      end
 
     sh "JUPYTER_DATA_DIR=#{Shellwords.shellescape(ipython_dir.to_s)} bundle exec iruby register --force"
 
@@ -35,7 +47,7 @@ namespace :jupyter do
       kernel_file = File.expand_path("kernels/#{cfg.kernel_name}/kernel.json", ipython_dir.to_s)
       kernel_h = JSON.parse(File.read(kernel_file))
       kernel_h['argv'] << File.expand_path(cfg.boot_file, __dir__)
-      kernel_h['display_name'] = "#{Rails.application.class.parent} (rails #{Rails.version}#{cfg.name_ext})"
+      kernel_h['display_name'] = "#{application_module} (rails #{Rails.version}#{cfg.name_ext})"
       kernel_h['env'] ||= {}
       kernel_h['env']['RAILS_ROOT'] = root.to_s
 

data/lib/jupyter_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JupyterOnRails
-  VERSION = '0.7.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jupyter_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Yuki INOUE
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -115,9 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -133,7 +130,7 @@ files:
 - lib/jupyter_on_rails/boot_sandbox.rb
 - lib/jupyter_on_rails/daru/active_record_ext.rb
 - lib/jupyter_on_rails/daru/data_frame_ext.rb
-- lib/jupyter_on_rails/iruby_kernel_extention.rb
+- lib/jupyter_on_rails/initializer.rb
 - lib/jupyter_on_rails/kernel.rb
 - lib/jupyter_on_rails/railtie.rb
 - lib/jupyter_on_rails/railtie/jupyter.rake
@@ -144,7 +141,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Yuki-Inoue/jupyter_on_rails
   source_code_uri: https://github.com/Yuki-Inoue/jupyter_on_rails
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Integrate jupyter into rails
 test_files: []

data/.github/FUNDING.yml

@@ -1,2 +0,0 @@
-
-issuehunt: yuki-inoue

data/.github/workflows/ruby.yml

@@ -1,29 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.7.1
-    # https://github.com/actions/cache/blob/master/examples.md#ruby---bundler
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3 --path vendor/bundle
-        bundle exec rubocop

data/.gitignore

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