acts_as_word_cloud 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,10 @@
+== unreleased changes
+
+== 0.0.4
+
+* Improved performance of the recursive word cloud by avoiding calling it multiple times on the same object
+* Made rails requirements more general
+
 == 0.0.3
 
 * Added an option for permanently excluded models to the config file

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem "rails", "~> 3.1.0"
+gem "rails", ">= 3.1.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -11,7 +11,7 @@ group :development do
   gem "rspec", "~> 2.8.0"
   gem "rspec-rails"
   gem "database_cleaner", "~>0.6.7"
-  gem "bundler", "~> 1.2.3"
+  gem "bundler", ">=  1.2.3"
   gem "jeweler", "~> 1.8.4"
   gem "debugger"
 end

data/Gemfile.lock

@@ -117,13 +117,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.2.3)
+  bundler (>= 1.2.3)
   database_cleaner (~> 0.6.7)
   debugger
   faker (~> 1.0.1)
   jeweler (~> 1.8.4)
   machinist (= 1.0.6)
-  rails (~> 3.1.0)
+  rails (>= 3.1.0)
   rspec (~> 2.8.0)
   rspec-rails
   sqlite3

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/acts_as_word_cloud.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_word_cloud"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremiah Hemphill", "Alfredo Uribe"]
-  s.date = "2013-02-21"
+  s.date = "2013-03-14"
   s.description = "Returns values for specified methods on each object containing mixix and values from general methods specified for models that don't have the mixin; depending on 'depth' value passed in the method will also recursively return values for associated objects on each model scanned"
   s.email = "jeremiah@cloudspace.com"
   s.extra_rdoc_files = [
@@ -90,31 +90,31 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.1.0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<rspec-rails>, [">= 0"])
       s.add_development_dependency(%q<database_cleaner>, ["~> 0.6.7"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_development_dependency(%q<bundler>, [">= 1.2.3"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
     else
-      s.add_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_dependency(%q<rails>, [">= 3.1.0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rspec-rails>, [">= 0"])
       s.add_dependency(%q<database_cleaner>, ["~> 0.6.7"])
-      s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_dependency(%q<bundler>, [">= 1.2.3"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<debugger>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, ["~> 3.1.0"])
+    s.add_dependency(%q<rails>, [">= 3.1.0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rspec-rails>, [">= 0"])
     s.add_dependency(%q<database_cleaner>, ["~> 0.6.7"])
-    s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+    s.add_dependency(%q<bundler>, [">= 1.2.3"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<debugger>, [">= 0"])
   end

data/lib/acts_as_word_cloud/word_cloud.rb

@@ -53,10 +53,12 @@ module ActsAsWordCloud
       protected 
 
       # Finds all text attributes, associated objects, and included methods down to a specified depth
+      # Avoids running the word cloud on objects that have already been included
       #
       # @param [Integer] depth How many layers of associations to search
+      # @param [Array] already_included_objects List of objects of models that have already been included in the word cloud
       # @return [Array] The word cloud for the specified object and depth
-      def recursive_word_cloud(depth) 
+      def recursive_word_cloud(depth, already_included_objects = []) 
         # prepare an array of strings to be used as an output
         output = []
 
@@ -65,10 +67,16 @@ module ActsAsWordCloud
       
         # array of objects for every association minus a list of excluded objects
         objects = word_cloud_associated_objects
+
+        # do not search again on self
+        already_included_objects << self
+
         objects.each do |obj|
-          if obj.respond_to?(:recursive_word_cloud) && depth > 1
+          if already_included_objects.include?(obj)
+            # pass because the data is already in the output
+          elsif obj.respond_to?(:recursive_word_cloud) && depth > 1
             # if the object has a word cloud mixin and we can recurse
-            output |= obj.recursive_word_cloud(depth - 1)
+            output |= obj.recursive_word_cloud(depth - 1, already_included_objects)
           else
             # otherwise get the default name for the object
             output |= [self.word_cloud_object_name(obj)]

data/lib/generators/acts_as_word_cloud/templates/config.rb

@@ -15,5 +15,5 @@ ActsAsWordCloud.configure do |config|
   #
   # Each of the contants in this list will be added to the word cloud attribute, excluded_models.
   # This will happen even when the attribute is included in the mixin call.
-  # config.premanently_excluded_models = []
+  # config.permanently_excluded_models = []
 end

data/spec/acts_as_word_cloud_spec.rb

@@ -33,6 +33,7 @@ describe "ActsAsWordCloud" do
       @article.stub(:word_cloud_get_valid_strings).and_return([])
       @article.stub(:word_cloud_associated_objects).and_return([])
     end
+    
     it "should call word_cloud_get_valid_strings" do
       @article.should_receive(:word_cloud_get_valid_strings).and_return([])
       @article.send(:recursive_word_cloud, 1)
@@ -43,9 +44,9 @@ describe "ActsAsWordCloud" do
       @article.send(:recursive_word_cloud, 1)
     end
 
-    it "should call rescursive_word_cloud on an associated object if the depth is more than 1" do
+    it "should call rescursive_word_cloud on an associated object if the depth is more than 1 and it should include the calling object in the parameters" do
       object_with_word_cloud = mock(Author)
-      object_with_word_cloud.should_receive(:recursive_word_cloud).with(1).and_return([])
+      object_with_word_cloud.should_receive(:recursive_word_cloud).with(1, [@article]).and_return([])
 
       @article.stub(:word_cloud_associated_objects).and_return([object_with_word_cloud])
       @article.send(:recursive_word_cloud, 2)
@@ -68,6 +69,15 @@ describe "ActsAsWordCloud" do
       @article.send(:recursive_word_cloud, 2)
     end
 
+    it "should not call rescursive_word_cloud on an associated object if the object is included in the already_included_objects" do
+      object_with_word_cloud = mock(Author)
+      object_with_word_cloud.should_not_receive(:recursive_word_cloud)
+      object_with_word_cloud.should_not_receive(:name)
+
+      @article.stub(:word_cloud_associated_objects).and_return([object_with_word_cloud])
+      @article.send(:recursive_word_cloud, 2, [object_with_word_cloud])
+    end
+
     it "should return an array of strings" do
       @article.stub(:word_cloud_get_valid_strings).and_return(["hello"])
       results = @article.send(:recursive_word_cloud, 1)

data/spec/dummy/db/migrate/20121107162154_create_system.rb

@@ -12,6 +12,7 @@ class CreateSystem < ActiveRecord::Migration
     create_table :authors do |t|
       t.integer :publisher_id
       t.string :name
+      t.text :biography
       
       t.timestamps
     end

data/spec/dummy/db/schema.rb

@@ -30,6 +30,7 @@ ActiveRecord::Schema.define(:version => 20121107162154) do
   create_table "authors", :force => true do |t|
     t.integer  "publisher_id"
     t.string   "name"
+    t.text     "biography"
     t.datetime "created_at"
     t.datetime "updated_at"
   end

data/spec/integration_spec.rb

@@ -108,12 +108,13 @@ describe "Integration tests" do
       
     end
 
-    it "should return multiple levels of associations if the depth is set to 2" do
+    it "should return two levels of associations if the depth is set to 2" do
       @word_cloud_output = @article.word_cloud(:array)
 
       expected_word_cloud_output = [
-        @author.name,
-        @publisher.name,
+        @author.name, # default name
+        @author.biography, # from author word cloud
+        @publisher.name # default name
       ]
       expected_word_cloud_output.each do |str|
         @word_cloud_output.should include str

data/spec/support/blueprints.rb

@@ -23,6 +23,7 @@ end
 Author.blueprint do
   publisher { Publisher.make }
   name { generate_tiny_text }
+  biography { generate_text }
 end
 
 Publisher.blueprint do

metadata

@@ -2,7 +2,7 @@
 name: acts_as_word_cloud
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -11,14 +11,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-21 00:00:00 Z
+date: 2013-03-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 3.1.0
   type: :runtime
@@ -73,7 +73,7 @@ dependencies:
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.2.3
   type: :development
@@ -186,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 39024837777467519
+      hash: 2627755293098628913
       segments: 
       - 0
       version: "0"