beastie 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c52cc68533324dfc1d94ca88426850744b211c0a
+  data.tar.gz: aec85bee46e23870970efe04ff84f5db48f1cedc
+SHA512:
+  metadata.gz: 17dbb387afdd0873ae92597dc069be60b549efb6ad744da231cf60c248f8160284769bd0a1161b02200de9962886a2b4220249fa13b636e3c1753ed827e1f991
+  data.tar.gz: 385fef52bde1882313043b40208db029a081c07a5a2f296c31cbc9f7ddd37e66d861fd00f2273149c4612b24b1e34769fd9e5223b6f4d258fcdc97d6142653eb

data/.gitignore

@@ -0,0 +1,19 @@
+*~
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in beastie.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adolfo Villafiorita
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,79 @@
+h1. Beastie
+
+A bare-bones command-line bug tracking system for personal or small projects which require little formality.
+
+h2. Installation
+
+Add this line to your application's Gemfile:
+
+<pre>
+  gem 'beastie'
+</pre>
+
+And then execute:
+
+<pre>
+  $ bundle
+</pre>
+
+Or install it yourself as:
+
+<pre>
+  $ gem install beastie
+</pre>
+
+h2. Usage
+
+Beastie is a bug tracking system at its bare essentials.
+
+Main commands:
+
+- @beastie new@ := asks information about an issue and generate a YAML file in the current directory.
+
+- @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.
+
+- @beastie edit N@ := edits issue @N@.  The commands invokes the editor set in the shell @EDITOR@ variable or use @emacsclient@ if @EDITOR@ is unset.
+
+- @beastie help@ := unleashes the real power of @beastie@.
+
+h2. Limitations and Warnings
+
+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.  
+
+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).
+
+Beastie does not have a specific workflow for bug statutes.
+
+Beastie does not perform syntax checks when reading data.  This can be changed by specifying appropriate input functions in the @ISSUE_FIELDS@ variable (@lib/beastie/issue.rb@).
+
+Beastie asks various information about a bug.  Change the @ISSUE_FIELDS@ variable, if you are not happy with the default fieldset.
+
+
+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? 
+
+# 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
+
+h2. Author
+
+Adolfo Villafiorita
+
+h2. License
+
+"MIT":https://github.com/avillafiorita/beastie/blob/master/LICENSE.txt
+
+h2. Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/beastie.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beastie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "beastie"
+  spec.version       = Beastie::VERSION
+  spec.authors       = ["Adolfo Villafiorita"]
+  spec.email         = ["adolfo.villafiorita@me.com"]
+  spec.description   = %q{A command-line issue and bug tracking system}
+  spec.summary       = %q{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.}
+  spec.homepage      = "https://github.com/avillafiorita/beastie"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/bin/beastie

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+ 
+require_relative '../lib/beastie'
+
+Beastie::Runner.run(ARGV)
+

data/lib/beastie/issue.rb

@@ -0,0 +1,151 @@
+require 'date'
+require 'tempfile'
+require 'yaml'
+
+module Beastie
+  class Issue
+    # A default issue has:
+    #
+    # - title
+    # - status
+    # - created
+    # - component
+    # - priority
+    # - severity
+    # - points
+    # - type
+    # - description
+    #
+    # Customizing the fields:
+    #
+    # - the fields aske by the new command are specified by the
+    #   ISSUE_FIELDS variable
+    #
+    # - for each field, the structure if the following:
+    #
+    #           field name => init 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.
+    # 
+    # - title, created, and status are compulsory: do not delete them
+    #   (gen_filename depends upon title and created; the close
+    #   command depends upon status)
+    #
+    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 '.')"]
+    }
+
+    # which fields go to the report and formatting options
+    REPORT_FIELDS = {
+      "status"   => "%-10s",
+      "type"     => "%-10s",
+      "priority" => "%8s",
+      "severity" => "%8s",
+      "created"  => "%-10s",
+      "title"    => "%-32s"
+    }
+
+    # these keep the actual values
+    attr_reader :issue
+    # 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
+      @issue = Hash.new
+
+      ISSUE_FIELDS.keys.each do |key|
+        puts "#{ISSUE_FIELDS[key][1]}: " if ISSUE_FIELDS[key][1] != ""
+        @issue[key] = (eval ISSUE_FIELDS[key][0]) || ""
+      end
+    end
+    
+    # load from command line
+    def load filename
+      @filename = filename
+      @issue = YAML.load_file(filename)
+    end
+
+    def change field, value
+      @issue[field] = value
+    end
+
+    # save object to file
+    def save
+      @filename = @filename || gen_filename
+
+      file = File.open(@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
+
+    # list all issues in current directory
+    def self.list
+      # print header
+      printf "ID  "
+      REPORT_FIELDS.keys.each do |key|
+        printf REPORT_FIELDS[key] + " ", key
+      end
+      printf "\n"
+
+      # print issues
+      file_no = 0
+      Dir.glob('*.{yml,yaml}') do |file|
+        data = YAML.load_file(file)
+        file_no += 1
+
+        printf "%3d ", file_no
+        REPORT_FIELDS.keys.each do |key|
+          printf REPORT_FIELDS[key] + " ", data[key]
+        end
+        printf "\n"
+      end
+    end
+
+    private 
+   
+    # read n-lines (terminated by a ".")
+    def get_lines
+      $/ = "."  
+      STDIN.gets.chomp(".")
+    end
+    
+    # read an integer
+    def get_int
+      gets.chomp.to_i
+    end
+
+    # return a unique filename for this issue
+    def gen_filename
+      name = @issue["created"].strftime("%Y-%m-%d-") + 
+             @issue["title"].gsub(/\W+/, "_") +
+             ".yaml"
+      n = 1
+      while File.exist?(name)
+        name = File.basename(name, ".yaml") + "-" + n.to_s + ".yaml"
+        n += 1
+      end
+
+      name
+    end
+
+  end
+end

data/lib/beastie/version.rb

@@ -0,0 +1,3 @@
+module Beastie
+  VERSION = "0.1.1"
+end

data/lib/beastie.rb

@@ -0,0 +1,110 @@
+require 'pathname'
+require 'optparse'
+
+require_relative "beastie/version"
+require_relative "beastie/issue"
+
+module Beastie
+
+  # tell option parser to accept an existing directory
+  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 = {}
+
+      # 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
+
+      case command
+
+      when "new"
+        issue = Issue.new
+        issue.ask
+        issue.save
+
+      when "edit"
+        issue_no = args[0].to_i
+        shell_editor = `echo ${EDITOR}`.chomp
+        editor = shell_editor == "" ? EDITOR : shell_editor
+        system("#{editor} #{Issue.filename issue_no}")
+
+      when "show"
+        issue_no = args[0].to_i
+        system("cat #{Issue.filename issue_no}")
+
+      when "change"
+        issue_no = args[0].to_i
+        field = args[1]
+        value = args[2]
+        issue = Issue.new
+        issue.load(Issue.filename issue_no)
+        issue.change field, value
+        issue.save
+
+      when "close"
+        issue_no = args[0].to_i
+        issue = Issue.new
+        issue.load(Issue.filename issue_no)
+        issue.change "status", "closed"
+        issue.save
+        
+      when "list"
+        Beastie::Issue.list
+
+      when "help"
+        help
+        
+      when "version"
+        puts "beastie version #{VERSION}"
+
+      else 
+        help
+      end
+
+    end
+
+    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 "  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
+
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: beastie
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adolfo Villafiorita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 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
+email:
+- adolfo.villafiorita@me.com
+executables:
+- beastie
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- beastie.gemspec
+- bin/beastie
+- lib/beastie.rb
+- lib/beastie/issue.rb
+- lib/beastie/version.rb
+homepage: https://github.com/avillafiorita/beastie
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+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: []