glue 0.31.0 → 0.40.0

data/doc/AUTHORS

@@ -1,6 +1,6 @@
 MAIN DEVELOPER:
 
-* George Moschovitis  <gm@navel.gr>
+* George Moschovitis  <george.moschovitis@gmail.com>
   Project leader, architecture and design, code, 
   documentation, maintainer.
   

data/doc/LICENSE

@@ -1,7 +1,6 @@
 The BSD License
 
-Copyright (c) 2004-2005, George 'gmosx' Moschovitis. (http://www.gmosx.com)
-Copyright (c) 2004-2005, Navel Ltd. (http://www.navel.gr)
+Copyright (c) 2004-2006, George K. Moschovitis. (http://www.gmosx.com)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 
@@ -15,7 +14,7 @@ notice, this list of conditions and the following disclaimer.
 notice, this list of conditions and the following disclaimer in the 
 documentation and/or other materials provided with the distribution.
   
-* Neither the name of Navel nor the names of its contributors may be 
+* Neither the name of Glue nor the names of its contributors may be 
 used to endorse or promote products derived from this software 
 without specific prior written permission.
 

data/doc/RELEASES

@@ -1,7 +1,3 @@
-== Version 0.31.0
-
-Bugfixes. Refactored taggable.rb and removed attribute in favor of Facets's cattr which was then replaced with settings.
-
 == Version 0.30.0
 
 Cleaned up the codebase. Removed files duplicating functionality

data/lib/glue.rb

@@ -1,10 +1,9 @@
 # = Glue
 #
 # Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
-# Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 #
 # Glue (http://www.nitroproject.org) is copyrighted free software 
-# created and maintained by George Moschovitis (mailto:gm@navel.gr) 
+# created and maintained by George Moschovitis (mailto:george.moschovitis@gmail.com) 
 # and released under the standard BSD Licence. For details 
 # consult the file doc/LICENCE.
 
@@ -16,7 +15,8 @@ require 'facets/more/paramix' # keep this before module/is
 require 'facets/core/module/is'
 require 'facets/core/class/cattr'
 
-require 'glue/property'
+require 'glue/attribute'
+require 'glue/attributeutils'
 
 # Glue is a collection of reusable utilities and methods to 
 # especially suited to Nitro and Og coding. We try to extract

data/lib/glue/attribute.rb

@@ -0,0 +1,114 @@
+# This file extends the functionality in facets/more/annotation.
+
+require 'facets/more/annotation'
+require 'facets/more/annattr'
+require 'facets/more/aspects'
+
+require 'glue/validation'
+require 'og/entity'
+          
+class Module
+
+  # If the class has serializable attributes, automatically
+  # add some useful mixins.
+  #
+  # Extends the default facets implementation.
+  
+  [:attr_reader, :attr_writer, :attr_accessor].each do |m|
+    module_eval %{
+      alias_method :#{m}_previous, :#{m}
+   
+      def #{m} *args
+        # gmosx: this is a hack, rethink!
+        
+        unless klass = args.last.is_a?(Hash) ? args.last[:class] : nil
+          for a in args
+            if a.is_a? Class
+              klass = a
+              break
+            end
+          end
+        end
+                
+        # If the class defines the included_as_property callback
+        # call to modify the base with custom code.
+
+        if klass.respond_to? :included_as_property 
+          klass.included_as_property(self, args)
+        else
+          #{m}_previous *args
+        end
+
+        unless serializable_attributes.empty? 
+          include Og::EntityMixin unless ancestors.include?(Og::EntityMixin)
+          include Glue::Validation unless ancestors.include?(Glue::Validation)
+          include Aspects unless ancestors.include?(Aspects)
+        end
+      end
+    }  
+  end  
+  
+  alias_method :property, :attr_accessor
+
+  # Return the serializable attributes of this class.
+  # Serializable are attributes with the class annotation that
+  # are not marked as :serializable => false.
+  #
+  # === Examples
+  # 
+  # class MyClass
+  #   attr_accessor :test
+  #   attr_accessor :name, String, :doc => 'Hello'
+  #   attr_accessor :age, Fixnum
+  #   attr_accessor :body, String, :serialize => false
+  # end
+  #
+  # MyClass.attributes # => [:test, :name, :age, :body]
+  # MyClass.serializable_attributes # => [:name, :age]
+  
+  def serializable_attributes
+    attributes.find_all do |a| 
+      anno = self.ann(a)
+      anno.class? and (anno.serialize != false)
+    end
+  end
+
+  #--        
+  # Define force methods for the given attribute.
+  #++
+  
+  def define_force_method_for(sym)
+    if klass = self.ann(sym).class
+      code = %{
+        def __force_#{sym}(val)
+          if respond_to?(:force_#{sym})
+            self.#{sym} = force_#{sym}(val)
+          else
+            self.#{sym}=(} << case klass.name
+              when Fixnum.name: 'val.to_s.empty? ? nil : val.to_i'
+              when String.name: 'val.to_s'
+              when Float.name: 'val.to_f'
+              when Time.name: 'val.is_a?(Hash) ? Time.local(val["year"],val["month"],val["day"],val["hour"],val["min"]) : Time.parse(val.to_s)'
+              when Date.name: 'val.is_a?(Hash) ? Time.local(val["year"],val["month"],val["day"]).to_date : Time.parse(val.to_s).to_date'
+              when TrueClass.name, FalseClass.name: 'val == "on" or val == "true" ? true: val.to_i > 0'
+              else 'val'    
+            end + %{) 
+          end
+        end        
+      }
+
+      module_eval code
+    end
+  end 
+    
+  #--
+  # Define all force methods.
+  #++
+  
+  def define_force_methods
+    for a in serializable_attributes
+      define_force_method_for(a)
+    end
+  end  
+    
+end

data/lib/glue/attributeutils.rb

@@ -0,0 +1,117 @@
+require 'cgi'
+require 'og/relation/all'
+
+#--
+# TODO: find a better name!
+# TODO: this is nitro request specific, should probably get moved
+# into the Nitro directory.
+#++
+
+class AttributeUtils
+  class << self
+
+  #--
+  # TODO: Add preprocessing.
+  #++
+  
+  def set_attr(obj, name, value)
+    obj.send("__force_#{name}", value)
+  rescue Object => ex
+    obj.instance_variable_set("@#{name}", value)
+  end
+
+  # Populate an object from a hash of values.
+  # This is a truly dangerous method.
+  #
+  # === Options
+  #
+  # * name
+  # * force_boolean
+  
+  def populate_object(obj, values, options = {})
+    # If a class is passed create an instance.
+  
+    obj = obj.new if obj.is_a?(Class) 
+
+    for sym in obj.class.serializable_attributes
+      anno = obj.class.ann(sym)
+      
+      unless options[:all]
+        # THINK: should skip control none attributes?
+        next if sym == obj.class.primary_key or anno.control == :none or anno.disable_control?
+      end
+      
+      prop_name = sym.to_s
+
+      # See if there is an incoming request param for this prop.
+      
+      if values.has_key? prop_name
+        
+        prop_value = values[prop_name]
+        
+        # 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 "".
+        
+        break if anno.class == Og::Blob and prop_value.empty?
+
+        set_attr(obj, prop_name, CGI.unescape(prop_value))
+        
+      elsif options[:force_boolean] and (anno.class == TrueClass or anno.class == FalseClass)
+        # Set a boolean property to false if it is not in the 
+        # request. Requires force_boolean == true.
+
+        set_attr(obj, prop_name, 0)
+        obj.send("__force_#{prop_name}", 0)
+      end
+    end
+
+    if options[:assign_relations]
+      for rel in obj.class.relations
+        unless options[:all]
+          next if rel.options[:control] == :none or rel.options[:disable_control]
+        end
+        
+        rel_name = rel.name.to_s
+        
+        # Renew the relations from values
+        
+        if rel.kind_of?(Og::RefersTo)
+          if foreign_oid = values[rel_name]
+            foreign_oid = foreign_oid.to_s unless foreign_oid.is_a?(Hash) or foreign_oid.is_a?(Array) 
+            foreign_oid = nil if foreign_oid == 'nil' or foreign_oid == 'none'
+          end
+          set_attr(obj, rel.foreign_key, foreign_oid)
+        elsif rel.kind_of?(Og::JoinsMany) || rel.kind_of?(Og::HasMany)
+          collection = obj.send(rel_name)
+          collection.remove_all 
+          if values.has_key?(rel_name)
+            primary_keys = values[rel_name]
+            primary_keys.each do |v|
+              v  = v.to_s
+              next if v == "nil" or v == "none"
+              collection << rel.target_class[v.to_i]
+            end
+          end
+        end
+      end
+    end
+
+    #--
+    # gmosx, FIXME: this is a hack, will be replaced with proper
+    # code soon.
+    #++
+    
+    for callback in obj.class.assign_callbacks
+      callback.call(obj, values, options)
+    end if obj.class.respond_to?(:assign_callbacks)
+
+    return obj
+  end 
+  
+  end
+end

data/lib/glue/autoreload.rb

@@ -58,7 +58,3 @@ module Kernel
   end
 
 end
-
-# Michael Neumann
-# Tom Sawyer
-# George Moschovitis <gm@navel.gr>

data/lib/glue/builder.rb

@@ -55,5 +55,3 @@ class Builder
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/builder/xml.rb

@@ -101,5 +101,3 @@ class XmlBuilder < Builder
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache.rb

@@ -7,9 +7,9 @@ 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.
+# 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
 
@@ -20,5 +20,3 @@ class Cache
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/drb.rb

@@ -49,5 +49,3 @@ class DrbCache < MemoryCache
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/memory.rb

@@ -77,5 +77,3 @@ class MemoryCache < Cache
 end
   
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/cache/og.rb

@@ -4,10 +4,14 @@ 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
+    include Og::EntityMixin
+    
+    property :unique_id, String, :sql => 'PRIMARY KEY'
+    property :expires, Time
+    property :cache_name, String
+    property :content, String
+    
+    set_primary_key :unique_id, String
   end
 
   class OgCache
@@ -26,11 +30,12 @@ module Glue
       end
       #s.content = v.to_yaml
       s.content = encode(v)
-      s.save
+      s.insert
     end
 
     def [](k)
-      s = OgCached.find_by_unique_id_and_cache_name(k.to_s, @cache_name) and decode(s.content)
+      s = OgCached.find_by_unique_id_and_cache_name(k.to_s, @cache_name)
+      decode(s.content) if s
     end
 
     def gc!

data/lib/glue/configuration.rb

@@ -1,9 +1,10 @@
 require 'yaml'
 
-require 'facet/kernel/constant'
-require 'facet/synchash'
-require 'facet/dictionary'
-require 'facet/string/capitalized'
+require 'facets/core/kernel/constant'
+require 'facets/more/synchash'
+require 'facets/more/dictionary'
+require 'facets/core/string/capitalized'
+require 'facets/core/class/cattr'
 
 module Glue
 
@@ -98,6 +99,51 @@ class Configuration
   end
     
   class << self
+
+    # The configuration mode, typical modes include :debug, 
+    # :stage, :live. 
+    #
+    # [:debug]
+    #    useful when debugging, extra debug information
+    #    is emmited, actions, templates and shaders are
+    #    reloaded, etc. The execution speed of the application
+    #    is impaired.
+    #
+    # [:stage]
+    #    test the application with live parameters 
+    #    (typically on a staging server).
+    #
+    #  [:live]
+    #    use the parameters for the live (production)
+    #    server. Optimized for speed.
+    #
+    # Tries to set the default value from the CONFIGURATION_MODE 
+    # environment variable.
+    
+    attr_accessor :mode
+
+    def mode
+      @mode || ENV.fetch('CONFIGURATION_MODE', :debug).to_sym
+    end
+    
+    alias kernel_load load
+    
+    # Attempt to load external configuration in Ruby or
+    # YAML format. The files:
+    #
+    # * conf/mode.rb
+    # * conf/mode.yaml
+    #
+    # are considered.
+    
+    def load(m = mode)
+      ruby_conf = "conf/#{m}.rb"
+      kernel_load(ruby_conf) if File.exist?(ruby_conf)
+
+      # Try to configure from a yaml file.
+      yml_conf = "conf/#{m}.yml"
+      Configuration.load_yaml(yml_conf) if File.exist?(yml_conf)
+    end
   
     # Inject the configuration parameters provided as a hash
     # (dictionary, ordered) to classes to be configured.
@@ -115,24 +161,26 @@ class Configuration
 
     # Parse configuration parameters in yaml format.
     
-    def parse(options)
+    def parse_yaml(options)
       temp = YAML::load(options)
       options = Dictionary.new
       temp.each do |k, v| 
-        begin
-          options[k.gsub(/\./, '::').to_sym] = v 
-        rescue Object
-          options[k] = v 
-        end
+        options[k.gsub(/\./, '::').to_sym] = v
       end
 
       setup(options)
     end
     
+    # Load an external ruby configuration file. Constant missing
+    # errors are not reported for extra flexibility.
+    
+    def load_ruby(filename)
+    end
+    
     # Load and parse an external yaml configuration file.
     
-    def load(filename)
-      parse(File.read(filename))
+    def load_yaml(filename)
+      parse_yaml(File.read(filename))
     end
 
     # Manually add a configuration setting. The class key can
@@ -174,7 +222,6 @@ class Configuration
     alias_method :all, :settings
     alias_method :[], :settings
 
-
     #--
     # FIXME: this does not work as expected.
     #++
@@ -224,5 +271,3 @@ class Module
   end
   
 end
-
-# * George Moschovitis <gm@navel.gr>