Rename construct -> factory

Author: Kevin Paulisse

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

@@ -57,7 +57,7 @@ def self.catalog_diff(options = nil)
 
           # Return diffs and catalogs in expected format
           OpenStruct.new(
-            diffs: diffs.map { |x| OctocatalogDiff::API::V1::Diff.construct(x) },
+            diffs: diffs.map { |x| OctocatalogDiff::API::V1::Diff.factory(x) },
             from: OctocatalogDiff::API::V1::Catalog.new(catalogs[:from]),
             to: OctocatalogDiff::API::V1::Catalog.new(catalogs[:to])
           )

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

@@ -24,7 +24,7 @@ class Diff
         # identical object back.
         # @param object_in [?] Object in
         # @return [OctocatalogDiff::API::V1::Diff] Object out
-        def self.construct(object_in)
+        def self.factory(object_in)
           return object_in if object_in.is_a?(OctocatalogDiff::API::V1::Diff)
 
           return new(object_in) if object_in.is_a?(Array)

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

@@ -25,7 +25,7 @@ class Display
       def self.output(diff_in, options = {}, logger = nil)
         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.construct(x) }
+        diff = diff_x.map { |x| OctocatalogDiff::API::V1::Diff.factory(x) }
 
         # req_format means 'requested format' because 'format' has a built-in meaning to Ruby
         req_format = options.fetch(:format, :color_text)

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

@@ -55,7 +55,7 @@ def self.filter(result, filter_class_name, options = {})
         # it isn't already. The comparison is done on that array which is then applied back to the
         # original array.
         result_hash = {}
-        result.each { |x| result_hash[x] = OctocatalogDiff::API::V1::Diff.construct(x) }
+        result.each { |x| result_hash[x] = OctocatalogDiff::API::V1::Diff.factory(x) }
         obj = Kernel.const_get(filter_class_name).new(result_hash.values, options[:logger])
         result.reject! { |item| obj.filtered?(result_hash[item], options) }
       end

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

@@ -349,21 +349,21 @@
     end
   end
 
-  describe '#self.construct' do
+  describe '#self.factory' do
     it 'should return object as-is when passed a OctocatalogDiff::API::V1::Diff' do
       obj1 = described_class.new(chg_2)
-      testobj = described_class.construct(obj1)
+      testobj = described_class.factory(obj1)
       expect(testobj).to eq(obj1)
     end
 
     it 'should return new OctocatalogDiff::API::V1::Diff when passed an array' do
-      obj1 = described_class.construct(chg_2)
+      obj1 = described_class.factory(chg_2)
       expect(obj1).to be_a_kind_of(OctocatalogDiff::API::V1::Diff)
       expect(obj1.raw).to eq(chg_2)
     end
 
     it 'should raise error when passed something else' do
-      expect { described_class.construct(foo: true) }.to raise_error(ArgumentError, /Cannot construct .+ from Hash/)
+      expect { described_class.factory(foo: true) }.to raise_error(ArgumentError, /Cannot construct .+ from Hash/)
     end
   end
 

spec/octocatalog-diff/tests/catalog-diff/filter/absent_file_spec.rb

@@ -17,7 +17,7 @@
       ['~', "File\f/tmp/bar\fparameters\ftarget", nil, '/tmp/foo'],
       ['~', "Exec\f/tmp/bar\fparameters\fcommand", nil, '/tmp/foo']
     ]
-    obj = orig.map { |x| OctocatalogDiff::API::V1::Diff.construct(x) }
+    obj = orig.map { |x| OctocatalogDiff::API::V1::Diff.factory(x) }
     testobj = described_class.new(obj)
     result = obj.reject { |x| testobj.filtered?(x) }
     expect(result).to eq(obj.values_at(0, 2, 3, 4, 5, 6, 7))

spec/octocatalog-diff/tests/catalog-diff/filter/compilation_dir_spec.rb

@@ -26,7 +26,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -42,7 +42,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -58,7 +58,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(false)
     end
   end
@@ -76,7 +76,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -92,7 +92,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -108,7 +108,7 @@
         },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(false)
     end
   end
@@ -123,7 +123,7 @@
         { 'file' => nil, 'line' => nil },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -136,7 +136,7 @@
         { 'file' => nil, 'line' => nil },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(true)
     end
 
@@ -149,7 +149,7 @@
         { 'file' => nil, 'line' => nil },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(false)
     end
 
@@ -162,7 +162,7 @@
         { 'file' => nil, 'line' => nil },
         { 'file' => nil, 'line' => nil }
       ]
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(false)
     end
   end
@@ -180,12 +180,12 @@
     end
 
     it 'should not remove changes that do not match fully' do
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       expect(subject.filtered?(diff_obj, opts)).to eq(false)
     end
 
     it 'should log warning message' do
-      diff_obj = OctocatalogDiff::API::V1::Diff.construct(diff)
+      diff_obj = OctocatalogDiff::API::V1::Diff.factory(diff)
       subject.filtered?(diff_obj, opts)
       expect(@logger_str.string).to match(/WARN.*Varies_Due_To_Compilation_Dir_3\[Common Title\] parameters => dir.+differences/)
     end