smarter_csv 1.11.0 → 1.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996d8195dc01722461990cb51dbc2b65d4cf2edf93eff2c1d4c5359614911b92
-  data.tar.gz: 0f193b450b4cfb97a1f11bbeacbc659b5220fa545751533a225347349943bc9a
+  metadata.gz: 4a650fbccc5bf703199c6771da75ed95c87c9e3763e176b688a2daaa1b0c4669
+  data.tar.gz: 89cfff5bb92ee8faaeea7a644b61e63a7e47c61f30faefc515b602808eec0989
 SHA512:
-  metadata.gz: 1a8141ccf75d5f6edf5ffc6f4b719f36dabfc826903b69804cfda09988f43fce24678e7e44fe53e0228a3077858fa870b920bf019b9dd996c53d9024364767ca
-  data.tar.gz: 25daf165cb30decb0f7cd5703758dde5879a12398e6826fb8e0def3efb135b33ab8ef2bf26149d0bd887d42d73a19f9af8ab5e7ea1aee737e139a3acf5da6a4f
+  metadata.gz: 70ea1888be23a467d15001086935117252a30860ee5a418e8b61b61bfb19a03377391ffb28589db412b0aac4293ac029a047b268d0fa6836ec60f2319cabf102
+  data.tar.gz: 49d7d1d1c4e258611168056a0b8b7433dfedcf37eeac25c22c0aade552a878361d019b86156cbadcacc5996a43cae11d9d55990a0ef9c4a599cf447019cf8d7f

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 
 # SmarterCSV 1.x Change Log
 
+## 1.11.2 (2024-07-05)
+  * fixing missing errors definition
+    
+## 1.11.1 (2024-07-05) (YANKED)
+  * improved behavior of Writer class
+  * added SmarterCSV.generate shortcut for CSV writing
+    
 ## 1.11.0 (2024-07-02)
   * added SmarterCSV::Writer to output CSV files ([issue #44](https://github.com/tilo/smarter_csv/issues/44))
   

data/README.md

@@ -3,7 +3,13 @@
 
  [![codecov](https://codecov.io/gh/tilo/smarter_csv/branch/main/graph/badge.svg?token=1L7OD80182)](https://codecov.io/gh/tilo/smarter_csv) [![Gem Version](https://badge.fury.io/rb/smarter_csv.svg)](http://badge.fury.io/rb/smarter_csv)
 
-This library provides a complete interface to CSV files and data. It offers tools to enable you to read and write to and from Strings or IO objects, as needed.
+SmarterCSV provides a complete interface to CSV files and data. It offers tools to enable you to read and write to and from Strings or IO objects, as needed.
+
+SmarterCSV focuses on representing the data for each row as a hash. 
+
+When reading CSV files, Using an array-of-hashes format makes it much easier to further process the data, or creating database records with it.
+
+When writing CSV data to file, it similarly takes arrays of hashes, and converts them to a CSV file.
 
 #### BREAKING CHANGES
 

data/lib/smarter_csv/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SmarterCSV
+  class Error < StandardError; end # new code should rescue this instead
+  # Reader:
+  class SmarterCSVException < Error; end # for backwards compatibility
+  class HeaderSizeMismatch < SmarterCSVException; end
+  class IncorrectOption < SmarterCSVException; end
+  class ValidationError < SmarterCSVException; end
+  class DuplicateHeaders < SmarterCSVException; end
+  class MissingKeys < SmarterCSVException; end # previously known as MissingHeaders
+  class NoColSepDetected < SmarterCSVException; end
+  class KeyMappingError < SmarterCSVException; end
+  # Writer:
+  class InvalidInputData < SmarterCSVException; end
+end

data/lib/smarter_csv/smarter_csv.rb

@@ -1,15 +1,6 @@
 # frozen_string_literal: true
 
 module SmarterCSV
-  class SmarterCSVException < StandardError; end
-  class HeaderSizeMismatch < SmarterCSVException; end
-  class IncorrectOption < SmarterCSVException; end
-  class ValidationError < SmarterCSVException; end
-  class DuplicateHeaders < SmarterCSVException; end
-  class MissingKeys < SmarterCSVException; end # previously known as MissingHeaders
-  class NoColSepDetected < SmarterCSVException; end
-  class KeyMappingError < SmarterCSVException; end
-
   # first parameter: filename or input object which responds to readline method
   def SmarterCSV.process(input, given_options = {}, &block) # rubocop:disable Lint/UnusedMethodArgument
     initialize_variables

data/lib/smarter_csv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmarterCSV
-  VERSION = "1.11.0"
+  VERSION = "1.11.2"
 end

data/lib/smarter_csv/writer.rb

@@ -35,22 +35,35 @@ module SmarterCSV
   #    Make sure to use the correct form when specifying headers manually,
   #    in combination with the :discover_headers option
 
+  attr_reader :options, :row_sep, :col_sep, :quote_char, :force_quotes, :discover_headers, :headers, :map_headers, :output_file
+
   class Writer
     def initialize(file_path, options = {})
       @options = options
-      @discover_headers = options.has_key?(:discover_headers) ? (options[:discover_headers] == true) : true
-      @headers = options[:headers] || []
       @row_sep = options[:row_sep] || "\n" # RFC4180 "\r\n"
       @col_sep = options[:col_sep] || ','
-      @quote_char = '"'
+      @quote_char = options[:quote_char] || '"'
       @force_quotes = options[:force_quotes] == true
+      @discover_headers = true # defaults to true
+      if options.has_key?(:discover_headers)
+        # passing in the option overrides the default behavior
+        @discover_headers = options[:discover_headers] == true
+      else
+        # disable discover_headers when headers are given explicitly
+        @discover_headers = !(options.has_key?(:map_headers) || options.has_key?(:headers))
+      end
+      @headers = [] # start with empty headers
+      @headers = options[:headers] if options.has_key?(:headers) # unless explicitly given
+      @headers = options[:map_headers].keys if options.has_key?(:map_headers) && !options.has_key?(:headers)
       @map_headers = options[:map_headers] || {}
+
       @output_file = File.open(file_path, 'w+')
       # hidden state:
       @temp_file = Tempfile.new('tempfile', '/tmp')
       @quote_regex = Regexp.union(@col_sep, @row_sep, @quote_char)
     end
 
+    # this can be called many times in order to append lines to the csv file
     def <<(data)
       case data
       when Hash
@@ -60,7 +73,7 @@ module SmarterCSV
       when NilClass
         # ignore
       else
-        raise ArgumentError, "Invalid data type: #{data.class}. Must be a Hash or an Array."
+        raise InvalidInputData, "Invalid data type: #{data.class}. Must be a Hash or an Array."
       end
     end
 

data/lib/smarter_csv.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "smarter_csv/version"
+require "smarter_csv/errors"
+
 require "smarter_csv/file_io"
 require "smarter_csv/options_processing"
 require "smarter_csv/auto_detection"
@@ -9,8 +11,10 @@ require 'smarter_csv/header_transformations'
 require 'smarter_csv/header_validations'
 require "smarter_csv/headers"
 require "smarter_csv/hash_transformations"
+
 require "smarter_csv/parse"
 require "smarter_csv/writer"
+require "smarter_csv/smarter_csv"
 
 # load the C-extension:
 case RUBY_ENGINE
@@ -49,4 +53,24 @@ else
   BLOCK_COMMENT
 end
 # :nocov:
-require "smarter_csv/smarter_csv"
+
+module SmarterCSV
+  # SmarterCSV.generate(filename, options) do |csv_writer|
+  #   MyModel.find_in_batches(batch_size: 100) do |batch|
+  #    batch.pluck(:name, :description, :instructor).each do |record|
+  #       csv_writer << record
+  #     end
+  #   end
+  # end
+  #
+  # rubocop:disable Lint/UnusedMethodArgument
+  def self.generate(filename, options = {}, &block)
+    raise unless block_given?
+
+    writer = Writer.new(filename, options)
+    yield writer
+  ensure
+    writer.finalize
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+end

data/smarter_csv.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tilo.sloboda@gmail.com"]
 
   spec.summary       = "CSV Reading and Writing"
-  spec.description   = "Ruby Gem for smarter importing of CSV Files as Array(s) of Hashes, with lots of features for processing large files in parallel, embedded comments, unusual field- and record-separators, flexible mapping of CSV-headers to Hash-keys"
+  spec.description   = "Ruby Gem for convenient reading and writing: importing of CSV Files as Array(s) of Hashes, with lots of features for processing large files in parallel, embedded comments, unusual field- and record-separators, flexible mapping of CSV-headers to Hash-keys"
   spec.homepage      = "https://github.com/tilo/smarter_csv"
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarter_csv
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.2
 platform: ruby
 authors:
 - Tilo Sloboda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -94,9 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby Gem for smarter importing of CSV Files as Array(s) of Hashes, with
-  lots of features for processing large files in parallel, embedded comments, unusual
-  field- and record-separators, flexible mapping of CSV-headers to Hash-keys
+description: 'Ruby Gem for convenient reading and writing: importing of CSV Files
+  as Array(s) of Hashes, with lots of features for processing large files in parallel,
+  embedded comments, unusual field- and record-separators, flexible mapping of CSV-headers
+  to Hash-keys'
 email:
 - tilo.sloboda@gmail.com
 executables: []
@@ -118,6 +119,7 @@ files:
 - ext/smarter_csv/smarter_csv.c
 - lib/smarter_csv.rb
 - lib/smarter_csv/auto_detection.rb
+- lib/smarter_csv/errors.rb
 - lib/smarter_csv/file_io.rb
 - lib/smarter_csv/hash_transformations.rb
 - lib/smarter_csv/header_transformations.rb