ipynbdiff 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97969c0adb99db01eecef0831de1cbdb6eb1d2bfc58233195c76d475c8c4a97f
-  data.tar.gz: e04aa8f6b704f85d539eb6b59021f67ad3ca1c032a8fd3051115545828ad2c67
+  metadata.gz: ef1021a6b462ff49958069aea089dabfacd7ded6858bfc49c581dfcc03330405
+  data.tar.gz: 93ecedada6270a3f217349ef073b8f52950793e2f2197d2a0ca3254a5c2acd02
 SHA512:
-  metadata.gz: 9699f6249f6c47df87d0854069da21a484a91ef5974cd58570660e48bee7cadda633c7497396875e21d83221b00eaa8b8eb7d1e502340b0dec78718e7735d8b0
-  data.tar.gz: 63a1153092296010189a76dc3c9eadb6cf421603b6199189a9d8681048820fc607123aa41a65c08169a8497e7a28795a0325f790fd792105374268d0996e5e0a
+  metadata.gz: 29cedcb6c846d5d320425e9edf0f5f1a30bbbcdbcfaeb648b6568a6c884d60120c40926a8b30632eeff7d5892654c8b0ebe0433e9a8f03d14d2b8e6ad407ce4d
+  data.tar.gz: 85b7b9e9b3390f1484426bdb75143aebbf1f7bd2083b0c939df7d4e1e83a43f9346231c25f925ef9187ce54612ab7d202327f197c0cdb8916457913d226c9807

data/.gitlab-ci.yml

@@ -1,42 +1,43 @@
+# You can override the included template(s) by including variable overrides
+# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
+# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings
+# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
+# Note that environment variables can be set in several places
+# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
 image: ruby:2.7
-
 stages:
-  - test
-  - build
-  - rubygems
-
+- test
+- build
+- rubygems
 specs:
   stage: test
   script:
-    - bundle install
-    - bundle exec rspec
-
+  - bundle install
+  - bundle exec rspec
 build-gem:
   stage: build
   script:
-    - bundle install
-    - cat .VERSION.TMPL | sed s/GEM_VERSION/0.0.0/ > lib/version.rb
-    - gem build ipynbdiff.gemspec
+  - bundle install
+  - cat .VERSION.TMPL | sed s/GEM_VERSION/0.0.0/ > lib/version.rb
+  - gem build ipynbdiff.gemspec
   artifacts:
     paths:
     - ipynbdiff-0.0.0.gem
   needs:
-    - specs
-
+  - specs
 deploy-gem:
   stage: rubygems
   script:
-    - bundle install
-    - cat .VERSION.TMPL | sed s/GEM_VERSION/$CI_COMMIT_TAG/ > lib/version.rb
-    - gem build ipynbdiff.gemspec
-    - gem push ipynbdiff-$CI_COMMIT_TAG.gem
+  - bundle install
+  - cat .VERSION.TMPL | sed s/GEM_VERSION/$CI_COMMIT_TAG/ > lib/version.rb
+  - gem build ipynbdiff.gemspec
+  - gem push ipynbdiff-$CI_COMMIT_TAG.gem
   only:
-    - tags
+  - tags
   except:
-    - branches
-  needs: 
-    - build-gem
+  - branches
+  needs:
+  - build-gem
   when: manual
-  
-
-
+include:
+- template: Security/Dependency-Scanning.gitlab-ci.yml

data/ipynbdiff.gemspec

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'lib/version'
+lib = File.expand_path('lib/..', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'lib/version'
 
 Gem::Specification.new do |s|
   s.name        = 'ipynbdiff'

data/lib/ipynb_symbol_map.rb

@@ -7,8 +7,8 @@ module IpynbDiff
   # Creates a symbol map for a ipynb file (JSON format)
   class IpynbSymbolMap
     class << self
-      def parse(notebook)
-        IpynbSymbolMap.new(notebook).parse('')
+      def parse(notebook, objects_to_ignore = [])
+        IpynbSymbolMap.new(notebook, objects_to_ignore).parse('')
       end
     end
 
@@ -18,11 +18,12 @@ module IpynbDiff
 
     VALUE_STOPPERS = [',', '[', ']', '{', '}', *WHITESPACE_CHARS].freeze
 
-    def initialize(notebook)
+    def initialize(notebook, objects_to_ignore = [])
       @chars = notebook.chars
       @current_line = 0
       @char_idx = 0
       @results = {}
+      @objects_to_ignore = objects_to_ignore
     end
 
     def parse(prefix = '.')
@@ -69,11 +70,7 @@ module IpynbDiff
       loop do
         break if skip_beginning('}')
 
-        prop_name = parse_string
-
-        new_prefix = "#{prefix}.#{prop_name}"
-
-        add_result(new_prefix, current_line)
+        prop_name = parse_string(return_value: true)
 
         next_and_skip_whitespaces
 
@@ -81,24 +78,34 @@ module IpynbDiff
 
         next_and_skip_whitespaces
 
-        parse(new_prefix)
+        if @objects_to_ignore.include? prop_name
+          skip
+        else
+          new_prefix = "#{prefix}.#{prop_name}"
+
+          add_result(new_prefix, current_line)
+
+          parse(new_prefix)
+        end
       end
     end
 
-    def parse_string
-      value = ''
-      prev_char = nil
-
+    def parse_string(return_value: false)
       current_should_be '"'
+      init_idx = @char_idx
 
       loop do
         increment_char_index
-        break if (c = current_char) == '"' && prev_char != '\\'
 
-        value += (prev_char = c)
+        break if @char_idx > @chars.length
+
+        if current_char == '"' && prev_char != '\\'
+          init_idx += 1
+          break
+        end
       end
 
-      value
+      @chars[init_idx...@char_idx].join if return_value
     end
 
     def add_result(key, line_number)
@@ -129,6 +136,10 @@ module IpynbDiff
       @chars[@char_idx]
     end
 
+    def prev_char
+      @chars[@char_idx - 1]
+    end
+
     def current_should_be(another_char)
       raise InvalidTokenError unless current_char == another_char
     end
@@ -137,6 +148,45 @@ module IpynbDiff
       @current_line += 1 if current_char == "\n"
     end
 
+    def skip
+      skip_whitespaces
+
+      if (c = current_char) == '"'
+        parse_string
+      elsif c == '['
+        skip_array
+      elsif c == '{'
+        skip_object
+      else
+        parse_value
+      end
+    end
+
+    def skip_array
+      loop do
+        break if skip_beginning(']')
+
+        skip
+      end
+    end
+
+    def skip_object
+
+      loop do
+        break if skip_beginning('}')
+
+        parse_string
+
+        next_and_skip_whitespaces
+
+        current_should_be ':'
+
+        next_and_skip_whitespaces
+
+        skip
+      end
+    end
+
     def skip_beginning(closing_char)
 
       check_for_new_line

data/lib/output_transformer.rb

@@ -8,7 +8,8 @@ module IpynbDiff
 
     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]
+      'display_data' => %w[image/png image/svg+xml image/jpeg text/markdown text/latex],
+      'stream' => %w[text]
     }.freeze
 
     def transform(output, symbol)
@@ -17,15 +18,17 @@ module IpynbDiff
                       transform_error(output['traceback'], symbol / 'traceback')
                     when 'execute_result', 'display_data'
                       transform_non_error(ORDERED_KEYS[output_type], output['data'], symbol / 'data')
+                    when 'stream'
+                      transform_element('text', output['text'], symbol)
                     end
 
-      decorate_output(transformed, output, symbol) if transformed
+      transformed ? decorate_output(transformed, output, symbol) : []
     end
 
     def decorate_output(output_rows, output, symbol)
       [
         _,
-        symbol, %(%%%% Output: #{output['output_type']}),
+        _(symbol, %(%%%% Output: #{output['output_type']})),
         _,
         *output_rows
       ]
@@ -34,7 +37,7 @@ module IpynbDiff
     def transform_error(traceback, symbol)
       traceback.map.with_index do |t, idx|
         t.split("\n").map do |l|
-          [symbol / idx, l.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip]
+          _(symbol / idx, l.gsub(/\[[0-9][0-9;]*m/, '').sub("\u001B", '    ').gsub(/\u001B/, '').rstrip)
         end
       end
     end
@@ -52,13 +55,13 @@ module IpynbDiff
         transform_image(output_type, output_element, new_symbol)
       when 'image/svg+xml'
         transform_svg(output_element, new_symbol)
-      when 'text/markdown', 'text/latex', 'text/plain'
+      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", '')})"]
+      _(symbol, "    ![](data:#{image_type};base64,#{image_content.gsub("\n", '')})")
     end
 
     def transform_svg(image_content, symbol)
@@ -66,7 +69,7 @@ module IpynbDiff
 
       single_line = lines.map(&:strip).join.gsub(/\s+/, ' ')
 
-      [symbol, "    ![](data:image/svg+xml;utf8,#{single_line})"]
+      _(symbol, "    ![](data:image/svg+xml;utf8,#{single_line})")
     end
 
     def transform_text(text_content, symbol)

data/lib/symbolized_markdown_helper.rb

@@ -4,8 +4,8 @@ module IpynbDiff
   # Helper functions
   module SymbolizedMarkdownHelper
 
-    def _(content = '')
-      [nil, content]
+    def _(symbol = nil, content = '')
+      { symbol: symbol, content: content }
     end
 
     def array_if_not_array(thing)
@@ -14,9 +14,9 @@ module IpynbDiff
 
     def symbolize_array(symbol, content, &block)
       if content.is_a?(Array)
-        content.map.with_index { |l, idx| [symbol / idx, block.call(l)] }
+        content.map.with_index { |l, idx| _(symbol / idx, block.call(l)) }
       else
-        [symbol, content]
+        _(symbol, content)
       end
     end
   end

data/lib/transformed_notebook.rb

@@ -11,9 +11,9 @@ module IpynbDiff
 
     private
 
-    def initialize(lines = [], symbols = [], symbol_map = {})
-      @blocks = lines.zip(symbols).map do |line, symbol|
-        { content: line, source_symbol: symbol, source_line: symbol && symbol_map[symbol] }
+    def initialize(lines = [], symbol_map = {})
+      @blocks = lines.map do |line|
+        { content: line[:content], source_symbol: (symbol = line[:symbol]), source_line: symbol && symbol_map[symbol] }
       end
     end
   end

data/lib/transformer.rb

@@ -15,6 +15,7 @@ module IpynbDiff
     include SymbolizedMarkdownHelper
 
     @include_frontmatter = true
+    @objects_to_ignore = ['application/javascript', 'application/vnd.holoviews_load.v0+json']
 
     def initialize(include_frontmatter: true)
       @include_frontmatter = include_frontmatter
@@ -38,13 +39,7 @@ module IpynbDiff
       transformed = transform_document(notebook_json)
       symbol_map = IpynbSymbolMap.parse(notebook)
 
-      symbols, lines = if transformed && !transformed.empty?
-                         transformed.partition.each_with_index { |_el, i| i.even? }
-                       else
-                         [[], []]
-                       end
-
-      TransformedNotebook.new(lines, symbols, symbol_map)
+      TransformedNotebook.new(transformed, symbol_map)
     end
 
     def transform_document(notebook)
@@ -63,9 +58,9 @@ module IpynbDiff
       type = cell['cell_type'] || 'raw'
 
       [
-        symbol, %(%% Cell type:#{type} id:#{cell['id']} tags:#{tags&.join(',')}),
+        _(symbol, %(%% Cell type:#{type} id:#{cell['id']} tags:#{tags&.join(',')})),
         _,
-        *rows,
+        rows,
         _
       ]
     end
@@ -76,9 +71,9 @@ module IpynbDiff
 
     def transform_code_cell(cell, notebook, symbol)
       [
-        symbol / 'source', %(``` #{notebook.dig('metadata', 'kernelspec', 'language') || ''}),
+        _(symbol / 'source', %(``` #{notebook.dig('metadata', 'kernelspec', 'language') || ''})),
         symbolize_array(symbol / 'source', cell['source'], &:rstrip),
-        _('```'),
+        _(nil, '```'),
         cell['outputs'].map.with_index do |output, idx|
           @output_transformer.transform(output, symbol / ['outputs', idx])
         end
@@ -99,7 +94,7 @@ module IpynbDiff
         }
       }.to_yaml
 
-      as_yaml.split("\n").map { |l| _(l) }.append(_('---'), _)
+      as_yaml.split("\n").map { |l| _(nil, l) }.append(_(nil, '---'), _)
     end
   end
 end

data/lib/version.rb

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

metadata

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