keyword_prospector 0.8.0

data/spec/match_spec.rb

@@ -0,0 +1,140 @@
+# 
+# (C) 2008 Los Angeles Times
+# 
+require File.dirname(__FILE__) + '/spec_helper'
+require 'match'
+
+describe Match do
+  describe "spaceship operator" do
+    it "returns -1 when start position of other is greater than start position of self" do
+      match = Match.new(:dont_care, 1, 5)
+      other_matches = [Match.new(:dont_care, 5, 7),
+                       Match.new(:dont_care, 2, 7),
+                       Match.new(:dont_care, 2, 3)]
+
+      other_matches.each do |m|
+        (match <=> m).should == -1
+      end
+    end
+
+    it "returns -1 when start positions are equal and end position of other is greater than end position of self" do
+      match = Match.new(:dont_care, 1, 5)
+      other_matches = [Match.new(:dont_care, 1, 7),
+                       Match.new(:dont_care, 1, 9)]
+
+      other_matches.each do |m|
+        (match <=> m).should == -1
+      end
+    end
+
+    it "returns 0 when start position and end position are the same" do
+      [[0, 7], [1, 13], [7, 9]].each do |values|
+        match1 = Match.new(:dont_care, values[0], values[1])
+        match2 = Match.new(:dont_care, values[0], values[1])
+
+        (match1 <=> match2).should == 0
+      end
+    end
+
+    it "returns 1 when start position of other is less than start position of self" do
+      match = Match.new(:dont_care, 5, 9)
+      other_matches = [Match.new(:dont_care, 1, 4),
+                       Match.new(:dont_care, 2, 6),
+                       Match.new(:dont_care, 4, 11)]
+
+      other_matches.each do |m|
+        (match <=> m).should == 1
+      end
+    end
+
+    it "returns 1 when start positions are equal and end position of other is less than end position of self" do
+      match = Match.new(:dont_care, 5, 9)
+      other_matches = [Match.new(:dont_care, 5, 6),
+                       Match.new(:dont_care, 5, 8)]
+
+      other_matches.each do |m|
+        (match <=> m).should == 1
+      end
+    end
+  end
+
+  describe "accessors" do
+    before(:each) do
+      @match = Match.new(:first, :second, :third, :fourth)
+    end
+
+    it "keyword, start, and end should be assigned correctly" do
+      @match.keyword.should == :first
+      @match.start_idx.should == :second
+      @match.end_idx.should == :third
+      @match.output.should == :fourth
+    end
+  end
+
+  describe "overlap?" do
+    it "should return false when there is no overlap" do
+      match1 = Match.new("foo", 1, 4)
+      match2 = Match.new("bar", 7, 10)
+
+      should_not_overlap(match1, match2)
+    end
+
+    it "should return true when there is an overlap" do
+      match1 = Match.new("foo", 1, 4)
+      match2 = Match.new("bar", 2, 10)
+
+      should_overlap(match1, match2)
+    end
+
+    it "should return false when matches are consecutive" do
+      match1 = Match.new("foo", 1, 4)
+      match2 = Match.new("bar", 4, 10)
+
+      should_not_overlap(match1, match2)
+    end
+
+    it "should return true when overlap is one character" do
+      match1 = Match.new("foo", 1, 4)
+      match2 = Match.new("bar", 3, 10)
+
+      should_overlap(match1, match2)
+    end
+
+    def should_not_overlap(a, b)
+      a.overlap?(b).should == false
+      b.overlap?(a).should == false
+    end
+
+    def should_overlap(a, b)
+      a.overlap?(b).should == true
+      b.overlap?(a).should == true
+    end
+  end
+
+  describe "length" do
+    it "should return the difference between start and end indices" do
+      [[1, 4], [2, 7]].each do |start_idx, end_idx|
+        Match.new("don't care", start_idx, end_idx).length.should ==
+                                                          end_idx - start_idx
+      end
+    end
+  end
+
+  describe "equality" do
+    it "should be true if matches occupy same space regardless of keyword" do
+      m1 = Match.new("foo", 1, 7)
+      m2 = Match.new("bar", 1, 7)
+
+      m1.should == m2
+    end
+
+    it "should be false if matches don't occupy same space" do
+      m1 = Match.new("foo", 1, 7)
+      m2 = Match.new("bar", 2, 7)
+      m3 = Match.new("bar", 1, 6)
+
+      m1.should_not == m2
+      m1.should_not == m3
+    end
+  end
+end

data/spec/search_and_replace_spec.rb

@@ -0,0 +1,58 @@
+# 
+# (C) 2008 Los Angeles Times
+# 
+require File.dirname(__FILE__) + '/spec_helper'
+require 'search_and_replace'
+
+describe SearchAndReplace do
+  before(:each) do
+    @sar = SearchAndReplace.new
+  end
+
+  describe :add_replacement do
+    it "should take an original and a replacement" do
+      @sar.add_replacement("original", "replacement")
+    end
+  end
+
+  describe :replace_text do
+    before(:each) do
+      @sar.add_replacement("original", "replacement")
+      @sar.add_replacement("foo", "bar")
+    end
+
+    it "should replace text" do
+      @sar.replace_text("original").should == "replacement"
+    end
+
+    it "should replace text at the beginning of the string" do
+      @sar.replace_text("original is me").should == "replacement is me"
+    end
+
+    it "should replace text in the middle of the string" do
+      @sar.replace_text("is original me").should == "is replacement me"
+    end
+
+    it "should replace text at the end of the string" do
+      @sar.replace_text("me is original").should == "me is replacement"
+    end
+
+    it "should replace multiple instances of the same word" do
+      @sar.replace_text("original original original").should == "replacement replacement replacement"
+    end
+
+    it "should replace multiple words" do
+      @sar.replace_text("original foo original foo").should == "replacement bar replacement bar"
+    end
+
+    it "should have no trouble with html code" do
+      link = '<a href="http://travel.latimes.com/destinations/bar-url">bar</a>'
+      @sar.add_replacement(link, "bar")
+      @sar.replace_text(link).should == "bar"
+    end
+
+    it "respects word boundaries" do
+      @sar.replace_text("football").should == "football"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'keyword_prospector'

data/spec/state_spec.rb

@@ -0,0 +1,128 @@
+# 
+# (C) 2008 Los Angeles Times
+# 
+require File.dirname(__FILE__) + '/spec_helper'
+require 'state'
+
+describe State do
+  before(:each) do
+    @state = State.new(:char)
+  end
+
+  describe "initializer" do
+    it "should increment id for each new object" do
+      state1 = State.new(:char)
+      state2 = State.new(:char)
+      state3 = State.new(:char)
+
+      state2.id.should > state1.id
+
+      state3.id.should > state2.id
+    end
+    
+    it "should initialize char with the value passed" do
+      state = State.new(:value)
+      state.char.should == :value
+    end
+  end
+
+  describe "should have accessor" do
+    [:fail, :fail_increment, :output, :depth, :keyword].each do |method|
+      it method do
+        @state.send(method.to_s + "=", :any_object)
+        @state.send(method.to_s).should == :any_object
+      end
+    end
+  end
+
+  describe "children" do
+    it "should initially be nil" do
+      @state[:char].should == nil
+    end
+
+    it "should be assignable" do
+      @state[:char] = :value
+      @state[:char].should == :value
+    end
+
+    it "should have their keys available" do
+      keys = [?a, ?b, ?c]
+      keys.each {|key| @state[key] = :dont_care}
+
+      @state.keys.sort.should == keys
+    end
+
+    it "should have their values available" do
+      values = [?a, ?b, ?c]
+
+      values.size.times do |time|
+        @state[time] = values[time]
+      end
+
+      @state.values.sort.should == values
+    end
+  end
+
+  describe "insert_next_state" do
+    it "should create a new state initialized with the value provided" do
+      child_state = State.new(:char)
+      State.should_receive(:new).with(:char, 1).and_return(child_state)
+
+      @state.insert_next_state(:char)
+
+      @state[:char].should be_eql(child_state)
+    end
+
+    it "should not create a new child state if one already exists" do
+      child_state = State.new(:char)
+      State.should_receive(:new).exactly(1).times.with(:char, 1).
+        and_return(child_state)
+
+      @state.insert_next_state(:char)
+      @state.insert_next_state(:char)
+
+      @state[:char].should be_eql(child_state)
+    end
+  end
+
+  describe "transition" do
+    it "should return next state selected by char" do
+      @state[:char] = :next_state
+      @state.transition(:char).should == :next_state
+    end
+
+    it "to self should increment start position and set end position to equal start" do
+      @state[:char] = @state
+      position = Object.new
+      position.should_receive(:begin).and_return(1)
+      position.should_receive(:begin=).with(2)
+      position.should_receive(:end=).with(2)
+
+      @state.transition(:char, position)
+    end
+
+    it "should increment end position by one if state is found" do
+      position = Object.new
+      position.should_receive(:end).and_return(42)
+      position.should_receive(:end=).with(43)
+
+      @state[:char] = :next_state
+
+      @state.transition(:char, position)
+    end
+
+    describe "failures" do
+      before(:each) do
+        @fail_state = State.new(:dont_care)
+        @state.fail = @fail_state
+      end
+
+      it "should transition from fail state if next state doesn't exist" do
+        @fail_state.should_receive(:transition).with(:char).
+          and_return(:fail_state_transition)
+
+        @state.transition(:char).should == :fail_state_transition
+      end
+    end
+  end
+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/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+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/website/index.html

@@ -0,0 +1,141 @@
+<!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>
+      keyword_prospector
+  </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>keyword_prospector</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/keyword_prospector"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/keyword_prospector" class="numbers">0.8.0</a>
+    </div>
+    <h1>&#x2192; &#8216;keyword_prospector&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">keyword_prospector</span></pre></p>
+
+
+	<h2>The basics</h2>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/keyword_prospector">http://groups.google.com/group/keyword_prospector</a></p>
+
+
+	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; keyword_prospector</p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+
+
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/keyword_prospector/trunk</code> for anonymous access.</p>
+
+
+	<p><span class="caps">OOOORRRR</span></p>
+
+
+	<p>You can fetch the source from either:</p>
+
+
+	<ul>
+	<li>rubyforge: <span class="caps">MISSING IN ACTION</span></li>
+	</ul>
+
+
+	<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
+
+
+	<p>When you do this, this message will magically disappear!</p>
+
+
+	<p>Or you can hack website/index.txt and make it all go away!!</p>
+
+
+	<ul>
+	<li>github: <a href="http://github.com/GITHUB_USERNAME/keyword_prospector/tree/master">http://github.com/GITHUB_USERNAME/keyword_prospector/tree/master</a></li>
+	</ul>
+
+
+<pre>git clone git://github.com/GITHUB_USERNAME/keyword_prospector.git</pre>
+
+	<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+
+
+	<ul>
+	<li>gitorious: <a href="git://gitorious.org/keyword_prospector/mainline.git">git://gitorious.org/keyword_prospector/mainline.git</a></li>
+	</ul>
+
+
+<pre>git clone git://gitorious.org/keyword_prospector/mainline.git</pre>
+
+	<h3>Build and test instructions</h3>
+
+
+<pre>cd keyword_prospector
+rake test
+rake install_gem</pre>
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/keyword_prospector">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 11th August 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>

data/website/index.txt

@@ -0,0 +1,83 @@
+h1. keyword_prospector
+
+h1. → 'keyword_prospector'
+
+
+h2. What
+
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install keyword_prospector</pre>
+
+h2. The basics
+
+
+h2. Demonstration of usage
+
+
+
+h2. Forum
+
+"http://groups.google.com/group/keyword_prospector":http://groups.google.com/group/keyword_prospector
+
+TODO - create Google Group - keyword_prospector
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+TODO - pick SVN or Git instructions
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/keyword_prospector/trunk</code> for anonymous access.
+
+OOOORRRR
+
+You can fetch the source from either:
+
+<% if rubyforge_project_id %>
+
+* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
+
+<pre>git clone git://rubyforge.org/keyword_prospector.git</pre>
+
+<% else %>
+
+* rubyforge: MISSING IN ACTION
+
+TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects' id information.
+
+When you do this, this message will magically disappear!
+
+Or you can hack website/index.txt and make it all go away!!
+
+<% end %>
+
+* github: "http://github.com/GITHUB_USERNAME/keyword_prospector/tree/master":http://github.com/GITHUB_USERNAME/keyword_prospector/tree/master
+
+<pre>git clone git://github.com/GITHUB_USERNAME/keyword_prospector.git</pre>
+
+
+TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
+
+
+* gitorious: "git://gitorious.org/keyword_prospector/mainline.git":git://gitorious.org/keyword_prospector/mainline.git
+
+<pre>git clone git://gitorious.org/keyword_prospector/mainline.git</pre>
+
+h3. Build and test instructions
+
+<pre>cd keyword_prospector
+rake test
+rake install_gem</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/keyword_prospector
+