coral_core 0.2.3 → 0.2.4

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/coral_core.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "coral_core"
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adrian Webb"]
-  s.date = "2013-05-09"
+  s.date = "2013-05-10"
   s.description = "= coral_core\n\nThis library provides core data elements and utilities used in other Coral gems.\n\nThe Coral core library contains functionality that is utilized by other\nCoral gems by providing basic utilities like Git, Shell, Disk, and Data\nmanipulation libraries, a UI system, and a core data model that supports\nEvents, Commands, Repositories, and Memory (version controlled JSON \nobjects).  This library is only used as a starting point for other systems.\n\nNote:  This library is still very early in development!\n\n== Contributing to coral_core\n \n* Check out the latest {major}.{minor} branch to make sure the feature hasn't \n  been implemented or the bug hasn't been fixed yet.\n* Check out the issue tracker to make sure someone already hasn't requested \n  it and/or contributed it.\n* Fork the project.\n* Start a feature/bugfix branch.\n* Commit and push until you are happy with your contribution.\n* Make sure to add tests for it. This is important so I don't break it in a \n  future version unintentionally.\n* Please try not to mess with the Rakefile, version, or history. If you want \n  to have your own version, or is otherwise necessary, that is fine, but \n  please isolate to its own commit so I can cherry-pick around it.\n\n== Copyright\n\nLicensed under GPLv3.  See LICENSE.txt for further details.\n\nCopyright (c) 2013  Adrian Webb <adrian.webb@coraltech.net>\nCoral Technology Group LLC"
   s.email = "adrian.webb@coraltech.net"
   s.extra_rdoc_files = [

data/lib/coral_core/command.rb

@@ -12,22 +12,24 @@ class Command < Core
   # Constructor / Destructor
 
   def initialize(options = {})
-  
+      
     if options.is_a?(String) || options.is_a?(Symbol)
       options = string(options)
       options = { :name => options, :command => options }
     end
+    
+    config = Config.ensure(options)
   
-    super(options)
+    super(config)
     
     @properties           = {}
     
-    self.subcommand       = options[:subcommand] if options.has_key?(:subcommand)
+    self.subcommand       = config.get(:subcommand, nil)
     
-    @name                 = ( options.has_key?(:name) ? string(options[:name]) : '' )
+    @name                 = config.get(:name, '')
     
-    @properties           = options
-    @properties[:command] = executable(options)   
+    @properties           = config.options
+    @properties[:command] = executable(config)   
   end
      
   #-----------------------------------------------------------------------------
@@ -94,8 +96,10 @@ class Command < Core
   #---
   
   def subcommand=subcommand
-    @properties[:subcommand] = hash(subcommand)
-    @subcommand = self.class.new(@properties[:subcommand])
+    unless Util::Data.empty?(subcommand)
+      @properties[:subcommand] = hash(subcommand)
+      @subcommand = self.class.new(@properties[:subcommand])
+    end
   end
 
   #-----------------------------------------------------------------------------
@@ -205,8 +209,10 @@ class Command < Core
   #-----------------------------------------------------------------------------
     
   def exec!(options = {}, overrides = nil)
-    options[:ui] = @ui
-    success = Coral::Util::Shell.exec!(build(export, overrides), options) do |line|
+    config = Config.ensure(options)
+    
+    config[:ui] = @ui
+    success = Coral::Util::Shell.exec!(build(export, overrides), config) do |line|
       block_given? ? yield(line) : true
     end    
     return success
@@ -222,14 +228,16 @@ class Command < Core
   # Utilities
   
   def executable(options)
-    if options.has_key?(:coral)
-      return 'vagrant coral ' + options[:coral]
+    config = Config.ensure(options)
+    
+    if config.get(:coral, false)
+      return 'vagrant coral ' + config[:coral]
         
-    elsif options.has_key?(:vagrant)
-      return 'vagrant ' + options[:vagrant]
+    elsif config.get(:vagrant, false)
+      return 'vagrant ' + config[:vagrant]
         
-    elsif options.has_key?(:command)
-      return options[:command]
+    elsif config.get(:command, false)
+      return config[:command]
     end
   end
 end

data/lib/coral_core/config.rb

@@ -1,6 +1,6 @@
 
 module Coral
-class Config < Core
+class Config
   
   #-----------------------------------------------------------------------------
   # Global configuration
@@ -33,7 +33,7 @@ class Config < Core
     if File.exist?(config_file)
       config = Hiera::Config.load(config_file)
     else
-      ui.warning "Config file #{config_file} not found, using Hiera defaults"
+      Coral.ui.warning "Config file #{config_file} not found, using Hiera defaults"
     end
 
     config[:logger] = 'puppet'
@@ -139,6 +139,44 @@ class Config < Core
     return value  
   end
   
+  #---
+
+  def self.normalize(data, override = nil, options = {})
+    config  = Config.ensure(options)
+    results = {}
+    
+    unless undef?(override)
+      case data
+      when String, Symbol
+        data = [ data, override ] if data != override
+      when Array
+        data << override unless data.include?(override)
+      when Hash
+        data = [ data, override ]
+      end
+    end
+    
+    case data
+    when String, Symbol
+      results = Config.lookup(data.to_s, {}, config)
+      
+    when Array
+      data.each do |item|
+        if item.is_a?(String) || item.is_a?(Symbol)
+          item = Config.lookup(item.to_s, {}, config)
+        end
+        unless undef?(item)
+          results = Util::Data.merge([ results, item ], config)
+        end
+      end
+  
+    when Hash
+      results = data
+    end
+    
+    return results
+  end
+    
   #-----------------------------------------------------------------------------
   # Instance generator
   

data/lib/coral_core/core.rb

@@ -11,7 +11,9 @@ class Core
   # Constructor / Destructor
   
   def initialize(options = {})
-    @@ui = Interface.new(options)
+    config = Config.ensure(options)
+    
+    @@ui = Interface.new(config)
   end
   
   #-----------------------------------------------------------------------------

data/lib/coral_core/event.rb

@@ -5,9 +5,9 @@ class Event < Core
   #-----------------------------------------------------------------------------
   # Constructor / Destructor
   
-  def self.instance!(options = {}, build_hash = false, keep_array = false)
+  def self.instance!(data = {}, build_hash = false, keep_array = false)
     group  = ( build_hash ? {} : [] )    
-    events = build_info(options)
+    events = build_info(data)
     
     index = 1
     events.each do |info|
@@ -41,11 +41,13 @@ class Event < Core
   #---
   
   def initialize(options = {})
-    super(options)
+    config = Config.ensure(options)
     
-    @name       = ( options.has_key?(:name) ? options[:name] : '' )
-    @delegate   = ( options.has_key?(:delegate) ? options[:delegate] : nil )  
-    @properties = options
+    super(config)
+    
+    @name       = config.get(:name, '')
+    @delegate   = config.get(:delegate, nil)  
+    @properties = config.options
   end
     
   #-----------------------------------------------------------------------------

data/lib/coral_core/interface.rb

@@ -33,27 +33,28 @@ class Interface
     if options.is_a?(String)
       options = { :resource => options, :logger => options }
     end
+    config = Config.ensure(options)
     
-    if options.has_key?(:logger)
-      if options[:logger].is_a?(String)
-        @logger = Log4r::Logger.new(options[:logger])
+    if config.get(:logger, false)
+      if config[:logger].is_a?(String)
+        @logger = Log4r::Logger.new(config[:logger])
       else
-        @logger = options[:logger] 
+        @logger = config[:logger] 
       end
     else
       @logger = Log4r::Logger.new(class_name)
     end
     
-    @resource  = ( options.has_key?(:resource) ? options[:resource] : '' )
-    @color     = ( options.has_key?(:color) ? options[:color] : true )
+    @resource  = config.get(:resource, '')
+    @color     = config.get(:color, true)
     
-    @printer   = ( options.has_key?(:printer) ? options[:printer] : :puts )
+    @printer   = config.get(:printer, :puts)
     
-    @input     = ( options.has_key?(:input) ? options[:input] : $stdin )
-    @output    = ( options.has_key?(:output) ? options[:output] : $stdout )
-    @error     = ( options.has_key?(:error) ? options[:error] : $stderr )
+    @input     = config.get(:input, $stdin)
+    @output    = config.get(:output, $stdout)
+    @error     = config.get(:error, $stderr)
     
-    @delegate  = ( options.has_key?(:ui_delegate) ? options[:ui_delegate] : nil )    
+    @delegate  = config.get(:ui_delegate, nil)    
   end
 
   #-----------------------------------------------------------------------------

data/lib/coral_core/memory.rb

@@ -8,19 +8,21 @@ class Memory < Repository
   # Constructor / Destructor
   
   def initialize(options = {})
-    super(options)
+    config = Config.ensure(options)
+    
+    super(config)
     
     @absolute_config_file = ''
     
-    @properties     = ( options.has_key?(:properties) ? hash(options[:properties]) : {} )
-    @config_file    = ( options.has_key?(:config_file) ? string(options[:config_file]) : '' )
-    @autoload       = ( options.has_key?(:autoload) ? options[:autoload] : true )
-    @autosave       = ( options.has_key?(:autosave) ? options[:autosave] : true )
-    @autocommit     = ( options.has_key?(:autocommit) ? options[:autocommit] : true )
-    @commit_message = ( options.has_key?(:commit_message) ? string(options[:commit_message]) : 'Saving state' )
-      
-    set_absolute_config_file
-    load if @autoload
+    @properties     = config.get(:properties, {})
+    
+    @autoload       = config.get(:autoload, true)
+    @autosave       = config.get(:autosave, true)
+    @autocommit     = config.get(:autocommit, true)
+    @commit_message = config.get(:commit_message, 'Saving state')
+    
+    self.config_file = config.get(:config_file, '')
+    dbg(self, 'memory')
   end
   
   #---
@@ -52,7 +54,9 @@ class Memory < Repository
   #---
   
   def config_file=config_file
-    @config_file = string(config_file)
+    unless Util::Data.empty?(config_file)
+      @config_file = ( config_file.is_a?(Array) ? config_file.join(File::SEPARATOR) : string(config_file) )
+    end
     
     set_absolute_config_file
     load if @autoload

data/lib/coral_core/repository.rb

@@ -6,12 +6,14 @@ class Repository < Core
   # Constructor / Destructor
   
   def initialize(options = {})
-    super(options)
+    config = Config.ensure(options)
     
-    @name       = ( options.has_key?(:name) ? string(options[:name]) : '' )
-    @directory  = ( options.has_key?(:directory) ? string(options[:directory]) : '' )
-    @submodule  = ( options.has_key?(:submodule) ? string(options[:submodule]) : '' )
-    @remote_dir = ( options.has_key?(:remote_dir) ? string(options[:remote_dir]) : '' )
+    super(config)
+    
+    @name       = config.get(:name, '')
+    @directory  = config.get(:directory, '')
+    @submodule  = config.get(:submodule, '')
+    @remote_dir = config.get(:remote_dir, '')
     
     ensure_git(true) 
   end
@@ -53,26 +55,28 @@ class Repository < Core
   #-----------------------------------------------------------------------------
     
   def set_remote(name, hosts, options = {})
+    config = Config.ensure(options)
+    
     if can_persist?
       hosts = array(hosts)
       
       delete_remote(name)
       return self if hosts.empty?
       
-      if @remote_dir && ! options.has_key?(:repo)
-        options[:repo] = @remote_dir
+      if @remote_dir && ! config.get(:repo, false)
+        config[:repo] = @remote_dir
       end
       
-      git.add_remote(name, Git.url(hosts.shift, options[:repo], options))
+      git.add_remote(name, Git.url(hosts.shift, config[:repo], options))
       
       if ! hosts.empty?
         remote = git.remote(name)
         
-        options[:add] = true
+        config[:add] = true
       
         hosts.each do |host|
-          git_url = Git.url(host, options[:repo], options)
-          remote.set_url(git_url, options)
+          git_url = Git.url(host, config[:repo], config.options)
+          remote.set_url(git_url, config.options)
         end
       end
     end
@@ -83,7 +87,7 @@ class Repository < Core
   
   def delete_remote(name)
     if can_persist?
-      remote = @git.remote(name)
+      remote = git.remote(name)
       if remote && remote.url && ! remote.url.empty?
         remote.remove
       end
@@ -95,24 +99,26 @@ class Repository < Core
   # Git operations
   
   def commit(files = '.', options = {})
+    config = Config.ensure(options)
+    
     if can_persist?
       time    = Time.new.strftime("%Y-%m-%d %H:%M:%S")
       user    = ENV['USER']
-      message = ( options[:message] ? options[:message] : 'Saving state' )
+      message = config.get(:message, 'Saving state')
       
-      options[:author]      = ( ! options[:author].empty? ? options[:author] : '' )
-      options[:allow_empty] = ( options[:allow_empty] ? options[:allow_empty] : false )
+      config[:author]      = config.get(:author, '')
+      config[:allow_empty] = config.get(:allow_empty, false)
       
       unless user && ! user.empty?
         user = 'UNKNOWN'
       end
     
       array(files).each do |file|
-        @git.add(file)                      # Get all added and updated files
-        @git.add(file, { :update => true }) # Get all deleted files
+        git.add(file)                      # Get all added and updated files
+        git.add(file, { :update => true }) # Get all deleted files
       end
         
-      @git.commit("#{time} by <#{user}> - #{message}", options)                
+      git.commit("#{time} by <#{user}> - #{message}", config.options)                
     end
     return self      
   end
@@ -120,19 +126,21 @@ class Repository < Core
   #-----------------------------------------------------------------------------
   
   def push!(remote = 'origin', options = {})
+    config = Config.ensure(options)
+    
     if can_persist?
-      branch  = ( options[:branch] && ! options[:branch].empty? ? options[:branch] : 'master' )
-      tags    = ( options[:tags] ? options[:tags] : false )
+      branch = config.get(:branch, 'master')
+      tags   = config.get(:tags, false)
     
       return Coral::Command.new({
         :command => :git,
-        :data => { 'git-dir=' => @git.repo.to_s },
+        :data => { 'git-dir=' => git.repo.to_s },
         :subcommand => {
           :command => :push,
           :flags => ( tags ? :tags : '' ),
           :args => [ remote, branch ]
         }
-      }).exec!(options) do |line|
+      }).exec!(config) do |line|
         block_given? ? yield(line) : true
       end
     end

data/lib/coral_core/template.rb

@@ -44,7 +44,7 @@ module Template
     #dbg(data, 'template data -> init')
     
     if normalize
-      data = Util::Data.normalize(data, config)
+      data = Config.normalize(data, config)
       #dbg(data, 'template data -> post normalization')
     end
     

data/lib/coral_core/util/data.rb

@@ -1,7 +1,7 @@
 
 module Coral
 module Util
-class Data < Core
+class Data
   
   #-----------------------------------------------------------------------------
   # Type checking
@@ -136,53 +136,14 @@ class Data < Core
     #dbg(value, 'value')            
     return value
   end
-  
-  #---
 
-  def self.normalize(data, override = nil, options = {})
-    config  = Config.ensure(options)
-    results = {}
-    
-    unless undef?(override)
-      case data
-      when String, Symbol
-        data = [ data, override ] if data != override
-      when Array
-        data << override unless data.include?(override)
-      when Hash
-        data = [ data, override ]
-      end
-    end
-    
-    case data
-    when String, Symbol
-      results = Config.lookup(data.to_s, {}, config)
-      
-    when Array
-      data.each do |item|
-        if item.is_a?(String) || item.is_a?(Symbol)
-          item = Config.lookup(item.to_s, {}, config)
-        end
-        unless undef?(item)
-          results = merge([ results, item ], config)
-        end
-      end
-  
-    when Hash
-      results = data
-    end
-    
-    return results
-  end
-  
   #---
   
   def self.interpolate(value, scope, options = {})    
-    config  = Config.ensure(options)
-  
-    pattern = config.get(:pattern, '\$(\{)?([a-zA-Z0-9\_\-]+)(\})?')
-    group   = config.get(:var_group, 2)
-    flags   = config.get(:flags, '')
+    
+    pattern = ( options.has_key?(:pattern) ? options[:pattern] : '\$(\{)?([a-zA-Z0-9\_\-]+)(\})?' )
+    group   = ( options.has_key?(:var_group) ? options[:var_group] : 2 )
+    flags   = ( options.has_key?(:flags) ? options[:flags] : '' )
     
     if scope.is_a?(Hash)
       regexp = Regexp.new(pattern, flags.split(''))
@@ -195,7 +156,7 @@ class Data < Core
         #dbg(matches, 'matches')
         
         unless matches.nil?
-          replacement = scope.search(matches[group], config)
+          replacement = scope.search(matches[group], options)
           result      = item.gsub(matches[0], replacement) unless replacement.nil?
         end
         return result
@@ -213,7 +174,7 @@ class Data < Core
         #dbg(value, 'interpolate (hash) -> init')
         value.each do |key, data|
           #dbg(data, "interpolate (#{key}) -> data")
-          value[key] = interpolate(data, scope, config)
+          value[key] = interpolate(data, scope, options)
         end
       end
     end
@@ -223,32 +184,3 @@ class Data < Core
 end
 end
 end
-
-#-------------------------------------------------------------------------------
-# Data type alterations
-
-class Hash
-  def search(search_key, options = {})
-    config = Coral::Config.ensure(options)
-    value  = nil
-    
-    recurse       = config.get(:recurse, false)
-    recurse_level = config.get(:recurse_level, -1)
-        
-    self.each do |key, data|
-      if key == search_key
-        value = data
-        
-      elsif data.is_a?(Hash) && 
-        recurse && (recurse_level == -1 || recurse_level > 0)
-        
-        recurse_level -= 1 unless recurse_level == -1
-        value = value.search(search_key, 
-          Coral::Config.new(config).set(:recurse_level, recurse_level)
-        )
-      end
-      break unless value.nil?
-    end
-    return value
-  end
-end

data/lib/coral_core/util/shell.rb

@@ -7,18 +7,20 @@ class Shell < Core
   # Utilities
   
   def self.exec!(command, options = {})
-    min          = ( options[:min] ? options[:min].to_i : 1 )
-    tries        = ( options[:tries] ? options[:tries].to_i : min )
-    tries        = ( min > tries ? min : tries )
+    config = Config.ensure(options)
     
-    info_prefix  = ( options[:info_prefix] ? options[:info_prefix] : '' )
-    info_suffix  = ( options[:info_suffix] ? options[:info_suffix] : '' )
-    error_prefix = ( options[:error_prefix] ? options[:error_prefix] : '' )
-    error_suffix = ( options[:error_suffix] ? options[:error_suffix] : '' )
+    min   = config.get(:min, 1).to_i
+    tries = config.get(:tries, min).to_i
+    tries = ( min > tries ? min : tries )
     
-    ui           = ( options[:ui] ? options[:ui] : @@ui )
+    info_prefix  = config.get(:info_prefix, '')
+    info_suffix  = config.get(:info_suffix, '')
+    error_prefix = config.get(:error_prefix, '')
+    error_suffix = config.get(:error_suffix, '')
     
-    conditions   = Coral::Event.instance(options[:exit], true)
+    ui           = config.get(:ui, @@ui)
+    
+    conditions   = Coral::Event.instance(config.get(:exit, {}), true)
     
     $stdout.sync = true
     $stderr.sync = true  

data/lib/coral_core.rb

@@ -11,13 +11,8 @@ require 'hiera_backend.rb'
 
 #---
 
-# Include core
-[ :interface, :core ].each do |name| 
-  require File.join('coral_core', name.to_s + ".rb") 
-end
-
-# Include utilities
-[ :git, :data, :disk, :shell ].each do |name| 
+# Include pre core utilities (no internal dependencies)
+[ :git, :data ].each do |name| 
   require File.join('coral_core', 'util', name.to_s + ".rb") 
 end
 
@@ -26,6 +21,19 @@ Dir.glob(File.join(home, 'coral_core', 'util', 'git', '*.rb')).each do |file|
   require file
 end
 
+# Include core
+[ :config, :interface, :core, :resource, :template ].each do |name| 
+  require File.join('coral_core', name.to_s + ".rb") 
+end
+
+# Include post core utilities 
+# ( normally inherit from core and have no reverse dependencies with 
+#   core classes )
+#
+[ :disk, :shell ].each do |name| 
+  require File.join('coral_core', 'util', name.to_s + ".rb") 
+end
+
 # Include data model
 [ :event, :command, :repository, :memory ].each do |name| 
   require File.join('coral_core', name.to_s + ".rb") 
@@ -117,3 +125,32 @@ module Kernel
     puts '<<'
   end
 end
+
+#-------------------------------------------------------------------------------
+# Data type alterations
+
+class Hash
+  def search(search_key, options = {})
+    config = Coral::Config.ensure(options)
+    value  = nil
+    
+    recurse       = config.get(:recurse, false)
+    recurse_level = config.get(:recurse_level, -1)
+        
+    self.each do |key, data|
+      if key == search_key
+        value = data
+        
+      elsif data.is_a?(Hash) && 
+        recurse && (recurse_level == -1 || recurse_level > 0)
+        
+        recurse_level -= 1 unless recurse_level == -1
+        value = value.search(search_key, 
+          Coral::Config.new(config).set(:recurse_level, recurse_level)
+        )
+      end
+      break unless value.nil?
+    end
+    return value
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: coral_core
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Adrian Webb
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-09 00:00:00 Z
+date: 2013-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: git