honey_format 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd242cb77ccf8589eb2df059d887e13596f9c33a14fa587a886bcd376a6d728e
-  data.tar.gz: 72842684af98946cd50f7756818a4e9ce94b6c35d6c23a1e14661f70a93d3bac
+  metadata.gz: e5d7c212e16b346e58a80617576ff6c39b1938885b8a66ad7a91c1b7654897cf
+  data.tar.gz: e70bee6d2a69eb8624a35d69300c0e0f02772e88f0237a94f64fa6a13d0c409f
 SHA512:
-  metadata.gz: ed5f6fa7f275d7445ca2962aa1787f8c10e25125253c3c65e3a5732cb0ef40e91f7c7d6bf73fa2d49d8d684c43bfec48058369f38df2e9ed5a52522f36f59d8c
-  data.tar.gz: 987843e3c4a987112bfbd46d00fa61a885ef12b71f19005e578e49d3f6f1bbe3af9022e3666af90437e015d522dbc7557a9f3065c45e4d0dd797d48670a9667f
+  metadata.gz: 7a0af309f8e7f31f725cd9b3d391ee27c4ebf858d31498f39dad99e78cf55ebcd8541a347fb2937fa51a52a0b43405b611943f52dda8040a9124ada30f3a2b54
+  data.tar.gz: 9c6a89db6da810c78dfe2c74b0fb1ea175b4e62392226bd84e92c53ce5529049190e5c99cdb518dc358f5a98d4385fc3554add7407d2f5c809e3966631ffc467

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# v0.9.2
+# 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
 
 :warning: This release contains some backwards compatible changes.
 

data/README.md

@@ -91,6 +91,13 @@ csv = HoneyFormat::CSV.new(csv_string)
 csv.to_csv(columns: [:id, :country]) # => "id,country\nburen,Sweden\n"
 ```
 
+Output a subset of rows to CSV
+```ruby
+csv_string = "Name, Country\nburen,Sweden\njacob,Denmark"
+csv = HoneyFormat::CSV.new(csv_string)
+csv.to_csv { |row| row.country == 'Sweden' } # => "name,country\nburen,Sweden\n"
+```
+
 You can of course set the delimiter
 ```ruby
 HoneyFormat::CSV.new(csv_string, delimiter: ';')

data/honey_format.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.3.0'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'benchmark-ips'

data/lib/honey_format/convert_header_value.rb

@@ -16,6 +16,7 @@ module HoneyFormat
     # Returns converted value and mutates the argument.
     # @return [Symbol] the cleaned header column.
     # @param [String] column the string to be cleaned.
+    # @param [Integer] column index.
     # @example Convert simple header
     #     ConvertHeaderValue.call("  User name ") #=> "user_name"
     # @example Convert complex header

data/lib/honey_format/csv.rb

@@ -7,9 +7,11 @@ module HoneyFormat
   # Represents CSV.
   class CSV
     # @return [CSV] a new instance of CSV.
-    # @param [String] csv string.
-    # @param [Array<Symbol>] valid_columns valid array of symbols representing valid columns if empty all will be considered valid.
-    # @param [Array<String>] header optional argument for CSV header.
+    # @param [String] csv the CSV string
+    # @param [String] delimiter the CSV delimiter
+    # @param [Array<String>] header optional argument that represents CSV header, required if the CSV file lacks a header row.
+    # @param [Array<Symbol>] valid_columns array of symbols representing valid columns, if empty all will be considered valid.
+    # @param [#call] header_converter converts header columns.
     # @param [#call] row_builder will be called for each parsed row.
     # @raise [HeaderError] super class of errors raised when there is a CSV header error.
     # @raise [MissingHeaderError] raised when header is missing (empty or nil).
@@ -38,13 +40,12 @@ module HoneyFormat
     end
 
     # @return [Array] of rows.
-    # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
     def rows
       @rows
     end
 
     # @yield [row] The given block will be passed for every row.
-    # @yieldparam [Row] a colmn in the CSV header.
+    # @yieldparam [Row] row in the CSV.
     # @return [Enumerator] If no block is given, an enumerator object will be returned.
     def each_row
       return rows.each unless block_given?
@@ -53,9 +54,18 @@ module HoneyFormat
     end
 
     # Convert CSV object as CSV-string.
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
+    # @yield [row] The given block will be passed for every row - return truthy if you want the row to be included in the output
+    # @yieldparam [Row] row
     # @return [String] CSV-string representation.
-    def to_csv(columns: nil)
-      @header.to_csv(columns: columns) + @rows.to_csv(columns: columns)
+    # @example with selected columns
+    #   csv.to_csv(columns: [:id, :country])
+    # @example with selected rows
+    #   csv.to_csv { |row| row.country == 'Sweden' }
+    # @example with both selected columns and rows
+    #   csv.to_csv(columns: [:id, :country]) { |row| row.country == 'Sweden' }
+    def to_csv(columns: nil, &block)
+      @header.to_csv(columns: columns) + @rows.to_csv(columns: columns, &block)
     end
   end
 end

data/lib/honey_format/header.rb

@@ -10,6 +10,7 @@ module HoneyFormat
     # @param [Array<String>] header array of strings.
     # @param [Array<Symbol, String>] valid array representing the valid columns, if empty all columns will be considered valid.
     # @param converter [#call] header converter that implements a #call method that takes one column (string) argument.
+    # @raise [HeaderError] super class of errors raised when there is a CSV header error.
     # @raise [MissingHeaderColumnError] raised when header is missing
     # @raise [UnknownHeaderColumnError] raised when column is not in valid list.
     # @example Instantiate a header with a customer converter
@@ -32,7 +33,7 @@ module HoneyFormat
     end
 
     # @yield [row] The given block will be passed for every column.
-    # @yieldparam [Row] a colmn in the CSV header.
+    # @yieldparam [Row] a column in the CSV header.
     # @return [Enumerator]
     #   If no block is given, an enumerator object will be returned.
     def each(&block)

data/lib/honey_format/row.rb

@@ -7,7 +7,9 @@ module HoneyFormat
     # @return [Row] a new instance of Row.
     # @param [Array] columns an array of symbols.
     # @param builder [#call, #to_csv] optional row builder
+    # @raise [RowError] super class of errors raised when there is a row error.
     # @raise [EmptyRowColumnsError] raised when there are no columns.
+    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
     # @example Create new row
     #     Row.new!([:id])
     def initialize(columns, builder: nil)
@@ -22,7 +24,7 @@ module HoneyFormat
     end
 
     # Returns a Struct.
-    # @return [Struct] a new instance of Row.
+    # @return [Object] a new instance of built row.
     # @param row [Array] the row array.
     # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
     # @example Build new row

data/lib/honey_format/row_builder.rb

@@ -8,6 +8,7 @@ module HoneyFormat
     end
 
     # Represent row as CSV
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
     # @return [String] CSV-string representation.
     def to_csv(columns: nil)
       attributes = members

data/lib/honey_format/rows.rb

@@ -10,6 +10,9 @@ module HoneyFormat
     # @return [Rows] new instance of Rows.
     # @param [Array] rows the array of rows.
     # @param [Array] columns the array of column symbols.
+    # @raise [RowError] super class of errors raised when there is a row error.
+    # @raise [EmptyRowColumnsError] raised when there are no columns.
+    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
     def initialize(rows, columns, builder: nil)
       @rows = prepare_rows(Row.new(columns, builder: builder), rows)
     end
@@ -35,11 +38,26 @@ module HoneyFormat
     end
     alias_method :size, :length
 
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
+    # @yield [row] each row - return truthy if you want the row to be included in the output
+    # @yieldparam [Row] row
     # @return [String] CSV-string representation.
-    def to_csv(columns: nil)
+    # @example with selected columns
+    #   rows.to_csv(columns: [:id, :country])
+    # @example with selected rows
+    #   rows.to_csv { |row| row.country == 'Sweden' }
+    # @example with both selected columns and rows
+    #   csv.to_csv(columns: [:id, :country]) { |row| row.country == 'Sweden' }
+    def to_csv(columns: nil, &block)
       # Convert columns to Set for performance
       columns = Set.new(columns) if columns
-      to_a.map { |row| row.to_csv(columns: columns) }.join
+      csv_rows = []
+      each do |row|
+        if !block || block.call(row)
+          csv_rows << row.to_csv(columns: columns)
+        end
+      end
+      csv_rows.join
     end
 
     private

data/lib/honey_format/version.rb

@@ -1,4 +1,4 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jacob Burenstam
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="