metacrunch-file 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f457f5fcca1eb193efe81c0e7c8f02d73b42bc7e
-  data.tar.gz: 64f70e6bf5a0d45014853bbae5d09e75456a67c1
+  metadata.gz: c5561aee710c9450372e675cd2f528f0024d1b41
+  data.tar.gz: 960154bbd9225493784f55b6750ef08bc665c047
 SHA512:
-  metadata.gz: 80edcd6aaa76b570371fd14b6bbe59a50df168e2471e265075b5607504ae8270d33a2787dfab48bf038d30d8d8261b1c178d7ec306f127873b2bac1a654f64ac
-  data.tar.gz: 3ab68b17ab6f7971e286d6177db0c80a4d1b8a83d1d97b707e1ee188e1af55eb2ba1239bc2d47262abc190f7f52503418577e62e5ec6707f4e5d188b13e77197
+  metadata.gz: bf579706cde53758b82c5d833be4bc05e064532488c642600624c168f5cfb1eaeecd7cb80bbe006b58161633c4d7f7bdea0be9fb74655370308dc0fc167ebacf
+  data.tar.gz: c67526eb2803612c36940220554704c73238e7424168bfce67c9741baa163fee20992e4512e8b4085516c5c61fcb4cd5b2f27a8c850efffad35c8268993d03e3

data/Readme.md

@@ -14,7 +14,7 @@ Installation
 Include the gem in your `Gemfile`
 
 ```ruby
-gem "metacrunch-file", "~> 1.0.0"
+gem "metacrunch-file", "~> 1.2.0"
 ```
 
 and run `$ bundle install` to install it.
@@ -67,12 +67,26 @@ transformation ->(file_entry) do
 end
 ```
 
+### `Metacrunch::File::Destination`
+
+This class provides a metacrunch `destination` to write data to a file. Every data that gets passed to the destination is appended to the given file. If the data is an `Array` every element of that array is appended to the file. Non existing files will be created automatically.
+
+```ruby
+# my_job.metacrunch
+
+source Metacrunch::File::Destination.new("/tmp/my-data.txt" [, 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`.
+* 
 
 ### `Metacrunch::File::XLSXDestination`
 
 This class provides a metacrunch `destination` implementation to create simple Excel (xlsx) files.
 
-To use this destination a transformation is required to format the data in a proper array that can be feet into the destination. When defining the destination you must provide an array of column names. Each data row passed to the destination must be an array of the same size as the column array.
+To use this destination a transformation is required to format the data in a proper array that can be passed to the destination. When defining the destination you must provide an array of column names. Each data row passed to the destination must be an array of the same size as the column array.
 
 ```ruby
 # my_job.metacrunch

data/lib/metacrunch/file.rb

@@ -5,6 +5,7 @@ module Metacrunch
   module File
     require_relative "file/entry"
     require_relative "file/source"
+    require_relative "file/destination"
     require_relative "file/xlsx_destination"
   end
 end

data/lib/metacrunch/file/destination.rb

@@ -0,0 +1,36 @@
+require "metacrunch/file"
+
+module Metacrunch
+  class File::Destination
+
+    DEFAULT_OPTIONS = {
+      override_existing_file: false
+    }
+
+    def initialize(filename, options = {})
+      @filename = ::File.expand_path(filename)
+      @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
+    end
+
+    def write(data)
+      return if data.blank?
+
+      if data.is_a?(Array)
+        ::File.open(@filename, 'ab+') do |file|
+          data.each { |row| file.write(row) }
+        end
+      else
+        ::File.open(@filename, 'ab+') { |file| file.write(data) }
+      end
+    end
+
+    def close
+      # noop
+    end
+
+  end
+end

data/lib/metacrunch/file/version.rb

@@ -1,6 +1,6 @@
 
 module Metacrunch
   module File
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metacrunch-file
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - René Sprotte
@@ -53,6 +53,7 @@ files:
 - Readme.md
 - bin/console
 - lib/metacrunch/file.rb
+- lib/metacrunch/file/destination.rb
 - lib/metacrunch/file/entry.rb
 - lib/metacrunch/file/source.rb
 - lib/metacrunch/file/version.rb