Add new/old file/line tests and documentation

Author: Kevin Paulisse

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

@@ -28,6 +28,22 @@ See also: `#addition?`, `#change?`, `#removal?`
 
 Note: Internally `~` and `!` represent different types of changes, but when presenting the output, these can generally be considered equivalent.
 
+#### `#new_file` (String)
+
+Returns the filename of the Puppet manifest giving rise to the resource as it exists in the new catalog.
+
+Note that this is a pass-through of information provided in the Puppet catalog, and is not calculated by octocatalog-diff. If the Puppet catalog does not contain this information, this method will return `nil`.
+
+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_line` (String)
+
+Returns the line number within the Puppet manifest giving rise to the resource as it exists in the new catalog. (See `#new_file` for the filename of the Puppet manifest.)
+
+Note that this is a pass-through of information provided in the Puppet catalog, and is not calculated by octocatalog-diff. If the Puppet catalog does not contain this information, this method will return `nil`.
+
+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_value` (Object)
 
 Returns the value of the resource from the new catalog.
@@ -79,6 +95,22 @@ Returns the value of the resource from the new catalog.
   diff.old_value #=> 'This is the NEW FILE!!!!!'
   ```
 
+#### `#old_file` (String)
+
+Returns the filename of the Puppet manifest giving rise to the resource as it exists in the old catalog.
+
+Note that this is a pass-through of information provided in the Puppet catalog, and is not calculated by octocatalog-diff. If the Puppet catalog does not contain this information, this method will return `nil`.
+
+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_file` (String)
+
+Returns the line number within the Puppet manifest giving rise to the resource as it exists in the old catalog. (See `#old_file` for the filename of the Puppet manifest.)
+
+Note that this is a pass-through of information provided in the Puppet catalog, and is not calculated by octocatalog-diff. If the Puppet catalog does not contain this information, this method will return `nil`.
+
+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_value` (Object)
 
 Returns the value of the resource from the old catalog.

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

@@ -91,22 +91,6 @@ def new_value
           @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 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: Get the filename from the "old" location
         # @return [String] Filename
         def old_file
@@ -146,8 +130,6 @@ def to_h
             structure: structure,
             old_value: old_value,
             new_value: new_value,
-            old_location: old_location,
-            new_location: new_location,
             old_file: old_file,
             old_line: old_line,
             new_file: new_file,
@@ -166,6 +148,24 @@ 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

@@ -13,7 +13,7 @@
   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(:add_2) { ['+', type_title, parameters, loc_2] }
 
   let(:del_1) { ['-', type_title, parameters] }
   let(:del_2) { ['-', type_title, parameters, loc_1] }
@@ -165,21 +165,111 @@
     end
   end
 
-  describe '#old_location' do
-  end
+  describe '#old_file' do
+    it 'should return nil for an addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.old_file).to be_nil
+    end
 
-  describe '#new_location' do
-  end
+    it 'should return the filename for a removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.old_file).to eq(loc_1['file'])
+    end
 
-  describe '#old_file' do
+    it 'should return nil when information is not present for a removal' do
+      testobj = described_class.new(del_1)
+      expect(testobj.old_file).to be_nil
+    end
+
+    it 'should return the filename for a change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.old_file).to eq(loc_1['file'])
+    end
+
+    it 'should return nil when information is not present for a change' do
+      testobj = described_class.new(chg_1)
+      expect(testobj.old_file).to be_nil
+    end
   end
 
   describe '#old_line' do
+    it 'should return nil for an addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.old_line).to be_nil
+    end
+
+    it 'should return the line for a removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.old_line).to eq(loc_1['line'])
+    end
+
+    it 'should return nil when information is not present for a removal' do
+      testobj = described_class.new(del_1)
+      expect(testobj.old_line).to be_nil
+    end
+
+    it 'should return the line for a change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.old_line).to eq(loc_1['line'])
+    end
+
+    it 'should return nil when information is not present for a change' do
+      testobj = described_class.new(chg_1)
+      expect(testobj.old_line).to be_nil
+    end
   end
 
   describe '#new_file' do
+    it 'should return nil for a removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.new_file).to be_nil
+    end
+
+    it 'should return the filename for an addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.new_file).to eq(loc_2['file'])
+    end
+
+    it 'should return nil when information is not present for an addition' do
+      testobj = described_class.new(add_1)
+      expect(testobj.new_file).to be_nil
+    end
+
+    it 'should return the filename for a change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.new_file).to eq(loc_2['file'])
+    end
+
+    it 'should return nil when information is not present for a change' do
+      testobj = described_class.new(chg_1)
+      expect(testobj.new_file).to be_nil
+    end
   end
 
   describe '#new_line' do
+    it 'should return nil for a removal' do
+      testobj = described_class.new(del_2)
+      expect(testobj.new_line).to be_nil
+    end
+
+    it 'should return the line for an addition' do
+      testobj = described_class.new(add_2)
+      expect(testobj.new_line).to eq(loc_2['line'])
+    end
+
+    it 'should return nil when information is not present for an addition' do
+      testobj = described_class.new(add_1)
+      expect(testobj.new_line).to be_nil
+    end
+
+    it 'should return the line for a change' do
+      testobj = described_class.new(chg_2)
+      expect(testobj.new_line).to eq(loc_2['line'])
+    end
+
+    it 'should return nil when information is not present for a change' do
+      testobj = described_class.new(chg_1)
+      expect(testobj.new_line).to be_nil
+    end
   end
 end