iruby 0.3 → 0.7.0

data/lib/iruby/display.rb

@@ -1,17 +1,24 @@
+require "set"
+
 module IRuby
   module Display
     class << self
+      # @private
       def convert(obj, options)
         Representation.new(obj, options)
       end
 
+      # @private
       def display(obj, options = {})
         obj = convert(obj, options)
         options = obj.options
         obj = obj.object
 
         fuzzy_mime = options[:format] # Treated like a fuzzy mime type
-        raise 'Invalid argument :format' unless !fuzzy_mime || String === fuzzy_mime
+        unless !fuzzy_mime || String === fuzzy_mime
+          raise 'Invalid argument :format'
+        end
+
         if exact_mime = options[:mime]
           raise 'Invalid argument :mime' unless String === exact_mime
           raise 'Invalid mime type' unless exact_mime.include?('/')
@@ -27,32 +34,54 @@ module IRuby
 
         # As a last resort, interpret string representation of the object
         # as the given mime type.
-        data[exact_mime] = protect(exact_mime, obj) if exact_mime && !data.any? {|m,_| exact_mime == m }
+        if exact_mime && data.none? { |m, _| exact_mime == m }
+          data[exact_mime] = protect(exact_mime, obj)
+        end
 
         data
       end
 
-      def clear_output(wait=false)
-        IRuby::Kernel.instance.session.send(:publish, :clear_output, {wait: wait})
+      # @private
+      def clear_output(wait = false)
+        IRuby::Kernel.instance.session.send(:publish, :clear_output, wait: wait)
       end
 
       private
 
       def protect(mime, data)
-        MimeMagic.new(mime).text? ? data.to_s : [data.to_s].pack('m0')
+        ascii?(mime) ? data.to_s : [data.to_s].pack('m0')
+      end
+
+      # Each of the following mime types must be a text type,
+      # but mime-types library tells us it is a non-text type.
+      FORCE_TEXT_TYPES = Set[
+        "application/javascript",
+        "image/svg+xml"
+      ].freeze
+
+      def ascii?(mime)
+        if FORCE_TEXT_TYPES.include?(mime)
+          true
+        else
+          MIME::Type.new(mime).ascii?
+        end
       end
 
       def render(data, obj, exact_mime, fuzzy_mime)
         # Filter matching renderer by object type
-        renderer = Registry.renderer.select {|r| r.match?(obj) }
+        renderer = Registry.renderer.select { |r| r.match?(obj) }
 
         matching_renderer = nil
 
         # Find exactly matching display by exact_mime
-        matching_renderer = renderer.find {|r| exact_mime == r.mime } if exact_mime
+        if exact_mime
+          matching_renderer = renderer.find { |r| exact_mime == r.mime }
+        end
 
         # Find fuzzy matching display by fuzzy_mime
-        matching_renderer ||= renderer.find {|r| r.mime && r.mime.include?(fuzzy_mime) } if fuzzy_mime
+        if fuzzy_mime
+          matching_renderer ||= renderer.find { |r| r.mime&.include?(fuzzy_mime) }
+        end
 
         renderer.unshift matching_renderer if matching_renderer
 
@@ -73,7 +102,8 @@ module IRuby
       attr_reader :object, :options
 
       def initialize(object, options)
-        @object, @options = object, options
+        @object = object
+        @options = options
       end
 
       class << self
@@ -91,10 +121,13 @@ module IRuby
     end
 
     class Renderer
-      attr_reader :match, :mime, :render, :priority
+      attr_reader :match, :mime, :priority
 
       def initialize(match, mime, render, priority)
-        @match, @mime, @render, @priority = match, mime, render, priority
+        @match = match
+        @mime = mime
+        @render = render
+        @priority = priority
       end
 
       def match?(obj)
@@ -114,7 +147,7 @@ module IRuby
         @renderer ||= []
       end
 
-      SUPPORTED_MIMES = %w(
+      SUPPORTED_MIMES = %w[
         text/plain
         text/html
         text/latex
@@ -122,7 +155,8 @@ module IRuby
         application/javascript
         image/png
         image/jpeg
-        image/svg+xml)
+        image/svg+xml
+      ]
 
       def match(&block)
         @match = block
@@ -131,7 +165,7 @@ module IRuby
       end
 
       def respond_to(name)
-        match {|obj| obj.respond_to?(name) }
+        match { |obj| obj.respond_to?(name) }
       end
 
       def type(&block)
@@ -153,7 +187,7 @@ module IRuby
 
       def format(mime = nil, &block)
         renderer << Renderer.new(@match, mime, block, @priority)
-        renderer.sort_by! {|r| -r.priority }
+        renderer.sort_by! { |r| -r.priority }
 
         # Decrease priority implicitly for all formats
         # which are added later for a type.
@@ -170,6 +204,7 @@ module IRuby
       end
 
       type { Numo::NArray }
+      format 'text/plain', &:inspect
       format 'text/latex' do |obj|
         obj.ndim == 2 ?
         LaTeX.matrix(obj, obj.shape[0], obj.shape[1]) :
@@ -180,6 +215,7 @@ module IRuby
       end
 
       type { NArray }
+      format 'text/plain', &:inspect
       format 'text/latex' do |obj|
         obj.dim == 2 ?
         LaTeX.matrix(obj.transpose(1, 0), obj.shape[1], obj.shape[0]) :
@@ -241,37 +277,41 @@ module IRuby
 
       match do |obj|
         defined?(Magick::Image) && Magick::Image === obj ||
-        defined?(MiniMagick::Image) && MiniMagick::Image === obj
+          defined?(MiniMagick::Image) && MiniMagick::Image === obj
       end
       format 'image' do |obj|
         format = obj.format || 'PNG'
-        [format == 'PNG' ? 'image/png' : 'image/jpeg', obj.to_blob {|i| i.format = format }]
+        [format == 'PNG' ? 'image/png' : 'image/jpeg', obj.to_blob { |i| i.format = format }]
       end
 
-      type { Gruff::Base }
-      format 'image/png' do |obj|
-        obj.to_blob
+      match do |obj|
+        defined?(Vips::Image) && Vips::Image === obj
       end
+      format do |obj|
+        # handles Vips::Error, vips_image_get: field "vips-loader" not found
+        loader = obj.get('vips-loader') rescue nil
+        if loader == 'jpegload'
+          ['image/jpeg', obj.write_to_buffer('.jpg')]
+        else
+          # falls back to png for other/unknown types
+          ['image/png', obj.write_to_buffer('.png')]
+        end
+      end
+
+      type { Gruff::Base }
+      format 'image/png', &:to_blob
 
       respond_to :to_html
-      format 'text/html' do |obj|
-        obj.to_html
-      end
+      format 'text/html', &:to_html
 
       respond_to :to_latex
-      format 'text/latex' do |obj|
-        obj.to_latex
-      end
+      format 'text/latex', &:to_latex
 
       respond_to :to_tex
-      format 'text/latex' do |obj|
-        obj.to_tex
-      end
+      format 'text/latex', &:to_tex
 
       respond_to :to_javascript
-      format 'text/javascript' do |obj|
-        obj.to_javascript
-      end
+      format 'text/javascript', &:to_javascript
 
       respond_to :to_svg
       format 'image/svg+xml' do |obj|
@@ -280,21 +320,17 @@ module IRuby
       end
 
       respond_to :to_iruby
-      format do |obj|
-        obj.to_iruby
-      end
+      format(&:to_iruby)
 
-      match {|obj| obj.respond_to?(:path) && File.readable?(obj.path) }
+      match { |obj| obj.respond_to?(:path) && obj.method(:path).arity == 0 && File.readable?(obj.path) }
       format do |obj|
-        mime = MimeMagic.by_path(obj.path).to_s
+        mime = MIME::Types.of(obj.path).first.to_s
         [mime, File.read(obj.path)] if SUPPORTED_MIMES.include?(mime)
       end
 
       type { Object }
-      priority -1000
-      format 'text/plain' do |obj|
-        obj.inspect
-      end
+      priority(-1000)
+      format 'text/plain', &:inspect
     end
   end
 end

data/lib/iruby/event_manager.rb

@@ -0,0 +1,40 @@
+module IRuby
+  class EventManager
+    def initialize(available_events)
+      @available_events = available_events.dup.freeze
+      @callbacks = available_events.map {|n| [n, []] }.to_h
+    end
+
+    attr_reader :available_events
+
+    def register(event, &block)
+      check_available_event(event)
+      @callbacks[event] << block unless block.nil?
+      block
+    end
+
+    def unregister(event, callback)
+      check_available_event(event)
+      val = @callbacks[event].delete(callback)
+      unless val
+        raise ArgumentError,
+              "Given callable object #{callback} is not registered as a #{event} callback"
+      end
+      val
+    end
+
+    def trigger(event, *args, **kwargs)
+      check_available_event(event)
+      @callbacks[event].each do |fn|
+        fn.call(*args, **kwargs)
+      end
+    end
+
+    private
+
+    def check_available_event(event)
+      return if @callbacks.key?(event)
+      raise ArgumentError, "Unknown event name: #{event}", caller
+    end
+  end
+end

data/lib/iruby/formatter.rb

@@ -78,16 +78,16 @@ module IRuby
 
       if maxcols && keys.size > maxcols
         keys1 = keys[0...maxcols / 2]
-        keys2 = keys[-maxcols / 2...-1]
+        keys2 = keys[-maxcols / 2 + 1..-1]
         if header
           header1 = header[0...maxcols / 2]
-          header2 = header[-maxcols / 2...-1]
+          header2 = header[-maxcols / 2 + 1..-1]
         end
       end
 
       if maxrows && rows.size > maxrows
         rows1 = rows[0...maxrows / 2]
-        rows2 = rows[-maxrows / 2...-1]
+        rows2 = rows[-maxrows / 2 + 1..-1]
       end
 
       table = '<table>'

data/lib/iruby/input.rb

@@ -15,21 +15,21 @@ module IRuby
     end
 
     def form &block
-      builder = Builder.new &block
+      builder = Builder.new(&block)
       form = InputForm.new(
-        fields: builder.fields, 
+        fields: builder.fields,
         buttons: builder.buttons
       )
       form.widget_display
       builder.process_result form.submit
     end
-       
+
     def popup title='Input', &block
-      builder = Builder.new &block
+      builder = Builder.new(&block)
       form = InputForm.new fields: builder.fields
       popup = Popup.new(
-        title: title, 
-        form: form, 
+        title: title,
+        form: form,
         buttons: builder.buttons
       )
       popup.widget_display

data/lib/iruby/input/README.md

@@ -0,0 +1,299 @@
+
+# IRuby Input
+
+This README is generated from README.ipynb. Please do not edit this file directly.
+
+The `IRuby::Input` class makes it easier for IRuby users to get input from users. For example:
+
+
+```ruby
+name = IRuby.input 'Enter your name'
+```
+
+The following input methods are supported on the `IRuby` module:
+
+| method | description |
+| -------- | -------- |
+| `input(prompt)`   | Prompts the user for a line of input |
+| `password(prompt)`   | Prompts the user for a password |
+| `form(&block)`   | Presents a form to the user |
+| `popup(title,&block)`   | Displays a form to the user as a popup |
+
+## Forms
+
+Forms are groups of inputs to be collected from the user. For example:
+
+
+```ruby
+result = IRuby.form do 
+  input :username
+  password :password
+  button
+end
+```
+
+The following methods are available to build forms: 
+
+| method | description |
+| -------- | -------- |
+| `input(key=:input)`   | Prompts the user for a line of input |
+| `textarea(key=:textarea),`   | Adds a textarea to the form |
+| `password(key=:password)`   | Prompts the user for a password |
+| `button(key=:done, color: :blue)`   | Adds a submit button to the form |
+| `cancel(prompt='Cancel')`   | Adds a cancel button to the form |
+| `text(string)`   | Adds text to the form |
+| `html(&block)`   | Inserts HTML from the given [erector block](https://github.com/erector/erector)   |
+| `file(key=:file)`   | Adds a file input to the form |
+| `date(key=:date)`   | Adds a date picker to the form |
+| `select(*options)`   | Adds a dropdown select input to the form |
+| `radio(*options)`   | Adds a radio select input to the form |
+| `checkbox(*options)`   | Adds checkbox inputs to the form |
+
+## Popups
+ 
+Popups are just forms in a bootstrap modal. They are useful when users **Run All** in a notebook with a lot of inputs. The popups always appear in the same spot, so users don't have to scroll down to find the next input. 
+
+Popups accept a `title` argument, for example: 
+
+
+```ruby
+result = IRuby.popup 'Please enter your name' do 
+  input
+  button
+end
+```
+
+## Submit and cancel
+
+The enter key will submit an input or form and the escape key will cancel it. Canceled inputs are returned as `nil`. Inputs are automatically canceled if destroyed. An input can be destroyed by clearing its cell's output. The `cancel` button will cancel a form and all other buttons will submit it. 
+
+After a form destroyed, the cell's output is cleared. Be careful not to prompt for input in a block that has previous output you would like to keep. Output is cleared to prevent forms from interferring with one another and to ensure that inputs are not inadvertently saved to the notebook. 
+
+
+```ruby
+result = IRuby.popup 'Confirm' do 
+  text 'Are you sure you want to continue?'
+  cancel 'No'
+  button 'Yes'
+end
+```
+
+## Custom keys
+
+Every widget has an entry in the final results hash. A custom key can be passed as the first parameter to the hash. If no key is provided, the widget name is used as the key. The `cancel` widget has no key; it's first parameter is its label. 
+
+
+```ruby
+result = IRuby.form do
+  input :username
+  password :password
+end
+```
+
+## Custom labels
+
+Field labels appear to the left of the field. Button labels appear as the text on the button. `cancel` labels are passed as the first argument. All other widgets' labels are set using the `label` parameter. 
+
+
+```ruby
+result = IRuby.form do 
+  input :name, label: 'Please enter your name'
+  cancel 'None of your business!'
+  button :submit, label: 'All done'
+end
+```
+
+## Defaults
+
+Most inputs will accept a `default` parameter. If no default is given, the deault is `nil`. Since checkboxes can have multiple values selected, you can pass an array of values. To check everything, pass `true` as the default. 
+
+
+```ruby
+result = IRuby.form do 
+  checkbox :one, 'Fish', 'Cat', 'Dog', default: 'Fish'
+  checkbox :many, 'Fish', 'Cat', 'Dog', default: ['Cat', 'Dog']
+  checkbox :all, 'Fish', 'Cat', 'Dog', default: true
+  button :submit, label: 'All done'
+end
+```
+
+## Dates
+
+The `date` widget provides a calendar popup and returns a `Time` object. It's default should also be a `Time` object. 
+
+
+```ruby
+result = IRuby.form do 
+  date :birthday
+  date :today, default: Time.now
+  button
+end
+```
+
+## Buttons
+
+Buttons do not appear in the final hash unless they are clicked. If clicked, their value is `true`. Here are the various colors a button can be:
+
+
+```ruby
+result = IRuby.form do 
+  IRuby::Input::Button::COLORS.each_key do |color|
+    button color, color: color
+  end
+end
+```
+
+## Textareas
+
+Textareas are multiline inputs that are convenient for larger inputs. If you need a line return when typing in a textarea, use shift+enter since enter will submit the form.
+
+
+```ruby
+result = IRuby.form do 
+  text 'Enter email addresses, one per line (use shift+enter for newlines)'
+  textarea :emails
+end
+```
+
+## Text and HTML
+
+You can insert lines of text or custom html using their respective helpers:
+
+
+```ruby
+result = IRuby.form do 
+  html { h1 'Choose a Stooge' }
+  text 'Choose your favorite stooge'
+  select :stooge, 'Moe', 'Larry', 'Curly'
+  button
+end
+```
+
+## Dropdowns
+
+A `select` is a dropdown of options. Use a `multiple` to allow multiple selections. `multiple` widgets accept an additional `size` parameters that determines the number of rows. The default is 4. 
+
+
+```ruby
+result = IRuby.form do 
+  select :stooge, 'Moe', 'Larry', 'Curly'
+  select :stooge, 'Moe', 'Larry', 'Curly', default: 'Moe'
+  multiple :stooges, 'Moe', 'Larry', 'Curly', default: true, size: 3
+  multiple :stooges, 'Moe', 'Larry', 'Curly', default: ['Moe','Curly']
+  button
+end
+```
+
+## Radio selects and checkboxes
+
+Like selects, radio selects and checkboxes take multiple arguments, each one an option. If the first argument is a symbol, it is used as the key. 
+
+Note that the `checkbox` widget will always return `nil` or an array. 
+
+
+```ruby
+result = IRuby.form do 
+  radio :children, *(0..12), label: 'How many children do you have?'
+  checkbox :gender, 'Male', 'Female', 'Intersex', label: 'Select the genders of your children'
+  button
+end
+```
+
+## Files
+
+Since file widgets capture the enter key, you should include a button when creating forms that contain only a file input:
+
+
+```ruby
+IRuby.form do 
+  file :avatar, label: 'Choose an Avatar'
+  button :submit
+end
+```
+
+File widgets return a hash with three keys: 
+
+* `data`: The contents of the file as a string
+* `content_type`: The type of file, such as `text/plain` or `image/jpeg`
+* `name`: The name of the uploaded file
+
+## Example
+
+Here is an example form that uses every built-in widget. 
+
+
+```ruby
+result = IRuby.form do 
+  html { h1 'The Everything Form' }
+  text 'Marvel at the strange and varied inputs!'
+  date
+  file
+  input :username
+  password
+  textarea
+  radio *(1..10)
+  checkbox 'Fish', 'Cat', 'Dog', label: 'Animals'
+  select :color, *IRuby::Input::Button::COLORS.keys
+  cancel                     
+  button    
+end
+```
+
+## Writing your own widget
+
+Most form methods are `IRuby::Input::Widget` instances. A `Widget` is an [`Erector::Widget`](https://github.com/erector/erector) with some additional helpers. Here is the `cancel` widget:
+
+```ruby
+module IRuby
+  module Input
+    class Cancel < Widget
+      needs :label
+
+      builder :cancel do |label='Cancel'|
+        add_button Cancel.new(label: label)
+      end
+
+      def widget_css
+        ".iruby-cancel { margin-left: 5px; }"
+      end
+
+      def widget_js
+        <<-JS
+          $('.iruby-cancel').click(function(){
+            $('#iruby-form').remove();
+          });
+        JS
+      end
+
+      def widget_html
+        button(
+          @label,
+          type: 'button', 
+          :'data-dismiss' => 'modal',
+          class: "btn btn-danger pull-right iruby-cancel"
+        )
+      end
+    end
+  end
+end
+```
+
+The following methods are available for widgets to use or override: 
+
+| method | description |
+| -------- | -------- |
+| `widget_js`   | Returns the widget's Javascript |
+| `widget_css`   | Returns the widget's CSS |
+| `widget_html`   | Returns the widget's   |
+| `builder(method,&block)`   | Class method to add form building helpers. |
+
+The following methods are available in the `builder` block:
+
+| method | description |
+| -------- | -------- |
+| `add_field(field)` | Adds a widget to the form's field area |
+| `add_button(button)` | Adds a button to the form's button area |
+| `process(key,&block)`   | Register a custom processing block for the given key in the results hash |
+| `unique_key(key)` | Returns a unique key for the given key. Use this to make sure that there are no key collisions in the final results hash. |
+
+A canceled form always returns `nil`. Otherwise, the form collects any element with a `data-iruby-key` and non-falsey `data-iruby-value` and passes those to the processor proc registered for the key. See the `File` widget for a more involved example of processing results.