gamifying_formatter 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Belsole
+
+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,44 @@
+# GamifyingFormatter
+![Achievements and Trophies](/achievement.png)
+
+GameifyingFormatter is here to solve your testing woes. With trophies and achievements it makes running tests fun. This project was created so that you could use it as a stand alone test runner or extend it and add achievements to your own test runner.
+
+These are the achievements you can get points for right now:
+Fixing failed tests
+Improving test speed
+Adding tests
+
+You receive the trophies based on the amount of points you get which start out small and get bigger.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gamifying_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamifying_formatter
+
+If you want to use the Gamifying Formatter as your default formatter just put this option in your .rspec file:
+
+    --format GamifyingFormatter
+
+## Usage
+
+To use the GamifyingFormatter all you need to do is add this option when you are running your spect tests if you did not already edit your .rspec file:
+
+    --format GamifyingFormatter
+
+## 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/example/example.rb

@@ -0,0 +1,8 @@
+# rspec example/example.rb --require gamifying_formatter.rb --format GamifyingFormatter
+describe "my group" do
+  100.times do
+    specify "my example" do
+      expect(1).to eq(1)
+    end
+  end
+end

data/gamifying_formatter.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "gamifying_formatter"
+  gem.version       = '0.0.2'
+  gem.authors       = ["Chris Belsole"]
+  gem.email         = ["cbelsole@gmail.com"]
+  gem.description   = %q{The Gamifying Formatter}
+  gem.summary       = %q{An rspec formatter for making testing fun.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  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'
+end

data/lib/gamifying_formatter.rb

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

data/lib/test_info.rb

@@ -0,0 +1,15 @@
+class TestInfo
+  attr_accessor :number_of_tests, :total_time, :number_of_failed_tests, :xp, :level
+
+  def initialize
+    @achievements = []
+  end
+
+  def achievements=(value)
+    @achievements = value
+  end
+
+  def achievements
+    @achievements
+  end
+end

data/spec/gamifying_formatter_spec.rb

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

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: gamifying_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris Belsole
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: The Gamifying Formatter
+email:
+- cbelsole@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- achievement.png
+- example/example.rb
+- gamifying_formatter.gemspec
+- lib/gamifying_formatter.rb
+- lib/test_info.rb
+- spec/gamifying_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: An rspec formatter for making testing fun.
+test_files:
+- spec/gamifying_formatter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: