gamifying_formatter 0.0.2 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjE1NTRlMDU2YjdiOTdjNjcyOGRlZmMzYTY2ZTg1MDkyMzgzMGM1ZA==
-  data.tar.gz: !binary |-
-    Njc0N2ZlZWY1OGNiMmVhYjYyMWQyOWU0OTMwZjVmOTY0NTU2ZjQ1MA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YWRmZDY2N2NiZTY4OGRhNzAwMmZhZmRhMWUzNWJlZjc4ZTAwMDA2Y2Q4Mzli
-    ZGVkMzI1YzA5ZWM3ZTMyNzc4YzZjNTU1NDVhY2FlNjkzYzkyMDkyOTNlNDRi
-    MDM4ZTZhYjA0YzE2MzAyYTg2NThkNTBiOGM4NDhlYmYzNzNiOTU=
-  data.tar.gz: !binary |-
-    ZmJhZTZiYmY5YTVjZjJjMTBkNTlmZDI3MjVlZGY0NzYyY2NkODJhZTQ1MTJk
-    MmI2NzE2MmQ5YzNhNmJlOTIxZTk3ZTQyY2EyYTc2OTc2MThlYzE1YzZiODNk
-    MmI3MTdjNTc0YWFmODY3NmQwZjY1OWVkNzkxNzg0MzkyYmZhNTY=
+SHA1:
+  metadata.gz: 308f6e820cd5c35d1f0e1cb880c9d9c9947d9a34
+  data.tar.gz: 9149b823cba62dea23420ab53a8b10a8114f9de9
+SHA512:
+  metadata.gz: 8d73b00ff3ed98a0fe1ed512be8f5ea794ed19035157e0964de5ae89b6b85e2b6db074546adf09fa384062003ee0779b78a07e7e0acead924cdc579864188570
+  data.tar.gz: eda62592b01de6398116e154f84f8ba14b526c20025a20187cd8f36fccf6b31d116ac972af4a397f98e476f33905a4a55debc431064687e9e3bde25e2913468f

data/README.md

@@ -10,6 +10,10 @@ Adding tests
 
 You receive the trophies based on the amount of points you get which start out small and get bigger.
 
+Now works on Rspec 1/2/3.
+
+Thanks goes to the good folks at [nyan-cat-formatter](https://github.com/mattsears/nyan-cat-formatter) for the inspiration to do this and blazing for the trail for creating formatters.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +38,12 @@ To use the GamifyingFormatter all you need to do is add this option when you are
 
     --format GamifyingFormatter
 
+## Example
+
+Run the example using:
+
+    rspec example/example.rb --require gamifying_formatter.rb --format GamifyingFormatter
+
 ## Contributing
 
 1. Fork it

data/gamifying_formatter.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "gamifying_formatter"
-  gem.version       = '0.0.2'
+  gem.version       = '1.0.0'
   gem.authors       = ["Chris Belsole"]
   gem.email         = ["cbelsole@gmail.com"]
   gem.description   = %q{The Gamifying Formatter}
@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency 'rspec'
+  gem.add_dependency 'rspec', '= 3.0.0'
 end

data/lib/gamifying_formatter/common.rb

@@ -0,0 +1,139 @@
+require 'test_info'
+require 'yaml'
+
+module GamifyingFormatters
+  module Common
+
+    def load_test_info
+      if File.exists?('.past_results.yml')
+        @test_info = YAML::load(File.new('.past_results.yml', 'r'))
+      else
+        @test_info = TestInfo.new
+      end
+    end
+
+    def wrap_up(num_of_examples, num_of_failed_examples, duration)
+      @test_info.number_of_tests = num_of_examples
+      @test_info.number_of_failed_tests = num_of_failed_examples
+      @test_info.total_time = duration
+      File.open('.past_results.yml', 'w') { |file| file.puts @test_info.to_yaml }
+    end
+
+    def calculate_achevements(example_count, failure_count, duration)
+      achievements = []
+      achievements << number_of_tests_achievement(@test_info.number_of_tests, example_count)
+      achievements << number_of_fixed_tests_achievement(@test_info.number_of_failed_tests, failure_count)
+      achievements << decreased_test_time_achievement(@test_info.total_time, duration)
+
+      achievements.delete_if(&:nil?).each { |achievement| @test_info.addAchievement(achievement) }
+    end
+
+    def show_achievements
+      output.puts "\n!!!!!!!!Achievements!!!!!!!!"
+      output.puts get_trophie(@test_info.level)
+      output.puts '-' * (@test_info.achievements.uniq.join(" | ").size + 4)
+      output.puts "| #{@test_info.achievements.uniq.join(" | ")} |"
+      output.puts '-' * (@test_info.achievements.uniq.join(" | ").size + 4)
+    end
+
+    def show_xp_bar
+      case @test_info.level
+        when 1
+          goal_xp = 10
+        when 2
+          goal_xp = 25
+        when 3
+          goal_xp = 50
+        when 4
+          goal_xp = 100
+        else
+          goal_xp = 1000
+      end
+
+      least_common_multiple = goal_xp.lcm(25)
+      numerator = least_common_multiple / goal_xp
+      denominator = least_common_multiple / 25
+
+      xp_chars = '=' * ((@test_info.xp * numerator) / denominator).ceil
+      xp_filler = ' ' * (25 - xp_chars.size)
+      output.puts "Level #{@test_info.level}: #{@test_info.xp}/#{goal_xp} [#{xp_chars}#{xp_filler}]"
+    end
+
+    def number_of_tests_achievement(old_total_tests, new_total_tests)
+      goal = [100, 50, 25, 10, 5, 1].select { |target|
+        new_total_tests - old_total_tests >= target
+      }.max
+
+      goal ? "Added #{goal} test(s)!" : nil
+    end
+
+    def decreased_test_time_achievement(old_total_time, new_total_time)
+      goal = [100, 50, 25, 10, 5, 1, 0.5, 0.2].select { |target|
+        (old_total_time * 100 - new_total_time * 100).round / 100.0 >= target
+      }.max
+
+      goal ? "Reduced testing time by #{goal} second(s)!" : nil
+    end
+
+    def number_of_fixed_tests_achievement(old_failed_tests, new_failed_tests)
+      goal = [100, 50, 25, 10, 5, 1].select { |target|
+        old_failed_tests - new_failed_tests >= target
+      }.max
+
+      goal ? "Fixed #{goal} test(s)!" : nil
+    end
+
+    def get_trophie(level)
+      case level
+        when 1
+          <<-EOS
+            .__.
+           (|  |)
+            (  )
+            _)(_
+          EOS
+        when 2
+          <<-EOS
+                {}
+               /__\\
+             /|    |\\
+            (_|    |_)
+               \\  /
+                )(
+              _|__|_
+            _|______|_
+           |__________|
+          EOS
+        when 3
+          <<-EOS
+             ___________
+            '._==_==_=_.'
+            .-\\:      /-.
+           | (|:.     |) |
+            '-|:.     |-'
+              \\::.    /
+               '::. .'
+                 ) (
+               _.' '._
+              `"""""""`"
+          EOS
+        when 4
+          <<-EOS
+            .-=========-.
+            \\'-=======-'/
+            _|   .=.   |_
+           ((|  {{1}}  |))
+            \\|   /|\\   |/
+             \\__ '`' __/
+               _`) (`_
+             _/_______\\_
+            /___________\\
+          EOS
+        else
+          ''
+      end
+    end
+
+  end
+end
+

data/lib/gamifying_formatter/rspec1.rb

@@ -0,0 +1,24 @@
+include GamifyingFormatters::Common
+
+class RSpec1 < Spec::Runner::Formatter::BaseTextFormatter
+  def start(example_count)
+    super(example_count)
+    @test_info = load_test_info
+  end
+
+  def close
+    super
+    wrap_up(example_count, failure_count, duration)
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    super(duration, example_count, failure_count, pending_count)
+
+    achievements = calculate_achevements(example_count, failure_count, duration)
+
+    show_achievements unless achievements.empty?
+
+    show_xp_bar
+  end
+end
+

data/lib/gamifying_formatter/rspec2.rb

@@ -0,0 +1,26 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+include GamifyingFormatters::Common
+
+class RSpec2 < RSpec::Core::Formatters::BaseTextFormatter
+  def initialize(output)
+    super(output)
+    @test_info = load_test_info
+  end
+
+  def close
+    super
+    wrap_up(example_count, failure_count, duration)
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    super(duration, example_count, failure_count, pending_count)
+
+    achievements = calculate_achevements(example_count, failure_count, duration)
+
+    show_achievements unless achievements.empty?
+
+    show_xp_bar
+  end
+end
+

data/lib/gamifying_formatter/rspec3.rb

@@ -0,0 +1,41 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+include GamifyingFormatters::Common
+
+class RSpec3 < RSpec::Core::Formatters::BaseTextFormatter
+
+  RSpec::Core::Formatters.register self, :dump_summary
+
+  def initialize(output)
+    super(output)
+    @test_info = load_test_info
+  end
+
+  def wrap_up(num_of_examples, num_of_failed_examples, duration)
+    @test_info.number_of_tests = num_of_examples
+    @test_info.number_of_failed_tests = num_of_failed_examples
+    @test_info.total_time = duration
+    File.open('.past_results.yml', 'w') { |file| file.puts @test_info.to_yaml }
+  end
+
+  def dump_summary(summary_notification)
+    super(summary_notification)
+
+    achievements = calculate_achevements(
+      summary_notification.examples.size,
+      summary_notification.failed_examples.size,
+      summary_notification.duration
+    )
+
+    show_achievements unless achievements.empty?
+
+    show_xp_bar
+
+    wrap_up(
+      summary_notification.examples.size,
+      summary_notification.failed_examples.size,
+      summary_notification.duration
+    )
+  end
+end
+

data/lib/gamifying_formatter.rb

@@ -1,179 +1,24 @@
-require "rspec/core/formatters/base_text_formatter"
-require 'test_info'
-require 'yaml'
-
-class GamifyingFormatter < RSpec::Core::Formatters::BaseTextFormatter
-  def initialize(output)
-    super(output)
-
-    if File.exists?('.past_results.yml')
-      @test_info = YAML::load(File.new('.past_results.yml', 'r'))
-    else
-      @test_info = TestInfo.new
-      @test_info.level = 1
-      @test_info.xp = 0
-      @test_info.number_of_tests = 0
-      @test_info.number_of_failed_tests = 0
-      @test_info.total_time = 0.0
-    end
-
-    @got_achievement = false
-  end
-
-  def close
-    super
-
-    @test_info.number_of_tests = example_count
-    @test_info.total_time = duration
-    @test_info.number_of_failed_tests = failure_count
-
-    File.open('.past_results.yml', 'w') { |file| file.puts @test_info.to_yaml }
-  end
-
-  def dump_summary(duration, example_count, failure_count, pending_count)
-
-    super(duration, example_count, failure_count, pending_count)
-
-    calculate_achevements(example_count, failure_count, duration)
-
-    output_achievements
-
-    output_xp_bar
-  end
-
-  def calculate_achevements(example_count, failure_count, duration)
-    number_of_tests_achievement(@test_info.number_of_tests, example_count)
-
-    number_of_fixed_tests_achievement(@test_info.number_of_failed_tests, failure_count)
-
-    decreased_test_time_achievement(@test_info.total_time, duration)
-  end
-
-  def output_achievements
-    return unless @got_achievement
-    output.puts "\n!!!!!!!!Achievements!!!!!!!!"
-    output.puts get_trophie(@test_info.level)
-    output.puts '-' * (@test_info.achievements.uniq.join(" | ").size + 4)
-    output.puts "| #{@test_info.achievements.uniq.join(" | ")} |"
-    output.puts '-' * (@test_info.achievements.uniq.join(" | ").size + 4)
-  end
-
-  def output_xp_bar
-    case @test_info.level
-      when 1
-        goal_xp = 10
-      when 2
-        goal_xp = 25
-      when 3
-        goal_xp = 50
-      when 4
-        goal_xp = 100
-      else
-        goal_xp = 1000
-    end
-
-    least_common_multiple = goal_xp.lcm(25)
-    numerator = least_common_multiple / goal_xp
-    denominator = least_common_multiple / 25
-
-    xp_chars = '=' * ((@test_info.xp * numerator) / denominator).ceil
-    xp_filler = ' ' * (25 - xp_chars.size)
-
-    output.puts "Level #{@test_info.level}: #{@test_info.xp}/#{goal_xp} [#{xp_chars}#{xp_filler}]"
-  end
-
-  def number_of_tests_achievement(old_total_tests, new_total_tests)
-    [100, 50, 25, 10, 5, 1].each do |number|
-      if new_total_tests - old_total_tests >= number
-        @test_info.achievements.push("Added #{number} test(s)!")
-        @test_info.xp += 1
-        @got_achievement = true
-        check_level_up(@test_info.xp)
-        break
-      end
-    end
-  end
-
-  def decreased_test_time_achievement(old_total_time, new_total_time)
-    [100, 50, 25, 10, 5, 1, 0.5, 0.2].each do |number|
-      if (old_total_time * 100 - new_total_time * 100).round / 100.0 >= number
-        @test_info.achievements.push("Reduced testing time by #{number} second(s)!")
-        @test_info.xp += 1
-        @got_achievement = true
-        check_level_up(@test_info.xp)
-        break
-      end
-    end
-  end
-
-  def number_of_fixed_tests_achievement(old_failed_tests, new_failed_tests)
-    [100, 50, 25, 10, 5, 1].each do |number|
-      if old_failed_tests - new_failed_tests >= number
-        @test_info.achievements.push("Fixed #{number} test(s)!")
-        @test_info.xp += 1
-        @got_achievement = true
-        check_level_up(@test_info.xp)
-        break
-      end
-    end
-  end
-
-  def check_level_up(xp)
-    if xp == 10 || xp == 25 || xp == 50 || xp == 100
-      @test_info.level += 1
-      @test_info.xp = 0
-    end
-  end
-
-  def get_trophie(level)
-    case level
-      when 3
-        <<-EOS
-             ___________
-            '._==_==_=_.'
-            .-\\:      /-.
-           | (|:.     |) |
-            '-|:.     |-'
-              \\::.    /
-               '::. .'
-                 ) (
-               _.' '._
-              `"""""""`"
-        EOS
-      when 2
-        <<-EOS
-                {}
-               /__\\
-             /|    |\\
-            (_|    |_)
-               \\  /
-                )(
-              _|__|_
-            _|______|_
-           |__________|
-      EOS
-      when 4
-        <<-EOS
-            .-=========-.
-            \\'-=======-'/
-            _|   .=.   |_
-           ((|  {{1}}  |))
-            \\|   /|\\   |/
-             \\__ '`' __/
-               _`) (`_
-             _/_______\\_
-            /___________\\
-        EOS
-      when 1
-        <<-EOS
-            .__.
-           (|  |)
-            (  )
-            _)(_
-        EOS
-      else
-        ''
-    end
+# -*- coding: utf-8 -*-
+
+require 'gamifying_formatter/common'
+
+rspec_bin = $0.split('/').last
+if rspec_bin == 'spec'
+  [
+    'spec',
+    'spec/runner/formatter/base_text_formatter',
+    'gamifying_formatter/rspec1'
+  ].each { |f| require f }
+  formatter = RSpec1
+else
+  require 'rspec/core/formatters/base_text_formatter'
+  if Gem::Version.new(RSpec::Core::Version::STRING).release >= Gem::Version.new('3.0.0')
+    require 'gamifying_formatter/rspec3'
+    formatter = RSpec3
+  else
+    require 'gamifying_formatter/rspec2'
+    formatter = RSpec2
   end
 end
 
+GamifyingFormatter = formatter

data/lib/test_info.rb

@@ -1,15 +1,45 @@
 class TestInfo
-  attr_accessor :number_of_tests, :total_time, :number_of_failed_tests, :xp, :level
+  attr_accessor :number_of_tests, :total_time, :number_of_failed_tests
+  attr_reader :xp, :level, :achievements
 
   def initialize
     @achievements = []
+    @level = 1
+    @xp = 0
+    @number_of_tests = 0
+    @number_of_failed_tests = 0
+    @total_time = 0.0
   end
 
-  def achievements=(value)
-    @achievements = value
+  def addAchievement(value)
+    unless value && value.empty?
+      incrimentXpAndLevel
+      @achievements << value
+    end
+
+    nil
+  end
+
+  def ==(o)
+    o.class == self.class &&
+    o.number_of_tests == number_of_tests &&
+    o.total_time == total_time &&
+    o.number_of_failed_tests == number_of_failed_tests &&
+    o.xp == xp &&
+    o.level == level &&
+    o.achievements == achievements
   end
 
-  def achievements
-    @achievements
+private
+
+  def incrimentXpAndLevel
+    @xp += 1
+
+    if @xp == 10 || @xp == 25 || @xp == 50 || @xp == 100
+      @level += 1
+      @xp = 0
+    end
+
+    nil
   end
 end

data/spec/gamifying_formatter/gamifying_formatter_spec.rb

@@ -0,0 +1,412 @@
+require 'spec_helper'
+
+describe 'GamifyingFormatters::Common' do
+
+  let(:output) { StringIO.new }
+  let(:formatter) { TestFormatter.new(output) }
+
+  describe '#load_test_info' do
+    it 'loads yml file when present' do
+      allow(File).to receive(:exists?).and_return(true)
+      expect(File).to receive(:new).with('.past_results.yml', 'r').and_return('--- foo')
+      formatter.load_test_info
+      expect(formatter.instance_variable_get(:@test_info)).to eq('foo')
+    end
+
+    it 'creates new TestInfo when yml file is not present' do
+      allow(File).to receive(:exists?).and_return(false)
+      formatter.load_test_info
+      expect(formatter.instance_variable_get(:@test_info)).to eq(TestInfo.new)
+    end
+  end
+
+  describe '#wrap_up' do
+    let(:test_info) { formatter.instance_variable_get(:@test_info) }
+
+    it 'saves info to .past_results.yml' do
+      test_info.instance_variable_set(:@xp, 34)
+      test_info.instance_variable_set(:@level, 5)
+      test_info.instance_variable_set(:@achievements, ['something'])
+
+      allow(File).to receive(:open)
+
+      formatter.wrap_up(100, 2, 99)
+    end
+  end
+
+  describe '#show_achievements' do
+    let(:test_info) { formatter.instance_variable_get(:@test_info) }
+
+    it 'shows all achievements' do
+      test_info.instance_variable_set(:@achievements, ['one', 'two', 'three'])
+
+      expect(output).to receive(:puts)
+        .with("\n!!!!!!!!Achievements!!!!!!!!")
+      expect(output).to receive(:puts)
+        .with("            .__.\n           (|  |)\n            (  )\n            _)(_\n")
+      expect(output).to receive(:puts)
+        .with('---------------------')
+      expect(output).to receive(:puts)
+        .with('| one | two | three |')
+      expect(output).to receive(:puts)
+        .with('---------------------')
+      formatter.show_achievements
+    end
+  end
+
+  describe '#show_xp_bar' do
+    let(:test_info) { formatter.instance_variable_get(:@test_info) }
+
+    context 'when level is 1' do
+      it 'shows xp bar for empty xp' do
+        expect(output).to receive(:puts)
+          .with('Level 1: 0/10 [                         ]')
+
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar for almost full' do
+        expect(output).to receive(:puts)
+          .with('Level 1: 9/10 [======================   ]')
+        test_info.instance_variable_set(:@xp, 9)
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar half full' do
+        expect(output).to receive(:puts)
+          .with('Level 1: 5/10 [============             ]')
+        test_info.instance_variable_set(:@xp, 5)
+        formatter.show_xp_bar
+      end
+    end
+
+    context 'when level is 2' do
+      before do
+        test_info.instance_variable_set(:@level, 2)
+      end
+
+      it 'shows xp bar for empty xp' do
+        expect(output).to receive(:puts)
+          .with('Level 2: 0/25 [                         ]')
+
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar for almost full' do
+        expect(output).to receive(:puts)
+          .with('Level 2: 24/25 [======================== ]')
+        test_info.instance_variable_set(:@xp, 24)
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar half full' do
+        expect(output).to receive(:puts)
+          .with('Level 2: 13/25 [=============            ]')
+        test_info.instance_variable_set(:@xp, 13)
+        formatter.show_xp_bar
+      end
+    end
+
+    context 'when level is 3' do
+      before do
+        test_info.instance_variable_set(:@level, 3)
+      end
+
+      it 'shows xp bar for empty xp' do
+        expect(output).to receive(:puts)
+          .with('Level 3: 0/50 [                         ]')
+
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar for almost full' do
+        expect(output).to receive(:puts)
+          .with('Level 3: 49/50 [======================== ]')
+        test_info.instance_variable_set(:@xp, 49)
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar half full' do
+        expect(output).to receive(:puts)
+          .with('Level 3: 25/50 [============             ]')
+        test_info.instance_variable_set(:@xp, 25)
+        formatter.show_xp_bar
+      end
+    end
+
+    context 'when level is 4' do
+      before do
+        test_info.instance_variable_set(:@level, 4)
+      end
+
+      it 'shows xp bar for empty xp' do
+        expect(output).to receive(:puts)
+          .with('Level 4: 0/100 [                         ]')
+
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar for almost full' do
+        expect(output).to receive(:puts)
+          .with('Level 4: 99/100 [======================== ]')
+        test_info.instance_variable_set(:@xp, 99)
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar half full' do
+        expect(output).to receive(:puts)
+          .with('Level 4: 50/100 [============             ]')
+        test_info.instance_variable_set(:@xp, 50)
+        formatter.show_xp_bar
+      end
+    end
+
+    context 'when level is above 4' do
+      before do
+        test_info.instance_variable_set(:@level, 5)
+      end
+
+      it 'shows xp bar for empty xp' do
+        expect(output).to receive(:puts)
+          .with('Level 5: 0/1000 [                         ]')
+
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar for almost full' do
+        expect(output).to receive(:puts)
+          .with('Level 5: 999/1000 [======================== ]')
+        test_info.instance_variable_set(:@xp, 999)
+        formatter.show_xp_bar
+      end
+
+      it 'shows xp bar half full' do
+        expect(output).to receive(:puts)
+          .with('Level 5: 500/1000 [============             ]')
+        test_info.instance_variable_set(:@xp, 500)
+        formatter.show_xp_bar
+      end
+    end
+  end
+
+  describe '#number_of_tests_achievement' do
+    it 'returns achievement for adding 1 test' do
+      expect(
+        formatter.number_of_tests_achievement(1, 2)
+      ).to eq("Added 1 test(s)!")
+    end
+
+    it 'returns achievement for adding 5 tests' do
+      expect(
+        formatter.number_of_tests_achievement(1, 6)
+      ).to eq("Added 5 test(s)!")
+    end
+
+    it 'returns achievement for adding 10 tests' do
+      expect(
+        formatter.number_of_tests_achievement(1, 11)
+      ).to eq("Added 10 test(s)!")
+    end
+
+    it 'returns achievement for adding 25 tests' do
+      expect(
+        formatter.number_of_tests_achievement(1, 26)
+      ).to eq("Added 25 test(s)!")
+    end
+
+    it 'returns achievement for adding 50 tests' do
+      expect(
+        formatter.number_of_tests_achievement(1, 51)
+      ).to eq("Added 50 test(s)!")
+    end
+
+    it 'returns achievement for adding 100 tests' do
+      expect(
+        formatter.number_of_tests_achievement(1, 101)
+      ).to eq("Added 100 test(s)!")
+    end
+
+    it 'returns nil if added tests are less than 1' do
+      expect(
+        formatter.number_of_tests_achievement(1, 0)
+      ).to eq(nil)
+    end
+  end
+
+  describe '#decreased_test_time_achievement' do
+    it 'returns achievement for .2 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(0.3, 0.1)
+      ).to eq("Reduced testing time by 0.2 second(s)!")
+    end
+
+    it 'returns achievement for .5 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(0.6, 0.1)
+      ).to eq("Reduced testing time by 0.5 second(s)!")
+    end
+
+    it 'returns achievement for 1 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(2, 1)
+      ).to eq("Reduced testing time by 1 second(s)!")
+    end
+
+    it 'returns achievement for 5 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(6, 1)
+      ).to eq("Reduced testing time by 5 second(s)!")
+    end
+
+    it 'returns achievement for 10 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(11, 1)
+      ).to eq("Reduced testing time by 10 second(s)!")
+    end
+
+    it 'returns achievement for 25 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(26, 1)
+      ).to eq("Reduced testing time by 25 second(s)!")
+    end
+
+    it 'returns achievement for 50 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(51, 1)
+      ).to eq("Reduced testing time by 50 second(s)!")
+    end
+
+    it 'returns achievement for 100 saved seconds' do
+      expect(
+        formatter.decreased_test_time_achievement(101, 1)
+      ).to eq("Reduced testing time by 100 second(s)!")
+    end
+
+    it 'returns nil if seconds saved are less than .2' do
+      expect(
+        formatter.decreased_test_time_achievement(0, 1)
+      ).to eq(nil)
+    end
+  end
+
+  describe '#number_of_fixed_tests_achievement' do
+    it 'returns achievement for 1 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(2, 1)
+      ).to eq("Fixed 1 test(s)!")
+    end
+
+    it 'returns achievement for 5 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(6, 1)
+      ).to eq("Fixed 5 test(s)!")
+    end
+
+    it 'returns achievement for 10 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(11, 1)
+      ).to eq("Fixed 10 test(s)!")
+    end
+
+    it 'returns achievement for 25 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(26, 1)
+      ).to eq("Fixed 25 test(s)!")
+    end
+
+    it 'returns achievement for 50 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(51, 1)
+      ).to eq("Fixed 50 test(s)!")
+    end
+
+    it 'returns achievement for 100 fixed test' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(101, 1)
+      ).to eq("Fixed 100 test(s)!")
+    end
+
+    it 'returns nil if fixed tests are less than 1' do
+      expect(
+        formatter.number_of_fixed_tests_achievement(0, 1)
+      ).to eq(nil)
+    end
+  end
+
+  describe '#get_trophie' do
+    it 'returns level 1 trophy when level equals 1' do
+      expect(formatter.get_trophie(1)).to eq(
+        <<-EOS
+            .__.
+           (|  |)
+            (  )
+            _)(_
+        EOS
+      )
+    end
+
+    it 'returns level 2 trophy when level equals 2' do
+      expect(formatter.get_trophie(2)).to eq(
+        <<-EOS
+                {}
+               /__\\
+             /|    |\\
+            (_|    |_)
+               \\  /
+                )(
+              _|__|_
+            _|______|_
+           |__________|
+        EOS
+      )
+    end
+
+    it 'returns level 3 trophy when level equals 3' do
+      expect(formatter.get_trophie(3)).to eq(
+        <<-EOS
+             ___________
+            '._==_==_=_.'
+            .-\\:      /-.
+           | (|:.     |) |
+            '-|:.     |-'
+              \\::.    /
+               '::. .'
+                 ) (
+               _.' '._
+              `"""""""`"
+        EOS
+      )
+    end
+
+    it 'returns level 4 trophy when level equals 4' do
+      expect(formatter.get_trophie(4)).to eq(
+        <<-EOS
+            .-=========-.
+            \\'-=======-'/
+            _|   .=.   |_
+           ((|  {{1}}  |))
+            \\|   /|\\   |/
+             \\__ '`' __/
+               _`) (`_
+             _/_______\\_
+            /___________\\
+        EOS
+      )
+    end
+
+    it 'returns empty string when level is anything else' do
+      expect(formatter.get_trophie(10)).to eq('')
+    end
+  end
+end
+
+class TestFormatter
+  include GamifyingFormatters::Common
+
+  attr_reader :output
+
+  def initialize(output)
+    @test_info = TestInfo.new
+    @output = output
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gamifying_formatter'
+require 'stringio'

data/spec/test_info_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe TestInfo do
+  let(:test_info) { TestInfo.new }
+
+  describe '#addAchievement' do
+    context 'for a valid achievement' do
+      it 'adds an achievement to the list when the value is not blank' do
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.achievements.size).to eq(1)
+        expect(test_info.achievements.at(0)).to eq('some achievement')
+      end
+
+      it 'increments the level and resets the xp at 10' do
+        test_info.instance_variable_set('@xp', 9)
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.level).to eq(2)
+        expect(test_info.xp).to eq(0)
+      end
+
+      it 'increments the level and resets the xp at 25' do
+        test_info.instance_variable_set('@xp', 24)
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.level).to eq(2)
+        expect(test_info.xp).to eq(0)
+      end
+
+      it 'increments the level and resets the xp at 50' do
+        test_info.instance_variable_set('@xp', 49)
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.level).to eq(2)
+        expect(test_info.xp).to eq(0)
+      end
+
+      it 'increments the level and resets the xp at 100' do
+        test_info.instance_variable_set('@xp', 99)
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.level).to eq(2)
+        expect(test_info.xp).to eq(0)
+      end
+
+      it 'increments the xp and not the level at any other number' do
+        test_info.addAchievement('some achievement')
+
+        expect(test_info.level).to eq(1)
+        expect(test_info.xp).to eq(1)
+      end
+    end
+
+    it 'does not add an achievement to the list when it is blank' do
+      test_info.addAchievement('')
+
+      expect(test_info.achievements.size).to eq(0)
+    end
+
+    it 'returns nil' do
+      expect(test_info.addAchievement('something')).to be_nil
+    end
+  end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gamifying_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Belsole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 description: The Gamifying Formatter
 email:
 - cbelsole@gmail.com
@@ -31,7 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -40,9 +40,14 @@ files:
 - example/example.rb
 - gamifying_formatter.gemspec
 - lib/gamifying_formatter.rb
+- lib/gamifying_formatter/common.rb
+- lib/gamifying_formatter/rspec1.rb
+- lib/gamifying_formatter/rspec2.rb
+- lib/gamifying_formatter/rspec3.rb
 - lib/test_info.rb
-- spec/gamifying_formatter_spec.rb
+- spec/gamifying_formatter/gamifying_formatter_spec.rb
 - spec/spec_helper.rb
+- spec/test_info_spec.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -52,21 +57,22 @@ 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.3
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: An rspec formatter for making testing fun.
 test_files:
-- spec/gamifying_formatter_spec.rb
+- spec/gamifying_formatter/gamifying_formatter_spec.rb
 - spec/spec_helper.rb
+- spec/test_info_spec.rb
 has_rdoc: 

data/spec/gamifying_formatter_spec.rb

@@ -1,93 +0,0 @@
-require 'spec_helper'
-require 'stringio'
-
-describe GamifyingFormatter do
-  before do
-    @output = StringIO.new
-    @formatter = GamifyingFormatter.new(@output)
-    @formatter.start(2)
-  end
-
-  context 'achievements' do
-    describe '.number_of_tests_achievement' do
-      it 'should set an achievment for adding 1 test' do
-        @formatter.number_of_tests_achievement(3, 4)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Added 1 test(s)!')
-      end
-
-      it 'should set and achievement for adding 100 tests' do
-        @formatter.number_of_tests_achievement(1, 1000)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Added 100 test(s)!')
-      end
-
-      it 'should not set an achievement for adding tests' do
-        @formatter.number_of_tests_achievement(4, 3)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(0)
-      end
-    end
-
-    describe '.decreased_test_time_achievement' do
-      it 'should set an achievment for improving tests time by .2 seconds' do
-        @formatter.decreased_test_time_achievement(0.3, 0.1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Reduced testing time by 0.2 second(s)!')
-      end
-
-      it 'should set and achievement for improving tests time by 100 seconds' do
-        @formatter.decreased_test_time_achievement(1000, 1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Reduced testing time by 100 second(s)!')
-      end
-
-      it 'should not set an achievement for improving test time' do
-        @formatter.decreased_test_time_achievement(3, 4)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(0)
-      end
-    end
-
-    describe '.number_of_fixed_tests_achievement' do
-      it 'should set an achievment for fixing 1 test' do
-        @formatter.number_of_fixed_tests_achievement(4, 3)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Fixed 1 test(s)!')
-      end
-
-      it 'should set and achievement for fixing 100 tests' do
-        @formatter.number_of_fixed_tests_achievement(10000, 1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(1)
-        expect(@formatter.instance_variable_get(:@test_info).achievements[0]).to eq('Fixed 100 test(s)!')
-      end
-
-      it 'should not set an achievement for fixing tests' do
-        @formatter.number_of_fixed_tests_achievement(3, 4)
-        expect(@formatter.instance_variable_get(:@test_info).achievements.size).to eq(0)
-      end
-    end
-  end
-
-  context 'output' do
-    describe '.output_achievements' do
-      it 'outputs all achievemnts in the list' do
-        achievement_array = Array.new(5) { |i| "Achievement #{i}"}
-        @formatter.instance_variable_get(:@test_info).achievements = achievement_array
-
-        @output.should_receive(:puts).exactly(5).times
-
-        @formatter.output_achievements
-      end
-    end
-
-    describe '.get_trophies' do
-      it 'returns the correct trophie based on the number' do
-        expect(@formatter.get_trophie(1)).to eq([
-          "  .__.",
-          " (|  |)",
-          "  (  )",
-          "  _)(_"
-        ].join("\n"))
-      end
-    end
-  end
-end