beastie 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42a7c105f90e9690b9a2c2aeff5d6f9ce642b079
-  data.tar.gz: d64ed0a580dae6f716c7cb8e7d26ad1131225fec
+  metadata.gz: ccbf340538f8102a4cd65ad060dc3d3f55280936
+  data.tar.gz: 5c9c471a6e322b44cc91052c1b10cdfe4b245b60
 SHA512:
-  metadata.gz: 869f0cc4e4adaf5b085da54e7d6d23ea7ccd0d238811d179ee9ad629bf213d8caa416fae27096c71717f6690385d3a83ec117557b06cff9cf93b8e69bb96adf8
-  data.tar.gz: 85c0eb98dc47bf34060374d25ae2c26ecc9a61cc56f4cfb7d2881778f300cf665fcaf558da681770dfe74240c34320ee36d7c3b45c931570affe8e254810ccf2
+  metadata.gz: 22d310d93c27c2b332f8f3d9ecc9b68578cacf66b3fd0d2f713f4b5bc2a3d907130946045b15321f562f68307f6e74563739d5bcc3d8bea33bad6c4fc7b10baa
+  data.tar.gz: 8cb5a966918a470a61ba21da439d7a75701f2fed29fd74543cf7afdd051aed1d8fd4ccc308e3ccf7ca091c9d015d3e3fa32a7ef7a6c25d7303317c9b8a8545f4

data/README.textile

@@ -30,6 +30,8 @@ Main commands:
 
 - @beastie new@ := asks information about an issue and generate a YAML file in the current directory.
 
+- @beastie nedit@ := enter a new issue using the default editor (@nedit@ = new and edit; see @edit@ for the specificaiton of the editor)
+
 - @beastie list@ := reads all YAML files in the current directory and generate a list of all the issues.
 
 - @beastie show N@ := shows issue @N@, where @N@ is the identifier shown by the @beastie list@ command.

data/lib/beastie/issue.rb

@@ -23,37 +23,48 @@ module Beastie
     #
     # - for each field, the structure if the following:
     #
-    #           field name => init value, prompt
+    #           field name => input function, default value, prompt
     # 
     #   where 
-    #   * "init value" is evaluated (use "gets.chomp" to ask input)
-    #   * prompt is what is asked to the user.  Use an empty string for
-    #     a value which is filled automatically.
-    # 
+    #
+    #   * "input function" is a function to ask a value to the user. Use an empty
+    #                      string for a value which is filled automatically
+    #
+    #   * "default value"  is the default value to assign to the field
+    #
+    #   * "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
+    #
     # - title, created, and status are compulsory: do not delete them
     #   (gen_filename depends upon title and created; the close
     #   command depends upon status)
     #
+    INPUT_F=0
+    DEFAULT=1
+    PROMPT=2
+
     ISSUE_FIELDS = {
-      "title"       => ["gets.chomp", "Short description of the issue"], 
-      "status"      => ["'open'",     ""],
-      "created"     => ["Date.today", ""],
-      "component"   => ["gets.chomp", "Component affected by the issue"],
-      "priority"    => ["get_int", "Priority (an integer number, e.g., from 1 to 5)"],
-      "severity"    => ["get_int", "Severity (an integer number, e.g., from 1 to 5)"],
-      "points"      => ["get_int", "Points (an integer estimating the difficulty of the issue)"],
-      "type"        => ["gets.chomp", "Type (e.g., story, task, bug, refactoring)"],
-      "description" => ["get_lines",  "Longer description (terminate with '.')"]
+      "title"       => ["gets.chomp",  "'title'",    "Short description of the issue"], 
+      "status"      => ["",            "'open'",     ""],
+      "created"     => ["",            "Date.today", ""],
+      "component"   => ["gets.chomp",  "''",         "Component affected by the issue"],
+      "priority"    => ["get_int",     "3",          "Priority (an integer number, e.g., from 1 to 5)"],
+      "severity"    => ["get_int",     "3",          "Severity (an integer number, e.g., from 1 to 5)"],
+      "points"      => ["get_int",     "5",          "Points (an integer estimating difficulty of fix)"],
+      "type"        => ["gets.chomp",  "'bug'",      "Type (e.g., story, task, bug, refactoring)"],
+      "description" => ["get_lines",   "''",         "Longer description (terminate with '.')"]
     }
 
     # which fields go to the report and formatting options
     REPORT_FIELDS = {
       "status"   => "%-10s",
-      "type"     => "%-10s",
+      "type"     => "%-12s",
       "priority" => "%8s",
       "severity" => "%8s",
       "created"  => "%-10s",
-      "title"    => "%-32s"
+      "title"    => "%-30s"
     }
 
     # these keep the actual values
@@ -61,13 +72,15 @@ module Beastie
     # the filename, after the issue has been saved or if it has been loaded
     attr_reader :filename
 
-    # interactively ask from command line all fields specified in ISSUE_FIELDS
-    def ask
+    def initialize
       @issue = Hash.new
+    end
 
+    # interactively ask from command line all fields specified in ISSUE_FIELDS
+    def ask
       ISSUE_FIELDS.keys.each do |key|
-        puts "#{ISSUE_FIELDS[key][1]}: " if ISSUE_FIELDS[key][1] != ""
-        @issue[key] = (eval ISSUE_FIELDS[key][0]) || ""
+        puts "#{ISSUE_FIELDS[key][PROMPT]}: " if ISSUE_FIELDS[key][PROMPT] != ""
+        @issue[key] = (eval ISSUE_FIELDS[key][INPUT_F]) || (eval ISSUE_FIELDS[key][DEFAULT])
       end
     end
     
@@ -97,6 +110,12 @@ module Beastie
       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
+    end
+
     # list all issues in current directory
     def self.list
       # print header
@@ -120,6 +139,15 @@ 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 ".")

data/lib/beastie/version.rb

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

data/lib/beastie.rb

@@ -44,21 +44,61 @@ module Beastie
       case command
 
       when "new"
+        if args.size != 0
+          puts "beastie error: too many arguments.\n"
+          help
+          exit 1
+        end
+
         issue = Issue.new
         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}")
 
+      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.set_fields title
+        issue.save
+
+        shell_editor = `echo ${EDITOR}`.chomp
+        editor = shell_editor == "" ? EDITOR : shell_editor
+        system("#{editor} #{issue.filename}")
+
       when "show"
+        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}")
 
       when "change"
+        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
+        end
+
         issue_no = args[0].to_i
         field = args[1]
         value = args[2]
@@ -68,6 +108,12 @@ module Beastie
         issue.save
 
       when "close"
+        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)
@@ -92,19 +138,25 @@ module Beastie
     private
 
     def self.help
-      puts "beastie command args"
+      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 "  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 "  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"
     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
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beastie
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler