carps 0.2.1

data/lib/carps/ui/error.rb

@@ -0,0 +1,39 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/ui/colour"
+
+module CARPS
+
+   module UI
+
+      # Output an error message
+      #
+      # If the second parameter is true, the error message will begin with
+      # "Error:"
+      def UI::put_error msg, default_error=true
+         h = HighLine.new
+         prelude = ""
+         if default_error
+            prelude = "Error:  "
+         end
+         $stderr.write h.color("#{prelude}#{msg}", :error)
+         puts "\a"
+      end
+
+   end
+end

data/lib/carps/ui/highlight.rb

@@ -0,0 +1,32 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "highline"
+
+module CARPS
+
+   module UI
+
+      # Highlight text
+      def UI::highlight text
+         h = HighLine.new
+         puts h.color text, :magenta, :bold
+      end
+
+   end
+
+end

data/lib/carps/ui/question.rb

@@ -0,0 +1,63 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "highline"
+
+require "carps/ui/colour"
+
+module CARPS
+
+   module UI
+
+      # Because we mess with the modes, and we're meant to run in a safe environment, need to hack highline.
+      HighLine::SystemExtensions.module_eval do
+         def restore_mode
+            @state.untaint
+            system "stty #{@state}"
+         end
+      end
+
+      # Ask a question, return a boolean
+      def UI::confirm question
+         h = HighLine.new
+         resp = h.ask h.color("#{question}\n(Type anything beginning with y to accept)", :green)
+         resp[0] == "y"
+      end
+
+      # Ask a question.  Get a string for an answer
+      #
+      # Calls untaint on the answer
+      def UI::question msg
+         h = HighLine.new
+         res = h.ask h.color(msg, :green)
+         # Trust the user
+         res.untaint
+      end
+
+      # Ask a question and don't echo what is typed.
+      #
+      # Calls untaint on the password
+      def UI::secret msg
+         h = HighLine.new
+         ooh = h.ask(h.color(msg, :green)) {|q| q.echo = "*"}
+         h.untaint
+         ooh
+      end
+
+   end
+
+end

data/lib/carps/ui/warn.rb

@@ -0,0 +1,37 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/ui/colour"
+
+module CARPS
+
+   module UI
+
+      # Print a warning message to stderr
+      def UI::warn reason, *msgs
+         h = HighLine.new
+         $stderr.write h.color("Warning:\n", :warning)
+         $stderr.write h.color(reason + "\n", :warning)
+         msgs.each do |msg|
+            $stderr.write msg + "\n"
+         end
+         puts "\a" 
+      end
+
+   end
+
+end

data/lib/carps/ui.rb

@@ -0,0 +1,21 @@
+# Copyright 2010 John Morrice
+ 
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/ui/error"
+require "carps/ui/warn"
+require "carps/ui/question"
+require "carps/ui/highlight"

data/lib/carps/util/config.rb

@@ -0,0 +1,162 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/util/error"
+
+require "carps/ui/warn"
+
+require "yaml"
+
+module CARPS
+
+   # Configuration files that read yaml
+   class YamlConfig 
+
+      # Should we fail hard, quiting the program?
+      def fail_hard fatal
+         @fatal = fatal
+      end
+
+      # Read a resource using the subclass' parse_yaml.
+      #
+      # Then load this resource using the subclass' load_resource
+      def read filepath
+         filepath = $CONFIG + filepath
+         contents = ""
+         result = nil
+         # Try to read the  file
+         begin
+            contents = File.read filepath
+         rescue
+            # On failure, write a message to stderr and exit
+            err "Could not read configuration file: " + filepath 
+         end
+
+         # Try to parse the file
+         begin
+            conf = YAML.load contents
+            result = parse_yaml conf
+         rescue
+            err "Error parsing #{filepath}:\n#{$!}"
+         end
+
+         if result
+            load_resources *result
+         end
+      end
+
+      protected
+
+      # Save as a YAML file
+      def save_file path
+         y = emit.to_yaml 
+         begin
+            file = File.new $CONFIG + path, "w"
+            file.write y
+            file.close
+         rescue StandardError => e
+            UI::warn "Could not save #{self.class} as #{path}: #{e}"
+         end
+      end
+
+      # Emit as yaml
+      def emit
+      end
+
+      # Subclasses must create a method parse_yaml which takes YAML returns an array
+      def parse_yaml conf
+         []
+      end
+
+      # Subclasses may create a method load_resource
+      #
+      # This is called after parse_yaml - hence errors which occur here are not attributed to parsing the configuration file
+      #
+      # Takes each element of parse_yaml's return array as an argument, as in
+      # it is called with the result of parse_yaml, like so: 
+      #
+      # load_resources *parse_yaml conf 
+      def load_resources *forget
+      end
+
+      # Attempt to find field within the conf hash
+      #
+      # Untaints the field. 
+      def read_conf conf, field
+         unless conf.include? field
+            raise "Could not find field: #{field}"
+         end
+         conf[field].untaint
+      end
+
+      # Raise error
+      def err msg
+         if @fatal
+            CARPS::fatal msg
+         else
+            raise StandardError, msg
+         end
+      end
+
+   end
+
+   # User configurations, which may be stored in many files
+   # and which should not crash the system on an error
+   class UserConfig < YamlConfig
+
+      # Subclasses must call super
+      def initialize
+         fail_hard false
+      end
+
+      # Load a user file.
+      def self.load filepath
+         config = self.allocate
+         config.read filepath
+         config.fail_hard false 
+         config
+      end
+
+   end
+
+   # System configurations, which exist in strictly predefined locations
+   # and which should crash the system if they do not exist, because they
+   # are critical to its operation.
+   class SystemConfig < YamlConfig
+
+      # Subclasses must call super
+      def initialize
+         fail_hard true
+      end
+
+      # Load a system file.
+      def self.load
+         config = self.allocate
+         config.read self.filepath
+         config.fail_hard false 
+         config
+      end
+
+      # Save the user config
+      def save
+         save_file self.class.filepath
+      end
+      
+
+   end
+
+end

data/lib/carps/util/editor.rb

@@ -0,0 +1,147 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/util"
+
+require "carps/ui/error"
+
+require "carps/test"
+
+require "fileutils"
+
+require "tempfile"
+
+module CARPS
+
+   # Expects a field called "launch_editor"
+   class Editor < SystemConfig
+
+      def Editor.filepath
+         "editor.yaml"
+      end
+
+      def initialize editor, wait_for_confirm = false
+         @editor = editor
+         @wait_confirm = wait_for_confirm
+      end
+
+      def parse_yaml config
+         @editor = read_conf config, "launch_editor"
+         @wait_confirm = read_conf config, "wait"
+      end
+
+      # Edit a string
+      #
+      # Performs an untaint operation
+      #
+      # Not re-entrant
+      def edit msg
+         begin
+            dir = Dir.tmpdir.untaint
+            unless File.exists?(dir)
+               FileUtils.mkdir dir
+            end
+            file = Tempfile.new "carp_edit", dir
+            path = file.path
+            file.write "# Lines starting with # will be ignored.\n" + msg 
+            file.close
+            contents = edit_file path
+            contents.untaint
+            lines = contents.split /\n/
+               lines.reject! do |line|
+               line[0] == '#'
+               end
+            lines.join "\n"
+         rescue StandardError => e
+            UI::put_error e.to_s
+            nil
+         end
+      end
+
+      protected
+
+      def edit_file filepath
+         system @editor.gsub("%f", filepath)
+
+         if @wait_confirm
+            UI::question "Press enter when you are done editing."
+         end
+
+         if File.exists? filepath
+            return File.read filepath
+         else
+            return ""
+         end
+      end
+
+
+      # Emit as hash
+      def emit
+         {
+            "launch_editor" => @editor,
+            "wait" => @wait_confirm
+         }
+      end
+
+   end
+
+   module Test
+
+
+      # Testing for editor
+      module Editor
+
+         def Editor::load_fail
+            Editor::test_failed "The editor did not load the file correctly."
+         end
+
+         def Editor::save_fail
+            Editor::test_failed "The editor did not save the file correctly."
+         end
+
+      end
+
+      # Test the editor
+      def Test::editor editor
+         puts "The editor should launch, then you should edit this paragraph:"
+         before = "Please edit me."
+         puts before
+         puts "Once you are done editing, save the file and close the editor."
+         if after = editor.edit(before)
+            if after == before
+               Test::multi_fail "Your editor is detaching itself into the background.", "You did not edit the paragraph.  Do so!", "The editor did not save the file correctly.", "The editor did not load the file correctly."
+            else
+               before_good = UI::confirm "Before you starting editing, did the editor display this text?\n#{before}"
+               if before_good
+                  after_good = UI::confirm "Did you change that to this?\n#{after}"
+                  if after_good
+                     return true
+                  else
+                     Editor::save_fail
+                  end
+               else
+                  Editor::load_fail
+               end
+            end
+         else
+            Editor::save_fail
+         end
+
+      end
+   end
+
+end

data/lib/carps/util/error.rb

@@ -0,0 +1,75 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/ui"
+require "carps/util"
+
+module CARPS
+
+
+   # Press enter to quit
+   def CARPS::enter_quit status=0
+      UI::question "Press enter to quit."
+      CARPS::shutdown_properly status 
+   end
+
+   # Output an error message and quit with exit code 1
+   def CARPS::fatal msg
+      h = HighLine.new
+      $stderr.write h.color("\nFATAL ERROR\n#{msg}\n", :error)
+      puts "\a"
+      exit 1
+   end
+
+
+   # Kill all threads and exit with status
+   def CARPS::shutdown_properly status
+      # Stop all threads
+      Thread.list.each do |thr|
+         unless thr == Thread.main
+            Thread.kill thr
+            thr.join
+         end
+      end
+      exit status
+   end
+
+   # Catch errors and print out a stack trace if they occur.
+   #
+   # If wait is true, then wait for the user to press enter.
+   #
+   # Pass a block.
+   #
+   # Intented to be run at the top level (Eg by the binaries)
+   def CARPS::with_crash_report wait=false
+      begin
+         yield
+      rescue SystemExit => e
+         CARPS::shutdown_properly e.status
+      rescue Interrupt => e
+         CARPS::shutdown_properly 1
+      rescue Exception => e
+         UI::put_error "CRASHED!\n#{e.class} reports:\n   #{e.message}\n\nStack trace:\n#{e.backtrace.join("\n")}", false
+         if wait
+            CARPS::enter_quit 1
+         else
+            CARPS::shutdown_properly 1
+         end
+      end
+   end
+
+end

data/lib/carps/util/files.rb

@@ -0,0 +1,48 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+module CARPS
+
+   # Get the file names from inside a directory
+   def files dir
+      file_names = Dir.open(dir).entries.reject do |file|
+         file.untaint
+         file[0] == "." or File.ftype(dir + "/" + file) != "file" 
+      end
+      file_names.map do |fn|
+         dir + "/" + fn
+      end
+   end
+
+   # Write contents into a new file in a directory with an arbitrary, unique name
+   #
+   # Returns the path
+   def write_file_in dir, contents
+      t = Time.now
+      valid_path = false
+      path = $CONFIG + dir + "/" + t.to_f.to_s.gsub(/(\.|@, \?!#'"~\(\))/, "")
+      until valid_path
+         path += "_"
+         valid_path = not(File.exists?(path))
+      end
+      file = File.new path, "w"
+      file.write contents
+      file.close
+      path
+   end
+
+end