og 0.31.0 → 0.40.0

data/ProjectInfo

@@ -1,51 +0,0 @@
---- %YAML:1.0
-
-TITLE    : &title Og
-NAME     : &pkg og
-VERSION  : '0.31.0'
-STATUS   : beta
-
-AUTHOR   : George Moschovitis
-EMAIL    : &email gm@navel.gr
-HOMEPAGE : "http://www.nitroproject.org"
-
-SUMMARY: State of the art object-relational mapping system.
-
-DESCRIPTION: >
-  Object Graph (Og) is a state of the art ORM system.
-  Og serializes standard Ruby objects to Mysql, Postgres, Sqlite,
-  KirbyBase, Filesystem and more.
-
-RUBYFORGE:
-  PROJECT: 'nitro'
-  USERNAME: 'gmosx'
-
-DEPENDENCIES:
- - [ glue, '= 0.31.0' ]
-
-PACKAGE: !!package
-  distribute: [ gem, tgz, zip ]
-
-RDOC: !!rdoc
-  dir: rdoc
-  options: ['--all', '--inline-source']
-  include:
-    - 'lib/og/**/*'
-    - '[A-Z]*'
-
-TEST: !!test
-
-ANNOUNCE: !!announce
-  to: george.moschovitis@gmail.com
-  from: gm@navel.gr
-  domain: navel.gr
-  server: mail
-  port: 25 #587
-  account: gm@navel.gr
-  authtype: login  #cram_md5 #plain
-  sectype: tls # ~, tls, ssl (tls is broke)
-  file: ANN
-  slogan: Og (ObjectGraph)
-  links:
-    - http://www.nitroproject.org
-

data/README

@@ -1,177 +0,0 @@
-= Og 0.30.0 README
-
-Og (ObjectGraph) is a powerful and elegant object-relational mapping 
-library. Og manages the lifecycle of Ruby objects and  provides 
-transparent serialization of object graphs to stores (typically
-RDBM systems)/.
-
-Unlike other similar solutions Og maps standard Ruby objects 
-to SQL tables and not vice versa. Og provides a domain specific 
-language to describe the relations between objects, a flexible 
-and intuitive api for querieng the database, raw access to the 
-SQL language if needed (for example to fine tune the automatically 
-generated SQL tables, or for custom queries), provides automatic 
-validation, suports deserialization to Ruby objects or tuples, 
-automatically generates join tables for many_to_many relations 
-and provides a collection of usefull Mixins to synthesize 
-common Entities.
-
-Adapters for PostgreSQL, MySQL, SQLite3, KirbyBase, Memory, 
-Filesystem, Oracle and SQL Server are included.
-
-Og is part of the Nitro project, released as a stand-alone library
-due to popular demand. You can find the ChangeLog in the Nitro 
-distribution (http://www.nitroproject.org).
-
-
-== Features
-
-The library provides the following features:
-
-* Object-Relational mapping, automatically maps standard 
-  Ruby objects to sql schemas.
-* Absolutely no configuration files.
-* Multiple stores (PostgreSQL, MySQL, SQLite, Oraclei, SqlServer, ..).
-* Supports non SQL stores (KirbyBase, Memory, filesystem, ..).
-* Can 'reverse engineer' legacy database schemase.
-* Fine-grained or High-level customization of the generated
-  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.
-* Deserialize to Ruby Objects.
-* Deserialize sql join queries to Ruby Objects.
-* Can optionally use Ruby as a query language.
-* Supports model caching (even on distribbuted environments)
-* Eager associations.
-* Serialize arbitrary ruby object graphs through YAML.
-* Connection pooling.
-* Thread safety.
-* SQL transactions.
-* Aspect oriented constructs allow interception of lifecycle callbacks.
-* Transparent support for cascading deletes for all backends.
-* Can annotate and manage existing Ruby classes.
-* Hierarchical structures (nested sets)
-* Works safely as part of distributed application.
-* Optimistic locking.
-* Dynamic finder methods.
-* Simple implementation.
-
-
-== What's new
-
-For information about the latest changes please consult the
-file
-
-doc/RELEASES
-
-
-== Download
-
-The latest version of Og can be found at
-
-* http://www.nitroproject.org
-
-== Documentation
-
-Documentation for Og can be found at
-
-* http://www.nitroproject.org
-
-Don't forget to read the file doc/RELEASES for usefull
-documentation bits. Also, have a look at the test cases in
-the test directory for examples of usage. Additional examples
-of Og usage can be found at the example distribution of the
-Nitro Web Framework (http://www.nitroproject.org)
-
-You can find a nice tutorial at www.rubygarden.com. Be warned
-that this tutorial describes an earlier version of Og. A *LOT*
-of new features have been added in the meantime.
-
-
-== Requirements
-
-Og requires the following applications or libraries:
-
-* Ruby 1.8.1 and greater 
-  http://www.ruby-lang.org
-  Version 1.8.2 is recomended.
-
-* Ruby-psql 
-  http://www.postgresql.jp/interfaces/ruby/archive/ruby-postgres-0.7.1.tar.gz
-  Ruby interface to the PostgreSQL RDBMS.
-
-* Ruby-mysql 
-  http://tmtm.org/ja/ruby/mysql/README_en.html
-  Ruby interface to the MySQL RDBMS.
-  Pure Ruby Mysql interface:
-  http://www.tmtm.org/ruby/mysql/
-  
-* PostgreSQL 
-  http://www.postgres.org
-  Used for the Database Backend.
-  
-* MySQL 
-  http://www.mysql.org
-  Used for the Database Backend.
-
-* SQLite
-  http://www.sqlite.org/download.html
-  WARNING: you need sqlite3-ruby > 1.1.0
-
-Please install the required applications and libraries before continuing
-with the installation of Og. Only install the libraries needed for
-the backend you plan to use.
-
-
-== Instalation
-
-Og is distributed as a RubyGem. First of all make sure you have
-installed RubyGems on your system. Then run the following command:
-
-gem install og
-
-(make sure you have the latest stable versions of Ruby and RubyGems
-installed)
-
-Then try to run the examples in the examples directory.
-
-A tar.gz distribution is also available on http://www.rubyforge.com/projects/nitro.
-
-
-== Examples:
-
-Some examples can be found in the examples directory. You are also
-encouraged to check out the unit tests. Especially the test:
-
-test/og/tc_store.rb
-
-demonstrates some advanced features of Og.
-
-
-== Support
-
-For any questions regarding Og, feel free to ask on the ruby-talk 
-mailing list (which is mirrored to comp.lang.ruby) or contact 
-mailto:gm@navel.gr.
-
-An Og specific mailing list is also available. Please subscribe
-to nitro-general@rubyforge.com. The homepage for this list
-is available here:
-
-http://rubyforge.org/mailman/listinfo/nitro-general
-
-
-== Licence
-
-Copyright (c) 2004-2006, George 'gmosx' Moschovitis (http://www.gmosx.com).
-Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
-
-Og (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 LICENCE.
-

data/doc/config.txt

@@ -1,28 +0,0 @@
-= Og Configuration parameters
-
-This file presents a complete list of Og configuration 
-parameters.
-
-=== Og.table_prefix = nil
-
-Attach the given prefix to all generated SQL table names.
-Usefull on hosting scenarios where you have to run multiple
-applications/sites on a single database.
-
-=== Og.auto_manage_classes = true
-
-If true, use Ruby's advanced introspection capabilities to 
-automatically manage classes that define properties.
-  
-=== Og.create_schema = true
-
-If set to true, Og attempts to recreate the database schema
-to store the managed objects. If the table for an object class
-exists, Og does not recreate it. It is useful to get Og to
-automatically create the schema for your application on setup,
-or when you add a new managed class to your application. On 
-the downside, it inflicts a longer startup time on the 
-application, so it is better to set this to false in 
-production / live environments.
-
-This option is by default true to facilitate easy development.

data/examples/README

@@ -1,23 +0,0 @@
-= Og Examples
-
-Here you can find some simple Og examples. For more examples 
-please download the Nitro examples tarball. Nitro is a Ruby
-Web Framework that uses Og.
-
-
-== run.rb
-
-A simple example that demonstrates some Og features. The example
-automatically creates a 'test' database.
-
-
-== mock_example.rb
-
-Demonstrates how easily the Og infrastructure can be mocked,
-for easy test unit writing.
-
-
-== mysql_to_psql.rb
-
-Demonstrates how easy it is to migrate a mysql database
-to postgres using Og.

data/examples/mysql_to_psql.rb

@@ -1,71 +0,0 @@
-# = Mysql to PostgreSQL migration example.
-#
-# A simple example to demonstrate the flexibility of
-# Og. Two connections to different databases are 
-# created and data is copied from a MySQL database
-# to a PostgreSQL database.
-#
-# Og makes it easier to switch to a REAL database :)
-
-require 'og'
-
-# Configure databases.
-
-psql_config = {
-  :destroy => true,
-  :name => 'test',
-  :store => 'psql',
-  :user => 'postgres',
-  :password => 'navelrulez'
-}
-
-mysql_config = {
-  :destroy => true,
-  :name => 'test',
-  :store => 'mysql',
-  :user => 'root',
-  :password => 'navelrulez'
-}
-
-# Initialize Og.
-
-psql = Og.connect(psql_config)
-mysql = Og.connect(mysql_config)
-
-# An example managed object.
-# Looks like an ordinary Ruby object.
-
-class Article
-  property :name, :body, String
-
-  def initialize(name = nil, body = nil)
-    @name, @body = name, body
-  end
-end
-
-# First populate the mysql database.
-
-mysql.manage(Article)
-
-a1 = Article.create('name1', 'body1')
-a1 = Article.create('name1', 'body1')
-a1 = Article.create('name1', 'body1')
-
-# Read all articles from Mysql.
-
-articles = Article.all
-
-# Switch to PostgreSQL.
-
-psql.manage(Article)
-
-# Store all articles.
-
-for article in articles
-  article.insert
-end
-
-# Fetch an article from PostgreSQL
-# as an example. Lookup by name.
-
-article = Article.find_by_name('name1')

data/examples/run.rb

@@ -1,271 +0,0 @@
-# A simple example to demonstrate the Og library.
-
-require 'og'
-
-# Full debug information.
-
-$DBG = true
-
-# A child class.
-
-class Comment
-  property :body, String
-  
-  def initialize(body = nil)
-    @body = body
-  end
-  
-  def to_s
-    return @body
-  end
-end
-
-# = A Parent class.
-
-class User
-  property :name, String, :uniq => true
-  has_many :comments, UserComment
-  
-  def initialize(name = nil)
-    @name = name
-  end
-  
-  def to_s
-    return @name
-  end
-end
-
-
-# A parent class.
-
-class Article
-  property :title, String
-  property :body, String
-
-  # override the default O->R mapping
-
-  property :level, Fixnum, :sql => "smallint DEFAULT 1"
-
-  # store a Ruby Hash in the Database. YAML
-  # is used for serializing the attribute.
-  # no need to define the class, but you can if you want.
-
-  property :options, Hash
-
-  # exactly like the standard Ruby attr creates only the reader.
-
-  prop :create_time, Time
-  
-  # define comment relation:
-
-  has_many :comments, ArticleComment
-  
-  has_many :parts, Part
-
-  # many to many relation.
-  
-  many_to_many Category
-  
-  # define author relation:
-
-  belongs_to :author, User
-  
-  # this attribute is NOT stored in the db.
-
-  attr_accessor :other_options
-  
-  # Managed object constructors with no args, take *args 
-  # as parameter to allow for Mixin chaining.
-
-  def initialize(title = nil, body = nil)
-    @title, @body = title, body
-    @create_time = Time.now
-    @options = {}
-    @other_options = {}
-  end
-  
-  def to_s
-    return "#@title: #@body"
-  end
-end
-
-# A parent class.
-
-class Category
-  property :title, String
-  property :body, String
-
-  # define a 'many to many' relation.  
-
-  many_to_many Article
-  
-  def initialize(title = nil)
-    @title = title
-  end
-end
-
-
-# Article comment.
-
-class ArticleComment < Comment
-  belongs_to Article
-end
-
-# User comment.
-
-class UserComment < Comment
-  belongs_to :author, User
-end
-
-# Another child class.
-
-class Part
-  property :name, String
-  belongs_to Article
-  
-  def initialize(name = nil)
-    @name = name
-  end
-  
-  def to_s
-    return @name
-  end
-end
-
-# Og configuration.
-
-config = {
-  :destroy => true, # destroy table created from earlier runs.
-  :store => :sqlite,
-  :name => 'test',
-  :user => "postgres",
-  :password => "navelrulez"
-}
-
-# Initialize Og
-
-db = Og.setup(config)
-
-# Create some articles
-
-a1 = Article.new('Title1', 'Body1')
-a1.save
-
-# shortcut
-
-a2 = Article.create('Title2', 'Body2')
-
-puts "\n\n"
-puts "* Get and print all articles:"
-articles = Article.all
-articles.each { |a| puts a }
-
-# Create some comments
-
-c1 = ArticleComment.new('Comment 1')
-c1.article = a1
-c1.save
-
-c2 = ArticleComment.new('Comment 2')
-# alternative way to set the parent.
-c2.article_oid = a1.oid
-# an alternative way to save 
-db.store << c2
-
-# an alternative (easier and cooler) way to add children in a 
-# has_many relation:
-c3 = ArticleComment.new('Comment 3')
-# add_comment is automatically added by Og.
-a1.comments << c3
-
-puts "\n\n"
-puts "* Print all all comments for article 1:"
-a1.comments.each { |c| puts c }
-
-# Most Og commands allow you to fine-tune the low level
-# SQL code by passing extra_sql parameters, here is an
-# example
-puts "\n\n"
-puts "* comments with sql finetunings:"
-# use a standard SQL limit clause
-a1.comments(:limit => 2).each { |c| puts c }
-
-
-# Change a managed object
-a1.title = 'Changed Title'
-# Og knows that this is a managed object and executes
-# an SQL UPDATE instead of an SQL INSERT
-a1.save!
-
-puts "\n\n"
-Article.all.each { |a| puts a }
-
-# The previous command updates the whole object. It is used
-# when there are many updates or you dont care about speed. 
-# You can also update specific fields
-a2.title = 'A specific title'
-a2.update(:properties => [:title])
-
-puts "\n\n"
-Article.all.each { |a| puts a }
-
-# delete an object
-puts '-----------------1'
-ArticleComment.delete(c3)
-puts '-----------------2'
-
-puts "\n\n"
-ArticleComment.all.each { |a| puts a }
-
-
-# Serialize a hash
-a1.options = { :k1 => 'val1', :k2 => 'val2' }
-a1.save!
-
-# lookup an object
-article = Article[a1.oid]
-
-puts "\n\n"
-puts article.options.inspect
-
-u = User.new('gmosx')
-u.save!
-
-article = Article[1]
-# you can also lookup by the name property.
-article.author = User.find_by_name('gmosx')  
-article.save!
-
-part = Part.new('admin')
-part.article = article
-part.save!
-
-article.parts.each { |pa| puts pa }
-
-puts "\n\n"
-puts '---'
-
-c1 = Category.create('Category1')
-c2 = Category.create('Category2')
-
-article.categories << c1
-article.categories << c2
-
-puts '---'
-
-article.categories.each { |c| puts c.title }
-
-puts '---'
-
-c2.articles.each { |a| puts a.title }
-
-article.categories.delete(c1)
-
-puts '---'
-
-article.categories.each { |c| puts c.title }
-
-# create and save the article in one step.
-article = Article.create('title', 'body')
-
-puts '--', article.oid