oughtve 110.e2f5bb28

data/spec/spec.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby -w
+
+# The spec files are designed to be run one at a time
+# because it removes the necessity of completely tearing
+# down the DB bootstrap which is *exceedingly* difficult in
+# any ORM.
+
+require "fileutils"
+require "tmpdir"
+
+specdir = File.expand_path "#{File.dirname __FILE__}"
+dummy_dir = File.join specdir, "/dummy_home_dir_#{$$}"
+
+FileUtils.rm_r  dummy_dir, :secure => true  rescue nil
+
+
+# Raw output?
+raw = if ARGV.first == "--raw"
+        ARGV.shift
+        true
+      end
+
+# Split any files from options to pass to the spec program
+split = ARGV.index "--"
+
+opts  = if split
+          ARGV.slice!((split + 1)..-1).join ' '
+        else
+          '-f s'
+        end
+
+files = if ARGV.empty?
+          Dir.glob "#{specdir}/*_spec.rb"
+        else
+          ARGV.pop if split
+          ARGV.map {|f| "#{specdir}/#{File.basename(f)}" }
+        end
+
+begin
+  real_home = ENV['HOME']
+  ENV['HOME'] = dummy_dir
+
+  start = Time.now
+  examples, fails, pending = 0, 0, 0
+
+  files.each do |spec|
+    FileUtils.mkdir dummy_dir
+
+    puts "\n\n    ***********************************"
+    puts "\n    #{spec}:"
+    puts "\n    ***********************************\n"
+
+    if raw
+      pid = fork {
+        exec "spec", opts, File.expand_path(spec)
+      }
+
+      Process.waitpid pid
+    else
+      output = `spec #{opts} #{File.expand_path(spec)}`
+
+      stats = output.scan(/(\d+) examples?, (\d+) failures?(?:, (\d+) pending)?/).first
+
+      examples += stats[0].to_i
+      fails += stats[1].to_i
+      pending += stats[2].to_i if stats[2]
+
+
+      puts output
+    end
+
+    FileUtils.rm_r  dummy_dir, :secure => true rescue nil
+  end
+
+  unless raw
+    puts "\n\n========================\n"
+    puts "     Totals: #{fails} failures out of #{examples} examples."
+    puts "             #{pending} marked pending."
+    puts "     Time:   #{Time.now - start}s\n"
+    puts
+  end
+
+ensure
+  FileUtils.rm_r dummy_dir, :secure => true rescue nil
+  ENV['HOME'] = real_home
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# Ensure this current set is before any installed ones
+#
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "oughtve"
+
+# Sandbox, see spec.rb.
+Oughtve.run %w[ --bootstrap ]
+

data/spec/strike_spec.rb

@@ -0,0 +1,150 @@
+require File.join File.dirname(__FILE__), "spec_helper"
+
+describe Oughtve, "marking notes done or closed with --strike using the note's ID" do
+
+  before :each do
+    Oughtve.run %w[ --new --tangent tangy --directory /tmp ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi bob! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi Mike! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi james! ]
+  end
+
+  after :each do
+    Oughtve::Tangent.all(:name.not => "default").each {|t| t.destroy }
+  end
+
+  it "it sets the 'stricken' field to the time stricken" do
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (!!verse.struck).should == false
+
+    before = Time.now.to_f
+    Oughtve.run "--strike --id #{verse.id}".split(" ")
+    after = Time.now.to_f
+
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (before..after).should include(verse.struck.to_f)
+  end
+
+  it "raises if the ID does not exist" do
+    lambda { Oughtve.run %w[ --strike --id 100 ] }.should raise_error
+  end
+
+end
+
+describe Oughtve, "marking notes done or closed with --strike using text matching" do
+
+  before :each do
+    Oughtve.run %w[ --new --tangent tangy --directory /tmp ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi bob! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi Mike! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi james! ]
+  end
+
+  after :each do
+    Oughtve::Tangent.all(:name.not => "default").each {|t| t.destroy }
+  end
+
+  it "sets the stricken field if given text is an unambiguous regexp match to an open note in current tangent" do
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (!!verse.struck).should == false
+
+    before = Time.now.to_f
+    Oughtve.run %w[--strike --tangent tangy --match Hi\ j ]
+    after = Time.now.to_f
+
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (before..after).should include(verse.struck.to_f)
+  end
+
+  it "raises if Note cannot be matched" do
+    lambda {
+      Oughtve.run %w[--strike --tangent tangy --match hi\ james ]
+    }.should raise_error
+  end
+
+  it "raises if Note cannot be matched unambiguously" do
+    lambda {
+      Oughtve.run %w[--strike --tangent tangy --match Hi ]
+    }.should raise_error
+  end
+
+end
+
+describe Oughtve, "striking notes with parameter directly to --strike" do
+
+  before :each do
+    Oughtve.run %w[ --new --tangent tangy --directory /tmp ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi bob! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi Mike! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi james! ]
+  end
+
+  after :each do
+    Oughtve::Tangent.all(:name.not => "default").each {|t| t.destroy }
+  end
+
+  it "uses parameter as Integer when possible" do
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (!!verse.struck).should == false
+
+    before = Time.now.to_f
+    Oughtve.run %W[--strike #{verse.id} --tangent tangy ]
+    after = Time.now.to_f
+
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (before..after).should include(verse.struck.to_f)
+  end
+
+  it "uses parameter as regular expression if it is not an Integer" do
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (!!verse.struck).should == false
+
+    before = Time.now.to_f
+    Oughtve.run %w[ --strike Hi\ j --tangent tangy ]
+    after = Time.now.to_f
+
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (before..after).should include(verse.struck.to_f)
+  end
+
+end
+
+describe Oughtve, "marking notes done or closed with --strike" do
+
+  before :each do
+    Oughtve.run %w[ --new --tangent tangy --directory /tmp ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi bob! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi Mike! ]
+    Oughtve.run %w[ --scribe --tangent tangy Hi james! ]
+  end
+
+  after :each do
+    Oughtve::Tangent.all(:name.not => "default").each {|t| t.destroy }
+  end
+
+  it "raises if note already stricken" do
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (!!verse.struck).should == false
+
+    before = Time.now.to_f
+    Oughtve.run %w[--strike --tangent tangy --match Hi\ j ]
+    after = Time.now.to_f
+
+    verse = Oughtve::Tangent.first(:name => "tangy").current_chapter.verses.last
+
+    (before..after).should include(verse.struck.to_f)
+
+    lambda { Oughtve.run %w[ --strike --tangent tangy --match Hi\ j ] }.should raise_error
+  end
+
+end
+

data/spec/tangent_locating_spec.rb

@@ -0,0 +1,63 @@
+require File.join File.dirname(__FILE__), "spec_helper"
+
+require "fileutils"
+require "ostruct"
+
+
+describe Oughtve, "locating tangents" do
+  before :all do
+    @specdir = File.expand_path "#{Dir.pwd}/spec"
+    @one_up = File.expand_path "#{Dir.pwd}/.."
+    @two_up = File.expand_path "#{Dir.pwd}/../.."
+    @three_up = File.expand_path "#{Dir.pwd}/../../.."
+    @four_up = File.expand_path "#{Dir.pwd}/../../../.."
+
+    Oughtve.run "--new --tangent one_down   --directory #{@one_up}".split /\s/
+    Oughtve.run "--new --tangent three_down --directory #{@three_up}".split /\s/
+  end
+
+  it "uses current directory's tangent if there is one" do
+    Dir.chdir @one_up do
+      Oughtve.tangent_for(OpenStruct.new :dir => Dir.pwd).name.should == "one_down"
+    end
+
+    Dir.chdir @three_up do
+      Oughtve.tangent_for(OpenStruct.new :dir => Dir.pwd).name.should == "three_down"
+    end
+  end
+
+  it "climbs straight up directory hierarchy until finding directory with a tangent" do
+    Dir.chdir @specdir do
+      Oughtve.tangent_for(OpenStruct.new :dir => Dir.pwd).name.should == "one_down"
+    end
+
+    Dir.chdir @two_up do
+      Oughtve.tangent_for(OpenStruct.new :dir => Dir.pwd).name.should == "three_down"
+    end
+  end
+
+  it "falls back on default at / if no others match along the way" do
+    Dir.chdir @four_up do
+      Oughtve.tangent_for(OpenStruct.new :dir => Dir.pwd).name.should == "default"
+    end
+  end
+
+  it "by default only checks by name if name given even if tangent exists for path" do
+    Oughtve.tangent_for(OpenStruct.new :dir => @one_up, :name => "moo").should == nil
+  end
+
+  it "checks path if nonexisting name given if forced with second parameter" do
+    Oughtve.tangent_for(OpenStruct.new(:dir => @one_up, :name => "moo"), :check_path).name.should == "one_down"
+  end
+
+  it "raises if both name and directory given but do not match the same one" do
+    lambda {
+      Oughtve.tangent_for(OpenStruct.new :dir => @one_up, :name => "three_down")
+    }.should raise_error
+
+    lambda {
+      Oughtve.tangent_for(OpenStruct.new(:dir => @one_up, :name => "three_down"), :check_path)
+    }.should raise_error
+  end
+
+end

data/spec/tangent_spec.rb

@@ -0,0 +1,211 @@
+require File.join File.dirname(__FILE__), "spec_helper"
+
+
+describe Oughtve, "creating a new Tangent with --tangent when directory given" do
+
+  after :each do
+    Oughtve::Tangent.all(:dir.not => "/").each {|t| t.destroy }
+  end
+
+  it "creates a new Tangent for the specified directory path" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --directory /usr ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == "/usr"
+  end
+
+  it "does not create a Tangent for the current directory" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --directory /usr ]
+
+    Oughtve::Tangent.all(:dir => File.dirname(__FILE__)).size.should == 0
+  end
+
+  it "expands the directory name given" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --tangent two --dir ./ ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == Dir.pwd
+    tangents.first.name.should == "two"
+  end
+
+  it "raises if the directory does not exist" do
+    lambda { Oughtve.run %w[ --new --dir /uggabugga ] }.should raise_error(ArgumentError)
+  end
+
+end
+
+describe Oughtve, "creating a new Tangent with --tangent when name given" do
+
+  after :each do
+    Oughtve::Tangent.all(:dir.not => "/").each {|t| t.destroy }
+  end
+
+  it "stores the given name for the Tangent" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --tangent tangy\ toobs --directory /tmp ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == "/tmp"
+    tangents.first.name.should == "tangy toobs"
+  end
+
+end
+
+describe Oughtve, "creating a new Tangent with --tangent without a name" do
+
+  after :each do
+    Oughtve::Tangent.all(:dir.not => "/").each {|t| t.destroy }
+  end
+
+  it "uses the path as the Tangent's name also" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --directory /tmp ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == "/tmp"
+    tangents.first.name.should == "/tmp"
+  end
+
+end
+
+describe Oughtve, "creating a new Tangent" do
+
+  before :all do
+    @dummyroot = "/tmp/oughtve_tangent_spec_#{$$}_#{Time.now.to_i}"
+    @dummyhigher = File.join @dummyroot, "first"
+    @dummylower = File.join @dummyhigher, "second"
+
+    FileUtils.mkdir_p @dummylower
+  end
+
+  after :each do
+    Oughtve::Tangent.all(:dir.not => "/").each {|t| t.destroy }
+    $stderr = STDERR
+  end
+
+  after :all do
+    FileUtils.rm_r @dummyroot, :secure => true
+  end
+
+  it "uses current directory as the path if none is supplied" do
+    Oughtve::Tangent.all(:dir.not => "/").size.should == 0
+
+    Oughtve.run %w[ --new --tangent hi\ there ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == Dir.pwd
+    tangents.first.name.should == "hi there"
+  end
+
+  it "raises if a Tangent already exists for this exact path" do
+    Oughtve.run %w[ --new --tangent hi ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == Dir.pwd
+    tangents.first.name.should == "hi"
+
+    lambda { Oughtve.run %w[ --new --tangent hola ] }.should raise_error
+  end
+
+  it "raises if a Tangent already exists with the same name" do
+    Oughtve.run %w[ --new --tangent hi --directory /tmp ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == "/tmp"
+    tangents.first.name.should == "hi"
+
+    lambda { Oughtve.run %w[ --new --tangent hi ] }.should raise_error
+  end
+
+  it "can create a new Tangent below an existing one in the file hierarchy" do
+    Oughtve.run %W[ --new --tangent hi --directory #{@dummyhigher} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == @dummyhigher
+    tangents.first.name.should == "hi"
+
+    Oughtve.run %W[ --new --tangent ho --directory #{@dummylower} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 2
+
+    tangents.first.dir.should == @dummyhigher
+    tangents.first.name.should == "hi"
+
+    tangents.last.dir.should == @dummylower
+    tangents.last.name.should == "ho"
+  end
+
+  it "can create a new Tangent above an existing one in the file hierarchy" do
+    Oughtve.run %W[ --new --tangent hi --directory #{@dummylower} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+    tangents.first.dir.should == @dummylower
+    tangents.first.name.should == "hi"
+
+    Oughtve.run %W[ --new --tangent ho --directory #{@dummyhigher} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 2
+
+    tangents.first.dir.should == @dummylower
+    tangents.first.name.should == "hi"
+
+    tangents.last.dir.should == @dummyhigher
+    tangents.last.name.should == "ho"
+  end
+
+  # TODO: This will quite likely fail because RSpec sucks.
+  it "prints a warning if new Tangent being created above existing one" do
+    pending "RSpec does not support grabbing output."
+    
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    Oughtve.run %W[ --new --tangent hi --directory #{@dummylower} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 1
+
+    Oughtve.run %W[ --new --tangent ho --directory #{@dummyhigher} ]
+
+    tangents = Oughtve::Tangent.all :dir.not => "/"
+    tangents.size.should == 2
+
+    out = $stdout.read.chomp
+    err = $stderr.read.chomp
+
+    [out, err].any? {|str| str =~ /above/ }.should == true
+  end
+
+  # @todo This is expected to fail because RSpec sucks. --rue
+  it "raises an error if the path does not exist in the filesystem" do
+    nonesuch = "/foobar/#{$$}/#{Time.now.to_i}/#{rand 100}"
+    File.exist?(nonesuch).should == false
+    lambda { Oughtve.run %W[ --new --tangent hi --directory #{nonesuch} ] }.should raise_error
+  end
+
+  it "creates the initial Chapter associated with the Tangent" do
+    Oughtve.run %w[ --new --tangent something --directory /tmp ]
+
+    tangent = Oughtve::Tangent.all(:dir.not => "/").first
+    tangent.chapters.size.should == 1
+  end
+end