octocatalog-diff 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c315a978c543c665c37c9e3d8baee4cd51bd8ad0
-  data.tar.gz: b3ea77a256af869d688f3792aee560f9f582979c
+  metadata.gz: 0a6057ffec45d60dbe793f5b81170c1d00b7d1af
+  data.tar.gz: 158d57d91c2d57d3f796732b814f85394346f553
 SHA512:
-  metadata.gz: eb2810e2f011003b2cf5a99ea043936a990e97311de88d401142965a34450c1b29147bc2d151f8bf7f410a168758b4b10a97700a2ec5cafa354fe8f7d5f0fe6e
-  data.tar.gz: 2977a910bd86d03b634178b5333d33f3694d6a90b97890cfaaa7351169c84b1da83d6c3858a12c7d27c31597deb6c483a847e28f1bd9b88aa7873ddb9f2fda69
+  metadata.gz: 2ea4c161583582db60e6e89349ff4c2e2153080fc27a01b2b7a5f01af3ef920d52b69a1515c7f4c51329036c7949aea5ad7d97221e6a987a765240f4b5cc05e8
+  data.tar.gz: fbccb8d52fe1346f880584d95405b744e119528686846c7dfcd36d0e7087273c27c5703d90ad5a985b7fd1e6ef558e9b2b34c677d4508f52ecb791314166cb1b

data/.version

@@ -1 +1 @@
-1.0.1
+1.0.2

data/doc/CHANGELOG.md

@@ -8,6 +8,13 @@
 </tr>
 </thead><tbody>
 <tr valign=top>
+<td>1.0.2</td>
+<td>2017-03-08</td>
+<td>
+<li><a href="https://github.com/github/octocatalog-diff/pull/91">#91</a>: `--no-truncate-details` option</li>
+</td>
+</tr>
+<tr valign=top>
 <td>1.0.1</td>
 <td>2017-02-14</td>
 <td>

data/doc/optionsref.md

@@ -59,6 +59,7 @@ Usage: octocatalog-diff [command line options]
         --from-enc PATH              Path to ENC script (for the from catalog only)
         --to-enc PATH                Path to ENC script (for the to catalog only)
         --[no-]display-detail-add    Display parameters and other details for added resources
+        --[no-]truncate-details      Truncate details with --display-detail-add
         --no-header                  Do not print a header
         --default-header             Print default header with output
         --header STRING              Specify header for output
@@ -1092,6 +1093,21 @@ These files must exist and be in Puppet catalog format. (<a href="../lib/octocat
     </td>
   </tr>
 
+  <tr>
+    <td valign=top>
+      <pre><code>--truncate-details
+--no-truncate-details </code></pre>
+    </td>
+    <td valign=top>
+      Truncate details with --display-detail-add
+    </td>
+    <td valign=top>
+      When using `--display-detail-add` by default the details of any field will be truncated
+at 80 characters. Specify `--no-truncate-details` to display the full output. This option
+has no effect when `--display-detail-add` is not used. (<a href="../lib/octocatalog-diff/cli/options/truncate_details.rb">truncate_details.rb</a>)
+    </td>
+  </tr>
+
   <tr>
     <td valign=top>
       <pre><code>--validate-references

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

@@ -168,13 +168,14 @@ module OctocatalogDiff
           result = []
           add_source_file_line_info(item: item, result: result, new_loc: new_loc, options: options, logger: logger)
           if options[:display_detail_add] && diff.key?('parameters')
+            limit = options.fetch(:truncate_details, true) ? 80 : nil
             result << "+ #{item} =>".green
             result << '   parameters =>'.green
             result.concat(
               diff_two_hashes_with_diffy(
                 depth: 1,
                 hash2: Hash[diff['parameters'].sort], # Should work with somewhat older rubies too
-                limit: 80,
+                limit: limit,
                 strip_diff: true
               ).map(&:green)
             )
@@ -326,7 +327,7 @@ module OctocatalogDiff
         # @param depth [Fixnum] Depth, for correct indentation
         # @param limit [Fixnum] Maximum string length
         # @param strip_diff [Boolean] Strip leading +/-/" "
-        # @return Array<String> Displayable result
+        # @return [Array<String>] Displayable result
         def self.diff_two_hashes_with_diffy(opts = {})
           depth = opts.fetch(:depth, 0)
           hash1 = opts.fetch(:hash1, {})
@@ -334,6 +335,9 @@ module OctocatalogDiff
           limit = opts[:limit]
           strip_diff = opts.fetch(:strip_diff, false)
 
+          # Special case: addition only, no truncation
+          return addition_only_no_truncation(depth, hash2) if hash1 == {} && limit.nil?
+
           json_old = stringify_for_diffy(hash1)
           json_new = stringify_for_diffy(hash2)
 
@@ -353,6 +357,30 @@ module OctocatalogDiff
           end
         end
 
+        # Special case: addition only, no truncation
+        # @param depth [Fixnum] Depth, for correct indentation
+        # @param hash [Hash] Added object
+        # @return [Array<String>] Displayable result
+        def self.addition_only_no_truncation(depth, hash)
+          result = []
+
+          # Single line strings
+          hash.keys.sort.map do |key|
+            next if hash[key] =~ /\n/
+            result << left_pad(2 * depth + 4, [key.inspect, ': ', hash[key].inspect].join('')).green
+          end
+
+          # Multi-line strings
+          hash.keys.sort.map do |key|
+            next if hash[key] !~ /\n/
+            result << left_pad(2 * depth + 4, [key.inspect, ': >>>'].join('')).green
+            result.concat hash[key].split(/\n/).map(&:green)
+            result << '<<<'.green
+          end
+
+          result
+        end
+
         # Limit length of a string
         # @param str [String] String
         # @param limit [Fixnum] Limit (0=unlimited)

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

@@ -37,6 +37,7 @@ module OctocatalogDiff
         opts[:compilation_from_dir] = options[:compilation_from_dir] || nil
         opts[:compilation_to_dir] = options[:compilation_to_dir] || nil
         opts[:display_detail_add] = options.fetch(:display_detail_add, false)
+        opts[:truncate_details] = options.fetch(:truncate_details, true)
         opts[:display_datatype_changes] = options.fetch(:display_datatype_changes, false)
 
         # Call appropriate display method

data/lib/octocatalog-diff/cli/options/truncate_details.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# When using `--display-detail-add` by default the details of any field will be truncated
+# at 80 characters. Specify `--no-truncate-details` to display the full output. This option
+# has no effect when `--display-detail-add` is not used.
+# @param parser [OptionParser object] The OptionParser argument
+# @param options [Hash] Options hash being constructed; this is modified in this method.
+OctocatalogDiff::Cli::Options::Option.newoption(:truncate_details) do
+  has_weight 251
+
+  def parse(parser, options)
+    parser.on('--[no-]truncate-details', 'Truncate details with --display-detail-add') do |x|
+      options[:truncate_details] = x
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octocatalog-diff
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - GitHub, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -381,6 +381,7 @@ files:
 - lib/octocatalog-diff/cli/options/storeconfigs.rb
 - lib/octocatalog-diff/cli/options/suppress_absent_file_details.rb
 - lib/octocatalog-diff/cli/options/to_from_branch.rb
+- lib/octocatalog-diff/cli/options/truncate_details.rb
 - lib/octocatalog-diff/cli/options/validate_references.rb
 - lib/octocatalog-diff/cli/printer.rb
 - lib/octocatalog-diff/errors.rb