oughtve 110.e2f5bb28

data/doc/TODO

@@ -0,0 +1,13 @@
+ To Do
+=======
+
+- Improve command parser. Guess more.
+
+- Separate into entry, view, manage scripts.
+
+- Need for several databases?
+
+- Delete orphaned Chapters and Verses.
+
+- Change the stupid names.
+

data/lib/oughtve.rb

@@ -0,0 +1,87 @@
+#  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.
+#
+
+require "fileutils"
+
+
+# Project
+require "oughtve/errors"
+require "oughtve/options"
+
+
+module Oughtve
+
+  #
+  # Directory in which our resources are stored.
+  #
+  ResourceDirectory  = File.expand_path File.join(ENV["HOME"], ".oughtve")
+
+
+  #
+  # Entry point to the library.
+  #
+  # Parses arguments and performs the requested action.
+  #
+  def self.run(arguments)
+    options = parse_from arguments
+
+    Database.connect and self.send options.action, options
+  end
+
+  #
+  # Bootstrap a brand new setup.
+  #
+  def self.bootstrap(*)
+    FileUtils.mkdir_p ResourceDirectory and Database.bootstrap
+    run %w[ --new --tangent default --directory / ]
+
+    "Oughtve has been set up. A default tangent has been created."
+  end
+
+
+end
+
+require "oughtve/database"
+

data/lib/oughtve/chapter.rb

@@ -0,0 +1,93 @@
+#  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.
+#
+
+
+module Oughtve
+
+  # Forward-declare Tangent
+  class Tangent; end
+
+
+  #
+  # A Chapter is a (hopefully) logical section of a Tangent.
+  #
+  class Chapter
+    include DataMapper::Resource
+
+    # Unique identifier
+    property    :id,          Serial
+
+    # Time when closed
+    property    :ended,       Time
+
+    # Summary of what the chapter was about
+    property    :summary,     Text
+
+
+    has n, :verses
+    belongs_to :tangent
+
+
+    #
+    # Hash representation of data, including all verses.
+    #
+    def to_hash()
+      closed, open = verses.partition {|verse| verse.struck }
+      hash = {:open => open.map {|v| v.to_hash },
+              :closed => closed.map {|v| v.to_hash }
+             }
+
+      if ended
+        hash[:ended] = ended
+        hash[:summary] = summary
+      end
+
+      hash
+    end
+
+  end
+
+end
+

data/lib/oughtve/database.rb

@@ -0,0 +1,83 @@
+#  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.
+#
+
+require "rubygems"
+  require "dm-core"
+
+require "oughtve/tangent"
+require "oughtve/chapter"
+require "oughtve/verse"
+
+
+module Oughtve
+
+  module Database
+
+    # The database file path.
+    Path  = File.expand_path "#{Oughtve::ResourceDirectory}/data.db"
+
+    # The full URI to access the DB.
+    URI   = "sqlite3:///#{Path}"
+
+
+    #
+    # Connect to database (new or existing)
+    #
+    def self.connect()
+      DataMapper::Logger.new(STDOUT, :debug) if $VERBOSE
+      DataMapper.setup :default, URI
+    end
+
+    #
+    # Create a brand-new database.
+    #
+    def self.bootstrap()
+      raise OughtveError, "#{Path} already exists!" if File.exist? Path
+      connect and DataMapper.auto_migrate!
+    end
+
+  end
+
+end

data/lib/oughtve/errors.rb

@@ -0,0 +1,6 @@
+
+#
+# Special type for our errors.
+#
+class OughtveError < StandardError; end
+

data/lib/oughtve/options.rb

@@ -0,0 +1,193 @@
+#  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.
+#
+
+require "optparse"
+require "ostruct"
+
+
+module Oughtve
+
+  #
+  # Parse allowed options from given arguments
+  #
+  def self.parse_from(arguments)
+    result = OpenStruct.new
+
+    # Grab time here to be a bit closer to true
+    result.time = Time.now
+
+    def result.action!(given)
+      raise ArgumentError, "Two actions given: 1) --#{action}, 2) --#{given}" if action
+      self.action = given
+    end
+
+    OptionParser.new do |opts|
+
+      opts.banner = "Usage: #{$0} [--ACTION [OPTIONS]]"
+
+      opts.separator ""
+      opts.separator "  Actions:"
+
+
+      # Actions
+
+      opts.on "-s", "--scribe [TEXT]", "Enter a new note." do |text|
+        result.action! :scribe
+        result.text = text
+      end
+
+      opts.on "-S", "--strike [ID_OR_REGEXP]", "Strike out a note." do |id_or_regexp|
+        result.action! :strike
+
+        if id_or_regexp
+          begin
+            result.serial = Integer(id_or_regexp)
+          rescue ArgumentError
+            result.regexp = /#{Regexp.escape id_or_regexp}/
+          end
+        end
+      end
+
+      opts.on "-w", "--show [all | old]", "Show notes for tangent(s). [All notes / old chapters too]" do |specifier|
+        result.action! :show
+
+        if specifier
+          case specifier
+          when "all"
+            result.all = true
+          when "old"
+            result.all = true
+            result.old = true
+          else
+            raise ArgumentError, "--show #{specifier} is not a valid option!" 
+          end
+        end
+      end
+
+      opts.on "-l", "--list", "Show defined Tangents and their base directories." do
+        result.action! :list
+      end
+
+      opts.on "-c", "--chapter ENDNOTE", "Mark end of chapter and start new one." do |endnote|
+        result.action! :chapter
+        result.endnote = endnote
+      end
+
+
+      # Options
+      opts.separator ""
+      opts.separator "  Maintenance Actions:"
+
+      opts.on "-b", "--bootstrap", "Set up database and initial structures." do
+        result.action! :bootstrap
+      end
+
+      opts.on "-n", "--new", "Create new Tangent. (Use -t to give it a name.)" do
+        result.action! :tangent
+      end
+
+      opts.on "-D", "--delete [NAME]", "Delete tangent." do |name|
+        result.action! :delete
+        result.name = name
+      end
+
+
+      # Options
+      opts.separator ""
+      opts.separator "  Options:"
+
+      opts.on "-d", "--directory DIR", "Use given directory instead of Dir.pwd." do |dir|
+        result.dir = dir
+      end
+
+      opts.on "-i", "--id ID", "Use specific note ID." do |id|
+        result.serial = id
+      end
+
+      opts.on "-m", "--match REGEXP", "Match note using regexp, specific branch only." do |regexp|
+        result.regexp = /#{Regexp.escape regexp}/
+      end
+
+      opts.on "-t", "--tangent NAME", "Use named Tangent specifically." do |name|
+        result.name = name
+      end
+
+      opts.on "-x", "--text TEXT", "Text to use for note." do |text|
+        result.text = text
+      end
+
+      opts.on "-v", "--verbose", "Give extra information for some actions." do
+        result.verbose = true
+      end
+
+      opts.on "-J", "--json", "JSON output" do
+        result.format = :json
+      end
+
+      opts.on "-Y", "--yaml", "YAML output" do
+        result.format = :yaml
+      end
+
+
+      # Bookkeeping stuff
+
+      opts.on_tail "-h", "--help", "Display this message." do
+        puts opts
+        exit!
+      end
+
+    end.parse! arguments
+
+  rescue OptionParser::InvalidOption => e
+    $stderr.print "\n#{e.message}\n\n"
+    parse_from %w[ -h ]
+
+  else
+    result.rest = arguments
+    result.action = :scribe unless result.action
+    result
+  end
+
+end