flat_kit 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90aee146f0054a6afc302716d7bcbac4e013e0ec67bd09d390de326d9d090a27
-  data.tar.gz: b34138e0095b751ff2e29322c3899f7c4df54b5bd9649e2c2c9d550966225acb
+  metadata.gz: 1f30ca1aa08d445cdae1e2da95f32bcf3185e0ab5f003675d777cce2741ed3b8
+  data.tar.gz: 42606f14ad0e846e83734388f8250c0045a80208b9a91034360dc86c088121a4
 SHA512:
-  metadata.gz: 27f23b37c07b0702152904ffe4062269a091005dd112a570f374b902cedb9c489d5802e3d7cac366a275da435a5f1d38b25f3d20e34b8e12f3185330bdd65b0e
-  data.tar.gz: 9f11eda352f16db26ec54793836ff0e5153fb624659989d710789b7afb07a46be284ccbe235e649fb0bcb676327a040fc35f91a63c20c9772cccb3e50517e150
+  metadata.gz: c6b318485580e129ff979004c17ef21a4223aaf870224348b26353af7220ba8e57dfe11d21ad0870c9c0ccedd9ebcb1a1b40fc80417fef40dc8d27cdd569c205
+  data.tar.gz: b91c41e7778e598d2b3ab388b063e527dabceab2323c6ceb64ae8a1b68da4f13aceb79e3b400f4bbc56eb41456d717c4a498247777c6839e403f7998901f254e

data/CONTRIBUTING.md

@@ -27,8 +27,7 @@ easiest way to contribute.
 * Fork the [repo][].
 * Create a new branch for your issue: `git checkout -b issue/my-issue`
 * Lovingly craft your contribution:
-    * `rake develop` to bootstrap development. (skip if you already have bundler installed)
-    * `bundle install` to install dependencies.
+    * `bin/setup` to bootstrap development.
     * `rake test` to run tests
 * Make sure that `rake test` passes. It's important, I said it twice.
 * Add yourself to the contributors section below.

data/HISTORY.md

@@ -1,4 +1,19 @@
 # FlatKit Changelog
+
+## Version 1.0.0
+
+* Setup semaphore testing
+* Fix typos
+* Fix commandline error if no sub command is given
+* Add rubocop
+* Update supported to Ruby 3.0 or greater
+
+## Version 0.3.0
+
+* Changing the event listening api to include meta data about the event
+* Add field type detection
+* Add a 'stats' command to generate stats about the data file
+
 ## Version 0.2.0
 
 * add in event listening to allow for additional integrations

data/Manifest.txt

@@ -3,17 +3,29 @@ HISTORY.md
 LICENSE.txt
 Manifest.txt
 README.md
-Rakefile
-bin/fk
+exe/fk
+flat_kit.gemspec
 lib/flat_kit.rb
 lib/flat_kit/cli.rb
 lib/flat_kit/command.rb
 lib/flat_kit/command/cat.rb
 lib/flat_kit/command/merge.rb
 lib/flat_kit/command/sort.rb
+lib/flat_kit/command/stats.rb
 lib/flat_kit/descendant_tracker.rb
 lib/flat_kit/error.rb
 lib/flat_kit/event_emitter.rb
+lib/flat_kit/field_stats.rb
+lib/flat_kit/field_type.rb
+lib/flat_kit/field_type/boolean_type.rb
+lib/flat_kit/field_type/date_type.rb
+lib/flat_kit/field_type/float_type.rb
+lib/flat_kit/field_type/guess_type.rb
+lib/flat_kit/field_type/integer_type.rb
+lib/flat_kit/field_type/null_type.rb
+lib/flat_kit/field_type/string_type.rb
+lib/flat_kit/field_type/timestamp_type.rb
+lib/flat_kit/field_type/unknown_type.rb
 lib/flat_kit/format.rb
 lib/flat_kit/input.rb
 lib/flat_kit/input/file.rb
@@ -25,44 +37,27 @@ lib/flat_kit/jsonl/reader.rb
 lib/flat_kit/jsonl/record.rb
 lib/flat_kit/jsonl/writer.rb
 lib/flat_kit/leaf_node.rb
+lib/flat_kit/log_formatter.rb
 lib/flat_kit/logger.rb
 lib/flat_kit/merge.rb
 lib/flat_kit/merge_tree.rb
 lib/flat_kit/output.rb
 lib/flat_kit/output/file.rb
 lib/flat_kit/output/io.rb
+lib/flat_kit/position.rb
 lib/flat_kit/reader.rb
 lib/flat_kit/record.rb
 lib/flat_kit/sentinel_internal_node.rb
 lib/flat_kit/sentinel_leaf_node.rb
 lib/flat_kit/sort.rb
+lib/flat_kit/stat_type.rb
+lib/flat_kit/stat_type/nominal_stats.rb
+lib/flat_kit/stat_type/numerical_stats.rb
+lib/flat_kit/stat_type/ordinal_stats.rb
+lib/flat_kit/stats.rb
 lib/flat_kit/writer.rb
 lib/flat_kit/xsv.rb
 lib/flat_kit/xsv/format.rb
 lib/flat_kit/xsv/reader.rb
 lib/flat_kit/xsv/record.rb
 lib/flat_kit/xsv/writer.rb
-tasks/default.rake
-tasks/extension.rake
-tasks/man.rake
-tasks/this.rb
-test/device_dataset.rb
-test/input/test_file.rb
-test/input/test_io.rb
-test/jsonl/test_format.rb
-test/jsonl/test_reader.rb
-test/jsonl/test_record.rb
-test/jsonl/test_writer.rb
-test/output/test_file.rb
-test/output/test_io.rb
-test/test_conversions.rb
-test/test_event_emitter.rb
-test/test_format.rb
-test/test_helper.rb
-test/test_merge.rb
-test/test_merge_tree.rb
-test/test_version.rb
-test/xsv/test_format.rb
-test/xsv/test_reader.rb
-test/xsv/test_record.rb
-test/xsv/test_writer.rb

data/{bin → exe}/fk

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'flat_kit'
+require "flat_kit"
 FlatKit::Cli.new.run(argv: ARGV, env: ENV)

data/flat_kit.gemspec

@@ -0,0 +1,33 @@
+# DO NOT EDIT - This file is automatically generated
+# Make changes to Manifest.txt and/or Rakefile and regenerate
+# -*- encoding: utf-8 -*-
+# stub: flat_kit 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "flat_kit".freeze
+  s.version = "1.0.0".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.metadata = { "bug_tracker_uri" => "https://github.com/copiousfreetime/flat_kit/issues", "changelog_uri" => "https://github.com/copiousfreetime/flat_kit/blob/master/HISTORY.md", "homepage_uri" => "https://github.com/copiousfreetime/flat_kit", "label" => "flat_kit", "rubygems_mfa_required" => "true", "source_code_uri" => "https://github.com/copiousfreetime/flat_kit" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Jeremy Hinegardner".freeze]
+  s.bindir = "exe".freeze
+  s.date = "2024-04-28"
+  s.description = "A library and commandline program for reading, writing, indexing,  sorting, and merging CSV, TSV, JSON and other flat-file formats.".freeze
+  s.email = "jeremy@copiousfreetime.org".freeze
+  s.executables = ["fk".freeze]
+  s.extra_rdoc_files = ["CONTRIBUTING.md".freeze, "HISTORY.md".freeze, "LICENSE.txt".freeze, "Manifest.txt".freeze, "README.md".freeze]
+  s.files = ["CONTRIBUTING.md".freeze, "HISTORY.md".freeze, "LICENSE.txt".freeze, "Manifest.txt".freeze, "README.md".freeze, "exe/fk".freeze, "flat_kit.gemspec".freeze, "lib/flat_kit.rb".freeze, "lib/flat_kit/cli.rb".freeze, "lib/flat_kit/command.rb".freeze, "lib/flat_kit/command/cat.rb".freeze, "lib/flat_kit/command/merge.rb".freeze, "lib/flat_kit/command/sort.rb".freeze, "lib/flat_kit/command/stats.rb".freeze, "lib/flat_kit/descendant_tracker.rb".freeze, "lib/flat_kit/error.rb".freeze, "lib/flat_kit/event_emitter.rb".freeze, "lib/flat_kit/field_stats.rb".freeze, "lib/flat_kit/field_type.rb".freeze, "lib/flat_kit/field_type/boolean_type.rb".freeze, "lib/flat_kit/field_type/date_type.rb".freeze, "lib/flat_kit/field_type/float_type.rb".freeze, "lib/flat_kit/field_type/guess_type.rb".freeze, "lib/flat_kit/field_type/integer_type.rb".freeze, "lib/flat_kit/field_type/null_type.rb".freeze, "lib/flat_kit/field_type/string_type.rb".freeze, "lib/flat_kit/field_type/timestamp_type.rb".freeze, "lib/flat_kit/field_type/unknown_type.rb".freeze, "lib/flat_kit/format.rb".freeze, "lib/flat_kit/input.rb".freeze, "lib/flat_kit/input/file.rb".freeze, "lib/flat_kit/input/io.rb".freeze, "lib/flat_kit/internal_node.rb".freeze, "lib/flat_kit/jsonl.rb".freeze, "lib/flat_kit/jsonl/format.rb".freeze, "lib/flat_kit/jsonl/reader.rb".freeze, "lib/flat_kit/jsonl/record.rb".freeze, "lib/flat_kit/jsonl/writer.rb".freeze, "lib/flat_kit/leaf_node.rb".freeze, "lib/flat_kit/log_formatter.rb".freeze, "lib/flat_kit/logger.rb".freeze, "lib/flat_kit/merge.rb".freeze, "lib/flat_kit/merge_tree.rb".freeze, "lib/flat_kit/output.rb".freeze, "lib/flat_kit/output/file.rb".freeze, "lib/flat_kit/output/io.rb".freeze, "lib/flat_kit/position.rb".freeze, "lib/flat_kit/reader.rb".freeze, "lib/flat_kit/record.rb".freeze, "lib/flat_kit/sentinel_internal_node.rb".freeze, "lib/flat_kit/sentinel_leaf_node.rb".freeze, "lib/flat_kit/sort.rb".freeze, "lib/flat_kit/stat_type.rb".freeze, "lib/flat_kit/stat_type/nominal_stats.rb".freeze, "lib/flat_kit/stat_type/numerical_stats.rb".freeze, "lib/flat_kit/stat_type/ordinal_stats.rb".freeze, "lib/flat_kit/stats.rb".freeze, "lib/flat_kit/writer.rb".freeze, "lib/flat_kit/xsv.rb".freeze, "lib/flat_kit/xsv/format.rb".freeze, "lib/flat_kit/xsv/reader.rb".freeze, "lib/flat_kit/xsv/record.rb".freeze, "lib/flat_kit/xsv/writer.rb".freeze]
+  s.homepage = "http://github.com/copiousfreetime/flat_kit".freeze
+  s.licenses = ["MIT".freeze]
+  s.rdoc_options = ["--main".freeze, "README.md".freeze, "--markup".freeze, "tomdoc".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
+  s.rubygems_version = "3.5.9".freeze
+  s.summary = "A library and commandline program for reading, writing, indexing, sorting, and merging CSV, TSV, JSON and other flat-file formats.".freeze
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<oj>.freeze, ["~> 3.0".freeze])
+  s.add_runtime_dependency(%q<optimist>.freeze, ["~> 3.0".freeze])
+  s.add_runtime_dependency(%q<csv>.freeze, ["~> 3.3".freeze])
+end

data/lib/flat_kit/cli.rb

@@ -1,7 +1,11 @@
-require 'optimist'
-require_relative '../flat_kit/command'
+# frozen_string_literal: true
+
+require "optimist"
+require_relative "../flat_kit/command"
 
 module FlatKit
+  # Public: The the main entry point for the command line interface
+  #
   class Cli
     attr_reader :options
 
@@ -13,18 +17,18 @@ module FlatKit
       @parser ||= ::Optimist::Parser.new do
         version ::FlatKit::VERSION
 
-        banner "fk v#{self.version}"
+        banner "fk v#{version}"
 
         banner <<~USAGE
 
-        Usage:
-          fk <command> [<args>...]
-          fk [options]
+          Usage:
+            fk <command> [<args>...]
+            fk [options]
         USAGE
 
         banner <<~OPTIONS
 
-        Options:
+          Options:
 
         OPTIONS
 
@@ -40,8 +44,8 @@ module FlatKit
     end
 
     def self.commands_banner
-      sorted_commands = FlatKit::Command.children.sort_by{ |c| c.name }
-      left_width = sorted_commands.map { |c| c.name.length }.sort.last
+      sorted_commands = FlatKit::Command.children.sort_by(&:name)
+      left_width = sorted_commands.map { |c| c.name.length }.max
       banner = StringIO.new
       banner.puts
       banner.puts "Commands:"
@@ -54,27 +58,48 @@ module FlatKit
     end
 
     def run(argv: ARGV, env: ENV)
-      opts = ::Optimist::with_standard_exception_handling(parser) do
+      opts = parse_opts(argv)
+      init_logging(opts)
+      ::FlatKit.logger.debug(argv)
+
+      command_name = argv.shift
+      exit_if_help(command_name)
+
+      command_klass = command_klass_or_exit(command_name)
+      command = command_klass.new(argv: argv, logger: ::FlatKit.logger, env: env)
+      command.call
+    end
+
+    private
+
+    def parse_opts(argv)
+      ::Optimist.with_standard_exception_handling(parser) do
         parser.parse(argv)
       end
+    end
 
-      if opts[:log_given] then
-        ::FlatKit.log_to(opts[:log])
-      end
+    def init_logging(opts)
+      ::FlatKit.log_to(opts[:log]) if opts[:log_given]
 
-      if opts[:verbose] then
-        ::FlatKit.logger.level = :debug
-      else
-        ::FlatKit.logger.level = :info
-      end
+      ::FlatKit.logger.level = opts[:verbose] ? :debug : :info
+
+      ::FlatKit.logger.debug(opts)
+    end
 
-      ::FlatKit.logger.debug opts
-      ::FlatKit.logger.debug argv
+    def exit_if_help(command_name)
+      return unless command_name.nil? || command_name.downcase == "help"
 
-      command_name  = argv.shift
+      parser.educate
+      exit 0
+    end
+
+    def command_class_or_exit(command_name)
       command_klass = FlatKit::Command.for(command_name)
-      command       = command_klass.new(argv: argv, logger: ::FlatKit.logger, env: env)
-      command.call
+      return command_klass unless command_klass.nil?
+
+      $stdout.puts "ERROR: Unknown command '#{command_name}'"
+      parser.educate
+      exit 0
     end
   end
 end

data/lib/flat_kit/command/cat.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module FlatKit
   class Command
+    # Internal: The implementation of the cat command.
+    #
     # TODO: Implement the --flatten commandline switch
     class Cat < ::FlatKit::Command
       def self.name
@@ -12,43 +16,43 @@ module FlatKit
 
       def self.parser
         ::Optimist::Parser.new do
-          banner "#{Cat.description}"
+          banner Cat.description.to_s
           banner ""
 
           banner <<~BANNER
-          Concatenates files that have the same field structure together into
-          a single file. The files can be of different formats, but must have
-          the same fields and names.
+            Concatenates files that have the same field structure together into
+            a single file. The files can be of different formats, but must have
+            the same fields and names.
 
-          This is probably most easily usable as a way to convert CSV to JSON
-          and vice versa.
+            This is probably most easily usable as a way to convert CSV to JSON
+            and vice versa.
 
-          The flatfile type(s) will be automatically determined by the file name.
-          If the inputs or output is not a file, but from stdin or stdout then
-          the input and output types must be specified.
+            The flatfile type(s) will be automatically determined by the file name.
+            If the inputs or output is not a file, but from stdin or stdout then
+            the input and output types must be specified.
 
-          NOTE: If converting from JSON to CSV and the input JSON does not have
-                every possible field on ever record, then the output csv iwll
-                be corrupted.
+            NOTE: If converting from JSON to CSV and the input JSON does not have
+                  every possible field on ever record, then the output csv iwll
+                  be corrupted.
 
-                In this case the input json should be fed through 'flatten' first
-                or use the '--flatten' flag which will require an additional pass
-                through the input to gather all the fields
+                  In this case the input json should be fed through 'flatten' first
+                  or use the '--flatten' flag which will require an additional pass
+                  through the input to gather all the fields
           BANNER
 
           banner <<~USAGE
 
-          Usage:
-            fk cat file1.csv file2.csv > combinded.csv
-            fk cat --output-format json file1.csv
-            fk cat file1.csv.gzip -o file2.json.gzip
-            fk cat file1.csv.gzip --output-format json | gzip -c > file1.jsonl.gz
+            Usage:
+              fk cat file1.csv file2.csv > combinded.csv
+              fk cat --output-format json file1.csv
+              fk cat file1.csv.gzip -o file2.json.gzip
+              fk cat file1.csv.gzip --output-format json | gzip -c > file1.jsonl.gz
 
           USAGE
 
           banner <<~OPTIONS
 
-          Options:
+            Options:
 
           OPTIONS
 
@@ -60,17 +64,15 @@ module FlatKit
 
       def parse
         parser = self.class.parser
-        ::Optimist::with_standard_exception_handling(parser) do
-          begin
-            @opts = parser.parse(argv)
-            paths = parser.leftovers
-
-            @readers = ::FlatKit::Reader.create_readers_from_paths(paths: paths, fallback: opts[:input_format])
-            @writer  = ::FlatKit::Writer.create_writer_from_path(path: opts[:output], fallback: opts[:output_format],
-                                                                 reader_format: @readers.first.format_name)
-          rescue ::FlatKit::Error => e
-            raise ::Optimist::CommandlineError, e.message
-          end
+        ::Optimist.with_standard_exception_handling(parser) do
+          @opts = parser.parse(argv)
+          paths = parser.leftovers
+
+          @readers = ::FlatKit::Reader.create_readers_from_paths(paths: paths, fallback: opts[:input_format])
+          @writer  = ::FlatKit::Writer.create_writer_from_path(path: opts[:output], fallback: opts[:output_format],
+                                                               reader_format: @readers.first.format_name)
+        rescue ::FlatKit::Error => e
+          raise ::Optimist::CommandlineError, e.message
         end
       end
 

data/lib/flat_kit/command/merge.rb

@@ -1,8 +1,11 @@
-require 'csv'
+# frozen_string_literal: true
+
+require "csv"
 module FlatKit
   class Command
+    # Internal: The implementation of the merge command.
+    #
     class Merge < ::FlatKit::Command
-
       def self.name
         "merge"
       end
@@ -13,43 +16,43 @@ module FlatKit
 
       def self.parser
         ::Optimist::Parser.new do
-          banner "#{Merge.description}"
+          banner Merge.description.to_s
           banner ""
 
           banner <<~BANNER
-          Given a set of input files that have the same structure, and are already
-          sorted by a set of keys. The Merge command will merge all those files
-          into a single output file.
+            Given a set of input files that have the same structure, and are already
+            sorted by a set of keys. The Merge command will merge all those files
+            into a single output file.
 
-          The --key parameter is required, and it must be a comma separated list
-          of field nams on the input on which to use as the sort key for the merge
-          process.
+            The --key parameter is required, and it must be a comma separated list
+            of field nams on the input on which to use as the sort key for the merge
+            process.
 
-          There must also be at least 2 input files. Merging only 1 file into an
-          output file is the same as the 'cat' command.
+            There must also be at least 2 input files. Merging only 1 file into an
+            output file is the same as the 'cat' command.
 
-          The flatfile type(s) will be automatically determined by the file name.
-          If the output is not a file, but to stdout then the output type will
-          be the same as the first input file, or it can be specified as a commandline
-          switch.
+            The flatfile type(s) will be automatically determined by the file name.
+            If the output is not a file, but to stdout then the output type will
+            be the same as the first input file, or it can be specified as a commandline
+            switch.
 
-          The merge will do a single pass through the input to generate the
-          output.
+            The merge will do a single pass through the input to generate the
+            output.
           BANNER
 
           banner <<~USAGE
 
-          Usage:
-            fk merge --key surname,given_name file1.csv file2.csv > all.csv
-            fk merge --key surname,given_name --output-format json file1.csv file2.csv > all.json
-            fk merge --key field1,field2 --output-format json input*.csv | gzip -c > all.json.gz
-            fk merge --key field12 file*.json.gz -o all.json.gz
+            Usage:
+              fk merge --key surname,given_name file1.csv file2.csv > all.csv
+              fk merge --key surname,given_name --output-format json file1.csv file2.csv > all.json
+              fk merge --key field1,field2 --output-format json input*.csv | gzip -c > all.json.gz
+              fk merge --key field12 file*.json.gz -o all.json.gz
 
           USAGE
 
           banner <<~OPTIONS
 
-          Options:
+            Options:
 
           OPTIONS
 
@@ -64,19 +67,17 @@ module FlatKit
 
       def parse
         parser = self.class.parser
-        ::Optimist::with_standard_exception_handling(parser) do
-          begin
-            @opts = parser.parse(argv)
-            @compare_keys = CSV.parse_line(opts[:key])
-            paths = parser.leftovers
-            raise ::Optimist::CommandlineError, "At least 2 input files are required" if paths.size < 2
-
-            @merge = ::FlatKit::Merge.new(inputs: paths, input_fallback: opts[:input_format],
-                                          compare_fields: @compare_keys,
-                                          output: opts[:output], output_fallback: opts[:output_format])
-          rescue ::FlatKit::Error => e
-            raise ::Optimist::CommandlineError, e.message
-          end
+        ::Optimist.with_standard_exception_handling(parser) do
+          @opts = parser.parse(argv)
+          @compare_keys = CSV.parse_line(opts[:key])
+          paths = parser.leftovers
+          raise ::Optimist::CommandlineError, "At least 2 input files are required" if paths.size < 2
+
+          @merge = ::FlatKit::Merge.new(inputs: paths, input_fallback: opts[:input_format],
+                                        compare_fields: @compare_keys,
+                                        output: opts[:output], output_fallback: opts[:output_format])
+        rescue ::FlatKit::Error => e
+          raise ::Optimist::CommandlineError, e.message
         end
       end
 

data/lib/flat_kit/command/sort.rb

@@ -1,8 +1,11 @@
-require 'csv'
+# frozen_string_literal: true
+
+require "csv"
 module FlatKit
   class Command
+    # Internal: The implementation of the sort command.
+    #
     class Sort < ::FlatKit::Command
-
       def self.name
         "sort"
       end
@@ -13,41 +16,41 @@ module FlatKit
 
       def self.parser
         ::Optimist::Parser.new do
-          banner "#{Sort.description}"
+          banner Sort.description.to_s
           banner ""
 
           banner <<~BANNER
-          Given an input file and a sort key, order the records in that file by that
-          key. If no input file is given the stdin is assumed. If no output file
-          is given then stdout is assumed.
+            Given an input file and a sort key, order the records in that file by that
+            key. If no input file is given the stdin is assumed. If no output file
+            is given then stdout is assumed.
 
-          The --key parameter is required, and it must be a comma separated list
-          of field nams on the input on which to use as the sort key for the merge
-          process.
+            The --key parameter is required, and it must be a comma separated list
+            of field nams on the input on which to use as the sort key for the merge
+            process.
 
-          There must also be only 1 input files.
+            There must also be only 1 input files.
 
-          The flatfile type(s) will be automatically determined by the file name.
-          If the output is not a file, but to stdout then the output type will
-          be the same as the first input file, or it can be specified as a commandline
-          switch.
+            The flatfile type(s) will be automatically determined by the file name.
+            If the output is not a file, but to stdout then the output type will
+            be the same as the first input file, or it can be specified as a commandline
+            switch.
 
           BANNER
 
           banner <<~USAGE
 
-          Usage:
-            fk sort --key surname,given_name file.csv > sorted.csv
-            fk sort --key surname,given_name --output-format json file.csv > sorted.json
-            fk sort --key field1,field2 --output-format json input.csv | gzip -c > sorted.json.gz
-            fk sort --key field1 file.json.gz -o sorted.json.gz
-            gunzip -c file.json.gz | fk sort --key field1 --input-format json --output-format json > gzip -c sorted.json.gz
+            Usage:
+              fk sort --key surname,given_name file.csv > sorted.csv
+              fk sort --key surname,given_name --output-format json file.csv > sorted.json
+              fk sort --key field1,field2 --output-format json input.csv | gzip -c > sorted.json.gz
+              fk sort --key field1 file.json.gz -o sorted.json.gz
+              gunzip -c file.json.gz | fk sort --key field1 --input-format json --output-format json > gzip -c sorted.json.gz
 
           USAGE
 
           banner <<~OPTIONS
 
-          Options:
+            Options:
 
           OPTIONS
 
@@ -58,25 +61,22 @@ module FlatKit
         end
       end
 
-      attr_reader :compare_keys
-      attr_reader :reader
-      attr_reader :sort
+      attr_reader :compare_keys, :reader, :sort
 
       def parse
         parser = self.class.parser
-        ::Optimist::with_standard_exception_handling(parser) do
-          begin
-            @opts = parser.parse(argv)
-            @compare_keys = CSV.parse_line(opts[:key])
-            paths = parser.leftovers
-            raise ::Optimist::CommandlineError, "1 and only 1 input file is allowed" if paths.size > 1
-            path = paths.first || "-" # default to stdin
-            @sort = ::FlatKit::Sort.new(input: path, input_fallback: opts[:input_format],
-                                        output: opts[:output], output_fallback: opts[:output_format],
-                                        compare_fields: @compare_keys)
-          rescue ::FlatKit::Error => e
-            raise ::Optimist::CommandlineError, e.message
-          end
+        ::Optimist.with_standard_exception_handling(parser) do
+          @opts = parser.parse(argv)
+          @compare_keys = CSV.parse_line(opts[:key])
+          paths = parser.leftovers
+          raise ::Optimist::CommandlineError, "1 and only 1 input file is allowed" if paths.size > 1
+
+          path = paths.first || "-" # default to stdin
+          @sort = ::FlatKit::Sort.new(input: path, input_fallback: opts[:input_format],
+                                      output: opts[:output], output_fallback: opts[:output_format],
+                                      compare_fields: @compare_keys)
+        rescue ::FlatKit::Error => e
+          raise ::Optimist::CommandlineError, e.message
         end
       end