Should `bit_fields` and `bit_fields_typed` be merged? or not?

[kojix2]

There are two ways to define bit fields: bit_fields and bit_fields_typed.

class Struct1 < FFI::BitStruct
  layout \
    :a, :uint8,
    :b, :uint8

  bit_fields :a,
    :u, 2,
    :v, 2,
    :w, 1,
    :x, 1,
    :y, 1,
    :z, 1
end

class AccessFlags < FFI::BitStruct
  layout \
    :flags, :uint8

  bit_fields_typed :flags,
    revoked: [1, :bool],       # Creates revoked? method
    expired: [1, :bool],       # Creates expired? method
    some_string: [4, :string],
    reserved: [2, :int]
end

Should we integrate these two methods into one?

class AccessFlags < FFI::BitStruct
  layout \
    :flags, :uint8

  bit_fields :flags,
    revoked: [1, :bool],       # Creates revoked? method
    expired: [1, :bool],       # Creates expired? method
    some_string: [4, :string],
    reserved: [2, :int]
end

In that case, should we also allow a second argument other than an array? (Default is :int)

class AccessFlags < FFI::BitStruct
  layout \
    :flags, :uint8

  bit_fields :flags,
    revoked: [1, :bool],       # Creates revoked? method
    expired: [1, :bool],       # Creates expired? method
    some_string: [4, :string],
    reserved: [2] # or 2
end

ping @djberg96

[djberg96]

I guess you could, just assume a typed bit field if it's an array. I leave it up to you, I'm fine with it either way.

[kojix2]

Thank you. I will release it as it is for now, because if I try to make it perfect, I might forget to finish the task.
There may be some problems, but please tell me if you find any.

[kojix2]

@djberg96
Released a gem.
I've also granted you RubyGem maintainer permissions.
You should receive an email. Feel free to use it if you like.

[djberg96]

@kojix2 Do you have a changelog anywhere? Might be a good idea to have one so you can remember what you've done over time. I realize folks can go through a commit log, but changelogs are nice because they're just a high level summary. Just a suggestion.