ipynbdiff 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87c49e29a069b5064985b1b1097ac4d02c375161d9fe64df8e70f0155419220
-  data.tar.gz: 97931332962139f7f129a546bb7a7f9b670d779dcb032b27fbb1a3faa6f7dc85
+  metadata.gz: 54c011ed4790dc548b33d6e4773bb9bbdaedd7b8c1ffbdbcfa5e494e5380b1a9
+  data.tar.gz: 70f78c722ddc432576ec52d55617e4ce5bdf29cb7ff32ad46219ac52d0d6f5d5
 SHA512:
-  metadata.gz: 86c4be0fc53e0db2172221a17dd07e0c3f37492ffc699075b0de74dea3265feebee2207ef4e9170ead59be15c42b858918fbd2e56c7ed109cb674fbf7eb7dbbb
-  data.tar.gz: 10fdb124114a73425edc57f5c9fb80fbd546f6b8e7d58929a327f1be268774d8409238630286aa050e41384bf53c951d2b8c67aaeb76835bc3e0f37672775d48
+  metadata.gz: 757f9ea284f358771835db2e27ebe90cb5c8c99336313a65d04cbd0080c0891e1c25af79740cb4d191eeafec10e66c74baceef1ba24729b6ba6f743d502564fa
+  data.tar.gz: 35866e056ae8f4ab043bd9cc247f6c3f8dc3b02d475e94221ca11352badf1e96cf840e8020553ffa8c32b1359f967c74ccc67e0f4abda376e8a035d027871daf

data/README.md

@@ -32,6 +32,7 @@ Options:
   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 
   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

data/ipynbdiff.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ipynbdiff'
-  s.version     = '0.3.4'
+  s.version     = '0.3.5'
   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/ipynbdiff.rb

@@ -15,6 +15,7 @@ module IpynbDiff
     write_output_to: nil,
     format: :text,
     sources_are_files: FALSE,
+    raise_if_invalid_notebook: FALSE,
     transform_options: @default_transform_options,
     diff_opts: {
       include_diff_info: FALSE
@@ -22,32 +23,36 @@ module IpynbDiff
   }.freeze
 
   def self.prepare_input(to_prepare, options)
-    prepared = to_prepare
-    prepared = File.read(prepared) if options[:sources_are_files]
-    prepared = transform(prepared, options[:transform_options]) if options[:preprocess_input]
+    return '' unless to_prepare
 
-    prepared
+    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
   end
 
   def self.diff(
     from_notebook,
     to_notebook,
-    options = {}
+    options = @default_diff_options
   )
     options = @default_diff_options.merge(options)
 
-    from = from_notebook && prepare_input(from_notebook, options) || ''
-    to = to_notebook && prepare_input(to_notebook, options) || ''
+    from = prepare_input(from_notebook, options)
+    to = prepare_input(to_notebook, options)
 
     d = Diffy::Diff.new(from, to, **options[:diff_opts]).to_s(options[:format])
-
     File.write(options[:write_output_to], d) if options[:write_output_to]
-
     d
+  rescue InvalidNotebookError
+    raise if options[:raise_if_invalid_notebook]
   end
 
-  def self.transform(notebook, options)
+  def self.transform(notebook, raise_errors: FALSE, options: @default_transform_options)
     options = @default_transform_options.merge(options)
+
     Transformer.new(**options).transform(notebook)
+  rescue InvalidNotebookError
+    raise if raise_errors
   end
 end

data/lib/transformer.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module IpynbDiff
+  class InvalidNotebookError < StandardError
+  end
+
   # Returns a markdown version of the Jupyter Notebook
   class Transformer
     require 'json'
@@ -14,8 +17,18 @@ module IpynbDiff
       @cell_decorator = cell_decorator
     end
 
-    def transform(notebook)
+    def validate_notebook(notebook)
       notebook_json = JSON.parse(notebook)
+
+      return notebook_json if notebook_json.key?('cells') && notebook_json.key?('metadata')
+
+      raise InvalidNotebookError
+    rescue JSON::ParserError
+      raise InvalidNotebookError
+    end
+
+    def transform(notebook)
+      notebook_json = validate_notebook(notebook)
       transformed_blocks = notebook_json['cells'].map do |cell|
         decorate_cell(transform_cell(cell, notebook_json), cell)
       end
@@ -26,7 +39,7 @@ module IpynbDiff
 
     def decorate_cell(rows, cell)
       tags = cell['metadata']&.fetch('tags', [])
-      type = cell['cell_type']
+      type = cell['cell_type'] || 'raw'
 
       case @cell_decorator
       when :html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipynbdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Eduardo Bonet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy