change_type -> diff_type

Author: Kevin Paulisse

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

@@ -16,9 +16,9 @@ Returns true if this diff is an addition (resource exists in new catalog but not
 
 Returns true if this diff is a change (resource exists in both catalogs but is different between them).
 
-#### `#change_type` (String)
+#### `#diff_type` (String)
 
-Returns the change type of the diff, which is one of the following characters:
+Returns the type of difference, which is one of the following characters:
 
 - `+` for addition (resource exists in new catalog but not old catalog)
 - `-` for removal (resource exists in old catalog but not new catalog)
@@ -229,7 +229,7 @@ Returns the title of the resource from the Puppet catalog.
 For example, a diff involving `File['/etc/passwd']` would have:
 
 - `diff.title #=> '/etc/passwd'`
-- `diff.type #=> 'File`
+- `diff.type #=> 'File'`
 
 #### `#type` (String)
 
@@ -238,7 +238,7 @@ Returns the type of the resource from the Puppet catalog.
 For example, a diff involving `File['/etc/passwd']` would have:
 
 - `diff.title #=> '/etc/passwd'`
-- `diff.type #=> 'File`
+- `diff.type #=> 'File'`
 
 Note that the type will be capitalized because Puppet capitalizes this in catalogs.
 

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

@@ -36,26 +36,26 @@ def [](i)
 
         # Public: Get the change type
         # @return [String] Change type symbol (~, !, +, -)
-        def change_type
+        def diff_type
           @raw[0]
         end
 
         # Public: Is this an addition?
         # @return [Boolean] True if this is an addition
         def addition?
-          change_type == '+'
+          diff_type == '+'
         end
 
         # Public: Is this a removal?
         # @return [Boolean] True if this is an addition
         def removal?
-          change_type == '-'
+          diff_type == '-'
         end
 
         # Public: Is this a change?
         # @return [Boolean] True if this is an change
         def change?
-          change_type == '~' || change_type == '!'
+          diff_type == '~' || diff_type == '!'
         end
 
         # Public: Get the resource type
@@ -123,7 +123,7 @@ def new_line
         # @return [Hash] Hash with keys set by these methods
         def to_h
           {
-            change_type: change_type,
+            diff_type: diff_type,
             type: type,
             title: title,
             structure: structure,

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

@@ -42,10 +42,10 @@
     end
   end
 
-  describe '#change_type' do
+  describe '#diff_type' do
     it 'should identify the symbol' do
       testobj = described_class.new(chg_2)
-      expect(testobj.change_type).to eq('~')
+      expect(testobj.diff_type).to eq('~')
     end
   end
 
@@ -275,7 +275,7 @@
 
   describe '#to_h' do
     it 'should return a hash with the expected keys and values' do
-      methods = %w(change_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 old_line new_line old_file new_file)
       testobj = described_class.new(chg_2)
       result = testobj.to_h
       methods.each do |method_name|