og 0.24.0 → 0.25.0

data/ProjectInfo

@@ -2,7 +2,7 @@
 
 TITLE    : &title Og
 NAME     : &pkg og
-VERSION  : '0.24.0'
+VERSION  : '0.25.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
@@ -17,7 +17,7 @@ DESCRIPTION: >
   KirbyBase, Filesystem and more.
 
 DEPENDENCIES:
- - [ glue, '= 0.24.0' ]
+ - [ glue, '= 0.25.0' ]
 
 DISTRIBUTE: [ gem, tgz, zip ]
 
@@ -40,9 +40,6 @@ ANNOUNCE:
   sectype: tls # ~, tls, ssl (tls is broke)
   file: ANN
   slogan: Og (ObjectGraph)
-  
-  
-  
   links:
     - http://www.nitrohq.com
 

data/README

@@ -38,6 +38,7 @@ The library provides the following features:
   schema.
 * ActiveRecord-style domain specific language and db synchronized
   collections.
+* Scoped queries on collections.
 * Transforms resultsets from arbitrary sql queries to Ruby objects.
 * Independent store for each object class, can support multiple
   stores in the same application.
@@ -54,6 +55,7 @@ The library provides the following features:
 * Hierarchical structures (nested sets)
 * Works safely as part of distributed application.
 * Optimistic locking.
+* Dynamic finder methods.
 * Simple implementation.
 
 

data/doc/AUTHORS

@@ -11,7 +11,10 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 
 * Ysabel <deb@ysabel.org>
   Refactoring, patches.
-  
+
+* Thomas Sawyer <transfire@gmail.com>
+  Refactoring, code cleanup.
+
 * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
   Tons of patches.
 

data/doc/RELEASES

@@ -1,3 +1,56 @@
+== Version 0.25.0
+
+This is the first in a series of releases focused on stability 
+and refinement. Many bugs where fixed, the high level api was 
+improved where needed, and we still got some small but incredibly
+useful new features. Enjoy!
+
+Most notable changes:
+
+* Support for constrained / scoped queries in Og, here are
+  some examples:
+  
+  User.with_scope(:condition => 'age > 2') {
+    users = User.all
+  }
+  
+  Users.articles.find "title LIKE %t%" # => constrain i users articles.
+  
+* Dynamic auto generators, you can now query the database in
+  English:
+  
+  User.find_by_name_and_age('gmosx', 'age')
+  User.find_or_create_by_name_and_age(...)
+  
+* Added experimental version of a new schema evolution system. Assuming 
+  evolve_schema = true and evolve_schema_cautious = false
+
+  * With this patch, on application startup, fields are added and deleted.
+  * During run-time, if the file containing Og.setup is touched, fields are added.
+  * Fields are _not_ deleted during run-time, only at application startup.
+
+  a the moment this works only in the PostgreSQL store, support for more
+  stores is coming in the next versions. Thanks to Rob Pitt and Bryan Sotto 
+  for this feature.
+
+* Added some useful helpers to make the code you write cleaner,
+  here are some examples:
+  
+  class Article
+    is Taggable
+    
+  instead of
+  
+  class Article
+    include Og::Taggable
+    
+  and stuff like that...
+    
+* General code cleanup and refactoring.
+
+* Many, many bug fixes, including security fixes.
+
+
 == Version 0.24.0
 
 A snapshot of the latest developments. This version features

data/examples/run.rb

@@ -50,7 +50,7 @@ class Article
   # is used for serializing the attribute.
   # no need to define the class, but you can if you want.
 
-  property :options
+  property :options, Hash
 
   # exactly like the standard Ruby attr creates only the reader.
 
@@ -136,7 +136,7 @@ end
 
 config = {
   :destroy => true, # destroy table created from earlier runs.
-  :store => 'psql',
+  :store => :sqlite,
   :name => 'test',
   :user => "postgres",
   :password => "navelrulez"

data/lib/{og/mixin → glue}/hierarchical.rb

@@ -1,9 +1,9 @@
 require 'mega/dynamod'
 require 'mega/orm_support'
 
-module Og
+module Glue
 
-# Implements the Nested Sets pattern for hierarchical 
+# Implements the Nested Sets pattern for hierarchical
 # SQL queries.
 #--
 # TODO: use active collections.
@@ -12,12 +12,12 @@ module Og
 module NestedSets
 
   def self.append_dynamic_features(base, options)
-    c = { 
-      :left => 'lft', 
-      :right => 'rgt', 
-      :type => Fixnum, 
+    c = {
+      :left => 'lft',
+      :right => 'rgt',
+      :type => Fixnum,
       :parent => base.to_s.demodulize.underscore.downcase,
-      :children => base.to_s.demodulize.underscore.downcase.plural  
+      :children => base.to_s.demodulize.underscore.downcase.plural
     }
     c.update(options) if options
 
@@ -32,29 +32,29 @@ module NestedSets
     end
 
     scope = c[:scope]
-    
+
     if scope
       if scope.is_a?(Symbol)
         scope = %{(#{scope} ? "#{scope} = \#{@#{scope}}" : "#{scope} IS NULL")}
       end
-    
+
       cond = 'condition => ' + scope
       cond_and = ':condition => ' + scope + ' + " AND " +'
     else
       cond = ':condition => nil'
       cond_and = ':condition => '
-    end    
+    end
 
     base.module_eval <<-EOE, __FILE__, __LINE__    
       property :#{parent}, Fixnum, :sql_index => true
       property :#{left}, :#{right}, #{c[:type]}
 
       def root?
-        (@#{parent}.nil? || @#{parent} == 0) && (@#{left} == 1) && (@#{right} > @#{left})      
+        (@#{parent}.nil? || @#{parent} == 0) && (@#{left} == 1) && (@#{right} > @#{left})
       end
-    
+
       def child?
-        (@#{parent} &&  @#{parent} != 0) && (@#{left} > 1) && (@#{right} > @#{left})      
+        (@#{parent} &&  @#{parent} != 0) && (@#{left} > 1) && (@#{right} > @#{left})
       end
 
       def parent
@@ -64,7 +64,7 @@ module NestedSets
           #{base}[@#{parent}]
         end
       end
-                                   
+
       def #{children}_count
         return (@#{right} - @#{left} - 1)/2
       end
@@ -78,7 +78,7 @@ module NestedSets
         options.update(#{cond_and}"(#{left} > \#\{@#{left}\}) AND (#{right} < \#{@#{right}})")
         #{base}.all(options)
       end
-                            
+
       def direct_#{children}(options = {})
         options.update(#{cond_and}"#{parent} = \#{pk}")
         #{base}.all(options)
@@ -87,12 +87,12 @@ module NestedSets
       def add_#{child}(child)
         self.reload if pk
         child.reload if child.pk
-        
+
         if @#{left}.nil? || @#{left} == 0 || @#{right}.nil? || @#{right} == 0
           @#{left} = 1
           @#{right} = 2 
         end
-      
+
         child.#{parent} = pk
         child.#{left} = pivot = @#{right}
         child.#{right} = pivot + 1
@@ -102,7 +102,7 @@ module NestedSets
           #{base}.update_property("#{left} = (#{left} + 2)",  #{cond_and}"#{left} >= \#{pivot}")
           #{base}.update_property("#{right} = (#{right} + 2)", #{cond_and}"#{right} >= \#{pivot}")
         end
-      
+
         self.save
         child.save
       end
@@ -129,7 +129,7 @@ end
 module Hierarchical
 
   def self.append_dynamic_features(base, options)
-    o = { 
+    o = {
       :method => :nested_sets, 
     }
     o.update(options) if options

data/lib/{og/mixin → glue}/optimistic_locking.rb

@@ -1,7 +1,7 @@
 require 'mega/dynamod'
 require 'glue/on_included'
 
-module Og
+module Glue
 
 # This error is thrown when you the object you are trynig
 # to update is allready updated by another thread.

data/lib/glue/orderable.rb

@@ -0,0 +1,235 @@
+require 'mega/dynamod'
+require 'glue/aspects'
+
+module Glue
+
+# Attach list/ordering methods to the enchanted class.
+
+module Orderable
+  include Glue::Aspects
+
+  dynamic_feature do |opt|
+
+    opt_position = opt[:position] || 'position'
+
+    opt_type = opt[:type] || Fixnum
+
+    # provide a user defined condition.
+    
+    opt_condition = opt[:condition]
+
+    # provide a condition based on a key field (?)
+    
+    opt_scope = opt[:scope]
+
+    # clean scope field.
+    
+    if opt_scope
+      if opt_scope.to_s !~ /_oid$/
+        opt_scope = "#{opt_scope}_oid".to_sym
+      else
+        opt_scope = opt_scope.to_sym
+      end
+    end
+
+    define_method :orderable_position do
+      opt_position
+    end
+
+    define_method :orderable_type do
+      opt_type
+    end
+
+    define_method :orderable_scope do
+      opt_scope
+    end
+
+    define_method :orderable_condition do
+      scope = orderable_scope
+      if scope
+        scope_value = send(scope)
+        scope = scope_value ? "#{scope} = #{scope_value}" : "#{scope} IS NULL"
+      end
+      return [ opt_condition, scope ].compact
+    end
+
+    # How to check if property is already defined?
+    
+    unless method_defined?( opt_position )
+      define_method( opt_position ) do @position ; end
+      define_method( "#{opt_position}=" ) do |x| @position = x ; end
+      property opt_position, opt_type
+    end
+
+    # Use position for general reference.
+    
+    attr_accessor :position
+
+  end #dynamic_feature
+
+  before "add_to_bottom", :on => :og_insert
+  before "decrement_position_of_lower_items", :on => :og_delete
+
+  # Move higher.
+  
+  def move_higher
+    if higher = higher_item
+      self.class.transaction do
+        higher.increment_position
+        decrement_position
+      end
+    end
+  end
+
+  # Move lower.
+  
+  def move_lower
+    if lower = lower_item
+      self.class.transaction do
+        lower.decrement_position
+        increment_position
+      end
+    end
+  end
+
+  # Move to the top.
+  
+  def move_to_top
+    self.class.transaction do
+      increment_position_of_higher_items
+      set_top_position
+    end
+  end
+
+  # Move to the bottom.
+  
+  def move_to_bottom
+    self.class.transaction do
+      decrement_position_of_lower_items
+      set_bottom_position
+    end
+  end
+
+  # Move to a specific position.
+  
+  def move_to(dest_position)
+    return if @position == dest_position
+
+    pos = orderable_position
+    con = orderable_condition
+
+    self.class.transaction do
+      if @position < dest_position
+        adj = "#{pos} = #{pos} - 1"
+        con = con + [ "#{pos} > #{@position}", "#{pos} <= #{dest_position}" ]
+      else
+        adj = "#{pos} = #{pos} + 1"
+        con = con + [ "#{pos} < #{@position}", "#{pos} >= #{dest_position}" ]
+      end
+      self.class.update( adj, :condition => con.join(' AND ') )
+      @position = dest_position
+      update_property(:"#{pos}")
+    end
+
+    self
+  end
+
+  def add_to_top
+    increment_position_of_all_items
+  end
+
+  def add_to_bottom
+    @position = bottom_position + 1
+  end
+
+  def add_to
+    # TODO
+  end
+
+  def higher_item
+    pos = orderable_position
+    con = orderable_condition + [ "#{pos} = #{@position - 1}" ]
+    self.class.one( :condition => con.join(' AND ') )
+  end
+  alias_method :previous_item, :higher_item
+
+  def lower_item
+    pos = orderable_position
+    con = orderable_condition + [ "#{pos} = #{@position + 1}" ]
+    self.class.one( :condition => con.join(' AND ') )
+  end
+  alias_method :next_item, :lower_item
+
+  def top_item
+    # TODO
+  end
+  alias_method :first_item, :top_item
+
+  def bottom_item
+    pos = orderable_position
+    con = orderable_condition
+    con = con.empty? ? nil : con.join(' AND ')
+    self.class.one(:condition => con, :order => "#{pos} DESC", :limit => 1)
+  end
+  alias_method :last_item, :last_item
+
+  def top?
+    @position == 1
+  end
+  alias_method :first?, :top?
+
+  def bottom?
+    @position == bottom_position
+  end
+  alias_method :last?, :bottom?
+
+  def increment_position
+    @position += 1
+    update_property(:"#{orderable_position}")
+  end
+
+  def decrement_position
+    @position -= 1
+    update_property(:"#{orderable_position}")
+  end
+
+  def bottom_position
+    item = bottom_item
+    item ? item.send(orderable_position) : 0
+  end
+
+  def set_top_position
+    @position = 1
+    update_property(:"#{orderable_position}")
+  end
+
+  def set_bottom_position
+    @position = bottom_position + 1
+    update_property(:"#{orderable_position}")
+  end
+
+  def increment_position_of_higher_items
+    pos = orderable_position
+    con = orderable_condition + [ "#{pos} < #{@position}" ]
+    self.class.update( "#{pos}=(#{pos} + 1)",  :condition => con.join(' AND ') )
+  end
+
+  def increment_position_of_all_items
+    pos = orderable_position
+    con = orderable_condition
+    con = con.empty? ? nil : con.join(' AND ')
+    self.class.update("#{pos}=(#{pos} + 1)", :condition => con )
+  end
+
+  def decrement_position_of_lower_items
+    pos = orderable_position
+    con = orderable_condition + [ "#{pos} > #{@position}" ]
+    self.class.update( "#{pos}=(#{pos} - 1)",  :condition => con.join(' AND ') )
+  end
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>
+# * Thomas Sawyer <transfire@gmail.com>