histograffle 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jostein B.E.
+
+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.textile

@@ -0,0 +1,86 @@
+h1. Histograffle
+
+h2. A sort of histogram object implemented in pure Ruby. Use it to count the occurrence of each of several things.
+
+h3. Simple example of its use and abuse
+
+I am not a matematician, so this is not a mathematical library or explaination.
+
+Sample use case: We have two lists of words, and want to count the occurrence of each word in the lists, first separately, and then together.
+
+<pre>
+<code>
+require 'rubygems'
+require 'histograffle'
+
+include Histograffle
+
+reported_incidents = %w[rain thunder confusion fun rain rain theft]
+
+hist_one = Histogram.new
+
+hist_one.eat(reported_incidents)
+
+hist_one.ladder.each do |count|
+  puts "#{count}: #{hist_one[count].join(', ')}"
+end
+
+hist_two = Histogram.new
+
+unreported_incidents = %w[monkey pig concert ufo airplane pig pig concert]
+
+hist_two.eat(unreported_incidents)
+
+hist_one << hist_two
+
+</code>
+</pre>
+
+h3. API quickref
+
+|_@Histograffle::Histogram.new([serialized_data])@_|Create new instance.|
+|_@hist.eat(item_or_array_or_histogram)@_|Add the input. You can add histograms together this way.|
+|_@hist[n]@_|Return the occurrences of which there are _n_.|
+|_@hist.distribution[n]@_|Return the occurrences of which there are _n_.|
+|_@hist.distribution@_|Descending list of occurrence counts.|
+|_@hist.ladder@_|Ascending list of occurrence counts.|
+|_@hist.top(n)@_|Return the top n entries as a hash like @{12 => 'a_word', 2 => 'some other word'}@.|
+|_@hist.flat_top(n)@_|Same as above, return only a list of words with no differentiations.|
+|_@hist << other_hist@_|Add a histogram to another.|
+|_@hist == other_hist@_|True when they contain counts of the same entries.|
+
+There is also @.to_mongo@ and @.from_mongo@ serialization support.
+
+To get copies of the raw data tables (see below), you use @hist.data@ and @hist.lookup@.
+
+h3. Implementation
+
+Each instance stores its data internally, in two hashes, quite simply. The _data_ hash keys occurrences to counts. The _lookup_ hash keys counts to occurrences. Occurrences can be any object.
+
+!http://davidpsydoc.com/brian/pictures/extremely%20random,%20hamburger%20gets%20arrested.jpg!
+"Credit":http://davidpsydoc.com/brian/pictures/extremely%20random
+
+h3. LICENSE
+
+(MIT License)
+
+Copyright (c) 2009 Jostein Berre Eliassen
+
+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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "histograffle"
+    gem.summary = %Q{Count the occurrence of each of several things.}
+    gem.description = %Q{Count the occurrence of each of several things. Pure and banal Ruby.}
+    gem.email = "find.me@on.github"
+    gem.homepage = "http://github.com/jbe/histograffle"
+    gem.authors = ["Jostein B.E."]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+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
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "histograffle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/histograffle.rb

@@ -0,0 +1,114 @@
+
+module Histograffle; end
+
+class Histograffle::Histogram
+
+  def data
+    @data.dup
+  end
+
+  def lookup
+    lu = @lookup.dup
+    lu.each_key do |k|
+      lu[k] = lu[k].dup
+    end
+    lu
+  end
+
+  def initialize(d=[{}, {}])
+    @data   = d[0].dup
+    @lookup = d[1].dup
+    @data.default = 0
+  end
+
+  def eat( o, n=1 )
+    if o.is_a? self.class
+      self << o
+    else
+      o = [o] unless o.respond_to? :each
+      o.each do |t|
+        @data[t] += n
+        @lookup[@data[t]] ||= []
+        @lookup[@data[t]] << t
+        @lookup[@data[t]-n].delete(t) if @lookup[@data[t]-n]
+        @lookup.delete(@data[t]-n) if (@lookup[@data[t]-n] || []).empty?
+      end
+    end
+    self
+  end
+
+  def [](n)
+    @lookup[n]
+  end
+
+  def distribution
+    ladder.reverse
+  end
+
+  def ladder
+    @lookup.keys.sort
+  end
+
+  def top( n )
+    result = {}
+    distribution.each do |count|
+      @lookup[count].each do |word|
+        result[count] ||= []
+        result[count] << word
+        return result if (n -= 1) < 1
+      end
+    end
+    result
+  end
+
+  def flat_top( n )
+    result = []
+    ladder.reverse.each do |count|
+      @lookup[count].each do |word|
+        result << word
+        return result if (n -= 1) < 1
+      end
+    end
+    result
+
+  end
+
+  def <<(other)
+    other.data.each{|k,v| eat(k,v) }
+    self
+  end
+
+  def ==(other)
+    return false unless other.is_a?(self.class)
+    [@data, @lookup] == [other.data, other.lookup]
+  end
+
+  def self.to_mongo(v)
+    # puts "to_mongo:  " + v.inspect
+    return v if v.nil?
+    return Array.to_mongo(v) if v.is_a?(Array)
+    [v.data, stringify_keys(v.lookup)]
+  end
+
+  def self.from_mongo(v)
+    # puts "from_mongo:  " + v.inspect
+    return v if v.nil? || v.is_a?(self)
+    v ? self.new([v[0], intify_keys(v[1])]) : nil
+  end
+
+  private
+    def self.stringify_keys(hsh)
+      r = Hash.new
+      hsh.each do |k,v|
+        r[k.to_s] = v
+      end
+      r
+    end
+    def self.intify_keys(hsh)
+      r = Hash.new
+      hsh.each do |k,v|
+        r[k.to_i] = v
+      end
+      r
+    end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'histograffle'
+
+class Test::Unit::TestCase
+end

data/test/test_histograffle.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHistograffle < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: histograffle
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jostein B.E.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Count the occurrence of each of several things. Pure and banal Ruby.
+email: find.me@on.github
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/histograffle.rb
+- test/helper.rb
+- test/test_histograffle.rb
+has_rdoc: true
+homepage: http://github.com/jbe/histograffle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Count the occurrence of each of several things.
+test_files: 
+- test/helper.rb
+- test/test_histograffle.rb