namo 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84d86032e9397e8db4a4d7a4150474c30215cf9339ec2158a38802aad1a4d49
-  data.tar.gz: 830b874e04b36acd7ab848351419ed5ceb848e0108b95602184b7e6131812e01
+  metadata.gz: 1ed38a77d14075cbe3c28ff53097d539c2fefe4a91ff515e165e02c280311fd3
+  data.tar.gz: ba009835a59174f2e60327f3583753d2e6c2b0e81b06f23de4a15dd792981526
 SHA512:
-  metadata.gz: 1b409a5004f78619ea60186404e6f156fadbc660755cc9fc3c64cfe8a028a3ffdd7bb35dd252510ece1814674f0b02af7b347b1ea42c1280390e7d7a982f0de0
-  data.tar.gz: 15c2c28dafa605ee5a93e5ebb3bee4e5a1f8301dca7cfb11675e1f197db62052975a0f9b74a9096638062b4d40cd85b5752ce5e52c3b0c5f39463fed421aec6c
+  metadata.gz: 7328696a6b4032561fa1b68c0eb4d3e7d3582ee4d5fc24926779112413867f1713100d9c21a3aa2f18c299e50802c866b5c95e874e569f4ef41f40e7b3924f58
+  data.tar.gz: 8028776be37f1f183ca2cefc3c9de7229d6918cf37d05b5f925675dd2ffd7d05603cc21ba53665f74094991b0c8d08f22479de2f50ee35e36ba772777bdbfb6e

data/CHANGELOG

@@ -1,6 +1,46 @@
 CHANGELOG
 _________
 
+20260613
+0.18.0: + Namo::Collection — hierarchical aggregate of named Namos with summary/detail views.
+
+1. + lib/Namo/Collection.rb: Namo::Collection < Namo, the first family member beyond Namo
+   itself. Holds @members (an Array of named Namos, attr_reader :members) whose substance is
+   the collection; the inherited @data is a derived view rebuilt from the members. << accepts a
+   member or an array (via flatten), replaces by name (last-write-wins, unless member.name.nil?
+   so nil-named members always append), rebuilds @data = detail.data, and returns self. find(name)
+   returns the named member or nil (find(nil) is nil, and an unnamed member never matches),
+   shadowing Enumerable#find on Collections. summary(dimension, by: :member, reducer: :sum)
+   reduces each member to a {by => member.name, dimension => reduced} row; detail(by: :member)
+   unions the members' rows under the inject-iff-absent conditional
+   (row.key?(by) ? row : row.merge(by => member.name)); both return a fresh Namo (non-mutating).
+   as_summary(...) and as_detail(by = :member) set @data to the chosen view and return self
+   (mutating); the view persists until the next << re-materialises detail. Private initialize
+   sets @members = [] before super.
+2. ~ lib/namo.rb: + require_relative './Namo/Collection'.
+3. + test/Namo/Collection_test.rb: empty members; lazy detail materialisation and selection;
+   pure-live reflection of <<; <<' add/replace-by-name/array/unnamed/returns-self; find by name,
+   absent, nil, and unnamed; summary's labelled rows, custom by:, :mean reducer (local Array#mean),
+   and non-mutation; detail's plain-Namo return, inject-iff-absent both ways, and non-mutation;
+   live recomputation after <<; as_summary/as_detail mutate and return self and surface the
+   summary's columns in dimensions; as_* view persistence until the next <<; assembly round-trip
+   (as_detail(:assembly) injects and is retained, removed only by contraction); subclass default
+   by: via a Car < Namo::Collection overriding summary/detail.
+4. ~ README.md: + Collections section after Named Namos — the GT-budget example (Car/SubAssembly,
+   <<, summary, detail), lazy detail materialisation, the four view methods and the
+   non-mutating/mutating split, the inject-iff-absent rule, << replace-by-name with use-site
+   handling of unnamed members, the rebuild-on-<< view lifetime, and forward-notes to group_by
+   (0.19.0) and freeze-gated memoisation (2.x).
+5. ~ ROADMAP.md: Promote 0.18.0 to shipped, recording the resolved materialisation model
+   (rebuild-on-<<, as_* persists until the next <<, diverging from the drafted pure-live-per-access
+   / transient wording) and the find/Enumerable#find shadowing; Current state -> 0.18.0; Summary
+   folds in Namo::Collection; next phase -> group_by (0.19.0). The upcoming 0.18.0 design block
+   folded into the shipped entry.
+6. ~ COMPARISON.md: Aggregation entry repointed — Namo::Collection shipped (0.18.0), group_by
+   constructor still planned (0.19.0); persistent-named-collection retained as Namo's novelty
+   versus the other tools' transient group-by intermediates.
+7. ~ Namo::VERSION: /0.17.0/0.18.0/
+
 20260613
 0.17.0: + parameterised formulae — formulae with required parameters beyond (row, namo) receive arguments at access time through Row#[].
 

data/README.md

@@ -925,6 +925,121 @@ end
 
 `super` with no parentheses forwards every argument — positional and keyword — to `Namo#initialize` unchanged. The `return unless name` guard means a subclass need not override every operator to stop the result of `*` or `select` from re-running its construction side effects: it guards on `name` instead.
 
+### Collections
+
+`Namo::Collection` is a hierarchical aggregate — a Namo that holds an Array of named Namos (its `members`) and exposes summary and detail views across them. It is the first member of the Namo family beyond `Namo` itself.
+
+The motivating case is a hierarchical budget. Each sub-assembly of a car (`powertrain`, `chassis`, `body`, ...) is a Namo with shared columns; the whole car is a `Collection` of those sub-assemblies, queryable both at summary level ("weight by assembly") and detail level ("every line item across all assemblies"):
+
+```ruby
+class Car < Namo::Collection
+  def summary(dimension, by: :assembly, reducer: :sum)
+    super
+  end
+
+  def detail(by: :assembly)
+    super
+  end
+end
+
+class SubAssembly < Namo; end
+
+powertrain = SubAssembly.new(name: :powertrain, data: [
+  {component: 'engine', weight: 200, cost: 50000},
+  {component: 'gearbox', weight: 80, cost: 20000}
+])
+chassis = SubAssembly.new(name: :chassis, data: [{component: 'frame', weight: 150, cost: 30000}])
+body    = SubAssembly.new(name: :body, data: [{component: 'panels', weight: 60, cost: 15000}])
+
+gt = Car.new
+gt << [powertrain, chassis, body]
+
+gt.summary(:weight).to_a
+# => [
+#   {assembly: :powertrain, weight: 280},
+#   {assembly: :chassis, weight: 150},
+#   {assembly: :body, weight: 60}
+# ]
+
+gt.summary(:weight).values(:weight).sum    # total weight by summing the assembly summaries
+# => 490
+
+gt.detail.values(:weight).sum              # total weight by summing every line item
+# => 490
+```
+
+`Car` overrides `summary`/`detail` only to set `by: :assembly` as the per-class default and then calls `super`. A bare `Namo::Collection.new` works equally well, defaulting `by:` to `:member` and taking it at the call site.
+
+#### Lazy detail, behaving as its line items
+
+A Collection's substance is its `members`; the inherited `@data` is a *derived view* of them. Any inherited row-operation — selection, projection, `each`, `values`, the set and composition operators — reads that view, so a Collection transparently behaves as its **detail** (the lossless union of its members' rows). Nothing has to be called first:
+
+```ruby
+gt.values(:weight)
+# => [200, 80, 150, 60]
+
+gt[component: 'engine'].values(:cost)
+# => [50000]
+```
+
+Detail is the lazy view because a Collection's rows simply *are* its members' rows; a summary is a reduction you pose against them, so it is never reached by accident — only through `summary` or `as_summary`.
+
+#### Four view methods
+
+The views come in a non-mutating pair and a mutating pair:
+
+- `summary(dimension, by:, reducer:)` and `detail(by:)` are **non-mutating** — each returns a fresh `Namo` derived from the members, leaving the Collection untouched. Use these when you want a view to keep: assign the result to a variable and operate on it independently.
+- `as_summary(dimension, by:, reducer:)` and `as_detail(by)` are **mutating** — each sets the Collection's data to the chosen view and returns `self`, for a fluent step. (`as_detail` carries no `dimension`, so its label argument is positional: `as_detail(:assembly)`.)
+
+```ruby
+gt.summary(:cost, reducer: :mean)          # a fresh Namo; gt is unchanged
+gt.as_summary(:weight)                     # gt's data becomes the summary; returns gt
+gt.as_detail(:assembly)                    # gt's data becomes the detail; returns gt
+```
+
+`reducer:` is any method the member's column responds to — `:sum` (the default) and `:mean` are typical (`:mean` via a statistics gem that adds `Array#mean`).
+
+#### Inject-iff-absent
+
+`detail(by:)` unions the members' rows and labels each with its origin, but only when that label isn't already present:
+
+- If `by` is **already a dimension** in a member's rows, the row passes through untouched — the dimension is intrinsic.
+- If `by` is **not** present, `detail` injects it (`row.merge(by => member.name)`), promoting the member's name into a dimension.
+
+This single conditional is where assembly (`<<`, members named extrinsically) and partition (`group_by`, members named by an intrinsic value — 0.19.0) meet. For an assembled Collection, `as_detail(:assembly)` is the dimension-creating step: it promotes the member name into real data and **retains** it. From then on the structure is intrinsic and round-trips are exact; the promoted dimension is removed only by explicit contraction (`gt[-:assembly]`), never automatically.
+
+#### `<<` and unnamed members
+
+`<<` accepts a single member or an array of them. A member whose `name` collides with an existing member's **replaces** it (last-write-wins), making the name → member mapping a dictionary rather than a multimap:
+
+```ruby
+gt << SubAssembly.new(name: :powertrain, data: [...])   # replaces the existing :powertrain
+gt << [front_suspension, rear_suspension]               # adds each
+```
+
+There is no insertion-time guard against unnamed members. An unnamed member is simply appended (no name to collide on) and is unfindable by `find` — the honest consequence of having no name, not an error. `find(name)` returns the member with that name, or `nil`:
+
+```ruby
+gt.find(:chassis)    # => the chassis SubAssembly
+gt.find(:missing)    # => nil
+```
+
+(`find(name)` is member lookup; it shadows `Enumerable#find` on Collections. Predicate search over rows remains available as `detect`.)
+
+#### View lifetime and liveness
+
+Materialisation is pure-live: the Collection rebuilds its data view from the current members on every `<<`, with no memoisation. So a mutation is reflected immediately — add a member, then summarise or detail, and the new member is included.
+
+A mutating `as_summary`/`as_detail` view **persists until the next `<<`**, which re-materialises detail. So `as_summary` is for "be the summary for this immediate chain":
+
+```ruby
+gt.as_summary(:weight).values(:weight)    # => [280, 150, 60]   (the summary)
+gt << front_suspension                     # re-materialises detail
+gt.values(:weight)                         # => [200, 80, 150, 60, ...]   (line items again)
+```
+
+Freeze-gated memoisation is a 2.x optimisation — opt-in via `freeze`, transparent, and never changing this observable behaviour. `group_by` (0.19.0) is the partition-side constructor for the same type: it splits a Namo into a `Collection`, the mirror of assembling one with `<<`.
+
 ## Why?
 
 Every other multi-dimensional array library requires you to pre-shape your data before you can work with it. Namo takes it in the form it likely already comes in.

data/lib/Namo/Collection.rb

@@ -0,0 +1,52 @@
+# Namo/Collection.rb
+# Namo::Collection
+
+class Namo
+  class Collection < Namo
+    attr_reader :members
+
+    def <<(*members)
+      members.flatten.each do |member|
+        @members.reject!{|existing| existing.name == member.name} unless member.name.nil?
+        @members << member
+      end
+      @data = detail.data
+      self
+    end
+
+    def find(name)
+      @members.find{|member| member.name == name} unless name.nil?
+    end
+
+    def summary(dimension, by: :member, reducer: :sum)
+      rows = @members.map do |member|
+        {by => member.name, dimension => member.values(dimension).send(reducer)}
+      end
+      Namo.new(rows)
+    end
+
+    def detail(by: :member)
+      rows = @members.flat_map do |member|
+        member.data.map{|row| row.key?(by) ? row : row.merge(by => member.name)}
+      end
+      Namo.new(rows)
+    end
+
+    def as_summary(dimension, by: :member, reducer: :sum)
+      @data = summary(dimension, by: by, reducer: reducer).data
+      self
+    end
+
+    def as_detail(by = :member)
+      @data = detail(by: by).data
+      self
+    end
+
+    private
+
+    def initialize(positional_data = nil, data: [], formulae: {}, name: nil)
+      @members = []
+      super
+    end
+  end
+end

data/lib/Namo/VERSION.rb

@@ -2,5 +2,5 @@
 # Namo::VERSION
 
 class Namo
-  VERSION = '0.17.0'
+  VERSION = '0.18.0'
 end

data/lib/namo.rb

@@ -3,6 +3,7 @@
 
 require_relative './Namo/NegatedDimension'
 require_relative './Namo/Row'
+require_relative './Namo/Collection'
 require_relative './Namo/Enumerable'
 require_relative './Namo/VERSION'
 require_relative './Symbol'

data/test/Namo/Collection_test.rb

@@ -0,0 +1,250 @@
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+require_relative '../../lib/namo'
+
+class Array
+  def mean
+    sum.to_f / size
+  end
+end unless [].respond_to?(:mean)
+
+class SubAssembly < Namo; end
+
+class Car < Namo::Collection
+  def summary(dimension, by: :assembly, reducer: :sum)
+    super
+  end
+
+  def detail(by: :assembly)
+    super
+  end
+end
+
+describe Namo::Collection do
+  let(:powertrain) do
+    SubAssembly.new(name: :powertrain, data: [
+      {component: 'engine', weight: 200, cost: 50000},
+      {component: 'gearbox', weight: 80, cost: 20000},
+    ])
+  end
+
+  let(:chassis) do
+    SubAssembly.new(name: :chassis, data: [{component: 'frame', weight: 150, cost: 30000}])
+  end
+
+  let(:body) do
+    SubAssembly.new(name: :body, data: [{component: 'panels', weight: 60, cost: 15000}])
+  end
+
+  let(:wheels) do
+    SubAssembly.new(name: :wheels, data: [{component: 'tyres', weight: 40, cost: 8000}])
+  end
+
+  let(:collection) do
+    Namo::Collection.new.tap{|c| c << [powertrain, chassis, body]}
+  end
+
+  describe "construction" do
+    it "starts with empty members" do
+      _(Namo::Collection.new.members).must_equal []
+    end
+  end
+
+  describe "lazy detail materialisation" do
+    it "materialises detail on a bare row-operation without a prior as_detail" do
+      _(collection.values(:weight)).must_equal [200, 80, 150, 60]
+    end
+
+    it "supports selection against the materialised detail" do
+      _(collection[component: 'engine'].values(:component)).must_equal ['engine']
+    end
+
+    it "reflects a newly added member on the next operation" do
+      before = collection.values(:weight)
+      collection << wheels
+      _(collection.values(:weight)).must_equal before + [40]
+    end
+  end
+
+  describe "#<<" do
+    it "adds a member" do
+      collection = Namo::Collection.new
+      collection << powertrain
+      _(collection.members.size).must_equal 1
+      _(collection.find(:powertrain)).must_be_same_as powertrain
+    end
+
+    it "replaces a member with a colliding name (last-write-wins)" do
+      collection = Namo::Collection.new
+      collection << powertrain
+      replacement = SubAssembly.new(name: :powertrain, data: [{component: 'hybrid', weight: 250, cost: 70000}])
+      collection << replacement
+      _(collection.members.size).must_equal 1
+      _(collection.find(:powertrain)).must_be_same_as replacement
+    end
+
+    it "adds each member from an array" do
+      collection = Namo::Collection.new
+      collection << [powertrain, chassis]
+      _(collection.members.size).must_equal 2
+    end
+
+    it "appends an unnamed member, which is unfindable by name" do
+      collection = Namo::Collection.new
+      collection << SubAssembly.new(data: [{component: 'misc', weight: 5, cost: 100}])
+      collection << SubAssembly.new(data: [{component: 'other', weight: 6, cost: 200}])
+      _(collection.members.size).must_equal 2
+    end
+
+    it "returns self" do
+      collection = Namo::Collection.new
+      _(collection << powertrain).must_be_same_as collection
+    end
+  end
+
+  describe "#find" do
+    it "returns the member with the given name" do
+      _(collection.find(:chassis)).must_be_same_as chassis
+    end
+
+    it "returns nil for an absent name" do
+      _(collection.find(:engine)).must_be_nil
+    end
+
+    it "returns nil for find(nil)" do
+      _(collection.find(nil)).must_be_nil
+    end
+
+    it "never matches an unnamed member" do
+      collection = Namo::Collection.new
+      collection << SubAssembly.new(data: [{component: 'misc', weight: 5, cost: 100}])
+      _(collection.find(nil)).must_be_nil
+    end
+  end
+
+  describe "#summary" do
+    it "reduces each member to a labelled row" do
+      summary = collection.summary(:weight)
+      _(summary.values(:member)).must_equal [:powertrain, :chassis, :body]
+      _(summary.values(:weight)).must_equal [280, 150, 60]
+    end
+
+    it "labels with a custom by dimension" do
+      summary = collection.summary(:weight, by: :assembly)
+      _(summary.values(:assembly)).must_equal [:powertrain, :chassis, :body]
+    end
+
+    it "reduces with a custom reducer" do
+      summary = collection.summary(:weight, reducer: :mean)
+      _(summary.values(:weight)).must_equal [140.0, 150.0, 60.0]
+    end
+
+    it "is non-mutating — leaves the collection's data untouched" do
+      collection.summary(:weight)
+      _(collection.values(:weight)).must_equal [200, 80, 150, 60]
+    end
+  end
+
+  describe "#detail" do
+    it "returns a plain Namo" do
+      _(collection.detail).must_be_instance_of Namo
+    end
+
+    it "unions the members' rows, injecting the by dimension when absent" do
+      detail = collection.detail
+      _(detail.values(:member)).must_equal [:powertrain, :powertrain, :chassis, :body]
+      _(detail.values(:weight)).must_equal [200, 80, 150, 60]
+    end
+
+    it "does not inject when the by dimension is already present" do
+      collection = Namo::Collection.new
+      collection << SubAssembly.new(name: :ignored, data: [{member: :preexisting, weight: 5}])
+      _(collection.detail.values(:member)).must_equal [:preexisting]
+    end
+
+    it "is non-mutating — leaves the collection's data untouched" do
+      collection.detail(by: :assembly)
+      _(collection.dimensions).wont_include :assembly
+    end
+  end
+
+  describe "live recomputation (no memoisation in 1.x)" do
+    it "reflects a mutation on the next detail call" do
+      before = collection.detail.values(:weight).size
+      collection << wheels
+      _(collection.detail.values(:weight).size).must_equal before + 1
+    end
+
+    it "reflects a mutation on the next summary call" do
+      collection << wheels
+      _(collection.summary(:weight).values(:member)).must_equal [:powertrain, :chassis, :body, :wheels]
+    end
+  end
+
+  describe "#as_summary / #as_detail" do
+    it "as_summary sets the data to the summary view and returns self" do
+      result = collection.as_summary(:weight)
+      _(result).must_be_same_as collection
+      _(collection.values(:weight)).must_equal [280, 150, 60]
+    end
+
+    it "as_detail sets the data to the detail view and returns self" do
+      collection.as_summary(:weight)
+      result = collection.as_detail
+      _(result).must_be_same_as collection
+      _(collection.values(:weight)).must_equal [200, 80, 150, 60]
+    end
+
+    it "exposes the summary's columns in dimensions immediately after as_summary" do
+      collection.as_summary(:weight)
+      _(collection.dimensions.sort).must_equal [:member, :weight].sort
+    end
+  end
+
+  describe "as_* view lifetime (rebuild-on-<<: persists until the next <<)" do
+    it "keeps the summary view across a bare row-operation" do
+      collection.as_summary(:weight)
+      _(collection.values(:weight)).must_equal [280, 150, 60]
+      _(collection[member: :powertrain].values(:weight)).must_equal [280]
+    end
+
+    it "re-materialises detail on the next <<" do
+      collection.as_summary(:weight)
+      collection << wheels
+      _(collection.values(:weight)).must_equal [200, 80, 150, 60, 40]
+    end
+  end
+
+  describe "assembly round-trip" do
+    it "injects :assembly via as_detail and retains it through a later << and as_detail" do
+      collection.as_detail(:assembly)
+      _(collection.dimensions).must_include :assembly
+      _(collection.coordinates(:assembly)).must_equal [:powertrain, :chassis, :body]
+      collection << wheels
+      collection.as_detail(:assembly)
+      _(collection.dimensions).must_include :assembly
+      _(collection.coordinates(:assembly)).must_equal [:powertrain, :chassis, :body, :wheels]
+    end
+
+    it "removes :assembly only by explicit contraction" do
+      collection.as_detail(:assembly)
+      contracted = collection[-:assembly]
+      _(contracted.dimensions).wont_include :assembly
+    end
+  end
+
+  describe "subclass with a default by:" do
+    let(:car) do
+      Car.new.tap{|c| c << [powertrain, chassis, body]}
+    end
+
+    it "uses the subclass default :assembly for summary" do
+      _(car.summary(:weight).values(:assembly)).must_equal [:powertrain, :chassis, :body]
+    end
+
+    it "uses the subclass default :assembly for detail" do
+      _(car.detail.values(:assembly)).must_equal [:powertrain, :powertrain, :chassis, :body]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namo
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - thoran
@@ -64,6 +64,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/Namo/Collection.rb
 - lib/Namo/Enumerable.rb
 - lib/Namo/NegatedDimension.rb
 - lib/Namo/Row.rb
@@ -71,6 +72,7 @@ files:
 - lib/Symbol.rb
 - lib/namo.rb
 - namo.gemspec
+- test/Namo/Collection_test.rb
 - test/Namo/NegatedDimension_test.rb
 - test/Namo/Row_test.rb
 - test/Symbol_test.rb