csvrecord 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77369b93b97cff13a7159870a4343cb22ad86dec
-  data.tar.gz: cbc687395deb700c55ed7ca79687da11a7fb8913
+  metadata.gz: 3f9b5900a09323251bb9cf7fef7211c5692a5ac3
+  data.tar.gz: db705e1ba91bcd30ac538947d1518521a92ce76a
 SHA512:
-  metadata.gz: f8d27de0a2c8e8ee2ddfcc024802845a6bce1f05dbc94aa1911fec1cc287837a5b5739e46e93cd5d6db6af678c6ad80e326ea09850c95bb342a27c5063d61fdc
-  data.tar.gz: 548b5db8a78788d5c5e624ed44420b961bf0668f9289c876825fb7f09314bc0281f42ca2eb7d6dba11ece65c58de985e6630889230652524f31481e2603cecf2
+  metadata.gz: 34c7f0d23df73725a8f6616024cda30ab89938e94e1032727b8caee434263dc2551547c8f6599c6294f6fa9fe0d1a9255ccd957a2ef6dda277c6e7f044506bc2
+  data.tar.gz: 49a205a98277d5e7842f06a052c5306cb3ce475de9fe3fa056fef411f923a96bf2f254b70b07f70db771f09832630bd95b40b9675992bcb4c8b7a8a750ed7ba1

data/Manifest.txt

@@ -5,7 +5,6 @@ README.md
 Rakefile
 lib/csvrecord.rb
 lib/csvrecord/base.rb
-lib/csvrecord/builder.rb
 lib/csvrecord/version.rb
 test/data/beer.csv
 test/data/beer11.csv

data/Rakefile

@@ -18,6 +18,7 @@ Hoe.spec 'csvrecord' do
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
+     ['record',     '>=1.1.1'],
      ['csvreader']
    ]
 

data/lib/csvrecord.rb

@@ -2,6 +2,7 @@
 
 ###
 # 3rd party gems
+require 'record'
 require 'csvreader'
 
 
@@ -9,7 +10,6 @@ require 'csvreader'
 # our own code
 require 'csvrecord/version' # let version always go first
 require 'csvrecord/base'
-require 'csvrecord/builder'
 
 
 puts CsvRecord.banner   # say hello

data/lib/csvrecord/base.rb

@@ -3,270 +3,10 @@
 
 module CsvRecord
 
-  ## note on naming:
-  ##   use naming convention from awk and tabular data package/json schema for now
-  ##    use - records  (use rows for "raw" untyped (string) data rows )
-  ##        - fields  (NOT columns or attributes) -- might add an alias later - why? why not?
-
-  class Field  ## ruby record class field
-    attr_reader :name, :type
-
-    ## zero-based position index (0,1,2,3,...)
-    ## todo: use/rename to index/idx/pos - add an alias name - why?
-    attr_reader :num
-
-    def initialize( name, num, type )
-      ## note: always symbol-ify (to_sym) name and type
-
-      ## todo: add title or titles for header field/column title as is e.g. 'Team 1' etc.
-      ##   incl. numbers only or even an empty header title
-      @name = name.to_sym
-      @num  = num
-
-      if type.is_a?( Class )
-        @type = type    ## assign class to its own property - why? why not?
-      else
-        @type = Type.registry[type.to_sym]
-        if @type.nil?
-          puts "!!!! warn unknown type >#{type}< - no class mapping found; add missing type to CsvRecord::Type.registry[]"
-          ## todo/fix:  raise exception!!!!
-        end
-      end
-    end
-
-
-    def typecast( value )  ## cast (convert) from string value to type (e.g. float, integer, etc.)
-      ## todo: add typecast to class itself (monkey patch String/Float etc. - why? why not)
-      ##  use __typecast or something?
-      ##  or use a new "wrapper" class  Type::String or StringType - why? why not?
-
-      ## convert string value to (field) type
-      if @type == String
-        value   ## pass through as is
-      elsif @type == Float
-        ## note: allow/check for nil values - why? why not?
-        float = (value.nil? || value.empty?) ? nil : value.to_f
-        puts "typecast >#{value}< to float number >#{float}<"
-        float
-      elsif @type == Integer
-        number = (value.nil? || value.empty?) ? nil : value.to_i(10)   ## always use base10 for now (e.g. 010 => 10 etc.)
-        puts "typecast >#{value}< to integer number >#{number}<"
-        number
-      else
-        ## todo/fix: raise exception about unknow type
-        pp @type
-        puts "!!!! unknown type >#{@type}< - don't know how to convert/typecast string value >#{value}<"
-        value
-      end
-    end
-  end  # class Field
-
-
-
-  class Type   ## todo: use a module - it's just a namespace/module now - why? why not?
-
-    ##  e.g. use Type.registry[:string] = String etc.
-    ##   note use @@ - there is only one registry
-    def self.registry() @@registry ||={} end
-
-    ## add built-in types:
-    registry[:string]  = String
-    registry[:integer] = Integer   ## todo/check: add :number alias for integer? why? why not?
-    registry[:float]   = Float
-    ## todo: add some more
-  end  # class Type
-
-
-
-  def self.define( &block )
-    builder = Builder.new
-    if block.arity == 1
-      block.call( builder )
-      ## e.g. allows "yield" dsl style e.g.
-      ##  CsvRecord.define do |rec|
-      ##     rec.string :team1
-      ##     rec.string :team2
-      ##  end
-      ##
-    else
-      builder.instance_eval( &block )
-      ## e.g. shorter "instance eval" dsl style e.g.
-      ##  CsvRecord.define do
-      ##     string :team1
-      ##     string :team2
-      ##  end
-    end
-    builder.to_record
-  end
-
-
-   ###########################################
-   ## "magic" lazy auto-build schema from headers versions
-
-   def self.build_class( headers )   ## check: find a better name - why? why not?
-     ## (auto-)build record class from an array of headers
-     ##   add fields (all types will be string for now)
-     clazz = Class.new(Base)
-     headers.each do |header|
-       ## downcase and remove all non-ascii chars etc.
-       ##  todo/fix: remove all non-ascii chars!!!
-       ##  todo: check if header starts with a number too!!
-       name = header.downcase.gsub( ' ', '_' )
-       name = name.to_sym   ## symbol-ify
-       clazz.field( name )
-     end
-     clazz
-   end
-
-   def self.read( path, sep: Csv.config.sep )
-     headers = CsvReader.header( path, sep: sep )
-
-     clazz = build_class( headers )
-     clazz.read( path, sep: sep )
-   end
-
-   def self.foreach( path, sep: Csv.config.sep, &block )
-     headers = CsvReader.header( path, sep: sep )
-
-     clazz = build_class( headers )
-     clazz.foreach( path, sep: sep, &block )
-   end
-
-
-
-
-class Base
-
-def self.fields   ## note: use class instance variable (@fields and NOT @@fields)!!!! (derived classes get its own copy!!!)
-  @fields ||= []
-end
-
-def self.field_names   ## rename to header - why? why not?
-  ## return header row, that is, all field names in an array
-  ##   todo: rename to field_names or just names - why? why not?
-  ##  note: names are (always) symbols!!!
-  fields.map {|field| field.name }
-end
-
-def self.field_types
-  ##  note: types are (always) classes!!!
-  fields.map {|field| field.type }
-end
-
-
-
-def self.field( name, type=:string )
-  num = fields.size  ## auto-calc num(ber) / position index - always gets added at the end
-  field = Field.new( name, num, type )
-  fields << field
-
-  define_field( field )  ## auto-add getter,setter,parse/typecast
-end
-
-def self.define_field( field )
-  name = field.name   ## note: always assumes a "cleaned-up" (symbol) name
-  num  = field.num
-
-  define_method( name ) do
-    instance_variable_get( "@values" )[num]
-  end
-
-  define_method( "#{name}=" ) do |value|
-    instance_variable_get( "@values" )[num] = value
-  end
-
-  define_method( "parse_#{name}") do |value|
-    instance_variable_get( "@values" )[num] = field.typecast( value )
-  end
-end
-
-## column/columns aliases for field/fields
-##   use self <<  with alias_method  - possible? works? why? why not?
-def self.column( name, type=:string ) field( name, type ); end
-def self.columns() fields; end
-def self.column_names() field_names; end
-def self.column_types() field_types; end
-
-
-
-
-def self.build_hash( values )   ## find a better name - build_attrib? or something?
-  ## convert to key-value (attribute) pairs
-  ## puts "== build_hash:"
-  ## pp values
-
-  ## e.g. [[],[]]  return zipped pairs in array as (attribute - name/value pair) hash
-  Hash[ field_names.zip(values) ]
-end
-
-
-
-def self.typecast( new_values )
-  values = []
-
-  ##
-  ## todo: check that new_values.size <= fields.size
-  ##
-  ##   fields without values will get auto-filled with nils (or default field values?)
-
-  ##
-  ##  use fields.zip( new_values ).map |field,value| ... instead - why? why not?
-  fields.each_with_index do |field,i|
-     value = new_values[i]   ## note: returns nil if new_values.size < fields.size
-     values << field.typecast( value )
-  end
-  values
-end
-
-
-def parse( new_values )   ## use read (from array) or read_values or read_row - why? why not?
-
-  ## todo: check if values overshadowing values attrib is ok (without warning?) - use just new_values (not values)
-
-  ## todo/fix:
-  ##  check if values is a string
-  ##  use Csv.parse_line to convert to array
-  ##  otherwise assume array of (string) values
-  @values = self.class.typecast( new_values )
-  self  ## return self for chaining
-end
-
-
-def values
-  ## return array of all record values (typed e.g. float, integer, date, ..., that is,
-  ##   as-is and  NOT auto-converted to string
-  ##  use to_csv or values for all string values)
-  @values
-end
-
-
-
-def [](key)
-  if key.is_a? Integer
-    @values[ key ]
-  elsif key.is_a? Symbol
-    ## try attribute access
-    send( key )
-  else  ## assume string
-    ## downcase and symbol-ize
-    ##   remove spaces too -why? why not?
-    ##  todo/fix: add a lookup mapping for (string) titles (Team 1, etc.)
-    send( key.downcase.to_sym )
-  end
-end
-
-
-
-def to_h    ## use to_hash - why? why not?  - add attributes alias - why? why not?
-  self.class.build_hash( @values )
-end
-
-
-def to_csv   ## use/rename/alias to to_row too - why? why not?
-  ## todo/fix: check for date and use own date to string format!!!!
-  @values.map{ |value| value.to_s }
-end
+########################
+# Base
 
+class Base < Record::Base
 
 def self.foreach( path, sep: Csv.config.sep, headers: true )
   CsvReader.foreach( path, sep: sep, headers: headers ) do |row|
@@ -309,25 +49,54 @@ end
 
 
 
-def initialize( **kwargs )
-  @values = []
-  update( kwargs )
+def to_csv   ## use/rename/alias to to_row too - why? why not?
+  ## todo/fix: check for date and use own date to string format!!!!
+  @values.map{ |value| value.to_s }
 end
 
-def update( **kwargs )
-  pp kwargs
-  kwargs.each do |name,value|
-    ## note: only convert/typecast string values
-    if value.is_a?( String )
-      send( "parse_#{name}", value )  ## note: use parse_<name> setter (for typecasting)
-    else  ## use "regular" plain/classic attribute setter
-      send( "#{name}=", value )
-    end
+end # class Base
+
+
+
+
+###########################################
+## "magic" lazy auto-build schema from headers versions
+
+def self.build_class( headers )   ## check: find a better name - why? why not?
+  ## (auto-)build record class from an array of headers
+  ##   add fields (all types will be string for now)
+  clazz = Class.new( Base )
+  headers.each do |header|
+    ## downcase and remove all non-ascii chars etc.
+    ##  todo/fix: remove all non-ascii chars!!!
+    ##  todo: check if header starts with a number too!!
+    name = header.downcase.gsub( ' ', '_' )
+    name = name.to_sym   ## symbol-ify
+    clazz.field( name )
   end
+  clazz
+end
 
-  ## todo: check if args.first is an array  (init/update from array)
-  self   ## return self for chaining
+def self.read( path, sep: Csv.config.sep )
+  headers = CsvReader.header( path, sep: sep )
+
+  clazz = build_class( headers )
+  clazz.read( path, sep: sep )
+end
+
+def self.foreach( path, sep: Csv.config.sep, &block )
+  headers = CsvReader.header( path, sep: sep )
+
+  clazz = build_class( headers )
+  clazz.foreach( path, sep: sep, &block )
+end
+
+
+#########
+# alternative class (record) builder
+
+def self.define( &block )   ## check: rename super_class to base - why? why not?
+  Record.define( Base, &block )
 end
 
-end # class Base
 end # module CsvRecord

data/lib/csvrecord/version.rb

@@ -5,7 +5,7 @@ module CsvRecord
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
   MINOR = 4
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
 
@@ -21,4 +21,4 @@ module CsvRecord
     File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
   end
 
-end # class CsvRecord
+end # module CsvRecord

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvrecord
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerald Bauer
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: csvreader
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +84,6 @@ files:
 - Rakefile
 - lib/csvrecord.rb
 - lib/csvrecord/base.rb
-- lib/csvrecord/builder.rb
 - lib/csvrecord/version.rb
 - test/data/beer.csv
 - test/data/beer11.csv

data/lib/csvrecord/builder.rb

@@ -1,37 +0,0 @@
-# encoding: utf-8
-
-## (record) builder mini language / domain-specific language (dsl)
-
-module CsvRecord
-
-class Builder  # check: rename to RecordDefinition or RecordDsl or similar - why? why not?
-  def initialize
-    @clazz = Class.new(Base)
-  end
-
-  def field( name, type=:string )   ## note: type defaults to string
-    puts "  adding field >#{name}< with type >#{type}<"
-    @clazz.field( name, type )  ## auto-add getter and setter
-  end
-
-  def string( name )
-    puts "  adding string field >#{name}<"
-    field( name, :string )
-  end
-
-  def integer( name )  ## use number for alias for integer - why? why not???
-    puts "  adding integer number field >#{name}<"
-    field( name, :integer )
-  end
-
-  def float( name )
-    puts "  adding float number field >#{name}<"
-    field( name, :float )
-  end
-
-
-  def to_record   ## check: rename to just record or obj or finish or end something?
-    @clazz
-  end
-end # class Builder
-end # module CsvRecord