Changelog

SemVer 2.0.0 Keep-A-Changelog 1.0.0

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning,
and yes, platform and engine support are part of the public API.
Please file a bug if you notice a violation of semantic versioning.

Unreleased

Added

Changed

Deprecated

Removed

Fixed

Security

1.0.5 - 2026-07-31

  • TAG: v1.0.5
  • COVERAGE: 90.75% – 412/454 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 30.00% documented

Added

  • Documentation linting now has its generated yard-lint dependency and severity config available in the local bundle.

  • kettle-jem-template-20260726-001 - Projects now include YARD lint
    configuration and documentation dependencies so documentation issues fail
    before generated docs are refreshed.

  • kettle-jem-template-20260727-001 - Spec harness documentation now lists the
    RSpec helpers provided by kettle-test.

  • kettle-jem-template-20260729-005 - Gemspec metadata now publishes this
    project’s RubyForum tag as mailing_list_uri, and support docs link to the
    tagged RubyForum community alongside Discord.

Changed

  • kettle-jem-template-20260728-001 - Generated Ruby workflows now use clearer
    setup-ruby-flash planning and can prepare appraisal-only jobs without
    installing the main Gemfile bundle.

Fixed

  • Root release bundles now include ActiveRecord test support and load
    kettle/test/rspec, so kettle-changelog can generate coverage during
    release.

  • kettle-jem-template-20260726-002 - Generated version files now document their
    version namespace and constants, reducing warning-only YARD lint output.

  • kettle-jem-template-20260726-003 - Coverage upload steps now treat Coveralls,
    QLTY, and Codecov as optional, so provider outages do not fail CI when local
    coverage thresholds still pass.
  • kettle-jem-template-20260728-002 - Generated RuboCop configs now ignore the
    same gemfiles/vendor/bundle tree as .gitignore, so vendored dependency
    installs are not reported as project lint debt.

  • kettle-jem-template-20260728-003 - Generated dep-heads workflows now run
    TruffleRuby jobs with current RubyGems and Bundler, avoiding setup failures
    before the test suite starts.

  • kettle-jem-template-20260728-004 - Generated dep-heads workflows now use the
    setup-ruby Bundler install path for direct appraisal Gemfiles, avoiding rv
    lockfile parser failures on Git and path dependencies.

  • kettle-jem-template-20260728-005 - VersionGem bootstrap now creates the
    missing canonical version spec when a project only has shim namespace version
    specs.

  • kettle-jem-template-20260729-001 - Generated JRuby 9.4 workflows now use the
    legacy manual bundle install path, avoiding setup-time Bundler full-index
    failures against gem.coop.

  • kettle-jem-template-20260729-002 - VersionGem bootstrap now preserves
    and templates dedicated version_gem.rb entrypoints even when the gemspec
    dependency is intentionally omitted, and generated anonymous-loader specs
    cover both version.rb and version_gem.rb.

  • kettle-jem-template-20260729-003 - Old-Ruby gems below the VersionGem runtime
    floor now get managed minimal version.rb files and anonymous-loader version
    specs without adding version_gem.
  • kettle-jem-template-20260730-001 - Gemspec package file enumeration now runs
    relative to the gemspec directory, so packaged template assets are included
    even when the gemspec is loaded from another working directory.

1.0.4 - 2026-07-25

  • TAG: v1.0.4
  • COVERAGE: 90.75% – 412/454 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 27.78% documented

Changed

  • kettle-jem-template-20260716-001 - Shim gemspec manifests now include
    LICENSE.md instead of nonexistent LICENSE.txt.
  • kettle-jem-template-20260716-002 - Generated gemspec manifests now ship fewer
    repository-only files by default to reduce downstream distro packaging churn.
  • kettle-jem-template-20260720-001 - Generated READMEs can now render
    template-managed corporate sponsor logos from project or family config.
  • kettle-jem-template-20260720-002 - Generated development Gemfiles now use the
    released tree_sitter_language_pack gem 1.13.3 or newer by default.
  • kettle-jem-template-20260720-003 - Generated StructuredMerge Git diff driver
    config now uses the installed smorg-rb Ruby driver name.
  • kettle-jem-template-20260720-004 - Generated multi-engine workflow files now
    omit JRuby and TruffleRuby jobs when project config declares MRI-only engines.
  • kettle-jem-template-20260720-005 - Generated README Support & Community rows
    now include a RubyForum help badge.

  • kettle-jem-template-20260725-001 - Generated JRuby and TruffleRuby workflow
    files now run when pull request head branches start with feature/release,
    so release CI monitoring does not report intentionally skipped engine
    workflows as failures.

  • kettle-jem-template-20260725-002 - Generated gemspec templates now include
    anonymous_loader as a development dependency, and version specs use it to
    execute generated version.rb files for coverage without redefining package
    constants. Managed version specs are removed when version_gem is disabled
    or incompatible with the project’s runtime Ruby floor.

Removed

  • Removed the stale RVM-based bin/test.bash helper.

Fixed

  • Root development bundle now includes the ActiveRecord test harness fragments,
    so bundle exec kettle-test can load the suite outside appraisal-specific
    Gemfiles.

1.0.3 - 2026-07-02

  • TAG: v1.0.3
  • COVERAGE: 90.75% – 412/454 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 27.78% documented

Added

  • Added support for JRuby 10.1 and TruffleRuby 34.0.

Changed

  • Retemplated project metadata and CI/development automation with kettle-jem v7.0.0.

Fixed

  • Restore root Gemfile ActiveRecord test dependencies so kettle-test runs the
    RSpec suite outside appraisal-specific bundles.
  • Restore kettle-soup-cover SimpleCov startup so kettle-test reports merged
    line and branch coverage from turbo_tests2 workers.
  • Package configured license files in gem release file lists.

1.0.2 - 2026-06-14

  • TAG: v1.0.2
  • COVERAGE: 90.75% – 412/454 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 27.78% documented

Changed

  • Refreshed generated README/package metadata, copyright notices, template
    helper files, documentation custom-domain metadata, CI workflow pins, and
    development dependency floors from the latest kettle-jem template.

1.0.1 - 2026-06-05

  • TAG: v1.0.1
  • COVERAGE: 90.95% – 412/453 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 27.78% documented

Fixed

  • Fixed generated documentation URLs that incorrectly pointed at a monorepo
    gems/flag_shih_tzu path.

Changed

  • Raised generated version_gem and appraisal2 dependency floors to
    version_gem >= 1.1.10 and appraisal2 >= 3.0.9.

  • Refreshed generated project metadata, support documentation, CI workflows,
    and development dependency floors from the current kettle-jem template.

  • Updated the README synopsis to call out v1.0 multi-bit field support.

Removed

  • Removed the legacy Test::Unit suite now that its coverage is represented by
    the RSpec suite.
  • Removed obsolete direct development dependencies on bundler, rspec,
    rspec_junit_formatter, test-unit, and wwtd.

1.0.0 - 2026-05-26

  • TAG: v1.0.0
  • COVERAGE: 90.95% – 412/453 lines in 3 files
  • BRANCH COVERAGE: 76.76% – 142/185 branches in 3 files
  • 27.78% documented

Added

  • Added table_alias: support to generated not_<flag>_condition SQL helper
    methods, matching the existing alias support for positive flag conditions.
  • Added documentation for safely deprecating or removing flags without
    corrupting the meaning of existing bit values.
  • Added flags_as_attributes, attributes_with_flags, and generated
    <column>_as_attributes helpers for reading flag bits as boolean attributes.
  • Added first-class project metadata, documentation links, funding links, and
    gem signing metadata to the gemspec.
  • Added array and hash assignment support to flag column writers, so calls like
    record.update!(flags: [:warpdrive, :shields]) can set multiple flags
    without magic bit-field integers.
  • Added value_mode:, bit_width:, and encoder: options to has_flags,
    including built-in value_mode: :tri_state storage for flags that can be
    true, false, or nil. This feature was inspired by PR #56 from Shivang
    Yadav.
  • Added the :allow_overwrite option to has_flags for callers that
    intentionally want generated flag methods to replace existing instance
    methods.

Changed

  • BREAKING: Changed the default flag_query_mode from :in_list to
    :bit_operator so generated flag SQL remains correct during rolling deploys
    that add and set new flags. Applications that need the legacy query shape can
    set FlagShihTzu.default_flag_query_mode = :in_list or pass
    flag_query_mode: :in_list to has_flags.
  • BREAKING: Changed flag column validation from opt-out to opt-in at model
    load time. has_flags no longer checks the database by default, avoiding
    failures and warnings during setup, migration, seed, asset, and test boot
    tasks. Applications that want the legacy guardrail can set
    FlagShihTzu.default_check_for_column = true or pass
    check_for_column: true to has_flags.
  • BREAKING: Changed custom FlagShihTzu error classes to inherit from
    StandardError instead of Exception, so normal rescue blocks can handle
    them.
  • BREAKING: Changed flag column writers to interpret Array values as the
    complete selected flag set and Hash values as partial boolean flag updates.
    Raw integer assignment remains supported.
  • Updated project ownership and documentation links from pboling to
    galtzo-floss.
  • Raised the effective minimum installable Ruby version to Ruby 2.2 through
    the new version_gem runtime dependency.
  • Expanded the maintained compatibility matrix to cover modern Ruby,
    JRuby, TruffleRuby, and ActiveRecord releases through ActiveRecord 8.0.
  • Modernized validates_presence_of_flags integration for current
    ActiveModel error APIs.

Removed

  • Removed the obsolete Travis CI setup and legacy appraisal files for
    ActiveRecord 2.3 through 5.1.
  • Removed Ruby 2.3 and JRuby 9.1 from the tested release matrix.

Fixed

  • Restored project-specific README sections lost during templating, including
    the Alternatives section and the updated RailsBling URL from PR #104.
  • Avoided checking out an Active Record connection while quoting generated flag
    SQL identifiers.
  • Avoided repeated method redefinition warnings when flags are declared across
    multiple columns.
  • Fixed generated negative readers for flag names that are Ruby keywords, such
    as :end.
  • Normalized generated SQL condition behavior across supported ActiveRecord
    versions, including ActiveRecord 6.0 where-clause AST differences.

Security

Version 0.3.23 - NOV.30.2018

  • Avoid establishing a database connection unless necessary by Jonathan del Strother

Version 0.3.22 - SEP.18.2018

  • When #selected_flags= passed with nil it clears flag bits, by xpol
    • This makes flag_shih_tzu behave like Rails: converts empty array to nil.

Version 0.3.21 - SEP.09.2018

  • Make required minimum Ruby version explicit: 1.9.3 and up by Peter Boling
  • Support Rails 5.2 by Peter Boling
  • Add Ruby 2.5 to build, and update/fix build by Peter Boling

Version 0.3.20 - SEP.08.2018

  • Fix generated instance methods. by xpol
  • Support Rails 5.1 saved_change by shiro16

Version 0.3.19 - MAY.15.2017

  • Fixed a bug in Rails 5 support.
  • Added Rails 5.1 to travis.

Version 0.3.18 - APR.30.2017

  • Switched from Fixnum to Integer for Ruby 2.4 happiness
  • Fixed build for all supported Ruby and Rails versions in supported matrix

Version 0.3.17 - APR.29.2017

  • Improved compatibility with Rails 5.0
  • Fixed warnings about Fixnums
  • Fixed compatibility with SQLlite
  • Added Ruby 2.3, and 2.4 to the Travis Matrix
  • Removed JRuby 1.7 from the Travis Matrix

Version 0.3.16 - JAN.16.2017

  • Fix complex custom sql queries with multiple references to the column by vegetaras
  • Improved documentation and compatibility matrix by Peter Boling

Version 0.3.15 - OCT.11.2015

  • Fixed testing for all supported environments by Peter Boling
  • Testing on Travis: added Ruby jruby-9.0.1.0 by Peter Boling
  • Documented compatibility matrix in table in README by Peter Boling

Version 0.3.14 - OCT.08.2015

  • Allow use without ActiveRecord (experimental) by jfcaiceo
  • Many net-zero code cleanups to follow Ruby Style Guide
  • Improved local testing script rake test:all
  • Testing on Travis: added Ruby 1.9.3, 2.1.5, 2.2.3, jruby-1.7.0
  • Testing on Travis: removed Ruby 2.1.2

Version 0.3.13 - MAR.13.2015

  • methods for use with form builders like simple_form by Peter Boling

    • chained_flags_with_signature
    • chained_#{colmn}_with_signature
    • as_flag_collection
    • as_#{colmn.singularize}_collection
    • selected_flags=
    • selected_#{colmn}= (already existed)
  • Testing on Travis: added Ruby 2.2.1
  • Testing on Travis: removed Ruby 1.9.2

Version 0.3.12 - OCT.01.2014

  • Improve testing instructions in readme by Peter Boling
  • fix check_flag_column to return false after warn by Peter Boling
  • bash script for running complete test suite on Ruby 1.9.3 and Ruby 2.1.2 by Peter Boling
  • Improve documentation in readme by trliner
  • use aliases to make attribute reader methods more DRY by trliner
  • add negative attribute reader and writer methods for improved interoperability with simple_form and formtastic by trliner
  • Adds specs for ActiveRecord version 4.1 by Peter Boling
  • Use Kernel#warn instead of puts by Peter Boling

Version 0.3.11 - JUL.09.2014

  • Rename some ambigously-named methods mixed into AR::Base by jdelStrother
  • Add dynamic “.*_values_for” helpers by atipugin

Version 0.3.10 - NOV.26.2013

  • Can run tests without coverage by specifying NOCOVER=true by Peter Boling
  • Improved test coverage by Peter Boling
  • Improved documentation by Peter Boling
  • Readme converted to Markdown by Peter Boling

Version 0.3.9 - NOV.25.2013

  • Removed runtime dependency on active record and active support by Peter Boling
  • Fixed Coveralls Configuration by Peter Boling
  • Improved Readme by Peter Boling

Version 0.3.8 - NOV.24.2013

  • Improved Readme / Documentation by Peter Boling
  • Added Badges by Peter Boling
  • Configured Coveralls by Peter Boling
  • Added Code Climate, Coveralls, Gemnasium, and Version Badges by Peter Boling

Version 0.3.7 - OCT.25.2013

  • Change sql_in_for_flag to consider values from the range [0, 2 * max - 1] by Blake Thomson

Version 0.3.6 - AUG.29.2013

  • Allow use with any gem manager by Peter Boling
  • No need to alter Ruby’s load path by Peter Boling

Version 0.3.5 - AUG.06.2013

  • Fix Travis Build & Add Rails 4 by Peter M. Goldstein
  • Implemented update_flag! by Peter Boling (see https://github.com/pboling/flag_shih_tzu/issues/27)
    • sets a flag on a record without triggering callbacks or validations
    • optionally syncs the instance with new flag value, by default it does not.
  • Update gemspec by Peter Boling

Version 0.3.4 - JUN.20.2013

  • Allow non sequential flag numbers by Thomas Jachmann
  • Report correct source location for class_evaled methods. by Sebastian Korfmann
  • Implemented chained_flags_with, which allows optimizing the bit search by Tatsuhiko Miyagawa
  • [bugfix] flag_options[colmn][:column] is symbol, it causes error undefined method `length’ for nil:NilClass by Artem Pisarev
  • Validator raises an error if the validated column is not a flags column. by David DIDIER
  • Allow multiple include by Peter Goldstein
  • fix a deprecation warning in rails4 by Mose
  • Add flag_keys convenience method. by Keith Pitty
  • [bugfix] Column names provided as symbols fully work now, as they are converted to strings by Peter Boling
  • [bugfix issues/28] Since 0.3.0 flags no longer work in a class using an alternative database connection by Peter Boling
  • [bugfix issues/7] Breaks db:create rake task by Peter Boling
  • convenience methods now have default parameter so all_flags works with arity 0. by Peter Boling
  • Many more tests, including arity tests by Peter Boling

Version 0.3.3 - JUN.20.2013

  • Does not exist.

Version 0.3.2 - NOV.06.2012

  • Adds skip column check option :check_for_column - from arturaz
  • Adds a ‘smart’ set_flag_sql method which will auto determine the correct column for the given flag - from arturaz
  • Changes the behavior of sql_set_for_flag to not use table names in the generated SQL
    • because it didn’t actually work before
    • Now there is a test ensuring that the generated SQL can be executed by a real DB
    • This improved sql_set_for_flag underlies the public set_flag_sql method

Version 0.3.1 - NOV.06.2012

  • Adds new methods (for a flag column named ‘bar’, with many individual flags within) - from ddidier
    • all_bar, selected_bar, select_all_bar, unselect_all_bar, selected_bar=(selected_flags), has_bar?

Version 0.3.0 - NOV.05.2012 - first version maintained by Peter Boling

  • ClassWithHasFlags.set_#{flag_name}_sql # Returns the sql string for setting a flag for use in customized SQL
  • ClassWithHasFlags.unset_#{flag_name}_sql # Returns the sql string for unsetting a flag for use in customized SQL
  • ClassWithHasFlags.flag_columns # Returns the column_names used by FlagShihTzu as bit fields
  • has_flags :strict => true # DuplicateFlagColumnException raised when a single DB column is declared as a flag column twice
  • Less verbosity for expected conditions when the DB connection for the class is unavailable.
  • Tests for additional features, but does not change any behavior of 0.2.3 / 0.2.4 by default.
  • Easily migrate from 0.2.3 and 0.2.4. Goal is no code changes required. Minor version bump to encourage caution.

Version 0.2.4 - NOV.05.2012 - released last few changes from XING master

  • Fix deprecation warning for set_table_name
  • Optional bang methods
  • Complete Ruby 1.9(.[^1]) and Rails 3.2.X compatibility

Version 0.2.3 - last version maintained by XING AG