Initial commit of the Diff object

Author: Kevin Paulisse

lib/octocatalog-diff/api/v1.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'v1/catalog'
 require_relative 'v1/catalog-compile'
 require_relative 'v1/catalog-diff'
 require_relative 'v1/config'
+require_relative 'v1/diff'
 
 module OctocatalogDiff
   module API

lib/octocatalog-diff/api/v1/diff.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module OctocatalogDiff
+  module API
+    module V1
+      # This class represents a `diff` produced by a catalog-diff operation. This has traditionally
+      # been stored as an array with:
+      #   [0] Type of change - '+', '-', '!', '~'
+      #   [1] Type, title, and maybe structure, delimited by "\f"
+      #   [2] Content of the "old" catalog
+      #   [3] Content of the "new" catalog
+      #   [4] File and line of the "old" catalog
+      #   [5] File and line of the "new" catalog
+      # This object seeks to preserve this traditional structure, while providing methods to make it
+      # easier to deal with.
+      class Diff
+        attr_reader :raw
+
+        # Constructor: Accepts a diff in the traditional array format and stores it.
+        # @param raw [Array] Diff in the traditional format
+        def initialize(raw)
+          unless raw.is_a?(Array)
+            raise ArgumentError, 'OctocatalogDiff::API::V1::Diff#initialize expects Array argument'
+          end
+          @raw = raw
+        end
+
+        # Public: Retrieve an indexed value from the array
+        # @return [?] Indexed value
+        def [](i)
+          @raw[i]
+        end
+
+        # Public: Get the change type
+        # @return [String] Change type symbol (~, !, +, -)
+        def change_type
+          @raw[0]
+        end
+
+        # Public: Get the change type (English word)
+        # @return [String] Change type word
+        def change_type_word
+          return 'change' if @raw[0] == '!' || @raw[0] == '~'
+          return 'addition' if @raw[0] == '+'
+          return 'removal' if @raw[0] == '-'
+          raise ArgumentError, "No change type corresponds to #{@raw[0].inspect}"
+        end
+
+        # Public: Get the type_title string
+        # @return [?] Type_title_structure
+        def type_title
+          @raw[1]
+        end
+
+        # Public: Get the resource type
+        # @return [String] Resource type
+        def type
+          @raw[1].split(/\f/)[0]
+        end
+
+        # Public: Get the resource title
+        # @return [String] Resource title
+        def title
+          @raw[1].split(/\f/)[1]
+        end
+
+        # Public: Get the structure of the resource as an array
+        # @return [Array] Structure of resource
+        def structure
+          @raw[1].split(/\f/)[2..-1]
+        end
+
+        # Public: Get the "old" value, i.e. "from" catalog
+        # @return [?] "old" value
+        def old_value
+          return nil if @raw[0] == '+'
+          @raw[2]
+        end
+
+        # Public: Get the "new" value, i.e. "to" catalog
+        # @return [?] "old" value
+        def new_value
+          return nil if @raw[0] == '-'
+          return @raw[2] if @raw[0] == '+'
+          @raw[3]
+        end
+
+        # Public: Get the "old" location, i.e. location in the "from" catalog
+        # @return [Hash] <file:, line:> of resource
+        def old_location
+          return nil if @raw[0] == '+'
+          return @raw[3] if @raw[0] == '-'
+          @raw[4]
+        end
+
+        # Public: Get the "new" location, i.e. location in the "to" catalog
+        # @return [Hash] <file:, line:> of resource
+        def new_location
+          return @raw[3] if @raw[0] == '+'
+          return nil if @raw[0] == '-'
+          @raw[5]
+        end
+
+        # Public: Get the filename from the "old" location
+        # @return [String] Filename
+        def old_file
+          x = old_location
+          x.nil? ? nil : x['file']
+        end
+
+        # Public: Get the line number from the "old" location
+        # @return [String] Line number
+        def old_line
+          x = old_location
+          x.nil? ? nil : x['line']
+        end
+
+        # Public: Get the filename from the "new" location
+        # @return [String] Filename
+        def new_file
+          x = new_location
+          x.nil? ? nil : x['file']
+        end
+
+        # Public: Get the line number from the "new" location
+        # @return [String] Line number
+        def new_line
+          x = new_location
+          x.nil? ? nil : x['line']
+        end
+      end
+    end
+  end
+end

spec/octocatalog-diff/tests/api/v1/diff_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+require OctocatalogDiff::Spec.require_path('/api/v1/diff')
+
+describe OctocatalogDiff::API::V1::Diff do
+  let(:type_title) { "File\f/etc/foo" }
+  let(:parameters) { { 'parameters' => { 'owner' => 'root' } } }
+  let(:tts) { "File\f/etc/foo\fparameters\fcontent" }
+
+  let(:loc_1) { { 'file' => '/var/tmp/foo.pp', 'line' => 35 } }
+  let(:loc_2) { { 'file' => '/var/tmp/foo.pp', 'line' => 12 } }
+
+  let(:add_1) { ['+', type_title, parameters] }
+  let(:add_2) { ['+', type_title, parameters, loc_1] }
+
+  let(:del_1) { ['-', type_title, parameters] }
+  let(:del_2) { ['-', type_title, parameters, loc_1] }
+
+  let(:chg_1) { ['~', tts, 'old', 'new'] }
+  let(:chg_2) { ['~', tts, 'old', 'new', loc_1, loc_2] }
+
+  describe '#[]' do
+    it 'should return expected numeric values from an add/remove array' do
+      testobj = described_class.new(add_1)
+      expect(testobj[0]).to eq('+')
+      expect(testobj[1]).to eq(type_title)
+      expect(testobj[2]).to eq(parameters)
+      expect(testobj[3]).to be_nil
+    end
+
+    it 'should return expected numeric values from a change array' do
+      testobj = described_class.new(chg_2)
+      expect(testobj[0]).to eq('~')
+      expect(testobj[1]).to eq(tts)
+      expect(testobj[2]).to eq('old')
+      expect(testobj[3]).to eq('new')
+      expect(testobj[4]).to eq(loc_1)
+      expect(testobj[5]).to eq(loc_2)
+      expect(testobj[6]).to be_nil
+    end
+  end
+
+  describe '#change_type' do
+    it 'should identify the symbol' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.change_type).to eq('~')
+    end
+  end
+
+  describe '#change_type_word' do
+    it 'should identify addition' do
+      testobj = described_class.new(add_1)
+      expect(testobj.change_type_word).to eq('addition')
+    end
+
+    it 'should identify removal' do
+      testobj = described_class.new(del_1)
+      expect(testobj.change_type_word).to eq('removal')
+    end
+
+    it 'should identify change with ~' do
+      testobj = described_class.new(chg_1)
+      expect(testobj.change_type_word).to eq('change')
+    end
+
+    it 'should identify change with !' do
+      x = chg_1.dup
+      x[0] = '!'
+      testobj = described_class.new(x)
+      expect(testobj.change_type_word).to eq('change')
+    end
+
+    it 'should raise ArgumentError for unknown symbol' do
+      x = chg_1.dup
+      x[0] = '#'
+      testobj = described_class.new(x)
+      expect { testobj.change_type_word }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#type_title' do
+  end
+
+  describe '#type' do
+  end
+
+  describe '#title' do
+  end
+
+  describe '#structure' do
+  end
+
+  describe '#old_value' do
+  end
+
+  describe '#new_value' do
+  end
+
+  describe '#old_location' do
+  end
+
+  describe '#new_location' do
+  end
+
+  describe '#old_file' do
+  end
+
+  describe '#old_line' do
+  end
+
+  describe '#new_file' do
+  end
+
+  describe '#new_line' do
+  end
+end