oughtve 110.e2f5bb28

data/.gitignore

@@ -0,0 +1,9 @@
+# General
+*.swp
+*.tmp
+spec/dummy_*
+
+# setup.rb
+.config
+InstalledFiles
+

data/README

@@ -0,0 +1,115 @@
+ Oughtve
+=========
+
+- Shotgun:              $105.95.
+- Beat-up Olds:         $2000.
+- Chemistry 101:        $36.
+
+- Remembering "niktu":  Priceless.
+
+
+ What?
+-------
+
+Oughtve is a very simple command-line- and directory-based
+notation tool, always at your fingertips to avoid the few
+seconds/minutes/aeons that invariably cause you to lose the
+thought you had.
+
+Yeah. It lets you make notes. *And* read them later.
+
+
+ Why?
+------
+
+Because you *will* forget.
+
+
+ Features
+----------
+
+* Notes are grouped based on the working directory they are
+  written from. You might, for example, define a group for
+  each of your coding projects' top directories: any notes
+  you write in or under those directories will be grouped
+  respectively.
+
+* Notes can be "struck out" or closed so that they do not
+  appear in the default listings (e.g. to emulate simple todo
+  lists.)
+
+* Sets of notes in a group can be enclosed as a "chapter", or
+  a completed section. For example, one might close a section
+  once all items for the 0.3.0 release have been completed.
+  This starts a new section and removes the old one from the
+  default views.
+
+* The directory grouping always looks progressively higher in
+  the hierarchy until it finds a defined group, all the way up
+  to the default group bound at / if it comes across none on
+  the way.
+
+* The normal directory lookup and various other things can be
+  overridden with option switches. Sometimes you want to write
+  a note in a specific group from somewhere else in the system:
+  just specify the group name.
+
+* A group's notes can be exported to JSON or YAML (rudimentary.)
+
+
+ Examples
+----------
+
+An extremely curt introduction is found in doc/HOWTO.using.
+
+I like to rename my script to "--", so that I can use the
+following to enter a note:
+
+    $ -- Remember to actually write the HOWTO.
+
+
+ Requirements
+--------------
+
+* Ruby
+** 1.8.7, 1.9.1, 1.9.2, jruby-1.4
+
+* Gems
+** dm-core        >= 0.10.2
+** data_objects   >= 0.10.1
+** do_sqlite3     >= 0.10.1
+
+* Other
+** [SQLite3](http://sqlite.org)
+** UNIXy system.
+
+* Development
+** Gems
+*** RSpec (>= 1.3.0)
+
+
+ Status
+--------
+
+Experimental rewrite of an age-old workhorse of mine. The
+intent of this release is to figure out if anyone else
+finds this useful.
+
+Please break it. 'Some' robustness is needed.
+
+
+ Where?
+--------
+
+    $ gem install oughtve
+
+Source is found on [Github](http://github.com/rue/oughtve).
+
+
+ Who Do I Complain To?
+-----------------------
+
+* oughtve MEOW projects _purr_ kittensoft _rawr_ org.
+* IRC channel #oughtve on Freenode ("rue", in case I
+  am not the only other person on the channel.)
+

data/Rakefile

@@ -0,0 +1,44 @@
+begin
+  require "rubygems"
+    require "jeweler"
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "oughtve"
+
+  gem.version     = "#{`git log --pretty=oneline | wc -l`.chomp}.#{`git log -1 --pretty=oneline`[0...8]}"
+
+
+  gem.summary     = "Command-line tool for notes associated by filesystem location."
+  gem.description = "Command-line tool for notes associated by filesystem location."
+  gem.email       = "oughtve@projects.kittensoft.org"
+  gem.homepage    = "http://github.com/rue/oughtve"
+  gem.authors     = ["Eero Saynatkari"]
+
+  gem.add_runtime_dependency      "dm-core",      ">= 0.10.2"
+  gem.add_runtime_dependency      "data_objects", ">= 0.10.1"
+  gem.add_runtime_dependency      "do_sqlite3",   ">= 0.10.1"
+
+  gem.add_development_dependency  "rspec",        ">= 1.3.0"
+
+  gem.post_install_message = <<-END
+
+  =======================================
+
+  Oughtve has been installed. Please run
+
+      $ oughtve --bootstrap
+
+  to set up your database if you have not
+  used Oughtve before.
+
+  =======================================
+
+  END
+end
+
+Jeweler::GemcutterTasks.new
+

data/bin/oughtve

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+#  LICENCE
+# =========
+#
+#  Authors
+# ---------
+#
+#   See doc/AUTHORS.
+#
+#
+#  Copyright
+# -----------
+#
+#   Copyright (c) 2006-2010 Eero Saynatkari, all rights reserved.
+#
+#
+#  Licence
+# ---------
+#
+#   Redistribution and use in source and binary forms, with or without
+#   modification, are permitted provided that the following conditions
+#   are met:
+#
+#   - Redistributions of source code must retain the above copyright
+#     notice, this list of conditions, the following disclaimer and
+#     attribution to the original authors.
+#
+#   - Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions, the following disclaimer and
+#     attribution to the original authors in the documentation and/or
+#     other materials provided with the distribution.
+#
+#   - The names of the authors may not be used to endorse or promote
+#     products derived from this software without specific prior
+#     written permission.
+#
+#
+#  Disclaimer
+# ------------
+#
+#   This software is provided "as is" and without any express or
+#   implied warranties, including, without limitation, the implied
+#   warranties of merchantability and fitness for a particular purpose.
+#   Authors are not responsible for any damages, direct or indirect.
+#
+
+# Yeah, so we are not really doing much.. there _could_ be a UI here.
+require "oughtve"
+
+begin
+
+  puts Oughtve.run(ARGV)
+
+rescue Exception => e
+  $stderr.puts e.message
+  $stderr.puts e.backtrace.join("\n") if $VERBOSE
+
+  $stderr.puts "Did you run --bootstrap?" if e.message =~ /database/i
+  $stderr.puts "Try #{File.basename $0} --help"
+end
+

data/doc/HOWTO.using

@@ -0,0 +1,131 @@
+ Using Oughtve
+===============
+
+ Installing
+------------
+
+From the root of the source:
+
+    $ sudo ruby setup.rb
+
+This installs libraries in the normal site_ruby and the
+script in the normal bindir. You can naturally change
+the options, see here:
+
+    $ ruby setup.rb --help
+
+
+ Getting Started
+-----------------
+
+I personally like to create a symlink to "--" as the script
+name, which makes jotting notes that much easier. By default,
+the script is just called "oughtve".
+
+First, create your database. Everything is stored in the same
+place:
+
+    $ oughtve --bootstrap
+
+This sets up the DB in ~/.oughtve and creates a default
+group or "tangent" bound at /, so it catches everything.
+
+
+ Write a Note
+--------------
+
+You can try this anywhere in your filesystem, all notes will
+end up in your default group:
+
+    $ oughtve My first note!
+    $ cd /tmp
+    $ oughtve Another one!
+    $ cd back/wherever
+
+Go ahead, make some.
+
+
+ Viewing Notes
+---------------
+
+Did it actually take? Let us find out:
+
+    $ oughtve --show
+
+This should give you the notes you have entered thus far,
+all safely in the default group.
+
+
+ Another Group!
+----------------
+
+OK, time to make a group. For the purposes of this exercise,
+we can do this in your home directory (you could use that
+group as a personal to-do list, for example):
+
+    $ cd ~
+    $ oughtve --new --tangent Personal
+
+And there you go. The --tangent option is used here to *give*
+the name, and can later be used to refer to a name.
+
+
+ Which Group Goes Where?
+-------------------------
+
+To easily see which groups you have defined and where they
+live:
+
+    $ oughtve --list
+
+
+ Try it Out
+------------
+
+With the new group defined, anything under your home directory
+should be getting stored there rather than default:
+
+    $ cd ~
+    $ oughtve First personal note!
+    $ oughtve --show
+
+You should only see the one new note. You can add some more
+from subdirectories of ~, if you like. Then, hop above the
+tree:
+
+    $ cd ~/..
+    $ oughtve --show
+
+This should show you the old default notes. Adding one works
+too:
+
+    $ oughtve Here we are in the default group again.
+    $ oughtve --show
+
+
+ Going Outside the Box
+-----------------------
+
+You can actually address any group explicitly from anywhere
+in the system, even if it would normally be under some other
+group:
+
+    $ cd ~
+    $ oughtve --show --tangent default
+
+Default notes! You can give the --tangent switch to pretty
+much any command to force a specific group, or "tangent",
+to be used. Alternately, you could give the --directory
+switch  but it is mostly useful only when creating new ones.
+
+
+ Then What?
+------------
+
+You can ask oughtve to tell you what it can do to find more
+functionality until such time that I (or you!) write some
+more documentation:
+
+    $ oughtve --help
+
+

data/doc/LICENCE

@@ -0,0 +1,44 @@
+ LICENCE
+=========
+
+ Authors
+---------
+
+See doc/AUTHORS.
+
+
+ Copyright
+-----------
+
+Copyright (c) 2006-2010 Eero Saynatkari, all rights reserved.
+
+
+ Licence
+---------
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions, the following disclaimer and
+  attribution to the original authors.
+
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions, the following disclaimer and
+  attribution to the original authors in the documentation and/or
+  other materials provided with the distribution.
+
+- The names of the authors may not be used to endorse or promote
+  products derived from this software without specific prior
+  written permission.
+
+
+Disclaimer
+------------
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+Authors are not responsible for any damages, direct or indirect.
+

data/doc/README.markdown

@@ -0,0 +1,115 @@
+ Oughtve
+=========
+
+- Shotgun:              $105.95.
+- Beat-up Olds:         $2000.
+- Chemistry 101:        $36.
+
+- Remembering "niktu":  Priceless.
+
+
+ What?
+-------
+
+Oughtve is a very simple command-line- and directory-based
+notation tool, always at your fingertips to avoid the few
+seconds/minutes/aeons that invariably cause you to lose the
+thought you had.
+
+Yeah. It lets you make notes. *And* read them later.
+
+
+ Why?
+------
+
+Because you *will* forget.
+
+
+ Features
+----------
+
+* Notes are grouped based on the working directory they are
+  written from. You might, for example, define a group for
+  each of your coding projects' top directories: any notes
+  you write in or under those directories will be grouped
+  respectively.
+
+* Notes can be "struck out" or closed so that they do not
+  appear in the default listings (e.g. to emulate simple todo
+  lists.)
+
+* Sets of notes in a group can be enclosed as a "chapter", or
+  a completed section. For example, one might close a section
+  once all items for the 0.3.0 release have been completed.
+  This starts a new section and removes the old one from the
+  default views.
+
+* The directory grouping always looks progressively higher in
+  the hierarchy until it finds a defined group, all the way up
+  to the default group bound at / if it comes across none on
+  the way.
+
+* The normal directory lookup and various other things can be
+  overridden with option switches. Sometimes you want to write
+  a note in a specific group from somewhere else in the system:
+  just specify the group name.
+
+* A group's notes can be exported to JSON or YAML (rudimentary.)
+
+
+ Examples
+----------
+
+An extremely curt introduction is found in doc/HOWTO.using.
+
+I like to rename my script to "--", so that I can use the
+following to enter a note:
+
+    $ -- Remember to actually write the HOWTO.
+
+
+ Requirements
+--------------
+
+* Ruby
+** 1.8.7, 1.9.1, 1.9.2, jruby-1.4
+
+* Gems
+** dm-core        >= 0.10.2
+** data_objects   >= 0.10.1
+** do_sqlite3     >= 0.10.1
+
+* Other
+** [SQLite3](http://sqlite.org)
+** UNIXy system.
+
+* Development
+** Gems
+*** RSpec (>= 1.3.0)
+
+
+ Status
+--------
+
+Experimental rewrite of an age-old workhorse of mine. The
+intent of this release is to figure out if anyone else
+finds this useful.
+
+Please break it. 'Some' robustness is needed.
+
+
+ Where?
+--------
+
+    $ gem install oughtve
+
+Source is found on [Github](http://github.com/rue/oughtve).
+
+
+ Who Do I Complain To?
+-----------------------
+
+* oughtve MEOW projects _purr_ kittensoft _rawr_ org.
+* IRC channel #oughtve on Freenode ("rue", in case I
+  am not the only other person on the channel.)
+