flexor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 823be7501c328a913f46121e7aa40b37fde22d73505f92928087f0d68b9355e2
-  data.tar.gz: 717311911cdb6e059859390ef9b238c1f524ed96d52071563cbc9f56568d119a
+  metadata.gz: 957721d918f235f01e558af4a5303fd07a6e92ca70d0ef11b49d2fb58ea9ccfe
+  data.tar.gz: 32dd414daa542578908e01fd737f932a5a01ec886571bde813cf5634d82fe7e9
 SHA512:
-  metadata.gz: 9abb50d29119d0cb6deb40e8a14dc1bed3cf860fc65eb599adb1fc8f740374fc664440dc55cc5b3868b1cbe93e44d262ea338ab544f0fc590d587d1d738ab047
-  data.tar.gz: 531b16d783d2f49bf68edd73a27b47a7565f17f6a465b12b64f9d9542e4d781b9b4dfdacf345b941bad847e36afdee523b8666f42d09cb6ef0dc9f4de393a9c4
+  metadata.gz: a9082e8189768c8c073448fff223b1aaf3054d9474ac64faf8b3030fd27296c01d1f40a83356b69aa020e32b98ac4d2d0003f5eeebb8bd7652f98413033b9a4d
+  data.tar.gz: cef0d9d8d02589775c9361f21e00e494a208555c3048270ac937ebd995a834ab5a66d075c690404feeccbbd344c8a7ae1e37ca1161ef702676c5767ffbc6b359

data/.rubocop.yml

@@ -13,10 +13,9 @@ plugins:
   - rubocop-claude
   - rubocop-performance
   - rubocop-rspec
-  - rubocop-md
-  - rubocop-rake
 
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 3.4
 
 # ===========================================================================
@@ -172,9 +171,6 @@ Style/RedundantReturn:
 # ===========================================================================
 # Overrides from rubocop-performance — disable chain-hostile cops
 # ===========================================================================
-Performance:
-  Exclude:
-    - "spec/**/*"
 
 # ChainArrayAllocation flags idiomatic pipelines for microsecond gains.
 # If we need real throughput we parallelize, not uglify.
@@ -233,12 +229,19 @@ Metrics/BlockLength:
     - heredoc
     - method_call
   AllowedMethods:
+    - command
     - describe
     - context
     - shared_examples
     - shared_examples_for
     - shared_context
 
+# Shared test contexts legitimately define many helpers (stdin, stdout,
+# stderr, env, cli, exit_status, output). These are a single fixture,
+# not independent concerns.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
 # Anonymous forwarding (*, **, &) breaks TruffleRuby, JRuby, and
 # Ruby < 3.2. Named args are explicit and portable.
 #
@@ -379,16 +382,24 @@ RSpec/LeadingSubject:
 RSpec/ExpectChange:
   EnforcedStyle: block
 
-RSpec/NamedSubject:
+# Disabled because OpenStruct is used for testing
+Style/OpenStructUse:
   Enabled: false
 
-# PROJECT SPECIFIC:
-#
-# Behavior is very intricate here and warrants separation
-RSpec/SpecFilePathFormat:
+RSpec/NamedSubject:
   Enabled: false
 
+# Would rather be as thorough as possible here as this is inherently a "not normally safe" library
 RSpec/NestedGroups:
-  Enabled: false
+  Max: 4
+
 RSpec/MultipleExpectations:
-  Max: 3
+  Max: 2
+
+# Prefer the explicit &block rather than &
+Naming/BlockForwarding:
+  Enabled: false
+
+# This has bugs and is causing specs to fail when autocorrected
+Performance/RedundantMerge:
+  Enabled: false

data/CLAUDE.md

@@ -0,0 +1,62 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Rules
+
+1. DO NOT edit .rubocop.yml or add inline rubocop exemptions without explicit permission
+2. DO NOT run any git command that will rewrite history without explicit permission
+3. PREFER method & class extraction over comments
+4. Making new files, classes, modules, and methods IS NOT overengineering
+5. BEFORE writing code, identify which domain concept owns the behavior. Each class and module should have a single responsibility. If the new behavior doesn't fit an existing class's responsibility, create a new one — don't expand the scope of what's already there.
+6. DO NOT name classes with suffixes like "-er" or "-or" unless using a canonical pattern name (e.g., Parser, Router, Controller)
+7. ALWAYS write specs first. The workflow is: identify the domain concept (rule 5), write specs describing its behavior, then implement. No implementation without a failing spec.
+
+## Project
+
+Flexor is a Ruby gem providing a Hash-like data store with autovivifying nested access, nil-safe chaining, and seamless conversion between hashes and method-style access. Requires Ruby >= 3.4.
+
+## Commands
+
+- `rake spec` — run all tests
+- `bundle exec rspec spec/flexor/flexor_reading_spec.rb` — run a single spec file
+- `bundle exec rspec spec/flexor/flexor_reading_spec.rb:15` — run a single example by line
+- `rake rubocop` — run linter
+- `bundle exec rubocop -a` — autocorrect safe offenses
+- `rake` — run both specs and rubocop (default task)
+- `rake benchmark` — run performance benchmarks (uses YJIT)
+- `rake rdoc` — generate documentation
+- `rake version:current` — show current version
+- `rake version:bump` — bump patch version
+- `bin/console` — IRB session with Flexor loaded
+
+## Architecture
+
+Single class `Flexor` in `lib/flexor.rb` with three mixins:
+
+- **`Vivification`** (`lib/flexor/vivification.rb`) — recursively converts Hashes/Arrays into Flexor objects on write; reverses via `recurse_to_h` on read. The `@store` uses a `Hash.new` default block that auto-creates child Flexor nodes (autovivification).
+- **`HashDelegation`** (`lib/flexor/hash_delegation.rb`) — delegates `keys`, `values`, `size`, `empty?`, `key?` to `@store`.
+- **`Serialization`** (`lib/flexor/serialization.rb`) — Marshal and YAML round-trip support.
+
+Key internals:
+- `@store` is the backing Hash with an autovivifying default block
+- `@root` flag distinguishes top-level instances from auto-created children (affects `inspect` and `nil?` behavior)
+- `method_missing` handles dynamic getter/setter; once accessed, singleton methods are cached for performance (`cache_getter`/`cache_setter`)
+- `nil?` returns `true` when `@store` is empty (non-root nodes appear nil-like until written to)
+
+## Style Conventions (from .rubocop.yml)
+
+- Double quotes always (`Style/StringLiterals`)
+- No frozen_string_literal comments
+- Trailing commas in multiline literals/arguments
+- Pipeline-style chaining encouraged (multiline block chains allowed)
+- Block length max 8 (keeps blocks small, push logic into pipelines)
+- Dot-aligned chaining (`Layout/MultilineMethodCallIndentation: aligned`)
+- Consistent 2-space argument indentation (not aligned to first arg)
+- Explicit `begin/rescue/end` preferred over implicit method-body rescue
+- All classes require rdoc documentation (`Style/Documentation`)
+- RSpec: `expect { }.to change { }` block style, nested groups max 4, multiple expectations max 2
+
+## Tests
+
+Specs are organized by concern in `spec/flexor/` (reading, writing, merge, serialization, freeze, etc.). The top-level `spec/flexor_spec.rb` only checks the version. RSpec runs with `--format documentation` and monkey patching disabled.

data/issues.rec

@@ -0,0 +1,24 @@
+%rec: Issue
+%key: Id
+%typedef: Status_t enum open in_progress closed
+%typedef: Description_t regexp /.*/
+%type: Id uuid
+%type: Title line
+%type: Description Description_t
+%type: Updated date
+%type: Status Status_t
+%auto: Id Updated
+
+Id: BAA28228-220B-11F1-88B7-FE6CB9572C2E
+Updated: Tue, 17 Mar 2026 10:15:19 -0400
+Title: Add constant F that is set equal to Flexor
+Description: As Flexor is built to maximize ergonomics, it would be ideal to have a shorter way to call it. In lib, there should be f.rb, where F = Flexor as the only line. It could be called like:
++ puts F[json_string].people.first.first_name
++
+Status: open
+
+Id: A4C9FDF4-2220-11F1-BED9-FE6CB9572C2E
+Updated: Tue, 17 Mar 2026 12:45:02 -0400
+Title: Address rubocop offenses
+Description: Currently 30 violations as I write this
+Status: open

data/lib/f.rb

@@ -0,0 +1,3 @@
+require_relative "flexor"
+
+F = Flexor

data/lib/flexor/version.rb

@@ -1,3 +1,3 @@
 class Flexor
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Gillis
@@ -21,6 +21,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -29,6 +30,8 @@ files:
 - docs/benchmark-results.md
 - docs/original_specification.yaml
 - docs/specification.yaml
+- issues.rec
+- lib/f.rb
 - lib/flexor.rb
 - lib/flexor/hash_delegation.rb
 - lib/flexor/serialization.rb
@@ -58,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.7
 specification_version: 4
 summary: A Hash-like data store that does what you tell it to do
 test_files: []