ripple 0.6.1 → 0.7.0

data/Rakefile

@@ -1,61 +1,74 @@
 require 'rubygems'
-require 'rake'
-require 'rake/clean'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "ripple"
-    gem.summary = %Q{ripple is a rich Ruby client for Riak, Basho's distributed database.}
-    gem.description = %Q{ripple is a rich Ruby client for Riak, Basho's distributed database.  It includes all the basics of accessing and manipulating Riak buckets and objects, and an object mapper library for building a rich domain on top of Riak.}
-    gem.email = "seancribbs@gmail.com"
-    gem.homepage = "http://seancribbs.github.com/ripple"
-    gem.authors = ["Sean Cribbs"]
-    gem.add_development_dependency "rspec", ">= 1.3"
-    gem.add_development_dependency "fakeweb", ">=1.2"
-    gem.add_development_dependency "rack", ">=1.0"
-    gem.add_development_dependency "yard", ">=0.5.2"
-    gem.add_development_dependency "curb", ">=0.6"
-    gem.add_dependency "activesupport", "~>3.0.0.beta"
-    gem.add_dependency "activemodel", "~>3.0.0.beta"
-    gem.requirements << "`gem install curb` for better HTTP performance"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+require 'rake/gempackagetask'
+
+version = File.read('../VERSION').strip
+
+gemspec = Gem::Specification.new do |gem|
+  gem.name = "ripple"
+  gem.summary = %Q{ripple is an object-mapper library for Riak, the distributed database by Basho.}
+  gem.description = %Q{ripple is an object-mapper library for Riak, the distributed database by Basho.  It uses ActiveModel to provide an experience that integrates well with Rails 3 applications.}
+  gem.version = version
+  gem.email = "seancribbs@gmail.com"
+  gem.homepage = "http://seancribbs.github.com/ripple"
+  gem.authors = ["Sean Cribbs"]
+  gem.add_development_dependency "rspec", "~>2.0.0.beta.6"
+  gem.add_dependency "riak-client", version
+  gem.add_dependency "activesupport", "3.0.0.beta3"
+  gem.add_dependency "activemodel", "3.0.0.beta3"
+
+  files = FileList["**/*"]
+  files.exclude /\.DS_Store/
+  files.exclude /\#/
+  files.exclude /~/
+  files.exclude /\.swp/
+  files.exclude '**/._*'
+  files.exclude '**/*.orig'
+  files.exclude '**/*.rej'
+  files.exclude /^pkg/
+  files.exclude 'ripple.gemspec'
+
+  gem.files = files.to_a
+
+  gem.test_files = FileList["spec/**/*.rb"].to_a
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+# Gem packaging tasks
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rcov_opts = ['--exclude', 'lib\/spec,bin\/spec,config\/boot.rb,gems,spec_helper']
+task :gem => :gemspec
+
+desc %{Build the gemspec file.}
+task :gemspec do
+  gemspec.validate
+  File.open("#{gemspec.name}.gemspec", 'w'){|f| f.write gemspec.to_ruby }
 end
 
-task :spec => :check_dependencies
+desc %{Release the gem to RubyGems.org}
+task :release => :gem do
+  "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
 
-task :default => :spec
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-require 'yard'
-YARD::Rake::YardocTask.new do |yard|
-  docfiles = FileList['lib/**/*.rb', 'README*', 'VERSION', 'LICENSE', 'RELEASE_NOTES.textile']
-  yard.files = docfiles
-  yard.options = ["--no-private"]
+desc "Run Unit Specs Only"
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/ripple/**/*_spec.rb"
 end
 
-task :doc => :yard do
-  original_dir = Dir.pwd
-  docs_dir = File.expand_path(File.join(original_dir, "..", "ripple-docs"))
-  rm_rf File.join(docs_dir, "*")
-  cp_r File.join(original_dir, "doc", "."), docs_dir
-  touch File.join(docs_dir, '.nojekyll')
+namespace :spec do
+  desc "Run Integration Specs Only"
+  Rspec::Core::RakeTask.new(:integration) do |spec|
+    spec.pattern = "spec/integration/**/*_spec.rb"
+  end
+
+  desc "Run All Specs"
+  Rspec::Core::RakeTask.new(:all) do |spec|
+    spec.pattern = "spec/**/*_spec.rb"
+  end
 end
 
-CLOBBER.include(".yardoc")
-CLOBBER.include("doc")
+task :default => :spec

data/lib/ripple.rb

@@ -42,9 +42,13 @@ module Ripple
       Thread.current[:ripple_client] = value
     end
 
-    def config=(value)
+    def config=(hash)
       self.client = nil
       super
     end
+    
+    def load_config(config_file)
+      self.config = YAML.load_file(File.expand_path config_file).with_indifferent_access[:ripple]
+    end
   end
 end

data/lib/ripple/core_ext/casting.rb

@@ -102,6 +102,7 @@ class Time
   end
 
   def self.ripple_cast(value)
+    return nil if value.nil?
     value.respond_to?(:to_time) && value.to_time or raise Ripple::PropertyTypeMismatch.new(self, value)
   end
 end
@@ -113,6 +114,7 @@ class Date
   end
 
   def self.ripple_cast(value)
+    return nil if value.nil?
     value.respond_to?(:to_date) && value.to_date or raise Ripple::PropertyTypeMismatch.new(self, value)
   end
 end
@@ -124,6 +126,7 @@ class DateTime
   end
 
   def self.ripple_cast(value)
+    return nil if value.nil?
     value.respond_to?(:to_datetime) && value.to_datetime or raise Ripple::PropertyTypeMismatch.new(self, value)
   end
 end

data/lib/ripple/document.rb

@@ -42,8 +42,11 @@ module Ripple
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
 
+    autoload :Association, "ripple/document/associations"
+    autoload :Associations
     autoload :AttributeMethods
     autoload :BucketAccess
+    autoload :Callbacks
     autoload :Finders
     autoload :Persistence
     autoload :Properties
@@ -53,9 +56,10 @@ module Ripple
 
     included do
       extend BucketAccess
-      include Persistence
+      include Ripple::Document::Persistence
       include Ripple::EmbeddedDocument
-      include Finders
+      include Ripple::Document::Finders
     end
+
   end
 end

data/lib/ripple/document/associations.rb

@@ -0,0 +1,154 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'ripple'
+
+module Ripple
+  module Document
+    module Associations
+      extend ActiveSupport::Concern
+      extend ActiveSupport::Autoload
+
+      autoload :Proxy
+      autoload :One
+      autoload :Many
+      autoload :Embedded
+      autoload :Instantiators
+      autoload :OneEmbeddedProxy
+      autoload :ManyEmbeddedProxy
+
+      module ClassMethods
+        # @private
+        def inherited(subclass)
+          super
+          subclass.associations.merge!(associations)
+        end
+
+        # Associations defined on the document
+        def associations
+          @associations ||= {}.with_indifferent_access
+        end
+
+        # Creates a singular association
+        def one(name, options={})
+          create_association(:one, name, options)
+        end
+
+        # Creates a plural association
+        def many(name, options={})
+          create_association(:many, name, options)
+        end
+
+        private
+        def create_association(type, name, options={})
+          association = associations[name] = Association.new(type, name, options)
+
+          define_method(name) do
+            get_proxy(association)
+          end
+
+          define_method("#{name}=") do |value|
+            get_proxy(association).replace(value)
+            value
+          end
+
+          if association.one?
+            define_method("#{name}?") do
+              get_proxy(association).present?
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def associations
+          self.class.associations
+        end
+        
+        def embedded_associations
+          associations.map do |name, association|
+            association if association.embeddable?
+          end.compact
+        end
+        
+        # @private
+        def get_proxy(association)
+          unless proxy = instance_variable_get(association.ivar)
+            proxy = association.proxy_class.new(self, association)
+            instance_variable_set(association.ivar, proxy)
+          end
+          proxy
+        end
+      end
+    end
+
+    class Association
+      attr_reader :type, :name, :options
+      
+      # association options :using, :class_name, :class, :extend, 
+      # options that may be added :validate
+
+      def initialize(type, name, options={})
+        @type, @name, @options = type, name, options.to_options
+      end
+
+      def class_name
+        @class_name ||= case
+                        when @options[:class_name]
+                          @options[:class_name]
+                        when @options[:class]
+                          @options[:class].to_s
+                        when many?
+                          @name.to_s.classify
+                        else
+                          @name.to_s.camelize
+                        end
+      end
+
+      def klass
+        @klass ||= options[:class] || class_name.constantize
+      end
+
+      def many?
+        @type == :many
+      end
+
+      def one?
+        @type == :one
+      end
+      
+      def embeddable?
+        klass.embeddable?
+      end
+      
+      def polymorphic?
+        false
+      end
+
+      def ivar
+        "@_#{name}"
+      end
+      
+      def proxy_class
+        return @proxy_class if defined?(@proxy_class)
+        proxy_class_name.constantize
+      end
+
+      def proxy_class_name
+        @using   ||= options[:using] || (embeddable? ? :embedded : :link)
+        klass_name = (many? ? 'Many' : 'One') + @using.to_s.camelize + ('Polymorphic' if polymorphic?).to_s + 'Proxy'
+        "Ripple::Document::Associations::#{klass_name}"
+      end
+    end
+  end
+end

data/lib/ripple/document/{persistence/callbacks.rb → associations/embedded.rb}

@@ -15,34 +15,30 @@ require 'ripple'
 
 module Ripple
   module Document
-    module Persistence
-      module Callbacks
-        extend ActiveSupport::Concern
-
-        included do
-          extend ActiveModel::Callbacks
-          define_model_callbacks :create, :update, :save, :destroy
+    module Associations
+      module Embedded
+        
+        def initialize(*args)
+          super
+          owner.class.validates reflection.name, :associated => true
         end
-
-        module InstanceMethods
-          # @private
-          def save
-            state = new? ? :create : :update
-            run_callbacks(:save) do
-              run_callbacks(state) do
-                super
-              end
+        
+        protected
+          
+          def assign_references(docs)
+            Array(docs).each do |doc|
+              next unless doc.respond_to?(:_parent_document=)
+              doc._parent_document = owner
             end
           end
-
-          # @private
-          def destroy
-            run_callbacks(:destroy) do
-              super
-            end
+          
+          def instantiate_target(*args)
+            doc = super
+            assign_references(doc)
+            doc
           end
-        end
+        
       end
     end
   end
-end
+end

data/lib/ripple/document/associations/instantiators.rb

@@ -0,0 +1,41 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'ripple'
+
+module Ripple
+  module Document
+    module Associations
+      module Instantiators
+        
+        def build(attrs={})
+          instantiate_target(:new, attrs)
+        end
+
+        def create(attrs={})
+          instantiate_target(:create, attrs)
+        end
+
+        def create!(attrs={})
+          instantiate_target(:create!, attrs)
+        end
+        
+        protected
+          def instantiate_target
+            raise NotImplementedError
+          end
+        
+      end
+    end
+  end
+end

data/lib/{riak/util/translation.rb → ripple/document/associations/linked.rb}

@@ -11,19 +11,22 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
-require 'riak'
+require 'ripple'
 
-module Riak
-  module Util
-    module Translation
-      def i18n_scope
-        :riak
-      end
+module Ripple
+  module Document
+    module Associations
+      module Linked
+
+        def create(attrs={})
+          instantiate_target(:create, attrs)
+        end
 
-      def t(message, options={})
-        I18n.t("#{i18n_scope}.#{message}", options)
+        def create!(attrs={})
+          instantiate_target(:create!, attrs)
+        end
+        
       end
     end
   end
-end
-
+end