fcoury-mongomapper 0.2.0

data/lib/mongomapper/observing.rb

@@ -0,0 +1,50 @@
+require 'observer'
+require 'singleton'
+require 'set'
+
+module MongoMapper
+  module Observing #:nodoc:
+    def self.included(model)
+      model.class_eval do
+        extend Observable
+      end      
+    end
+  end
+
+  class Observer
+    include Singleton
+
+    class << self
+      def observe(*models)
+        models.flatten!
+        models.collect! { |model| model.is_a?(Symbol) ? model.to_s.camelize.constantize : model }
+        define_method(:observed_classes) { Set.new(models) }
+      end
+
+      def observed_class
+        if observed_class_name = name[/(.*)Observer/, 1]
+          observed_class_name.constantize
+        else
+          nil
+        end
+      end
+    end
+
+    def initialize
+      Set.new(observed_classes).each { |klass| add_observer! klass }
+    end
+
+    def update(observed_method, object) #:nodoc:
+      send(observed_method, object) if respond_to?(observed_method)
+    end
+
+    protected
+      def observed_classes
+        Set.new([self.class.observed_class].compact.flatten)
+      end
+      
+      def add_observer!(klass)
+        klass.add_observer(self)
+      end
+  end
+end

data/lib/mongomapper/save_with_validation.rb

@@ -0,0 +1,19 @@
+module MongoMapper
+  module SaveWithValidation
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :save, :validation
+        alias_method_chain :save!, :validation
+      end
+    end
+    
+    private
+      def save_with_validation
+        valid? ? save_without_validation : false
+      end
+      
+      def save_with_validation!
+        valid? ? save_without_validation! : raise(DocumentNotValid.new(self))
+      end
+  end  
+end

data/lib/mongomapper/serialization.rb

@@ -0,0 +1,55 @@
+require 'active_support/json'
+
+module MongoMapper #:nodoc:
+  module Serialization
+    class Serializer #:nodoc:
+      attr_reader :options
+
+      def initialize(record, options = {})
+        @record, @options = record, options.dup
+      end
+
+      def serializable_key_names
+        key_names = @record.send :defined_key_names
+
+        if options[:only]
+          options.delete(:except)
+          key_names = key_names & Array(options[:only]).collect { |n| n.to_s }
+        else
+          options[:except] = Array(options[:except])
+          key_names = key_names - options[:except].collect { |n| n.to_s }
+        end
+
+        key_names
+      end
+
+      def serializable_method_names
+        Array(options[:methods]).inject([]) do |method_attributes, name|
+          method_attributes << name if @record.respond_to?(name.to_s)
+          method_attributes
+        end
+      end
+
+      def serializable_names
+        serializable_key_names + serializable_method_names
+      end
+
+      def serializable_record
+        returning(serializable_record = {}) do
+          serializable_names.each { |name| serializable_record[name] = @record.send(name) }
+        end
+      end
+
+      def serialize
+        # overwrite to implement
+      end
+
+      def to_s(&block)
+        serialize(&block)
+      end
+    end
+  end
+end
+
+dir = Pathname(__FILE__).dirname.expand_path + 'serializers'
+require dir + 'json_serializer'

data/lib/mongomapper/serializers/json_serializer.rb

@@ -0,0 +1,77 @@
+module MongoMapper #:nodoc:
+  module Serialization
+    def self.included(base)
+      base.cattr_accessor :include_root_in_json, :instance_writer => false
+      base.extend ClassMethods
+    end
+
+    # Returns a JSON string representing the model. Some configuration is
+    # available through +options+.
+    #
+    # The option <tt>include_root_in_json</tt> controls the top-level behavior of
+    # to_json. When it is <tt>true</tt>, to_json will emit a single root node named
+    # after the object's type. For example:
+    #
+    #   konata = User.find(1)
+    #   User.include_root_in_json = true
+    #   konata.to_json
+    #   # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16,
+    #                   "created_at": "2006/08/01", "awesome": true} }
+    #
+    #   User.include_root_in_json = false
+    #   konata.to_json
+    #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
+    #         "created_at": "2006/08/01", "awesome": true}
+    #
+    # The remainder of the examples in this section assume include_root_in_json is set to
+    # <tt>false</tt>.
+    #
+    # Without any +options+, the returned JSON string will include all
+    # the model's attributes. For example:
+    #
+    #   konata = User.find(1)
+    #   konata.to_json
+    #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
+    #         "created_at": "2006/08/01", "awesome": true}
+    #
+    # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the attributes
+    # included, and work similar to the +attributes+ method. For example:
+    #
+    #   konata.to_json(:only => [ :id, :name ])
+    #   # => {"id": 1, "name": "Konata Izumi"}
+    #
+    #   konata.to_json(:except => [ :id, :created_at, :age ])
+    #   # => {"name": "Konata Izumi", "awesome": true}
+    #
+    # To include any methods on the model, use <tt>:methods</tt>.
+    #
+    #   konata.to_json(:methods => :permalink)
+    #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
+    #         "created_at": "2006/08/01", "awesome": true,
+    #         "permalink": "1-konata-izumi"}
+    def to_json(options = {})
+      if include_root_in_json
+        "{#{self.class.json_class_name}: #{JsonSerializer.new(self, options).to_s}}"
+      else
+        JsonSerializer.new(self, options).to_s
+      end
+    end
+
+    def from_json(json)
+      self.attributes = ActiveSupport::JSON.decode(json)
+      self
+    end
+
+    class JsonSerializer < MongoMapper::Serialization::Serializer #:nodoc:
+      def serialize
+        serializable_record.to_json
+      end
+    end
+
+    module ClassMethods
+      def json_class_name
+        @json_class_name ||= name.demodulize.underscore.inspect
+      end
+    end
+  end
+end

data/lib/mongomapper/validations.rb

@@ -0,0 +1,47 @@
+module MongoMapper
+  module Validations
+    class ValidatesUniquenessOf < Validatable::ValidationBase
+      def valid?(instance)
+        # TODO: scope
+        doc = instance.class.find(:first, :conditions => {self.attribute => instance[attribute]}, :limit => 1)
+        doc.nil? || instance.id == doc.id
+      end
+
+      def message(instance)
+        super || "has already been taken"
+      end
+    end
+    
+    class ValidatesExclusionOf < Validatable::ValidationBase
+      required_option :within
+      
+      def valid?(instance)
+        value = instance[attribute]
+        return true if allow_nil && value.nil?
+        return true if allow_blank && value.blank?
+        
+        !within.include?(instance[attribute])
+      end
+      
+      def message(instance)
+        super || "is reserved"
+      end
+    end
+
+    class ValidatesInclusionOf < Validatable::ValidationBase
+      required_option :within
+      
+      def valid?(instance)
+        value = instance[attribute]
+        return true if allow_nil && value.nil?
+        return true if allow_blank && value.blank?
+        
+        within.include?(value)
+      end
+      
+      def message(instance)
+        super || "is not in the list"
+      end
+    end
+  end
+end

data/mongomapper.gemspec

@@ -0,0 +1,105 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongomapper}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2009-07-07}
+  s.email = %q{nunemaker@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mongomapper.rb",
+     "lib/mongomapper/associations.rb",
+     "lib/mongomapper/associations/array_proxy.rb",
+     "lib/mongomapper/associations/base.rb",
+     "lib/mongomapper/associations/belongs_to_proxy.rb",
+     "lib/mongomapper/associations/has_many_embedded_proxy.rb",
+     "lib/mongomapper/associations/has_many_proxy.rb",
+     "lib/mongomapper/associations/polymorphic_belongs_to_proxy.rb",
+     "lib/mongomapper/associations/proxy.rb",
+     "lib/mongomapper/callbacks.rb",
+     "lib/mongomapper/document.rb",
+     "lib/mongomapper/embedded_document.rb",
+     "lib/mongomapper/finder_options.rb",
+     "lib/mongomapper/key.rb",
+     "lib/mongomapper/observing.rb",
+     "lib/mongomapper/document_rails_compatibility.rb",
+     "lib/mongomapper/embedded_document_rails_compatibility.rb",
+     "lib/mongomapper/save_with_validation.rb",
+     "lib/mongomapper/serialization.rb",
+     "lib/mongomapper/serializers/json_serializer.rb",
+     "lib/mongomapper/validations.rb",
+     "mongomapper.gemspec",
+     "test/serializers/test_json_serializer.rb",
+     "test/test_associations.rb",
+     "test/test_callbacks.rb",
+     "test/test_document.rb",
+     "test/test_embedded_document.rb",
+     "test/test_finder_options.rb",
+     "test/test_helper.rb",
+     "test/test_key.rb",
+     "test/test_mongomapper.rb",
+     "test/test_observing.rb",
+     "test/test_rails_compatibility.rb",
+     "test/test_serializations.rb",
+     "test/test_validations.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jnunemaker/mongomapper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mongomapper}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Awesome gem for modeling your domain and storing it in mongo}
+  s.test_files = [
+    "test/serializers/test_json_serializer.rb",
+     "test/test_associations.rb",
+     "test/test_callbacks.rb",
+     "test/test_document.rb",
+     "test/test_embedded_document.rb",
+     "test/test_finder_options.rb",
+     "test/test_helper.rb",
+     "test/test_key.rb",
+     "test/test_mongomapper.rb",
+     "test/test_observing.rb",
+     "test/test_rails_compatibility.rb",
+     "test/test_serializations.rb",
+     "test/test_validations.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<mongodb-mongo>, ["= 0.9"])
+      s.add_runtime_dependency(%q<jnunemaker-validatable>, ["= 1.7.1"])
+      s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<mongodb-mongo>, ["= 0.9"])
+      s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.1"])
+      s.add_dependency(%q<mocha>, ["= 0.9.4"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<mongodb-mongo>, ["= 0.9"])
+    s.add_dependency(%q<jnunemaker-validatable>, ["= 1.7.1"])
+    s.add_dependency(%q<mocha>, ["= 0.9.4"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+  end
+end

data/test/serializers/test_json_serializer.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+class JsonSerializationTest < Test::Unit::TestCase
+  class Contact
+    include MongoMapper::EmbeddedDocument
+    key :name, String
+    key :age, Integer
+    key :created_at, Time
+    key :awesome, Boolean
+    key :preferences, Hash
+  end
+  
+  def setup
+    Contact.include_root_in_json = false
+    @contact = Contact.new(
+      :name        => 'Konata Izumi',
+      :age         => 16,
+      :created_at  => Time.utc(2006, 8, 1),
+      :awesome     => true,
+      :preferences => { :shows => 'anime' }
+    )
+  end
+  
+  should "include demodulized root" do
+    Contact.include_root_in_json = true
+    assert_match %r{^\{"contact": \{}, @contact.to_json
+  end
+  
+  should "encode all encodable attributes" do
+    json = @contact.to_json
+
+    assert_match %r{"name": "Konata Izumi"}, json
+    assert_match %r{"age": 16}, json
+    assert json.include?(%("created_at": #{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))}))
+    assert_match %r{"awesome": true}, json
+    assert_match %r{"preferences": \{"shows": "anime"\}}, json
+  end
+  
+  should "allow attribute filtering with only" do
+    json = @contact.to_json(:only => [:name, :age])
+
+    assert_match %r{"name": "Konata Izumi"}, json
+    assert_match %r{"age": 16}, json
+    assert_no_match %r{"awesome"}, json
+    assert_no_match %r{"created_at"}, json
+    assert_no_match %r{"preferences"}, json
+  end
+  
+  should "allow attribute filtering with except" do
+    json = @contact.to_json(:except => [:name, :age])
+
+    assert_no_match %r{"name"}, json
+    assert_no_match %r{"age"}, json
+    assert_match %r{"awesome"}, json
+    assert_match %r{"created_at"}, json
+    assert_match %r{"preferences"}, json
+  end
+  
+  context "including methods" do
+    setup do
+      def @contact.label; "Has cheezburger"; end
+      def @contact.favorite_quote; "Constraints are liberating"; end
+    end
+    
+    should "include single method" do
+      # Single method.
+      assert_match %r{"label": "Has cheezburger"}, @contact.to_json(:only => :name, :methods => :label)
+    end
+    
+    should "include multiple methods" do
+      json = @contact.to_json(:only => :name, :methods => [:label, :favorite_quote])
+      assert_match %r{"label": "Has cheezburger"}, json
+      assert_match %r{"favorite_quote": "Constraints are liberating"}, json
+    end
+  end
+  
+  context "array of records" do
+    setup do
+      @contacts = [
+        Contact.new(:name => 'David', :age => 39),
+        Contact.new(:name => 'Mary', :age => 14)
+      ]
+    end
+
+    should "allow attribute filtering with only" do
+      assert_equal %([{"name": "David"}, {"name": "Mary"}]), @contacts.to_json(:only => :name)
+    end
+    
+    should "allow attribute filtering with except" do
+      json = @contacts.to_json(:except => [:name, :preferences, :awesome, :created_at])
+      assert_equal %([{"age": 39}, {"age": 14}]), json
+    end
+  end
+  
+  should "allow options for hash of records" do
+    contacts = {
+      1 => Contact.new(:name => 'David', :age => 39),
+      2 => Contact.new(:name => 'Mary', :age => 14)
+    }
+
+    assert_equal %({"1": {"name": "David"}}), contacts.to_json(:only => [1, :name])
+  end
+  
+end