concerns_on_rails 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743380a3be200eda289e97edef227f8b900550ba08af52c4a06b995fc5c8297a
-  data.tar.gz: 7e8e8cb4bfd923819ec96178d75e68378829fb0f80b5a2e3cf3cd84e150fcc32
+  metadata.gz: a34c6e186b582806890012bb0f8bf049c1fd0f56f74007af7669cdb5ae713eb2
+  data.tar.gz: 298f957409be23ecfd9bbd0de46161ac56af7a01a6a300d29cf3bff9ca2b94d3
 SHA512:
-  metadata.gz: 48e77b0bb95ee7419207289be7e1f74166f43aa4e31f4af6a6269ac2a84ccb90ac38e81a2a11a44cdafb7bd678d48153070c41d502b37f0a6baeabfd114f73f0
-  data.tar.gz: bb03d4bcfb6b26b7963f70cdaee8e591293fc8f96e34aa636aab84df6ce20647ae9df01e3d52554c8b6a9cb52cfce68c2da2c0f967ede2a3ec7960be737f4bd2
+  metadata.gz: 6a96e094791d487cd9a534e4263de4bd902af9b533a8607ceb20906d4b38827c82ee0b370cb885d8a5800aef8a03a9b84cc718dc00074da1c0b1f35ade4fc2b3
+  data.tar.gz: e803d31da5694c6ad1a0ea28d928f9d552e75ded84420aa94cb816538e4cbe9b4a228f2b9dfa9428a8091b369444909d750523d2c5a0e9edae1f2df6fec95a78

data/README.md

@@ -2,7 +2,7 @@
 
 > 🇻🇳 **Hoàng Sa and Trường Sa belong to Việt Nam.**
 
-A plug-and-play collection of reusable ActiveSupport concerns for Rails **models** and **controllers** — slugs, soft delete, scheduled publish, expiry, pagination, filtering, JSON envelopes, and more. One `include`, one declarative macro, done.
+A plug-and-play collection of reusable ActiveSupport concerns for Rails **models** and **controllers** — slugs, soft delete, scheduled publish, expiry, sequential reference numbers, pagination, filtering, JSON envelopes, and more. One `include`, one declarative macro, done.
 
 ```ruby
 class Article < ApplicationRecord
@@ -36,6 +36,7 @@ Article.published.without_deleted.find("hello-world")
   - [Searchable](#-searchable) — LIKE/ILIKE search across configured columns
   - [Activatable](#-activatable) — boolean active/inactive toggle
   - [Tokenizable](#-tokenizable) — security tokens with timing-safe lookup
+  - [Sequenceable](#-sequenceable) — ordered, human-friendly reference numbers
   - [Stateable](#-stateable) — lightweight string-backed state machine
   - [Addressable](#-addressable) — postal address normalization + format validation
 - **Controller concerns**
@@ -54,7 +55,7 @@ Article.published.without_deleted.find("hello-world")
 
 ## ✨ Why this gem?
 
-- **Thirteen model concerns + six controller concerns**, all production-ready
+- **Fourteen model concerns + six controller concerns**, all production-ready
 - **One include, one macro** — no boilerplate, no glue code
 - **Lean dependencies** — only `acts_as_list` (Sortable) and `friendly_id` (Sluggable); controller concerns have zero extra deps
 - **Schema-validated configuration** — every macro checks that the configured column exists and raises `ArgumentError` early
@@ -67,7 +68,7 @@ Article.published.without_deleted.find("hello-world")
 Add to your application's `Gemfile`:
 
 ```ruby
-gem "concerns_on_rails", "~> 1.9"
+gem "concerns_on_rails", "~> 1.11"
 ```
 
 Or pull the latest from GitHub:
@@ -578,6 +579,70 @@ User.authenticate_by_api_token(token)     # timing-safe; returns user or nil
 
 ---
 
+## 🧾 Sequenceable
+
+Ordered, human-friendly reference numbers — invoice numbers, order numbers, ticket IDs, support cases. Unlike the *random* identifiers from [Hashable](#-hashable) / [Tokenizable](#-tokenizable), `Sequenceable` produces *sequential* ones backed by an integer column that is the source of truth.
+
+```ruby
+class Invoice < ApplicationRecord
+  include ConcernsOnRails::Sequenceable
+
+  sequenceable_by :sequence,        # integer column — the source of truth
+    into:    :number,               # optional string column for the formatted value
+    prefix:  "INV-",
+    padding: 5,
+    scope:   :account_id,           # one independent counter per account
+    reset:   :year                  # restart numbering each calendar year
+end
+
+invoice = Invoice.create!(account_id: 1)
+invoice.sequence            # => 1, 2, 3 ... (per account, per year)
+invoice.number              # => "INV-2026-00001"
+invoice.formatted_sequence  # => "INV-2026-00001"
+
+Invoice.next_sequence(account_id: 1)   # => 4  (peek the next value, without creating)
+```
+
+**Options**
+
+| Option               | Default     | Purpose                                                                                  |
+|----------------------|-------------|------------------------------------------------------------------------------------------|
+| `field` (positional) | `:sequence` | Integer column holding the sequence — the source of truth.                               |
+| `into:`              | `nil`       | String column to persist the formatted reference into (immutable display value).          |
+| `prefix:`            | `""`        | Prepended to the formatted value.                                                        |
+| `padding:`           | `0`         | Zero-pad width of the numeric portion (`0` = no padding).                                |
+| `separator:`         | `"-"`       | Joins prefix / period token / number in the default format.                              |
+| `start_at:`          | `1`         | First value when the scope/period has no rows yet.                                       |
+| `scope:`             | `nil`       | Column (or array of columns) the counter is scoped to — e.g. one sequence per `account_id`. |
+| `reset:`             | `:never`    | `:never` / `:year` / `:month` / `:day` — restart numbering each period (needs `created_at`). |
+| `template:`          | `nil`       | `->(seq, record) { ... }` full custom formatter; overrides `prefix` / `padding` / period. |
+
+**Default format**
+
+| `reset:`  | Example               | Shape                            |
+|-----------|-----------------------|----------------------------------|
+| `:never`  | `INV-00001`           | `prefix + padded`                |
+| `:year`   | `INV-2026-00001`      | `prefix + YYYY + sep + padded`   |
+| `:month`  | `INV-202606-00001`    | `prefix + YYYYMM + sep + padded` |
+| `:day`    | `INV-20260604-00001`  | `prefix + YYYYMMDD + sep + padded` |
+
+**Generated API**
+
+| Method                            | What it does                                                                          |
+|-----------------------------------|---------------------------------------------------------------------------------------|
+| `formatted_<field>`               | The formatted string — the persisted `into:` value when set, otherwise computed.      |
+| `Model.next_<field>(scope_attrs)` | Peek the next integer for a scope without creating a record.                           |
+
+**Notes**
+- The next value is `MAX(<field>) + 1` within the scope (and period), so numbering is dense and ordered — not random.
+- Caller-supplied values are respected: `Invoice.create!(sequence: 100)` is not overwritten (and its `into:` string is still formatted from `100`).
+- Generation reads `MAX` then inserts, so two concurrent inserts can race. It's **best-effort** — add a **scoped unique index** on `<field>` (and on `into:`) for a real guarantee, the same way you would for any `MAX`-based numbering.
+- `reset:` requires a `created_at` column; the period is taken from each row's creation time.
+- For fixed-width display (`00042`), make the `into:` column a **string** — integer columns drop leading zeros.
+- Distinct from `Hashable` / `Tokenizable`, which generate *random* values; reach for those when the identifier must be unguessable.
+
+---
+
 ## 🔄 Stateable
 
 Lightweight string-backed state machine — the 80% of AASM without the dependency.
@@ -956,7 +1021,7 @@ Both forms reference the same module, so you can freely mix them.
 bundle install                                  # install dev dependencies
 bundle exec rspec                               # run the test suite
 gem build concerns_on_rails.gemspec             # build the gem
-gem install ./concerns_on_rails-1.9.0.gem       # install locally
+gem install ./concerns_on_rails-1.11.0.gem      # install locally
 ```
 
 The test suite uses an in-memory SQLite database and a lightweight `FakeController` harness for controller-concern specs — no Rails routes or boot required.

data/lib/concerns_on_rails/legacy_aliases.rb

@@ -15,4 +15,5 @@ module ConcernsOnRails
   Tokenizable   = Models::Tokenizable
   Stateable     = Models::Stateable
   Addressable   = Models::Addressable
+  Sequenceable  = Models::Sequenceable
 end

data/lib/concerns_on_rails/models/sequenceable.rb

@@ -0,0 +1,135 @@
+require "active_support/concern"
+
+module ConcernsOnRails
+  module Models
+    # Generates ordered, human-friendly sequential reference numbers — invoice
+    # numbers, order numbers, ticket numbers, support cases. Unlike Hashable /
+    # Tokenizable (which produce *random* identifiers), Sequenceable produces
+    # *ordered* ones backed by an integer column that is the source of truth.
+    #
+    #   class Invoice < ApplicationRecord
+    #     include ConcernsOnRails::Sequenceable
+    #
+    #     sequenceable_by :sequence,        # integer column — source of truth
+    #       into:    :number,               # optional string column for the formatted value
+    #       prefix:  "INV-",
+    #       padding: 5,
+    #       scope:   :account_id,           # one counter per account
+    #       reset:   :year                  # restart numbering each calendar year
+    #   end
+    #
+    #   invoice = Invoice.create!(account_id: 1)
+    #   invoice.sequence            # => 1, 2, 3 ... (per account, per year)
+    #   invoice.number              # => "INV-2026-00001"
+    #   invoice.formatted_sequence  # => "INV-2026-00001"
+    #   Invoice.next_sequence(account_id: 1)  # peek the next value without creating
+    #
+    # The integer is computed as MAX(field) within the scope (+ period) + 1, so
+    # numbering is dense and ordered. Generation is best-effort under concurrency
+    # — pair the column(s) with a scoped unique DB index for a real guarantee.
+    module Sequenceable
+      extend ActiveSupport::Concern
+
+      RESET_PERIODS = %i[never year month day].freeze
+      MAX_GENERATION_ATTEMPTS = 10
+      NAME = "ConcernsOnRails::Models::Sequenceable".freeze
+
+      included do
+        class_attribute :sequenceable_config, instance_accessor: false, default: {}
+      end
+
+      class_methods do
+        include ConcernsOnRails::Support::ColumnGuard
+        include ConcernsOnRails::Support::SequenceCalculator
+
+        # Configure a sequenceable field.
+        #
+        # Options:
+        #   into:      string column to persist the formatted value into (default nil)
+        #   prefix:    string prepended to the formatted value (default "")
+        #   padding:   zero-pad width of the numeric portion (default 0 = no padding)
+        #   separator: joins prefix / period token / number in the default format (default "-")
+        #   start_at:  first value per scope/period when no rows exist yet (default 1)
+        #   scope:     column or array of columns the counter is scoped to (default nil)
+        #   reset:     :never (default) | :year | :month | :day — restart per period (needs created_at)
+        #   template:  ->(seq, record) { ... } full custom formatter; overrides prefix/padding/period
+        def sequenceable_by(field = :sequence, into: nil, prefix: "", padding: 0,
+                            separator: "-", start_at: 1, scope: nil, reset: :never, template: nil)
+          field      = field.to_sym
+          into       = into&.to_sym
+          reset      = reset.to_sym
+          scope_cols = Array(scope).map(&:to_sym)
+
+          ensure_columns!(NAME, field)
+          ensure_columns!(NAME, into) if into
+          ensure_columns!(NAME, *scope_cols) unless scope_cols.empty?
+          ensure_columns!(NAME, :created_at) unless reset == :never
+          validate_sequenceable_options!(reset, template)
+
+          self.sequenceable_config = sequenceable_config.merge(
+            field => { into: into, prefix: prefix.to_s, padding: padding.to_i,
+                       separator: separator.to_s, start_at: start_at.to_i,
+                       scope: scope_cols, reset: reset, template: template }
+          )
+
+          before_create -> { assign_sequenceable_value(field) }
+          define_sequenceable_methods(field)
+        end
+      end
+
+      class_methods do
+        private
+
+        def define_sequenceable_methods(field)
+          define_method("formatted_#{field}") do
+            cfg = self.class.sequenceable_config.fetch(field)
+            return self[cfg[:into]] if cfg[:into] && self[cfg[:into]].present?
+            return nil if self[field].blank?
+
+            self.class.send(:format_sequence, field, self[field], self)
+          end
+
+          define_singleton_method("next_#{field}") do |scope_attrs = {}|
+            sequence_base_value(field, nil, scope_attrs)
+          end
+        end
+
+        def validate_sequenceable_options!(reset, template)
+          unless RESET_PERIODS.include?(reset)
+            raise ArgumentError, "#{NAME}: unknown reset '#{reset}'. Valid values: #{RESET_PERIODS.join(', ')}"
+          end
+
+          return if template.nil? || template.respond_to?(:call)
+
+          raise ArgumentError, "#{NAME}: template must be callable (respond to #call)"
+        end
+      end
+
+      # Assigns the sequence (and, when configured, the formatted string) only when
+      # the integer column is blank, so callers can pass an explicit value. The
+      # increment-until-free loop is a best-effort guard against pre-taken values;
+      # a scoped unique index is the real concurrency guarantee.
+      def assign_sequenceable_value(field)
+        cfg = self.class.sequenceable_config.fetch(field)
+
+        if self[field].blank?
+          candidate = self.class.send(:sequence_base_value, field, self, {})
+          attempts = 0
+          while self.class.send(:sequence_value_taken?, field, candidate, self, {})
+            attempts += 1
+            if attempts >= MAX_GENERATION_ATTEMPTS
+              raise "#{NAME}: could not find a free value for '#{field}' after " \
+                    "#{MAX_GENERATION_ATTEMPTS} attempts — add a scoped unique index"
+            end
+            candidate += 1
+          end
+          self[field] = candidate
+        end
+
+        return unless cfg[:into] && self[cfg[:into]].blank?
+
+        self[cfg[:into]] = self.class.send(:format_sequence, field, self[field], self)
+      end
+    end
+  end
+end

data/lib/concerns_on_rails/support/sequence_calculator.rb

@@ -0,0 +1,74 @@
+module ConcernsOnRails
+  module Support
+    # Internal helpers for Models::Sequenceable: computing the next value within a
+    # scope (+ period) and formatting it. Mixed into the model's class methods, so
+    # `self` is the model class and `unscoped` / `sequenceable_config` resolve
+    # against it. Kept here to keep the concern itself focused on configuration.
+    module SequenceCalculator
+      private
+
+      # Next integer that would be assigned for the given scope: MAX within the
+      # scope (+ period) + 1, or start_at when the scope/period is still empty.
+      def sequence_base_value(field, record, scope_attrs)
+        cfg = sequenceable_config.fetch(field)
+        max = sequence_relation(field, record, scope_attrs).maximum(field)
+        max ? max + 1 : cfg[:start_at]
+      end
+
+      def sequence_value_taken?(field, candidate, record, scope_attrs)
+        sequence_relation(field, record, scope_attrs).exists?(field => candidate)
+      end
+
+      # Relation of existing rows that share this record's scope (and period, when
+      # reset is enabled). Reads from `unscoped` so a model's default_scope never
+      # hides rows the counter must account for.
+      def sequence_relation(field, record, scope_attrs)
+        cfg = sequenceable_config.fetch(field)
+        rel = unscoped
+
+        cfg[:scope].each do |col|
+          value = record ? record[col] : (scope_attrs[col] || scope_attrs[col.to_s])
+          rel = rel.where(col => value)
+        end
+
+        return rel if cfg[:reset] == :never
+
+        rel.where(created_at: period_range(cfg[:reset], base_time(record)))
+      end
+
+      def format_sequence(field, seq, record)
+        cfg = sequenceable_config.fetch(field)
+        return cfg[:template].call(seq, record) if cfg[:template]
+
+        padded = cfg[:padding].positive? ? seq.to_s.rjust(cfg[:padding], "0") : seq.to_s
+        return "#{cfg[:prefix]}#{padded}" if cfg[:reset] == :never
+
+        token = period_token(cfg[:reset], base_time(record))
+        "#{cfg[:prefix]}#{token}#{cfg[:separator]}#{padded}"
+      end
+
+      def period_range(reset, time)
+        case reset
+        when :year  then time.beginning_of_year..time.end_of_year
+        when :month then time.beginning_of_month..time.end_of_month
+        when :day   then time.beginning_of_day..time.end_of_day
+        end
+      end
+
+      def period_token(reset, time)
+        case reset
+        when :year  then time.year.to_s
+        when :month then time.strftime("%Y%m")
+        when :day   then time.strftime("%Y%m%d")
+        end
+      end
+
+      # created_at is the natural anchor for the period, but it may not be set yet
+      # during before_create — fall back to the current time, which is what the
+      # timestamp will resolve to anyway.
+      def base_time(record)
+        record&.created_at || Time.current
+      end
+    end
+  end
+end

data/lib/concerns_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ConcernsOnRails
-  VERSION = "1.10.0".freeze
+  VERSION = "1.11.0".freeze
 end

data/lib/concerns_on_rails.rb

@@ -11,6 +11,7 @@ end
 require "concerns_on_rails/support/column_guard"
 require "concerns_on_rails/support/random_value"
 require "concerns_on_rails/support/address_data"
+require "concerns_on_rails/support/sequence_calculator"
 
 # Model concerns
 require "concerns_on_rails/models/sluggable"
@@ -26,6 +27,7 @@ require "concerns_on_rails/models/activatable"
 require "concerns_on_rails/models/tokenizable"
 require "concerns_on_rails/models/stateable"
 require "concerns_on_rails/models/addressable"
+require "concerns_on_rails/models/sequenceable"
 
 # Controller concerns
 require "concerns_on_rails/controllers/paginatable"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concerns_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Ethan Nguyen
@@ -85,6 +85,7 @@ files:
 - lib/concerns_on_rails/models/publishable.rb
 - lib/concerns_on_rails/models/schedulable.rb
 - lib/concerns_on_rails/models/searchable.rb
+- lib/concerns_on_rails/models/sequenceable.rb
 - lib/concerns_on_rails/models/sluggable.rb
 - lib/concerns_on_rails/models/soft_deletable.rb
 - lib/concerns_on_rails/models/sortable.rb
@@ -93,6 +94,7 @@ files:
 - lib/concerns_on_rails/support/address_data.rb
 - lib/concerns_on_rails/support/column_guard.rb
 - lib/concerns_on_rails/support/random_value.rb
+- lib/concerns_on_rails/support/sequence_calculator.rb
 - lib/concerns_on_rails/version.rb
 homepage: https://github.com/VSN2015/concerns_on_rails
 licenses: