distributing-iterator

Distributing iterator

Synopsis

Rust

use distributing_iterator::DistributingIterator;

#[derive(Debug, PartialEq)]
struct Item {
    id: u64,
}

let data = vec![
    Item { id: 1 },
    Item { id: 1 },
    Item { id: 1 },
    Item { id: 2 },
    Item { id: 2 },
    Item { id: 2 },
    Item { id: 3 },
    Item { id: 3 },
    Item { id: 3 },
];
let iterator = DistributingIterator::new(data.into(), 3, |item| item.id);
let result: Vec<Item> = iterator.collect();
assert_eq!(
    result,
    vec![
        Item { id: 1 }, Item { id: 2 }, Item { id: 3 },
        Item { id: 1 }, Item { id: 2 }, Item { id: 3 },
        Item { id: 1 }, Item { id: 2 }, Item { id: 3 },
    ]
);

As a ruby gem:

Gemfile:

gem 'distributing_iterator', git: 'fetlife/distributing-iterator'

require 'distributing_iterator'

csv = <<~CSV
id,name
1,foo
1,bar
1,baz
2,qux
3,quux
3,corge
2,grault
2,garply
3,waldo
3,fred
2,plugh
3,xyzzy
2,thud
3,plugh
3,xyzzy
CSV

output = DistributingIterator.distribute_csv(csv, 'id', 3)

puts output
# id,name
# 1,foo
# 2,qux
# 3,quux
# 1,bar
# 2,grault
# 3,corge
# 1,baz
# 2,garply
# 3,waldo
# 2,plugh
# 3,fred
# 2,thud
# 3,xyzzy
# 3,plugh
# 3,xyzzy

Releasing a New Version

To work on the gem locally:

bundle install
bundle exec rake compile
bundle exec rake test

To build a source gem:

bundle exec rake build

To build a native gem for the current platform:

bundle exec rake native gem

To build a cross-compiled native gem for a specific platform:

bundle exec rb-sys-dock --platform x86_64-linux --build

To release a new version of the gem:

1. Update the version number in Cargo.toml and lib/distributing_iterator/version.rb
2. Create and push a new git tag with the version number (e.g., 0.2.1 or v0.2.1):

   git tag 0.2.1
   git push origin 0.2.1

The release workflow will automatically:

• Build the source gem
• Compile native gems for multiple platforms:
  • x86_64 Linux
  • aarch64 Linux
  • x86_64 macOS
  • arm64 macOS
  • x64 Windows (UCRT)
• Create a GitHub release with all compiled gems
• Generate release notes based on the commits since the last release

The compiled gems will be available for download from the GitHub release page: https://github.com/fetlife/distributing-iterator/releases