dreader 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c16cce6fa4d2c813f381b7adefd8a6dd241db8b2133188aaf483c433e054ed
-  data.tar.gz: 4a35caf1ee4703628db442a9852090dbe87055301c0963ba00580bc7eb9f4e38
+  metadata.gz: d59887423bcb1658823534ca3d8a5505899cd70a5f8d23eda235159c590cf364
+  data.tar.gz: b17d71ed8d7db969fcc872a3f01cb6fdfbfaff69e0030ffc304ebc481a15675d
 SHA512:
-  metadata.gz: b17fc5631ac685e5117d6ef9c1199422c7ef9a347c8d05436b2fd28fbf421465a9035930c0f45adcc19bc94279bf7ff2ba8a4f7f6b932ef2befcc82743e03ee4
-  data.tar.gz: 9a124ddd059c973710800f2b058482b13d155852e0ebb1740e54e90d92100396f9b391a17806c9e1f561c527680d0ab50d59ef3b2162f1fa9ce5da350b29fe3a
+  metadata.gz: 1407751e4baa35d4c6644cc9c9ebea7a8185febd2211e6b76c86a3001e8972d58061b6946a178dd007043c897a9943d41971e0868dab2e9e332350a5436bfff1
+  data.tar.gz: da163158d92a1618de0218f5285fe189f3ec5fe78b0d815c6b873574175c817ef4134725ff70a174b0206fb0da1770f9888044b076dbfc8e62b79f22e10930a6

data/CHANGELOG.org

@@ -1,5 +1,18 @@
 #+TITLE: Changelog
 
+* Version 1.1.2 - <2023-10-31 Tue>
+** Fixes an issue with the :extension option
+
+   - Fixes a bug related to =:extension= and adds a working example, to test
+     the feature
+   - Changes the extension from a string to a symbol. No initial dot required
+     any longer
+
+* Version 1.1.1 - <2023-10-16 Mon>
+** Adds option :extension
+
+   - Adds options =extension= to the class options and to the =open_spreadsheet=
+     function, to be able to determine the type of a file with no extension
 
 * Version 1.1.0
 ** Fixes an issue with visibility of variables

data/README.org

@@ -165,11 +165,13 @@ Require =dreader= and declare a class which extends =Dreader::Engine=:
   end
 #+END_EXAMPLE
 
-In the class specify parsing option, using the following syntax:
+Specify parsing option in the class, using the following syntax:
 
 #+BEGIN_EXAMPLE ruby
   options do
     filename 'example.ods'
+    # this optional. Use it when the file does not have an extension
+    extension :ods
 
     sheet 'Sheet 1'
 
@@ -185,10 +187,17 @@ In the class specify parsing option, using the following syntax:
 
 where:
 
-- (optional) =filename= is the file to read. If not specified, you will
-  have to supply a filename when loading the file (see =read=, below).
-  The extension determines the file type. *Use =.tsv= for tab-separated
-  files.*
+- (optional) =filename= is the file to read. If not specified, you will have
+  to supply a filename when loading the file (see =read=, below).  *Use
+  =.tsv= for tab-separated files.* 
+- (optional) =extension= overrides or specify the extension of =filename=.
+  Takes as input a symbol (e.g., =:xlsx=).  
+  Notice that **value of this option is not appended to filename** (see =read=
+  below).  Filename must thus be a valid reference to a file in the file
+  system. This option is useful in one of these two circumstances:
+  1. When =filename= has no extension
+  2. When you want to override the extension of the filename, e.g., to force
+     reading a "file.csv" as a tab separated file
 - (optional) =first_row= is the first line to read (use =2= if your file
   has a header)
 - (optional) =last_row= is the last line to read. If not specified, we
@@ -451,9 +460,17 @@ A typical scenario works as follows:
 
 #+BEGIN_EXAMPLE ruby
   i = Reader
+
+  # read uses the options if defined and takes the same arguments as options
+  # examples:
+  # i.read
+  # i.read filename: "example.ods"
+  # i.read filename: "example.ods", extension: :ods
+  # i.read filename: "example", extension: :ods
+  # (the line above opens the file "example" as an Open Document Spreasdheet)
   i.read
   
-  # alternatively
+  # alternately
   Reader.read
 #+END_EXAMPLE
 

data/examples/age_csv/Birthdays-TabSeparated.csv

@@ -0,0 +1,13 @@
+Name	Date of birth
+Forest Whitaker	July 15, 1961
+Daniel Day-Lewis	April 29, 1957
+Sean Penn	August 17, 1960
+Jeff Bridges	December 4, 1949
+Colin Firth	September 10, 1960
+Jean Dujardin	June 19, 1972
+Daniel Day-Lewis	April 29, 1957
+Matthew McConaughey	November 4, 1969
+Eddie Redmayne	January 6, 1982
+Leonardo DiCaprio	November 11, 1974
+Casey Affleck	August 12, 1975
+Gary Oldman	March 21, 1958

data/examples/age_csv/Birthdays.csv

@@ -0,0 +1,13 @@
+Name,Date of birth
+Forest Whitaker,"July 15, 1961"
+Daniel Day-Lewis,"April 29, 1957"
+Sean Penn,"August 17, 1960"
+Jeff Bridges,"December 4, 1949"
+Colin Firth,"September 10, 1960"
+Jean Dujardin,"June 19, 1972"
+Daniel Day-Lewis,"April 29, 1957"
+Matthew McConaughey,"November 4, 1969"
+Eddie Redmayne,"January 6, 1982"
+Leonardo DiCaprio,"November 11, 1974"
+Casey Affleck,"August 12, 1975"
+Gary Oldman,"March 21, 1958"

data/examples/age_csv/age.rb

@@ -0,0 +1,55 @@
+require "dreader"
+
+class Reader
+  extend Dreader::Engine
+
+  options do
+    first_row 2
+    debug true
+  end
+
+  column :name do
+    doc "A is the name string"
+    colref 'A'
+  end
+
+  column :birthdate do
+    doc "Birthdate contains a full date (i.e., including the year)"
+    colref 'B'
+
+    process do |c|
+      Date.parse(c)
+    end
+  end
+
+  virtual_column :age do
+    process do |row|
+      birthdate = row[:birthdate][:value]
+      birthday = Date.new(Date.today.year, birthdate.month, birthdate.day)
+      today = Date.today
+
+      [0, today.year - birthdate.year - (birthday < today ? 1 : 0)].max
+    end
+  end
+
+  mapping do |row|
+    r = Dreader::Util.simplify(row)
+    puts "#{r[:name]} is #{r[:age]} years old (born on #{r[:birthdate]})"
+  end
+end
+
+i = Reader
+i.read filename: "Birthdays.csv", mapping: true
+
+i.read filename: "Birthdays-TabSeparated.csv", extension: :tsv, mapping: true
+
+#
+# Here we can do further processing on the data
+#
+File.open("ages.txt", "w") do |file|
+  i.table.each do |row|
+    unless row[:row_errors].any?
+      file.puts "#{row[:name][:value]} #{row[:age][:value]}"
+    end
+  end
+end

data/examples/age_noext/age.rb

@@ -0,0 +1,73 @@
+require "dreader"
+
+class Reader
+  extend Dreader::Engine
+
+  options do
+    first_row 2
+    debug true
+    extension :ods
+  end
+
+  column :name do
+    doc "A is the name string"
+    colref 'A'
+  end
+
+  column :birthdate do
+    doc "Birthdate contains a full date (i.e., including the year)"
+    colref 'B'
+
+    process do |c|
+      Date.parse(c)
+    end
+  end
+
+  virtual_column :age do
+    process do |row|
+      birthdate = row[:birthdate][:value]
+      birthday = Date.new(Date.today.year, birthdate.month, birthdate.day)
+      today = Date.today
+
+      [0, today.year - birthdate.year - (birthday < today ? 1 : 0)].max
+    end
+  end
+
+  mapping do |row|
+    r = Dreader::Util.simplify(row)
+    puts "#{r[:name]} is #{r[:age]} years old (born on #{r[:birthdate]})"
+  end
+end
+
+puts
+puts "*****************************************************************"
+puts "Reading ODS with no extension, using extension set in the options"
+puts "*****************************************************************"
+puts
+
+i = Reader
+i.read filename: "Birthdays"
+i.virtual_columns
+i.mappings
+
+puts
+puts "*****************************************************************"
+puts "Reading XLSX with wrong extension, overriding existing extension"
+puts "*****************************************************************"
+puts
+
+i = Reader
+i.read filename: "Birthdays-xlsx-with-wrong-extension.xls", extension: :xlsx
+i.virtual_columns
+i.mappings
+
+puts
+puts "*****************************************************************"
+puts "Reading XLSX with no extension"
+puts "*****************************************************************"
+puts
+
+i = Reader
+i.read filename: "Birthdays-xlsx", extension: :xlsx
+i.virtual_columns
+i.mappings

data/lib/dreader/engine.rb

@@ -150,7 +150,7 @@ module Dreader
         raise Exception
       end
 
-      spreadsheet = open_spreadsheet (options[:filename])
+      spreadsheet = open_spreadsheet(options)
       sheet = spreadsheet.sheet(options[:sheet] || 0)
       first_row = options[:first_row] || 1
       last_row = options[:last_row] || sheet.last_row
@@ -324,7 +324,7 @@ module Dreader
     def compare_headers(hash = {})
       options = @declared_options.merge(hash)
 
-      spreadsheet = open_spreadsheet(options[:filename])
+      spreadsheet = open_spreadsheet(options)
       sheet = spreadsheet.sheet(options[:sheet] || 0)
       header_row_number = options[:first_row] - 1 || 1
 
@@ -398,27 +398,36 @@ module Dreader
     # list of keys we support in options. We remove them when reading
     # the CSV file
     OPTION_KEYS = %i[
-      filename sheet first_row last_row logger logger_level
+      filename extension sheet first_row last_row
+      logger logger_level
+      debug
     ]
 
-    def open_spreadsheet(filename)
-      ext = File.extname(filename)
+    def open_spreadsheet(options)
+      filename = options[:filename]
+      # use the extension option or make ".CSV" into :csv
+      extension = options[:extension] || File.extname(filename).downcase[1..-1]&.to_sym
 
-      case ext
-      when ".csv"
+      
+      # TODO: MAKE DEBUG AND LOGGER INTO REAL CLASS VARIABLES OR MAKE LOCAL AND/OR FUNCTIONS
+      @debug = @declared_options.merge(options)[:debug] == true
+      if @debug
+        @logger = options[:logger] || Logger.new($stdout)
+        @logger.debug "[dreader open_spreadsheet] filename: #{filename}"
+        @logger.debug "[dreader open_spreadsheet] extension: #{extension}"
+      end
+
+      case extension
+      when :csv
         csv_options = @declared_options.except(*OPTION_KEYS)
         Roo::CSV.new(filename, csv_options:)
-      when ".tsv"
+      when :tsv
         csv_options = @declared_options.except(*OPTION_KEYS).merge({ col_sep: "\t" })
         Roo::CSV.new(filename, csv_options:)
-      when ".ods"
-        Roo::OpenOffice.new(filename)
-      when ".xls"
-        Roo::Excel.new(filename)
-      when ".xlsx"
-        Roo::Excelx.new(filename)
+      when :ods, :xls, :xlsx
+        Roo::Spreadsheet.open(filename, extension:)
       else
-        raise "Unknown extension: #{ext}"
+        raise "Unknown extension: #{ext}. Use the :extension option."
       end
     end
 

data/lib/dreader/version.rb

@@ -1,3 +1,3 @@
 module Dreader
-  VERSION = "1.1.0"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dreader
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roo
@@ -108,6 +108,13 @@ files:
 - dreader.gemspec
 - examples/age/Birthdays.ods
 - examples/age/age.rb
+- examples/age_csv/Birthdays-TabSeparated.csv
+- examples/age_csv/Birthdays.csv
+- examples/age_csv/age.rb
+- examples/age_noext/Birthdays
+- examples/age_noext/Birthdays-xlsx
+- examples/age_noext/Birthdays-xlsx-with-wrong-extension.xls
+- examples/age_noext/age.rb
 - examples/age_with_multiple_checks/Birthdays.ods
 - examples/age_with_multiple_checks/age_with_multiple_checks.rb
 - examples/local_vars/local_vars.rb
@@ -142,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Process and import data from cvs and spreadsheets