ipynbdiff 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c011ed4790dc548b33d6e4773bb9bbdaedd7b8c1ffbdbcfa5e494e5380b1a9
-  data.tar.gz: 70f78c722ddc432576ec52d55617e4ce5bdf29cb7ff32ad46219ac52d0d6f5d5
+  metadata.gz: 10f77cf53513157724c6e1d8c8abc4659e3254dd77c3c14ebb2aaabd3155639c
+  data.tar.gz: 10815dc6a9cb76c73b4d6c9f712bdb28be9217a2b40efbcf076342e9f5d34811
 SHA512:
-  metadata.gz: 757f9ea284f358771835db2e27ebe90cb5c8c99336313a65d04cbd0080c0891e1c25af79740cb4d191eeafec10e66c74baceef1ba24729b6ba6f743d502564fa
-  data.tar.gz: 35866e056ae8f4ab043bd9cc247f6c3f8dc3b02d475e94221ca11352badf1e96cf840e8020553ffa8c32b1359f967c74ccc67e0f4abda376e8a035d027871daf
+  metadata.gz: 06e895b990e7099d094b6e78c8a54fc6e5c618b28a9ae266cdb47a127189d67df7a7468f5a96fb2da21529f30911dfca761d7e4b0fc5452fc351e1878c697811
+  data.tar.gz: 54ee8fb62e05b130b304989787ee1032ffe41a2dc68dcdfde5bf7480588bdcd3a4f9a20c3b63eeb7cf21dd0ed89527b34d39a7ec15170f7cddda6114ea8fac0a

data/ipynbdiff.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ipynbdiff'
-  s.version     = '0.3.5'
+  s.version     = '0.3.6'
   s.summary     = 'Human Readable diffs for Jupyter Notebooks'
   s.description = 'Better diff for Jupyter Notebooks by first preprocessing them and removing clutter'
   s.authors     = ['Eduardo Bonet']

data/lib/output_transformer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module IpynbDiff
+
+  # Transforms Jupyter output data into markdown
+  class OutputTransformer
+
+    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]
+    }.freeze
+
+    def transform(output)
+      case (output_type = output['output_type'])
+      when 'error'
+        transform_error(output['traceback'])
+      when 'execute_result', 'display_data'
+        transform_non_error(ORDERED_KEYS[output_type], output['data'])
+      end
+    end
+
+    def transform_error(traceback)
+      traceback.map do |t|
+        t.split("\n").map do |line|
+          line.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip << "\n"
+        end
+      end
+    end
+
+    def transform_non_error(accepted_keys, elements)
+      accepted_keys.map do |key|
+        transform_element(key, elements[key]) if elements.key?(key)
+      end.flatten
+    end
+
+    def transform_element(output_type, output_element)
+      case output_type
+      when 'image/png', 'image/jpeg'
+        transform_image(output_type, output_element)
+      when 'image/svg+xml'
+        transform_svg(output_element)
+      when 'text/markdown', 'text/latex', 'text/plain'
+        transform_text(output_element)
+      end
+    end
+
+    def transform_image(image_type, image_content)
+      ["    ![](data:#{image_type};base64,#{image_content.gsub("\n", '')})", "\n"]
+    end
+
+    def transform_svg(image_content)
+      single_line = image_content.map(&:strip).join('').gsub(/\s+/, ' ')
+
+      ["    ![](data:image/svg+xml;utf8,#{single_line})", "\n"]
+    end
+
+    def transform_text(text_content)
+      text_content.map { |line| "    #{line}" }.append("\n")
+    end
+  end
+end

data/lib/transformer.rb

@@ -8,13 +8,16 @@ module IpynbDiff
   class Transformer
     require 'json'
     require 'yaml'
+    require 'output_transformer'
 
     @cell_decorator = :html
     @include_metadata = TRUE
 
+
     def initialize(include_metadata: TRUE, cell_decorator: :html)
       @include_metadata = include_metadata
       @cell_decorator = cell_decorator
+      @output_transformer = OutputTransformer.new
     end
 
     def validate_notebook(notebook)
@@ -73,38 +76,8 @@ module IpynbDiff
       ]
     end
 
-    def format_traceback(traceback)
-      traceback.map do |t|
-        t.split("\n").map do |line|
-          line.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip << "\n"
-        end
-      end
-    end
-
-    def transform_execute_result(output)
-      output['data']['text/plain'].map { |line| "    #{line}" }.append("\n")
-    end
-
-    def transform_image_result(output)
-      if output['data'].key?('image/png')
-        ["![](data:image/png;base64,#{output['data']['image/png'].gsub("\n", '')})", "\n"]
-      end
-    end
-
-    def transform_error_result(output)
-      format_traceback(output['traceback'])
-    end
-
     def transform_output(output)
-      transformed =
-        case output['output_type']
-        when 'execute_result'
-          transform_execute_result(output)
-        when 'display_data'
-          transform_image_result(output)
-        when 'error'
-          transform_error_result(output)
-        end
+      transformed = @output_transformer.transform(output)
 
       decorate_output(transformed, output).join('') if transformed
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipynbdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Eduardo Bonet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -121,6 +121,7 @@ files:
 - README.md
 - ipynbdiff.gemspec
 - lib/ipynbdiff.rb
+- lib/output_transformer.rb
 - lib/transformer.rb
 homepage: https://gitlab.com/gitlab-org/incubation-engineering/mlops/rb-ipynbdiff
 licenses: