pain 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18ce563eae08ef8d490873ac46bbdb7956db3c22
-  data.tar.gz: 718e6be6cc82460d955b024cbdd740e7510c0f2e
+SHA256:
+  metadata.gz: 7ed10c1b52b39337e13741f8cc57fb41e8b116c5e7f41a8438af2bb441d19a68
+  data.tar.gz: 10fb7b20f0fafaf75c2e2c3e06c638939b50dae86eca5e1f54442e1a2abb044b
 SHA512:
-  metadata.gz: 1e1604a734977f2db5d5f5becbf3f94968635185eb013ea9a7dabd6261e619ae530f3029296601b586a0f4bec68587ae5b6e3d39ab2ebbe7a15b2321e6205c4d
-  data.tar.gz: 6bc02a62493ae684f9fb7e447d6c36ff5f83581e750fae359abc35b62a90ad4118994761527963639238cf0d25ce1ca2d4b7b061ee897ae8cbe68cf6e8a30f10
+  metadata.gz: fc3fc6de280eac3f11662545ee19d6dea0d982fe56a8fc994f637c6a3f61bf6778c84483a2503c2ee8c47e3c23169e991e9fc325b4cc2c4054012b4d6824ab90
+  data.tar.gz: 24f06280c62da6d1a3e745f27d35b109bc29c4512ad0c1160452c886c7356b1da70e6bd3d1dc995798f0f6ca535ddcbc0b22d804bf1a3181e27f0b81240c43a9

data/.rubocop.yml

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

data/Gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in user_pain.gemspec
 gemspec
 
-gem 'rubocop'
 gem 'coveralls', require: false
-
+gem 'rubocop', '< 2'
+gem 'rubocop-rspec'

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/bin/pain

@@ -1,140 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 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,
-    Pain::INPUT_MESSAGE[:likelihood]
-  ) do |like|
-    options[:likelihood] = Pain.normalize(like, :likelihood)
-  end
-
-  opts.on(
-    '-i',
-    '--impact [IMPACT]',
-    OptionParser::DecimalInteger,
-    Pain::INPUT_MESSAGE[:impact]
-  ) do |impact|
-    options[:impact] = Pain.normalize(impact, :impact)
-  end
-
-  opts.on(
-    '-t',
-    '--type [TYPE]',
-    OptionParser::DecimalInteger,
-    Pain::INPUT_MESSAGE[:bug_type]
-  ) 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
+Pain::Cli.new.run!

data/lib/pain.rb

@@ -1,62 +1,9 @@
+# frozen_string_literal: true
+
+require 'pain/color_strings'
+require 'pain/model'
+require 'pain/cli'
 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 but 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/cli.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Pain
+  class Cli
+    using Pain::ColorStrings
+
+    def initialize
+      @options = {}
+      @model = Pain::Model.new
+      @option_parser = Options.create(@options, @model)
+    end
+
+    def run!
+      @option_parser.parse!
+
+      %i[bug_type likelihood impact].each { |input| fill_question(input) }
+
+      puts
+      print_report_for options
+    end
+
+    private
+
+    attr_reader :model, :options, :option_parser
+
+    def fill_question(input, first: true)
+      return unless options[input].nil?
+
+      ask_question_for input
+      display_choices_for(input) if first
+
+      response       = gets.chomp
+      options[input] = model.normalize(response, input)
+
+      fill_question(input, first: false) if options[input].nil?
+    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 = case danger
+              when :normal
+                :default
+              when Symbol
+                danger
+              else
+                case_danger(danger)
+              end
+      puts msg.color(get_color(level))
+    end
+
+    def display_choices_for(input)
+      choices = model.choices_for(input)
+      ceiling = choices.count
+      choices.each do |v, msg|
+        color_output("#{v}: #{msg}", (v / ceiling.to_f))
+      end
+      puts
+    end
+
+    def ask_question_for(input)
+      color_output model.input_message(input)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def print_report_for(scores)
+      pain = model.user_pain(scores[:bug_type], scores[:likelihood], scores[:impact])
+
+      levels = scores.each_with_object({}) do |(input, level), hash|
+        hash[input] = case_danger(level.to_f / model.max_for(input))
+      end
+
+      color_output "Type:       #{scores[:bug_type]} - #{model.level_string(:bug_type, scores[:bug_type])}",
+                   levels[:bug_type]
+      color_output "Likelihood: #{scores[:likelihood]} - #{model.level_string(:likelihood, scores[:likelihood])}",
+                   levels[:likelihood]
+      color_output "Impact:     #{scores[:impact]} - #{model.level_string(:impact, scores[:impact])}", levels[:impact]
+      puts
+      color_output "User Pain: #{pain}", total_danger(pain)
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  class Options
+    def self.create(options, model)
+      OptionParser.new do |opts|
+        opts.on(
+          '-l',
+          '--likelihood [LIKELIHOOD]',
+          OptionParser::DecimalInteger,
+          model.input_message(:likelihood)
+        ) do |like|
+          options[:likelihood] = model.normalize(like, :likelihood)
+        end
+
+        opts.on(
+          '-i',
+          '--impact [IMPACT]',
+          OptionParser::DecimalInteger,
+          model.input_message(:impact)
+        ) do |impact|
+          options[:impact] = model.normalize(impact, :impact)
+        end
+
+        opts.on(
+          '-t',
+          '--type [TYPE]',
+          OptionParser::DecimalInteger,
+          model.input_message(:bug_type)
+        ) do |bug_type|
+          options[:bug_type] = model.normalize(bug_type, :bug_type)
+        end
+      end
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+end

data/lib/pain/color_strings.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'term/ansicolor'
+
+module Pain
+  module ColorStrings
+    refine String do
+      include Term::ANSIColor
+    end
+  end
+end

data/lib/pain/model.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Pain
+  class Model
+    MAX = {
+      bug_type: 7,
+      likelihood: 5,
+      impact: 5
+    }.freeze
+
+    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?'
+    }.freeze
+
+    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 but 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'
+      }
+    }.freeze
+
+    def choices_for(category)
+      OPTIONS[category]
+    end
+
+    def level_string(category, score)
+      OPTIONS.dig(category, score)
+    end
+
+    def max_for(category)
+      MAX[category]
+    end
+
+    def input_message(category)
+      INPUT_MESSAGE[category]
+    end
+
+    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
+end

data/lib/pain/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pain
-  VERSION = '0.0.3'
+  VERSION = '0.1.1'
 end

data/pain.gemspec

@@ -14,17 +14,18 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/pain}) { |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_dependency 'tins'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '< 4'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-rcov'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubygems-update'
 end

data/spec/model_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Pain
+  RSpec.describe Model do
+    describe '#user_pain' do
+      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
+
+    describe '#normalize' do
+      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
+  end
+end

data/spec/spec_helper.rb

@@ -26,7 +26,6 @@ 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
 

metadata

@@ -1,139 +1,152 @@
 --- !ruby/object:Gem::Specification
 name: pain
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Andy Nicholson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2021-08-04 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: tins
   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'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2'
 - !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'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !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'
+- !ruby/object:Gem::Dependency
+  name: rubygems-update
+  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:
-- .rubocop.yml
 - pain
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,37 +154,36 @@ files:
 - bin/.rubocop.yml
 - bin/pain
 - lib/pain.rb
+- lib/pain/cli.rb
+- lib/pain/color_strings.rb
+- lib/pain/model.rb
 - lib/pain/version.rb
 - pain.gemspec
-- spec/normalize_spec.rb
+- spec/model_spec.rb
 - spec/spec_helper.rb
-- spec/user_pain_spec.rb
 homepage: http://github.com/anicholson/pain.git
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Quickly calculate User Pain for a bug
 test_files:
-- spec/normalize_spec.rb
+- spec/model_spec.rb
 - spec/spec_helper.rb
-- spec/user_pain_spec.rb
-has_rdoc: 

data/spec/normalize_spec.rb

@@ -1,16 +0,0 @@
-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/user_pain_spec.rb

@@ -1,12 +0,0 @@
-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