rspec-kungfuhamster 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 83e445d6b6f36abbdc071fa90fc752bbe001d090
-  data.tar.gz: a6e0f962912f05dfa28af4069871ba5e004f9b7d
+SHA256:
+  metadata.gz: cdeade8d8542b627204a981d63260b3ded4c3eb08258f66ea7f7e49e482b8f61
+  data.tar.gz: befdc3608a08866bc7d9c1556ee54283993a4068db106b607fd6a96c0a980a3d
 SHA512:
-  metadata.gz: f768b438b5f6d2032b2d6006547755c6474a5960b373af949a42789e0ec1ab61cb287634ec506ccfdfd05da3f2b85178afa6e1217cf6ef7959013c4a48d0b80e
-  data.tar.gz: 9be05a6034129734b493b0e5cb302abbb3be9f5cad59ed97e06d863c37bb4da826223d925b82fa673dd3a8608a57f2f48df13f18e2678b9b2bdaccf6c4f98404
+  metadata.gz: 6d9013150c705bb88c75067d9af425f4a65f7b5abed6779694f61fea85137bfc5d8b0ffa230fa06bb1fc888dcc40c3e4a02d91104ff957fed6d97b635a467c27
+  data.tar.gz: 99e1e684ffb1e0290ae84b8174a28f2d33d5cbe42461d5c21cec3f3d2617c834cb7ce7b0c2aa801ffbb7be8f7f34a05f26b6cc8c6ff8fda224ddd2758a085a6e

data/README.md

@@ -2,3 +2,93 @@ rspec-kungfuhamster
 ======================
 
 Animated kung fu hamster formatter
+
+# Sample Output
+
+As your tests run, you'll see an animated kung fu hamster performing various martial arts moves:
+
+```
+    ()__()
+    / o o\
+   |' =Y=';----
+   { \  / }
+    mmm mmm
+```
+
+The hamster is colorized based on your test results:
+- **Green** portion: Passing tests
+- **Yellow** portion: Pending tests
+- **Red** portion: Failing tests
+
+The hamster cycles through different kung fu poses as each test completes, creating an animated effect in your terminal!
+
+# Installation
+
+Add this to your Gemfile (in the test group) and run `bundle install`:
+
+``` ruby
+gem 'rspec-kungfuhamster'
+```
+
+# Usage
+
+After installing the gem, you can use the formatter in several ways:
+
+## Command Line
+
+Run RSpec with the formatter specified:
+
+```bash
+rspec --format RspecKungFuHamster::Formatter
+```
+
+## Configuration File
+
+Add to your `.rspec` file in your project root:
+
+```
+--format RspecKungFuHamster::Formatter
+```
+
+## RSpec Configuration
+
+Add to your `spec/spec_helper.rb` or `spec/rails_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  config.formatter = RspecKungFuHamster::Formatter
+end
+```
+
+Or if you want to use multiple formatters:
+
+```ruby
+RSpec.configure do |config|
+  config.formatter = :progress  # or :documentation
+  config.add_formatter RspecKungFuHamster::Formatter
+end
+```
+
+# Development
+
+## Automated Version Bumping
+
+This gem uses automated version bumping on pull requests merged to `main` or `master`. The version bump type is determined by labels on the PR:
+
+- **`major`** label: Bumps the major version (e.g., 1.2.3 → 2.0.0)
+- **`minor`** label: Bumps the minor version (e.g., 1.2.3 → 1.3.0)
+- **No label**: Defaults to patch bump (e.g., 1.2.3 → 1.2.4)
+
+The workflow automatically:
+1. Detects the bump type from PR labels
+2. Updates the version in `lib/rspec_kung_fu_hamster/version.rb`
+3. Commits the version bump with message `[skip ci]`
+4. Creates and pushes a git tag (e.g., `v1.2.3`)
+
+### Manual Version Bumping
+
+You can also manually bump the version using the script:
+
+```bash
+ruby scripts/bump_version.rb [major|minor|patch]
+```

data/lib/rspec_kung_fu_hamster/formatter.rb

@@ -0,0 +1 @@
+require 'rspec_kung_fu_hamster'

data/lib/rspec_kung_fu_hamster/version.rb

@@ -0,0 +1,3 @@
+module RspecKungFuHamster
+  VERSION = '0.2.0'
+end

data/lib/rspec_kung_fu_hamster.rb

@@ -1,29 +1,64 @@
 require 'rspec'
- require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/base_text_formatter'
+require 'rspec_kung_fu_hamster/version'
 
 rspec_bin = $0.split('/').last
 
-class RspecKungFuHamster < RSpec::Core::Formatters::BaseTextFormatter
-  RSpec::Core::Formatters.register self,
+module RspecKungFuHamster
+  class Formatter < RSpec::Core::Formatters::BaseTextFormatter
+    RSpec::Core::Formatters.register self,
 #    :start,
 #     :example_start
 #    :message,
-    :example_passed
-#    :example_pending,
-#    :example_failed,
+    :example_passed,
+    :example_pending,
+    :example_failed
 #    :dump_failures
 
   def initialize(output)
     @index = 0
+    @example_passed = 0
+    @example_pending = 0
+    @example_failed = 0
     super(output)
   end
 
+  def color_positions(length)
+    total = @example_passed + @example_pending + @example_failed
+    passed_percent = @example_passed * length / total
+    pending_percent = @example_pending * length / total
+
+    [passed_percent, passed_percent + pending_percent, length]
+  end
+
+  GREEN = "\e[32m"
+  YELLOW = "\e[33m"
+  RED = "\e[31m"
+  RESET = "\e[0m"
+
+  def colorize(string)
+    green, yellow, red = color_positions(string.length)
+    GREEN + string[0...green] + YELLOW + string[green...yellow] + RED + string[yellow...red] + RESET
+  end
+
+  def display(strings)
+    colorize(strings.join("\n"))
+  end
+
+  def output_hamster
+    output.puts "\e[2J\e[;H" + display(hamster_and_next)
+  end
   def example_passed(notification)
-    output.puts "\e[2J\e[;H" << hamster_and_next.join("\n")
+    @example_passed += 1
+    output_hamster
+  end
+  def example_pending(notification)
+    @example_pending += 1
+    output_hamster
   end
   def example_failed(notification)
-    output.puts "\e[2J\e[;H" << hamster_and_next.join("\n")
-    sleep 0.1
+    @example_failed += 1
+    output_hamster
   end
 
   def hamster_and_next
@@ -76,4 +111,5 @@ class RspecKungFuHamster < RSpec::Core::Formatters::BaseTextFormatter
     "   { \\  / }    ",
     "    mmm mmm    "
   ]
+  end
 end

data/spec/kungfuhamster_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/rspec_kung_fu_hamster.rb'
-describe RspecKungFuHamster do
+describe RspecKungFuHamster::Formatter do
   100.times do |i|
     it { expect(i).to eq i }
   end
-  it { expect(RspecKungFuHamster::KUNG_FU_HAMSTER.length).to eq 6 }
+  it { expect(RspecKungFuHamster::Formatter::KUNG_FU_HAMSTER.length).to eq 6 }
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-kungfuhamster
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Powell
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,18 +29,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
 - lib/rspec_kung_fu_hamster.rb
+- lib/rspec_kung_fu_hamster/formatter.rb
+- lib/rspec_kung_fu_hamster/version.rb
 - spec/kungfuhamster_spec.rb
 homepage: https://github.com/stringsn88keys/rspec-kungfuhamster
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options:
 - "--charset"
 - UTF-8
@@ -58,11 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rspec kung fu hamster formatter
 test_files:
 - spec/kungfuhamster_spec.rb
-has_rdoc: