type_balancer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ffc72598d68e02ede3d667d51d4eb3bafd48597cddbb36e124cdb95a8e6f54c
-  data.tar.gz: fd4d236432a8490e20271c66235ecd4bcd114cb6d5ceb213dbbc7e9346f7037e
+  metadata.gz: f73ec86fddfda3cd22f19b0081824a8a488e1a47359976e32eb6b999074b92a3
+  data.tar.gz: f25f85b6caeeeb3a5f8012ae295b96ae02413e4b4342aba946438bbcbb9eb063
 SHA512:
-  metadata.gz: ea6b99ba44cb6e209a122a18a16a88cc8a8ccb6c5f8a1ceba1a443344489e1744cc3d105886d27df4e601a2149d0bbf0a72cabc9ddd5f766a3fada1d88abc64e
-  data.tar.gz: eac933d9f6b1e77f4ec4e83794aabd09dabd47f4a83fd10e148e40680c0cff411dd33c8eaf343823b830206c7b16536c954372788e78bcd65cecbbac5d09d227
+  metadata.gz: c8895eea255feccab33cd33ba70d9bfb486a4ff9108ba1a828d1be72b501db1635cb35d5aab574298923533d1080c29d7b45a50bb8d1547ffdacfd882dc4d491
+  data.tar.gz: '09f755338981a1523cae4eddc3468b17d7693b9183e7039b7e81f1d24bd6beab29133d9d9a797487ea3745195f3f4e577311c89258b41fa237bd63cc3fb63cd2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    type_balancer (0.1.2)
+    type_balancer (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,7 +20,7 @@ TypeBalancer is a sophisticated Ruby gem designed to solve the challenge of dist
 
 The gem uses advanced distribution algorithms to ensure that items are not only balanced by type but also maintain optimal spacing, preventing clusters of similar content while respecting specified ratios.
 
-[View Examples & Quality Tests](docs/quality.md) | [View Benchmark Results](docs/benchmarks/README.md)
+[View Documentation](docs/README.md) | [View Benchmark Results](docs/benchmarks/README.md)
 
 ## Installation
 
@@ -56,6 +56,60 @@ items = [
 balanced_items = TypeBalancer.balance(items, type_field: :type)
 ```
 
+## Balancing Collections with `TypeBalancer.balance`
+
+The primary method for balancing collections is `TypeBalancer.balance`. This method takes an array of items and distributes them by type, ensuring optimal spacing and respecting type ratios.
+
+**Basic Example:**
+
+```ruby
+items = [
+  { type: 'video', title: 'Video 1' },
+  { type: 'image', title: 'Image 1' },
+  { type: 'article', title: 'Article 1' },
+  # ...
+]
+balanced = TypeBalancer.balance(items, type_field: :type)
+# => [ { type: 'article', ... }, { type: 'image', ... }, { type: 'video', ... }, ... ]
+```
+
+**Custom Type Order:**
+
+You can specify a custom order for types using the `type_order` argument. This controls the priority of types in the balanced output.
+
+```ruby
+# Prioritize images, then videos, then articles
+balanced = TypeBalancer.balance(items, type_field: :type, type_order: %w[image video article])
+# => [ { type: 'image', ... }, { type: 'video', ... }, { type: 'article', ... }, ... ]
+```
+
+- `type_field`: The key to use for type extraction (default: `:type`).
+- `type_order`: An array of type names (as strings) specifying the desired order.
+
+For more advanced usage and options, see [Detailed Balance Method Documentation](docs/balance.md).
+
+## Calculating Positions Directly
+
+In addition to balancing collections, you can use `TypeBalancer.calculate_positions` to determine optimal positions for a given type or subset of items within a sequence. This is useful for advanced scenarios where you need fine-grained control over item placement.
+
+**Basic Example:**
+
+```ruby
+# Calculate positions for 3 items in a sequence of 10 slots
+positions = TypeBalancer.calculate_positions(total_count: 10, ratio: 0.3)
+# => [0, 5, 9]
+```
+
+**With Available Items:**
+
+```ruby
+# Restrict placement to specific slots
+positions = TypeBalancer.calculate_positions(total_count: 10, ratio: 0.5, available_items: [0, 1, 2])
+# => [0, 1, 2]
+```
+
+For more advanced usage and options, see [Detailed Position Calculation Documentation](docs/calculate_positions.md).
+
 ## Performance Characteristics
 
 TypeBalancer is designed to handle collections of varying sizes efficiently. Here are the current performance metrics:
@@ -91,7 +145,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then:
 3. Run `rake rubocop` to check code style
 4. Run `bin/console` for an interactive prompt
 
-For more information about the quality script and its uses, see our [quality script documentation](docs/quality.md).
+For more information about the gem, its features, and quality checks, see our [documentation](docs/README.md).
 
 ## Contributing
 
@@ -140,7 +194,7 @@ We welcome contributions to TypeBalancer! Here's how you can help:
 - Quality script should pass without new issues
 
 For more detailed information about our development process and tools:
-- [Quality Script Documentation](docs/quality.md)
+- [Documentation](docs/README.md)
 - [Benchmark Documentation](docs/benchmarks/README.md)
 
 ## License

data/docs/README.md

@@ -0,0 +1,8 @@
+# Documentation Index
+
+Welcome to the TypeBalancer documentation! Below you'll find links to all major documentation resources for the gem.
+
+- [Quality Script](quality.md): Integration and example script for verifying gem functionality, with instructions for running locally or from other projects.
+- [Balance Method Details](balance.md): In-depth documentation for the `TypeBalancer.balance` method, including arguments, usage, and edge cases.
+- [Calculate Positions Method Details](calculate_positions.md): Detailed documentation for `TypeBalancer.calculate_positions`, with examples and caveats.
+- [Benchmarks](benchmarks/README.md): Performance metrics and benchmarking methodology for the gem. 

data/docs/balance.md

@@ -0,0 +1,71 @@
+# Detailed Documentation: `TypeBalancer.balance`
+
+`TypeBalancer.balance` is the main method for distributing items of different types across a sequence, ensuring optimal spacing and respecting type ratios. It is highly configurable and supports custom type fields and type orderings.
+
+## Method Signature
+
+```ruby
+TypeBalancer.balance(items, type_field: :type, type_order: nil)
+```
+
+### Arguments
+- `items` (Array<Hash>): The collection of items to balance. Each item should have a type field (default: `:type`).
+- `type_field` (Symbol/String, optional): The key to use for extracting the type from each item. Default is `:type`.
+- `type_order` (Array<String>, optional): An array specifying the desired order of types in the output. If omitted, the gem determines the order automatically.
+
+## Return Value
+- Returns a new array of items, balanced by type and spaced as evenly as possible.
+- The output array will have the same length as the input.
+
+## Usage Examples
+
+### 1. Basic Balancing
+```ruby
+items = [
+  { type: 'video', title: 'Video 1' },
+  { type: 'image', title: 'Image 1' },
+  { type: 'article', title: 'Article 1' },
+  { type: 'article', title: 'Article 2' },
+  { type: 'image', title: 'Image 2' },
+  { type: 'video', title: 'Video 2' }
+]
+balanced = TypeBalancer.balance(items)
+# => [ { type: 'article', ... }, { type: 'image', ... }, { type: 'video', ... }, ... ]
+```
+
+### 2. Custom Type Order
+```ruby
+# Prioritize images, then videos, then articles
+balanced = TypeBalancer.balance(items, type_order: %w[image video article])
+# => [ { type: 'image', ... }, { type: 'video', ... }, { type: 'article', ... }, ... ]
+```
+
+### 3. Custom Type Field
+```ruby
+items = [
+  { category: 'video', title: 'Video 1' },
+  { category: 'image', title: 'Image 1' },
+  { category: 'article', title: 'Article 1' }
+]
+balanced = TypeBalancer.balance(items, type_field: :category)
+# => [ { category: 'article', ... }, { category: 'image', ... }, { category: 'video', ... } ]
+```
+
+### 4. Handling Missing Types
+If a type in `type_order` is not present in the input, it is simply ignored in the output order.
+
+### 5. Edge Cases
+- **Empty Input:** Raises an exception (`Collection cannot be empty`).
+- **Single Type:** All items are returned in their original order.
+- **Missing Type Field:** If an item is missing the type field, it is ignored or may cause an error depending on context.
+
+## Notes and Caveats
+- The method is deterministic: the same input will always produce the same output.
+- The `type_order` argument must be an array of strings matching the type values in your items.
+- If you use a custom `type_field`, ensure all items have that field.
+- The method does not mutate the input array.
+
+## See Also
+- [README.md](../README.md) for general usage
+- [Quality Script Documentation](quality.md) for integration tests and examples
+- [Detailed Position Calculation Documentation](calculate_positions.md) 

data/docs/calculate_positions.md

@@ -0,0 +1,87 @@
+# Detailed Documentation: `TypeBalancer.calculate_positions`
+
+`TypeBalancer.calculate_positions` is a utility method for determining the optimal positions for a given number of items (or a ratio of items) within a sequence of slots. This is useful for advanced scenarios where you want to control the distribution of a specific type or subset of items.
+
+## Method Signature
+
+```ruby
+TypeBalancer.calculate_positions(total_count:, ratio:, available_items: nil)
+```
+
+### Arguments
+- `total_count` (Integer): The total number of slots in the sequence (e.g., the length of your feed or array).
+- `ratio` (Float): The desired ratio of items to place (e.g., `0.3` for 30%).
+- `available_items` (Array<Integer>, optional): An array of slot indices where placement is allowed. If omitted, all slots are considered available.
+
+## Return Value
+- Returns an array of integer indices representing the optimal positions for the items.
+- The array will have a length close to `total_count * ratio`, rounded as appropriate.
+- If `available_items` is provided, only those slots will be used.
+
+## Usage Examples
+
+### 1. Even Distribution
+```ruby
+# Place 3 items evenly in 10 slots
+TypeBalancer.calculate_positions(total_count: 10, ratio: 0.3)
+# => [0, 5, 9]
+```
+
+### 2. Restricting to Available Slots
+```ruby
+# Only use slots 0, 1, and 2
+TypeBalancer.calculate_positions(total_count: 10, ratio: 0.5, available_items: [0, 1, 2])
+# => [0, 1, 2]
+```
+
+### 3. Edge Cases
+```ruby
+# Single item
+TypeBalancer.calculate_positions(total_count: 1, ratio: 1.0)
+# => [0]
+
+# No items
+TypeBalancer.calculate_positions(total_count: 100, ratio: 0.0)
+# => []
+
+# All items
+TypeBalancer.calculate_positions(total_count: 5, ratio: 1.0)
+# => [0, 1, 2, 3, 4]
+```
+
+### 4. Precision with Small Ratios
+```ruby
+# Two positions in three slots
+TypeBalancer.calculate_positions(total_count: 3, ratio: 0.67)
+# => [0, 1]
+
+# Single position in three slots
+TypeBalancer.calculate_positions(total_count: 3, ratio: 0.34)
+# => [0]
+```
+
+### 5. Available Items Edge Cases
+```ruby
+# Single target with multiple available positions
+TypeBalancer.calculate_positions(total_count: 5, ratio: 0.2, available_items: [1, 2, 3])
+# => [1]
+
+# Two targets with multiple available positions
+TypeBalancer.calculate_positions(total_count: 10, ratio: 0.2, available_items: [1, 3, 5])
+# => [1, 5]
+
+# Exact match of available positions
+TypeBalancer.calculate_positions(total_count: 10, ratio: 0.3, available_items: [2, 4, 6])
+# => [2, 4, 6]
+```
+
+## Notes and Caveats
+- If `ratio` is 0 or `total_count` is 0, returns an empty array.
+- If `ratio` is 1.0, returns all available slots.
+- If `available_items` is provided and its length is less than the target count, all available items are returned.
+- For very small or very large ratios, the method ensures at least one or all slots are used, respectively.
+- The method is deterministic and will always return the same result for the same input.
+
+## See Also
+- [README.md](../README.md) for general usage
+- [Quality Script Documentation](quality.md) for integration tests and examples 

data/docs/quality.md

@@ -8,12 +8,42 @@ The TypeBalancer gem includes a comprehensive quality check script located at `/
 
 ## Running the Script
 
-To run the quality script:
+To run the quality script from the gem repository:
 
 ```bash
 bundle exec ruby examples/quality.rb
 ```
 
+### Running from Other Projects
+
+You can run the quality script from any project that includes the TypeBalancer gem. This is useful for verifying the gem's behavior in your app or as part of CI for downstream projects.
+
+**Example:**
+
+```bash
+bundle exec ruby /path/to/gems/type_balancer/examples/quality.rb
+```
+
+**How do I find the path to the gem?**
+
+If you are not sure where the gem is installed, you can use Bundler to locate it:
+
+```bash
+bundle show type_balancer
+```
+
+This will print the path to the gem directory. The quality script is located in the `examples` subdirectory of that path. For example:
+
+```bash
+$ bundle show type_balancer
+/Users/yourname/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/type_balancer-0.1.3
+$ bundle exec ruby /Users/yourname/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/type_balancer-0.1.3/examples/quality.rb
+```
+
+- Ensure the gem is installed and available in your bundle.
+- The script expects the test data file at `examples/balance_test_data.yml` (relative to the gem root).
+- Output will be color-coded if your terminal supports ANSI colors.
+
 ## What it Tests
 
 The script tests several key aspects of the TypeBalancer gem:
@@ -23,32 +53,23 @@ The script tests several key aspects of the TypeBalancer gem:
 - Shows spacing calculations between positions
 - Verifies edge cases (single item, no items, all items)
 
-### 2. Content Feed Example
+### 2. Robust Balance Method Tests
+- Loads scenarios from a YAML file (`examples/balance_test_data.yml`)
+- Tests `TypeBalancer.balance` with and without the `type_order` argument
+- Checks type counts, custom order, and exception handling for empty input
+- Prints a color-coded summary table for pass/fail counts
+
+### 3. Content Feed Example
 - Shows a real-world example of content type distribution
 - Verifies position allocation for different content types (video, image, article)
 - Checks distribution statistics and ratios
 
-### 3. Balancer API
-- Tests the main TypeBalancer.balance method
-- Verifies batch creation and size limits
-- Demonstrates custom type ordering
-
-### 4. Type Extraction
-- Tests type extraction from both hash and object items
-- Verifies support for different type field access methods
-
-### 5. Error Handling
-- Validates handling of empty collections
-- Tests response to invalid type fields
-- Verifies batch size validation
-
 ## Output Format
 
-The script provides detailed output showing:
-- Results of each test case
-- Distribution statistics
-- Any issues found during testing
-- A summary of all examples run and passed
+- Each section prints a color-coded summary table of passing and failing tests
+- Failures and exceptions are highlighted in red; passes in green
+- The final summary shows the total number of examples run and passed
+- The script exits with status 0 if all tests pass, or 1 if any fail (CI-friendly)
 
 ## Using as a Development Tool
 
@@ -58,6 +79,19 @@ The quality script is particularly useful when:
 3. Verifying changes haven't broken core functionality
 4. Understanding how different features work together
 
+## Customizing/Extending the Script
+
+- You can add new scenarios to `examples/balance_test_data.yml` to test additional cases or edge conditions.
+- You may copy or extend the script for your own integration tests.
+- The script can be adapted to accept a custom YAML path if needed (see comments in the script).
+
+## Troubleshooting
+
+- **Color output not working:** Ensure your terminal supports ANSI colors.
+- **File not found:** Make sure `examples/balance_test_data.yml` exists and is accessible from the script's location.
+- **Gem not found:** Ensure the TypeBalancer gem is installed and available in your bundle.
+- **Path issues:** Use an absolute or correct relative path to the script when running from another project.
+
 ## Extending the Script
 
 When adding new features to TypeBalancer, consider:

data/examples/balance_test_data.yml

@@ -0,0 +1,66 @@
+# Test data for TypeBalancer.balance integration tests
+
+- name: Even distribution
+  items:
+    - { type: video, id: 1 }
+    - { type: video, id: 2 }
+    - { type: image, id: 3 }
+    - { type: image, id: 4 }
+    - { type: article, id: 5 }
+    - { type: article, id: 6 }
+    - { type: article, id: 7 }
+    - { type: article, id: 8 }
+  expected_type_counts:
+    video: 2
+    image: 2
+    article: 4
+
+- name: Uneven distribution
+  items:
+    - { type: video, id: 1 }
+    - { type: image, id: 2 }
+    - { type: article, id: 3 }
+    - { type: article, id: 4 }
+    - { type: article, id: 5 }
+    - { type: article, id: 6 }
+    - { type: article, id: 7 }
+    - { type: article, id: 8 }
+  expected_type_counts:
+    video: 1
+    image: 1
+    article: 6
+
+- name: Missing type (no images)
+  items:
+    - { type: video, id: 1 }
+    - { type: video, id: 2 }
+    - { type: article, id: 3 }
+    - { type: article, id: 4 }
+    - { type: article, id: 5 }
+  expected_type_counts:
+    video: 2
+    article: 3
+
+- name: Custom type order
+  items:
+    - { type: video, id: 1 }
+    - { type: image, id: 2 }
+    - { type: article, id: 3 }
+    - { type: article, id: 4 }
+    - { type: image, id: 5 }
+    - { type: video, id: 6 }
+    - { type: article, id: 7 }
+  type_order: [image, video, article]
+  expected_first_type: image
+
+- name: Edge case - empty
+  items: []
+  expected_type_counts: {}
+
+- name: Edge case - single type
+  items:
+    - { type: article, id: 1 }
+    - { type: article, id: 2 }
+    - { type: article, id: 3 }
+  expected_type_counts:
+    article: 3 

data/examples/quality.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
 require 'type_balancer'
+require 'yaml'
 
 class QualityChecker
+  GREEN = "\e[32m"
+  RED = "\e[31m"
+  YELLOW = "\e[33m"
+  RESET = "\e[0m"
+
   def initialize
     @issues = []
     @examples_run = 0
@@ -15,6 +21,7 @@ class QualityChecker
     check_edge_cases
     check_position_precision
     check_available_positions_edge_cases
+    check_balance_method_robust
     check_real_world_feed
 
     print_summary
@@ -29,11 +36,15 @@ class QualityChecker
 
   def check_basic_distribution
     @examples_run += 1
+    @section_examples_run = 0 if !defined?(@section_examples_run)
+    @section_examples_passed = 0 if !defined?(@section_examples_passed)
+    @section_examples_run += 1
     puts "\nBasic Distribution Example:"
     positions = TypeBalancer.calculate_positions(total_count: 10, ratio: 0.3)
 
     if positions == [0, 5, 9]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Basic distribution positions #{positions.inspect} don't match expected [0, 5, 9]")
     end
@@ -49,6 +60,7 @@ class QualityChecker
 
   def check_available_items
     @examples_run += 1
+    @section_examples_run += 1
     puts "\nAvailable Items Example:"
     positions = TypeBalancer.calculate_positions(
       total_count: 10,
@@ -58,6 +70,7 @@ class QualityChecker
 
     if positions == [0, 1, 2]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Available items test returned #{positions.inspect} instead of expected [0, 1, 2]")
     end
@@ -70,33 +83,40 @@ class QualityChecker
 
     # Single item
     @examples_run += 1
+    @section_examples_run += 1
     single = TypeBalancer.calculate_positions(total_count: 1, ratio: 1.0)
     puts "Single item: #{single.inspect}"
     if single == [0]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Single item case returned #{single.inspect} instead of [0]")
     end
 
     # No items
     @examples_run += 1
+    @section_examples_run += 1
     none = TypeBalancer.calculate_positions(total_count: 100, ratio: 0.0)
     puts "No items needed: #{none.inspect}"
     if none == []
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Zero ratio case returned #{none.inspect} instead of []")
     end
 
     # All items
     @examples_run += 1
+    @section_examples_run += 1
     all = TypeBalancer.calculate_positions(total_count: 5, ratio: 1.0)
     puts "All items needed: #{all.inspect}"
     if all == [0, 1, 2, 3, 4]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Full ratio case returned #{all.inspect} instead of [0, 1, 2, 3, 4]")
     end
+    print_section_table('calculate_positions')
   end
 
   def check_position_precision
@@ -104,23 +124,28 @@ class QualityChecker
     
     # Two positions in three slots
     @examples_run += 1
+    @section_examples_run += 1
     positions = TypeBalancer.calculate_positions(total_count: 3, ratio: 0.67)
     puts "Two positions in three slots: #{positions.inspect}"
     if positions == [0, 1]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Two in three case returned #{positions.inspect} instead of [0, 1]")
     end
 
     # Single position in three slots
     @examples_run += 1
+    @section_examples_run += 1
     positions = TypeBalancer.calculate_positions(total_count: 3, ratio: 0.34)
     puts "Single position in three slots: #{positions.inspect}"
     if positions == [0]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("One in three case returned #{positions.inspect} instead of [0]")
     end
+    print_section_table('calculate_positions')
   end
 
   def check_available_positions_edge_cases
@@ -128,6 +153,7 @@ class QualityChecker
 
     # Single target with multiple available positions
     @examples_run += 1
+    @section_examples_run += 1
     positions = TypeBalancer.calculate_positions(
       total_count: 5,
       ratio: 0.2,
@@ -136,12 +162,14 @@ class QualityChecker
     puts "Single target with multiple available: #{positions.inspect}"
     if positions == [1]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Single target with multiple available returned #{positions.inspect} instead of [1]")
     end
 
     # Two targets with multiple available positions
     @examples_run += 1
+    @section_examples_run += 1
     positions = TypeBalancer.calculate_positions(
       total_count: 10,
       ratio: 0.2,
@@ -150,12 +178,14 @@ class QualityChecker
     puts "Two targets with multiple available: #{positions.inspect}"
     if positions == [1, 5]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Two targets with multiple available returned #{positions.inspect} instead of [1, 5]")
     end
 
     # Exact match of available positions
     @examples_run += 1
+    @section_examples_run += 1
     positions = TypeBalancer.calculate_positions(
       total_count: 10,
       ratio: 0.3,
@@ -164,17 +194,111 @@ class QualityChecker
     puts "Exact match of available positions: #{positions.inspect}"
     if positions == [2, 4, 6]
       @examples_passed += 1
+      @section_examples_passed += 1
     else
       record_issue("Exact match case returned #{positions.inspect} instead of [2, 4, 6]")
     end
+    print_section_table('calculate_positions')
+  end
+
+  def check_balance_method_robust
+    puts "\n#{YELLOW}Robust Balance Method Tests:#{RESET}"
+    scenarios = YAML.load_file(File.expand_path('../balance_test_data.yml', __FILE__))
+    section_run = 0
+    section_passed = 0
+    scenarios.each do |scenario|
+      @examples_run += 1
+      section_run += 1
+      # Deep symbolize keys for all items in the scenario
+      items = (scenario['items'] || []).map { |item| deep_symbolize_keys(item) }
+      type_order = scenario['type_order']
+      expected_type_counts = scenario['expected_type_counts'] || {}
+      expected_first_type = scenario['expected_first_type']
+
+      # Test with and without type_order
+      [nil, type_order].uniq.each do |order|
+        label = order ? "with type_order #{order}" : "default order"
+        begin
+          # Special handling for the empty input case
+          if scenario['name'] =~ /empty/i
+            begin
+              if order
+                TypeBalancer.balance(items, type_field: :type, type_order: order)
+              else
+                TypeBalancer.balance(items, type_field: :type)
+              end
+              # If no exception, this is a failure
+              record_issue("#{scenario['name']} (#{label}): Expected exception for empty input, but none was raised")
+              puts "#{RED}#{scenario['name']} (#{label}): Expected exception for empty input, but none was raised#{RESET}"
+            rescue => e
+              if e.message =~ /Collection cannot be empty/
+                @examples_passed += 1
+                section_passed += 1
+                puts "#{GREEN}#{scenario['name']} (#{label}): Correctly raised exception for empty input#{RESET}"
+              else
+                record_issue("#{scenario['name']} (#{label}): Unexpected exception: #{e}")
+                puts "#{RED}#{scenario['name']} (#{label}): Unexpected exception: #{e}#{RESET}"
+              end
+            end
+            next
+          end
+          # Normal test logic for other cases
+          result = if order
+            TypeBalancer.balance(items, type_field: :type, type_order: order)
+          else
+            TypeBalancer.balance(items, type_field: :type)
+          end
+        rescue => e
+          record_issue("#{scenario['name']} (#{label}): Exception raised: #{e}")
+          puts "#{RED}#{scenario['name']} (#{label}): Exception raised: #{e}#{RESET}"
+          next
+        end
+        # Check type counts
+        type_counts = result.group_by { |i| i[:type] }.transform_values(&:size)
+        if expected_type_counts && !expected_type_counts.empty?
+          if type_counts != expected_type_counts
+            record_issue("#{scenario['name']} (#{label}): Type counts #{type_counts.inspect} do not match expected #{expected_type_counts.inspect}")
+            puts "#{RED}#{scenario['name']} (#{label}): Type counts #{type_counts.inspect} do not match expected #{expected_type_counts.inspect}#{RESET}"
+          else
+            @examples_passed += 1
+            section_passed += 1
+            puts "#{GREEN}#{scenario['name']} (#{label}): Passed#{RESET}"
+          end
+        end
+        # Check first type for custom order
+        if expected_first_type && order
+          if result.first && result.first[:type] != expected_first_type
+            record_issue("#{scenario['name']} (#{label}): First type #{result.first[:type]} does not match expected #{expected_first_type}")
+            puts "#{RED}#{scenario['name']} (#{label}): First type #{result.first[:type]} does not match expected #{expected_first_type}#{RESET}"
+          else
+            @examples_passed += 1
+            section_passed += 1
+            puts "#{GREEN}#{scenario['name']} (#{label}): Custom order respected#{RESET}"
+          end
+        end
+        puts "  Result: #{result.map { |i| i[:type] }.inspect}"
+        puts "  Type counts: #{type_counts.inspect}"
+      end
+    end
+    print_section_table('balance_method', section_run, section_passed)
+  end
+
+  # Helper to deeply symbolize keys in a hash
+  def deep_symbolize_keys(obj)
+    case obj
+    when Hash
+      obj.each_with_object({}) { |(k, v), h| h[k.to_sym] = deep_symbolize_keys(v) }
+    when Array
+      obj.map { |v| deep_symbolize_keys(v) }
+    else
+      obj
+    end
   end
 
   def check_real_world_feed
     @examples_run += 1
-    puts "\nReal World Example - Content Feed:"
+    puts "\n#{YELLOW}Real World Example - Content Feed:#{RESET}"
     feed_size = 20
-
-    # Create test items
     items = [
       { type: 'video', id: 1 },
       { type: 'video', id: 2 },
@@ -186,87 +310,22 @@ class QualityChecker
       { type: 'article', id: 8 },
       { type: 'article', id: 9 }
     ]
-
-    # Track allocated positions
-    allocated_positions = []
-    content_positions = {}
-
-    # Calculate positions for each type
-    content_positions[:video] = TypeBalancer.calculate_positions(
-      total_count: feed_size,
-      ratio: 0.3,
-      available_items: (0..7).to_a - allocated_positions
-    )
-    allocated_positions += content_positions[:video]
-
-    content_positions[:image] = TypeBalancer.calculate_positions(
-      total_count: feed_size,
-      ratio: 0.4,
-      available_items: (0..14).to_a - allocated_positions
-    )
-    allocated_positions += content_positions[:image]
-
-    content_positions[:article] = TypeBalancer.calculate_positions(
-      total_count: feed_size,
-      ratio: 0.3,
-      available_items: (0..19).to_a - allocated_positions
-    )
-
-    puts "\nContent Type Positions:"
-    content_positions.each do |type, pos|
-      puts "#{type}: #{pos.inspect}"
-    end
-
-    # Check for overlaps
-    all_positions = content_positions.values.compact.flatten
-    if all_positions == all_positions.uniq
-      puts "\nSuccess: No overlapping positions!"
-      @examples_passed += 1
-    else
-      overlaps = all_positions.group_by { |e| e }.select { |_, v| v.size > 1 }.keys
-      record_issue("Found overlapping positions at indices: #{overlaps.inspect}")
-      puts "\nWarning: Some positions overlap!"
-    end
-
-    # Verify distribution
-    puts "\nDistribution Stats:"
-    expected_counts = { video: 6, image: 8, article: 6 }
-    content_positions.each do |type, positions|
-      count = positions&.length || 0
-      percentage = (count.to_f / feed_size * 100).round(1)
-      puts "#{type}: #{count} items (#{percentage}% of feed)"
-
-      if count != expected_counts[type]
-        record_issue("#{type} count #{count} doesn't match expected #{expected_counts[type]}")
-      end
-    end
-
     # Test with custom type order
     ordered_result = TypeBalancer.balance(
       items,
       type_field: :type,
       type_order: %w[article image video]
     )
-
-    # Verify type order is respected
     if ordered_result.first[:type] == 'article'
       @examples_passed += 1
+      puts "#{GREEN}Custom type order respected in real world feed#{RESET}"
+      print_section_table('real_world_feed', 1, 1)
     else
-      record_issue("Custom type order not respected")
-    end
-
-    # Test position calculation
-    positions = TypeBalancer::Distributor.calculate_target_positions(
-      total_count: 10,
-      ratio: 0.3
-    )
-    if positions.is_a?(Array) && positions.all? { |p| p.is_a?(Integer) }
-      @examples_passed += 1
-    else
-      record_issue("Position calculation failed")
+      record_issue("Custom type order not respected in real world feed")
+      puts "#{RED}Custom type order not respected in real world feed#{RESET}"
+      print_section_table('real_world_feed', 1, 0)
     end
-
-    puts "\nBalanced items with custom order:"
+    puts "  Balanced items with custom order: #{ordered_result.map { |i| i[:type] }.inspect}"
   end
 
   def print_summary
@@ -276,15 +335,28 @@ class QualityChecker
     puts "Expectations Passed: #{@examples_passed}"
 
     if @issues.empty?
-      puts "\nAll quality checks passed! ✓"
+      puts "\n#{GREEN}All quality checks passed! ✓#{RESET}"
     else
-      puts "\nQuality check failed with #{@issues.size} issues:"
+      puts "\n#{RED}Quality check failed with #{@issues.size} issues:#{RESET}"
       @issues.each_with_index do |issue, index|
-        puts "#{index + 1}. #{issue}"
+        puts "#{RED}#{index + 1}. #{issue}#{RESET}"
       end
     end
     puts "#{'-' * 50}"
   end
+
+  # Print a summary table for a section
+  def print_section_table(section, run = @section_examples_run, passed = @section_examples_passed)
+    failed = run - passed
+    puts "\nSection: #{section}"
+    puts "-----------------------------"
+    puts "  #{GREEN}Passing: #{passed}#{RESET}"
+    puts "  #{RED}Failing: #{failed}#{RESET}"
+    puts "-----------------------------\n"
+    # Reset section counters for next section
+    @section_examples_run = 0
+    @section_examples_passed = 0
+  end
 end
 
 QualityChecker.new.run

data/lib/type_balancer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypeBalancer
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: type_balancer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Carl Smith
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies: []
 description: Balances types in collections by ensuring each type appears a similar
   number of times
@@ -37,8 +37,12 @@ files:
 - benchmark_results/ruby3.3.7_yjit.txt
 - benchmark_results/ruby3.4.2.txt
 - benchmark_results/ruby3.4.2_yjit.txt
+- docs/README.md
+- docs/balance.md
 - docs/benchmarks/README.md
+- docs/calculate_positions.md
 - docs/quality.md
+- examples/balance_test_data.yml
 - examples/quality.rb
 - lib/type_balancer.rb
 - lib/type_balancer/alternating_filler.rb
@@ -76,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Balances types in collections
 test_files: []