metacrunch-file 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a64cc33b8badb7d4e6b7c29267501db505edbb081ed55be3c4bdf269109eac8
-  data.tar.gz: 0bb18d835fb8e812ff04aded3b8bfc3d90f8daae606704c49d2dbfe502cdaafd
+  metadata.gz: 873e28ee7fabd11484426b0282b9857025b95452ec7cabffabf98a163326f8e5
+  data.tar.gz: 46f10b360760fa3259d46a1578ee62bffb9134511d4fd76ca0247d12b91f4866
 SHA512:
-  metadata.gz: a28ff6fcb40f286673011ee27de86a15d579bdc213b379eb77781eddbd6efa5613e3d68bd16e1d016d61f9d786b143c35e2b276961affbad21d71707060c65a4
-  data.tar.gz: e58ec6254b11f956c4a45a0ef68477cee7b9bb2e79ce5fd283f5a3e0450e0e4b49c5c53796f7e6234ad9742d46fd42e19fed6bd2be231847b8de6a82cb188d57
+  metadata.gz: 28f0edd5914fac3b1611943e8d8bbdbb9c2c33a92c4fd45cd3b579a61cbf7eaf2c6db489878ff878d31ceeb75262ff76f95fedf4739e9e90e13cf892e2cf0de8
+  data.tar.gz: 62aec554a36543043909c814d1331dc3951997be24fcc9c6a4839b10d454c7f4287160aaf99c80a7bed33d2a495e8bce676fe17e29c26ee03e7ce8774be40940

data/Readme.md

@@ -17,7 +17,7 @@ Installation
 Include the gem in your `Gemfile`
 
 ```ruby
-gem "metacrunch-file", "~> 1.4.0"
+gem "metacrunch-file", "~> 1.5.0"
 ```
 
 and run `$ bundle install` to install it.
@@ -98,6 +98,25 @@ source Metacrunch::File::CSVSource.new("my.csv" [, OPTIONS])
 * `quote_char`: Quotation character. Defaults to `"`.
 * `file_encoding`: Set the file encoding. Defaults to `utf-8`.
 
+## `Metacrunch::File::CSVDestination`
+
+This class provides a metacrunch `desination` for writing CSV files. Because [smarter_csv](https://github.com/tilo/smarter_csv) can only be used to read CSV, this class uses Ruby's [build in CSV feature](https://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html) under the hood.
+
+```ruby
+# my_job.metacrunch
+
+destination Metacrunch::File::CSVDestination.new(
+  "result.csv",                  # filename
+  ["Header 1", "Header 2", ...], # headers 
+  [, OPTIONS]
+)
+```
+
+**Options**
+
+* `override_existing_file`: Overrides an existing file if set to `true`. If set to `false` an error is raised if the file already exists. Defaults to `false`.
+* `csv_options`: Set options for CSV generation as `col_sep`. Full list is [here](https://ruby-doc.org/stdlib/libdoc/csv/rdoc/CSV.html#class-CSV-label-Options).
+
 ## `Metacrunch::File::XLSXDestination`
 
 This class provides a metacrunch `destination` implementation to create simple Excel (xlsx) files.

data/lib/metacrunch/file.rb

@@ -10,5 +10,6 @@ module Metacrunch
     require_relative "file/file_destination"
     require_relative "file/destination"
     require_relative "file/xlsx_destination"
+    require_relative "file/csv_destination"
   end
 end

data/lib/metacrunch/file/csv_destination.rb

@@ -0,0 +1,49 @@
+require "metacrunch/file"
+
+module Metacrunch
+  class File::CSVDestination
+
+    DEFAULT_OPTIONS = {
+      override_existing_file: false,
+      csv_options: {}
+    }
+
+    def initialize(filename, headers, options = {})
+      @filename = ::File.expand_path(filename)
+      @headers  = headers
+      @options  = DEFAULT_OPTIONS.deep_merge(options)
+
+      if ::File.exists?(@filename) && @options[:override_existing_file] == false
+        raise "File `#{@filename}` exists but `override_existing_file` option was set to `false`"
+      end
+
+      @file = ::File.open(@filename, 'wb+')
+
+      if @headers.present?
+        raise ArgumentError, "Headers must be an Array" unless @headers.is_a?(Array)
+        csv_str = CSV.generate_line(@headers, **@options[:csv_options])
+        @file.write(csv_str)
+      end
+    end
+
+    def write(data)
+      return if data.blank?
+      raise ArgumentError, "Data must be an Array" unless data.is_a?(Array)
+
+      if data.first.is_a?(Array)
+        data.each do |d|
+          csv_str = CSV.generate_line(d, **@options[:csv_options])
+          @file.write(csv_str)
+        end
+      else
+        csv_str = CSV.generate_line(data, **@options[:csv_options])
+        @file.write(csv_str)
+      end
+    end
+
+    def close
+      @file.close if @file
+    end
+
+  end
+end

data/lib/metacrunch/file/version.rb

@@ -1,5 +1,5 @@
 module Metacrunch
   module File
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metacrunch-file
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - René Sprotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,6 +67,7 @@ files:
 - Readme.md
 - bin/console
 - lib/metacrunch/file.rb
+- lib/metacrunch/file/csv_destination.rb
 - lib/metacrunch/file/csv_source.rb
 - lib/metacrunch/file/destination.rb
 - lib/metacrunch/file/entry.rb
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: File package for the metacrunch ETL toolkit.