beastie 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f24bc36744a8be167db9a4331e94ecabcab1554
-  data.tar.gz: dd0690cf2c6cf69b88a7db87ec05dc5d6084eaa7
+  metadata.gz: 55a0236d7397dc7dd609866c8626939671311a40
+  data.tar.gz: 4c2bbd746c30ddf062e5e93dcd07585479db165a
 SHA512:
-  metadata.gz: 9a1650acd6767af4d3eeef5e74e71da0024732badab0d388493bd8540f6805418993139db9025621a2e2252e97369eede0429b6012d765e9558585578440f178
-  data.tar.gz: 7ecedb24b9f338fe7ebe4b546dd3df8742b94e231855614ef62e782ad46c5c265cd0e1107f364aff017bd8180b2d411ffbf49fdbfdee95dc8b4e1d6a7d61cc69
+  metadata.gz: a7b1ca0ad1891cfe1b6f977aa540c61637b1a080d6aaefb51f6b2c68762327ca8ece38b671a8a01286e136380f24505ebeffd6c689157af5af512d7db1ae8932
+  data.tar.gz: a29e31ed196abfdf13c16fcc4e227de4b09028ff007acdf90f8be02f88c4dc3c0471307b151d31a1a15eda4852f7cc78e5f2c7a2f7c105d885b7caf0d7655b34

data/README.textile

@@ -54,7 +54,7 @@ For this reason, from version 0.3, @beastie@ supports the following two options
 For instance:
 
 <pre>
-  beastie -d ~/issues show
+  beastie show -d ~/issues
 </pre>
 
 will show all issues stored in the @~/issue@ directory.
@@ -80,13 +80,33 @@ For instance, if @.beastie_projects@ contains:
 then
 
 <pre>
-  $ beastie -p beastie show
+  $ beastie show -p beastie
 </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. Filtering
+
+Beastie has support for filtering data, using the @--where@ option.  The option takes as argument an expression (written in Ruby), defining what issues have to be printed.
+
+For instance:
+
+<pre>
+  beastie list --where "status == 'open'"
+</pre>
+
+will show only the @open@ issues.  More complex expressions can be defined, using Boolean operators:
+
+<pre>
+  beastie list --where "status == 'open' and priority >= 4"
+</pre>
+
+will show open issues with priority greater or equal to 4.
+
+Notice that the expression passes as argument to @--where@ is evaluated in Ruby, so any Ruby expression will work.
+
 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).
@@ -97,20 +117,12 @@ 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:
+Sorting its on the way (but not yet implemented).  Use the power of Unix for that.  For instance:
 
 <pre>
   beastie list | grep -v "^ID" | sort -n -k 4
 </pre>
 
-Exceptions apply.
-
 
 h2. Similar solutions
 
@@ -123,11 +135,11 @@ So... why did I re-invent the wheel?
 # a "programmable" fieldset (see @lib/beastie/issue.rb@)
 # 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.)
+Use @beastie@!  According to @sloccount@, you will be using, for free, a software which costed $4,490 to produce! (This is less than the cost of v 0.3, which was estimated at $8,000.  Jekyll mercenary, in fact, lowered the number of lines of code and the costs estimated with COCOMO.)
 
 h2. Author
 
-Adolfo Villafiorita
+"Adolfo Villafiorita":http://ict4g.org/home/profile/Adolfo_Villafiorita.html
 
 h2. License
 

data/beastie.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+
+  spec.add_dependency "mercenary", "~> 0.3"
 end

data/bin/beastie

@@ -1,6 +1,231 @@
 #!/usr/bin/env ruby
- 
+
+require 'mercenary'
 require_relative '../lib/beastie'
 
-Beastie::Runner.run(ARGV)
+Mercenary.program(:beastie) do |p|
+  EDITOR = "emacsclient"
+
+  p.version Beastie::VERSION
+  p.description 'A simple command-line bug-tracking system'
+  p.syntax "beastie <subcommand> [options] [arguments]"
+
+  p.option 'directory', '--directory DIR', '-d DIR', 'operate on DIR'
+  p.option 'project', '--project PRJ', '-p PRJ', 'operate on project PRJ'
+
+  p.command(:new) do |c|
+    c.syntax "new"
+    c.description "create a new issue"
+
+    c.action do |args, options|
+      if args.size != 0
+        puts "beastie error: too many arguments.\n"
+        puts p.to_s
+        exit 1
+      end
+
+      dir = dest_dir options
+      issue = Beastie::Issue.new dir
+      issue.ask
+      issue.save
+      puts "Issue saved to #{issue.full_filename}."
+    end
+  end
+
+  p.command(:nedit) do |c|
+    c.syntax("nedit title")
+    c.description("create an issue template and edit it with default editor.")
+
+    c.action do |args, options|
+      title = args.join(" ") # get all arguments (so that no " are necessary)
+
+      if title == ""
+        puts "beastie error: please specify the title of the issue.\n"
+        puts p.to_s
+        exit 1
+      end
+
+      dir = dest_dir options
+      issue = Beastie::Issue.new dir
+      issue.set_fields title
+      issue.save
+      system("#{editor_cmd} #{issue.full_filename}")
+    end
+  end
+
+  p.command(:edit) do |c|
+    c.syntax "edit N"
+    c.description "edit issue number N (where N is the output of the list command)"
+
+    c.action do |args, options|
+      dir = dest_dir options
+      issue = Beastie::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"
+        puts p.to_s
+        exit 1
+      end
+
+      issue_no = args[0].to_i
+      system("#{editor_cmd} #{issue.id_to_full_filename issue_no}")
+    end
+  end
+
+  p.command(:list) do |c|
+    c.syntax "list"
+    c.description "list all issues"
+
+    c.option "where", "-w COND", "--where COND", "filter according to condition"
+
+    c.action do |_, options|
+      dir = dest_dir options
+
+      issue = Beastie::Issue.new dir
+      issue.list options["where"] || "true" # it is a string because we eval the argument
+    end
+  end
+
+  p.command(:show) do |c|
+    c.syntax "show N"
+    c.description "show issue with id N (where N is the output of the list command)"
+
+    c.action do |args, options|
+      dir = dest_dir options
+      issue = Beastie::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"
+        puts p.to_s
+        exit 1
+      end
+
+      issue_no = args[0].to_i
+      system("cat #{issue.id_to_full_filename issue_no}")
+    end
+  end
+  
+  p.command(:change) do |c|
+    c.syntax "change N f v"
+    c.description "change value of field 'f' to 'v' in issue N"
+    c.alias "modify"
+
+    c.action do |args, options|
+      dir = dest_dir options
+      issue = Beastie::Issue.new dir
+
+      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"
+        puts p.to_s
+        exit 1
+      end
+
+      issue_no = args[0].to_i
+      field = args[1]
+      value = args[2]
+
+      issue.load_n issue_no
+      issue.change field, value
+      issue.save
+      puts "Issue #{issue_no} has now #{field} set to #{value}."
+    end
+  end
+
+  p.command(:close) do |c|
+    c.syntax "close N"
+    c.description "shortcut for 'change N status closed'"
+
+    c.action do |args, options|
+      dir = dest_dir options
+      issue = Beastie::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"
+        puts p.to_s
+        exit 1
+      end
+
+      issue_no = args[0].to_i
+      issue.load_n issue_no
+      issue.change "status", "closed"
+      issue.save
+      puts "Issue #{issue_no} is now closed."
+    end
+  end
+
+  p.command(:projects) do |c|
+    c.syntax "projects"
+    c.alias "list_projects"
+    c.description "list currently defined projects"
+
+    c.action do |_,_|
+      puts Beastie::ProjectList.to_s
+    end
+  end
+
+  p.command(:version) do |c|
+    c.syntax "version"
+    c.description "print version number (equivalent to beastie -v)"
+
+    c.action do |_,_|
+      puts "This is beastie version #{Beastie::VERSION}"
+    end
+  end
+
+  p.command(:help) do |c|
+    c.syntax "help"
+    c.description "print command usage information (equivalent to beastie -h)"
+
+    c.action do |_,_|
+      puts p.to_s
+    end
+  end
+
+  p.default_command(:help)
+
+  private
+
+  # define the directory in which we will operate
+  def self.dest_dir options
+    if options["project"] then
+      dir = Beastie::ProjectList.project_dir options["project"]
+
+      if dir == nil then
+        name = options["project"]
+        puts "beastie error: nothing known about project #{name}.\n"
+        puts ""
+        puts "add the following lines to #{Beastie::ProjectList::PROJECT_FILE}"
+        puts ""
+        puts "#{name}:"
+        puts "  dir: <directory where #{name} issues live>"
+        exit 1
+      end
+    elsif options["directory"] then
+      dir = options["directory"]
+    else
+      dir = "."
+    end
+
+    if not Dir.exists?(dir)
+      puts "beastie error: the directory does not exist"
+      puts ""
+      puts "if you used -p, please check the #{Beastie::ProjectList::PROJECT_FILE} file"
+      exit 1
+    end
+
+    dir
+  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  
 

data/lib/beastie/issue.rb

@@ -141,7 +141,7 @@ module Beastie
     end
 
     # list all issues in current directory
-    def list
+    def list condition
       # print header
       printf "ID  "
       REPORT_FIELDS.keys.each do |key|
@@ -155,11 +155,28 @@ module Beastie
         data = YAML.load_file(file)
         file_no += 1
 
-        printf "%3d ", file_no
+        # create a string with all the bindings
+        assignments = ""
         REPORT_FIELDS.keys.each do |key|
-          printf REPORT_FIELDS[key] + " ", data[key]
+          # not sure why, but using classes does not work..
+          # so I make them into strings
+          case data[key].class.to_s
+          when "Fixnum"
+            assignments << "#{key} = #{data[key]};"
+          when "String"
+            assignments << "#{key} = '#{data[key]}';"
+          when "Date"
+            assignments << "#{key} = Date.parse('#{data[key]}');"
+          end
+        end
+
+        if eval (assignments + condition) then
+          printf "%3d ", file_no
+          REPORT_FIELDS.keys.each do |key|
+            printf REPORT_FIELDS[key] + " ", data[key]
+          end
+          printf "\n"
         end
-        printf "\n"
       end
     end
 

data/lib/beastie/project_list.rb

@@ -14,6 +14,17 @@ module Beastie
       end
     end
 
+    # an overkill ... system("cat #{PROJECT_FILE}") could work equally well
+    def self.to_s
+      output = ""
+      projects = self.read
+      projects.keys.each do |key|
+        output << "#{key}:\n"
+        output << "  dir: #{projects[key]["dir"]}\n"
+      end
+      output
+    end
+
     private
     
     def self.read

data/lib/beastie/version.rb

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

data/lib/beastie.rb

@@ -1,210 +1,3 @@
-require 'pathname'
-require 'optparse'
-
 require_relative "beastie/version"
 require_relative "beastie/issue"
 require_relative "beastie/project_list"
-
-module Beastie
-
-  # 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
-
-  class Runner
-    # the editor to use with the edit command
-    EDITOR = "emacsclient"
-    
-    def self.run(args)
-
-      # 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
-
-      command = args[0]
-      args.shift
-
-      case command
-
-      when "new"
-        if args.size != 0
-          puts "beastie error: too many arguments.\n"
-          help
-          exit 1
-        end
-
-        issue = Issue.new dir
-        issue.ask
-        issue.save
-        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 dir
-        issue.set_fields title
-        issue.save
-        system("#{editor_cmd} #{issue.full_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"
-        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.id_to_full_filename issue_no}")
-
-      when "modify", "change"
-        issue = Issue.new dir
-
-        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]
-
-        issue.load_n issue_no
-        issue.change field, value
-        issue.save
-        puts "Issue #{issue_no} has now #{field} set to #{value}."
-
-      when "close"
-        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.load_n issue_no
-        issue.change "status", "closed"
-        issue.save
-        puts "Issue #{issue_no} is now closed."
-        
-      when "list"
-        issue = Issue.new dir
-        issue.list
-
-      when "help"
-        help
-        
-      when "version"
-        puts "beastie version #{VERSION}"
-
-      else 
-        help
-      end
-
-    end
-
-    private
-
-    def self.help
-      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beastie
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: A command-line issue and bug tracking system
 email:
 - adolfo.villafiorita@me.com
@@ -78,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A command-line issue and bug tracking system which uses a file per bug, yaml