midwire_common 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4677c1584c5c35e20addcfa6e40dc60919b1813b
-  data.tar.gz: 6f16246a5e91000ba332144220458ce99e19c3a2
+SHA256:
+  metadata.gz: 0ec5ad4761d6f6a14b441e63ff1a18b1be5c2900b8c9302404b3321944953321
+  data.tar.gz: 42ac62ab72e3c3c78fcecbcf6da3f869f83e498766a907995bb43e78cdbdc79e
 SHA512:
-  metadata.gz: f8a4e99cb0a6f1d9619ea07f17c55f11ee33f09d5c275258454575d6dd6e38817463fd0e74702b523e33d968cbb7e63b5b18d3684de520714a84ba15ec012757
-  data.tar.gz: c4c0cd3bd83b2663901853a409251315f1e72420598ff2b4fbf5a0aae3bb7bab04e672594d33f56e9cbd9b1bebf3d21f65c4d578c40325a57b9b6252c1ef7e49
+  metadata.gz: 7dd67a8fee94b821bb360f3f19c2ab0af90665105abef667df040de666c50543e69619cff1d5af0f4c7759914c498aa8cd8841fbe22fd3d7b520e1ec6fe50df4
+  data.tar.gz: c8c5247f62f5fbed75400704646d0203220f6dc526bcaf6c7bbe607fd41cbf714d1e605124ba1f42e04a3641b3424857727c14f9178cb587763ae30ed9b91302

data/.github/mergeable.yml

@@ -0,0 +1,43 @@
+version: 2
+mergeable:
+  - when: pull_request.*, pull_request_review.*
+    validate:
+      - do: title
+        # Enforce semantic release convention.
+        must_include:
+          regex: ^(feat|docs|chore|fix|refactor|test|style|perf)(\(\w+\))?:.+$
+          message: Semantic release conventions must be followed.
+        # All todo check boxes must be checked.
+      - do: description
+        must_exclude:
+          regex: \[ \]
+          message: There are incomplete TODO task(s) unchecked.
+      - do: approvals
+        min:
+          count: 1
+        or:
+          - required:
+              reviewers: [ jusx ]
+          - required:
+              reviewers: [ shine2lay ]
+      - do: or
+        # if the PR is a new feature or a fix, it must be logged in the changelog
+        validate:
+          - do: and
+            validate:
+              - do: title
+                must_include:
+                  regex: ^(feat|fix)(\(\w+\))?:.+$
+              - do: changeset
+                must_include:
+                  regex: 'docs/changelog.rst'
+                  message: 'new features or fixes needed to be logged to the changelog'
+          - do: title
+            must_exclude:
+              regex: ^(feat|fix)(\(\w+\))?:.+$
+              message: 'new features or fixes needed to be logged to the changelog'
+    pass:
+      - do: merge
+        merge_method: 'squash'
+      - do: checks
+        status: 'success'

data/.gitignore

@@ -17,3 +17,26 @@ test/version_tmp
 tmp
 vendor/ruby
 /vendor/
+
+# Editor/IDE
+.idea
+.vscode
+
+# Environment
+.bash_profile
+.bashrc
+.profile
+.zprofile
+.zshrc
+.gitconfig
+.gitmodules
+.ripgreprc
+.mcp.json
+.claude/
+
+# Git internals (spurious)
+/HEAD
+/config
+/hooks
+/objects
+/refs

data/.ruby-version

@@ -1 +1 @@
-2.2.4
+3.4.8

data/CLAUDE.md

@@ -0,0 +1,95 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+`midwire_common` is a Ruby gem providing lightweight extensions to Ruby core classes (String, Array, Hash, Float, Integer, Time, Enumerable) via **refinements**, plus utility classes (DataFileCache, YamlSetting, TimeTool, RakeHelper, BottomlessHash). Version 2.0.0. Requires Ruby >= 3.2.
+
+## Commands
+
+### Run all tests
+```
+bundle exec rspec
+```
+
+### Run a single test file
+```
+bundle exec rspec spec/lib/midwire_common/string_spec.rb
+```
+
+### Run tests with coverage
+```
+COVERAGE=1 bundle exec rspec
+```
+
+### Version bumping (prompts for CHANGELOG entry)
+```
+bundle exec rake version:bump_patch
+bundle exec rake version:bump_minor
+bundle exec rake version:bump_major
+```
+
+## Architecture
+
+### Core Pattern: Refinements
+
+Each class extension is a refinement module under `MidwireCommon` (e.g., `MidwireCommon::StringExtensions`). Consumers activate them per-file with `using`:
+
+```ruby
+require 'midwire_common/string'
+using MidwireCommon::StringExtensions
+```
+
+Or activate everything at once:
+
+```ruby
+require 'midwire_common/all'
+using MidwireCommon::All
+```
+
+Refinement modules use `refine ClassName do` for instance methods and `refine ClassName.singleton_class do` for class methods (e.g., `String.random`, `Time.timestamp`).
+
+`NumberBehavior` is a shared module imported into Float and Integer refinements via `import_methods` (not `include`, which was removed from refinements in Ruby 3.2).
+
+### Refinement Modules
+
+| File | Module | Refines |
+|------|--------|---------|
+| `string.rb` | `StringExtensions` | `String`, `String.singleton_class` |
+| `array.rb` | `ArrayExtensions` | `Array` |
+| `hash.rb` | `HashExtensions` | `Hash` |
+| `integer.rb` | `IntegerExtensions` | `Integer` |
+| `float.rb` | `FloatExtensions` | `Float` |
+| `enumerable.rb` | `EnumerableExtensions` | `Enumerable` |
+| `time.rb` | `TimeExtensions` | `Time.singleton_class` |
+| `file.rb` | `FileExtensions` | `File::Stat.singleton_class` |
+
+### Loading
+
+- `require 'midwire_common'` — loads namespace, version, and autoloads for utility classes
+- `require 'midwire_common/all'` — loads all refinement modules and utility classes, defines `MidwireCommon::All`
+- Individual files can be required separately (e.g., `require 'midwire_common/string'`)
+
+### Utility Classes (namespaced under `MidwireCommon`)
+
+- **BottomlessHash** — Hash subclass with auto-vivifying nested keys
+- **DataFileCache** — file-based data caching with age tracking
+- **YamlSetting** — YAML file-backed key/value configuration with lazy loading
+- **TimeTool** — class-method-only utility for HH:MM:SS <-> seconds conversion
+- **RakeHelper** — loads version-management rake tasks from `lib/tasks/`
+
+### Rake Tasks
+
+`lib/tasks/version.rake` provides `version:bump_patch`, `version:bump_minor`, `version:bump_major`. These tasks modify `lib/midwire_common/version.rb`, update the version string in `README.md`, and prepend to `CHANGELOG`. They warn when bumping on the `master` branch.
+
+### Test Structure
+
+Specs mirror `lib/` layout: `spec/lib/midwire_common/<name>_spec.rb`. Each spec file activates the refinements it needs with `using` at the top level. The spec helper includes `MidwireCommon` module at the top level for utility class access.
+
+## Conventions
+
+- Ruby version: specified in `.ruby-version` (currently 3.4.8), gemspec requires `>= 3.2`
+- RSpec 3 with `--format documentation --color` (see `.rspec`), supports both `should` and `expect` syntax
+- Tests run in random order
+- Bang methods (`sanitize!`) follow Ruby convention of modifying in place

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -2,10 +2,12 @@
 
 [![Gem Version](https://badge.fury.io/rb/midwire_common.png)](https://badge.fury.io/rb/midwire_common)
 
-**Version: 1.1.1**
+**Version: 2.0.0**
 
 A handy, light-weight Ruby library for Midwire development
 
+Requires Ruby >= 3.2.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,16 +20,17 @@ And then execute:
 
 ## Usage
 
-### Ruby Class Extensions
+### Ruby Class Extensions (Refinements)
 
-To use the standard class extensions you must include the individual files or 'midwire_common/all' to include everything:
+As of 2.0.0, all class extensions use Ruby refinements instead of monkey-patching. Require the extensions, then activate them with `using`:
 
     require 'midwire_common/all'
+    using MidwireCommon::All
 
-... or include individual files as necessary:
+... or include individual refinement modules:
 
     require 'midwire_common/string'
-    require 'midwire_common/array'
+    using MidwireCommon::StringExtensions
 
 ### Rake Tasks
 

data/Rakefile

@@ -1,6 +1,8 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
-Dir['lib/tasks/**/*.rake'].sort.each { |ext| load ext }
+Dir['lib/tasks/**/*.rake'].each { |ext| load ext }
 
 # RSpec Tasks
 require 'rspec/core/rake_task'