apriori 0.2.1

data/tasks/apriori.rake

@@ -0,0 +1,20 @@
+namespace :apriori do
+  desc "Download the example data"
+  task :get_example_data do
+    puts <<-EOF 
+Sorry! This isn't implemented in a portable way just yet.
+If you're on a *nix system try: 
+
+curl -0 http://fimi.cs.helsinki.fi/data/kosarak.dat > examples/test_data/kosarak.dat
+curl -0 http://fimi.cs.helsinki.fi/data/retail.dat > examples/test_data/retail.dat
+
+Patches welcome! (http://github.com/jashmenn/apriori/tree/master)
+EOF
+
+      # open("http://www.ruby-lang.org/") {|f|
+      #       f.each_line {|line| p line}
+      #         }
+      # }
+
+  end
+end

data/tasks/attic.rake

@@ -0,0 +1,28 @@
+# This task is not actually used. 
+# Use "ruby setup.rb" instead. 
+# This task is just here to show you the idea of what is going on
+ext_base = File.join(File.dirname(__FILE__), "ext")
+task "get_it_done" do
+  sh "
+  pushd #{ext_base}/util/src/;
+      rm *.o
+      make;
+      popd;
+  pushd #{ext_base}/math/src;
+      rm *.o
+      # dont need to make this
+      popd;
+  pushd #{ext_base}/apriori/src/;
+      rm *.o;
+      make;
+      popd;
+  pushd #{ext_base};
+      rm *.o;
+      rm *.bundle;
+      rm Makefile;
+      ruby extconf.rb;
+      make;
+      popd;
+      ruby -d test/apriori_test.rb;
+      "
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/install.rake

@@ -0,0 +1,13 @@
+task :extension do
+  # just compile the extension, dont do a typical setup.rb install
+  sh "ruby setup.rb clean"
+  sh "ruby setup.rb config"
+  sh "ruby setup.rb setup"
+end
+
+namespace :github do
+  desc "Generate the Gemspec for github"
+  task :generate_gemspec do
+    sh "rake --silent debug_gem > apriori.gemspec"
+  end
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/apriori_test.rb

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'apriori'; include Apriori; puts do_apriori(["apriori", "test/fixtures/sample.txt", "test/fixtures/results.txt"])
+puts
+puts
+puts
+# puts test_hash_ap("one", "two", :hello => "world")
+# puts do_apriori
+#puts find_association_rules("one", "two", :hello => "world")
+
+# ruby -r 'Apriori/apriori' -e 'include Apriori; puts test_converting_array(["apriori", "test/sample.txt", "test/results.txt"])'
+# puts test1
+# => 10
+# pp help

data/test/fixtures/market_basket_results_test.txt

@@ -0,0 +1,5 @@
+doritos <- beer  (33.3/2, 100.0)
+apple <- doritos  (50.0/3, 33.3)
+cheese <- apple  (66.7/4, 75.0)
+foo <- bar baz  (66.7/4, 75.0)
+foo <- bar baz bangle (66.7/4, 75.0)

data/test/fixtures/market_basket_string_test.txt

@@ -0,0 +1,7 @@
+apple 
+beer doritos
+apple cheese
+beer doritos
+apple cheese
+apple cheese
+apple doritos

data/test/fixtures/results.txt

@@ -0,0 +1,2 @@
+4 <- 2  (28.6, 100.0)
+1 <- 3  (42.9, 100.0)

data/test/fixtures/sample.txt

@@ -0,0 +1,7 @@
+1
+2 4
+1 3 
+2 4
+1 3
+1 3
+1 4

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'pp'
+require File.dirname(__FILE__) + '/../lib/apriori'
+
+FIXTURES_DIR = File.expand_path(File.dirname(__FILE__) + "/fixtures")

data/test/unit/test_apriori.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestApriori < Test::Unit::TestCase
+
+  def setup
+  end
+
+  # require 'apriori'; include Apriori; puts do_apriori(["apriori", "test/fixtures/sample.txt", "test/fixtures/results.txt"])
+  
+  def test_truth
+    input = File.join(FIXTURES_DIR + "/market_basket_string_test.txt")
+    assert rules = Apriori.find_association_rules(input)
+  end
+
+  def test_calling_all_the_options
+    input = File.join(FIXTURES_DIR + "/market_basket_string_test.txt")
+    assert rules = Apriori.find_association_rules(input, 
+                              :min_items => 2,
+                              :max_items => 5,
+                              :min_support => 1, 
+                              :max_support => 100, 
+                              :min_confidence => 20)
+  end
+
+  def test_giving_the_transactions
+    transactions = [  %w{beer doritos},
+                      %w{apple cheese}, 
+                      %w{beer doritos}, 
+                      %w{apple cheese}, 
+                      %w{apple cheese}, 
+                      %w{apple doritos} ]
+
+    rules = Apriori.find_association_rules(transactions,
+                              :min_items => 2,
+                              :max_items => 5,
+                              :min_support => 1, 
+                              :max_support => 100, 
+                              :min_confidence => 20)
+
+    assert is = Apriori::AssociationRule.parse_line("apple <- cheese (50.0/3, 100.0)")
+    assert rules.include?(is)
+
+    # puts rules.join("\n")
+  end
+
+  def test_returning_no_results
+    # currently the application exits. thats no good! just give a message
+    transactions = [  %w{beer doritos},
+                      %w{apple cheese}, 
+                      %w{beer doritos}, 
+                      %w{apple cheese}, 
+                      %w{apple cheese}, 
+                      %w{apple doritos} ]
+
+    # crazy numbers that will never return any rules
+    rules = Apriori.find_association_rules(transactions,
+                              :min_items => 5,
+                              :max_items => 5,
+                              :min_support => 100, 
+                              :max_support => 100, 
+                              :min_confidence => 20)
+
+    assert_equal 0, rules.size
+
+    # also, make notes that if you get more rules, a common thing to do is to reduce the min_support to a very small float
+  end
+
+end

data/test/unit/test_itemsets_and_parsing.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestAssociationRulesAndParsingApriori < Test::Unit::TestCase
+  include Apriori
+
+  def setup
+  end
+
+  def test_reading_from_a_file
+    input = File.join(FIXTURES_DIR + "/market_basket_results_test.txt")
+    assert rules = AssociationRule.from_file(input)
+    assert_equal 5, rules.size
+
+    assert is = AssociationRule.parse_line("apple <- doritos  (50.0/3, 33.3)")
+    assert rules.include?(is)
+    assert is = AssociationRule.parse_line("foo <- bar baz bangle (66.7/4, 75.0)")
+    assert rules.include?(is)
+  end
+
+  def test_parsing_individual_lines
+    assert is = AssociationRule.parse_line("doritos <- beer  (33.3/2, 100.0)")
+    wanted = {
+      :consequent => "doritos",
+      :antecedent => ["beer"],
+      :support => 33.3,
+      :num_antecedent_transactions => 2,
+      :confidence => 100.0,
+    }
+    wanted.each do |key,value|
+      assert_equal value, is.send(key), "Expected itemset '#{key}' to be '#{value}'"
+    end
+    assert_equal "doritos <- beer (33.3/2, 100.0)", is.to_s
+
+    assert is = AssociationRule.parse_line("apple <- doritos  (50.0/3, 33.3)")
+    wanted = {
+      :consequent => "apple",
+      :antecedent => ["doritos"],
+      :support => 50.0,
+      :num_antecedent_transactions => 3,
+      :confidence => 33.3,
+    }
+    wanted.each do |key,value|
+      assert_equal value, is.send(key), "Expected itemset '#{key}' to be '#{value}'"
+    end
+    assert_equal "apple <- doritos (50.0/3, 33.3)", is.to_s
+
+    assert is = AssociationRule.parse_line("foo <- bar baz  (66.7, 75.0)")
+    wanted = {
+      :consequent => "foo",
+      :antecedent => ["bar", "baz"],
+      :support => 66.7,
+      :num_antecedent_transactions => nil,
+      :confidence => 75.0,
+    }
+    wanted.each do |key,value|
+      assert_equal value, is.send(key), "Expected itemset '#{key}' to be '#{value}'"
+    end
+    assert_equal "foo <- bar baz (66.7, 75.0)", is.to_s
+
+    # foo <- bar baz bangle (66.7/4, 75.0)
+    assert is = AssociationRule.parse_line("foo <- bar baz bangle (66.7/4, 75.0)")
+    wanted = {
+      :consequent => "foo",
+      :antecedent => ["bar", "baz", "bangle"],
+      :support => 66.7,
+      :num_antecedent_transactions => 4,
+      :confidence => 75.0,
+    }
+    wanted.each do |key,value|
+      assert_equal value, is.send(key), "Expected itemset '#{key}' to be '#{value}'"
+    end
+    assert_equal "foo <- bar baz bangle (66.7/4, 75.0)", is.to_s
+  end
+
+  def test_association_rule_equality
+    assert is  = AssociationRule.parse_line("doritos <- beer  (33.3/2, 100.0)")
+    assert is2 = AssociationRule.parse_line("doritos <- beer  (33.3/2, 100.0)")
+    assert_equal is, is2
+  end
+
+
+end

data/website/index.html

@@ -0,0 +1,248 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      apriori
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>apriori</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/apriori"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/apriori" class="numbers">0.2.1</a>
+      <img src="images/2118201782_4e87521dc9_m.jpg" />
+    </div>
+    <h1>&#x2192; &#8216;find item associations&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>Ruby Apriori is a library to efficiently find item association rules within
+large sets of transactions. This library provides a Ruby interface to Christian
+Borgelt&#8217;s C implementation of this algorithm.</p>
+
+
+	<p>From Christian Borgelt&#8217;s Apriori:http://www.borgelt.net/apriori.html documentation:</p>
+
+
+	<blockquote>
+		<p>Association rule induction is a powerful method for so-called market basket
+    analysis, which aims at finding regularities in the shopping behavior of
+    customers.</p>
+	</blockquote>
+
+
+	<blockquote>
+		<p>With the induction of association rules one tries to find sets of
+    products that are frequently bought together, so that from the presence of
+    certain products in a shopping cart one can infer (with a high probability)
+    that certain other products are present.</p>
+	</blockquote>
+
+
+	<blockquote>
+		<p>An association rule is a rule like &#8220;If a customer buys wine and bread, he often
+    buys cheese, too.&#8221;</p>
+	</blockquote>
+
+
+	<blockquote>
+		<p>An association rule states that if we pick a customer at random and find out
+    that he selected certain items (bought certain products, chose certain options
+    etc.), we can be confident, quantified by a percentage, that he also selected
+    certain other items (bought certain other products, chose certain other options
+    etc.).</p>
+	</blockquote>
+
+
+	<p>This Ruby library provides a convenient way to use this algorithm from Ruby.</p>
+
+
+	<p>Original Apriori C code by Christian Borgelt.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">gem</span> <span class="ident">install</span> <span class="punct">--</span><span class="ident">source</span> <span class="ident">http</span><span class="punct">:/</span><span class="regex"></span><span class="punct">/</span><span class="ident">gems</span><span class="punct">.</span><span class="ident">github</span><span class="punct">.</span><span class="ident">com</span> <span class="ident">jashmenn</span><span class="punct">-</span><span class="ident">apriori</span></pre></p>
+
+
+	<h2>The Algorithm:</h2>
+
+
+	<p>This document is not an introduction to the Apriori algorithm. To find out more about Apriori see:</p>
+
+
+	<ul>
+	<li><a href="http://www.borgelt.net/papers/cstat_02.pdf">http://www.borgelt.net/papers/cstat_02.pdf</a></li>
+		<li><a href="http://www.borgelt.net/papers/fimi_03.pdf">http://www.borgelt.net/papers/fimi_03.pdf</a></li>
+		<li><a href="http://www.borgelt.net/apriori.html">http://www.borgelt.net/apriori.html</a></li>
+		<li><a href="http://en.wikipedia.org/wiki/Apriori_algorithm">http://en.wikipedia.org/wiki/Apriori_algorithm</a></li>
+	</ul>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<p><pre class='syntax'>
+  <span class="ident">require</span> <span class="punct">'</span><span class="string">apriori</span><span class="punct">'</span>
+
+  <span class="ident">transactions</span> <span class="punct">=</span> <span class="punct">[</span>  <span class="punct">%w{</span><span class="string">beer doritos</span><span class="punct">},</span>
+                    <span class="punct">%w{</span><span class="string">apple cheese</span><span class="punct">},</span> 
+                    <span class="punct">%w{</span><span class="string">beer doritos</span><span class="punct">},</span> 
+                    <span class="punct">%w{</span><span class="string">apple cheese</span><span class="punct">},</span> 
+                    <span class="punct">%w{</span><span class="string">apple cheese</span><span class="punct">},</span> 
+                    <span class="punct">%w{</span><span class="string">apple doritos</span><span class="punct">}</span> <span class="punct">]</span>
+
+  <span class="ident">rules</span> <span class="punct">=</span> <span class="constant">Apriori</span><span class="punct">.</span><span class="ident">find_association_rules</span><span class="punct">(</span><span class="ident">transactions</span><span class="punct">,</span>
+                            <span class="symbol">:min_items</span> <span class="punct">=&gt;</span> <span class="number">2</span><span class="punct">,</span>
+                            <span class="symbol">:max_items</span> <span class="punct">=&gt;</span> <span class="number">5</span><span class="punct">,</span>
+                            <span class="symbol">:min_support</span> <span class="punct">=&gt;</span> <span class="number">1</span><span class="punct">,</span> 
+                            <span class="symbol">:max_support</span> <span class="punct">=&gt;</span> <span class="number">100</span><span class="punct">,</span> 
+                            <span class="symbol">:min_confidence</span> <span class="punct">=&gt;</span> <span class="number">20</span><span class="punct">)</span>
+
+  <span class="ident">puts</span> <span class="ident">rules</span><span class="punct">.</span><span class="ident">join</span><span class="punct">(&quot;</span><span class="string"><span class="escape">\n</span></span><span class="punct">&quot;)</span>
+
+  <span class="comment"># Results: </span>
+  <span class="comment"># doritos &lt;- beer (33.3/2, 100.0)</span>
+  <span class="comment"># beer &lt;- doritos (50.0/3, 66.7)</span>
+  <span class="comment"># apple &lt;- doritos (50.0/3, 33.3)</span>
+  <span class="comment"># doritos &lt;- apple (66.7/4, 25.0)</span>
+  <span class="comment"># apple &lt;- cheese (50.0/3, 100.0)</span>
+  <span class="comment"># cheese &lt;- apple (66.7/4, 75.0)</span>
+
+  <span class="comment"># NOTE:</span>
+  <span class="comment"># doritos &lt;- beer (33.3/2, 100.0)</span>
+  <span class="comment"># means: </span>
+  <span class="comment"># * beer appears in 33.3% (2 total) of the transactions (the support)</span>
+  <span class="comment"># * beer implies doritos 100% of the time (the confidence)</span>
+</pre></p>
+
+
+	<p>See the <ins>examples</ins> directory for more examples of usage.</p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/apriori">http://groups.google.com/group/apriori</a></p>
+
+
+	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; apriori</p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<ul>
+	<li>github: <a href="http://github.com/jashmenn/apriori/tree/master">http://github.com/jashmenn/apriori/tree/master</a></li>
+	</ul>
+
+
+<pre>git clone git://github.com/jashmenn/apriori.git</pre>
+
+	<h3>Build and test instructions</h3>
+
+
+<pre>cd apriori
+rake test
+rake install_gem</pre>
+
+	<p>h3.</p>
+
+
+	<p>If you get the error:</p>
+
+
+	<pre><code>undefined method `add_development_dependency' for #<Gem::Specification:0x2aabcba63ed8></code></pre>
+
+
+	<p>This is because hoe 1.7.0 requires rubygems 1.2.0. To upgrade, simply do the following:</p>
+
+
+	<pre><code>gem update --system</code></pre>
+
+
+	<h2>License</h2>
+
+
+	<h3>Apriori C code</h3>
+
+
+	<p>Copyright&#169; Christian Borgelt</p>
+
+
+	<p>Modified and under the <span class="caps">LGPL</span> license. 
+See <pre>ext/apriori/doc/copying</pre> for details.</p>
+
+
+	<h3>Ruby Apriori Extension</h3>
+
+
+	<p>(The <span class="caps">MIT</span> License)</p>
+
+
+	<p>Copyright&#169; 2008 Nate Murray</p>
+
+
+	<p>Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+&#8216;Software&#8217;), 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:</p>
+
+
+	<p>The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.</p>
+
+
+	<p><span class="caps">THE SOFTWARE IS PROVIDED</span> &#8216;AS IS&#8217;, <span class="caps">WITHOUT WARRANTY OF ANY KIND</span>,
+<span class="caps">EXPRESS OR IMPLIED</span>, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF</span>
+<span class="caps">MERCHANTABILITY</span>, FITNESS <span class="caps">FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT</span>.
+<span class="caps">IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY</span>
+<span class="caps">CLAIM</span>, DAMAGES <span class="caps">OR OTHER LIABILITY</span>, WHETHER <span class="caps">IN AN ACTION OF CONTRACT</span>,
+<span class="caps">TORT OR OTHERWISE</span>, ARISING <span class="caps">FROM</span>, OUT <span class="caps">OF OR IN CONNECTION WITH THE</span>
+<span class="caps">SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE</span>.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:nate@natemurray.com">Nate Murray</a> via the <a href="http://groups.google.com/group/apriori">forum</a></p>
+    <p class="coda">
+      <a href="nate@natemurray.com">Nate Murray</a>, 8th September 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>