Add old_location, new_location, and to_h_with_string_keys

Author: Kevin Paulisse

doc/dev/api/v1/objects/diff.md

@@ -44,6 +44,10 @@ Note that this is a pass-through of information provided in the Puppet catalog,
 
 Note also that if the diff represents removal of a resource, this will return `nil`, because the resource does not exist in the new catalog.
 
+#### `#new_location` (Hash)
+
+Returns a hash containing `:file` (equal to `#new_file`) and `:line` (equal to `#new_line`) when either is defined. Returns `nil` if both are undefined.
+
 #### `#new_value` (Object)
 
 Returns the value of the resource from the new catalog.
@@ -111,6 +115,10 @@ Note that this is a pass-through of information provided in the Puppet catalog,
 
 Note also that if the diff represents addition of a resource, this will return `nil`, because the resource does not exist in the old catalog.
 
+#### `#old_location` (Hash)
+
+Returns a hash containing `:file` (equal to `#old_file`) and `:line` (equal to `#old_line`) when either is defined. Returns `nil` if both are undefined.
+
 #### `#old_value` (Object)
 
 Returns the value of the resource from the old catalog.
@@ -249,4 +257,5 @@ These methods are available for debugging or development purposes but are not gu
 - `#inspect` (String): Returns inspection of object
 - `#raw` (Array): Returns internal array data structure of the "diff"
 - `#to_h` (Hash): Returns object as a hash, where keys are above described methods
+- `#to_h_with_string_keys` (Hash): Returns object as a hash, where keys are above described methods; keys are strings, not symbols
 - `#[]` (Object): Retrieve indexed array elements from raw internal array object

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

@@ -119,6 +119,22 @@ def new_line
           x.nil? ? nil : x['line']
         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 addition?
+          return @raw[3] if removal?
+          @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 addition?
+          return nil if removal?
+          @raw[5]
+        end
+
         # Public: Convert this object to a hash
         # @return [Hash] Hash with keys set by these methods
         def to_h
@@ -132,10 +148,20 @@ def to_h
             old_file: old_file,
             old_line: old_line,
             new_file: new_file,
-            new_line: new_line
+            new_line: new_line,
+            old_location: old_location,
+            new_location: new_location
           }
         end
 
+        # Public: Convert this object to a hash with string keys
+        # @return [Hash] Hash with keys set by these methods, with string keys
+        def to_h_with_string_keys
+          result = {}
+          to_h.each { |key, val| result[key.to_s] = val }
+          result
+        end
+
         # Public: String inspection
         # @return [String] String for inspection
         def inspect
@@ -147,24 +173,6 @@ def inspect
         def to_s
           raw.inspect
         end
-
-        private
-
-        # Private: Get the "old" location, i.e. location in the "from" catalog
-        # @return [Hash] <file:, line:> of resource
-        def old_location
-          return nil if addition?
-          return @raw[3] if removal?
-          @raw[4]
-        end
-
-        # Private: Get the "new" location, i.e. location in the "to" catalog
-        # @return [Hash] <file:, line:> of resource
-        def new_location
-          return @raw[3] if addition?
-          return nil if removal?
-          @raw[5]
-        end
       end
     end
   end

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

@@ -273,9 +273,44 @@
     end
   end
 
+  describe '#old_location' do
+    it 'should return nil for addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.old_location).to be_nil
+    end
+
+    it 'should return location for removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.old_location).to eq(loc_1)
+    end
+
+    it 'should return location for change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.old_location).to eq(loc_1)
+    end
+  end
+
+  describe '#new_location' do
+    it 'should return location for addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.new_location).to eq(loc_2)
+    end
+
+    it 'should return nil for removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.new_location).to be_nil
+    end
+
+    it 'should return location for change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.new_location).to eq(loc_2)
+    end
+  end
+
   describe '#to_h' do
     it 'should return a hash with the expected keys and values' do
-      methods = %w(diff_type type title structure old_value new_value old_line new_line old_file new_file)
+      methods = %w(diff_type type title structure old_value new_value)
+                .concat %w(old_line new_line old_file new_file old_location new_location)
       testobj = described_class.new(chg_2)
       result = testobj.to_h
       methods.each do |method_name|
@@ -286,6 +321,20 @@
     end
   end
 
+  describe '#to_h_with_string_keys' do
+    it 'should return a hash with the expected keys and values' do
+      methods = %w(diff_type type title structure old_value new_value)
+                .concat %w(old_line new_line old_file new_file old_location new_location)
+      testobj = described_class.new(chg_2)
+      result = testobj.to_h_with_string_keys
+      methods.each do |method_name|
+        method = method_name.to_sym
+        expect(result.key?(method.to_s)).to eq(true)
+        expect(result[method.to_s]).to eq(testobj.send(method))
+      end
+    end
+  end
+
   describe '#inspect' do
     it 'should return a string' do
       testobj = described_class.new(chg_2)