csvrecord 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bec20faf657130128c9a70953bc48160b3e1d99
-  data.tar.gz: 92900195cb8f791286e4d07920b4f5d1ebb4b13a
+  metadata.gz: d1458e4244f8a88c335b08c7e4c21ff576ba07fe
+  data.tar.gz: c44ca7e8f52667c0a62895c97e86ebe501b18c82
 SHA512:
-  metadata.gz: c02849458381b9dd23643f0a6f9358c04984ef69aa5e2b72c61a791b3da7340a431049dd08a0059a09c0c188c5c5fbafedeaf815fe062d9ab4c61f8f704ce75d
-  data.tar.gz: b79e7e35a4d016ac38cbc281d59a534df054d508d8ccc45130f1b351850622ed0991e59336b564c42aa1919c14da62de973b1e797b44d8ae26e428e80db2a106
+  metadata.gz: dabfc7c26f4e69548f2791c9474f4b3579a90c17e14bccfc5f9c0db4285f8e4610b6ef70a4bd6560547a828ff55c4d38235a8201a57f7fb1c615e742c277bf15
+  data.tar.gz: 4f5879e6827cf1a1d56c989242bd13b672fe6abf28abff1743219921ed88d55ab238eedf763ff5bf592a07acd9aa0a3e0504673e79fbaeadd931c3e1dd6db7d6

data/lib/csvrecord/base.rb

@@ -12,36 +12,94 @@ module CsvRecord
     attr_reader :name, :type
 
     def initialize( name, type )
-      ## todo: always symbol-ify (to_sym) name and type - why? why not?
+      ## 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
 
       if type.is_a?( Class )
         @type = type    ## assign class to its own property - why? why not?
       else
-        @type = type.to_sym
+        @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
   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
-    builder.instance_eval(&block)
+    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
 
 
+
 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 )
+  field = Field.new( name, type )
+  fields << field
+
+  define_field( field )  ## auto-add getter,setter,parse/typecast
+end
 
-  fields << Field.new( name, type )
+def self.define_field( field )
+  name = field.name   ## note: always assumes a "cleaned-up" (symbol) name
+  type = field.type   ## note: always assumes a (class) type
 
   define_method( name ) do
     instance_variable_get( "@#{name}" )
@@ -55,27 +113,36 @@ def self.field( name, type=:string )
     instance_variable_set( "@#{name}", self.class.typecast( value, type ) )
   end
 end
-def self.add_field( name, type ) field( name, type ); end  ## add alias for builder
 
+## 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.typecast( value, type )  ## cast (convert) from string value to type (e.g. float, integer, etc.)
 
 
-def self.typecast( value, type )
   ## convert string value to (field) type
-  if type == :string || type == 'string' || type == String
+  if type == String
      value   ## pass through as is
-  elsif type == :float || type == 'float' || type == Float
-    ## note: allow/check for nil values
+  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 == :number || type == 'number' || type == Integer
+  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
-     ## raise exception about unknow type
-     puts "!!!! unknown type >#{type}< - don't know how to convert/typecast string value >#{value}<"
-     value
+    ## raise exception about unknow type
+    pp type
+    puts "!!!! unknown type >#{type}< - don't know how to convert/typecast string value >#{value}<"
+    value
   end
 end
 
@@ -85,21 +152,43 @@ def self.build_hash( values )   ## find a better name - build_attrib? or somethi
   ## puts "== build_hash:"
   ## pp values
 
-  h = {}
-  values.each_with_index do |value,i|
-    field = fields[i]
-    ## pp field
-    h[ field.name ] = value
-  end
-  h
+  ## e.g. [[],[]]  return zipped pairs in array as (attribute - name/value pair) hash
+  Hash[ field_names.zip(values) ]
 end
 
 
+
 def parse( values )   ## use read (from array) or read_values or read_row - why? why not?
-  h = self.build_hash( values )
+
+  ## todo/fix:
+  ##  check if values is a string
+  ##  use Csv.parse_line to convert to array
+  ##  otherwise assume array of (string) values
+
+  h = self.class.build_hash( values )
   update( h )
 end
 
+def to_a
+  ## 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)
+  self.class.fields.map { |field| send( field.name ) }
+end
+
+def to_h    ## use to_hash - why? why not?  - add attributes alias - why? why not?
+  self.class.build_hash( to_a )
+end
+
+
+def values   ## use/rename/alias to to_row too - why? why not?
+  ## todo/fix: check for date and use own date to string format!!!!
+  to_a.map{ |value| value.to_s }
+end
+## use values as to_csv alias
+## - reverse order? e.g. make to_csv an alias of value s- why? why not?
+alias_method :to_csv, :values
+
 
 
 def self.parse( txt_or_rows )  ## note: returns an (lazy) enumarator
@@ -120,7 +209,8 @@ def self.parse( txt_or_rows )  ## note: returns an (lazy) enumarator
      ## else
        ## pp row.fields
        ## pp row.to_hash
-       ## fix/todo: use row.to_hash
+       ## fix/todo!!!!!!!!!!!!!
+       ##  check for CSV::Row etc. - use row.to_hash ?
        h = build_hash( row.fields )
        ## pp h
        rec = new( h )

data/lib/csvrecord/builder.rb

@@ -11,22 +11,22 @@ class Builder  # check: rename to RecordDefinition or RecordDsl or similar - why
 
   def field( name, type=:string )   ## note: type defaults to string
     puts "  adding field >#{name}< with type >#{type}<"
-    @clazz.add_field( name, type )  ## auto-add getter and setter
+    @clazz.field( name, type )  ## auto-add getter and setter
   end
 
   def string( name )
     puts "  adding string field >#{name}<"
-    field( name, 'string' )
+    field( name, :string )
   end
 
-  def number( name )  ## use for alias for integer ???
-    puts "  adding number field >#{name}<"
-    field( name, 'number' )
+  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' )
+    field( name, :float )
   end
 
 

data/lib/csvrecord/version.rb

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

data/test/test_beer.rb

@@ -79,6 +79,16 @@ class TestBeer < MiniTest::Test
     pp clazz2.class.name
     pp Beer.class.name
 
+    clazz2b = CsvRecord.define do |rec|   ## try "yield"-style dsl with block.arity == 1
+       rec.string :brewery
+       rec.string :city
+       rec.string :name
+       rec.float  :abv
+    end
+    pp clazz2b
+    pp clazz2b.class.name
+    pp clazz2b.fields
+
     assert true  ## assume ok if we get here
   end
 
@@ -101,6 +111,34 @@ class TestBeer < MiniTest::Test
     pp beers
 
     pp BeerClassic.fields
+    pp BeerClassic.field_names
+    pp BeerClassic.columns       ## try fields alias
+    pp BeerClassic.column_names  ## try field_names alias
+
+    assert_equal [:brewery, :city, :name, :abv], BeerClassic.field_names
+    assert_equal [String, String, String, Float], BeerClassic.field_types
+
+
+    assert_equal ['Andechser Klosterbrauerei',
+                  'Andechs',
+                  'Doppelbock Dunkel',
+                  7.0], beers[0].to_a     ## typed values
+
+    beer_hash = { brewery: 'Andechser Klosterbrauerei',
+                  city:    'Andechs',
+                  name:    'Doppelbock Dunkel',
+                  abv:     7.0 }
+    assert_equal beer_hash, beers[0].to_h     ## typed name/value pairs (hash)
+
+    assert_equal  ['Andechser Klosterbrauerei',
+                  'Andechs',
+                  'Doppelbock Dunkel',
+                  '7.0'], beers[0].values    ## all string values
+    assert_equal  ['Andechser Klosterbrauerei',
+                  'Andechs',
+                  'Doppelbock Dunkel',
+                  '7.0'], beers[0].to_csv  ## try to_csv alias
+
 
     beer = BeerClassic.new
     pp beer
@@ -151,10 +189,26 @@ class TestBeer < MiniTest::Test
                       name:   'Doppelbock Dunkel' )
     pp beer2
 
-    assert_equal nil, beer2.abv
+    assert_nil   beer2.abv
     assert_equal 'Andechser Klosterbrauerei', beer2.brewery
     assert_equal 'Andechs', beer2.city
     assert_equal 'Doppelbock Dunkel', beer2.name
   end
 
+  def test_parse
+    values = ['Andechser Klosterbrauerei',
+              'Andechs',
+              'Doppelbock Dunkel',
+              '7.0']
+
+    beer = Beer.new
+    beer.parse( values )
+
+    assert_equal values,         beer.values
+    assert_equal values[0],      beer.brewery
+    assert_equal values[1],      beer.city
+    assert_equal values[2],      beer.name
+    assert_equal values[3].to_f, beer.abv
+  end
+
 end # class TestBeer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvrecord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer