csv-diff-report 0.2 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTAxMGE1NTA2MjRhMjkzOGUyNThmMGQ1MjJmMGUwY2FjOWUzNzg2OQ==
+    NmNhMzlmNDc4ZGQ5NWU1MjdlMjdmN2JlNTI4NGQ0NWE1ODY0ZmVlMw==
   data.tar.gz: !binary |-
-    NDdhNTE0M2M5MWFmNDUyYTE4NTgyMWIzMWY0NWNkOTYwMGFhM2FmNA==
+    NjY0ODgxMmU1ZDFkZWQ2ZmY4MWQwNDU5NmM5YTUzNGJlODNmNzVkNw==
 SHA512:
   metadata.gz: !binary |-
-    YjU2ZGZjMTJlOTUzYzE1YTE5MmZiOTZkYTRhZjBhOWVmODRiMDlhMDI5ZDZh
-    ZTUzYjUxYzNlOGYzMDZiYTgzNjU1YTE2ZDkzZTk4Mjk1ZTQxMmI2MzAyYzM1
-    OGFmOWEzMTVjZDM0NThlYmExMWJlZjQwZmZkNWVkYWU1Nzk3ZTQ=
+    YTFiNmQ5YWZkNDllNmI0OGE3ZjI0ZjE2ZTYwY2U4YTUwZDliZDUzYTc1Njg1
+    NzBmOTg1YmFmMTkxY2VmNTdkNTliZTA0YTgzODJhMDZhOTFmN2U2MTlkZmQ1
+    MWEzMDcxM2U1NTZhNDVhMjgwYWI0MDNjNjA0NGRiOTZkMGUxNGY=
   data.tar.gz: !binary |-
-    N2I3NjgzYjQ0YTc5OTJkOTY2YWM3MTQyMDdiZjJiODdmNTQ5MDQ2MjBjZTYx
-    MjRhMDBiMTY1NDE0ZjI1YTE2NTUwZWFjZDcyMDFiMDg1MzNkMmU3MjVkNDBi
-    MDZkMWY2Yzk4YmVlYjZlMWNiZDQyYzIyMTg5MjA3MzJlODYxZmQ=
+    Y2Y4YzVjMzY1NGJlZTE0MTkzOGQ2YWEwODU1MzVmYjJmYzNhMWIxYTJjNDBh
+    NDQ5NTE1NTA0MjkyYmY0YTkxMmQ5NGUyYTkxYTE3NTQ5YzEzODJjMWI3NTJj
+    MzQ1ZTQyMmI1NzcxOWY3OWI4ZTNkZDYwZmE3MjkzYzEyMGVkNWE=

data/lib/csv-diff-report/cli.rb

@@ -47,6 +47,7 @@ class CSVDiff
         flag_arg :tab_delimited, 'If true, the file is assumed to be tab-delimited rather than comma-delimited'
         flag_arg :ignore_header, 'If true, the first line in each source file is ignored; ' +
             'requires the use of the --field-names option to name the fields'
+        flag_arg :ignore_case, 'If true, field comparisons are performed without regard to case'
 
         usage_break 'Diff Options'
         keyword_arg :ignore_fields, 'The names or indexes of any fields to be ignored during the diff',
@@ -95,11 +96,12 @@ class CSVDiff
         # Process a CSVDiffReport using +arguments+ to determine all options.
         def process(arguments)
             options = {}
-            exclude_args = [:from, :to, :tab_delimited]
+            exclude_args = [:from, :to, :tab_delimited, :ignore_case]
             arguments.each_pair do |arg, val|
                 options[arg] = val if val && !exclude_args.include?(arg)
             end
             options[:csv_options] = {:col_sep => "\t"} if arguments.tab_delimited
+            options[:case_sensitive] = !arguments.ignore_case
             rep = CSVDiff::Report.new
             rep.diff(arguments.from, arguments.to, options)
 

data/lib/csv-diff-report/excel.rb

@@ -50,11 +50,11 @@ class CSVDiff
             xl.workbook.add_worksheet(name: 'Summary') do |sheet|
                 sheet.add_row do |row|
                     row.add_cell 'From:', :style => @xl_styles['Title']
-                    row.add_cell compare_from
+                    row.add_cell @diffs.size > 1 ? File.dirname(compare_from) : compare_from
                 end
                 sheet.add_row do |row|
                     row.add_cell 'To:', :style => @xl_styles['Title']
-                    row.add_cell compare_to
+                    row.add_cell @diffs.size > 1 ? File.dirname(compare_to) : compare_to
                 end
                 sheet.add_row
                 sheet.add_row ['Sheet', 'Adds', 'Deletes', 'Updates', 'Moves'], :style => @xl_styles['Title']
@@ -64,7 +64,8 @@ class CSVDiff
                 sheet.column_info.first.width = 20
 
                 @diffs.each do |file_diff|
-                    sheet.add_row([File.basename(file_diff.left.path, File.extname(file_diff.left.path)),
+                    sheet.add_row([file_diff.options[:sheet_name] ||
+                                   File.basename(file_diff.left.path, File.extname(file_diff.left.path)),
                                    file_diff.summary['Add'], file_diff.summary['Delete'],
                                    file_diff.summary['Update'], file_diff.summary['Move']])
                     xl_diff_sheet(xl, file_diff) if file_diff.diffs.size > 0
@@ -76,10 +77,16 @@ class CSVDiff
 
         # Add diff sheet
         def xl_diff_sheet(xl, file_diff)
-            sheet_name = File.basename(file_diff.left.path, File.extname(file_diff.left.path))
-            all_fields = [:row, :action, :sibling_position] + file_diff.diff_fields
+            sheet_name = file_diff.options[:sheet_name] ||
+                File.basename(file_diff.left.path, File.extname(file_diff.left.path))
+            all_fields = [:row, :action]
+            all_fields << :sibling_position unless file_diff.options[:ignore_moves]
+            freeze_cols = file_diff.options[:freeze_cols] ||
+                (all_fields.length + file_diff.left.key_fields.max + 1)
+            all_fields.concat(file_diff.diff_fields)
             xl.workbook.add_worksheet(name: sheet_name) do |sheet|
-                sheet.add_row(all_fields.map{ |f| f.to_s }, :style => @xl_styles['Title'])
+                sheet.add_row(all_fields.map{ |f| f.is_a?(Symbol) ? titleize(f) : f },
+                              :style => @xl_styles['Title'])
                 file_diff.diffs.sort_by{|k, v| v[:row] }.each do |key, diff|
                     sheet.add_row do |row|
                         chg = diff[:action]
@@ -107,8 +114,13 @@ class CSVDiff
                             end
                             case new
                             when String
-                                cell = row.add_cell(new.encode('utf-8'), :style => style) #, :type => :string)
-                            #    cell = row.add_cell(new, :style => style)
+                                if new =~ /^0+\d+(\.\d+)?/
+                                    # Don't let Excel auto-convert this to a number, as that
+                                    # will remove the leading zero(s)
+                                    cell = row.add_cell(new, :style => style, :type => :string)
+                                else
+                                    cell = row.add_cell(new.encode('utf-8'), :style => style)
+                                end
                             else
                                 cell = row.add_cell(new, :style => style)
                             end
@@ -120,7 +132,7 @@ class CSVDiff
                 sheet.column_info.each do |ci|
                     ci.width = 80 if ci.width > 80
                 end
-                xl_filter_and_freeze(sheet, 5)
+                xl_filter_and_freeze(sheet, freeze_cols)
             end
         end
 
@@ -143,7 +155,7 @@ class CSVDiff
             begin
                 xl.serialize(path)
                 path
-            rescue RuntimeError => ex
+            rescue StandardError => ex
                 Console.puts ex.message, :red
                 raise "Unable to replace existing Excel file #{path} - is it already open in Excel?"
             end

data/lib/csv-diff-report/html.rb

@@ -69,8 +69,13 @@ class CSVDiff
             body << '<p>Source Locations:</p>'
             body << '<table>'
             body << '<tbody>'
-            body << "<tr><th>From:</th><td>#{@left}</td></tr>"
-            body << "<tr><th>To:</th><td>#{@right}</td></tr>"
+            if @diffs.size > 1
+                body << "<tr><th>From:</th><td>#{File.dirname(@left)}</td></tr>"
+                body << "<tr><th>To:</th><td>#{File.dirname(@right)}</td></tr>"
+            else
+                body << "<tr><th>From:</th><td>#{@left}</td></tr>"
+                body << "<tr><th>To:</th><td>#{@right}</td></tr>"
+            end
             body << '</tbody>'
             body << '</table>'
             body << '<br>'
@@ -124,11 +129,13 @@ class CSVDiff
             end
             body << '</p>'
 
-            all_fields = [:row, :action, :sibling_position] + file_diff.diff_fields
+            all_fields = [:row, :action]
+            all_fields << :sibling_position unless file_diff.options[:ignore_moves]
+            all_fields.concat(file_diff.diff_fields)
             body << '<table>'
             body << '<thead><tr>'
             all_fields.each do |fld|
-                body << "<th>#{fld.to_s}</th>"
+                body << "<th>#{fld.is_a?(Symbol) ? titleize(fld) : fld}</th>"
             end
             body << '</tr></thead>'
             body << '<tbody>'

data/lib/csv-diff-report/report.rb

@@ -14,9 +14,30 @@ class CSVDiff
         include Html
 
 
-        # Instantiate a new diff report object.
-        def initialize
+        # Instantiate a new diff report object. Takes an optional block callback
+        # to use for handling the output generated by the diff process. If no
+        # callback is supplied, this output will be sent to the console using
+        # ColorConsole.
+        #
+        # @yield [*out] If supplied, the block passed to this method will be
+        #   called for each line of text to be output. The argument to the block
+        #   will be an array of text chunks, each of which may be accompanied by
+        #   optional foreground and background colours.
+        def initialize(&block)
             @diffs = []
+            @echo_handler = block
+        end
+
+
+        def echo(*args)
+            if @echo_handler
+                @echo_handler.call(*args)
+            else
+                args.each do |out|
+                    Console.write(*out)
+                end
+                Console.puts
+            end
         end
 
 
@@ -24,6 +45,26 @@ class CSVDiff
         def <<(diff)
             if diff.is_a?(CSVDiff)
                 @diffs << diff
+                unless @left
+                    @left = Pathname.new(diff.left.path)
+                    @right = Pathname.new(diff.right.path)
+                end
+                diff.diff_warnings.each{ |warn| echo warn, :yellow }
+                out = []
+                out << ["Found #{diff.diffs.size} differences"]
+                diff.summary.each_with_index.map do |pair, i|
+                    out << [i == 0 ? ": " : ", "]
+                    k, v = pair
+                    color = case k
+                            when 'Add' then :light_green
+                            when 'Delete' then :red
+                            when 'Update' then :cyan
+                            when 'Move' then :light_magenta
+                            when 'Warning' then :yellow
+                            end
+                    out << ["#{v} #{k}s", color]
+                end
+                echo(*out)
             else
                 raise ArgumentError, "Only CSVDiff objects can be added to a CSVDiff::Report"
             end
@@ -37,15 +78,15 @@ class CSVDiff
             @left = Pathname.new(left)
             @right = Pathname.new(right)
             if @left.file? && @right.file?
-                Console.puts "Performing file diff:"
-                Console.puts "  From File:    #{@left}"
-                Console.puts "  To File:      #{@right}"
+                echo "Performing file diff:"
+                echo "  From File:    #{@left}"
+                echo "  To File:      #{@right}"
                 opt_file = load_opt_file(@left.dirname)
                 diff_file(@left.to_s, @right.to_s, options, opt_file)
             elsif @left.directory? && @right.directory?
-                Console.puts "Performing directory diff:"
-                Console.puts "  From directory:  #{@left}"
-                Console.puts "  To directory:    #{@right}"
+                echo "Performing directory diff:"
+                echo "  From directory:  #{@left}"
+                echo "  To directory:    #{@right}"
                 opt_file = load_opt_file(@left)
                 if fts = options[:file_types]
                     file_types = find_matching_file_types(fts, opt_file)
@@ -69,15 +110,15 @@ class CSVDiff
         # @param format [Symbol] The output format for the report; one of :html or
         #   :xlsx.
         def output(path, format = :html)
-            path = case format.to_s
-            when /^html$/i
-                html_output(path)
-            when /^xls(x)?$/i
+            path = case
+            when format.to_s =~ /^xlsx?$/i || File.extname(path) =~ /xlsx?$/i
                 xl_output(path)
+            when format.to_s =~ /^html$/i || File.extname(path) =~ /html$/i
+                html_output(path)
             else
                 raise ArgumentError, "Unrecognised output format: #{format}"
             end
-            Console.puts "Diff report saved to '#{path}'"
+            echo "Diff report saved to '#{path}'"
         end
 
 
@@ -89,7 +130,7 @@ class CSVDiff
             opt_path = Pathname(dir + '.csvdiff')
             opt_path = Pathname('.csvdiff') unless opt_path.exist?
             if opt_path.exist?
-                Console.puts "Loading options from .csvdiff at '#{dir}'"
+                echo "Loading options from '#{opt_path}'"
                 opt_file = YAML.load(IO.read(opt_path))
                 symbolize_keys(opt_file)
             end
@@ -103,6 +144,11 @@ class CSVDiff
         end
 
 
+        def titleize(sym)
+            sym.to_s.gsub(/_/, ' ').gsub(/\b([a-z])/) { $1.upcase }
+        end
+
+
         # Locates the file types in +opt_file+ that match the +file_types+ list of
         # file type names or patterns
         def find_matching_file_types(file_types, opt_file)
@@ -114,15 +160,15 @@ class CSVDiff
                     if matches.size > 0
                         matched_fts.concat(matches)
                     else
-                        Console.puts "No file type matching '#{ft}' defined in .csvdiff", :yellow
-                        Console.puts "Known file types are: #{opt_file[:file_types].keys.join(', ')}", :yellow
+                        echo "No file type matching '#{ft}' defined in .csvdiff", :yellow
+                        echo "Known file types are: #{opt_file[:file_types].keys.join(', ')}", :yellow
                     end
                 end
             else
                 if opt_file
-                    Console.puts "No file types are defined in .csvdiff", :yellow
+                    echo "No file types are defined in .csvdiff", :yellow
                 else
-                    Console.puts "The file_types option can only be used when a " +
+                    echo "The file_types option can only be used when a " +
                         ".csvdiff is present in the LEFT or current directory", :yellow
                 end
             end
@@ -135,18 +181,17 @@ class CSVDiff
             pattern = Pathname(options[:pattern] || '*')
             exclude = options[:exclude]
 
-            Console.puts "  Include Pattern: #{pattern}"
-            Console.puts "  Exclude Pattern: #{exclude}" if exclude
+            echo "  Include Pattern: #{pattern}"
+            echo "  Exclude Pattern: #{exclude}" if exclude
 
-
-            left_files = Dir[left + pattern].sort
-            excludes = exclude ? Dir[left + exclude] : []
+            left_files = Dir[(left + pattern).to_s.gsub('\\', '/')].sort
+            excludes = exclude ? Dir[(left + exclude).to_s.gsub('\\', '/')] : []
             (left_files - excludes).each_with_index do |file, i|
                 right_file = right + File.basename(file)
                 if right_file.file?
                     diff_file(file, right_file.to_s, options, opt_file)
                 else
-                    Console.puts "Skipping file '#{File.basename(file)}', as there is " +
+                    echo "Skipping file '#{File.basename(file)}', as there is " +
                         "no corresponding TO file", :yellow
                 end
             end
@@ -164,23 +209,9 @@ class CSVDiff
             options = settings.merge(options)
             from = open_source(left, :from, options)
             to = open_source(right, :to, options)
-            diff = CSVDiff.new(left, right, options)
-            diff.diff_warnings.each{ |warn| Console.puts warn, :yellow }
-            Console.write "Found #{diff.diffs.size} differences"
-            diff.summary.each_with_index.map do |pair, i|
-                Console.write i == 0 ? ": " : ", "
-                k, v = pair
-                color = case k
-                        when 'Add' then :light_green
-                        when 'Delete' then :red
-                        when 'Update' then :cyan
-                        when 'Move' then :light_magenta
-                        when 'Warning' then :yellow
-                        end
-                Console.write "#{v} #{k}s", color
-            end
-            Console.puts
+            diff = CSVDiff.new(from, to, options)
             self << diff
+            diff
         end
 
 
@@ -190,14 +221,14 @@ class CSVDiff
             settings = opt_file && opt_file[:defaults] || {}
             opt_file && opt_file[:file_types] && opt_file[:file_types].each do |file_type, hsh|
                 unless hsh[:pattern]
-                    Console.puts "Invalid setting for file_type #{file_type} in .csvdiff; " +
+                    echo "Invalid setting for file_type #{file_type} in .csvdiff; " +
                         "missing a 'pattern' key to use to match files", :yellow
                     hsh[:pattern] = '-'
                 end
                 next if hsh[:pattern] == '-'
                 unless hsh[:matched_files]
-                    hsh[:matched_files] = Dir[(left.dirname + hsh[:pattern]).to_s]
-                    hsh[:matched_files] -= Dir[(left.dirname + hsh[:exclude]).to_s] if hsh[:exclude]
+                    hsh[:matched_files] = Dir[(left.dirname + hsh[:pattern]).to_s.gsub('\\', '/')]
+                    hsh[:matched_files] -= Dir[(left.dirname + hsh[:exclude]).to_s.gsub('\\', '/')] if hsh[:exclude]
                 end
                 if hsh[:matched_files].include?(left.to_s)
                     settings.merge!(hsh)
@@ -214,10 +245,11 @@ class CSVDiff
         # @param src [String] A path to the file to be opened.
         # @param options [Hash] An options hash to be passed to CSVSource.
         def open_source(src, left_right, options)
-            Console.write "Opening #{left_right.to_s.upcase} file '#{File.basename(src)}'..."
+            out = ["Opening #{left_right.to_s.upcase} file '#{File.basename(src)}'..."]
             csv_src = CSVDiff::CSVSource.new(src.to_s, options)
-            Console.puts "  #{csv_src.lines.size} lines read", :white
-            csv_src.warnings.each{ |warn| Console.puts warn, :yellow }
+            out << ["  #{csv_src.lines.size} lines read", :white]
+            echo(*out)
+            csv_src.warnings.each{ |warn| echo warn, :yellow }
             csv_src
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv-diff-report
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.1
 platform: ruby
 authors:
 - Adam Gardiner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv-diff
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: arg-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: color-console
   requirement: !ruby/object:Gem::Requirement