glue 0.29.0 → 0.30.0

data/ProjectInfo

@@ -2,40 +2,38 @@
 
 TITLE    : &title Glue
 NAME     : &pkg glue
-VERSION  : '0.29.0'
+VERSION  : '0.30.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
 EMAIL    : &email gm@navel.gr
-HOMEPAGE : "http://www.nitrohq.com"
+HOMEPAGE : "http://www.nitroproject.org"
 
 SUMMARY: Utility methods and classes for Nitro.
 
 DESCRIPTION: >
   Utility methods and classes for Nitro.
 
-DEPENDENCIES:
- - [ facets, '= 1.0.3' ]
- - [ cmdparse, '= 2.0.0' ]
- 
-DISTRIBUTE: [ gem, tgz, zip ]
-
 RUBYFORGE:
   PROJECT: 'nitro'
   USERNAME: 'gmosx'
 
-RDOC:
-  - dir: rdoc
-    options: ['--all', '--inline-source']
-    include:
-      - 'lib/glue/**/*'
-      - '[A-Z]*'
+DEPENDENCIES:
+ - [ facets, '= 1.3.3' ]
+ 
+PACKAGE: !!package
+  distribute: [ gem, tgz, zip ]
+
+RDOC: !!rdoc
+  dir: rdoc
+  options: ['--all', '--inline-source']
+  include:
+    - 'lib/glue/**/*'
+    - '[A-Z]*'
 
-# Anything to require upfront?
-#TEST:
-#  fixture: ''
+TEST: !!test
 
-ANNOUNCE:
+ANNOUNCE: !!announce
   to: george.moschovitis@gmail.com
   from: gm@navel.gr
   domain: navel.gr
@@ -47,15 +45,5 @@ ANNOUNCE:
   file: ANN
   slogan: Glue
   links:
-    - http://www.nitrohq.com
-
-
-
-
-
-
-
-
-
-
+    - http://www.nitroproject.org
 

data/README

@@ -1,4 +1,4 @@
-= Glue 0.29.0 README
+= Glue 0.30.0 README
 
 Useful utilites and methods.
 
@@ -6,7 +6,7 @@ Useful utilites and methods.
 == Purpose
 
 Useful libraries are stored here. An attempt is made to 
-graduate smaller libraries to the more general Nano/Mega
+graduate smaller libraries to the more general Facets 
 ruby project.
 
 

data/doc/RELEASES

@@ -1,3 +1,11 @@
+== Version 0.30.0
+
+Cleaned up the codebase. Removed files duplicating functionality
+already present in Facets. Moreover, we moved several generally
+useful files into Facets. Expect the cleanup process to be 
+continued in next versions.
+
+
 == Version 0.29.0
 
 * MemCache store for the generalized caching system.

data/lib/glue.rb

@@ -1,9 +1,9 @@
 # = Glue
 #
-# Copyright (c) 2004-2005, Navel Ltd (http://www.navel.gr)
-# Copyright (c) 2004-2005, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 #
-# Glue (http://www.nitrohq.com) is copyrighted free software 
+# Glue (http://www.nitroproject.org) is copyrighted free software 
 # created and maintained by George Moschovitis (mailto:gm@navel.gr) 
 # and released under the standard BSD Licence. For details 
 # consult the file doc/LICENCE.
@@ -12,7 +12,7 @@ require 'English'
 require 'pp'
 
 require 'facet/nullclass'
-require 'glue/paramix' # keep this before module/is
+require 'facets/more/paramix' # keep this before module/is
 require 'facet/module/is'
 
 require 'glue/property'
@@ -36,7 +36,7 @@ module Glue
 
   # The version.
 
-  Version = '0.29.0'
+  Version = '0.30.0'
   
   # Library path.
 

data/lib/glue/autoreload.rb

@@ -33,7 +33,7 @@ module Kernel
           $autoreload_dirty = true
           need_reload.each_pair do |file,mtime|
             file_mtime[file] = mtime
-            Logger.debug "File '#{ file }' reloaded"
+            Logger.debug "File '#{ file }' reloaded" if $DBG
             begin
               load(file)
             rescue Exception => e
@@ -48,7 +48,7 @@ module Kernel
           if File.exists?(file) and (mtime = File.stat(file).mtime) > (file_mtime[file] || start_time)
             $autoreload_dirty = true
             file_mtime[file] = mtime
-            Logger.debug "File '#{ file }' changed"
+            Logger.debug "File '#{ file }' changed" if $DBG
           end
         end
       

data/lib/glue/builder.rb

@@ -32,17 +32,28 @@ class Builder
 
   # Provide the target where the builder output will be
   # accomulated. The builder utilizes duck typing to make it
-  # compatible with anly target responding to <<.
+  # compatible with any target responding to <<.
   
-  def initialize(buffer = '', *modules)
-    @buffer = buffer
-    
+  def initialize(buffer = '', options = {})
+    @buffer = buffer    
   end  
   
+  # Emit a text string.
+
+  def text!(str)
+    @buffer << str
+
+    return self
+  end
+  alias_method :print, :text!
+  alias_method :<<, :text!
+  
+  def to_s
+    @buffer.to_s
+  end
+  
 end
 
 end
 
 # * George Moschovitis <gm@navel.gr>
-
-__END__

data/lib/glue/builder/xml.rb

@@ -1,9 +1,5 @@
 require 'glue/builder'
 
-require 'nitro/helper/xhtml'
-require 'nitro/helper/form'
-require 'nitro/helper/table'
-
 module Glue
 
 # A Builder for programmatically building XML blocks. 
@@ -12,6 +8,10 @@ module Glue
 #++
 
 class XmlBuilder < Builder
+  require 'nitro/helper/xhtml'
+  require 'nitro/helper/form'
+  require 'nitro/helper/table'
+
   include_builder Nitro::XhtmlHelper
   include_builder Nitro::TableHelper
   include_builder Nitro::FormHelper
@@ -73,15 +73,6 @@ class XmlBuilder < Builder
     return self
   end
 
-  # Emit a text string.
-
-  def text!(str)
-    @buffer << str
-
-    return self
-  end
-  alias_method :print, :text!
-
   # Emit a comment.
 
   def comment!(str)

data/lib/glue/cache/drb.rb

@@ -33,7 +33,6 @@ class DrbCache < MemoryCache
   # :address = The address of the DRb cache object.
   # :port = The port of the DRb cache object.
   
-
   # The address of the Session cache / store (if distibuted).
  
   setting :address, :default => '127.0.0.1', :doc => 'The address of the Session cache'
@@ -43,8 +42,8 @@ class DrbCache < MemoryCache
   setting :port, :default => 9069, :doc => 'The port of the Session cache'
   
   
-  def initialize
-    @hash = DRbObject.new(nil, "druby://#{DrbCache.address}:#{DrbCache.port}") 
+  def initialize(address = DrbCache.address, port = DrbCache.port)
+    @hash = DRbObject.new(nil, "druby://#{address}:#{port}") 
   end
   
 end

data/lib/glue/cache/file.rb

@@ -51,16 +51,16 @@ module Glue
 
     def decode_file(fn)
       val = nil
-      File.open(fn,"r") do |f|
+      File.open(fn,"rb") do |f|
         f.flock(File::LOCK_EX)
-        val = Marshal.load( File.read(fn) )
+        val = Marshal.load( f.read )
         f.flock(File::LOCK_UN)
       end
       return val
     end
 
     def encode_file(fn, value)
-      File.open(fn, "w") do |f| 
+      File.open(fn, "wb") do |f| 
         f.flock(File::LOCK_EX)
         f.chmod(0600)
         f.write(Marshal.dump(value))

data/lib/glue/configuration.rb

@@ -2,6 +2,8 @@ require 'yaml'
 
 require 'facet/kernel/constant'
 require 'facet/synchash'
+require 'facet/dictionary'
+require 'facet/string/capitalized'
 
 require 'glue/attribute'
 require 'glue/flexob'
@@ -9,7 +11,13 @@ require 'glue/flexob'
 module Glue
 
 # A Configuration holds a group of Settings organized by
-# Owners.
+# Owners. An owner is a class that represents the system to be
+# configured. An alias for this class is Settings.
+#
+# You can pass strings, constants or symbols as keys for the
+# classes to be configured. Passing symbols you can configure
+# classes even before they are defined.
+#
 #--
 # TODO: implement with annotations.
 #++
@@ -25,49 +33,86 @@ class Configuration
   @@owners = SyncHash.new  
 
   # A datastructure to store Settings metadata.
-  
+  # 
+  # Please note the difference between :default and :value,
+  # :default does NOT override :value.
+    
   class Setting
     attr_accessor :owner, :name, :type, :value, :options
     
     def initialize(owner, name, options)
-      raise ArgumentError.new('A default value is required') unless options.key?(:default)
+      if options.key? :value
+        @value = options[:value]
+      elsif options.key? :default 
+        @value = options[:default]
+      else
+        raise ArgumentError.new('A value is required')
+      end
+      
       @owner, @name = owner, name
-      @options = options
-      @value = options[:default]
+      @options = options      
       @type = options[:type] = options[:type] || @value.class
     end
 
-    def value=(value)
-      @value = value
-      constant(@owner).module_eval %{
-        @@#{@name} = #{value.inspect}
-      }
-    end
+    # Update the setting from an options hash. The update does
+    # NOT take default values into account!
+    
+    def update(hash)
+      if hash.key? :value
+        @value = hash[:value]
+        @type = @value.class
+      end
+      
+      if hash.key? :type
+        @type = hash[:type]
+      end
 
+      @options.update(hash)
+    end
+    
+    # Text representation of this setting.
+    
     def to_s
       @value.to_s
     end
 
   end
+
+  # A collection of Settings. This helper enables intuitive
+  # settings initialization like this:
+  #
+  # Configuration.Compiler.template_root = 'public'
+  # instead of
+  # Configuration.setting :compiler, :template_root, :value => 'public'
   
+  class SettingCollection < Hash
+    attr_accessor :owner
+    
+    # Handles setting readers and writers.
+    
+    def method_missing(sym, *args)
+      if sym.to_s =~ /=$/
+        # Remove trailing 
+        sym = sym.to_s.gsub(/=/, '').to_sym
+        Configuration.setting @owner, sym, :value => args.first
+      else
+        self[sym]
+      end
+    end
+  end
+    
   class << self
   
-    # Inject the configuration parameters to configuration
-    # classes.
+    # Inject the configuration parameters provided as a hash
+    # (dictionary, ordered) to classes to be configured.
+    # 
+    # === Warning: Pass an ordered hash (dictionary)
     
     def setup(options)
       options.each do |owner, ss|
         next unless ss
-        begin
-          owner = constant(owner)
-        rescue NameError
-          next
-        end
         ss.each do |name, s|
-          @@owners[owner][name.to_sym].value = s
-          owner.module_eval %{
-            @@#{name} = #{s.inspect}
-          }
+          add_setting(owner, name.to_sym, :value => s)
         end 
       end
     end
@@ -76,14 +121,15 @@ class Configuration
     
     def parse(options)
       temp = YAML::load(options)
-      options = {}
+      options = Dictionary.new
       temp.each do |k, v| 
         begin
-          options[constant(k.gsub(/\./, '::').to_sym)] = v 
+          options[k.gsub(/\./, '::').to_sym] = v 
         rescue Object
           options[k] = v 
         end
       end
+
       setup(options)
     end
     
@@ -92,15 +138,38 @@ class Configuration
     def load(filename)
       parse(File.read(filename))
     end
-    
+
+    # Manually add a configuration setting. The class key can
+    # be the actual class name constant or a symbol. If the
+    # setting is already defined it updates it. 
+    # 
+    # === Examples
+    #
+    # Configuration.add_setting Compiler, :verification, :value => 12, :doc => '...'
+    # Configuration.setting :IdPart, :verify_registration_email, :value => false
+    # s = Configuration.Compiler.verification.value 
+        
     def add_setting(owner, name, options)
-      s = @@owners[owner] || {}
-      s[name] = Setting.new(owner, name, options)
-      @@owners[owner] = s
+      owner = owner.to_s.to_sym 
+      @@owners[owner] ||= {}
+      if s = @@owners[owner][name]
+        # The setting already exists, update it.
+        s.update(options)
+      else
+        # The setting does not exist, create it.
+        @@owners[owner][name] = Setting.new(owner, name, options)
+      end
     end
-    
+    alias_method :setting, :add_setting
+
+    # Return the settings for the given owner. The owner is 
+    # typically the Class that represents the system to be 
+    # configured. If no class is provided, it returns all the
+    # registered settings.
+        
     def settings(owner = nil)
       if owner
+        owner = owner.to_s.to_sym 
         @@owners[owner]
       else
         @@owners.values.inject([]) { |memo, obj| memo.concat(obj.values) }
@@ -109,9 +178,20 @@ class Configuration
     alias_method :all, :settings
     alias_method :[], :settings
 
+
+    #--
+    # FIXME: this does not work as expected.
+    #++
+    
     def method_missing(sym)
-      if sym.to_s =~ /[A-Z]/ # FIXME: facets's capitalized? is buggy at the moment.
-        Flexob.new(self[constant(sym)])
+      if sym.to_s.capitalized?
+#        Flexob.new(self[sym])
+         bdl = SettingCollection.new
+         bdl.owner = sym
+         if hash = self[sym]
+           bdl.update(hash)
+         end
+         return bdl
       end
     end
   end
@@ -126,24 +206,28 @@ end
 
 class Module
 
-  # Defines a configuration setting.
-  #--
-  # TODO: implement with annotations.
-  #++
+  # Defines a configuration setting for the enclosing class.
+  #
+  # === Example
+  #
+  # class Compiler
+  #   setting :template_root, :default => 'src/template', :doc => 'The template root dir'
+  # end
   
   def setting(sym, options = {})
     Glue::Configuration.add_setting(self, sym, options)
+    
     module_eval %{
-      mattr_accessor sym, options[:default]
+      def self.#{sym}
+        Glue::Configuration[#{self}][:#{sym}].value
+      end
       
-      def self.#{sym.id2name}=(obj)
-        @@#{sym.id2name} = obj
-        Glue::Configuration[#{self}][:#{sym}].value = obj
+      def self.#{sym}=(obj)
+        Glue::Configuration.setting #{self}, :#{sym}, :value => obj
       end
     }
   end
   
 end
 
-
 # * George Moschovitis <gm@navel.gr>