Add legacy JSON display format

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-diff/display.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require_relative '../api/v1/diff'
 require_relative 'differ'
 require_relative 'display/json'
+require_relative 'display/legacy_json'
 require_relative 'display/text'
 
 module OctocatalogDiff
@@ -21,8 +23,9 @@ class Display
       # @param logger [Logger] Logger object
       # @return [String] Text output for provided diff
       def self.output(diff_in, options = {}, logger = nil)
-        diff = diff_in.is_a?(OctocatalogDiff::CatalogDiff::Differ) ? diff_in.diff : diff_in
-        raise ArgumentError, "text_output requires Array<Diff results>; passed in #{diff_in.class}" unless diff.is_a?(Array)
+        diff_x = diff_in.is_a?(OctocatalogDiff::CatalogDiff::Differ) ? diff_in.diff : diff_in
+        raise ArgumentError, "text_output requires Array<Diff results>; passed in #{diff_in.class}" unless diff_x.is_a?(Array)
+        diff = diff_x.map { |x| OctocatalogDiff::API::V1::Diff.new(x) }
 
         # req_format means 'requested format' because 'format' has a built-in meaning to Ruby
         req_format = options.fetch(:format, :color_text)
@@ -41,6 +44,9 @@ def self.output(diff_in, options = {}, logger = nil)
         when :json
           logger.debug 'Generating JSON output' if logger
           OctocatalogDiff::CatalogDiff::Display::Json.generate(diff, opts, logger)
+        when :legacy_json
+          logger.debug 'Generating Legacy JSON output' if logger
+          OctocatalogDiff::CatalogDiff::Display::LegacyJson.generate(diff, opts, logger)
         when :text
           logger.debug 'Generating non-colored text output' if logger
           OctocatalogDiff::CatalogDiff::Display::Text.generate(diff, opts.merge(color: false), logger)

lib/octocatalog-diff/catalog-diff/display/json.rb

@@ -7,7 +7,8 @@
 module OctocatalogDiff
   module CatalogDiff
     class Display
-      # Display the output from a diff in JSON format.
+      # Display the output from a diff in JSON format. This is the new format, used in octocatalog-diff
+      # 1.x, where each diff is represented by an hash with named keys.
       class Json < OctocatalogDiff::CatalogDiff::Display
         # Generate JSON representation of the 'diff' suitable for further analysis.
         # @param diff [Array<Diff results>] The diff which *must* be in this format
@@ -16,7 +17,7 @@ class Json < OctocatalogDiff::CatalogDiff::Display
         # @param _logger [Logger] Not used here
         def self.generate(diff, options = {}, _logger = nil)
           result = {
-            'diff' => diff
+            'diff' => diff.map(&:to_h_with_string_keys)
           }
           result['header'] = options[:header] unless options[:header].nil?
           result.to_json

lib/octocatalog-diff/catalog-diff/display/legacy_json.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../display'
+
+require 'json'
+
+module OctocatalogDiff
+  module CatalogDiff
+    class Display
+      # Display the output from a diff in JSON format. This is the legacy format, used in octocatalog-diff
+      # 0.x, where each diff is represented by an array.
+      class LegacyJson < OctocatalogDiff::CatalogDiff::Display
+        # Generate JSON representation of the 'diff' suitable for further analysis.
+        # @param diff [Array<Diff results>] The diff which *must* be in this format
+        # @param options [Hash] Options which are:
+        #           - :header => [String] Header to print; no header is printed if not specified
+        # @param _logger [Logger] Not used here
+        def self.generate(diff, options = {}, _logger = nil)
+          result = {
+            'diff' => diff.map(&:raw)
+          }
+          result['header'] = options[:header] unless options[:header].nil?
+          result.to_json
+        end
+      end
+    end
+  end
+end

spec/octocatalog-diff/tests/catalog-diff/display_spec.rb

@@ -41,14 +41,49 @@
       expect(result.first).to eq('+ Class[Fizzbuzz]')
     end
 
+    it 'should call OctocatalogDiff::CatalogDiff::Display::LegacyJson' do
+      opts = {
+        format: :legacy_json,
+        header: 'My awesome header'
+      }
+      answer = [
+        [
+          '+',
+          "Class\fFizzbuzz",
+          { 'type' => 'Class', 'title' => 'Fizzbuzz', 'tags' => %w(class fizzbuzz), 'exported' => false },
+          { 'file' => nil, 'line' => nil }
+        ]
+      ]
+      result = OctocatalogDiff::CatalogDiff::Display.output(differ, opts)
+      parse_result = JSON.parse(result)
+      expect(parse_result['diff']).to eq(answer)
+      expect(parse_result['header']).to eq('My awesome header')
+    end
+
     it 'should call OctocatalogDiff::CatalogDiff::Display::Json' do
       opts = {
         format: :json,
         header: 'My awesome header'
       }
+      answer = [
+        {
+          'diff_type' => '+',
+          'type' => 'Class',
+          'title' => 'Fizzbuzz',
+          'structure' => [],
+          'old_value' => nil,
+          'new_value' => { 'type' => 'Class', 'title' => 'Fizzbuzz', 'tags' => %w(class fizzbuzz), 'exported' => false },
+          'old_file' => nil,
+          'old_line' => nil,
+          'new_file' => nil,
+          'new_line' => nil,
+          'old_location' => nil,
+          'new_location' => { 'file' => nil, 'line' => nil }
+        }
+      ]
       result = OctocatalogDiff::CatalogDiff::Display.output(differ, opts)
       parse_result = JSON.parse(result)
-      expect(parse_result['diff']).to eq(differ.diff)
+      expect(parse_result['diff']).to eq(answer)
       expect(parse_result['header']).to eq('My awesome header')
     end