add props

Author: geraldb

README.md

@@ -7,6 +7,11 @@ Gems:
 - [logutils-admin](logutils-admin) - addon for browsing logs in database (e.g. LogDb, log model etc.)
 
 
+<!-- break -->
+- [**props**](props)  - manage settings hierarchies (commandline, user, home, defaults, etc.)
+- [props-activerecord](props-activerecord) - addon for database support (ConfDb, props model, etc.)
+
+
 <!-- break -->
 - [shell-lite](shell-lite) - run / execute shell commands
 

props-activerecord/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+

props-activerecord/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2014-12-03
+
+* Everything is new. First release

props-activerecord/Manifest.txt

@@ -0,0 +1,10 @@
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+lib/props/activerecord.rb
+lib/props/activerecord/models.rb
+lib/props/activerecord/schema.rb
+lib/props/activerecord/version.rb
+test/helper.rb
+test/test_models.rb

props-activerecord/README.md

@@ -0,0 +1,41 @@
+# props-activerecord
+
+Manage Setting Hierarchies Addon for Database Support (ConfDb, Props Model, etc.)
+
+* home  :: [github.com/rubylibs/props](https://github.com/rubylibs/props)
+* bugs  :: [github.com/rubylibs/props/issues](https://github.com/rubylibs/props/issues)
+* gem   :: [rubygems.org/gems/props-activerecord](https://rubygems.org/gems/props-activerecord)
+* rdoc  :: [rubydoc.info/gems/props-activerecord](http://rubydoc.info/gems/props-activerecord)
+
+
+## Usage
+
+### DB - Config Database / Schema / Model
+
+Example:
+
+```
+require 'props/activerecord'       # include database support
+
+ConfDb.create    # build schema / tables (props)
+
+Prop.create!( key: 'db.schema.version', '1.0.0' )
+
+puts "Props:"
+Prop.order( 'created_at asc' ).all.each do |prop|
+  puts "  #{prop.key} / #{prop.value} | #{prop.created_at}"
+end
+```
+
+More examples:
+
+```
+ConfDb.tables     # dump stats to console
+ConfDb.delete!    # delete all records
+```
+
+
+## License
+
+The `props-activerecord` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

props-activerecord/Rakefile

@@ -0,0 +1,31 @@
+require 'hoe'
+require './lib/props/activerecord/version.rb'
+
+Hoe.spec 'props-activerecord' do
+
+  self.version = ConfDb::VERSION
+
+  self.summary = 'props-activerecord - Manage Setting Hierachies Addon for Database Support (ConfDb, Props Model, etc.)'
+  self.description = summary
+
+  self.urls    = ['https://github.com/rubylibs/props']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = '[email protected]'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.licenses = ['Public Domain']
+
+  self.extra_deps = [
+    ['props', '>=1.2.0'],
+    ['activerecord'],  # Note: will include activesupport, etc.
+  ]
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.3'
+  }
+
+end

props-activerecord/lib/props/activerecord.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+
+## note: assumes props alreay required
+##  this is an addon/plugin/extension for the props gems (that is, will NOT work stand-alone)
+
+# rubygems / 3rd party libs
+require 'active_record'   ## todo: add sqlite3? etc.
+
+# our own code
+
+require 'props/activerecord/version'   # version always goes first
+require 'props/activerecord/schema'
+require 'props/activerecord/models'
+
+
+
+module ConfDb
+
+  def self.create
+    CreateDb.new.up
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting props table records/data...'
+    Prop.delete_all
+  end # method delete!
+
+##  def self.stats   ## remove ? -- duplicate - use tables - why?? why not????
+##    puts "#{Model::Prop} props"
+##  end
+
+  def self.tables
+    puts "#{Prop.count} props"
+  end
+
+end # module ConfDb
+
+
+
+puts ConfDb.banner   if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)  # say hello

props-activerecord/lib/props/activerecord/models.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module ConfDb
+  module Model
+
+
+class Prop < ActiveRecord::Base
+
+  ### todo/fix: move create_from_fixture! method to textutils ??? - why? why not?
+  ## yes - move to textutils! - fixture concept/notion is part of textutils
+
+  def self.create_from_fixture!( name, path )
+    key   = "db.#{fixture_name_to_prop_key(name)}.version"
+    
+    value = "txt.#{File.mtime(path).strftime('%Y.%m.%d')}"
+    
+    Prop.create!( key: key, value: value )
+  end
+
+  ### todo:
+  ## add latest scope -> order props by creation date desc!!!!
+  
+  ## add dump -> dump latest props to console via puts
+  ## check - dump already taken by activerecord??
+
+private
+
+  # helper
+  #   change at/2012_13/bl           to at.2012/13.bl
+  #    or    quali_2012_13_europe_c  to quali.2012/13.europe.c
+  
+  def self.fixture_name_to_prop_key( name )
+    prop_key = name.gsub( '/', '.' )
+    prop_key = prop_key.gsub( /(\d{4})_(\d{2})/, '\1/\2' )  # 2012_13 => 2012/13
+    prop_key = prop_key.gsub( '_', '.' )
+    prop_key
+  end
+
+end # class Prop
+
+  end # module Model
+
+  ##### add convenience module alias in plural e.g. lets you use include ConfDb::Models
+  Models = Model
+  ##### add convenience class alias e.g lets you use Prop instead of Model::Prop 
+  Prop   = Model::Prop
+
+end # module ConfDb

props-activerecord/lib/props/activerecord/schema.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module ConfDb
+
+class CreateDb
+
+  def up
+ActiveRecord::Schema.define do
+
+create_table :props do |t|
+  t.string :key,   null: false
+  t.string :value, null: false
+
+  # note: do NOT/can NOT use type - already used by ActiveRecord (for single-table-inheritance/STI)
+  t.string :kind     # e.g. version|user|sys(tem)|db etc.
+
+  t.timestamps
+end
+
+end # Schema.define
+  end # method up
+
+end  # class CreateDb
+
+end  # module ConfDb

props-activerecord/lib/props/activerecord/version.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module ConfDb
+
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 2
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    # todo: add RUBY_PATCHLEVEL or RUBY_PATCH_LEVEL??
+    "confdb/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )}"
+  end
+
+end # module ConfDb

props-activerecord/test/helper.rb

@@ -0,0 +1,40 @@
+
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+# our own code
+require 'props'
+require 'props/activerecord'      # Note: explict require required for ConfDb (not automatic)
+
+
+Prop  = ConfDb::Model::Prop
+
+
+
+def setup_in_memory_db
+  # Database Setup & Config
+
+  db_config = {
+    adapter:  'sqlite3',
+    database: ':memory:'
+  }
+
+  pp db_config
+
+  ActiveRecord::Base.logger = Logger.new( STDOUT )
+  ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+  ## NB: every connect will create a new empty in memory db
+  ActiveRecord::Base.establish_connection( db_config )
+
+
+  ## build schema
+  ConfDb.create
+end
+
+
+setup_in_memory_db()

props-activerecord/test/test_models.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestModels < MiniTest::Test
+
+  def setup
+    ConfDb.delete!
+  end
+
+  def test_count
+    assert_equal 0, Prop.count
+  end
+
+
+  def test_create
+    prop = Prop.create!( key: 'key', value: 'value' )
+
+    assert_equal 1, Prop.count
+  end
+
+end # class TestModels

props/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+

props/HISTORY.md

@@ -0,0 +1,8 @@
+### 0.2 / 2012-06-10
+
+* Add optional erb processing with passed in binding (`load_file_with_erb`)
+* Add section lookup (`fetch_with_section`)
+
+### 0.1 / 2012-06-03
+
+* Everything is new. First release