pain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c4206b23bae5c9b227f43d0418a8bbfabe7d8d3
+  data.tar.gz: 8c6753d6ba640cacbd626c6833624f1d8f4774b7
+SHA512:
+  metadata.gz: 248b2f22e0ec30f3c514a322fd83e9a6ec22bee38f11577db7e8ff603e4cab3b03a3ceb6e6551f3c19cd47b48bddbec2eb605eb70cac3abddb1e8887b9abf6b9
+  data.tar.gz: d4f5f6f7696d4a16dade07df3769684a4972eaf2189bbffeeb7b3400b0f7bce8a305044e045c2ae615107743cd6a7cdd32627bdb9731c53a1785c4fed500f705

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Exclude:
+  - spec/**
+  - pain.gemspec
+
+Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in user_pain.gemspec
+gemspec
+
+gem 'rubocop'
+gem 'coveralls', require: false
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andy Nicholson
+
+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.md

@@ -0,0 +1,25 @@
+# Pain
+
+Quickly gauge the User Pain a bug will cause.
+Basically stolen from http://www.lostgarden.com/2008/05/improving-bug-triage-with-user-pain.html
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install pain
+
+## Usage
+
+    Usage: pain [options]
+        -l, --likelihood [LIKELIHOOD]    How likely is this bug to occur?
+        -i, --impact [IMPACT]            How much impact will this bug have?
+        -t, --type [TYPE]                What kind of bug is this?
+
+## Contributing
+
+1. Fork it ( https://github.com/anicholson/pain/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/pain

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'term/ansicolor'
+require 'pain'
+
+include Pain
+
+class String
+  include Term::ANSIColor
+end
+
+def get_color(value)
+  offset = case value
+           when :trivial
+             40
+           when :minor
+             69
+           when :standard
+             184
+           when :major
+             202
+           when :critical
+             9
+           else
+             252
+     end
+  Term::ANSIColor::Attribute[offset]
+end
+
+def case_danger(danger)
+  if danger < 0.21
+    :trivial
+  elsif danger < 0.41
+    :minor
+  elsif danger < 0.65
+    :standard
+  elsif danger < 0.81
+    :major
+  else
+    :critical
+  end
+end
+
+def total_danger(danger)
+  if danger < 21
+    :trivial
+  elsif danger < 31
+    :minor
+  elsif danger < 51
+    :standard
+  elsif danger < 75
+    :major
+  else
+    :critical
+  end
+end
+
+def color_output(msg, danger = :normal)
+  level = if danger == :normal
+            :default
+    elsif danger.is_a? Symbol
+      danger
+    else
+            case_danger(danger)
+    end
+  puts msg.color(get_color(level))
+end
+
+def display_options_for(input)
+  ceiling = Pain::OPTIONS[input].count
+  Pain::OPTIONS[input].each do |v, msg|
+    color_output("#{v}: #{msg}", (v/ceiling.to_f))
+  end
+  puts
+end
+
+def ask_question_for(input)
+  color_output Pain::INPUT_MESSAGE[input]
+end
+
+def print_report_for(o)
+  pain = Pain.user_pain(o[:bug_type], o[:likelihood], o[:impact])
+
+  levels = o.reduce({}) do |hash, (input, level)|
+    hash[input] = case_danger(level.to_f /  Pain::MAX[input])
+    hash
+  end
+
+  color_output  "Type:       #{o[:bug_type]} - #{Pain::OPTIONS[:bug_type][o[:bug_type]]}", levels[:bug_type]
+  color_output  "Likelihood: #{o[:likelihood]} - #{Pain::OPTIONS[:likelihood][o[:likelihood]]}", levels[:likelihood]
+  color_output  "Impact:     #{o[:impact]} - #{Pain::OPTIONS[:impact][o[:impact]]}", levels[:impact]
+  puts
+  color_output "User Pain: #{pain}", total_danger(pain)
+end
+
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.on('-l', '--likelihood [LIKELIHOOD]', OptionParser::DecimalInteger,
+    'How likely is this bug to occur?') do |like|
+    options[:likelihood] = Pain::normalize(like, :likelihood)
+  end
+
+  opts.on('-i', '--impact [IMPACT]', OptionParser::DecimalInteger,
+    'How much impact will this bug have?') do |impact|
+    options[:impact] = Pain.normalize(impact, :impact)
+  end
+
+  opts.on('-t', '--type [TYPE]', OptionParser::DecimalInteger,
+    'What kind of bug is this?') do |bug_type|
+    options[:bug_type] = Pain.normalize(bug_type, :bug_type)
+  end
+end.parse!
+
+[:bug_type, :likelihood, :impact].each do |input|
+  first = true
+  until options[input]
+    ask_question_for input
+    display_options_for(input) if first
+
+    response       = gets.chomp
+    options[input] = Pain::normalize(response, input)
+    first          = false
+  end
+end
+
+print_report_for options

data/lib/pain.rb

@@ -0,0 +1,62 @@
+require 'pain/version'
+require 'optparse'
+require 'ostruct'
+
+module Pain
+  MAX  = {
+    bug_type:   7,
+    likelihood: 5,
+    impact:     5
+  }
+
+  INPUT_MESSAGE  = {
+    bug_type:   'What kind of bug is this?',
+    likelihood: 'How likely is this bug to occur?',
+    impact:     'How much impact will this bug have?'
+  }
+
+  OPTIONS = {
+    bug_type: {
+      1 => 'Documentation: a documentation issue',
+      2 => 'Localization: missing translations',
+      3 => 'Visual Polish: Aesthetic issues',
+      4 => 'Balancing: allows poor usage strategy',
+      5 => 'Minor UX: Impairs UX in secondary scenarios',
+      6 => 'Major UX: Impairs UX in key scenarios',
+      7 => 'Crash: Causes crash or data loss'
+    },
+    likelihood: {
+      1 => 'Will affect almost no one',
+      2 => 'Will only affect a few users',
+      3 => 'Will affect average number of users',
+      4 => 'Will affect most users',
+      5 => 'Will affect all users'
+    },
+
+    impact: {
+      1 => 'Nuisance: not a big deal bug noticeable.',
+      2 => 'A Pain: Users won\'t like this once they notice it.',
+      3 => 'Affects Buy-in. Will show up in review. Clearly noticeable.',
+      4 => 'A user would return the product. Should not deploy until fixed',
+      5 => 'Affects system build'
+    }
+  }
+
+  def max_pain
+    MAX.values.reduce(&:*)
+  end
+
+  def user_pain(type, likelihood, impact)
+    100 * (type * likelihood * impact) / max_pain
+  end
+
+  def normalize(value, variable)
+    value = value.to_i
+    max   = MAX[variable]
+
+    return nil if max.nil? || value.nil?
+    return nil if value < 1
+    return max if value > max
+    value
+  end
+end

data/lib/pain/version.rb

@@ -0,0 +1,3 @@
+module Pain
+  VERSION = '0.0.1'
+end

data/pain.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pain'
+  spec.version       = Pain::VERSION
+  spec.authors       = ['Andy Nicholson']
+  spec.email         = ['andrew@anicholson.net']
+  spec.summary       = %q{Quickly calculate User Pain for a bug}
+  spec.description   = %q{Based on http://www.lostgarden.com/2008/05/improving-bug-triage-with-user-pain.html }
+  spec.homepage      = 'http://github.com/anicholson/pain.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'term-ansicolor'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'pry'
+end

data/spec/normalize_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'normalize' do
+  subject { Class.new { include Pain }.new }
+
+  it 'doesn\'t allow numbers too small' do
+    expect(subject.normalize(0, :impact)).to  be_nil
+    expect(subject.normalize(-1, :impact)).to be_nil
+  end
+
+  it 'doesn\'t allow numbers too big' do
+    expect(subject.normalize(10, :bug_type)).to eq(7) 
+    expect(subject.normalize(7,  :impact)).to   eq(5)
+    expect(subject.normalize(7,  :bug_type)).to eq(7)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'bundler/setup'
+
+require 'simplecov'
+require 'simplecov-rcov'
+require 'pry'
+require 'coveralls'
+
+Coveralls.wear!
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+require 'pain'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/user_pain_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+
+describe 'pain' do
+  subject { Class.new { include Pain }.new }
+
+  it 'calculates_correctly' do
+    expect(subject.user_pain(7, 5, 5)).to eq(100)
+    expect(subject.user_pain(1, 1, 1)).to eq(0)
+    expect(subject.user_pain(4, 3, 3)).to eq(20)
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: pain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Nicholson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 'Based on http://www.lostgarden.com/2008/05/improving-bug-triage-with-user-pain.html '
+email:
+- andrew@anicholson.net
+executables:
+- pain
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pain
+- lib/pain.rb
+- lib/pain/version.rb
+- pain.gemspec
+- spec/normalize_spec.rb
+- spec/spec_helper.rb
+- spec/user_pain_spec.rb
+homepage: http://github.com/anicholson/pain.git
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Quickly calculate User Pain for a bug
+test_files:
+- spec/normalize_spec.rb
+- spec/spec_helper.rb
+- spec/user_pain_spec.rb
+has_rdoc: