glue 0.27.0 → 0.28.0

data/ProjectInfo

@@ -2,7 +2,7 @@
 
 TITLE    : &title Glue
 NAME     : &pkg glue
-VERSION  : '0.27.0'
+VERSION  : '0.28.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
@@ -15,7 +15,7 @@ DESCRIPTION: >
   Utility methods and classes for Nitro.
 
 DEPENDENCIES:
- - [ facets, '= 2005.10.30' ]
+ - [ facets, '= 1.0.2' ]
  - [ cmdparse, '= 2.0.0' ]
  
 DISTRIBUTE: [ gem, tgz, zip ]

data/README

@@ -1,4 +1,4 @@
-= Glue 0.27.0 README
+= Glue 0.28.0 README
 
 Useful utilites and methods.
 

data/Rakefile

@@ -30,7 +30,7 @@ task :default => :package
 # Run all tests.
 
 Rake::TestTask.new do |t|
-  cwd = File.expand_path(File.join(File.dirname(__FILE__) + '.'))
+  cwd = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   t.libs << 'test'
   %w[glue nitro og].each do |dir|
     t.libs << File.join(cwd, dir, 'lib')

data/doc/RELEASES

@@ -1,3 +1,17 @@
+== Version 0.28.0
+
+* New generalized caching system. The caching code is refactored
+in a new Glue system. At the moment, caches in memory, DRb, 
+filesystem and Og are provided. A memcache version will be available
+in the near future. The new caching system is used to implement
+Session stores, Og caching, Fragment caching, and Application scoped
+parameters. A useful DRb cache management script is provided to 
+manage multiple DRb caches.
+
+* Integration of Facets 1.0.1. The new library features a better
+API and better implementation of various features.
+
+
 == Version 0.27.0
 
 Various fixes and smaller improvements.

data/lib/glue.rb

@@ -11,9 +11,9 @@
 require 'English'
 require 'pp'
 
-require 'mega/null'
-require 'mega/dynamod'
-require 'nano/module/is'
+require 'facet/nullclass'
+require 'glue/paramix' # keep this before module/is
+require 'facet/module/is'
 
 require 'glue/property'
 require 'glue/attribute'
@@ -36,7 +36,7 @@ module Glue
 
   # The version.
 
-  Version = '0.27.0'
+  Version = '0.28.0'
   
   # Library path.
 

data/lib/glue/accumulate.rb

@@ -1,4 +1,4 @@
-require 'mega/functor'
+require 'facet/functor'
 
 module Enumerable
 

data/lib/glue/aspects.rb

@@ -1,4 +1,4 @@
-require 'mega/inheritor'
+require 'facet/inheritor'
 
 module Glue
 

data/lib/glue/autoreload.rb

@@ -1,4 +1,4 @@
-require 'nano/dir/self/recurse'
+require 'facet/dir/self/recurse'
 
 module Kernel
 
@@ -7,7 +7,11 @@ module Kernel
   
   def autoreload(check_interval=10, glob = '.')
     Thread.new(Time.now) do |start_time|
-    
+      check_dirty = lambda do |file,hash,file_mtime|
+        if File.exists?(file) and (mtime = File.stat(file).mtime) > (file_mtime[file] || start_time)
+          hash[file] = mtime 
+        end
+      end
       file_mtime = {}
 
       files = []
@@ -18,19 +22,22 @@ module Kernel
       end
       
       loop do
+        need_reload = Hash.new
         sleep check_interval 
         $LOADED_FEATURES.each do |feature|
-          $LOAD_PATH.each do |lp|
-            file = File.join(lp, feature)
-            if File.exists?(file) and (mtime = File.stat(file).mtime) > (file_mtime[file] || start_time)
-              $autoreload_dirty = true
-              file_mtime[file] = mtime
-              STDERR.puts "File '#{ file }' reloaded"
-              begin
-                load(file)
-              rescue Exception => e
-                STDERR.puts e.inspect
-              end
+          check_dirty.call(feature,need_reload,file_mtime)
+          $LOAD_PATH.each {|lp| check_dirty.call(File.join(lp, feature),need_reload,file_mtime)}
+        end
+                
+        unless need_reload.empty?
+          $autoreload_dirty = true
+          need_reload.each_pair do |file,mtime|
+            file_mtime[file] = mtime
+            STDERR.puts "File '#{ file }' reloaded"
+            begin
+              load(file)
+            rescue Exception => e
+              STDERR.puts e.inspect
             end
           end
         end
@@ -44,7 +51,8 @@ module Kernel
             STDERR.puts "File '#{ file }' changed"
           end
         end
-      end
+      
+      end # loop
     
     end
   end

data/lib/glue/cache.rb

@@ -0,0 +1,19 @@
+module Glue
+
+# A general cache key.
+
+class CacheKey
+end
+
+# A general cache mechanism.
+#
+# This cache system was originaly developed for Nitro. It is used
+# to cache fragments, og objects (entities), sessions, application
+# scoped variables and more.
+
+class Cache
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/drb.rb

@@ -0,0 +1,49 @@
+require 'drb'
+
+require 'glue/cache/memory'
+
+module Glue
+
+# A cached backed in a DRb server.
+# 
+# === Example
+#
+# This cache needs a corresponding DRb server. Here is how you
+# can setup the standard Nitro Drb server to keep a DrbCache:
+#
+# require 'glue/cache/memory'
+#
+# class MyDrbServer < Nitro::DrbServer
+#   def setup_drb_objects
+#     ..
+#     @my_cache = SyncHash.new 
+#     DRb.start_service("druby://#{my_drb_address}:#{my_drb_port}", @my_cache)
+#     ..
+#   end
+# end    
+#
+# MyDrbServer.start
+
+class DrbCache < MemoryCache
+
+  # Initialize the cache.
+  #
+  # === Options
+  #
+  # :address = The address of the DRb cache object.
+  # :port = The port of the DRb cache object.
+  
+  def initialize(options = {})
+    c = {
+      :address => '127.0.0.1',
+      :port => 9080,
+    }.update(options)
+
+    @hash = DRbObject.new(nil, "druby://#{options[:address]}:#{options[:port]}") 
+  end
+  
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/file.rb

@@ -0,0 +1,59 @@
+require 'fileutils'
+require 'tmpdir'
+
+module Glue
+ 
+  # TODO: safe locking of files, because Nitro can be multiprocess
+  
+  class FileCache
+
+    setting :basedir, :default => "#{Dir.tmpdir}/nitro_file_cache", :doc => 'The directory to store files'
+
+    def initialize(name, keepalive = nil)
+      @path = File.join(FileCache.basedir, name)
+      @keepalive = keepalive
+
+      FileUtils.mkdir_p(@path, :mode => 0700)
+    end
+
+    def []=(k,v)
+      fn = File.join(@path, k.to_s)
+      encode_file(fn, v)
+    end
+
+    def [](k)
+      fn = File.join(@path, k.to_s)
+      return nil unless File.exists?(fn)
+      decode_file(fn)
+    end
+
+    def gc!
+      return unless @keepalive
+
+      now = Time.now
+      all.each do |fn|
+        expire_time = File.stat(fn).atime + @keepalive 
+        File.delete(fn) if now > expire_time
+      end
+    end
+
+    def all
+      Dir.glob( File.join(@path, '*' ) )
+    end
+
+    private
+
+    def decode_file(fn)
+      Marshal.load( File.read(fn) )
+    end
+
+    def encode_file(fn, value)
+      File.open(fn, "w") do |f| 
+        f.chmod(0600)
+        f.write(Marshal.dump(value))
+      end
+    end
+
+  end
+end
+

data/lib/glue/cache/memcache.rb

@@ -0,0 +1,2 @@
+# gmosx: not implemented yet, anyone wants to take over this
+# bounty?

data/lib/glue/cache/memory.rb

@@ -0,0 +1,81 @@
+require 'facet/synchash'
+
+require 'glue/cache'
+
+module Glue
+
+# A cache backed in memory. 
+#--
+# This implementation is also the base for the Drb Cache.
+#++
+
+class MemoryCache < Cache
+  attr :hash
+
+  def initialize(options = {})
+    if options[:sync]
+      @hash = SyncHash
+    else
+      @hash = {}
+    end
+  end
+
+  # Get an object from the cache.
+  
+  def get(key, options = nil)
+    @hash[key]
+  end
+  alias_method :read, :get
+  alias_method :[], :get
+
+  # Put an object in the cache.
+  
+  def set(key, value = nil, options = nil)
+    @hash[key] = value
+  end
+  alias_method :put, :set
+  alias_method :write, :set
+  alias_method :[]=, :set
+  
+  # Delete an object from the cache.
+  
+  def delete(key, options = nil) 
+    @hash.delete(key)
+  end
+  alias_method :remove, :delete
+
+  def delete_if(&block)
+    @hash.delete_if(&block)
+  end
+
+  # Perform session garbage collection. Typically this method
+  # is called from a cron like mechanism.
+  
+  def gc!
+    delete_if { |key, s| s.expired? }
+  end
+
+  # Return the mapping.
+  
+  def mapping
+    @hash
+  end
+
+  # Return all keys in the cache.
+  
+  def keys
+    @hash.keys
+  end
+
+  # Return all objects in the cache.
+  
+  def all
+    @hash.values
+  end
+  alias_method :values, :all
+  
+end
+  
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/og.rb

@@ -0,0 +1,56 @@
+require 'og'
+require 'base64'
+
+module Glue
+
+  class OgCached
+    prop_accessor :unique_id, String, :unique => true
+    prop_accessor :expires, Time
+    prop_accessor :cache_name, String
+    prop_accessor :content
+  end
+
+  class OgCache
+
+    def initialize(cache_name, keepalive = nil)
+      @cache_name = cache_name
+      @keepalive = keepalive
+    end
+
+    def []=(k,v)
+      unless s = OgCached.find_by_unique_id_and_cache_name(k.to_s, @cache_name)
+        s = OgCached.new
+        s.cache_name = @cache_name
+        s.expires = Time.now + @keepalive if @keepalive
+        s.unique_id = k.to_s
+      end
+      #s.content = v.to_yaml
+      s.content = encode(v)
+      s.save
+    end
+
+    def [](k)
+      s = OgCached.find_by_unique_id_and_cache_name(k.to_s, @cache_name) and decode(s.content)
+    end
+
+    def gc!
+      OgCached.find(:condition => ["expires < ? AND cache_name = ?", Time.now, @cache_name]).each {|s| s.delete }
+    end
+
+    def all
+      OgCached.find_by_cache_name(@cache_name)
+    end
+
+    private
+
+    def encode(c)
+      Base64.encode64(Marshal.dump(c))
+    end
+
+    def decode(c)
+      Marshal::load(Base64.decode64(c)) 
+      #s.content = YAML::load(s.content)
+    end
+
+  end
+end

data/lib/glue/configuration.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 
-require 'nano/kernel/constant'
-require 'mega/synchash'
+require 'facet/kernel/constant'
+require 'facet/synchash'
 
 require 'glue/attribute'
 require 'glue/flexob'
@@ -47,6 +47,10 @@ class Configuration
     def to_s
       @value.to_s
     end
+
+    def <=>(other)
+      "#{owner}.#{name}" <=> "#{other.owner}.#{other.name}"
+    end
   end
   
   class << self
@@ -109,7 +113,7 @@ class Configuration
     alias_method :[], :settings
 
     def method_missing(sym)
-      if sym.to_s =~ /[A-Z]/ # nano's capitalized? is buggy at the moment.
+      if sym.to_s =~ /[A-Z]/ # FIXME: facets's capitalized? is buggy at the moment.
         Flexob.new(self[constant(sym)])
       end
     end

data/lib/glue/fixture.rb

@@ -1,6 +1,6 @@
-require 'nano/kernel/constant'
+require 'facet/kernel/constant'
 
-require 'mega/orm_support'
+require 'facet/ormsupport'
 
 require 'glue/configuration'
 require 'glue/template'

data/lib/glue/logger.rb

@@ -43,7 +43,7 @@ class Logger
     unless expr.respond_to? :to_str
       warn "trace: Can't evaluate the given value: #{caller.first}"
     else
-      require 'nano/binding/self/of_caller'
+      require 'facet/binding/self/of_caller'
 
       Binding.of_caller do |b|
         value = b.eval(expr.to_str)
@@ -155,7 +155,7 @@ class Logger
     unless expr.respond_to? :to_str
       warn "trace: Can't evaluate the given value: #{caller.first}"
     else
-      require 'nano/binding/self/of_caller'
+      require 'facet/binding/self/of_caller'
 
       Binding.of_caller do |b|
         value = eval(expr.to_str, b)

data/lib/glue/markup.rb

@@ -2,7 +2,7 @@ require 'singleton'
 require 'redcloth'
 require 'cgi'
 
-require 'mega/class_inherit'
+require 'facet/classinherit'
 
 require 'glue/sanitize'
 

data/lib/glue/paramix.rb

@@ -0,0 +1,233 @@
+# gmosx: replaces gems/facet_more-1.0.1/lib/facet/paramix.rb 
+# to make Nitro work, till we come up with a better solution.
+# 
+# This is a temporary solution until the Facets version is 
+# fixed.
+
+#--
+# Parametric Mixins
+#
+# Copyright (c) 2005 Thomas Sawyer and George Moschovitis
+#
+# Ruby License
+#
+# This module is free software. You may use, modify, and/or redistribute this
+# software under the same terms as Ruby.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+# ==========================================================================
+#  Revision History
+# --------------------------------------------------------------------------
+#  2005-12-02  trans     * Simplified into fine elegance.
+#  2005-09-19  trans     * Cleaned up and renamed.
+#  2005-04-28  trans     * Added to Calibre.
+# ==========================================================================
+#
+#++
+
+require 'facet/module/basename'
+
+#:title: Parametric Mixins
+#
+# Parametric Mixins provides parameters for mixin modules.
+# Module parameters can be set at the time of inclusion or extension,
+# then accessed via an instance method of the same name as the included
+# module.
+#
+# == Synopsis
+#
+#   module Mixin
+#     def hello
+#       puts "Hello from #{Mixin(:name)}"
+#     end
+#   end
+#
+#   class MyClass
+#     include Mixin, :name => 'Ruby'
+#   end
+#
+#   m = MyClass.new
+#   m.hello -> 'Hello from Ruby'
+#
+# You can view the full set of parameters via the #mixin_parameters
+# class method, which returns a hash keyed on the included modules.
+#
+#   MyClass.mixin_parameters         #=> {Mixin=>{:name=>'Ruby'}}
+#   MyClass.mixin_parameters[Mixin]  #=> {:name=>'Ruby'}
+#
+# To create _dynamic mixins_ you can use the #included callback
+# method along with mixin_parameters method like so:
+#
+#   module Mixin
+#     def included( base )
+#       parms = base.mixin_parameters[self]
+#       base.class_eval {
+#         def hello
+#           puts "Hello from #{parms(:name)}"
+#         end
+#       }
+#     end
+#   end
+#
+# More conveniently a new callback has been added, #included_with_parameters,
+# which passes in the parameters in addition to the base class/module.
+#
+#   module Mixin
+#     def included_with_parameters( base, parms )
+#       base.class_eval {
+#         def hello
+#           puts "Hello from #{parms(:name)}"
+#         end
+#       }
+#     end
+#   end
+#
+# We would prefer to have passed the parameters through the #included callback
+# method itself, but implementation of such a feature is much more complicated.
+# If a reasonable solution presents itself in the future however, we will fix.
+#
+# == Author(s)
+#
+# * George Moschovitis
+# * Thomas Sawyer
+#
+
+class Module
+
+  # Store for module parameters. This is local per module
+  # and indexed on module/class included-into.
+  def mixin_parameters ; @mixin_parameters ||= {} ; end
+
+  alias_method :include_without_parameters, :include
+
+  def include(*args)
+    params = args.last.is_a?(Hash) ? args.pop : {}    
+=begin
+    for mod in args
+      mixin_parameters[mod] = params
+      define_method( mod.basename ) do |key|
+        if params.key?(key)
+          params[key]
+        else
+          super if defined?( super )
+        end
+      end
+    end
+=end
+    r = include_without_parameters(*args)
+    for mod in args
+      mod.included_with_parameters( self, params ) if mod.respond_to?(:included_with_parameters)
+    end
+    r
+  end
+
+  alias_method :extend_without_parameters, :extend
+
+  def extend(*args)
+    params = args.last.is_a?(Hash) ? args.pop : nil
+=begin    
+    for mod in args
+      (class << self; self; end).class_eval do
+        mixin_parameters[mod] = params
+        define_method( mod.basename ) do |key|
+          if params.key?(key)
+            params[key]
+          else
+            super if defined?( super )
+          end
+        end
+      end
+    end
+=end
+    r = extend_without_parameters(*args)
+    extended_with_parameters( self, params ) if method_defined?(:extended_with_parameters)
+    r
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin test
+
+  require 'test/unit'
+  require 'facet/kernel/adhoc'
+
+  class TC01 < Test::Unit::TestCase
+
+    module M
+      def f
+        M(:p)
+      end
+      def self.included_with_parameters( base, parms )
+      end
+    end
+
+    class C
+      include M, :p => "check"
+    end
+
+    class D
+      include M, :p => "steak"
+    end
+
+    def test_01_001
+      c = C.new
+      assert_equal( "check", c.f )
+    end
+
+    def test_01_002
+      d = D.new
+      assert_equal( "steak", d.f )
+    end
+
+    def test_01_003
+      assert_equal( {M=>{:p => "check"}}, C.mixin_parameters )
+      assert_equal( {M=>{:p => "steak"}}, D.mixin_parameters )
+    end
+
+  end
+
+
+  class TC02 < Test::Unit::TestCase
+
+    module M
+      def f
+        M(:p)
+      end
+    end
+
+    class C
+      extend M, :p => "mosh"
+    end
+
+    class D
+      extend M, :p => "many"
+    end
+
+    def test_02_001
+      assert_equal( "mosh", C.f )
+    end
+
+    def test_02_002
+      assert_equal( "many", D.f )
+    end
+
+    def test_02_003
+      assert_equal( {M=>{:p => "mosh"}}, C.adhoc.mixin_parameters )
+      assert_equal( {M=>{:p => "many"}}, D.adhoc.mixin_parameters )
+    end
+
+  end
+
+=end

data/lib/glue/property.rb

@@ -1,12 +1,12 @@
-require 'mega/annotation'
-require 'mega/inheritor'
-require 'mega/dictionary'
+require 'facet/annotation'
+require 'facet/inheritor'
+require 'facet/dictionary'
 
 require 'glue/on_included'
-require 'og/entity'
 require 'glue/validation'
-require 'og/relation/all'
 require 'glue/aspects'
+require 'og/entity'
+require 'og/relation/all'
 
 # A convienience structure that holds property 
 # metadata.
@@ -71,13 +71,19 @@ class Property
         
         prop_value = values[prop_name]
         
-        # to_s must be called on the prop_value incase the request is IOString
+        # to_s must be called on the prop_value incase the 
+        # request is IOString.
+        
         prop_value = prop_value.to_s unless prop_value.is_a?(Hash) or prop_value.is_a?(Array)
         
-        # If property is a Blob dont overwrite current property's data if "".
+        # If property is a Blob dont overwrite current 
+        # property's data if "".
+        
         break if prop.klass == Og::Blob and prop_value.empty?
         
-        # if custom preprocessing is active then try and preprocess
+        # If custom preprocessing is active then try and 
+        # preprocess.
+        
         prop_value = preprocess_value(obj, prop, prop_value) if options[:preprocess]
 
         # assign using __force_ methods.
@@ -263,7 +269,7 @@ class Module
   end
   alias :property :prop_accessor
         
-  # NITRO specific!! leave blank in nano/mega.
+  # NITRO specific!! leave blank in facets.
   # TODO: factor in eval_helpers into the hook!
 
   def self.__add_prop_hook__(m)

data/lib/glue/template.rb

@@ -97,7 +97,7 @@ module TemplateMixin
     # (useful in xsl stylesheets)
     # Examples: %nbsp;, %rquo;
 
-    text.gsub!(/%(\S*?);/, '&\1;')
+    text.gsub!(/%(#\d+|\w+);/, '&\1;')
 
     # Compile time ruby code. This code is evaluated when
     # compiling the template and the result injected directly

data/lib/glue/uri.rb

@@ -1,7 +1,7 @@
 require 'uri'
 require 'cgi'
 
-require 'nano/string/blank'
+require 'facet/string/blank'
 
 module Glue
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: glue
 version: !ruby/object:Gem::Version 
-  version: 0.27.0
-date: 2006-01-16 00:00:00 +02:00
+  version: 0.28.0
+date: 2006-02-06 00:00:00 +02:00
 summary: Utility methods and classes for Nitro.
 require_paths: 
 - lib
@@ -15,7 +15,7 @@ description:
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: true
+has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -53,16 +53,19 @@ files:
 - lib/glue/sanitize.rb
 - lib/glue/property.rb
 - lib/glue/on_included.rb
+- lib/glue/cache
 - lib/glue/html.rb
 - lib/glue/mailer.rb
 - lib/glue/mail.rb
 - lib/glue/logger.rb
 - lib/glue/attribute.rb
+- lib/glue/paramix.rb
 - lib/glue/flexob.rb
 - lib/glue/fixture.rb
 - lib/glue/builder.rb
 - lib/glue/configuration.rb
 - lib/glue/expirable.rb
+- lib/glue/cache.rb
 - lib/glue/aspects.rb
 - lib/glue/markup.rb
 - lib/glue/accumulate.rb
@@ -70,6 +73,11 @@ files:
 - lib/glue/builder/xml.rb
 - lib/glue/mailer/outgoing.rb
 - lib/glue/mailer/incoming.rb
+- lib/glue/cache/file.rb
+- lib/glue/cache/og.rb
+- lib/glue/cache/memcache.rb
+- lib/glue/cache/memory.rb
+- lib/glue/cache/drb.rb
 - lib/html/tokenizer.rb
 - lib/html/version.rb
 - lib/html/document.rb
@@ -121,7 +129,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 2005.10.30
+        version: 1.0.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: cmdparse