csvrecord 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d818fdddecd7801bb46d6e4e1aadeae2d8fd8582
-  data.tar.gz: 05ae6e9291073847dca7b976063b8e8aa636c8bf
+  metadata.gz: ea4f015ade2a8b105eb89aec99e4a9bd7f5be01c
+  data.tar.gz: 2738c2e3655a29e3a626eb7aee228d9b7275a3bd
 SHA512:
-  metadata.gz: c2749476a7023391f54e049862b1816d78e6cab919bb0d2385a4d1578552f2f5a7b72fbda022858822e297d29e02634e743d27bcb24ae80ac7e28f63170def5e
-  data.tar.gz: 838ce053c3b6203a7f9a30bf745f46a69b35da6f14974b30c29c2ebc2b38cd9d94a0369cb8a92459de635ba21294cc09206db5d56918cdea1059dab8b545acdc
+  metadata.gz: '0290ce3db55dfa7e3e24f00db9aa4c918be94b04c408415844015d09fa8f0eabee4f8989ac7f9dfb7fc917dbd428727da25ee1d84200057b5bbe6c9add3e18ce'
+  data.tar.gz: 6c47502227af693814a99f7d34bd9fede8afadc556d1797c1cf365437e7491312bd7d1037c23eb0923775884bb0ed5e55ac5a62642d940810db7fa9bdb3e4a5d

data/README.md

@@ -61,21 +61,12 @@ pretty prints (pp):
 
 ```
 6 beers:
-[#<Beer:0x302c760
-    @abv     = 7.0,
-    @brewery = "Andechser Klosterbrauerei",
-    @city    = "Andechs",
-    @name    = "Doppelbock Dunkel">,
- #<Beer:0x3026fe8
-    @abv     = 5.6,
-    @brewery = "Augustiner Br\u00E4u M\u00FCnchen",
-    @city    = "M\u00FCnchen",
-    @name    = "Edelstoff">,
- #<Beer:0x30257a0
-    @abv     = 5.4,
-    @brewery = "Bayerische Staatsbrauerei Weihenstephan",
-    @city    = "Freising",
-    @name    = "Hefe Weissbier">,
+[#<Beer:0x302c760 @values=
+   ["Andechser Klosterbrauerei", "Andechs", "Doppelbock Dunkel", 7.0]>,
+ #<Beer:0x3026fe8 @values=
+   ["Augustiner Br\u00E4u M\u00FCnchen", "M\u00FCnchen", "Edelstoff", 5.6]>,
+ #<Beer:0x30257a0 @values=
+   ["Bayerische Staatsbrauerei Weihenstephan", "Freising", "Hefe Weissbier", 5.4]>,
  ...
 ]
 ```
@@ -103,30 +94,86 @@ Hofbräu Oktoberfestbier (6.3%) by Staatliches Hofbräuhaus München, München
 Or create new records from scratch. Example:
 
 ``` ruby
+beer = Beer.new( 'Andechser Klosterbrauerei',
+                 'Andechs',
+                 'Doppelbock Dunkel',
+                 '7.0%' )
+
+# -or-
+
+values = ['Andechser Klosterbrauerei', 'Andechs', 'Doppelbock Dunkel', '7.0%']
+beer = Beer.new( values )
+
+# -or-
+
 beer = Beer.new( brewery: 'Andechser Klosterbrauerei',
                  city:    'Andechs',
-                 name:    'Doppelbock Dunkel' )
-pp beer
+                 name:    'Doppelbock Dunkel',
+                 abv:     '7.0%' )
+
+# -or-
+
+hash = { brewery: 'Andechser Klosterbrauerei',
+         city:    'Andechs',
+         name:    'Doppelbock Dunkel',
+         abv:     '7.0%' }
+beer = Beer.new( hash )
+
 
 # -or-
 
 beer = Beer.new
-beer.update( abv: 12.7 )
 beer.update( brewery: 'Andechser Klosterbrauerei',
              city:    'Andechs',
              name:    'Doppelbock Dunkel' )
+beer.update( abv: 12.7 )
 
 # -or-
 
-beer.abv     = 12.7
-beer.name    = 'Doppelbock Dunkel'
+beer = Beer.new
+beer.parse( ['Andechser Klosterbrauerei', 'Andechs', 'Doppelbock Dunkel', '7.0%'] )
+
+# -or-
+
+beer = Beer.new
+beer.parse( 'Andechser Klosterbrauerei,Andechs,Doppelbock Dunkel,7.0%' )
+
+# -or-
+
+beer = Beer.new
 beer.brewery = 'Andechser Klosterbrauerei'
+beer.name    = 'Doppelbock Dunkel'
+beer.abv     = 12.7
 ```
 
 
 And so on. That's it.
 
 
+## Frequently Asked Questions (FAQs) and Answers
+
+### Q: What about ActiveRecord models? Why not inherit from ActiveRecord::Base so you get the SQL relational database magic / machinery for "free"?
+
+Good point. `CsvRecord` and `ActiveRecord` are different.
+`ActiveRecord` has its own
+database schema / attributes. Using [`CsvPack` - the tabular data
+package](https://github.com/csv11/csvpack) you can, however, for your convenience auto-generate
+`ActiveRecord` model classes
+and `ActiveRecord` schema migrations (that is, tables and indices, etc.)
+from the tabular
+datapackage schema (in the JSON Schema format).
+That was kind of the start of the
+exercise :-), that is, the genesis for building `CsvRecord`
+in the first place.
+
+To sum up - use `CsvRecord` for comma-separated values (csv) data
+imports or data "wrangling"
+and use `ActiveRecord` for SQL queries / analysis and more. In the
+good old unix tradition - the work together but have its own (limited
+/ focused) purpose.
+
+
+
 
 ## Alternatives
 

data/lib/csvrecord/base.rb

@@ -11,12 +11,17 @@ module CsvRecord
   class Field  ## ruby record class field
     attr_reader :name, :type
 
-    def initialize( 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?
@@ -24,10 +29,36 @@ module CsvRecord
         @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!!!!
+          ## 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
 
 
@@ -91,7 +122,8 @@ end
 
 
 def self.field( name, type=:string )
-  field = Field.new( name, type )
+  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
@@ -99,18 +131,18 @@ end
 
 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
+  num  = field.num
 
   define_method( name ) do
-    instance_variable_get( "@#{name}" )
+    instance_variable_get( "@values" )[num]
   end
 
   define_method( "#{name}=" ) do |value|
-    instance_variable_set( "@#{name}", value )
+    instance_variable_get( "@values" )[num] = value
   end
 
   define_method( "parse_#{name}") do |value|
-    instance_variable_set( "@#{name}", self.class.typecast( value, type ) )
+    instance_variable_get( "@values" )[num] = field.typecast( value )
   end
 end
 
@@ -123,29 +155,6 @@ def self.column_types() field_types; end
 
 
 
-def self.typecast( value, type )  ## cast (convert) from string value to type (e.g. float, integer, etc.)
-
-
-  ## 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
-    ## raise exception about unknow type
-    pp type
-    puts "!!!! unknown type >#{type}< - don't know how to convert/typecast string value >#{value}<"
-    value
-  end
-end
-
 
 def self.build_hash( values )   ## find a better name - build_attrib? or something?
   ## convert to key-value (attribute) pairs
@@ -158,36 +167,71 @@ end
 
 
 
-def parse( values )   ## use read (from array) or read_values or read_row - why? why not?
+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
-
-  h = self.class.build_hash( values )
-  update( h )
+  @values = self.class.typecast( new_values )
+  self  ## return self for chaining
 end
 
-def to_a
+
+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)
-  self.class.fields.map { |field| send( field.name ) }
+  @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( to_a )
+  self.class.build_hash( @values )
 end
 
 
-def values   ## use/rename/alias to to_row too - why? why not?
+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!!!!
-  to_a.map{ |value| value.to_s }
+  @values.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
 
 
 
@@ -211,9 +255,8 @@ def self.parse( txt_or_rows )  ## note: returns an (lazy) enumarator
        ## pp row.to_hash
        ## fix/todo!!!!!!!!!!!!!
        ##  check for CSV::Row etc. - use row.to_hash ?
-       h = build_hash( row.fields )
-       ## pp h
-       rec = new( h )
+       rec = new
+       rec.parse( row.fields )
      ## end
      yielder.yield( rec )
     end
@@ -229,6 +272,7 @@ end
 
 
 def initialize( **kwargs )
+  @values = []
   update( kwargs )
 end
 

data/lib/csvrecord/version.rb

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

data/test/test_beer.rb

@@ -122,7 +122,7 @@ class TestBeer < MiniTest::Test
     assert_equal ['Andechser Klosterbrauerei',
                   'Andechs',
                   'Doppelbock Dunkel',
-                  7.0], beers[0].to_a     ## typed values
+                  7.0], beers[0].values     ## typed values
 
     beer_hash = { brewery: 'Andechser Klosterbrauerei',
                   city:    'Andechs',
@@ -133,11 +133,7 @@ class TestBeer < MiniTest::Test
     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
+                  '7.0'], beers[0].to_csv  ## try to_csv all string values
 
 
     beer = BeerClassic.new
@@ -204,11 +200,31 @@ class TestBeer < MiniTest::Test
     beer = Beer.new
     beer.parse( values )
 
-    assert_equal values,         beer.values
+    assert_equal values,         beer.to_csv
     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
+
+    assert_equal values[0],      beer[0]
+    assert_equal values[1],      beer[1]
+    assert_equal values[2],      beer[2]
+    assert_equal values[3].to_f, beer[3]
+
+    assert_equal values[0],      beer.values[0]
+    assert_equal values[1],      beer.values[1]
+    assert_equal values[2],      beer.values[2]
+    assert_equal values[3].to_f, beer.values[3]
+
+    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]
+
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvrecord
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc