beastie 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccbf340538f8102a4cd65ad060dc3d3f55280936
-  data.tar.gz: 5c9c471a6e322b44cc91052c1b10cdfe4b245b60
+  metadata.gz: 6f24bc36744a8be167db9a4331e94ecabcab1554
+  data.tar.gz: dd0690cf2c6cf69b88a7db87ec05dc5d6084eaa7
 SHA512:
-  metadata.gz: 22d310d93c27c2b332f8f3d9ecc9b68578cacf66b3fd0d2f713f4b5bc2a3d907130946045b15321f562f68307f6e74563739d5bcc3d8bea33bad6c4fc7b10baa
-  data.tar.gz: 8cb5a966918a470a61ba21da439d7a75701f2fed29fd74543cf7afdd051aed1d8fd4ccc308e3ccf7ca091c9d015d3e3fa32a7ef7a6c25d7303317c9b8a8545f4
+  metadata.gz: 9a1650acd6767af4d3eeef5e74e71da0024732badab0d388493bd8540f6805418993139db9025621a2e2252e97369eede0429b6012d765e9558585578440f178
+  data.tar.gz: 7ecedb24b9f338fe7ebe4b546dd3df8742b94e231855614ef62e782ad46c5c265cd0e1107f364aff017bd8180b2d411ffbf49fdbfdee95dc8b4e1d6a7d61cc69

data/README.textile

@@ -40,11 +40,56 @@ Main commands:
 
 - @beastie help@ := unleashes the real power of @beastie@.
 
-h2. Limitations and Warnings
+h2. Managing Different Projects
 
-Beastie uses the *current directory* for all operations.  While this gives a lot of flexibility and freedom in choosing one's standards, it also requires discipline: so, make sure you select one directory where issues are stored and always invoke @beastie@ from that directory.  
+By default @beastie@ uses the *current directory* when executing a command. While this makes gives a lot of freedom in choosing one's standards, it also require a lot of discipline (you always need to make sure you are in the right directory) and can be inconvenient at times.  
 
-Beastie tries to generate human-readable filenames, following the convention "Jekyll":http://jekyllrb.com has for blog posts.  Selecting issues using filenames, however, is a bit clumsy and to simplify operations @beastie@ assigns a number to each issue, which can be used to reference them.  The number can be seen with the @list@ command and depends upon the order in which issues are parsed.  Thus *the same issue might be assigned a different id over time*, if the order in which files are read changes (e.g., if a new back-dated issue is added by hand).
+For this reason, from version 0.3, @beastie@ supports the following two options to specify the directory to use when executing a command:
+
+* option @-d@ (@--directory@) to specify the destination directory
+* option @-p@ (@--project@) to use a specific project for a directory
+
+*Option @-d@.* Use @-d <dir>@ (or @--directory <dir>@) to specify the directory in which the command is executed.
+
+For instance:
+
+<pre>
+  beastie -d ~/issues show
+</pre>
+
+will show all issues stored in the @~/issue@ directory.
+
+*Option @-p@.* Use @-p <name>@ (or @--project <name>@) to specify the name of a project and @beastie@ will perform the operation on the directory associated to @<name>@ in the @~/.beastie_projects@ file.
+
+Entries in the @.beastie_projects@ file look like:
+
+<pre>
+<name>:
+  dir: <dir>
+<another name>:
+  dir: <another dir>
+</pre>
+
+For instance, if @.beastie_projects@ contains:
+
+<pre>
+  beastie:
+    dir: /Users/guest/beastie_issues
+</pre>
+
+then
+
+<pre>
+  $ beastie -p beastie show
+</pre>
+
+will show all the issues stored in the @/Users/guest/beastie_issues@ directory.
+
+Use only one of @-d@ or @-p@; if you do not, @-d@ has precedence.
+
+h2. Remarks and Warnings
+
+Beastie generates human-readable filenames, following the convention "Jekyll":http://jekyllrb.com has for blog posts.  Selecting issues using filenames, however, is a bit clumsy and to simplify operations @beastie@ assigns a number to each issue, which can be used to reference them.  The number can be seen with the @list@ command and depends upon the order in which issues are listed in the directory.  Thus *the same issue might be assigned a different id over time*, if the order in which files are read changes (e.g., if a new back-dated issue is added by hand).
 
 Beastie does not have a specific workflow for bug statutes.
 
@@ -52,17 +97,33 @@ Beastie does not perform syntax checks when reading data.  This can be changed b
 
 Beastie asks various information about a bug.  Change the @ISSUE_FIELDS@ variable, if you are not happy with the default fieldset.
 
+Beastie does not have fancy sorting and filtering functions.  The unix commands @sort@ and @grep@ can be reasonable work-arounds.  For instance the list of open bugs can be gotten with:
+
+<pre>
+  beastie list | grep open
+</pre>
+
+To sort issues by priority:
+
+<pre>
+  beastie list | grep -v "^ID" | sort -n -k 4
+</pre>
+
+Exceptions apply.
+
 
 h2. Similar solutions
 
 There are different command-line bug tracking systems.  The ones I came across with before re-inventing the wheel include: ditz, "bugs everywhere":http://bugseverywhere.org, "ticgit-Ng":https://github.com/jeffWelling/ticgit, "bugzyrb":https://github.com/rkumar/bugzyrb, "git-issues":https://github.com/duplys/git-issues, "later":https://github.com/qznc/later.
 
-Why did I re-invent the wheel? 
+So... why did I re-invent the wheel? 
 
 # for fun
 # human-readable filenames, so that I can manage issues without using beastie, if I want
 # a "programmable" fieldset (see @lib/beastie/issue.rb@)
-# keeping the solution simple
+# keeping the solution simple (280 lines of ruby code, according to @sloccount@)
+
+Use @beastie@! According to @sloccount@, you using a software which costed $8,033! (... as you might guess, COCOMO does not work well for small systems.)
 
 h2. Author
 

data/lib/beastie/issue.rb

@@ -35,7 +35,8 @@ module Beastie
     #   * "prompt"         is what is asked to the user.  Use an empty string for
     #                      a value which is filled automatically.
     #
-    # input function and default value are evaluated, so that computation can be performed
+    # input function and default value are evaluated, so that computation can
+    # be performed
     #
     # - title, created, and status are compulsory: do not delete them
     #   (gen_filename depends upon title and created; the close
@@ -67,12 +68,18 @@ module Beastie
       "title"    => "%-30s"
     }
 
-    # these keep the actual values
-    attr_reader :issue
-    # the filename, after the issue has been saved or if it has been loaded
+    # the directory where all issues of this instance are stored
+    attr_reader :dir
+
+    # the filename of this issue.
+    # IT IS ALWAYS A BASENAME. @dir is added only when needed (e.g. load)
     attr_reader :filename
 
-    def initialize
+    # the values (a Hash) of this issue
+    attr_reader :issue
+
+    def initialize directory
+      @dir = directory
       @issue = Hash.new
     end
 
@@ -84,40 +91,57 @@ module Beastie
       end
     end
     
-    # load from command line
-    def load filename
-      @filename = filename
-      @issue = YAML.load_file(filename)
+    # initialize all fields with the default values
+    # (and set title to the argument)
+    def set_fields title
+      ISSUE_FIELDS.keys.each do |k|
+        @issue[k] = eval(ISSUE_FIELDS[k][DEFAULT])
+      end
+      @issue['title'] = title
     end
 
     def change field, value
       @issue[field] = value
     end
 
+    # load from command line
+    def load filename
+      @filename = File.basename(filename)
+      @issue = YAML.load_file(File.join(@dir, @filename))
+    end
+
+    # load by issue id
+    # @dir must be set, which is always the case because of
+    #      the constructor
+    def load_n n
+      load id_to_full_filename n
+    end
+
+    def id_to_full_filename n
+      Dir.glob(File.join(@dir, '*.{yml,yaml}'))[n - 1]
+    end
+
+    # return the full filename, if @filename is set 
+    # (load, save, ...)
+    def full_filename
+      File.join(@dir, @filename)
+    end
+
     # save object to file
     def save
       @filename = @filename || gen_filename
-
-      file = File.open(@filename, 'w') { |f|
+      file = File.open(File.join(@dir, @filename), 'w') { |f|
         f.puts @issue.to_yaml
       }
-
-      puts "Issue saved to #{filename}"
-    end
-
-    # return the n-th filename
-    def self.filename n
-      Dir.glob('*.{yml,yaml}')[n - 1]
     end
 
-    # count all issues in current directory
-    # to get the maximum ID
-    def self.count
-      Dir.glob('*.{yml,yaml}').size
+    # count all issues in current directory to get the maximum ID
+    def count
+      Dir.glob(File.join(@dir, '*.{yml,yaml}')).size
     end
 
     # list all issues in current directory
-    def self.list
+    def list
       # print header
       printf "ID  "
       REPORT_FIELDS.keys.each do |key|
@@ -127,7 +151,7 @@ module Beastie
 
       # print issues
       file_no = 0
-      Dir.glob('*.{yml,yaml}') do |file|
+      Dir.glob(File.join(@dir, '*.{yml,yaml}')) do |file|
         data = YAML.load_file(file)
         file_no += 1
 
@@ -139,15 +163,6 @@ module Beastie
       end
     end
 
-    # initialize all fields with the default values
-    # (and set title to the argument)
-    def set_fields title
-      ISSUE_FIELDS.keys.each do |k|
-        @issue[k] = eval(ISSUE_FIELDS[k][DEFAULT])
-      end
-      @issue['title'] = title
-    end
-
     private 
    
     # read n-lines (terminated by a ".")
@@ -161,13 +176,16 @@ module Beastie
       gets.chomp.to_i
     end
 
-    # return a unique filename for this issue
+    # generate a unique filename for this issue
+    #
+    # (notice that @dir is prepended, to make sure it is unique
+    # in the right directory)
     def gen_filename
       name = @issue["created"].strftime("%Y-%m-%d-") + 
              @issue["title"].gsub(/\W+/, "_") +
              ".yaml"
       n = 1
-      while File.exist?(name)
+      while File.exist?(File.join(@dir, name))
         name = File.basename(name, ".yaml") + "-" + n.to_s + ".yaml"
         n += 1
       end

data/lib/beastie/project_list.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module Beastie
+  class ProjectList
+    PROJECT_FILE="#{Dir.home}/.beastie_projects"
+
+    def self.project_dir project_name
+      projects = read 
+
+      if projects and projects[project_name]
+        projects[project_name]["dir"]
+      else
+        nil
+      end
+    end
+
+    private
+    
+    def self.read
+      File.exists?(PROJECT_FILE) ? YAML.load_file(PROJECT_FILE) : nil
+    end
+
+  end
+end

data/lib/beastie/version.rb

@@ -1,3 +1,3 @@
 module Beastie
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/beastie.rb

@@ -3,41 +3,53 @@ require 'optparse'
 
 require_relative "beastie/version"
 require_relative "beastie/issue"
+require_relative "beastie/project_list"
 
 module Beastie
 
-  # tell option parser to accept an existing directory
+  # add an option to optparser to accept an existing pathname as option
   OptionParser.accept(Pathname) do |pn|
     Pathname.new(pn) if pn
     raise OptionParser::InvalidArgument, pn if not Dir.exist?(pn)
   end
 
-  # Bestie manages issues from the command line.
-  # Each issue is a text file in YAML, whose name is Jekyll-post like: DATE-TITLE.yml
-  #
-  # Two simple commands
-  # - beastie new (create a new issue in the current directory
-  # - beastie list (list relevant firelds of issues stored in the current directory)
-
   class Runner
     # the editor to use with the edit command
     EDITOR = "emacsclient"
     
     def self.run(args)
 
-      # options = {}
+      # default directory is ".", unless -p is specified
+      dir = "."
+      OptionParser.new do |opts|
+        opts.on("-p", "--project name", String,
+                "Use project's dir for operations") do |name|
+          dir = ProjectList.project_dir name
+          
+          if dir == nil then
+            puts "beastie error: nothing known about project #{name}.\n"
+            puts ""
+            puts "add the following lines to #{ProjectList::PROJECT_FILE}"
+            puts ""
+            puts "#{name}:"
+            puts "  dir: <directory where #{name} issues live>"
+            exit 1
+          end
+        end
+
+        opts.on("-d", "--directory name", String,
+                "Use this directory for operations") do |name|
+          dir = name
+        end
+      end.order!.parse!
+
+      if not Dir.exists?(dir)
+        puts "beastie error: the directory does not exist"
+        puts ""
+        puts "if you used -p, please check the #{ProjectList::PROJECT_FILE} file"
+        exit 1
+      end
 
-      # global_options = OptionParser.new do |opts|
-      #   opts.banner = "Usage: beastie [global options] <command> [[command options] <args>]"
-        
-      #   # Mandatory argument.
-      #   opts.on("-d", "--directory DIR", Pathname,
-      #           "Use DIR as the directory to store (and retrieve) issues") do |dir|
-      #     options[:dir] = dir
-      #   end
-      # end
-
-      # global_options.order!
       command = args[0]
       args.shift
 
@@ -50,50 +62,53 @@ module Beastie
           exit 1
         end
 
-        issue = Issue.new
+        issue = Issue.new dir
         issue.ask
         issue.save
-
-      when "edit"
-        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > Issue.count
-          puts "beastie error: please specify an issue.\n\n"
-          help
-          exit 1
-        end
-
-        issue_no = args[0].to_i
-        shell_editor = `echo ${EDITOR}`.chomp
-        editor = shell_editor == "" ? EDITOR : shell_editor
-        system("#{editor} #{Issue.filename issue_no}")
+        puts "Issue saved to #{issue.full_filename}."
 
       when "nedit"
         title = args.join(" ") # get all arguments (so that no " are necessary)
+
         if title == ""
           puts "beastie error: please specify the title of the issue.\n"
           help
           exit 1
         end
 
-        issue = Issue.new
+        issue = Issue.new dir
         issue.set_fields title
         issue.save
+        system("#{editor_cmd} #{issue.full_filename}")
 
-        shell_editor = `echo ${EDITOR}`.chomp
-        editor = shell_editor == "" ? EDITOR : shell_editor
-        system("#{editor} #{issue.filename}")
+      when "edit"
+        issue = Issue.new dir
+
+        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > issue.count
+          puts "beastie error: please specify a valid identifier.\n\n"
+          help
+          exit 1
+        end
+
+        issue_no = args[0].to_i
+        system("#{editor_cmd} #{issue.id_to_full_filename issue_no}")
 
       when "show"
-        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > Issue.count
+        issue = Issue.new dir
+
+        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > issue.count
           puts "beastie error: please specify an issue.\n"
           help
           exit 1
         end
 
         issue_no = args[0].to_i
-        system("cat #{Issue.filename issue_no}")
+        system("cat #{issue.id_to_full_filename issue_no}")
+
+      when "modify", "change"
+        issue = Issue.new dir
 
-      when "change"
-        if args.size != 3 or not digits_only(args[0]) or args[0].to_i > Issue.count
+        if args.size != 3 or not digits_only(args[0]) or args[0].to_i > issue.count
           puts "beastie error: could not parse command line.\n"
           help
           exit 1
@@ -102,26 +117,30 @@ module Beastie
         issue_no = args[0].to_i
         field = args[1]
         value = args[2]
-        issue = Issue.new
-        issue.load(Issue.filename issue_no)
+
+        issue.load_n issue_no
         issue.change field, value
         issue.save
+        puts "Issue #{issue_no} has now #{field} set to #{value}."
 
       when "close"
-        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > Issue.count
+        issue = Issue.new dir
+
+        if args.size != 1 or not digits_only(args[0]) or args[0].to_i > issue.count
           puts "beastie error: please specify an issue.\n"
           help
           exit 1
         end
 
         issue_no = args[0].to_i
-        issue = Issue.new
-        issue.load(Issue.filename issue_no)
+        issue.load_n issue_no
         issue.change "status", "closed"
         issue.save
+        puts "Issue #{issue_no} is now closed."
         
       when "list"
-        Beastie::Issue.list
+        issue = Issue.new dir
+        issue.list
 
       when "help"
         help
@@ -138,25 +157,54 @@ module Beastie
     private
 
     def self.help
-      puts "beastie <command> [<args>]"
-      puts ""
-      puts "A simple command-line bug-tracking system"
-      puts ""
-      puts "Commands:"
-      puts "  new             create a new issue in current directory"
-      puts "  nedit    title  create an issue template and edit it with default editor"
-      puts "  list            list all issues stored in current directory"
-      puts "  edit     N      edit issue with id N (where N is the output of the list command)"
-      puts "  show     N      show issue with id N (where N is the output of the list command)"
-      puts "  change   N f v  change value of field 'f' to 'v' in id N"
-      puts "  close    N      shortcut for 'change N status closed'"
-      puts "  version         print version number"
+      puts <<-eos
+beastie [-p <project> | -d <dir>] <command> [<args>]
+
+A simple command-line bug-tracking system
+
+Global options:
+  -p <project>  (--project) command will operate on <project> (*)
+  -d <dir>      (--directory) command will operate on directory <dir>
+
+Commands:
+  new             create a new issue in current directory
+  nedit    title  create an issue template and edit it with default editor
+  list            list all issues stored in current directory
+  edit     N      edit issue with id N (where N is the output of the list command)
+  show     N      show issue with id N (where N is the output of the list command)
+  change   N f v  change value of field 'f' to 'v' in id N
+  modify   N f v  change value of field 'f' to 'v' in id N
+  close    N      shortcut for 'change N status closed'
+  version         print version number
+
+(*) To use this option, create a file #{ProjectList::PROJECT_FILE} containing
+entries in the form:
+
+<project1>:
+  dir: <dir1>
+<project2>:
+  dir: <dir2>
+
+For instance:
+
+beastie:
+  dir: /Users/guest/beastie
+
+(in which case -p beastie is equivalent to -d /Users/guest/beastie)
+eos
     end
 
     # check if str is composed by digits only
     def self.digits_only str
       str.each_char.map { |x| x >= '0' and x <= '9'}.all?
     end
+
+    # get an editor
+    def self.editor_cmd
+      shell_editor = `echo ${EDITOR}`.chomp
+      shell_editor == "" ? EDITOR : shell_editor
+    end
+
   end
 
 end

data/test/test_project_list.rb

@@ -0,0 +1,47 @@
+require_relative "../lib/beastie/project_list"
+
+require "test/unit"
+require "tempfile"
+ 
+# we need to override the PROJECT_FILE
+class MyTestProjectList < Beastie::ProjectList
+  # a hack to change the PROJECT_FILE constant to point to string
+  def self.project_file string
+    PROJECT_FILE.replace string
+  end
+end
+
+class TestProjectList < Test::Unit::TestCase
+  # if the project file does not exist, nil is returned
+  def test_no_project_file
+    MyTestProjectList.project_file Tempfile.new('foo').path
+    assert_equal(nil, MyTestProjectList.project_dir('foo'))
+  end
+ 
+  # the file exists, it might or might not contain an entry
+  def test_project_file
+    MyTestProjectList.project_file Tempfile.new('foo').path
+    File.open(MyTestProjectList::PROJECT_FILE, "w") do |f|
+      f.puts <<-eos
+foo:
+  dir: /a/b/c
+      eos
+    end
+    assert_equal("/a/b/c", MyTestProjectList.project_dir('foo'))
+    assert_equal(nil, MyTestProjectList.project_dir('foolish'))
+  end
+
+  # the file exists, but it is wrongly configured (no dir entry)
+  def test_wrong_project_file
+    MyTestProjectList.project_file Tempfile.new('foo').path
+    File.open(MyTestProjectList::PROJECT_FILE, "w") do |f|
+      f.puts <<-eos
+foo:
+  directory: /a/b/c
+      eos
+    end
+    assert_equal(nil, MyTestProjectList.project_dir('foo'))
+  end
+
+
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: beastie
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A command-line issue and bug tracking system
@@ -46,7 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.textile
@@ -55,7 +55,9 @@ files:
 - bin/beastie
 - lib/beastie.rb
 - lib/beastie/issue.rb
+- lib/beastie/project_list.rb
 - lib/beastie/version.rb
+- test/test_project_list.rb
 homepage: https://github.com/avillafiorita/beastie
 licenses:
 - MIT
@@ -66,20 +68,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A command-line issue and bug tracking system which uses a file per bug, yaml
   for data storage and it is not opinionated about versioning system, workflows, fieldsets,
   etc.  Useful for small and personal projects when high formality is not required.
-test_files: []
+test_files:
+- test/test_project_list.rb