acts_as_word_cloud 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore_new

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/reports/

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1
+
+* Initial release.  Works but not pretty.

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "rails", "~> 3.1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "sqlite3"
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.2.3"
+  gem "jeweler", "~> 1.8.4"
+  gem "debugger"
+end
+
+group :test do
+  gem "machinist", "= 1.0.6"
+  gem "faker", "~>1.0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,130 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.10)
+      actionpack (= 3.1.10)
+      mail (~> 2.3.3)
+    actionpack (3.1.10)
+      activemodel (= 3.1.10)
+      activesupport (= 3.1.10)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
+      rack-cache (~> 1.2)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.4)
+    activemodel (3.1.10)
+      activesupport (= 3.1.10)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.10)
+      activemodel (= 3.1.10)
+      activesupport (= 3.1.10)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.10)
+      activemodel (= 3.1.10)
+      activesupport (= 3.1.10)
+    activesupport (3.1.10)
+      multi_json (>= 1.0, < 1.3)
+    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)
+    debugger (1.2.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.4)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.4)
+    diff-lcs (1.1.3)
+    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)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    machinist (1.0.6)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.3.9)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.1.10)
+      actionmailer (= 3.1.10)
+      actionpack (= 3.1.10)
+      activerecord (= 3.1.10)
+      activeresource (= 3.1.10)
+      activesupport (= 3.1.10)
+      bundler (~> 1.0)
+      railties (= 3.1.10)
+    railties (3.1.10)
+      actionpack (= 3.1.10)
+      activesupport (= 3.1.10)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sprockets (2.0.4)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.3)
+  cucumber
+  debugger
+  faker (~> 1.0.1)
+  jeweler (~> 1.8.4)
+  machinist (= 1.0.6)
+  rails (~> 3.1.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeremiah Hemphill
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,122 @@
+= acts_as_word_cloud
+
+Searches through model to get string attributes and recursively searches other associated models.
+
+= How to use
+
+  class Article < ActiveRecord::Base
+    acts_as_word_cloud :excluded_models => [Reader, Following], :depth => 2
+  
+    belongs_to :site
+    belongs_to :author
+    belongs_to :publisher
+    has_many :followings
+    has_many :readers, :through => :followings 
+  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
+
+  gem "acts_as_word_cloud"
+
+== Install the migration and config
+
+  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.
+
+Optionally, word_cloud can take two parameters:
+
+* 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
+
+== Contributing to acts_as_word_cloud
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jeremiah Hemphill. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acts_as_word_cloud"
+  gem.homepage = "http://github.com/jeremiahishere/acts_as_word_cloud"
+  gem.license = "MIT"
+  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"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_word_cloud #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/acts_as_word_cloud.gemspec

@@ -0,0 +1,127 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "acts_as_word_cloud"
+  s.version = "0.0.1"
+
+  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.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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".DS_Store",
+    ".document",
+    ".gitignore_new",
+    ".rspec",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "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",
+    "lib/acts_as_word_cloud/railtie.rb",
+    "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",
+    "spec/dummy/app/assets/javascripts/application.js",
+    "spec/dummy/app/assets/stylesheets/application.css",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/helpers/application_helper.rb",
+    "spec/dummy/app/mailers/.gitkeep",
+    "spec/dummy/app/models/.gitkeep",
+    "spec/dummy/app/models/article.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",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/database.yml",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/secret_token.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/initializers/wrap_parameters.rb",
+    "spec/dummy/config/locales/en.yml",
+    "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"
+  ]
+  s.homepage = "http://github.com/jeremiahishere/acts_as_word_cloud"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Search function for associated objects on model"
+
+  if s.respond_to? :specification_version then
+    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_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<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<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<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<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<bundler>, ["~> 1.2.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<debugger>, [">= 0"])
+  end
+end
+

data/features/acts_as_word_cloud.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'acts_as_word_cloud'
+
+require 'rspec/expectations'

data/lib/acts_as_word_cloud/config.rb

@@ -0,0 +1,31 @@
+# this file was stolen from kaminari
+require 'active_support/configurable'
+
+module ActsAsWordCloud
+
+  # create new configs by passing a block with the config assignment
+  def self.configure(&block)
+    yield @config ||= ActsAsWordCloud::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  # setup config data
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :min_depth
+    config_accessor :no_mixin_fields
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call() : config.param_name
+    end
+  end
+
+  # setup default options
+  # this should match the generator config that goes in the initializer file
+  configure do |config|
+  end
+end
+

data/lib/acts_as_word_cloud/engine.rb

@@ -0,0 +1,4 @@
+module ActsAsWordCloud
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/acts_as_word_cloud/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+require 'acts_as_word_cloud/config'
+
+module ActsAsWordCloud
+  class Railtie < ::Rails::Railtie
+    initializer 'acts_as_word_cloud' do |app|
+      require 'acts_as_word_cloud/word_cloud'
+      ActiveRecord::Base.send :include, ActsAsWordCloud::WordCloud
+    end
+  end
+end