noodall-core 0.7.5 → 0.8.0

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm: 1.9.2
+env: DB=mongodb

data/lib/noodall/component.rb

@@ -1,45 +1,41 @@
 module Noodall
   class Component
     include MongoMapper::EmbeddedDocument
-    
+
     key :_type, String
     key :style, String
-  
+
     embedded_in :node
-  
+
     module ClassMethods
       def possible_slots
         Node.possible_slots
       end
 
       def allowed_positions(*args)
-        @allowed_positions = args.reject{|a| !Node.possible_slots.include?(a) }.uniq
-      end
-  
-      def positions
-        @allowed_positions || []
+        warn "[DEPRECATION] `allowed_positions` is deprecated. Please use `Noodall::Node.slot` instead."
+        allowed_positions = args.reject{|a| !Node.possible_slots.include?(a) }.uniq
+
+        allowed_positions.each do |p|
+          Node.send("#{p}_slot_components") << self
+        end
       end
-  
+
       def positions_classes(position)
-        classes = []
-        ObjectSpace.each_object(Class) do |c|
-          next unless c.ancestors.include?(Component) and (c != Component) and c.positions.include?(position)
-          classes << c
-        end
-        classes
+        Node.send("#{position}_slot_components")
       end
-  
+
       def positions_names(position)
         positions_classes(position).collect{|c| c.name.titleize }
       end
-  
+
       # Allow us to set the component to nil if we get a blank
       def to_mongo(value)
         return nil if value.blank?
         super
       end
-  
+
     end
     extend ClassMethods
-  end  
+  end
 end

data/lib/noodall/core/version.rb

@@ -1,5 +1,5 @@
 module Noodall
   module Core
-    VERSION = "0.7.5"
+    VERSION = "0.8.0"
   end
 end

data/lib/noodall/node.rb

@@ -317,6 +317,8 @@ module Noodall
     class << self
       @@slots = []
 
+      # <b>DEPRECATED:</b> Please use <tt>slot</tt> instead.
+      #
       # Set the names of the slots that will be avaiable to fill with components
       # For each name new methods will be created;
       #
@@ -325,21 +327,56 @@ module Noodall
       #   <name>_slots_count(count)
       #   Reads back the count you set
       def slots(*args)
-        @@slots = args.map(&:to_sym).uniq
+        warn "[DEPRECATION] `slots` is deprecated.  Please use `slot` instead."
+        slots = args.map(&:to_sym).uniq
+
+        slots.each do |s|
+          slot(s)
+        end
+      end
 
-        @@slots.each do |slot|
-          puts "Noodall::Node Defined slot: #{slot}"
-          define_singleton_method("#{slot}_slots") do |count|
-            instance_variable_set("@#{slot}_slots_count", count)
+      # Define a slot type and what components are allowed to be place in that
+      # slot type.
+      #
+      # Generates methods in Noodall::Node models that allow you to set and read the
+      # number of slots of the name defined
+      #
+      #   Noodall::Node.slot :small, Gallery, Picture
+      #
+      #   class NicePage < Noodall::Node
+      #     small_slots 3
+      #   end
+      #
+      #   NicePage.small_slots_count  # => 3
+      #
+      #   n = NicePage.new
+      #   n.small_slot_0 = Gallery.new(...)
+      #
+      def slot(slot_name, *allowed_components)
+        if @@slots.include?(slot_name.to_sym)
+          warn "[WARNING] Overriding slot definition"
+        else
+          @@slots << slot_name.to_sym
+          puts "Noodall::Node Defined slot: #{slot_name}"
+          define_singleton_method("#{slot_name}_slots") do |count|
+            instance_variable_set("@#{slot_name}_slots_count", count)
             count.times do |i|
-              slot_sym = "#{slot}_slot_#{i}".to_sym
+              slot_sym = "#{slot_name}_slot_#{i}".to_sym
               key slot_sym, Noodall::Component
-              validates slot_sym, :slot => { :slot_type => slot }
+              validates slot_sym, :slot => { :slot_type => slot_name }
               validates_associated slot_sym
             end
           end
-          define_singleton_method("#{slot}_slots_count") { instance_variable_get("@#{slot}_slots_count") }
+
+          define_singleton_method("#{slot_name}_slot_components") do
+            class_variable_get "@@#{slot_name}_slot_components".to_sym
+          end
+
+          define_singleton_method("#{slot_name}_slots_count") do
+            instance_variable_get("@#{slot_name}_slots_count")
+          end
         end
+        class_variable_set "@@#{slot_name}_slot_components".to_sym, allowed_components
       end
 
       def slots_count
@@ -365,49 +402,60 @@ module Noodall
         @template_classes || []
       end
 
-      def root_templates
-        return @root_templates if @root_templates
-        classes = []
-        ObjectSpace.each_object(Class) do |c|
-          next unless c.ancestors.include?(Noodall::Node) and (c != Noodall::Node) and c.root_template?
-          classes << c
-        end
-        @root_templates = classes
-      end
-
       def template_names
-        template_classes.collect{|c| c.name.titleize}.sort
+        template_classes.map{|c| c.name.titleize }.sort
       end
 
+      # Returns a lst of all node template classes available in
+      # in the tree
       def all_template_classes
         templates = []
-        template_classes.each do |template|
+        root_templates.each do |template|
           templates << template
           templates = templates + template.template_classes
         end
-        templates.uniq.collect{ |c| c.name.titleize }.sort
+        templates.uniq
       end
 
+      def all_template_names
+        all_template_classes.map{|c| c.name.titleize }.sort
+      end
+
+      # Set the Node templates that can be a child  of this templates
+      # in the tree
       def sub_templates(*arr)
         @template_classes = arr
       end
 
+      @@root_templates = []
+
+      # Set the Node templates that can be a root of a tree
+      #
+      # Noodall::Node.root_templates Home, LandingPage
+      #
+      # Returns a list of the root templates
+      #
+      # Noodall::Node.root_templates # => [Home, LandingPage]
+      def root_templates(*templates)
+        @@root_templates = templates unless templates.empty?
+        @@root_templates
+      end
+
+      # <b>DEPRECATED:</b> Please use <tt>root_templates/tt> instead.
       def root_template!
-        @root_template = true
+        warn "[DEPRECATION] `root_template` is deprecated.  Please use `root_templates` instead."
+        @@root_templates << self
       end
 
       def root_template?
-        @root_template
+        @@root_templates.include?(self)
       end
 
       # Returns a list of classes that can have this model as a child
       def parent_classes
-        classes = []
-        ObjectSpace.each_object(Class) do |c|
-          next unless c.ancestors.include?(Noodall::Node) and (c != Noodall::Node) and c.template_classes.include?(self)
-          classes << c
+        all_template_classes.find_all do |c|
+          c.template_classes.include?(self)
         end
-        classes
       end
 
       # If rails style time zones are unavaiable fallback to standard now
@@ -418,7 +466,9 @@ module Noodall
 
     class SlotValidator < ActiveModel::EachValidator
       def validate_each(record, attribute, value)
-        record.errors[attribute] << "cannnot contain  #{value.class.name.humanize}" unless value.nil? or Noodall::Component.positions_classes(options[:slot_type]).include?(value.class)
+        unless value.nil? or Noodall::Component.positions_classes(options[:slot_type]).one?{|c| c.name == value._type }
+          record.errors[attribute] << "cannnot contain a #{value.class.name.humanize} component"
+        end
       end
     end
 

data/spec/component_spec.rb

@@ -2,46 +2,74 @@ require 'spec_helper'
 
 describe Noodall::Component do
 
-  it "should allow you to define the slots that are available" do
-    Noodall::Node.slots :wide, :small, :main
+  it "should list components classes avaiable to a slot (deprecated)" do
+    class DListedComponent < Noodall::Component
+      allowed_positions :dsmall, :dwide
+    end
 
-    Noodall::Component.possible_slots.should == [:wide, :small, :main]
+    Noodall::Node.dsmall_slot_components.should include(DListedComponent)
+    Noodall::Node.dmain_slot_components.should_not include(DListedComponent)
+  end
 
-    class Promo < Noodall::Component
-      allowed_positions :small, :wide, :main, :egg, :nog
+  it "should list components classes avaiable to a slot" do
+    class ListedComponent < Noodall::Component
     end
 
-    Promo.positions.should have(3).things
+    Noodall::Node.slot :small, ListedComponent, Content
+    Noodall::Node.slot :main, Content
+
+    Noodall::Node.small_slot_components.should include(ListedComponent)
+    Noodall::Node.main_slot_components.should_not include(ListedComponent)
   end
 
-  it "should list components classes avaiable to a slot" do
+  it "should be validated by the node (deprecated)" do
+    Noodall::Node.slots :wide, :small, :main
 
-    class Promo < Noodall::Component
+    class DValidatedComponent < Noodall::Component
       allowed_positions :small, :wide
     end
 
-    Promo.positions.should have(2).things
+    class DValidatedNode < Noodall::Node
+      main_slots 3
+    end
+
+    node = DValidatedNode.new :title => "Slot Node"
+    node.main_slot_0 = DValidatedComponent.new
+
+    node.save
 
-    Noodall::Component.positions_classes(:small).should include(Promo)
-    Noodall::Component.positions_classes(:main).should_not include(Promo)
+    node.errors.should have(1).things
   end
 
   it "should be validated by the node" do
-    class Promo < Noodall::Component
-      allowed_positions :small, :wide
+    class ValidatedComponent < Noodall::Component
+    end
+
+    Noodall::Node.slot :middle, ValidatedComponent
+    Noodall::Node.slot :main, Content
+
+    class ValidatedNode < Noodall::Node
+      main_slots 1
     end
 
-    node = Factory(:page)
-    node.main_slot_0 = Promo.new()
-  
+    node = ValidatedNode.new :title => "Slot Node"
+    node.main_slot_0 = ValidatedComponent.new
+
     node.save
-  
+
     node.errors.should have(1).things
   end
 
   it "should know it's node" do
-    node = Factory(:page)
-    node.small_slot_0 = Factory(:content) 
+    Noodall::Node.slot :small, Content
+
+    class KnowingNode < Noodall::Node
+      small_slots 3
+    end
+
+    node = KnowingNode.new :title => "Slot Node"
+
+    node.small_slot_0 = Factory(:content)
 
     node.save!
 

data/spec/factories/component.rb

@@ -3,8 +3,6 @@ class Content < Noodall::Component
   key :title, String
   key :url, String
   key :url_text, String
-
-  allowed_positions :small, :wide
 end
 
 # And a factory to build it

data/spec/factories/node.rb

@@ -3,10 +3,6 @@ class Page < Noodall::Node
   #sub_templates PageA, PageB, ArticlesList, LandingPage, EventsList
   searchable_keys :title, :description, :keywords, :body
   root_template!
-
-  main_slots 1
-  small_slots 4
-  wide_slots 3
 end
 
 class LandingPage < Noodall::Node

data/spec/node_spec.rb

@@ -7,6 +7,76 @@ describe Noodall::Node do
     }
   end
 
+  it "should allow me to set up slots (deprecated)" do
+    Noodall::Node.slots :dmain, :dsmall
+    class DSlotNode < Noodall::Node
+      dsmall_slots 3
+      dmain_slots 3
+    end
+
+    DSlotNode.new.slots.should be_instance_of(Array)
+    DSlotNode.slots_count.should == 6
+  end
+
+  it "should allow me to set up slots" do
+    Noodall::Node.slot :main, Content
+    Noodall::Node.slot :small, Content
+
+    class SlotNode < Noodall::Node
+      small_slots 3
+      main_slots 3
+    end
+
+    SlotNode.new.slots.should be_instance_of(Array)
+    SlotNode.small_slot_components.should include(Content)
+    SlotNode.slots_count.should == 6
+  end
+
+  it "should be able to list all slots (deprecated)" do
+    Noodall::Node.slots :dsmall
+
+    class DListSlotNode < Noodall::Node
+      dsmall_slots 3
+    end
+
+    class DListSlotComponent < Noodall::Component
+      allowed_positions :dsmall
+    end
+
+    node = DListSlotNode.new(:title => "Slot Node")
+    node.dsmall_slot_0 = DListSlotComponent.new(:body => "Some text")
+    node.dsmall_slot_1 = DListSlotComponent.new(:body => "Some more text")
+
+    node.save!
+
+    node.slots.should have(2).things
+
+    node.slots.first.body.should == "Some text"
+    node.slots.last.body.should == "Some more text"
+  end
+
+  it "should be able to list all slots" do
+    class ListSlotComponent < Noodall::Component
+    end
+
+    Noodall::Node.slot :small, ListSlotComponent
+
+    class ListSlotNode < Noodall::Node
+      small_slots 3
+    end
+
+    node = ListSlotNode.new(:title => "Slot Node")
+    node.small_slot_0 = ListSlotComponent.new(:body => "Some text")
+    node.small_slot_1 = ListSlotComponent.new(:body => "Some more text")
+
+    node.save!
+
+    node.slots.should have(2).things
+
+    node.slots.first.body.should == "Some text"
+    node.slots.last.body.should == "Some more text"
+  end
+
   it "should create a new instance given valid attributes" do
     Noodall::Node.create!(@valid_attributes)
   end
@@ -16,12 +86,21 @@ describe Noodall::Node do
     c.valid?.should == false
   end
 
-  it "should know it's root templates" do
-    class LandingPage < Noodall::Node
+  it "should know it's root templates (deprecated)" do
+    class DRootPage < Noodall::Node
       root_template!
     end
 
-    Noodall::Node.template_classes.should include(LandingPage)
+    Noodall::Node.template_classes.should include(DRootPage)
+  end
+
+  it "should allow you to set the root templates" do
+    class RootPage < Noodall::Node
+    end
+
+    Noodall::Node.root_templates RootPage
+
+    Noodall::Node.template_classes.should include(RootPage)
   end
 
   it "should filter roots with options" do
@@ -41,7 +120,6 @@ describe Noodall::Node do
     node.class.should == Page
 
     class LandingPage < Noodall::Node
-      root_template!
     end
 
     LandingPage.create!(@valid_attributes)
@@ -55,21 +133,13 @@ describe Noodall::Node do
     Noodall::Node.find_by_permalink('my-page').should == page
   end
 
-  it "should allow you to set the number of slots" do
-    class NicePage < Noodall::Node
-      wide_slots 3
-      small_slots 5
-    end
-
-    NicePage.slots_count.should == 8
-  end
-
   describe "within a tree" do
     before(:each) do
       class LandingPage < Noodall::Node
-        root_template!
       end
 
+      Noodall::Node.root_templates LandingPage
+
       @root = LandingPage.create!(:title => "Root")
 
       @child = Page.create!(:title => "Ickle Kid", :parent => @root)
@@ -194,23 +264,6 @@ describe Noodall::Node do
     p = Factory(:page)
   end
 
-  it "should be able to list all slots" do
-    ObjectSpace.each_object(Class) do |c|
-      next unless c.ancestors.include?(Noodall::Node) and (c != Noodall::Node)
-      c.new.slots.should be_instance_of(Array)
-    end
-
-    node = Factory(:page)
-    node.small_slot_0 = Content.new(:body => "Some text")
-    node.small_slot_1 = Content.new(:body => "Some more text")
-
-    node.save!
-
-    node.slots.should have(2).things
-
-    node.slots.first.body.should == "Some text"
-    node.slots.last.body.should == "Some more text"
-  end
 
   it "should use a tree structure" do
     root = Page.create!(@valid_attributes)
@@ -398,13 +451,14 @@ describe Noodall::Node do
       sub_templates LandingPage
     end
 
+    Noodall::Node.root_templates LandingPage, ArticlesList
+
     Page.parent_classes.should include(LandingPage)
     Page.parent_classes.should_not include(ArticlesList)
   end
 
   it "should know what sub templates are allowed" do
     class LandingPage < Noodall::Node
-      root_template!
       sub_templates Page, LandingPage
     end
     class Article < Noodall::Node
@@ -450,7 +504,6 @@ describe Noodall::Node do
 
     before(:each) do
       class LandingPage < Noodall::Node
-        root_template!
         sub_templates Page, LandingPage
       end
       class Article < Noodall::Node

data/spec/spec_helper.rb

@@ -12,9 +12,6 @@ MongoMapper.database = 'noodal-core-test'
 DatabaseCleaner.strategy = :truncation
 DatabaseCleaner.clean_with(:truncation)
 
-
-Noodall::Node.slots :main, :wide, :small
-
 require 'factories/node'
 require 'factories/component'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noodall-core
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-26 00:00:00.000000000Z
+date: 2011-10-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &14024980 !ruby/object:Gem::Requirement
+  requirement: &3394060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *14024980
+  version_requirements: *3394060
 - !ruby/object:Gem::Dependency
   name: ramdiv-mongo_mapper_acts_as_tree
-  requirement: &14023780 !ruby/object:Gem::Requirement
+  requirement: &3393140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *14023780
+  version_requirements: *3393140
 - !ruby/object:Gem::Dependency
   name: mm-multi-parameter-attributes
-  requirement: &14022840 !ruby/object:Gem::Requirement
+  requirement: &3392240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *14022840
+  version_requirements: *3392240
 - !ruby/object:Gem::Dependency
   name: canable
-  requirement: &14022000 !ruby/object:Gem::Requirement
+  requirement: &3391320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *14022000
+  version_requirements: *3391320
 - !ruby/object:Gem::Dependency
   name: mm-versionable
-  requirement: &14021120 !ruby/object:Gem::Requirement
+  requirement: &3388620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.5
   type: :runtime
   prerelease: false
-  version_requirements: *14021120
+  version_requirements: *3388620
 - !ruby/object:Gem::Dependency
   name: ruby-stemmer
-  requirement: &14020320 !ruby/object:Gem::Requirement
+  requirement: &3387460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14020320
+  version_requirements: *3387460
 description: Core data objects for Noodall
 email:
 - steve@wearebeef.co.uk
@@ -87,6 +87,7 @@ files:
 - .document
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -122,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1321159501201934569
+      hash: 1553541379450765350
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: