record 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905b06c2d1e681e1ae4a2f99b31e1293ab8d455d
-  data.tar.gz: 9a2876f8c7ca014181d75a1e0e02052b17c1546f
+  metadata.gz: cc59075082029afa3cb880dd9048246c0f24e467
+  data.tar.gz: 33b1756e6572e6a251aca77d610311606504cf51
 SHA512:
-  metadata.gz: a6a98f18f4b684db22b4099ccd0bf2a962d7cde44216facd03de97733000ddff62120709ab3766b85fadef58d5e60b88871a278282f9d7a3451cf6432a4edf67
-  data.tar.gz: c48238cbdedd1f50f36aad3ecbc5e9b437af5fd8f356bda68e1d16f5182c5d5af2d1d7866eb0d9a6d04832aff459fec1a133cf2af1a6af746a093aaab30ec485
+  metadata.gz: 2faf17a51b130aefd4b935e58503beefba5798940df7b47fcb8dc8c0455fa1e8c0cae4748e56bbf04c2e764a5e8e37e382269e30ca97433ea60f6f5b188a8bda
+  data.tar.gz: 4321d9fc421c88d573df8016e3f0fb6d960151044ea0d641a43863ef9d63ec7ca0d301f24a157aed3371b4cc528d6ccedf890a4312ec29f78d0214941e1926ed

data/README.md

@@ -1,15 +1,103 @@
-# record
+# record -  named tuples / records with typed structs / schemas
 
-* home  :: [github.com/rubylibs/record](https://github.com/rubylibs/record)
-* bugs  :: [github.com/rubylibs/record/issues](https://github.com/rubylibs/record/issues)
+* home  :: [github.com/rubycoco/record](https://github.com/rubycoco/record)
+* bugs  :: [github.com/rubycoco/record/issues](https://github.com/rubycoco/record/issues)
 * gem   :: [rubygems.org/gems/record](https://rubygems.org/gems/record)
 * rdoc  :: [rubydoc.info/gems/record](http://rubydoc.info/gems/record)
 * forum :: [wwwmake](http://groups.google.com/group/wwwmake)
 
 
+
 ## Usage
 
 
+Step 1: Define a (typed) struct for your records / named tuples. Example:
+
+```ruby
+require 'record'
+
+Beer = Record.define do
+  field :brewery        ## note: default type is :string
+  field :city
+  field :name
+  field :abv, Float     ## allows type specified as class (or use :float)
+end
+```
+
+or in "classic" style:
+
+```ruby
+class Beer < Record::Base
+  field :brewery
+  field :city
+  field :name
+  field :abv, Float
+end
+```
+
+
+
+Step 2:  Use the new class to create new (typed) records. Example:
+
+
+``` ruby
+beer = Beer.new( 'Andechser Klosterbrauerei',
+                 'Andechs',
+                 'Doppelbock Dunkel',
+                 '7%' )
+
+# -or-
+
+values = ['Andechser Klosterbrauerei', 'Andechs', 'Doppelbock Dunkel', '7%']
+beer = Beer.new( values )
+
+# -or-
+
+beer = Beer.new( brewery: 'Andechser Klosterbrauerei',
+                 city:    'Andechs',
+                 name:    'Doppelbock Dunkel',
+                 abv:     '7%' )
+
+# -or-
+
+hash = { brewery: 'Andechser Klosterbrauerei',
+         city:    'Andechs',
+         name:    'Doppelbock Dunkel',
+         abv:     '7%' }
+beer = Beer.new( hash )
+
+
+# -or-
+
+beer = Beer.new
+beer.update( brewery: 'Andechser Klosterbrauerei',
+             city:    'Andechs',
+             name:    'Doppelbock Dunkel' )
+beer.update( abv: 7.0 )
+
+# -or-
+
+beer = Beer.new
+beer.parse( ['Andechser Klosterbrauerei', 'Andechs', 'Doppelbock Dunkel', '7%'] )
+
+# -or-
+
+beer = Beer.new
+beer.parse( 'Andechser Klosterbrauerei,Andechs,Doppelbock Dunkel,7%' )
+
+# -or-
+
+beer = Beer.new
+beer.brewery = 'Andechser Klosterbrauerei'
+beer.name    = 'Doppelbock Dunkel'
+beer.abv     = 7.0
+```
+
+
+And so on. That's it.
+
+
+
 
 ## License
 

data/Rakefile

@@ -5,10 +5,10 @@ Hoe.spec 'record' do
 
   self.version = Record::VERSION
 
-  self.summary = "record"
+  self.summary = "record - named tuples / records with typed structs / schemas"
   self.description = summary
 
-  self.urls = ['https://github.com/rubylibs/record']
+  self.urls = ['https://github.com/rubycoco/record']
 
   self.author = 'Gerald Bauer'
   self.email = 'wwwmake@googlegroups.com'
@@ -20,7 +20,7 @@ Hoe.spec 'record' do
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   :required_ruby_version => '>= 2.2.2'
+   required_ruby_version: '>= 2.2.2'
   }
 
 end

data/lib/record.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 require 'pp'
+require 'logger'
+
 
 
 ###
@@ -11,4 +13,5 @@ require 'record/base'
 require 'record/builder'
 
 
-puts Record.banner   # say hello
+# say hello
+puts Record.banner     if $DEBUG || (defined?($RUBYCOCO_DEBUG) && $RUBYCOCO_DEBUG)

data/lib/record/builder.rb

@@ -5,27 +5,45 @@
 module Record
 
 class Builder  # check: rename to RecordDefinition or RecordDsl or similar - why? why not?
+
+  ###################################
+  ## add simple logger with debug flag/switch
+  #
+  #  use Parser.debug = true   # to turn on
+  #
+  #  todo/fix: use logutils instead of std logger - why? why not?
+
+  def self.build_logger()
+    l = Logger.new( STDOUT )
+    l.level = :info    ## set to :info on start; note: is 0 (debug) by default
+    l
+  end
+  def self.logger() @@logger ||= build_logger; end
+  def logger()  self.class.logger; end
+
+
+
   def initialize( super_class=Base )
     @clazz = Class.new( super_class )
   end
 
   def field( name, type=:string )   ## note: type defaults to string
-    puts "  adding field >#{name}< with type >#{type}<"
+    logger.debug "  adding field >#{name}< with type >#{type}<"
     @clazz.field( name, type )  ## auto-add getter and setter
   end
 
   def string( name )
-    puts "  adding string field >#{name}<"
+    logger.debug "  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}<"
+    logger.debug "  adding integer number field >#{name}<"
     field( name, :integer )
   end
 
   def float( name )
-    puts "  adding float number field >#{name}<"
+    logger.debug "  adding float number field >#{name}<"
     field( name, :float )
   end
 

data/lib/record/field.rb

@@ -9,6 +9,24 @@ module Record
   ##        - fields  (NOT columns or attributes) -- might add an alias later - why? why not?
 
   class Field  ## ruby record class field
+
+
+    ###################################
+    ## add simple logger with debug flag/switch
+    #
+    #  use Parser.debug = true   # to turn on
+    #
+    #  todo/fix: use logutils instead of std logger - why? why not?
+
+    def self.build_logger()
+      l = Logger.new( STDOUT )
+      l.level = :info    ## set to :info on start; note: is 0 (debug) by default
+      l
+    end
+    def self.logger() @@logger ||= build_logger; end
+    def logger()  self.class.logger; end
+
+
     attr_reader :name, :type
 
     ## zero-based position index (0,1,2,3,...)
@@ -28,7 +46,7 @@ module Record
       else
         @type = Type.registry[type.to_sym]
         if @type.nil?
-          puts "!!!! warn unknown type >#{type}< - no class mapping found; add missing type to Record::Type.registry[]"
+          logger.warn "!!!! warn unknown type >#{type}< - no class mapping found; add missing type to Record::Type.registry[]"
           ## todo/fix:  raise exception!!!!
         end
       end
@@ -46,16 +64,16 @@ module Record
       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}<"
+        logger.debug "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}<"
+        logger.debug "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}<"
+        logger.warn "!!!! unknown type >#{@type}< - don't know how to convert/typecast string value >#{value}<"
+        logger.warn @type.inspect
         value
       end
     end

data/lib/record/version.rb

@@ -3,10 +3,14 @@
 
 module Record
 
-  MAJOR = 1    ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
-  PATCH = 1
-  VERSION = [MAJOR,MINOR,PATCH].join('.')
+  module Version
+    MAJOR = 1
+    MINOR = 2
+    PATCH = 0
+  end
+  VERSION = [Version::MAJOR,
+             Version::MINOR,
+             Version::PATCH].join('.')
 
 
   def self.version

data/test/helper.rb

@@ -7,3 +7,9 @@ require 'minitest/autorun'
 
 ## our own code
 require 'record'
+
+
+
+## turn on "global" logging
+Record::Field.logger.level   = :debug
+Record::Builder.logger.level = :debug

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: record
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: record
+description: record - named tuples / records with typed structs / schemas
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
@@ -61,7 +61,7 @@ files:
 - test/helper.rb
 - test/test_record.rb
 - test/test_version.rb
-homepage: https://github.com/rubylibs/record
+homepage: https://github.com/rubycoco/record
 licenses:
 - Public Domain
 metadata: {}
@@ -86,5 +86,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: record
+summary: record - named tuples / records with typed structs / schemas
 test_files: []