noodall-core 0.1.0

data/lib/noodall/permalink.rb

@@ -0,0 +1,27 @@
+module Noodall
+  class Permalink < Array
+    def initialize(*args)
+      if args.length > 1
+        super args
+      else
+        super args.first.to_s.split('/')
+      end
+    end
+
+    def to_s
+      self.join('/')
+    end
+
+    def inspect
+      "<Permalink #{self.to_s}>"
+    end
+
+    def self.to_mongo(value)
+      value.to_s
+    end
+    
+    def self.from_mongo(value)
+      new( *value.to_s.split('/') ) 
+    end
+  end
+end

data/lib/noodall/search.rb

@@ -0,0 +1,123 @@
+module Noodall
+  module Search
+    STOPWORDS = ["about", "above", "above", "across", "after", "afterwards", "again", "against", "all", "almost", "alone", "along", "already", "also", "although", "always", "among", "amongst", "amoungst", "amount", "and", "another", "any", "anyhow", "anyone", "anything", "anyway", "anywhere", "are", "around", "back", "became", "because", "become", "becomes", "becoming", "been", "before", "beforehand", "behind", "being", "below", "beside", "besides", "between", "beyond", "bill", "both", "bottom", "but", "call", "can", "cannot", "cant", "con", "could", "couldnt", "cry", "describe", "detail", "done", "down", "due", "during", "each", "eight", "either", "eleven", "else", "elsewhere", "empty", "enough", "etc", "even", "ever", "every", "everyone", "everything", "everywhere", "except", "few", "fifteen", "fify", "fill", "find", "fire", "first", "five", "for", "former", "formerly", "forty", "found", "four", "from", "front", "full", "further", "get", "give", "had", "has", "hasnt", "have", "hence", "her", "here", "hereafter", "hereby", "herein", "hereupon", "hers", "herself", "him", "himself", "his", "how", "however", "hundred", "inc", "indeed", "interest", "into", "its", "itself", "keep", "last", "latter", "latterly", "least", "less", "ltd", "made", "many", "may", "meanwhile", "might", "mill", "mine", "more", "moreover", "most", "mostly", "move", "much", "must", "myself", "name", "namely", "neither", "never", "nevertheless", "next", "nine", "nobody", "none", "noone", "nor", "not", "nothing", "now", "nowhere", "off", "often", "once", "one", "only", "onto", "other", "others", "otherwise", "our", "ours", "ourselves", "out", "over", "own", "part", "per", "perhaps", "please", "put", "rather", "same", "see", "seem", "seemed", "seeming", "seems", "serious", "several", "she", "should", "show", "side", "since", "sincere", "six", "sixty", "some", "somehow", "someone", "something", "sometime", "sometimes", "somewhere", "still", "such", "system", "take", "ten", "than", "that", "the", "the", "their", "them", "themselves", "then", "thence", "there", "thereafter", "thereby", "therefore", "therein", "thereupon", "these", "they", "thickv", "thin", "third", "this", "those", "though", "three", "through", "throughout", "thru", "thus", "together", "too", "top", "toward", "towards", "twelve", "twenty", "two", "under", "until", "upon", "very", "via", "was", "well", "were", "what", "whatever", "when", "whence", "whenever", "where", "whereafter", "whereas", "whereby", "wherein", "whereupon", "wherever", "whether", "which", "while", "whither", "who", "whoever", "whole", "whom", "whose", "why", "will", "with", "within", "without", "would", "yet", "you", "your", "yours", "yourself", "yourselves"]
+  
+    def self.configure(model)
+      require 'lingua/stemmer'
+  
+      model.class_eval do
+        key :_keywords, Array, :index => true
+        attr_accessor :relevance
+  
+        before_save :_update_keywords
+      end
+    end
+  
+    module ClassMethods
+      def searchable_keys(*keys)
+        @@searchable_keys ||= Set.new
+        @@searchable_keys += keys
+  
+        @@searchable_keys
+      end
+  
+      def language(lang = 'en')
+        @language ||= lang
+      end
+  
+      def search(query, options = {})
+        if options[:per_page] || options[:per_page]
+          per_page      = options.delete(:per_page)
+          page          = options.delete(:page)
+        end
+        plucky_query = query(options.reverse_merge(
+          :order => 'relevance DESC'
+        ))
+        criteria = plucky_query.criteria.to_hash
+        options = plucky_query.options.to_hash
+
+        # Extract words from the query and clean up
+        words = query.downcase.split(/\W/) - STOPWORDS
+        words.reject!{|w| w.length < 3}
+        criteria.merge!( :_keywords => { :$all => words } )
+  
+        # The Search result
+        search_result = collection.map_reduce(search_map(words), search_reduce, {:query => criteria, :finalize => search_finalize})
+        
+        # Add value to sort options because model is stored in the value key
+        options[:sort].map! do |s,v|
+          ["value.#{s}",v]
+        end
+
+        search_query = Plucky::Query.new(search_result, options)
+
+        if per_page
+          results = search_query.paginate(:per_page => per_page, :page => page)
+        else
+          results = search_query.all
+        end
+        # clean up tmp collection
+        search_result.drop 
+        #return results mappped to objects
+        results.tap do |docs|
+          docs.map! { |hash| load(hash['value']) }
+        end
+      end
+  
+      def search_map(words)
+        #convert words into Regex OR
+        q = words.map do |k|
+          Regexp.escape(k)
+        end.join("|")
+        "function(){" +
+          "this.relevance = this._keywords.filter(" +
+          "function(z){" +
+          "return String(z).match(/(#{q})/);" +
+          "}).length;" +
+          "emit(this._id, this);" +
+          "}"
+      end
+  
+      def search_reduce
+        "function( key , values ){return { model: values[0]};}"
+      end
+  
+      def search_finalize
+        "function( key , values ){return values.model;}"
+      end
+    end
+  
+    module InstanceMethods
+      protected
+      def _update_keywords
+        s = Lingua::Stemmer.new(:language => self.class.language)
+  
+        self._keywords = []
+  
+        self.class.searchable_keys.each do |search_key|
+          self._keywords += keywords_for_value(s, send(search_key)).compact
+        end
+      end
+  
+      private
+      def keywords_for_value(stemmer, val)
+        if val.kind_of?(String)
+          words = val.downcase.split(/\W/) - STOPWORDS
+          words.reject!{|w| w.length < 3}
+          words.map do |word|
+            stem = stemmer.stem(word)
+            if stem != word
+              [stem, word]
+            else
+              word
+            end
+          end.flatten
+        elsif val.kind_of?(Array)
+          val.map { |e| keywords_for_value(stemmer, e) }.flatten
+        else
+          [val]
+        end
+      end
+    end
+  end
+end

data/lib/noodall/tagging.rb

@@ -0,0 +1,68 @@
+module Noodall
+  module Tagging
+    def self.configure(model)
+      model.class_eval do
+        key :tags, Array, :index => true
+      end
+    end
+  
+    module ClassMethods
+      def tag_cloud(options = {})
+        return [] if self.count == 0 # Don't bother if there is nothing in this collection
+        query = query(options.reverse_merge(
+          :order => 'value DESC'
+        ))
+        tags_map = collection.map_reduce(tag_cloud_map, tag_cloud_reduce, {:query => query.criteria.to_hash})
+        if tags_map.count > 0
+          tags = tags_map.find({}, query.options.to_hash ).to_a.collect{ |hash| Tag.new(hash['_id'], hash['value']) }
+          tags_map.drop # clean up tmp collection
+          tags
+        else
+          []
+        end
+      end
+  
+      def tag_cloud_map
+       "function(){" +
+        "this.tags.forEach(" +
+        "function(z){" +
+        "emit( z , 1 );" +
+        "}" +
+        ")}"
+      end
+  
+      def tag_cloud_reduce
+        "function( key , values ){" +
+        "var total = 0;" +
+        "for ( var i=0; i<values.length; i++ ){" +
+        "total += values[i];" +
+        "}" +
+        "return total;" +
+        "}"
+      end
+    end
+  
+    module InstanceMethods
+      def tag_list=(string)
+        self.tags = string.to_s.split(',').map{ |t| t.strip.downcase }.reject(&:blank?).compact.uniq
+      end
+  
+      def tag_list
+        tags.join(', ')
+      end
+  
+      def related(options ={})
+        self.class.all(options.merge({:_id => {'$ne' => self._id}, :tags => /(#{self.tags.join('|')})/i}))
+      end
+    end
+  
+    class Tag
+      attr_reader :name, :count
+  
+      def initialize(name, count)
+        @name = name
+        @count = count.to_i
+      end
+    end
+  end
+end

data/noodall-core.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{noodall-core}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve England"]
+  s.date = %q{2010-10-10}
+  s.description = %q{Core data objects for Noodall}
+  s.email = %q{steve@wearebeef.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/noodall-core.rb",
+     "lib/noodall/component.rb",
+     "lib/noodall/global_update_time.rb",
+     "lib/noodall/indexer.rb",
+     "lib/noodall/multi_parameter_attributes.rb",
+     "lib/noodall/node.rb",
+     "lib/noodall/permalink.rb",
+     "lib/noodall/search.rb",
+     "lib/noodall/tagging.rb",
+     "noodall-core.gemspec",
+     "spec/component_spec.rb",
+     "spec/factories/component.rb",
+     "spec/factories/node.rb",
+     "spec/node_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/beef/noodall-core}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Core data objects for Noodall}
+  s.test_files = [
+    "spec/component_spec.rb",
+     "spec/factories/component.rb",
+     "spec/factories/node.rb",
+     "spec/node_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo_mapper>, ["= 0.8.4"])
+      s.add_runtime_dependency(%q<ramdiv-mongo_mapper_acts_as_tree>, ["= 0.1.1"])
+      s.add_runtime_dependency(%q<canable>, ["= 0.1.1"])
+      s.add_runtime_dependency(%q<ruby-stemmer>, [">= 0"])
+    else
+      s.add_dependency(%q<mongo_mapper>, ["= 0.8.4"])
+      s.add_dependency(%q<ramdiv-mongo_mapper_acts_as_tree>, ["= 0.1.1"])
+      s.add_dependency(%q<canable>, ["= 0.1.1"])
+      s.add_dependency(%q<ruby-stemmer>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongo_mapper>, ["= 0.8.4"])
+    s.add_dependency(%q<ramdiv-mongo_mapper_acts_as_tree>, ["= 0.1.1"])
+    s.add_dependency(%q<canable>, ["= 0.1.1"])
+    s.add_dependency(%q<ruby-stemmer>, [">= 0"])
+  end
+end
+

data/spec/component_spec.rb

@@ -0,0 +1,51 @@
+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
+
+    Noodall::Component.possible_slots.should == [:wide, :small, :main]
+
+    class Promo < Noodall::Component
+      allowed_positions :small, :wide, :main, :egg, :nog
+    end
+
+    Promo.positions.should have(3).things
+  end
+
+  it "should list components classes avaiable to a slot" do
+
+    class Promo < Noodall::Component
+      allowed_positions :small, :wide
+    end
+
+    Promo.positions.should have(2).things
+
+    Noodall::Component.positions_classes(:small).should include(Promo)
+    Noodall::Component.positions_classes(:main).should_not include(Promo)
+  end
+
+  it "should be validated by the node" do
+    class Promo < Noodall::Component
+      allowed_positions :small, :wide
+    end
+
+    node = Factory(:page)
+    node.main_slot_0 = Promo.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) 
+
+    node.save!
+
+    node.small_slot_0.node.should == node
+  end
+
+end

data/spec/factories/component.rb

@@ -0,0 +1,16 @@
+# A Dummy slot for tests
+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
+Factory.define :content do |component|
+  component.title { Faker::Lorem.words(4).join('') }
+  component.url { 'http://www.google.com' }
+  component.url_text { 'More' }
+end
+

data/spec/factories/node.rb

@@ -0,0 +1,15 @@
+# Dummy node class for the tests
+class Page < Noodall::Node
+  #sub_templates PageA, PageB, ArticlesList, LandingPage, EventsList
+  root_template!
+
+  main_slots 1
+  small_slots 4
+  wide_slots 3
+end
+
+# And a factory to build it
+Factory.define :page do |node|
+  node.title { Faker::Lorem.words(3).join(' ') }
+  node.published_at { Time.now }
+end

data/spec/node_spec.rb

@@ -0,0 +1,330 @@
+require 'spec_helper'
+
+describe Noodall::Node do
+  before(:each) do
+    @valid_attributes = {
+      :title => "My First Node"
+    }
+  end
+
+  it "should create a new instance given valid attributes" do
+    Noodall::Node.create!(@valid_attributes)
+  end
+
+  it "should be invalid if attributes are incorrect" do
+    c = Noodall::Node.create
+    c.valid?.should == false
+  end
+
+  it "should know it's root templates" do
+    class LandingPage < Noodall::Node
+      root_template!
+    end
+
+    Noodall::Node.template_classes.should include(LandingPage)
+  end
+
+  it "should know what class it is" do
+    page = Page.create!(@valid_attributes)
+    page.reload
+
+    page.class.should == Page
+
+    node = Noodall::Node.find(page.id)
+
+    node.class.should == Page
+  end
+
+  it "should be found by permalink" do
+    page = Factory(:page, :title => "My Page", :publish => true)
+    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
+      @root = Page.create!(:title => "Root")
+
+      @child = Page.create!(:title => "Ickle Kid", :parent => @root)
+
+      @grandchild = Page.create!(:title => "Very Ickle Kid", :parent => @child) 
+    end
+
+    it "should create permlink based on tree" do
+      @grandchild.permalink.to_s.should == "root/ickle-kid/very-ickle-kid"
+      @grandchild.reload
+      @grandchild.permalink.to_s.should == "root/ickle-kid/very-ickle-kid"
+    end
+    
+    it "should be under the correct path once moved" do
+      grand_child_2 = Page.create!(:title => "Ickle Kid", :parent => @child)
+      root_2 = Page.create!(:title => "Root 2")
+      
+      grand_child_2.parent = root_2
+      grand_child_2.save!
+
+      grand_child_2.path.should_not include(@child.id)
+      grand_child_2.path.should include(root_2.id)
+    end
+
+    it "should be under the correct path once it's parent is moved" do
+      grand_child_2 = Page.create!(:title => "Ickle Kid 2", :parent => @child)
+      root_2 = Page.create!(:title => "Root 2")
+      @child.parent = root_2
+      @child.save(:validate => false)
+
+      grand_child_2.reload
+      
+      grand_child_2.path.should_not include(@root.id)
+      grand_child_2.path.should include(root_2.id)
+    end
+
+    it "should allow parent to be set to nill using a the string 'none' to make it easy to set via forms" do
+      @grandchild.update_attributes!(:parent => 'none')
+      @grandchild.reload
+      @grandchild.parent.should be(nil)
+    end
+
+  end
+
+  describe "Publish dates" do
+    before(:each) do
+      @node = Factory(:page, :published_at => 3.days.ago, :published_to => 3.days.since)
+    end
+
+    it "should be able to be published now" do
+      node = Factory(:page, :publish => true)
+      node.published?.should == true
+    end
+
+    it "should be able to be hidden now" do
+      @node.hide = true
+      @node.save
+      @node.published?.should == false
+    end
+
+    it "should determine if it is published" do
+      @node.published?.should == true
+    end
+
+    it "should know it it is to be published" do
+      @node.published_at = 1.hour.since
+      @node.save
+      @node.published?.should == false
+      @node.pending?.should == true
+      @node.expired?.should == false
+    end
+
+    it "should know it has been published" do
+      @node.published_to = 1.hour.ago
+      @node.save
+      @node.published?.should == false
+      @node.pending?.should == false
+      @node.expired?.should == true
+    end
+
+    it "should allow you to clear published to" do
+      @node.published_to = 1.hour.ago
+      @node.save
+      @node.published?.should == false
+
+      @node.published_to = nil
+      @node.save
+      @node.published?.should == true
+    end
+
+    it "should be findable by publish dates" do
+      nodes = Noodall::Node.all(:published_at => { :$lte => Time.now }, :published_to => { :$gte => Time.now })
+      nodes.should have(1).things
+
+      nodes = Noodall::Node.all(:published_at => { :$lte => 4.days.ago }, :published_to => { :$gte => 4.days.ago })
+      nodes.should have(0).things
+
+      nodes = Noodall::Node.all(:published_at => { :$lte => 4.days.since }, :published_to => { :$gte => 4.days.since })
+      nodes.should have(0).things
+
+    end
+
+  end
+
+  it "should update the global update timestamp" do
+    Noodall::GlobalUpdateTime::Stamp.should_receive(:update!)
+    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)
+
+    child = Page.create!(:title => "Ickle Kid", :parent => root)
+
+    grandchild = Page.create!(:title => "Very Ickle Kid", :parent => child)
+
+    child.parent.should == root
+
+    grandchild.root.should == root
+
+    root.children.first.should == child
+
+    sec_child = Page.create!(:title => "Ickle Kid 2", :parent => root)
+
+    child.siblings.first.should == sec_child
+
+    root.children.last.should == sec_child
+
+    sec_child.position = 0
+    sec_child.save
+
+    root.children.first.should == sec_child
+
+    child.reload
+
+    child.position.should == 1
+
+    third_child = Page.create!(:title => "Ickle Kid 3", :parent => root, :position => 0)
+
+    root.children.first.should == third_child
+
+    sec_child.reload
+
+    sec_child.position.should == 1
+
+    child.reload
+
+    child.position.should == 2
+
+    last_child = Page.create!(:title => "Ickle Kid 4", :parent => root, :position => 33)
+
+    last_child.reload
+
+    root.children.should have(4).things
+
+
+    root.children.last.should == last_child
+
+    last_child.position.should == 3
+  end
+
+  it "shold allow groups to be set by strings for easy form access" do
+    node = Factory(:page)
+    node.destroyable_groups_list = 'Webbies, Dudes,Things,  Dudes, ,'
+    node.destroyable_groups.should == ['Webbies', 'Dudes', 'Things']
+
+    node = Factory(:page, :destroyable_groups_list => 'Webbies, Dudes,Things,  Dudes, ,')
+    node.destroyable_groups.should == ['Webbies', 'Dudes', 'Things']
+  end
+
+  it "should restrict user accces by groups" do
+    # Stub a simple user model
+    class ::User
+      include MongoMapper::Document
+      include Canable::Cans
+
+      key :name, String
+      key :groups, Array
+      key :admin, Boolean
+    end
+
+    john = User.create!(:name => 'John', :groups => ['Webbies','Blokes'])
+    steve = User.create!(:name => 'Steve', :groups => ['Dudes'])
+
+    ruby = Factory(:page, :updatable_groups => ['Dudes'], :destroyable_groups => ['Webbies', 'Dudes'], :publishable_groups => ['Dudes'] )
+
+    ruby.all_groups.should have(2).things
+
+    john.can_create?(ruby).should == true
+    steve.can_create?(ruby).should == true
+
+    ruby.creator = john
+    ruby.save
+
+    john.can_view?(ruby).should == true
+    steve.can_view?(ruby).should == true
+
+    john.can_update?(ruby).should == false
+    steve.can_update?(ruby).should == true
+
+    john.can_destroy?(ruby).should == true
+    steve.can_destroy?(ruby).should == true
+  end
+
+  it "should be searchable" do
+    3.times do |i|
+      Factory(:page, :title => "My Searchable Page #{i}")
+    end
+
+    top_hit = Factory(:page, :title => "My Extra Searchable Page", :description => "My Extra Searchable Page")
+
+    3.times do |i|
+      Factory(:page, :title => "My Unfit Page #{i}")
+    end
+
+    results = Page.search("Searchable")
+
+    results.should have(4).things
+
+    results.first.should == top_hit
+
+    results = Page.search("Searchable", :per_page => 2)
+
+    results.should have(2).things
+    results.total_pages.should == 2
+
+    results.first.should == top_hit
+
+    results = Page.search("supercalifragilistic")
+
+    results.should have(0).things
+  end
+
+  it "should return related" do
+    Factory(:page, :title => "My Page 1", :tag_list => 'one,two,three')
+    Factory(:page, :title => "My Page 2", :tag_list => 'two,three,four')
+    Factory(:page, :title => "My Page 3", :tag_list => 'three,four,five')
+    ref = Factory(:page, :title => "My Page 4", :tag_list => 'five,nine')
+
+    ref.related.should have(1).things
+
+    Factory(:page, :title => "My Page 5", :tag_list => 'nine')
+
+    ref.related.should have(2).things
+  end
+
+  it "should know who can be a parent" do
+    class LandindPage < Noodall::Node
+      sub_templates Page
+    end
+    class ArticlesList < Noodall::Node
+      sub_templates LandindPage
+    end
+
+    Page.parent_classes.should include(LandingPage)
+    Page.parent_classes.should_not include(ArticlesList)
+  end
+
+end