wc 0.98.2 → 0.99.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/README.rdoc

@@ -1,25 +1,21 @@
 = wc
 
-wc gem is a very simple word counter. It takes a file in input and prints the words occurences.
+wc is a rubygem to count word occurrences in a given text.
 
-== Usage
+*NEWS*
+This is a major rewrite since version 0.98.2 and the API is completely rewritten from scratch. 
+The expected behavior is to let wc gem to extend a plain ruby String object and use it to retrieve tag cloud.
+Please note that reading words from a file will be removed in further releases.
 
- $ bin/wc filename 
- 
- This is the very basic wc usage. It reads filename and it prints out a sorted
- array for the word occurrences they have been found.
 
- $ bin/wc --json filename
- The same as the example above, except for the results that are printed in json notation.
+== Usage
 
- $bin/wc -w x filename
- It prints out only the first x words that appear with highest rate in filename
+Using wc is easy. Just require the gem and use the to_tag_cloud method to the
+string containing the text you want to transform in a tag cloud
 
- $bin/wc --cloud filename
- It prints out the result using definition list HTML tag. This can be used to generate tag clouds
+  require 'wc'
 
- $bin/wc -H filename
- It prints out the result excluding some very common English idioms such as ('and', 'of', 'the', ...)
+  "A text longer is here".to_tag_cloud ~> "<ul id=\"cloud\"><li><a href=\"#\" class=\"tag0\">text</a></li><li><a href=\"#\" class=\"tag0\">longer</a></li><li><a href=\"#\" class=\"tag0\">here</a></li></ul>" 
 
 == Note on Patches/Pull Requests
  
@@ -33,4 +29,4 @@ wc gem is a very simple word counter. It takes a file in input and prints the wo
 
 == Copyright
 
-Copyright (c) 2010 Paolo Perego. See LICENSE for details.
+Copyright (c) 2011 Paolo Perego. See LICENSE for details.

data/Rakefile

@@ -1,59 +1,44 @@
-require 'rubygems'
-require 'rake'
+# encoding: utf-8
 
+require 'rubygems'
+require 'bundler'
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "wc"
-    gem.summary = "your ruby word counter experience"
-    gem.description = "your ruby word counter experience"
-    gem.email = "thesp0nge@gmail.com"
-    gem.homepage = "http://github.com/thesp0nge/wc"
-    gem.authors = ["Paolo Perego"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem.add_development_dependency "getoptlong", ">=0"
-    gem.add_development_dependency "builder", ">=2.1.2"
-    gem.add_development_dependency "json_pure", ">=1.4.3"
-    
-    # gem.add_dependency "json_pure", ">=1.4.3"
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  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 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+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 = "wc"
+  gem.summary = "your ruby word counter experience"
+  gem.description = "your ruby word counter experience"
+  gem.email = "thesp0nge@gmail.com"
+  gem.homepage = "http://github.com/thesp0nge/wc"
+  gem.authors = ["Paolo Perego"]
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+  gem.license = "new BSD License"
+  gem.email = "thesp0nge@gmail.com"
+  # dependencies defined in Gemfile
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-task :test => :check_dependencies
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
 
-task :default => :test
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+task :default => :spec
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "wc #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.98.2
+0.99.0

data/doc/String.html

@@ -0,0 +1,372 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>Class: String</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (S)</a> &raquo; 
+    
+    
+    <span class="title">String</span>
+  
+  
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Class: String
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">String</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/wc.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#occurrences-instance_method" title="#occurrences (instance method)">- (Object) <strong>occurrences</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#to_tag_cloud-instance_method" title="#to_tag_cloud (instance method)">- (Object) <strong>to_tag_cloud</strong>(max_words = nil) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#wc-instance_method" title="#wc (instance method)">- (Object) <strong>wc</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="occurrences-instance_method">
+  
+    - (<tt>Object</tt>) <strong>occurrences</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wc.rb', line 9</span>
+
+<span class='kw'>def</span> <span class='id occurrences'>occurrences</span>
+  <span class='const'>Wc</span><span class='op'>::</span><span class='const'>Engine</span><span class='period'>.</span><span class='id read_inline'>read_inline</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="to_tag_cloud-instance_method">
+  
+    - (<tt>Object</tt>) <strong>to_tag_cloud</strong>(max_words = nil) 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wc.rb', line 13</span>
+
+<span class='kw'>def</span> <span class='id to_tag_cloud'>to_tag_cloud</span><span class='lparen'>(</span><span class='id max_words'>max_words</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+
+  <span class='id sorted'>sorted</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id occurrences'>occurrences</span>
+
+  <span class='kw'>if</span> <span class='id max_words'>max_words</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+    <span class='id cloud_items'>cloud_items</span> <span class='op'>=</span> <span class='id sorted'>sorted</span>
+  <span class='kw'>else</span>
+    <span class='id cloud_items'>cloud_items</span> <span class='op'>=</span> <span class='id sorted'>sorted</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='id max_words'>max_words</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+
+  <span class='id max'>max</span> <span class='op'>=</span> <span class='id sorted'>sorted</span><span class='period'>.</span><span class='id first'>first</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
+  <span class='id min'>min</span> <span class='op'>=</span> <span class='id sorted'>sorted</span><span class='period'>.</span><span class='id last'>last</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
+  
+  <span class='id range'>range</span> <span class='op'>=</span> <span class='id max'>max</span> <span class='op'>-</span> <span class='id min'>min</span>
+  <span class='id interval'>interval</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='float'>1.0</span> <span class='op'>*</span> <span class='id range'>range</span><span class='rparen'>)</span><span class='op'>/</span><span class='int'>10</span>
+  
+  <span class='id r0'>r0</span><span class='op'>=</span><span class='id min'>min</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r1'>r1</span><span class='op'>=</span><span class='id r0'>r0</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r2'>r2</span><span class='op'>=</span><span class='id r1'>r1</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r3'>r3</span><span class='op'>=</span><span class='id r2'>r2</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r4'>r4</span><span class='op'>=</span><span class='id r3'>r3</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r5'>r5</span><span class='op'>=</span><span class='id r4'>r4</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r6'>r6</span><span class='op'>=</span><span class='id r5'>r5</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r7'>r7</span><span class='op'>=</span><span class='id r6'>r6</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r8'>r8</span><span class='op'>=</span><span class='id r7'>r7</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r9'>r9</span><span class='op'>=</span><span class='id r8'>r8</span><span class='op'>+</span><span class='id interval'>interval</span>
+  <span class='id r10'>r10</span><span class='op'>=</span><span class='id r9'>r9</span><span class='op'>+</span><span class='id interval'>interval</span>
+  
+  <span class='id ret'>ret</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;ul id=\&quot;cloud\&quot;&gt;</span><span class='tstring_end'>&quot;</span></span>
+  
+  <span class='id cloud_items'>cloud_items</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id elem'>elem</span><span class='op'>|</span>
+    <span class='kw'>if</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='op'>&gt;</span><span class='id r10'>r10</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag9</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r9'>r9</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag8</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r8'>r8</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag7</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r7'>r7</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag6</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r6'>r6</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag5</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r5'>r5</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag4</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r4'>r4</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag3</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r3'>r3</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag2</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='id r2'>r2</span><span class='rparen'>)</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag1</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>else</span>
+      <span class='id c'>c</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag0</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>end</span>
+  
+    <span class='id ret'>ret</span><span class='op'>+=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;li&gt;&lt;a href=\&quot;#\&quot; class=\&quot;</span><span class='tstring_end'>&quot;</span></span><span class='op'>+</span><span class='id c'>c</span><span class='op'>+</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;&gt;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span> <span class='id elem'>elem</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;/a&gt;&lt;/li&gt;</span><span class='tstring_end'>&quot;</span></span>
+    
+  <span class='rbrace'>}</span>
+  <span class='id ret'>ret</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;/ul&gt;</span><span class='tstring_end'>&quot;</span></span>
+  <span class='id ret'>ret</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="wc-instance_method">
+  
+    - (<tt>Object</tt>) <strong>wc</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+5
+6
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/wc.rb', line 5</span>
+
+<span class='kw'>def</span> <span class='id wc'>wc</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id occurrences'>occurrences</span><span class='period'>.</span><span class='id size'>size</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+    
+    <div id="footer">
+  Generated on Tue Jul  5 09:22:52 2011 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.6.8 (ruby-1.9.2).
+</div>
+
+  </body>
+</html>