props 1.0.1 → 1.0.2

data/Manifest.txt

@@ -3,5 +3,13 @@ Manifest.txt
 README.md
 Rakefile
 lib/props.rb
+lib/props/db.rb
+lib/props/db/deleter.rb
+lib/props/db/models.rb
+lib/props/db/schema.rb
+lib/props/env.rb
+lib/props/ini.rb
+lib/props/props.rb
+lib/props/version.rb
 test/helper.rb
 test/test_ini.rb

data/Rakefile

@@ -1,10 +1,10 @@
 require 'hoe'
-require './lib/props.rb'
+require './lib/props/version.rb'
 
 Hoe.spec 'props' do
 
-  self.version = Props::VERSION
-  
+  self.version = ConfUtils::VERSION
+
   self.summary = 'props - Manage Settings Hierachies (Commandline, User, Home, Defaults, etc.)'
   self.description = summary
 

data/lib/props/db/deleter.rb

@@ -0,0 +1,15 @@
+
+module ConfDb
+
+  class Deleter
+    include ConfDb::Models
+
+    def run
+      # for now delete all tables
+      
+      Prop.delete_all
+    end
+    
+  end # class Deleter
+  
+end # module ConfDb

data/lib/props/db/models.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module ConfDb
+  module Models
+
+
+class Prop < ActiveRecord::Base
+  
+end # class Prop
+
+
+  end # module Models
+end # module ConfDb

data/lib/props/db/schema.rb

@@ -0,0 +1,23 @@
+module ConfDb
+
+
+class CreateDb < ActiveRecord::Migration
+
+  def up
+
+create_table :props do |t|
+  t.string :key,   :null => false
+  t.string :value, :null => false
+  t.string :kind     # e.g. version|user|sys(tem)|db etc. # note: can NOT use type - already used by ActiveRecord
+  t.timestamps
+end
+
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+
+end  # class CreateDb
+
+end  # module ConfDb

data/lib/props/db.rb

@@ -0,0 +1,41 @@
+#########################################
+# NB: only load on demand
+#  we do NOT want to pull in activerecord gem/dep for simple scripts
+
+# rubygems / 3rd party libs
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+# our own code
+
+require 'props/db/models'
+require 'props/db/schema'
+require 'props/db/deleter'
+
+
+module ConfDb
+
+  def self.banner
+    "confdb #{ConfUtils::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.create
+    CreateDb.new.up
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting props table records/data...'
+    Deleter.new.run
+  end # method delete!
+
+  def self.stats
+    # to be done
+  end
+
+
+end # module ConfDb
+
+
+# say hello
+puts ConfDb.banner

data/lib/props/env.rb

@@ -0,0 +1,30 @@
+module ConfUtils
+
+class Env
+
+  def self.home
+    path = if( ENV['HOME'] || ENV['USERPROFILE'] )
+             ENV['HOME'] || ENV['USERPROFILE']
+           elsif( ENV['HOMEDRIVE'] && ENV['HOMEPATH'] )
+             "#{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}"
+           else
+             begin
+                File.expand_path('~')
+             rescue
+                if File::ALT_SEPARATOR
+                   'C:/'
+                else
+                   '/'
+                end
+             end
+           end
+     
+    # todo: use logger - how?
+    ## puts "env home=>#{path}<"
+    
+    path
+  end
+
+end # class Env
+
+end # module ConfUtils

data/lib/props/ini.rb

@@ -0,0 +1,84 @@
+
+module ConfUtils
+
+
+class IniFile
+
+  # returns a nested hash
+  #  (compatible structure - works like YAML.load_file)
+
+  def self.load_file( path )
+    text = File.open( path, 'r:bom|utf-8' ).read
+    self.load( text )
+  end
+
+  def self.load( text )
+    IniFile.new( text ).parse
+  end
+
+
+  def initialize( text )
+    @text = text
+  end
+
+  def parse
+    hash = top_hash = Hash.new
+
+    text = @text
+    text = text.gsub( "\t", ' ' )   # replace all tabs w/ spaces
+
+    text.each_line do |line|
+
+      ### skip comments
+      #  e.g.   # this is a comment line
+      #  or     ; this too
+      #  or     --  haskell style
+      #  or     %   text style
+
+      if line =~ /^\s*#/ || line =~ /^\s*;/ || line =~ /^\s*--/ || line =~ /^\s*%/
+        ## logger.debug 'skipping comment line'
+        next
+      end
+
+      ### skip blank lines
+      if line =~ /^\s*$/ 
+        ## logger.debug 'skipping blank line'
+        next
+      end
+
+      # pass 1) remove possible trailing eol comment
+      ##  e.g    -> New York   # Sample EOL Comment Here (with or without commas,,,,)
+      ## becomes -> New York
+
+      line = line.sub( /\s+#.*$/, '' )
+
+      # pass 2) remove leading and trailing whitespace
+      
+      line = line.strip
+ 
+      ## check for new section e.g.  [planet012-xxx_bc]
+
+      ### todo: allow _ or - in strict section key? why? why not??
+      ###   allow _ or - in value key? why why not??
+      if line =~ /^\s*\[\s*([a-z0-9_\-]+)\s*\]\s*$/   # strict section
+        key = $1.to_s.dup
+        hash = top_hash[ key ] = Hash.new
+      elsif line =~ /^\s*\[\s*([^ \]]+)\s*\]\s*$/     # liberal section; allow everything in key
+        key = $1.to_s.dup
+        hash = top_hash[ key ] = Hash.new
+      elsif line =~ /^\s*([a-z0-9_\-]+)\s*[:=](.*)$/
+        key   = $1.to_s.dup
+        value = $2.to_s.strip.dup   # check if it can be nil? if yes use blank string e.g. ''
+        ### todo:  strip quotes from value??? why? why not?
+        hash[ key ] = value
+      else
+        puts "*** warn: skipping unknown line type in ini >#{line}<"
+      end
+    end # each lines
+
+    top_hash
+  end
+  
+end # class IniReader
+
+end # module ConfUtils

data/lib/props/props.rb

@@ -0,0 +1,64 @@
+
+module ConfUtils
+
+
+class Props
+
+  VERSION = ConfUtils::VERSION  # remove version; depreciated api/constant; use ConfUtils::VERSION
+
+  attr_reader :path
+  attr_reader :parent
+
+
+  def self.load_file( path, parent=nil )
+    h = YAML.load_file( path )
+    Props.new( h, path, parent )
+  end
+  
+  ### todo: use TOP_LEVEL_BINDING for binding default?
+  def self.load_file_with_erb( path, binding, parent=nil )  # run through erb first
+    text = ERB.new( File.read( path ) ).result( binding )
+    h = YAML.load( text )
+    Props.new( h, path, parent )
+  end
+
+
+  def initialize( hash, path, parent=nil)
+    @hash   = hash
+    @path   = path
+    @parent = parent
+  end
+
+  def dump   # for debugging
+    puts "dump of >#{@path}<:"
+    pp @hash
+  end
+
+    
+  def fetch(key, default)
+    value = get( key )
+    value.nil? ? default : value
+  end
+  
+  def fetch_from_section(section, key, default)
+    value = get_from_section( section, key )
+    value.nil? ? default : value
+  end
+
+  def [](key)  get( key );  end
+
+  def get( key )
+    value = @hash.fetch( key.to_s, nil )
+    # if not found try lookup in parent hash
+    (value.nil? && parent) ? parent.get(key) : value
+  end
+
+  def get_from_section( section, key )
+    value = @hash.fetch( section.to_s, {} ).fetch( key.to_s, nil )
+    # if not found try lookup in parent hash
+    (value.nil? && parent) ? parent.get_from_section(section,key) : value
+  end
+
+end # class Props
+
+end # module ConfUtils

data/lib/props/version.rb

@@ -0,0 +1,5 @@
+
+module ConfUtils
+  VERSION = '1.0.2'
+end
+

data/lib/props.rb

@@ -8,161 +8,45 @@ require 'fileutils'
 require 'erb'
 
 
+# our own code
 
-class Env
-
-  def self.home
-    path = if( ENV['HOME'] || ENV['USERPROFILE'] )
-             ENV['HOME'] || ENV['USERPROFILE']
-           elsif( ENV['HOMEDRIVE'] && ENV['HOMEPATH'] )
-             "#{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}"
-           else
-             begin
-                File.expand_path('~')
-             rescue
-                if File::ALT_SEPARATOR
-                   'C:/'
-                else
-                   '/'
-                end
-             end
-           end
-     
-    # todo: use logger - how?
-    ## puts "env home=>#{path}<"
-    
-    path
-  end
-
-end # class Env
+require 'props/version'   # version always goes first
+require 'props/env'
+require 'props/ini'
+require 'props/props'
 
 
-module INI
+######################
+# add top_level convenience alias for classes
 
-  def self.load_file( path )
-    # returns a nested hash
-    #  (compatible structure - works like YAML.load_file)
+Env   = ConfUtils::Env
+Props = ConfUtils::Props
 
-    text = File.open( path, 'r:bom|utf-8' ).read
-    self.load( text )
-  end
 
+module INI
 
-  def self.load( text )
-    hash = top_hash = Hash.new
-
-    text = text.gsub( "\t", ' ' )   # replace all tabs w/ spaces
-
-    text.each_line do |line|
-
-      ### skip comments
-      #  e.g.   # this is a comment line
-      #  or     ; this too
-      #  or     --  haskell style
-      #  or     %   text style
-
-      if line =~ /^\s*#/ || line =~ /^\s*;/ || line =~ /^\s*--/ || line =~ /^\s*%/
-        ## logger.debug 'skipping comment line'
-        next
-      end
-
-      ### skip blank lines
-      if line =~ /^\s*$/ 
-        ## logger.debug 'skipping blank line'
-        next
-      end
-
-      # pass 1) remove possible trailing eol comment
-      ##  e.g    -> New York   # Sample EOL Comment Here (with or without commas,,,,)
-      ## becomes -> New York
-
-      line = line.sub( /\s+#.*$/, '' )
-
-      # pass 2) remove leading and trailing whitespace
-      
-      line = line.strip
- 
-      ## check for new section e.g.  [planet012-xxx_bc]
-
-      ### todo: allow _ or - in strict section key? why? why not??
-      ###   allow _ or - in value key? why why not??
-      if line =~ /^\s*\[\s*([a-z0-9_\-]+)\s*\]\s*$/   # strict section
-        key = $1.to_s.dup
-        hash = top_hash[ key ] = Hash.new
-      elsif line =~ /^\s*\[\s*([^ \]]+)\s*\]\s*$/     # liberal section; allow everything in key
-        key = $1.to_s.dup
-        hash = top_hash[ key ] = Hash.new
-      elsif line =~ /^\s*([a-z0-9_\-]+)\s*[:=](.*)$/
-        key   = $1.to_s.dup
-        value = $2.to_s.strip.dup   # check if it can be nil? if yes use blank string e.g. ''
-        ### todo:  strip quotes from value??? why? why not?
-        hash[ key ] = value
-      else
-        puts "*** warn: skipping unknown line type in ini >#{line}<"
-      end
-    end # each lines
-
-    top_hash
-  end # method load
+  # returns a nested hash
+  #  (compatible structure - works like YAML.load_file)
 
+  def self.load_file( path  )   ConfUtils::IniFile.load_file( path );  end
+  def self.load( text )         ConfUtils::IniFile.load( text );   end
 
 end  # module INI
 
 
+module ConfUtils
 
-class Props
-
-  VERSION = '1.0.1'
-
-  attr_reader :path
-  attr_reader :parent
-    
-  def initialize( hash, path, parent=nil)
-    @hash   = hash
-    @path   = path
-    @parent = parent
-  end
-    
-  def self.load_file( path, parent=nil )
-    h = YAML.load_file( path )
-    Props.new( h, path, parent )
-  end
-  
-  ### todo: use TOP_LEVEL_BINDING for binding default?
-  def self.load_file_with_erb( path, binding, parent=nil )  # run through erb first
-    text = ERB.new( File.read( path ) ).result( binding )
-    h = YAML.load( text )
-    Props.new( h, path, parent )
-  end
-    
-  def dump   # for debugging
-    puts "dump of >#{@path}<:"
-    pp @hash
+  def self.banner
+    "props #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
   end
 
-    
-  def fetch(key, default)
-    value = get( key )
-    value.nil? ? default : value
+=begin
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
   end
+=end
   
-  def fetch_from_section(section, key, default)
-    value = get_from_section( section, key )
-    value.nil? ? default : value
-  end
+end  # module ConfUtils
 
-  def [](key)  get( key );  end
-
-  def get( key )
-    value = @hash.fetch( key.to_s, nil )
-    # if not found try lookup in parent hash
-    (value.nil? && parent) ? parent.get(key) : value
-  end
-
-  def get_from_section( section, key )
-    value = @hash.fetch( section.to_s, {} ).fetch( key.to_s, nil )
-    # if not found try lookup in parent hash
-    (value.nil? && parent) ? parent.get_from_section(section,key) : value
-  end
 
-end # class Props
+puts ConfUtils.banner    # say hello

data/test/test_ini.rb

@@ -6,8 +6,8 @@
 
 require 'helper'
 
-class TestIni < MiniTest::Unit::TestCase
 
+class TestIni < MiniTest::Unit::TestCase
 
   def test_load
 
@@ -36,15 +36,15 @@ EOS
     hash = INI.load( text )
     pp hash
 
-    assert( hash['key1'] == 'hello' )
-    assert( hash['key2'] == 'hi!' )
-    assert( hash['section1']['key3'] == 'salut' )
-    assert( hash['section2']['key4'] == 'hola' )
-    assert( hash['section2']['blank'] == '' )
-    assert( hash['section2']['blank2'] == '' )
-    assert( hash['http://example.com']['title'] == 'A rose is a rose is a rose, eh?' )
-    assert( hash['http://example.com']['title2'] == 'A rose is a rose is a rose, eh?' )
-    assert( hash['http://example.com']['title3'] == 'A rose is a rose is a rose, eh?' )
+    assert_equal( 'hello', hash['key1'] )
+    assert_equal( 'hi!',   hash['key2'] )
+    assert_equal( 'salut', hash['section1']['key3'] )
+    assert_equal( 'hola',  hash['section2']['key4'] )
+    assert_equal( '',      hash['section2']['blank'] )
+    assert_equal( '',      hash['section2']['blank2'] )
+    assert_equal( 'A rose is a rose is a rose, eh?', hash['http://example.com']['title'] )
+    assert_equal( 'A rose is a rose is a rose, eh?', hash['http://example.com']['title2'] )
+    assert_equal( 'A rose is a rose is a rose, eh?', hash['http://example.com']['title3'] )
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: props
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &83434100 !ruby/object:Gem::Requirement
+  requirement: &79922660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *83434100
+  version_requirements: *79922660
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &83477370 !ruby/object:Gem::Requirement
+  requirement: &79922080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *83477370
+  version_requirements: *79922080
 description: props - Manage Settings Hierachies (Commandline, User, Home, Defaults,
   etc.)
 email: webslideshow@googlegroups.com
@@ -46,6 +46,14 @@ files:
 - README.md
 - Rakefile
 - lib/props.rb
+- lib/props/db.rb
+- lib/props/db/deleter.rb
+- lib/props/db/models.rb
+- lib/props/db/schema.rb
+- lib/props/env.rb
+- lib/props/ini.rb
+- lib/props/props.rb
+- lib/props/version.rb
 - test/helper.rb
 - test/test_ini.rb
 - .gemtest