ipynbdiff 0.3.5 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c011ed4790dc548b33d6e4773bb9bbdaedd7b8c1ffbdbcfa5e494e5380b1a9
-  data.tar.gz: 70f78c722ddc432576ec52d55617e4ce5bdf29cb7ff32ad46219ac52d0d6f5d5
+  metadata.gz: 4a0b43a4e07caec84f0a356fddf739dcbfd8a851031414a2d3dd8de52d399ba7
+  data.tar.gz: efa08ed43c9afcbbac0d895d2bc7306601581609cbbf51398d1a8f0b7e7d5171
 SHA512:
-  metadata.gz: 757f9ea284f358771835db2e27ebe90cb5c8c99336313a65d04cbd0080c0891e1c25af79740cb4d191eeafec10e66c74baceef1ba24729b6ba6f743d502564fa
-  data.tar.gz: 35866e056ae8f4ab043bd9cc247f6c3f8dc3b02d475e94221ca11352badf1e96cf840e8020553ffa8c32b1359f967c74ccc67e0f4abda376e8a035d027871daf
+  metadata.gz: df6258024f5bad0cd1a74be669d9156910ddc08cd626a9785664367fa599ef2f53da8e71276d5126a0858c5446efd0e33c6ba84c192b8c5b628f40f6f101c5ab
+  data.tar.gz: c64d0ba535a8b5b3d20df51b7937f514ef188eb7a93f2204b27ad2fd1cbdc13401fe2564987fc559e26f66bd5d55044c7fc1b57dc1958f0fccf624f94c9ab1af

data/.VERSION.TMPL

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

data/.gitlab-ci.yml

@@ -0,0 +1,39 @@
+image: ruby:2.7
+
+stages:
+  - test
+  - build
+  - rubygems
+
+specs:
+  stage: test
+  script:
+    - bundle install
+    - bundle exec rspec
+
+build-gem:
+  stage: build
+  script:
+    - bundle install
+    - cat .VERSION.TMPL | sed s/GEM_VERSION/$CI_COMMIT_REF_NAME/ > lib/version.rb
+    - gem build ipynbdiff.gemspec
+  artifacts:
+    paths:
+    - ipynbdiff-$CI_COMMIT_REF_NAME.gem
+  needs:
+    - specs
+
+deploy-gem:
+  stage: rubygems
+  script:
+    - bundle install
+    - gem push ipynbdiff-$CI_COMMIT_TAG.gem
+  only:
+    - master
+    - tags
+  needs: 
+    - build-gem
+  when: manual
+  
+
+

data/Gemfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+source "https://rubygems.org"
+
 gem 'diffy', '3.3.0'
 gem 'json', '2.5.1'
 gem 'rspec', '3.10.0'

data/Gemfile.lock

@@ -1,4 +1,5 @@
 GEM
+  remote: https://rubygems.org/
   specs:
     diff-lcs (1.4.4)
     diffy (3.3.0)
@@ -18,6 +19,7 @@ GEM
     rspec-support (3.10.2)
 
 PLATFORMS
+  ruby
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -26,4 +28,4 @@ DEPENDENCIES
   rspec (= 3.10.0)
 
 BUNDLED WITH
-   2.2.28
+   2.2.29

data/README.md

@@ -28,16 +28,16 @@ Options:
 
 ```ruby
 @default_transform_options = {
-  preprocess_input: TRUE, # Whether the input should be transformed
+  preprocess_input: true, # Whether the input should be transformed
   write_output_to: nil, # Pass a path to save the output to a file
   format: :text, # These are the formats Diffy accepts https://github.com/samg/diffy
-  sources_are_files: FALSE, # Weather to use the from/to as string or path to a file 
-  raise_if_invalid_notebook: FALSE, # Raises an error if the notebooks are invalid, otherwise returns nil 
+  sources_are_files: false, # Weather to use the from/to as string or path to a file
+  raise_if_invalid_notebook: false, # Raises an error if the notebooks are invalid, otherwise returns nil
   transform_options: @default_transform_options, # See below for transform options
   diff_opts: {
-    include_diff_info: FALSE # These are passed to Diffy https://github.com/samg/diffy
+    include_diff_info: false # These are passed to Diffy https://github.com/samg/diffy
   }
-} 
+}
 ```
 
 ### Transforming the notebooks
@@ -52,7 +52,7 @@ Options:
 
 ```ruby
 @default_transform_options = {
-    include_metadata: FALSE, # Whether to include or not the notebook metadata (kernel, language, etc)
+    include_metadata: false, # Whether to include or not the notebook metadata (kernel, language, etc)
     cell_decorator: :html # :html is useful to add styling with css, :percent is better for text format
 }
 ```

data/ipynbdiff.gemspec

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative "lib/version"
+
 Gem::Specification.new do |s|
   s.name        = 'ipynbdiff'
-  s.version     = '0.3.5'
+  s.version     = IpynbDiff::VERSION
   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']
@@ -18,8 +20,8 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'diffy', '3.3.0'
-  s.add_runtime_dependency 'json', '2.5.1'
+  s.add_runtime_dependency 'diffy', '~> 3.3'
+  s.add_runtime_dependency 'json', '~> 2.5', '>= 2.5.1'
 
   s.add_development_dependency 'bundler', '~> 2.2'
   s.add_development_dependency 'guard-rspec'

data/lib/ipynbdiff.rb

@@ -6,19 +6,19 @@ module IpynbDiff
   require 'diffy'
 
   @default_transform_options = {
-    include_metadata: FALSE,
+    include_metadata: false,
     cell_decorator: :html
   }
 
   @default_diff_options = {
-    preprocess_input: TRUE,
+    preprocess_input: true,
     write_output_to: nil,
     format: :text,
-    sources_are_files: FALSE,
-    raise_if_invalid_notebook: FALSE,
+    sources_are_files: false,
+    raise_if_invalid_notebook: false,
     transform_options: @default_transform_options,
     diff_opts: {
-      include_diff_info: FALSE
+      include_diff_info: false
     }
   }.freeze
 
@@ -27,7 +27,7 @@ module IpynbDiff
 
     prep = to_prepare
     prep = File.read(prep) if options[:sources_are_files]
-    prep = transform(prep, raise_errors: TRUE, options: options[:transform_options]) if options[:preprocess_input]
+    prep = transform(prep, raise_errors: true, options: options[:transform_options]) if options[:preprocess_input]
     prep
   end
 
@@ -48,7 +48,7 @@ module IpynbDiff
     raise if options[:raise_if_invalid_notebook]
   end
 
-  def self.transform(notebook, raise_errors: FALSE, options: @default_transform_options)
+  def self.transform(notebook, raise_errors: false, options: @default_transform_options)
     options = @default_transform_options.merge(options)
 
     Transformer.new(**options).transform(notebook)

data/lib/output_transformer.rb

@@ -0,0 +1,65 @@
+# 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)
+      lines = image_content.is_a?(Array) ? image_content : [image_content]
+
+      single_line = lines.map(&:strip).join('').gsub(/\s+/, ' ')
+
+      ["    ![](data:image/svg+xml;utf8,#{single_line})", "\n"]
+    end
+
+    def transform_text(text_content)
+      lines = text_content.is_a?(Array) ? text_content : [text_content]
+
+      lines.map { |line| "    #{line}" }.append("\n")
+    end
+  end
+end

data/lib/transformer.rb

@@ -8,19 +8,22 @@ module IpynbDiff
   class Transformer
     require 'json'
     require 'yaml'
+    require 'output_transformer'
 
     @cell_decorator = :html
-    @include_metadata = TRUE
+    @include_metadata = true
 
-    def initialize(include_metadata: TRUE, cell_decorator: :html)
+
+    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)
       notebook_json = JSON.parse(notebook)
 
-      return notebook_json if notebook_json.key?('cells') && notebook_json.key?('metadata')
+      return notebook_json if notebook_json.key?('cells')
 
       raise InvalidNotebookError
     rescue JSON::ParserError
@@ -66,51 +69,22 @@ module IpynbDiff
 
     def transform_code_cell(cell, notebook)
       [
-        %(``` #{notebook['metadata']['kernelspec']['language']}\n),
+        %(``` #{notebook.dig('metadata', 'kernelspec', 'language') || ''}\n),
         *cell['source'],
         "\n```\n",
         *cell['outputs'].map { |output| transform_output(output) }
       ]
     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
 
     def transform_text_cell(cell)
-      cell['source'].append("\n")
+      source = cell['source']
+      (source.is_a?(Array) ? source : [source]).append("\n")
     end
 
     def transform_metadata(notebook_json)

data/lib/version.rb

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

metadata

@@ -1,41 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: ipynbdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.9
 platform: ruby
 authors:
 - Eduardo Bonet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.1
 - !ruby/object:Gem::Dependency
@@ -115,13 +121,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".VERSION.TMPL"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - ipynbdiff.gemspec
 - lib/ipynbdiff.rb
+- lib/output_transformer.rb
 - lib/transformer.rb
+- lib/version.rb
 homepage: https://gitlab.com/gitlab-org/incubation-engineering/mlops/rb-ipynbdiff
 licenses:
 - MIT