honey_format 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ea71ae5f48d46c64294767a6e52f2b47971e7cb578418e8947a7abfbd188a0
-  data.tar.gz: df93394a4afd2cf7e7cff2d9c25f185febfb57b7b400d28cc7b2d703e6a2d0c6
+  metadata.gz: 857b7d39a88dc2a08a7fe2e3659e4e35e0b5deec1d13b3507ec74849ed55a105
+  data.tar.gz: cc1bd4d205e225a9767d96cd7f49d89374b55c6221de42f28210666bb505193c
 SHA512:
-  metadata.gz: 5c95d38ebe74e9f1ace21c9ac8cb3e60dfbcd102996d8151a0dfc0c37e927a52ae9396a8b6f291160b69167bd4e6c2254a9f6290ef3e59b3a04d035dff06c124
-  data.tar.gz: f15d755c122826a0c20de5918e248a1e100b89d4b933569614a2732d2aed5300fbb4c252ce51a67d8f0a27cc2c4064383b246e3fe59b67ddab7e6ccec4f5568c
+  metadata.gz: 13e3ac4d6e10d6e416b21ef909e42960a9aa33b5d09fbb231f5703390d9b9440e2271fb3bc7842a8d233ec89652051de44c4bc7c542a06fd78853d8185ed5104
+  data.tar.gz: 66b176f2f89999eb80c4e2688fde3db94c92dc7a3d25f2520f838dfbbc38f61c8711ee0f266d282d5930a4eb65ba8cebcb44bc81b1cbd0fc6381515487f62e98

data/CHANGELOG.md

@@ -1,12 +1,21 @@
 # HEAD
 
-# v0.14.0
+## v0.15.0
+
+:warning: This release contains some backwards compatible changes.
+
+* Add `--skip-lines` argument to CLI [PR#22](https://github.com/buren/honey_format/pull/22)
+* Add support for CSV skip lines [PR#22](https://github.com/buren/honey_format/pull/22)
+* CLI have input file argument on tail instead of head [PR #21](https://github.com/buren/honey_format/pull/21)
+  - :warning: Backwards incompatible
+
+## v0.14.0
 
 * Additional converters
   + `integer_or_zero`
   + `decimal_or_zero`
 
-# v0.13.0
+## v0.13.0
 
 :warning: This release contains some backwards compatible changes.
 
@@ -20,21 +29,21 @@
 * Add `--[no-]rows-only` CLI option
 * Rename `--[no-]only-header` CLI option to `--[no-]header-only`
 
-# v0.12.0
+## v0.12.0
 
 * Add `--[no-]only-header` option to CLI
 * _[Bugfix]_: Handle missing --columns argument in CLI
 
-# v0.11.0
+## v0.11.0
 
 * Add CLI: `honey_format` executable
 * Swap `RowBuilder` <> `Row` class names [[#PR12](https://github.com/buren/honey_format/pull/12)]
 
-# v0.10.0
+## v0.10.0
 
 * Add support for filtering what rows are included in `#to_csv` [[#PR11](https://github.com/buren/honey_format/pull/11)]
 
-# v0.9.0
+## v0.9.0
 
 :warning: This release contains some backwards compatible changes.
 
@@ -45,41 +54,41 @@
   - There are now two super classes for errors `HeaderError` and `RowError`
   - All errors are under an `Errors` namespace, which `HoneyFormat` includes
 
-# v0.8.2
+## v0.8.2
 
 * _[Bugfix]_ `#to_csv` now outputs nil values as empty string instead of `""`
 
-# v0.8.1
+## v0.8.1
 
 * _[Bugfix]_ Properly quote cells with special CSV-characters in them. ([PR#7](https://github.com/buren/honey_format/pull/7))
 
-# v0.8.0
+## v0.8.0
 
 * _[Feature]_ Add `#size` and `#length` methods to `Header` and `Rows` objects
 * _[Bugfix]_ Improved Row error handling for when row size differs from header column
 
 
-# v0.7.0
+## v0.7.0
 
 * Don't sanitize each row :rocket: (improves performance from ~1.4x times slower than raw CSV to ~1.1)
 * Fold `Columns` class into `Header`
 * Remove `Sanitize` class
 
-# v0.6.0
+## v0.6.0
 
 * Add `CSV#to_csv` ([PR#2](https://github.com/buren/honey_format/pull/2))
 * `csv#rows` returns an instance of `Rows` instead of `Array`
 
-# v0.3.0 - v0.5.0
+## v0.3.0 - v0.5.0
 
 * Add CSV `row_builder` option
 * ...
 
-# v0.2.0
+## v0.2.0
 
 * More explicit exception classes
 * Restructured internals
 
-## v0.1.0
+### v0.1.0
 
 Initial release

data/README.md

@@ -29,7 +29,7 @@ Id,Username,Email
 CSV
 csv = HoneyFormat::CSV.new(csv_string, type_map: { id: :integer })
 csv.columns     # => [:id, :username]
-user = csv.rows # => [#<struct id="1", username="buren">]
+user = csv.rows # => [#<Row id="1", username="buren">]
 user.id         # => 1
 user.username   # => "buren"
 
@@ -70,7 +70,7 @@ header.columns # => [:id, :username]
 
 
 # Rows
-rows = csv.rows # => [#<struct id="1", username="buren">]
+rows = csv.rows # => [#<Row id="1", username="buren">]
 user = rows.first
 user.id         # => "1"
 user.username   # => "buren"
@@ -128,7 +128,7 @@ Custom row builder
 csv_string = "Id,Username\n1,buren"
 upcaser = ->(row) { row.tap { |r| r.username.upcase! } }
 csv = HoneyFormat::CSV.new(csv_string, row_builder: upcaser)
-csv.rows # => [#<struct id="1", username="BUREN">]
+csv.rows # => [#<Row id="1", username="BUREN">]
 ```
 
 As long as the row builder responds to `#call` you can pass anything you like
@@ -282,18 +282,36 @@ You can see all [available errors here](https://www.rubydoc.info/gems/honey_form
 
 If you want to see more usage examples check out the [`examples/`](https://github.com/buren/honey_format/tree/master/examples) and [`spec/`](https://github.com/buren/honey_format/tree/master/spec) directories.
 
+__Skip lines__
+
+> Skip comments and/or other unwanted lines from being parsed.
+
+```ruby
+csv_string = <<~CSV
+Id,Username
+1,buren
+# comment
+2,jacob
+CSV
+regexp = %r{\A#} # Match all lines that start with "#"
+csv = HoneyFormat::CSV.new(csv_string, skip_lines: regexp)
+csv.rows.length # => 2
+```
+
+
 ## CLI
 
 > Perfect when you want to get something simple done quickly.
 
 ```
-Usage: honey_format [file.csv] [options]
+Usage: honey_format [options] <file.csv>
         --csv=input.csv              CSV file
-        --[no-]header-only           Print only the header
-        --[no-]rows-only             Print only the rows
-        --columns=id,name            Select columns.
+        --columns=id,name            Select columns
         --output=output.csv          CSV output (STDOUT otherwise)
         --delimiter=,                CSV delimiter (default: ,)
+        --skip-lines=,               Skip lines that match this pattern
+        --[no-]header-only           Print only the header
+        --[no-]rows-only             Print only the rows
     -h, --help                       How to use
         --version                    Show version
 ```

data/exe/honey_format

@@ -11,7 +11,11 @@ options = cli.options
 
 input_path = options[:input_path] || raise(ArgumentError, 'input path required')
 csv_input = File.read(input_path)
-csv = HoneyFormat::CSV.new(csv_input, delimiter: options[:delimiter])
+csv = HoneyFormat::CSV.new(
+  csv_input,
+  delimiter: options[:delimiter],
+  skip_lines: options[:skip_lines]
+)
 
 csv_part = if options[:header_only]
              csv.header

data/lib/honey_format/cli/cli.rb

@@ -8,24 +8,32 @@ module HoneyFormat
 
     # Instantiate the CLI
     # @return [CLI] the CLI
-    def initialize
-      @options = parse_options(argv: ARGV)
+    def initialize(argv: ARGV, io: STDOUT)
+      @io = io
+      @options = parse_options(argv: argv.dup)
+    end
+
+    private
+
+    def puts(*args)
+      @io.puts(*args)
     end
 
     # Parse command line arguments and return options
     # @param [Array<String>] argv the command lines arguments
     # @return [Hash] the command line options
     def parse_options(argv:)
-      input_path = argv.first
+      input_path = nil
       columns = nil
       output_path = nil
       delimiter = ','
       header_only = false
       rows_only = false
+      skip_lines = nil
 
       OptionParser.new do |parser|
-        parser.banner = "Usage: honey_format [file.csv] [options]"
-        parser.default_argv = ARGV
+        parser.banner = "Usage: honey_format [options] <file.csv>"
+        parser.default_argv = argv
 
         parser.on("--csv=input.csv", String, "CSV file") do |value|
           input_path = value
@@ -43,6 +51,10 @@ module HoneyFormat
           delimiter = value
         end
 
+        parser.on("--skip-lines=,", String, "Skip lines that match this pattern") do |value|
+          skip_lines = value
+        end
+
         parser.on("--[no-]header-only", "Print only the header") do |value|
           header_only = value
         end
@@ -60,14 +72,17 @@ module HoneyFormat
           puts "HoneyFormat version #{HoneyFormat::VERSION}"
           exit
         end
-
-        # No argument, shows at tail. This will print an options summary.
-        parser.on_tail("-h", "--help", "Show this message") do
-          puts parser
-          exit
-        end
       end.parse!
 
+      if header_only && rows_only
+        raise(ArgumentError, "you can't provide both --header-only and --rows-only")
+      end
+
+      if input_path && argv.last
+        raise(ArgumentError, "you can't provide both --csv and <path>")
+      end
+      input_path ||= argv.last
+
       {
         input_path: input_path,
         columns: columns,
@@ -75,6 +90,7 @@ module HoneyFormat
         delimiter: delimiter,
         header_only: header_only,
         rows_only: rows_only,
+        skip_lines: skip_lines
       }
     end
   end

data/lib/honey_format/csv.rb

@@ -17,6 +17,7 @@ module HoneyFormat
     # @param [#call] header_converter converts header columns.
     # @param [#call] row_builder will be called for each parsed row.
     # @param type_map [Hash] map of column_name => type conversion to perform.
+    # @param skip_lines [Regexp, String] Regexp for determining wheter a line is a comment. See CSV skip_lines option.
     # @raise [HeaderError] super class of errors raised when there is a CSV header error.
     # @raise [MissingHeaderError] raised when header is missing (empty or nil).
     # @raise [MissingHeaderColumnError] raised when header column is missing.
@@ -48,14 +49,16 @@ module HoneyFormat
       header: nil,
       header_converter: HoneyFormat.header_converter,
       row_builder: nil,
-      type_map: {}
+      type_map: {},
+      skip_lines: nil
     )
       csv = ::CSV.parse(
         csv,
         col_sep: delimiter,
         row_sep: row_delimiter,
         quote_char: quote_character,
-        skip_blanks: true
+        skip_blanks: true,
+        skip_lines: skip_lines
       )
       super(
         csv,

data/lib/honey_format/row.rb

@@ -23,6 +23,20 @@ module HoneyFormat
       ::CSV.generate_line(row)
     end
 
+    # Describe the contents of this row in a string.
+    # @return [String] content of this row
+    def inspect
+      attributes = members.map do |field|
+        value = self[field]
+        value = "\"#{value}\"" if value.is_a?(String)
+
+        [field, value].join("=")
+      end.join(", ")
+
+      "#<Row #{attributes}>"
+    end
+    alias_method :to_s, :inspect
+
     private
 
     # Returns the column in CSV format

data/lib/honey_format/value_converter.rb

@@ -8,9 +8,12 @@ require 'honey_format/header_column_converter'
 module HoneyFormat
   # Converts values
   class ValueConverter
+    # String values considered truthy
     TRUTHY = Set.new(%w[t T 1 y Y true TRUE]).freeze
+    # String values considered falsy
     FALSY = Set.new(%w[f F 0 n N false FALSE]).freeze
 
+    # Tries to convert value boolean to, returns nil if it can't convert
     CONVERT_BOOLEAN = lambda { |v|
       value = v&.downcase
       if TRUTHY.include?(value)

data/lib/honey_format/version.rb

@@ -1,4 +1,8 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.14.0'
+  VERSION = [
+    MAJOR_VERSION = 0,
+    MINOR_VERSION = 15,
+    PATCH_VERSION = 0
+  ].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler