veneer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,138 @@
+h1. veneer
+
+Veneer is an interface that sits above Data Sources.
+It differs from ActiveModel in that it doesn't require errors or validations or anything like that.
+Veneer instead aims to provide a simple interface for
+ * querying
+ * creating
+ * saving
+ * deleting
+
+h2. 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 => "attribute")
+obj.save
+
+ # OR
+
+obj = Veneer(MyModel).create(:some => "attribute")
+</code></pre>
+
+There are also version that will raise exceptions
+
+<pre><code>obj = Veneer(MyModel).new(:some => "attribute").save!
+
+# OR
+
+obj = Veneer(MyModel).create!(:some => "attribute")
+</code></pre>
+
+h2. Deleting
+
+You can delete all the instances of a model or a single instance.
+
+<pre><code>Veneer(MyModel).destroy_all # delete all instances
+
+@some_veneer_model.destroy
+</code></pre>
+
+h2. Queries
+
+Veneer lets you query models with a simple interface.  Only simple queries are supported.
+
+You can query a single object, or multiple objects.
+
+<pre><code>Veneer(MyModel).all(:conditions => {:name => "foo"})
+
+Veneer(MyModel).all(:conditions => {"age gte" => 18}, :limit => 5)
+</code></pre>
+
+The supported options are:
+
+* :limit
+* :offset
+* :order
+* :conditions
+
+h3. 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.
+
+h3. Order
+
+Ordering should be set as a string.  By default, the order is decending.
+
+The format of the string is:
+
+<pre><code>"<field> (<directon>), <field> (direction), ..."
+
+# eg
+  Veneer(MyModel).all(:order => "name, age desc")
+</code></pre>
+
+h3. Conditions
+
+Conditions are a very simple set of conditions on the fields of the model.  The for of the conditions are:
+
+<pre><code>:conditions => {"field operator" => value}</code></pre>
+
+The supported operators are
+
+* eql
+* not
+* lt  (less than)
+* lte (less than or equal to)
+* gt  (greater than)
+* gte (greater than or equal to)
+* in  (in an array)
+
+By default, the operator is set to eql
+
+<pre><code>
+  Veneer(MyModel).all(:conditions => {"name in" => ["fred", "barney"], "age gte" => 18})
+  Veneer(MyModel).first(:conditions => {:name => "fred"})
+</code></pre>
+
+The results of a query are all wrapped as Veneer instances.
+
+h3. All Together
+
+<pre><code>Veneer(MyModel).all(:order => "name, age asc", :limit => 5, :offset => 15, :conditions => {"name not" => "betty", "age lt" => 18})
+</code></pre>
+
+h2. Object methods
+
+All methods that aren't found on the adapter, are passed through to the instance.  So to access any attributes on the actual model instance, just call the method on it.
+
+h2. Current Support
+
+Veneer currently has built in support for ActiveRecord and DataMapper.
+
+Veneer works on a VeneerInterface inner module though so you can easily impelment you're adapter without requireing it to be in the veneer repo (although pull requests are welcome)
+
+To use DataMapper or ActiveRecord
+
+<pre><code>
+require 'veneer/adapters/activerecord'
+require 'veneer/adapters/datamapper'
+</code></pre>
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Daniel Neighman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "veneer"
+    gem.summary = %Q{A thin veneer over data stores}
+    gem.description = %Q{Veneer provides basic querying, saving, deleteing and creating of data stores.}
+    gem.email = "has.sox@gmail.com"
+    gem.homepage = "http://github.com/hassox/veneer"
+    gem.authors = ["Daniel Neighman"]
+    gem.rubyforge_project = "veneer"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+#require 'spec/rake/spectask'
+#Spec::Rake::SpecTask.new(:spec) do |spec|
+#  spec.libs << 'lib' << 'spec'
+#  spec.spec_files = FileList['spec/**/*_spec.rb']
+#end
+#
+#Spec::Rake::SpecTask.new(:rcov) do |spec|
+#  spec.libs << 'lib' << 'spec'
+#  spec.pattern = 'spec/**/*_spec.rb'
+#  spec.rcov = true
+#end
+#
+#task :spec => :check_dependencies
+#
+#task :default => :spec
+
+task :default => [:test_units]
+require 'rake/testtask'
+desc "Run test suite."
+Rake::TestTask.new("test"){ |test|
+  test.pattern = "test/*_test.rb"
+  test.verbose = true
+  test.warning = true
+  test.libs << "test"
+  test.test_files = FileList["test/test*.rb", "test/**/*_test.rb"]
+}
+
+task :test => :check_dependencies
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "veneer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/datamapper_setup.rb

@@ -0,0 +1,2 @@
+require 'dm-core'
+

data/lib/veneer.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/hash'
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+
+require 'veneer/core_ext/kernel'
+
+unless defined?(BasicObject)
+  begin
+    require 'blankslate'
+    ::BasicObject = BlankSlate
+    class BasicObject
+      def ==(other)
+        object_id == other.object_id
+      end
+
+      def equal?(other)
+        object_id == other.object_id
+      end
+    end
+  rescue => e
+    puts "Please install builder: gem install builder"
+    raise e.class, e.message, e.backtrace
+  end
+end
+
+module Veneer
+  autoload :Errors,       'veneer/errors'
+  autoload :Proxy,        'veneer/proxy'
+  autoload :Conditional,  'veneer/base/conditional'
+
+  module Base
+    autoload :ClassWrapper,     'veneer/base/class_wrapper'
+    autoload :InstanceWrapper,  'veneer/base/instance_wrapper'
+  end
+end
+

data/lib/veneer/adapters/activerecord.rb

@@ -0,0 +1,2 @@
+require 'veneer/adapters/activerecord/class_wrapper'
+require 'veneer/adapters/activerecord/instance_wrapper'

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

@@ -0,0 +1,90 @@
+module ActiveRecord
+  class Base
+    module VeneerInterface
+      class ClassWrapper < Veneer::Base::ClassWrapper
+        def new(opts = {})
+          ::Kernel::Veneer(klass.new(opts))
+        end
+
+        def destroy_all
+          klass.destroy_all
+        end
+
+        def find_first(conditional)
+          opts = conditional_to_ar_opts(conditional)
+          klass.find(:first, opts)
+        end
+
+        def find_many(conditional)
+          opts = conditional_to_ar_opts(conditional)
+          klass.find(:all,opts)
+        end
+
+        private
+        def conditional_to_ar_opts(c)
+          opts = {}
+          opts[:limit]  = c.limit   if c.limit
+          opts[:offset] = c.offset  if c.offset
+
+          unless c.order.blank?
+            opts[:order] = c.order.inject([]) do |ary, cnd|
+              ary << "#{cnd.field} #{cnd.direction}"
+            end.join(",")
+          end
+
+          unless c.conditions.blank?
+            val_array = []
+            cnds = c.conditions.inject([]) do |ary, cd|
+              case cd.operator
+              when :eql
+                if cd.value.nil?
+                  ary << "#{cd.field} IS ?"
+                else
+                  ary << "#{cd.field} = ?"
+                end
+                val_array << cd.value
+              when :not
+                if cd.value.nil?
+                  ary << "#{cd.field} IS NOT ?"
+                else
+                  ary << "#{cd.field} <> ?"
+                end
+                val_array << cd.value
+              when :gt
+                ary << "#{cd.field} > ?"
+                val_array << cd.value
+              when :gte
+                ary << "#{cd.field} >= ?"
+                val_array << cd.value
+              when :lt
+                ary << "#{cd.field} < ?"
+                val_array << cd.value
+              when :lte
+                ary << "#{cd.field} <= ?"
+                val_array << cd.value
+              when :in
+                ary << "#{cd.field} IN ( ? )"
+                val_array << cd.value
+              end
+              ary
+            end
+            opts[:conditions] = [cnds.join(" AND "), *val_array]
+          end
+          opts
+        end
+      end # ClassWrapper
+
+      class InstanceWrapper < Veneer::Base::InstanceWrapper
+        def save!
+          instance.save!
+        rescue ActiveRecord::RecordInvalid => e
+          raise ::Veneer::Errors::NotSaved
+        end
+
+        def save
+          instance.save
+        end
+      end # InstanceWrapper
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module ActiveRecord
+  class Base
+    module VeneerInterface
+      class InstanceWrapper < Veneer::Base::InstanceWrapper
+        def update(attributes = {})
+          instance.update_attributes(attributes)
+        end
+      end # InstanceWrapper
+    end # VeneerInterface
+  end # Base
+end # ActiveRecord

data/lib/veneer/adapters/datamapper.rb

@@ -0,0 +1,2 @@
+require 'veneer/adapters/datamapper/class_wrapper'
+require 'veneer/adapters/datamapper/instance_wrapper'

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

@@ -0,0 +1,54 @@
+module DataMapper
+  module Resource
+    module VeneerInterface
+      class ClassWrapper < ::Veneer::Base::ClassWrapper
+        def new(opts = {})
+          ::Kernel.Veneer(klass.new(opts))
+        end
+
+        def destroy_all
+          klass.all.destroy
+        end
+
+        def find_first(conditional)
+          opts = opts_from_conditional_for_dm(conditional)
+          klass.first(opts)
+        end
+
+        def find_many(conditional)
+          opts = opts_from_conditional_for_dm(conditional)
+          klass.all(opts)
+        end
+
+        private
+        def opts_from_conditional_for_dm(c)
+          opts = {}
+
+          opts[:limit]  = c.limit  if c.limit
+          opts[:offset] = c.offset if c.offset
+
+          unless c.order.empty?
+            opts[:order] = c.order.inject([]) do |ary, cnd|
+              ary << cnd.field.send(cnd.direction)
+              ary
+            end
+          end
+
+          unless c.conditions.empty?
+            c.conditions.each do |cd|
+              case cd.operator
+              when :eql
+                opts[cd.field] = cd.value
+              when :not, :gt, :gte, :lt, :lte
+                opts[cd.field.send(cd.operator)] = cd.value
+              when :in
+                opts[cd.field] = ::Array.new([cd.value].flatten.compact)
+              end
+            end
+          end
+          opts
+        end
+      end
+    end
+  end
+end