friendly 0.3.5 → 0.4.0

data/spec/integration/scope_chaining_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path("../../spec_helper", __FILE__)
+require "active_support/core_ext"
+
+describe "Chaining scopes together" do
+  describe "then calling #all" do
+    before do
+      User.all(:name => "Quagmire").each { |q| q.destroy }
+      @users = (0...10).map do |i|
+        User.create :name       => "Quagmire",
+                    :created_at => i.hours.ago
+      end
+    end
+
+    it "queries using a combination of both scopes" do
+      User.named_quagmire.recent.all.should == @users.slice(0, 3)
+    end
+
+    it "gives scopes on the right priority" do
+      User.named_joe.named_quagmire.first.name.should == "Quagmire"
+    end
+  end
+end

data/spec/integration/table_creator_spec.rb

@@ -7,16 +7,20 @@ describe "Creating the tables for a model" do
 
       def self.table_name; "stuffs"; end
 
-      attribute :name, String
+      attribute :name,    String
+      attribute :user_id, Friendly::UUID
 
       indexes [:name, :created_at]
+      indexes :user_id
     end
 
     @klass.create_tables!
-    @schema       = Friendly.db.schema(:stuffs)
-    @table        = Hash[*@schema.map { |s| [s.first, s.last] }.flatten]
-    @index_schema = Friendly.db.schema(:index_stuffs_on_name_and_created_at)
-    @index_table  = Hash[*@index_schema.map { |s| [s.first, s.last] }.flatten]
+    @schema         = Friendly.db.schema(:stuffs)
+    @table          = Hash[*@schema.map { |s| [s.first, s.last] }.flatten]
+    @index_schema   = Friendly.db.schema(:index_stuffs_on_name_and_created_at)
+    @index_table    = Hash[*@index_schema.map { |s| [s.first, s.last] }.flatten]
+    @id_idx_schema  = Friendly.db.schema(:index_stuffs_on_user_id)
+    @id_index_table = Hash[*@id_idx_schema.map { |s| [s.first, s.last] }.flatten]
   end
 
   after do
@@ -44,6 +48,14 @@ describe "Creating the tables for a model" do
     @index_table[:id][:primary_key].should be_true
   end
 
+  it "knows how to create an index for a field of a custom type" do
+    @id_index_table.keys.length.should == 2
+    @id_index_table[:user_id][:db_type].should == "binary(16)"
+    @id_index_table[:user_id][:primary_key].should be_true
+    @id_index_table[:id][:db_type].should == "binary(16)"
+    @id_index_table[:id][:primary_key].should be_true
+  end
+
   it "doesn't raise if the tables already exist" do
     lambda {
       @klass.create_tables!

data/spec/spec_helper.rb

@@ -7,13 +7,14 @@ require 'rubygems'
 require 'spec'
 require 'spec/autorun'
 require 'sequel'
-require 'json'
+require 'json/pure'
 gem     'jferris-mocha'
 require 'mocha'
 require 'memcached'
 require 'friendly'
 
-Friendly.configure "mysql://root@localhost/friendly_test"
+config = YAML.load(File.read(File.dirname(__FILE__) + "/config.yml"))['test']
+Friendly.configure config
 $db = Friendly.db
 Sequel::MySQL.default_engine = "InnoDB"
 
@@ -32,13 +33,25 @@ Friendly.cache     = Friendly::Memcached.new($cache)
 class User
   include Friendly::Document
 
-  attribute :name,  String
-  attribute :age,   Integer
-  attribute :happy, Friendly::Boolean, :default => true
-  attribute :sad,   Friendly::Boolean, :default => false
+  attribute :name,       String
+  attribute :age,        Integer
+  attribute :happy,      Friendly::Boolean, :default => true
+  attribute :sad,        Friendly::Boolean, :default => false
+  attribute :friend,     Friendly::UUID
 
+  indexes   :happy
+  indexes   :friend
   indexes   :name
   indexes   :name, :created_at
+
+  named_scope :named_joe,      :name   => "Joe"
+  named_scope :named_quagmire, :name   => "Quagmire"
+  named_scope :recent,         :order! => :created_at.desc,
+                               :limit! => 3
+
+  has_many    :addresses
+  has_many    :addresses_override, :class_name  => "Address",
+                                   :foreign_key => :user_id
 end
 
 User.create_tables!

data/spec/unit/associations/association_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+describe "Friendly::Associations::Association" do
+  before do
+    @owner_klass = stub(:name => "User")
+    @klass       = stub
+    # FIXME: ugh.
+    String.any_instance.stubs(:constantize).returns(@klass)
+    @assoc_klass = Friendly::Associations::Association
+  end
+
+  describe "with defaults" do
+    before do
+      @association = @assoc_klass.new(@owner_klass, :addresses)
+    end
+
+    it "has a default klass of name.classify.constantize" do
+      @association.klass.should == @klass
+    end
+
+    it "has a foreign_key of owner_klass.name.singularize + '_id'" do
+      @association.foreign_key.should == :user_id
+    end
+
+    it "returns a scope on klass of {:foreign_key => document.id}" do
+      @scope = stub
+      @klass.stubs(:scope).with(:user_id => 42).returns(@scope)
+
+      @association.scope(stub(:id => 42)).should == @scope
+    end
+  end
+
+  describe "with overridden attributes" do
+    before do
+      @klass      = stub
+      @class_name = "SomeOtherClass"
+      @class_name.stubs(:constantize).returns(@klass)
+      @association = @assoc_klass.new @owner_klass, :whatever, 
+                                      :class_name  => @class_name,
+                                      :foreign_key => :other_id
+    end
+
+    it "uses the overridden class_name to get the class" do
+      @association.klass.should == @klass
+    end
+
+    it "uses the overridden foreign_key" do
+      @association.foreign_key.should == :other_id
+    end
+
+    it "uses the override foreign_key in the scope" do
+      @scope = stub
+      @klass.stubs(:scope).with(:other_id => 42).returns(@scope)
+      @association.scope(stub(:id => 42)).should == @scope
+    end
+  end
+end

data/spec/unit/associations/set_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+describe "Friendly::Associations::Set" do
+  before do
+    @klass             = Class.new
+    @association_klass = stub
+    @set               = Friendly::Associations::Set.new(@klass, @association_klass)
+    @assoc             = stub
+    @association_klass.stubs(:new).
+      with(@klass, :my_awesome_association, {}).returns(@assoc)
+  end
+
+  describe "adding an association" do
+    before do
+      @set.add(:my_awesome_association)
+    end
+
+    it "creates an association and adds it to its hash by name" do
+      @set.associations[:my_awesome_association].should == @assoc
+    end
+
+    it "adds an instance method to the klass through which to acces the assoc" do
+      @doc   = @klass.new
+      @scope = stub
+      @klass.stubs(:association_set).returns(@set)
+      @assoc.stubs(:scope).with(@doc).returns(@scope)
+      @doc.my_awesome_association.should == @scope
+    end
+  end
+
+  it "can return the association by name" do
+    @set.add(:my_awesome_association)
+    @set.get(:my_awesome_association).should == @assoc
+  end
+
+  it "provides the scope for an association by name" do
+    @doc   = stub
+    @scope = stub
+    @assoc.stubs(:scope).with(@doc).returns(@scope)
+    @set.add(:my_awesome_association)
+    @set.get_scope(:my_awesome_association, @doc).should == @scope
+  end
+end

data/spec/unit/attribute_spec.rb

@@ -61,4 +61,45 @@ describe "Friendly::Attribute" do
   it "has a default value even if it's false" do
     @false.default.should be_false
   end
+
+  describe "registering a type" do
+    before do
+      @klass = Class.new
+      Friendly::Attribute.register_type(@klass, "binary(16)") { |t| t.to_i }
+    end
+
+    after { Friendly::Attribute.deregister_type(@klass) }
+
+    it "tells Attribute about the sql_type" do
+      Friendly::Attribute.sql_type(@klass).should == "binary(16)"
+    end
+
+    it "registers the conversion method" do
+      Friendly::Attribute.new(@klass, :something, @klass).convert("1").should == 1
+    end
+
+    it "is custom_type?(@klass)" do
+      Friendly::Attribute.should be_custom_type(@klass)
+    end
+  end
+
+  describe "deregistering a type" do
+    before do
+      @klass = Class.new
+      Friendly::Attribute.register_type(@klass, "whatever") {}
+      Friendly::Attribute.deregister_type(@klass)
+    end
+
+    it "removes the converter method" do
+      Friendly::Attribute.converters.should_not be_has_key(@klass)
+    end
+
+    it "removes the sql_type" do
+      Friendly::Attribute.sql_types.should_not be_has_key(@klass)
+    end
+
+    it "is not custom_type?(@klass)" do
+      Friendly::Attribute.should_not be_custom_type(@klass)
+    end
+  end
 end

data/spec/unit/document_spec.rb

@@ -307,5 +307,52 @@ describe "Friendly::Document" do
       @collection.should have_received(:replace).with(@docs)
     end
   end
+
+  describe "creating a named_scope" do
+    before do
+      @scope_proxy           = stub(:add_named => nil)
+      @klass.scope_proxy     = @scope_proxy
+      @klass.named_scope(:by_name, :order => :name)
+    end
+
+    it "asks the named_scope_set to add it" do
+      @klass.scope_proxy.should have_received(:add_named).
+                                  with(:by_name, :order => :name)
+    end
+  end
+
+  describe "Document.has_named_scope?" do
+    it "delegates to the scope_proxy" do
+      @scope_proxy       = stub
+      @scope_proxy.stubs(:has_named_scope?).with(:whatever).returns(true)
+      @klass.scope_proxy = @scope_proxy
+      @klass.has_named_scope?(:whatever).should be_true
+    end
+  end
+
+  describe "accessing an ad-hoc scope" do
+    before do
+      @scope             = stub
+      @scope_proxy       = stub
+      @scope_proxy.stubs(:ad_hoc).with(:order! => :name).returns(@scope)
+      @klass.scope_proxy = @scope_proxy
+    end
+
+    it "asks the named_scope_set to add it" do
+      @klass.scope(:order! => :name).should == @scope
+    end
+  end
+
+  describe "adding an association" do
+    before do
+      @assoc_set             = stub(:add => nil)
+      @klass.association_set = @assoc_set
+      @klass.has_many :addresses
+    end
+
+    it "asks the association set to add it" do
+      @assoc_set.should have_received(:add).with(:addresses, {})
+    end
+  end
 end
 

data/spec/unit/named_scope_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "Friendly::NamedScope" do
+  before do
+    @klass       = stub
+    @scope       = stub
+    @scope_klass = stub
+    @parameters  = {:name => "James"}
+    @scope_klass.stubs(:new).with(@klass, @parameters).returns(@scope)
+    @named_scope = Friendly::NamedScope.new(@klass, @parameters, @scope_klass)
+  end
+
+  it "provides scope instances with the given parameters" do
+    @named_scope.scope.should == @scope
+  end
+end

data/spec/unit/scope_proxy_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "Friendly::ScopeProxy" do
+  before do
+    @klass             = Class.new
+    @scope             = stub
+    @scope_klass       = stub
+    @scope_proxy       = Friendly::ScopeProxy.new(@klass, @scope_klass)
+    @params            = {:order! => :created_at.desc}
+    @scope_klass.stubs(:new).with(@klass, @params).returns(@scope)
+    @klass.stubs(:scope_proxy).returns(@scope_proxy)
+    @scope_proxy.add_named(:recent, @params)
+  end
+
+  it "returns false for has_named_scope if it doesnt have one by that name" do
+    @scope_proxy.should_not be_has_named_scope(:whatever)
+  end
+
+  describe "adding a scope" do
+    it "adds a scope by that name to the set" do
+      @scope_proxy.get(:recent).should == @params
+    end
+
+    it "adds a method to the klass that returns an instance of the scope" do
+      @klass.recent.should == @scope
+    end
+
+    it "returns true for #has_named_scope?(name)" do
+      @scope_proxy.should be_has_named_scope(:recent)
+    end
+  end
+
+  describe "getting an instance of a scope" do
+    it "instantiates Scope" do
+      @scope_proxy.get_instance(:recent).should == @scope
+    end
+  end
+
+  describe "accessing an ad_hoc scope" do
+    it "instantiates Scope" do
+      @scope_proxy.ad_hoc(@params).should == @scope
+    end
+  end
+end

data/spec/unit/scope_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "Friendly::Scope" do
+  before do
+    @klass            = stub
+    @scope_parameters = {:name => "Quagmire", :order! => :created_at.desc}
+    @scope            = Friendly::Scope.new(@klass, @scope_parameters)
+  end
+
+  describe "#all" do
+    before do
+      @documents = stub
+    end
+
+    it "delegates to klass with the scope parameters" do
+      @klass.stubs(:all).with(@scope_parameters).returns(@documents)
+      @scope.all.should == @documents
+    end
+
+    it "merges additional parameters" do
+      merged = @scope_parameters.merge(:name => "Joe")
+      @klass.stubs(:all).with(merged).returns(@documents)
+      @scope.all(:name => "Joe").should == @documents
+    end
+  end
+
+  describe "#first" do
+    before do
+      @document = stub
+    end
+
+    it "delegates to klass with the scope parameters" do
+      @klass.stubs(:first).with(@scope_parameters).returns(@document)
+      @scope.first.should == @document
+    end
+
+    it "merges additional parameters" do
+      merged = @scope_parameters.merge(:name => "Joe")
+      @klass.stubs(:first).with(merged).returns(@document)
+      @scope.first(:name => "Joe").should == @document
+    end
+  end
+
+  describe "#paginate" do
+    before do
+      @documents = stub
+    end
+
+    it "delegates to klass with the scope parameters" do
+      @klass.stubs(:paginate).with(@scope_parameters).returns(@documents)
+      @scope.paginate.should == @documents
+    end
+
+    it "merges additional parameters" do
+      merged = @scope_parameters.merge(:name => "Joe")
+      @klass.stubs(:paginate).with(merged).returns(@documents)
+      @scope.paginate(:name => "Joe").should == @documents
+    end
+  end
+
+  describe "#build" do
+    it "instantiates klass with the scope parameters (minus modifiers)" do
+      @doc = stub
+      @klass.stubs(:new).with(:name => "Quagmire").returns(@doc)
+      @scope.build.should == @doc
+    end
+
+    it "merges additional parameters" do
+      @doc = stub
+      @klass.stubs(:new).with(:name => "Fred").returns(@doc)
+      @scope.build(:name => "Fred").should == @doc
+    end
+  end
+
+  describe "#create" do
+    it "delegates to klass#create with the scope parameters (minus modifiers)" do
+      @doc = stub
+      @klass.stubs(:create).with(:name => "Quagmire").returns(@doc)
+      @scope.create.should == @doc
+    end
+
+    it "merges additional parameters" do
+      @doc = stub
+      @klass.stubs(:create).with(:name => "Fred").returns(@doc)
+      @scope.create(:name => "Fred").should == @doc
+    end
+  end
+
+  describe "chaining another named scope" do
+    before do
+      @recent_params = {:order! => :created_at.desc}
+      @recent        = Friendly::Scope.new(@klass, @recent_params)
+      @klass.stubs(:has_named_scope?).with(:recent).returns(true)
+      @klass.stubs(:recent).returns(@recent)
+      @scope_params  = {:name => "Joe"}
+      @scope         = Friendly::Scope.new(@klass, @scope_params)
+    end
+
+    it "responds to the other scope method" do
+      @scope.should be_respond_to(:recent)
+    end
+
+    it "creates a new scope that merges the two scopes together" do
+      merged_parameters = @scope_params.merge(@recent_params)
+      @scope.recent.parameters.should == merged_parameters
+    end
+
+    it "gives precedence to scopes on the right" do
+      @quagmire = Friendly::Scope.new(@klass, :name => "Quagmire")
+      (@scope + @quagmire).parameters[:name].should == "Quagmire"
+    end
+  end
+end