crm114 1.0.0 → 1.0.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2006 Arto Bendiken <http://bendiken.net/>
+Copyright (c) 2005-2009 Arto Bendiken <http://ar.to/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README

@@ -1,12 +1,14 @@
-== CRM114 Controllable Regex Mutilator for Ruby
+= CRM114 Controllable Regex Mutilator for Ruby
 
 This is a Ruby interface to the CRM114 Controllable Regex Mutilator, an
 advanced and fast text classifier that uses sparse binary polynomial
 matching with a Bayesian Chain Rule evaluator and a hidden Markov model to
 categorize data with up to a 99.87% accuracy.
 
-The Ruby wrapper grew out of this:
-* http://bendiken.net/2006/07/05/spam-filters-alien-technology-and-ruby-on-rails
+* http://crm114.rubyforge.org
+* http://github.com/bendiken/crm114
+* http://ar.to/2006/07/spam-filters-alien-technology-and-ruby-on-rails
+
 
 === About CRM114
 
@@ -15,45 +17,74 @@ The Ruby wrapper grew out of this:
 * http://en.wikipedia.org/wiki/Dr_Strangelove
 * http://www.paulgraham.com/wsy.html
 
-== Download
-
-* http://rubyforge.org/projects/crm114
-* gem install crm114
-* svn checkout svn://rubyforge.org/var/svn/crm114
-
-== Dependencies
-
-Requires the CRM114 binaries to be installed. Specifically, the '+crm+'
-binary should be accessible in the current user's PATH environment variable.
 
 == Usage
 
 The CRM114 library interface is very similar to that of the
-Classifier[http://rubyforge.org/projects/classifier/] project.
+Classifier[http://rubyforge.org/projects/classifier] project.
 
 Here follows a brief example:
 
   require 'crm114'
+
   crm = Classifier::CRM114.new([:interesting, :boring])
+
   crm.train! :interesting, 'Some data set with a decent signal to noise ratio.'
   crm.train! :boring, 'Pig latin, as in lorem ipsum dolor sit amet.'
+
   crm.classify 'Lorem ipsum'       => [:boring, 0.99]
   crm.interesting? 'Lorem ipsum'   => false
   crm.boring? 'Lorem ipsum'        => true
 
 Have a look at the included unit tests for more comprehensive examples.
 
-== Related Projects
 
+== Dependencies
+
+Requires the CRM114 binaries to be installed. Specifically, the '+crm+'
+binary should be accessible in the current user's +PATH+ environment
+variable.
+
+
+== Download
+
+To get a local working copy of the development repository, do:
+
+  % git clone git://github.com/bendiken/crm114.git
+
+Alternatively, you can download the latest development version as a tarball
+as follows:
+
+  % wget http://github.com/bendiken/crm114/tarball/master
+
+
+== Installation
+
+The recommended installation method is via RubyGems. To install the latest
+official release from RubyForge, do:
+
+  % [sudo] gem install crm114
+
+To use the very latest bleeding-edge development version, install the gem
+directly from GitHub as follows:
+
+  % [sudo] gem install bendiken-crm114 -s http://gems.github.com
+
+
+== Resources
+
+* http://rubyforge.org/projects/crm114
 * http://www.elegantchaos.com/node/129 (crm.py)
-* http://rubyforge.org/projects/classifier/
-* http://rubyforge.org/projects/bishop/
+* http://rubyforge.org/projects/classifier
+* http://rubyforge.org/projects/bishop
+
 
 == Author
 
-Arto Bendiken (mailto:arto.bendiken@gmail.com) - http://bendiken.net
+* Arto Bendiken (mailto:arto.bendiken@gmail.com) - http://ar.to
+
 
 == License
 
-Released under the terms of the MIT license. See the accompanying LICENSE
-file for more information.
+All source code is available under the terms of the MIT license. For more
+information, see the accompanying LICENSE file.

data/Rakefile

@@ -1,41 +1,18 @@
-$:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
-
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'lib')))
 require 'rubygems'
+require 'rakefile' # http://github.com/bendiken/rakefile
 require 'crm114'
 
-PKG_NAME    = 'crm114'
-PKG_VERSION = Classifier::CRM114::VERSION
-PKG_DESC    = 'Ruby interface to the CRM114 Controllable Regex Mutilator text classification engine.'
-PKG_URL     = 'http://crm114.rubyforge.org/'
-
-PKG_AUTHOR  = 'Arto Bendiken'
-PKG_EMAIL   = 'arto.bendiken@gmail.com'
-
-##############################################################################
-
-require 'hoe'
-
-Hoe.new(PKG_NAME, PKG_VERSION) do |p|
-  p.author = PKG_AUTHOR
-  p.email = PKG_EMAIL
-  p.url = PKG_URL
-  p.summary = PKG_DESC
-  p.description = p.paragraphs_of('README', 1).first
-  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.spec_extras = { :rdoc_options => ['--main', 'README'] }
-end
-
-##############################################################################
-
-def egrep(pattern, files)
-  Dir[files].each do |file|
-    File.open(file).readlines.each_with_index do |line, lineno|
-      puts "#{file}:#{lineno + 1}:#{line}" if line =~ pattern
-    end
-  end
-end
-
-desc 'Look for TODO and FIXME tags in the code base.'
-task :todo do
-  egrep /#.*(FIXME|TODO)/, '**/*.rb'
+desc "Generate YARD documentation (with title)"
+task :yardocs => :yardoc do
+  # FIXME: fork YARD and patch it to allow the title to be configured
+  sh "sed -i 's/YARD Documentation/CRM114.rb Documentation/' doc/yard/index.html"
+
+  # TODO: investigate why YARD doesn't auto-link URLs like RDoc does
+  html = File.read(file = 'doc/yard/readme.html')
+  html.gsub!(/>(http:\/\/)([\w\d\.\/\-]+)/, '><a href="\1\2" target="_blank">\2</a>')
+  html.gsub!(/(http:\/\/ar\.to)([^\/]+)/, '<a href="\1" target="_top">ar.to</a>\2')
+  html.gsub!(/(mailto:[^\)]+)/, '<a href="\1">\1</a>')
+  File.open(file, 'wb') { |f| f.puts html }
 end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/crm114.rb

@@ -1,12 +1,12 @@
 # Author::    Arto Bendiken (mailto:arto.bendiken@gmail.com)
-# Copyright:: Copyright (c) 2006 Arto Bendiken.
+# Copyright:: Copyright (c) 2006-2009 Arto Bendiken.
 # License::   MIT
 
 module Classifier
 
   class CRM114
 
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
 
     CLASSIFICATION_TYPE = '<osb unique microgroom>'
     FILE_EXTENSION = '.css'

metadata

@@ -1,63 +1,71 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: crm114
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-11-06 00:00:00 +01:00
-summary: Ruby interface to the CRM114 Controllable Regex Mutilator text classification engine.
-require_paths: 
-- lib
-- test
-email: arto.bendiken@gmail.com
-homepage: http://crm114.rubyforge.org/
-rubyforge_project: crm114
-description: This is a Ruby interface to the CRM114 Controllable Regex Mutilator, an advanced and fast text classifier that uses sparse binary polynomial matching with a Bayesian Chain Rule evaluator and a hidden Markov model to categorize data with up to a 99.87% accuracy.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Arto Bendiken
-files: 
-- CHANGELOG
-- LICENSE
-- Manifest.txt
-- README
-- Rakefile
-- lib/crm114.rb
-- test/test_code_or_text.rb
-- test/test_crm114.rb
-test_files: []
-
-rdoc_options: 
-- --main
-- README
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2009-04-20 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rakefile
+  type: :development
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.2
+        version: "0"
     version: 
+description: "    CRM114.rb is a Ruby interface to the CRM114 Controllable Regex\n    Mutilator, an advanced and fast text classifier that uses sparse binary\n    polynomial matching with a Bayesian Chain Rule evaluator and a hidden\n    Markov model to categorize data with up to a 99.87% accuracy.\n"
+email: arto.bendiken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/crm114.rb
+- test/test_code_or_text.rb
+- test/test_crm114.rb
+has_rdoc: false
+homepage: http://crm114.rubyforge.org/
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- CRM114
+rubyforge_project: crm114
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the CRM114 Controllable Regex Mutilator text classification engine.
+test_files: 
+- test/test_code_or_text.rb
+- test/test_crm114.rb

data/CHANGELOG

@@ -1,3 +0,0 @@
-== 1.0.0 / 2006-11-06
-
-* Initial release of CRM114 library for Ruby.

data/Manifest.txt

@@ -1,8 +0,0 @@
-CHANGELOG
-LICENSE
-Manifest.txt
-README
-Rakefile
-lib/crm114.rb
-test/test_code_or_text.rb
-test/test_crm114.rb