veneer 0.2.0 → 0.4.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+Gemfile.lock

data/Gemfile

@@ -1,4 +1,15 @@
-#source "http://rubygems.org"
+source "http://rubygems.org"
 
 # Specify your gem's dependencies in ..gemspec
 gemspec
+
+gem 'rake'
+gem 'shoulda'
+gem 'activerecord'
+gem 'mongo_mapper'
+gem 'dm-core'
+gem 'dm-migrations'
+gem 'dm-aggregates'
+gem 'dm-sqlite-adapter'
+gem 'sqlite3-ruby'
+gem 'mysql2'

data/README.md

@@ -7,119 +7,87 @@ Veneer aims to provide plugin, engine, and library authors with a consistant int
 It differs from ActiveModel in that it doesn't provide any validation support, serialization, callbacks, state machine or anything like that.  Veneer is intended to work _with_ ActiveModel to provide a data store independant interface to create reusable code.
 
 Veneer instead aims to provide a simple interface for
+
 * querying
 * creating
 * saving
 * deleting
 * basic lifecycle hooks
-** before validation
-** before save
-** after save
-** before destroy
-** after destroy
+  * before validation
+  * before save
+  * after save
+  * before destroy
+  * after destroy
 
 There is no interface for validations, since this interface is handled as part of ActiveModel
 
-## Creating and Saving an instance
-
-To create an instance of an object wrap the class in a vaneer call and create or get a new instance.
-
-<pre><code>obj = Veneer(MyModel).new(:some => "hash", :of => "attributes")
-obj.save
+## Quick Intro
 
- # OR
-
-obj = Veneer(MyModel).create(:some => "hash", :of => "attributes")
-</code></pre>
+<pre><code># Assume User class model
 
-There are also version that will raise an exception if it could not save
+# Create new items
+Veneer(User).new(:some => "parameters")     # instantiate only
+Veneer(User).create(:some => "parameters")  # instantiate and persist
+Veneer(User).create!(:some => "parameters") # create and raise on failure
 
-<pre><code>obj = Veneer(MyModel).new(:some => "attribute").save!
-
-# OR
-
-obj = Veneer(MyModel).create!(:some => "attribute")
-</code></pre>
+# Query
 
-h2. Deleting
+# The supported options are:
+#
+# * :limit
+# * :offset
+# * :order
+# * :conditions (hash with keys => <Array|Primitive|Range>
 
-You can delete all the instances of a model or a single instance.
+# First can be used in place of all to get a single item
+# All options can be used together
 
-<pre><code>Veneer(MyModel).destroy\_all # delete all instances
-
-@some\_veneer\_model.destroy
-</code></pre>
-
-### Updating
-
-To update an instance:
-
-<pre><code>@some\_veneer\_instance.update(:with => "attributes")
-
-OR
-
-@some\_veneer\_instance.update!(:with => "attributes") # raise on error
-</code></pre>
+Veneer(User).all(:limit => 3, :offset => 2)
+Veneer(User).all(:order => ["name", "dob desc"])
+Veneer(User).all(:conditions => {:some => "condition"})
 
-## Queries
+# Update object
+user = Veneer(User).first(:conditions => {:id => params[:id]})
+user.update(:some => "new values") # updates and persists changes
 
-Veneer lets you query models with a simple interface.  Only simple queries are supported.
+# Destroy object
+user = Veneer(User).first(:conditions => {:id => params[:id]})
+user.destroy
 
-You can query a single object, or multiple objects.
+Veneer(User).destroy_all
 
-<pre><code>Veneer(MyModel).first(:conditions => {:name => "foo"})
-
-Veneer(MyModel).all(:conditions => {:age => 18}, :limit => 5)
-</code></pre>
-
-The supported options are:
-
-* :limit
-* :offset
-* :order
-* :conditions
-
-## Limit & Offset
-
-The :limit option will limit the number of returned results.
-
-The :offset option, when set to an integer x will begin the results at the xth result.
-
-## Order
-
-Ordering should be set as an array.  By default, the order is decending.
-
-The format of the array is:
-
-<pre><code>["<field> <directon>", "<field>"]
-
-### Example
-  Veneer(MyModel).all(:order => [:name, "age desc")
-</code></pre>
+# Save
+user.name = "bar"
+user.save
+# OR
+user.save! # raise on fail
 
-## Conditions
+# Find associations
+Veneer(User).collection_associations # grabs things like has_many and has n
+Veneer(User).member_associations # grabs singular associations like belongs_to and has_one
 
-Conditions are a very simple set of conditions on the fields of the model.  The for of the conditions are:
+# ====> results in
+[ { :name => "asociaiton_name", :class => AssociationClass }]
 
-<pre><code>:conditions => {:field => value}</code></pre>
+# Find property names (NOT YET IMPLEMENTED. PATCHES WELCOME)
 
-<pre><code>
-  Veneer(MyModel).all(:conditions => {:name => ["fred", "barney"], :age => (18..18)})
-  Veneer(MyModel).first(:conditions => {:name => "fred"})
-</code></pre>
+Veneer(User).property_names # => [:name, :login, ...]
 
-Condition fields should be ready to accept:
+# Discover loaded model classes
+Veneer.model_classes
 
-* String
-* Range (Between clauses)
-* Array (IN clauses)
-* nil
+# Aggregate methods
+Veneer(User).count
+Veneer(User).count(conditional_options_same_as_all)
 
-The results of a query are all wrapped as Veneer instances.
+Veneer(User).sum(:column_name)
+Veneer(User).sum(:column_name, conditional_options_same_as_all)
 
-## All Together
+Veneer(User).min(:column_name)
+Veneer(User).min(:column_name, conditional_options_same_as_all)
 
-<pre><code>Veneer(MyModel).all(:order => [:name, "age asc"], :limit => 5, :offset => 15, :conditions => {:name => "betty", :age => (0..18)})
+Veneer(User).max(:column_name)
+Veneer(User).max(:column_name, conditional_options_same_as_all)
 </code></pre>
 
 ## Object methods
@@ -128,7 +96,7 @@ All methods that aren't found on the adapter, are passed through to the instance
 
 ## Current Support
 
-Veneer currently has built in support for ActiveRecord and DataMapper.
+Veneer currently has built in support for ActiveRecord and DataMapper and MongoMapper.
 
 Veneer works on a VeneerInterface inner module though so you can easily impelment your adapter without requiring it to be in the veneer repo (although pull requests are welcome) (see Building Your Adapter)
 

data/Rakefile

@@ -7,7 +7,7 @@ desc "Run test suite."
 Rake::TestTask.new("test"){ |test|
   test.pattern = "test/*_test.rb"
   test.verbose = true
-  test.warning = true
+  test.warning = false
   test.libs << "test"
   test.test_files = FileList["test/test*.rb", "test/**/test*.rb"]
 }

data/lib/veneer.rb

@@ -24,11 +24,16 @@ module Veneer
   autoload :Errors,       'veneer/errors'
   autoload :Proxy,        'veneer/proxy'
   autoload :Conditional,  'veneer/base/conditional'
-  autoload :Lint,         'veneer/lint'
+
 
   module Base
     autoload :ClassWrapper,     'veneer/base/class_wrapper'
     autoload :InstanceWrapper,  'veneer/base/instance_wrapper'
+    autoload :Property,  'veneer/base/property'
+  end
+
+  def self.model_classes
+    Base::ClassWrapper.subclasses.map{|adapter| adapter.model_classes }.flatten.compact
   end
 end
 

data/lib/veneer/adapters/activerecord.rb

@@ -1,4 +1,6 @@
 if defined?(ActiveRecord::Base)
+  require 'veneer/adapters/activerecord/property'
+
   if ActiveRecord::VERSION::MAJOR < 3
     require 'veneer/adapters/activerecord/pre_3.0_class_wrapper'
     require 'veneer/adapters/activerecord/pre_3.0_instance_wrapper'

data/lib/veneer/adapters/activerecord/class_wrapper.rb

@@ -2,10 +2,84 @@ module ActiveRecord
   class Base
     module VeneerInterface
       class ClassWrapper < Veneer::Base::ClassWrapper
+        delegate :validators_on, :to => :klass 
+
+        def self.except_classes
+          @@except_classes ||= [
+            "CGI::Session::ActiveRecordStore::Session",
+            "ActiveRecord::SessionStore::Session"
+          ]
+        end
+
+        def self.model_classes
+          klasses = ::ActiveRecord::Base.descendants
+          klasses.select do |klass|
+            !klass.abstract_class? && !except_classes.include?(klass.name)
+          end
+        end
+
         def new(opts = {})
           ::Kernel::Veneer(klass.new(opts))
         end
 
+        def collection_associations
+          @collection_associations ||= begin
+            associations = []
+            [:has_many, :has_and_belongs_to_many].each do |macro|
+              associations += klass.reflect_on_all_associations(macro)
+            end
+            associations.inject([]) do |ary, reflection|
+              ary << {
+                :name  => reflection.name,
+                :class => reflection.class_name.constantize
+              }
+              ary
+            end
+          end
+        end
+
+        def member_associations
+          @member_associations ||= begin
+            associations = []
+            [:belongs_to, :has_one].each do |macro|
+              associations += klass.reflect_on_all_associations(macro)
+            end
+            associations.inject([]) do |ary, reflection|
+              ary << {
+                :name  => reflection.name,
+                :class => reflection.class_name.constantize
+              }
+              ary
+            end
+          end
+        end
+
+        def properties
+          @properties ||= begin
+            klass.columns.map do |property|
+              name = property.name.to_sym
+             ::ActiveRecord::Base::VeneerInterface::Property.new(
+                self,
+                {
+                  :name => name,
+                  :type => property.type,
+                  :constraints => {
+                    :length => property.limit,
+                    :nullable? => property.null,
+                    :precision => property.precision,
+                    :scale => property.scale,
+                  },
+                  :primary => primary_keys.include?(name),
+                }
+              )
+            end
+          end
+        end
+
+        def primary_keys
+          @primary_keys ||= [klass.primary_key.to_sym]
+        end
+
         def destroy_all
           klass.destroy_all
         end
@@ -15,16 +89,36 @@ module ActiveRecord
         end
 
         def find_many(opts)
-          build_query(opts)
+          build_query(opts).all
+        end
+
+        def count(opts ={})
+          opts = ::Hashie::Mash.new(opts)
+          build_query(opts).count
+        end
+
+        def sum(field, opts={})
+          opts = ::Hashie::Mash.new(opts)
+          build_query(opts).sum(field)
+        end
+
+        def max(field, opts={})
+          opts = ::Hashie::Mash.new(opts)
+          build_query(opts).maximum(field)
+        end
+
+        def min(field, opts={})
+          opts = ::Hashie::Mash.new(opts)
+          build_query(opts).minimum(field)
         end
 
         private
         def build_query(opts)
           query = klass
-          query.where(opts.conditions) if opts.conditions.present?
-          query.limit(opts.limit)      if opts.limit?
-          query.offset(opts.offset)    if opts.offset?
-          query.order(opts.order)      if opts.order?
+          query = query.where(opts.conditions.to_hash) if opts.conditions.present?
+          query = query.limit(opts.limit.to_i)         if opts.limit?
+          query = query.offset(opts.offset.to_i)       if opts.offset?
+          query = query.order(opts.order)              if opts.order?
           query
         end
       end # ClassWrapper

data/lib/veneer/adapters/activerecord/instance_wrapper.rb

@@ -7,9 +7,11 @@ module ActiveRecord
         end
 
         def save!
-          instance.save ?
-            true :
+          if instance.save
+            true
+          else
             raise ::Veneer::Errors::NotSaved
+          end
         end
       end # InstanceWrapper
     end # VeneerInterface

data/lib/veneer/adapters/activerecord/pre_3.0_class_wrapper.rb

@@ -2,10 +2,56 @@ module ActiveRecord
   class Base
     module VeneerInterface
       class ClassWrapper < Veneer::Base::ClassWrapper
+        def self.except_classes
+          @@except_classes ||= [
+            "CGI::Session::ActiveRecordStore::Session",
+            "ActiveRecord::SessionStore::Session"
+          ]
+        end
+
+        def self.model_classes
+          klasses = ::ActiveRecord::Base.__send__(:subclasses)
+          klasses.select do |klass|
+            !klass.abstract_class? && !except_classes.include?(klass.name)
+          end
+        end
+
         def new(opts = {})
           ::Kernel::Veneer(klass.new(opts))
         end
 
+        def collection_associations
+          @collection_associations ||= begin
+            associations = []
+            [:has_many, :has_and_belongs_to_many].each do |macro|
+              associations += klass.reflect_on_all_associations(macro)
+            end
+            associations.inject([]) do |ary, reflection|
+              ary << {
+                :name  => reflection.name,
+                :class => reflection.class_name.constantize
+              }
+              ary
+            end
+          end
+        end
+
+        def member_associations
+          @member_associations ||= begin
+            associations = []
+            [:belongs_to, :has_one].each do |macro|
+              associations += klass.reflect_on_all_associations(macro)
+            end
+            associations.inject([]) do |ary, reflection|
+              ary << {
+                :name  => reflection.name,
+                :class => reflection.class_name.constantize
+              }
+              ary
+            end
+          end
+        end
+
         def destroy_all
           klass.destroy_all
         end
@@ -17,8 +63,23 @@ module ActiveRecord
         def find_many(opts)
           klass.find(:all,opts.to_hash.symbolize_keys)
         end
-      end # ClassWrapper
 
+        def count(opts={})
+          if opts[:conditions]
+            klass.count(:conditions => opts[:conditions])
+          else
+            klass.count
+          end
+        end
+
+        def sum(field, opts={})
+          if opts[:conditions]
+            klass.sum(field, :conditions => opts[:conditions])
+          else
+            klass.sum(field)
+          end
+        end
+      end # ClassWrapper
     end
   end
 end