ipynbdiff 0.4.4 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1021a6b462ff49958069aea089dabfacd7ded6858bfc49c581dfcc03330405
-  data.tar.gz: 93ecedada6270a3f217349ef073b8f52950793e2f2197d2a0ca3254a5c2acd02
+  metadata.gz: '09eee5bd0bb92f76cdabc67bd9b4ac1050756f952f9b5a3b91aaef984f860b87'
+  data.tar.gz: d89a1289023f1c44af159847a91f9139746a9c0846de169494f6438917754ca4
 SHA512:
-  metadata.gz: 29cedcb6c846d5d320425e9edf0f5f1a30bbbcdbcfaeb648b6568a6c884d60120c40926a8b30632eeff7d5892654c8b0ebe0433e9a8f03d14d2b8e6ad407ce4d
-  data.tar.gz: 85b7b9e9b3390f1484426bdb75143aebbf1f7bd2083b0c939df7d4e1e83a43f9346231c25f925ef9187ce54612ab7d202327f197c0cdb8916457913d226c9807
+  metadata.gz: 24b0b3fa46237a5b2fff8ef253b1dc2b90d5c8650c406097dd86e525e3e8bd5d89568b9280897d85c88444eb993ce3f490b15b0c741dd57dbea6e227dce2abea
+  data.tar.gz: a61bedd1f3b227f1b06dc97ed40ba19136fe4b157b9c0767887bbf22ee036bbbdfb21db3311c4b07a0e7ba39310f4cf8abd37dc8e7973c2035462478428bdd75

data/README.md

@@ -1,19 +1,18 @@
 # IpynbDiff: Better diff for Jupyter Notebooks
 
-This is a simple diff tool that cleans up jupyter notebooks, transforming each [notebook](example/1/from.ipynb)
+This is a simple diff tool that cleans up Jupyter notebooks, transforming each [notebook](example/1/from.ipynb)
 into a [readable markdown file](example/1/from_html.md), keeping the output of cells, and running the
 diff after. Markdowns are generated using an opinionated Jupyter to Markdown conversion. This means
 that the entire file is readable on the diff.
 
 The result are diffs that are much easier to read:
 
-| Diff | | IpynbDiff |  
-| ------ |  ------ |
-| [Here](example/diff.txt) |  [Here](example/ipynbdiff_percent.txt) |
-| ![](example/img/diff.png) |  ![](example/img/ipynbdiff_percent.png) | 
+| Diff                                | IpynbDiff                                             |
+| ----------------------------------- | ----------------------------------------------------- |
+| [Diff text](example/diff.txt)       | [IpynbDiff text](example/ipynbdiff_percent.txt)       |
+| ![Diff image](example/img/diff.png) | ![IpynbDiff image](example/img/ipynbdiff_percent.png) |
 
-
-This started as a port of This is a port of [ipynbdiff](https://gitlab.com/gitlab-org/incubation-engineering/mlops/ipynbdiff), 
+This started as a port of [ipynbdiff](https://gitlab.com/gitlab-org/incubation-engineering/mlops/poc/ipynbdiff),
 but now has extended functionality although not working as git driver.
 
 ## Usage

data/lib/ipynb_symbol_map.rb

@@ -27,6 +27,8 @@ module IpynbDiff
     end
 
     def parse(prefix = '.')
+      raise_if_file_ended
+
       skip_whitespaces
 
       if (c = current_char) == '"'
@@ -50,6 +52,8 @@ module IpynbDiff
       current_should_be '['
 
       loop do
+        raise_if_file_ended
+
         break if skip_beginning(']')
 
         new_prefix = "#{prefix}.#{i}"
@@ -68,6 +72,8 @@ module IpynbDiff
       current_should_be '{'
 
       loop do
+        raise_if_file_ended
+
         break if skip_beginning('}')
 
         prop_name = parse_string(return_value: true)
@@ -97,9 +103,9 @@ module IpynbDiff
       loop do
         increment_char_index
 
-        break if @char_idx > @chars.length
+        raise_if_file_ended
 
-        if current_char == '"' && prev_char != '\\'
+        if current_char == '"' && !prev_backslash?
           init_idx += 1
           break
         end
@@ -113,11 +119,12 @@ module IpynbDiff
     end
 
     def parse_value
-      increment_char_index until VALUE_STOPPERS.include?(current_char)
+      increment_char_index until raise_if_file_ended || VALUE_STOPPERS.include?(current_char)
     end
 
     def skip_whitespaces
       while WHITESPACE_CHARS.include?(current_char)
+        raise_if_file_ended
         check_for_new_line
         increment_char_index
       end
@@ -133,11 +140,13 @@ module IpynbDiff
     end
 
     def current_char
+      raise_if_file_ended
+
       @chars[@char_idx]
     end
 
-    def prev_char
-      @chars[@char_idx - 1]
+    def prev_backslash?
+      @chars[@char_idx - 1] == '\\' && @chars[@char_idx - 2] != '\\'
     end
 
     def current_should_be(another_char)
@@ -148,7 +157,13 @@ module IpynbDiff
       @current_line += 1 if current_char == "\n"
     end
 
+    def raise_if_file_ended
+      @char_idx >= @chars.size && raise(InvalidTokenError)
+    end
+
     def skip
+      raise_if_file_ended
+
       skip_whitespaces
 
       if (c = current_char) == '"'
@@ -164,6 +179,8 @@ module IpynbDiff
 
     def skip_array
       loop do
+        raise_if_file_ended
+
         break if skip_beginning(']')
 
         skip
@@ -173,6 +190,8 @@ module IpynbDiff
     def skip_object
 
       loop do
+        raise_if_file_ended
+
         break if skip_beginning('}')
 
         parse_string

data/lib/ipynbdiff.rb

@@ -5,18 +5,18 @@ module IpynbDiff
   require 'transformer'
   require 'diff'
 
-  def self.diff(from, to, raise_if_invalid_nb: false, include_frontmatter: false, diffy_opts: {})
-    transformer = Transformer.new(include_frontmatter: include_frontmatter)
+  def self.diff(from, to, raise_if_invalid_nb: false, include_frontmatter: false, hide_images: false, diffy_opts: {})
+    transformer = Transformer.new(include_frontmatter: include_frontmatter, hide_images: hide_images)
 
     Diff.new(transformer.transform(from), transformer.transform(to), diffy_opts)
   rescue InvalidNotebookError
     raise if raise_if_invalid_nb
   end
 
-  def self.transform(notebook, raise_errors: false, include_frontmatter: true)
+  def self.transform(notebook, raise_errors: false, include_frontmatter: true, hide_images: false)
     return unless notebook
 
-    Transformer.new(include_frontmatter: include_frontmatter).transform(notebook).as_text
+    Transformer.new(include_frontmatter: include_frontmatter, hide_images: hide_images).transform(notebook).as_text
   rescue InvalidNotebookError
     raise if raise_errors
   end

data/lib/output_transformer.rb

@@ -6,12 +6,18 @@ module IpynbDiff
     require 'symbolized_markdown_helper'
     include SymbolizedMarkdownHelper
 
+    HIDDEN_IMAGE_OUTPUT = '    [Hidden Image Output]'
+
     ORDERED_KEYS = {
       'execute_result' => %w[image/png image/svg+xml image/jpeg text/markdown text/latex text/plain],
       'display_data' => %w[image/png image/svg+xml image/jpeg text/markdown text/latex],
       'stream' => %w[text]
     }.freeze
 
+    def initialize(hide_images: false)
+      @hide_images = hide_images
+    end
+
     def transform(output, symbol)
       transformed = case (output_type = output['output_type'])
                     when 'error'
@@ -52,24 +58,22 @@ module IpynbDiff
       new_symbol = symbol_prefix / output_type
       case output_type
       when 'image/png', 'image/jpeg'
-        transform_image(output_type, output_element, new_symbol)
+        transform_image(output_type + ';base64', output_element, new_symbol)
       when 'image/svg+xml'
-        transform_svg(output_element, new_symbol)
+        transform_image(output_type + ';utf8', output_element, new_symbol)
       when 'text/markdown', 'text/latex', 'text/plain', 'text'
         transform_text(output_element, new_symbol)
       end
     end
 
     def transform_image(image_type, image_content, symbol)
-      _(symbol, "    ![](data:#{image_type};base64,#{image_content.gsub("\n", '')})")
-    end
+      return _(nil, HIDDEN_IMAGE_OUTPUT) if @hide_images
 
-    def transform_svg(image_content, symbol)
       lines = image_content.is_a?(Array) ? image_content : [image_content]
 
       single_line = lines.map(&:strip).join.gsub(/\s+/, ' ')
 
-      _(symbol, "    ![](data:image/svg+xml;utf8,#{single_line})")
+      _(symbol, "    ![](data:#{image_type},#{single_line})")
     end
 
     def transform_text(text_content, symbol)

data/lib/transformer.rb

@@ -17,9 +17,10 @@ module IpynbDiff
     @include_frontmatter = true
     @objects_to_ignore = ['application/javascript', 'application/vnd.holoviews_load.v0+json']
 
-    def initialize(include_frontmatter: true)
+    def initialize(include_frontmatter: true, hide_images: false)
       @include_frontmatter = include_frontmatter
-      @output_transformer = OutputTransformer.new
+      @hide_images = hide_images
+      @output_transformer = OutputTransformer.new(hide_images: hide_images)
     end
 
     def validate_notebook(notebook)

data/lib/version.rb

@@ -1,5 +1,5 @@
 # lib/emoticon/version.rb
 
 module IpynbDiff
-  VERSION = "0.4.4"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipynbdiff
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.7
 platform: ruby
 authors:
 - Eduardo Bonet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy