fruit_to_lime 2.1.2 → 2.1.3

data/lib/fruit_to_lime/csv_helper.rb

@@ -1,14 +1,13 @@
 require "csv"
 module FruitToLime
     module CsvHelper
-        def self.detect_col_sep(text)
-            firstline = text.split('\n').first
-            col_seps = [';','\t',',']
-            return col_seps.find do |c|
-                firstline.include? c
-            end
-        end
-        
+
+        # @example Detect column separator and transform to hashes
+        #     hashes = FruitToLime::CsvHelper.text_to_hashes(text)
+        #
+        # @example Use specific column separator and transform to hashes
+        #     column_separator = ','
+        #     hashes = FruitToLime::CsvHelper.text_to_hashes(text, column_separator)
         def self.text_to_hashes(text, column_separator = nil)
             if !text
                 raise "Missing text"
@@ -34,5 +33,15 @@ module FruitToLime
             end
             return rs
         end
+        
+        private
+        def self.detect_col_sep(text)
+            firstline = text.split('\n').first
+            col_seps = [';','\t',',']
+            return col_seps.find do |c|
+                firstline.include? c
+            end
+        end
+
     end
 end

data/lib/fruit_to_lime/model/rootmodel.rb

@@ -117,19 +117,19 @@ module FruitToLime
         def sanity_check
             error = String.new
 
-            dups = get_duplicates(@coworkers) {|coworker| coworker.integration_id}
+            dups = get_integration_id_duplicates(with_non_empty_integration_id(@coworkers))
             dups_error_items = (dups.collect{|coworker| coworker.integration_id}).compact
             if dups.length > 0
                 error = "#{error}\nDuplicate coworker integration_id: #{dups_error_items.join(", ")}."
             end
 
-            dups = get_duplicates(@organizations) {|org| org.integration_id}
+            dups = get_integration_id_duplicates(with_non_empty_integration_id(@organizations))
             dups_error_items = (dups.collect{|org| org.integration_id}).compact
             if dups.length > 0
                 error = "#{error}\nDuplicate organization integration_id: #{dups_error_items.join(", ")}."
             end
 
-            dups = get_duplicates(@deals) {|deal| deal.integration_id}
+            dups = get_integration_id_duplicates(with_non_empty_integration_id(@deals))
             dups_error_items = (dups.collect{|deal| deal.integration_id}).compact
             if dups_error_items.length > 0
                 error = "#{error}\nDuplicate deal integration_id: #{dups_error_items.join(", ")}."
@@ -138,17 +138,6 @@ module FruitToLime
             return error.strip
         end
 
-        # returns all items from the object array with duplicate keys.
-        # To get all organizations with the same integration_id use
-        # @example Get all the organization duplicates with the same integration id
-        #      rm.get_duplicates(rm.organizations, {|org| org.integration_id})
-        #
-        def get_duplicates(objects, &key)
-            uniq_items = objects.uniq {|item| key.call(item)}.compact
-
-            return (objects - uniq_items).compact
-        end
-
         def validate()
             error = String.new
 
@@ -177,5 +166,22 @@ module FruitToLime
             elem = doc.add_element(element_name,{"Version"=>"v2_0"})
             SerializeHelper::serialize_variables_rexml(elem, self)
         end
+
+        private
+        # returns all items from the object array with duplicate integration ids.
+        # To get all organizations with the same integration_id use
+        # @example Get all the organization duplicates with the same integration id
+        #      rm.get_integration_id_duplicates(rm.organizations)
+        def get_integration_id_duplicates(objects)
+            uniq_items = objects.uniq {|item| item.integration_id}.compact
+
+            return (objects - uniq_items).compact
+        end
+
+        def with_non_empty_integration_id(objects)
+            return objects.select do |obj|
+                obj.integration_id!=nil && !obj.integration_id.empty?
+            end
+        end
     end
 end

data/lib/fruit_to_lime/model_helpers.rb

@@ -1,5 +1,7 @@
 module FruitToLime
     module ModelHasCustomFields
+        # @example
+        #     obj.set_custom_value(row['business_value_partner_info'], "partner_info")
         def set_custom_value(value, field)
             @custom_values = [] if @custom_values == nil
             custom_value = CustomValue.new()
@@ -36,7 +38,9 @@ module FruitToLime
         end
     end
 
-    module ModelHasTags        
+    module ModelHasTags
+        # @example
+        #     obj.set_tag("partner")
         def set_tag(str)
             @tags = [] if @tags == nil
             if ! @tags.any? {|tag| tag.value == str }

data/lib/fruit_to_lime/roo_helper.rb

@@ -1,15 +1,28 @@
 require "csv"
 module FruitToLime
+    # @example transform xlsx file into rows
+    #     organizations_path = File.join(File.dirname(__FILE__), 'organizations.xlsx') # same path as this file
+    #     rows = FruitToLime::RooHelper.new(Roo::Excelx.new(organizations_path)).rows
     class RooHelper
+
         def initialize(data)
             @data = data
             @default_sheet = data.sheets.first
         end
 
+        # Get rows for the first sheet.
+        # The rows are hashes of the first row of cells as header cells and the rest as content.
+        # @example If the header 'Name' and the second column contains 'Johan'.
+        #    FruitToLime::RooHelper.new(Roo::Excelx.new(file_path)).rows
+        #    # returns:
+        #    [{'Name'=>'Johan'}]
         def rows
             return rows_for_sheet(@default_sheet)
         end
 
+        # @example transform xlsx file into rows for the second sheet
+        #     data = Roo::Excelx.new(organizations_path)
+        #     rows = FruitToLime::RooHelper.new(data).rows_for_sheet(data.sheets[1])
         def rows_for_sheet(sheet)
             column_headers = {}
             1.upto(@data.last_column(sheet)) do |col|

data/lib/fruit_to_lime/templating.rb

@@ -10,24 +10,6 @@ module FruitToLime
             Dir.entries(@path).select { |d| d != '.' && d != '..' }
         end
 
-        def exec_but_dont_show_unless_error(cmd)
-            std_out_value = []
-            Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
-                while std_line = stdout.gets
-                    std_out_value << std_line
-                end
-
-                exit_status = wait_thr.value
-                if !exit_status.success?
-                    puts "Failed with #{exit_status}"
-                    puts "std_out_value"
-                    puts std_out_value
-
-                    raise "failed exec #{cmd}"
-                end
-            end
-        end
-
         def unpack(name, path)
             template = list.find { |t| t == name }
             if template
@@ -47,5 +29,24 @@ module FruitToLime
                 false
             end
         end
+
+        private
+        def exec_but_dont_show_unless_error(cmd)
+            std_out_value = []
+            Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+                while std_line = stdout.gets
+                    std_out_value << std_line
+                end
+
+                exit_status = wait_thr.value
+                if !exit_status.success?
+                    puts "Failed with #{exit_status}"
+                    puts "std_out_value"
+                    puts std_out_value
+
+                    raise "failed exec #{cmd}"
+                end
+            end
+        end
     end
 end

data/spec/rootmodel_spec.rb

@@ -42,7 +42,7 @@ describe "RootModel" do
             :email=>"kalle.anka@vonanka.com"
         })
         rootmodel.coworkers.length.should eq 2
-        expect { 
+        expect {
             rootmodel.add_coworker({
                 :integration_id=>"123key",
                 :first_name=>"Knatte",
@@ -54,5 +54,29 @@ describe "RootModel" do
         rootmodel.coworkers.length.should eq 2
     end
 
-end
+    it "will ignore empty integration ids during sanity check" do
+        org1 = FruitToLime::Organization.new
+        org1.name = "company 1"
+        rootmodel.organizations.push org1
+
+        org2 = FruitToLime::Organization.new
+        org2.name = "company 2"
+        rootmodel.organizations.push org2
+
+        rootmodel.sanity_check.should eq ""
+    end
+    
+    it "will report when the same integration id is used during sanity check" do
+        org1 = FruitToLime::Organization.new
+        org1.integration_id = "1"
+        org1.name = "company 1"
+        rootmodel.organizations.push org1
 
+        org2 = FruitToLime::Organization.new
+        org2.integration_id = "1"
+        org2.name = "company 2"
+        rootmodel.organizations.push org2
+
+        rootmodel.sanity_check.should eq "Duplicate organization integration_id: 1."
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fruit_to_lime
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
   prerelease: 
 platform: ruby
 authors: