acts_as_word_cloud 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.0.2
+
+* Major code refactoring
+* Documentation update
+
 == 0.0.1
 
 * Initial release.  Works but not pretty.

data/Gemfile

@@ -9,8 +9,8 @@ gem "rails", "~> 3.1.0"
 group :development do
   gem "sqlite3"
   gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "cucumber", ">= 0"
+  gem "rspec-rails"
+  gem "database_cleaner", "~>0.6.7"
   gem "bundler", "~> 1.2.3"
   gem "jeweler", "~> 1.8.4"
   gem "debugger"

data/Gemfile.lock

@@ -32,11 +32,7 @@ GEM
     arel (2.2.3)
     builder (3.0.4)
     columnize (0.3.6)
-    cucumber (1.2.1)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
+    database_cleaner (0.6.7)
     debugger (1.2.1)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.1.1)
@@ -48,8 +44,6 @@ GEM
     erubis (2.7.0)
     faker (1.0.1)
       i18n (~> 0.4)
-    gherkin (2.11.5)
-      json (>= 1.4.6)
     git (1.2.5)
     hike (1.2.1)
     i18n (0.6.1)
@@ -102,6 +96,11 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
     sprockets (2.0.4)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -119,12 +118,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.2.3)
-  cucumber
+  database_cleaner (~> 0.6.7)
   debugger
   faker (~> 1.0.1)
   jeweler (~> 1.8.4)
   machinist (= 1.0.6)
   rails (~> 3.1.0)
-  rdoc (~> 3.12)
   rspec (~> 2.8.0)
+  rspec-rails
   sqlite3

data/README.rdoc

@@ -1,109 +1,41 @@
 = acts_as_word_cloud
 
-Searches through model to get string attributes and recursively searches other associated models.
+Generate a word cloud of a model's database attributes, methods, and associations.
 
 = How to use
 
   class Article < ActiveRecord::Base
-    acts_as_word_cloud :excluded_models => [Reader, Following], :depth => 2
+    acts_as_word_cloud :included_methods => [:truncated_title]
   
-    belongs_to :site
     belongs_to :author
-    belongs_to :publisher
-    has_many :followings
-    has_many :readers, :through => :followings 
+
+    def truncated_title
+      title[0..25] if title
+    end
   end
   
-  Article.last.word_cloud(:array)     
-  => ["Artcle title", "genre", "description", "review", "Website name", "domain", "tagline", <names of affiliated companies>, 
-  "Author name", "gender", "location", "bio", "quote", <titles of other authored articles>, 
-  "Publisher name", "address", "city", "state", "zip code", "phone number", <titles of other articles published>]
-
-== Add the gem to your gemfile
+Calling Article.last.word_cloud will return
 
-  gem "acts_as_word_cloud"
+* Database fields: "Near-Response Advertising", "Looking at the next generation of advertising companies, it...", 
+* Methods: "Near-Response Advert"
+* Associations: "Jeremiah Hemphill" (Author name)
 
-== Install the migration and config
+== Installing the gem
 
+  gem "acts_as_word_cloud"
   rails generate acts_as_word_cloud:install
-  rake db:migrate
 
 == Add the mixin to your models
   
-  class Article < ActiveRecord::Base
-    acts_as_word_cloud :methods_to_use => [<Symbol>], :excluded_models => [<Constant>], :skipped_attributes => [<Symbol>], :depth => <Integer>
-  end 
-
-There are four options to customize search per model:
-* methods_to_use : specify which methods (that return strings) should be called when the model is being searched. Models that are being scanned as associations on the model calling word_cloud will only return a value if each of them has a methods_to_use containing a valid method for that model.
-* excluded_models : select associated models that you would like to leave out of the search.
-* skipped_attributes : by default, all string attributes are returned, unless some are set to be skipped.
-* depth : indicates the level of recursion word_cloud should take on the model being searched.
-
-== Set options for gem's config file
-
-/config/initializers/acts_as_word_cloud.rb:
-  
-  ActsAsWordCloud.configure do |config|
-    config.min_depth = 1         
-    config.no_mixin_fields = [:name, :title, :label]
-  end
-
-Here you can set the default minimum depth to use on all models that include the mixin. (Depth must be greater than or equal to 1, word_cloud will return an error message if not so)
-
-The no_mixin_fields option allows you to list methods to call on models that do not include the mixin for the gem. These models would be traversed during searches on models with the mixin if they aren't explicitly excluded in the hash. If no methods are added to the list or if a model does not respond to any on this list, word_cloud will return the object's class name.
-
-== Searching
-
-Example:
-  
-  class Publisher < ActiveRecord::Base
-    belongs_to :site
-  end
-  
-  class Site < ActiveRecord::Base
-    acts_as_word_cloud :excluded_models => [Author]
-    
-    has_many :publishers
-    has_many :authors           
-    has_many :articles
-  end
-   
-  class Author < ActiveRecord::Base
-    acts_as_word_cloud :methods_to_use => [:full_name, :random_quote] :skipped_attributes => [:phone_number]
-    
-    has_many :articles
-    belongs_to :site             
-  end
-
-  class Article < ActiveRecord::Base
-    acts_as_word_cloud :methods_to_use => [:title], :depth => 2
-   
-    belongs_to :author
-    belongs_to :site             
-  end
-
-Once model defaults are set, the method to call is .word_cloud:
-
-  Site.last.word_cloud
-  => model's string attributes, Publisher names (:name having been added to no_mixin_fields in config file),
-     and associated Article titles (this model ignores its associated Author objects)
-  
-  Author.last.word_cloud        
-  => model's string attributes except for :phone_number and the values for the methods :full_name and :random_quote,
-     associated Article titles, and nothing for associated Sites since methods_to_use isn't set on the Site model 
-  
-  Article.last.word_cloud       
-  => model's string attributes, (because of depth 2) the above data for Author and Site associated to current Article.
-     keeping in mind that the above results are due to the default depth being set to 1 
-     and that so would they be on the recursive calls to those associated objects
-
-When the method is scanning through objects recursively it goes as 'deep' as the original model's setting suggests. There may be cycling through the same objects but it will never be stuck in an endless loop since each further model's depth setting is not consulted.
+The mixin has five options:
 
-Optionally, word_cloud can take two parameters:
+* included_methods An array of method symbols used to create this model's word cloud
+* excluded_methods An array of method symbols that should not be used in the word cloud.
+* excluded_models An array of model constants whose data should not be included in the word cloud
+* depth_level How many levels of associations to include
+* object_name_method  How to name the object when included in the word cloud as an association
 
-* An integer to specify a different recursion depth for that specific method call
-* The symbol :array to get results listed in an array, by default they are returned in a single string
+These settings are optional.  Using the mixin without any options will pull data from the database and associations only.  Default values are set through the config file located in config/initializers/acts_as_word_cloud.rb.
 
 == Contributing to acts_as_word_cloud
  

data/Rakefile

@@ -20,7 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Search function for associated objects on model}
   gem.description = %Q{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}
   gem.email = "jeremiah@cloudspace.com"
-  gem.authors = ["Jeremiah Hemphill"]
+  gem.authors = ["Jeremiah Hemphill", "Alfredo Uribe"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -36,9 +36,6 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new(:features)
-
 task :default => :spec
 
 require 'rdoc/task'

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

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.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jeremiah Hemphill"]
-  s.date = "2013-02-19"
+  s.authors = ["Jeremiah Hemphill", "Alfredo Uribe"]
+  s.date = "2013-02-21"
   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 = [
@@ -29,9 +29,6 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "acts_as_word_cloud.gemspec",
-    "features/acts_as_word_cloud.feature",
-    "features/step_definitions/acts_as_word_cloud_steps.rb",
-    "features/support/env.rb",
     "lib/acts_as_word_cloud.rb",
     "lib/acts_as_word_cloud/config.rb",
     "lib/acts_as_word_cloud/engine.rb",
@@ -39,7 +36,6 @@ Gem::Specification.new do |s|
     "lib/acts_as_word_cloud/word_cloud.rb",
     "lib/generators/acts_as_word_cloud/install_generator.rb",
     "lib/generators/acts_as_word_cloud/templates/config.rb",
-    "lib/model_methods_helper.rb",
     "spec/acts_as_word_cloud_spec.rb",
     "spec/dummy/README.rdoc",
     "spec/dummy/Rakefile",
@@ -50,11 +46,10 @@ Gem::Specification.new do |s|
     "spec/dummy/app/mailers/.gitkeep",
     "spec/dummy/app/models/.gitkeep",
     "spec/dummy/app/models/article.rb",
+    "spec/dummy/app/models/article_reader.rb",
     "spec/dummy/app/models/author.rb",
-    "spec/dummy/app/models/following.rb",
     "spec/dummy/app/models/publisher.rb",
     "spec/dummy/app/models/reader.rb",
-    "spec/dummy/app/models/site.rb",
     "spec/dummy/app/views/layouts/application.html.erb",
     "spec/dummy/config.ru",
     "spec/dummy/config/application.rb",
@@ -74,16 +69,16 @@ Gem::Specification.new do |s|
     "spec/dummy/config/routes.rb",
     "spec/dummy/db/migrate/20121107162154_create_system.rb",
     "spec/dummy/db/schema.rb",
-    "spec/dummy/features/support/blueprints.rb",
     "spec/dummy/lib/assets/.gitkeep",
-    "spec/dummy/lib/model_methods_helper.rb",
     "spec/dummy/log/.gitkeep",
     "spec/dummy/public/404.html",
     "spec/dummy/public/422.html",
     "spec/dummy/public/500.html",
     "spec/dummy/public/favicon.ico",
     "spec/dummy/script/rails",
-    "spec/spec_helper.rb"
+    "spec/integration_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/blueprints.rb"
   ]
   s.homepage = "http://github.com/jeremiahishere/acts_as_word_cloud"
   s.licenses = ["MIT"]
@@ -98,8 +93,8 @@ Gem::Specification.new do |s|
       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<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<cucumber>, [">= 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<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
@@ -107,8 +102,8 @@ Gem::Specification.new do |s|
       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<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<cucumber>, [">= 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<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<debugger>, [">= 0"])
@@ -117,8 +112,8 @@ Gem::Specification.new do |s|
     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<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<cucumber>, [">= 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<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<debugger>, [">= 0"])

data/lib/acts_as_word_cloud/config.rb

@@ -15,8 +15,10 @@ module ActsAsWordCloud
   # setup config data
   class Configuration
     include ActiveSupport::Configurable
-    config_accessor :min_depth
-    config_accessor :no_mixin_fields
+    # default recursion depth when looking at data in associations
+    config_accessor :default_search_depth
+    # List of name methods to try on associations
+    config_accessor :object_name_methods
 
     def param_name
       config.param_name.respond_to?(:call) ? config.param_name.call() : config.param_name
@@ -26,6 +28,8 @@ module ActsAsWordCloud
   # setup default options
   # this should match the generator config that goes in the initializer file
   configure do |config|
+    config.default_search_depth = 1
+    config.object_name_methods = [:name, :title, :label, :to_s]
   end
 end
 

data/lib/acts_as_word_cloud/railtie.rb

@@ -5,6 +5,7 @@ require 'acts_as_word_cloud/config'
 module ActsAsWordCloud
   class Railtie < ::Rails::Railtie
     initializer 'acts_as_word_cloud' do |app|
+      # just one mixin: acts_ac_word_cloud
       require 'acts_as_word_cloud/word_cloud'
       ActiveRecord::Base.send :include, ActsAsWordCloud::WordCloud
     end