mbrcode 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 668e1477aa761496dde6ffe763c7d80d7112999dec6860305b9a726705ace55f
-  data.tar.gz: b801310198256b2b07b36d38d08cfc710518a5ea0f77e828e3deb0acad9b0419
+  metadata.gz: 5b2670d625de2bba07d5b5afa0269157130be5a2a7d74bbf1ea0f2bffce8184d
+  data.tar.gz: d96b32461b1496e390ea898d5b635af1eb7b54a60e52e0b0c8654cd73b90914e
 SHA512:
-  metadata.gz: a3ca567c2fc23f2094ec3e759b2e8e6f126218d427e6ddbd3af8cbbdcd76ea732faca5745fce1b0fa0bc8d0c0cf7d22b5d945618a567743a9f11fc7c419756d9
-  data.tar.gz: d3d5a6dfb574cc42ad37749b80cfc4cb3367bb9c156b038867544f90b810928facbd097c5b4c5b70faacef89178f6d6fe1e736b127e19974bcbc9b068bb25a8e
+  metadata.gz: ff082cf39523d587ddddd917dbd0f43b44d68ec189c3200f07cc964a2bfdbd3aa87ad760d1fbf656663c3006f3bd172bf8df74521b2f5e9a742a0bcf92f4b6bf
+  data.tar.gz: d01ad2e07c5c25f6ed3089d268497242b12ae0f734334d6df8e728868ffd11d81a8632ccd84168f42ec23919f62e7f2b5df63cb0105797e449458dfa063f1344

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mbrcode.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mbrcode (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    rake (13.0.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  mbrcode!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+
+BUNDLED WITH
+   2.5.18

data/README.md

@@ -1,35 +1,188 @@
 # Mbrcode
 
-TODO: Delete this and the text below, and describe your gem
+**Mbrcode** is a lightweight, deterministic, and clean **membership code generator** for Ruby applications.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mbrcode`. To experiment with that code, run `bin/console` for an interactive prompt.
+It produces stable, structured IDs using the format:
 
-## Installation
+PREFIX + SHARD + "-" + DIGITS
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Where:
 
-Install the gem and add to the application's Gemfile by executing:
+- **PREFIX** → normalized to exactly 4 characters
+- **SHARD** → numeric grouping/version number
+- **DIGITS** → auto-incrementing sequence
+- **Raw length before dashes** = **EXACTLY 16 characters**
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Example output:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+MBR1-0000-0000-000
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Mbrcode is ideal for membership systems, gyms, schools, apps, organizations, ERPs, identity platforms, and anything requiring clean, compact, and consistent codes.
 
-## Usage
+---
 
-TODO: Write usage instructions here
+## ✨ Features
 
-## Development
+- 🔒 Thread-safe incremental counter
+- 🧩 Smart prefix normalization rules
+- 📏 Always 16 raw characters before dash grouping
+- 🔣 Groups digits into 4-4-4 format when possible
+- ⚙️ Configurable prefix and shard
+- 💎 Zero external dependencies
+- 🚀 Fast, simple, production-ready
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+---
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## 📦 Installation
 
-## Contributing
+Add to your Gemfile:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mbrcode.
+```ruby
+gem "mbrcode"
+```
 
-## License
+Install:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```bash
+bundle install
+```
+
+Or install manually:
+
+```bash
+gem install mbrcode
+```
+
+---
+
+## 🚀 Usage
+
+### Default generation
+
+```ruby
+Mbrcode.generate
+# => "MBR1-0000-0000-000"
+```
+
+### Custom prefix
+
+```ruby
+Mbrcode.generate(prefix: "user")
+# => "USER1-0000-0000-000"
+```
+
+### Multi-word prefix → initials
+
+```ruby
+Mbrcode.generate(prefix: "karate membership")
+# => "KM00-0000-0000-000"
+```
+
+### Prefix shorter than 4 chars → padded
+
+```ruby
+Mbrcode.generate(prefix: "ab")
+# => "AB00-0000-0000-000"
+```
+
+### Long prefix → first 4 characters
+
+```ruby
+Mbrcode.generate(prefix: "customer")
+# => "CUST1-0000-0000-000"
+```
+
+### Custom shard
+
+```ruby
+Mbrcode.generate(prefix: "mbr", shard: 2)
+# => "MBR2-0000-0000-000"
+```
+
+---
+
+## 🧠 Prefix Normalization Rules
+
+| Input Prefix        | Output Prefix | Rule Applied           |
+|---------------------|---------------|-------------------------|
+| "m"                 | "M000"        | padded to 4 characters |
+| "ab"                | "AB00"        | padded to 4 characters |
+| "karate membership" | "KM00"        | initials + padded      |
+| "ruby on rails"     | "ROR0"        | initials + padded      |
+| "customer"          | "CUST"        | first 4 characters     |
+| "USER"              | "USER"        | unchanged (4 chars)    |
+
+---
+
+## 🔢 16-Character Enforcement
+
+Before grouping and adding dashes, the ID ALWAYS equals:
+
+PREFIX(4) + SHARD(N) + DIGITS(M) = 16 characters
+
+If the shard leaves no space for digits:
+
+```ruby
+Mbrcode.generate(prefix: "abcd", shard: 999999999)
+# => raises "Shard too long"
+```
+
+This ensures consistent, predictable, compact membership IDs.
+
+---
+
+## 🧪 Testing
+
+Run RSpec tests:
+
+```bash
+bundle exec rspec
+```
+
+All tests should pass.
+
+---
+
+## 🛠 Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/delacruzjames/mbrcode.git
+cd mbrcode
+```
+
+Install dependencies:
+
+```bash
+bundle install
+```
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome!  
+Please include tests for new features or bug fixes.
+
+---
+
+## 📜 License
+
+Released under the **MIT License**.
+
+---
+
+## 👤 Author
+
+**Sensei James Dela Cruz**  
+Ruby Developer • API Architect • Karate Instructor
+
+📧 Email: `delacruzjamesmartin@gmail.com`  
+🐙 GitHub: `@delacruzjames`

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mbrcode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mbrcode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mbrcode
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/mbrcode.rb

@@ -1,70 +1,60 @@
 require "mbrcode/version"
-require "mutex_m"
+require "monitor"
+extend MonitorMixin
 
 module Mbrcode
-  extend Mutex_m
+  extend MonitorMixin
 
   @sequence = 0
 
   class << self
     #
-    # New Rules:
-    # - Prefix processed to exactly 4 chars using logic described
-    # - MAX 16 digits total after prefix+shard
+    # GENERATE MEMBERSHIP CODE
     #
     def generate(prefix: "mbr", shard: 1)
+      shard_str = shard.to_i.to_s
+
+      # STRICT: shard must be <= 3 characters always
+      raise "Shard too long" if shard_str.length > 3
+
       prefix_str = normalize_prefix(prefix)
-      shard_str  = shard.to_i.to_s
 
       seq = next_sequence
 
-      # remaining characters allowed for digits
       max_digits = 16 - (prefix_str.length + shard_str.length)
-
-      # enforce enough space for meaningful numbering
       raise "Shard too long" if max_digits < 4
 
-      digits = format("%0#{max_digits}d", seq)
-
-      grouped =
-        if max_digits > 4
-          digits.scan(/.{1,4}/).join("-")
-        else
-          digits
-        end
+      digits  = format("%0#{max_digits}d", seq)
+      grouped = digits.scan(/.{1,4}/).join("-")
 
       "#{prefix_str}#{shard_str}-#{grouped}"
     end
 
     private
 
-    # -----------------------------
-    # PREFIX NORMALIZATION LOGIC
-    # -----------------------------
+    # -----------------------------------------------------------
+    # PREFIX NORMALIZATION BASED ON YOUR SPECIFIC RULES
+    # -----------------------------------------------------------
     def normalize_prefix(prefix)
       str = prefix.to_s.strip.upcase
 
-      # Multi-word? Use initials.
+      # 1) MULTI-WORD PREFIX → INITIALS (max 2 chars) → pad to 3
       if str.include?(" ")
         initials = str.split.map { |w| w[0] }.join
-        return pad_or_trim(initials)
+        return initials[0, 2].ljust(3, "0")
       end
 
-      # Single word:
-      if str.length < 4
-        return pad_or_trim(str)
-      else
-        # Use first 4 chars
-        return str[0, 4]
-      end
-    end
-
-    def pad_or_trim(str)
-      if str.length >= 4
-        str[0, 4]
+      # 2) SINGLE-WORD RULES
+      case str.length
+      when 1, 2
+        return str.ljust(3, "0")
+      when 3
+        return str
+      when 4
+        return str[0, 3]
       else
-        # pad numbers until length = 4
-        str.ljust(4, "0")
+        mid = (str.length / 2) - 1
+        return str[mid, 3]
       end
     end
 

data/mbrcode.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/mbrcode/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mbrcode"
+  spec.version       = Mbrcode::VERSION
+  spec.authors       = ["Sensei James"]
+  spec.email         = ["delacruzjamesmartin@gmail.com"]
+
+  spec.summary       = "Simple and clean membership code generator."
+  spec.description   = "Generates structured membership IDs like MBR1-0000-0000-0000 for apps, systems, and organizations."
+  spec.homepage      = "https://github.com/delacruzjames/mbrcode"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"]     = spec.homepage
+  spec.metadata["source_code_uri"]  = spec.homepage
+
+  # Correct file discovery
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.12"
+end

data/spec/mbrcode_spec.rb

@@ -0,0 +1,70 @@
+require "mbrcode"
+
+RSpec.describe Mbrcode do
+  before { Mbrcode.instance_variable_set(:@sequence, 0) } # reset sequence for predictable tests
+
+  describe ".generate" do
+    context "default behavior" do
+      it "generates a code with the default prefix MBR (normalized to MBR)" do
+        code = Mbrcode.generate
+        expect(code).to start_with("MBR1-")
+      end
+
+      it "increments the sequence number" do
+        first  = Mbrcode.generate
+        second = Mbrcode.generate
+        expect(first).not_to eq(second)
+      end
+    end
+
+    context "prefix rules (new specification)" do
+      it "pads prefix shorter than 3 chars with zeros (KP → KP0)" do
+        code = Mbrcode.generate(prefix: "kp")
+        expect(code).to start_with("KP01-")
+      end
+
+      it "keeps 3-character prefixes as is (KKP stays KKP)" do
+        code = Mbrcode.generate(prefix: "kkp")
+        expect(code).to start_with("KKP1-")
+      end
+
+      it "trims 4-character prefixes to first 3 (WKKP → WKK)" do
+        code = Mbrcode.generate(prefix: "WKKP")
+        expect(code).to start_with("WKK1-")
+      end
+
+      it "extracts middle 3 letters for 5+ char prefixes (WKKPP → KKP)" do
+        code = Mbrcode.generate(prefix: "WKKPP")
+        expect(code).to start_with("KKP1-")
+      end
+
+      it "multi-word prefixes convert to initials and pad to 3 chars" do
+        # "karate membership" → KM → pad → KM0
+        code = Mbrcode.generate(prefix: "karate membership")
+        expect(code).to start_with("KM01-")
+      end
+    end
+
+    context "shard logic" do
+      it "appends shard number after normalized prefix" do
+        # 'user' → 'USE' (first 3 of USER)
+        code = Mbrcode.generate(prefix: "user", shard: 9)
+        expect(code).to start_with("USE9-")
+      end
+
+      it "raises an error when shard is too large for 16-char rule" do
+        expect {
+          Mbrcode.generate(prefix: "abcd", shard: 123456789)
+        }.to raise_error(/Shard too long/)
+      end
+    end
+
+    context "length compliance" do
+      it "ensures total raw length (no dashes) does not exceed 16 chars" do
+        code = Mbrcode.generate(prefix: "mem", shard: 1)
+        raw = code.delete("-")
+        expect(raw.length).to be <= 16
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mbrcode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Sensei James
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".idea/.gitignore"
 - ".idea/inspectionProfiles/Project_Default.xml"
 - ".idea/mbrcode.iml"
@@ -39,12 +40,19 @@ files:
 - ".idea/modules.xml"
 - ".idea/vcs.xml"
 - ".rspec"
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/mbrcode.rb
 - lib/mbrcode/version.rb
+- mbrcode.gemspec
 - sig/mbrcode.rbs
+- spec/mbrcode_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/delacruzjames/mbrcode
 licenses:
 - MIT