solidus_advanced_pricing 0.1.0 → 0.3.0

data/lib/views/backend/spree/admin/prices/_advanced_fields.html.erb

@@ -5,8 +5,9 @@
       <%= f.collection_select :price_type_id,
                               SolidusAdvancedPricing::PriceType.ordered,
                               :id, :name,
-                              {},
-                              { class: 'custom-select fullwidth' } %>
+                              { include_blank: t('solidus_advanced_pricing.base_price') },
+                              { class: 'custom-select fullwidth', disabled: !f.object.new_record? } %>
+      <span class="field-hint"><%= t('solidus_advanced_pricing.price_type_hint') %></span>
     <% end %>
   </div>
 
@@ -25,14 +26,14 @@
   <div class="col-2">
     <%= f.field_container :valid_from do %>
       <%= f.label :valid_from %>
-      <%= f.text_field :valid_from, value: f.object.valid_from&.iso8601, class: 'fullwidth datepicker' %>
+      <%= f.datetime_local_field :valid_from, class: 'fullwidth' %>
     <% end %>
   </div>
 
   <div class="col-2">
     <%= f.field_container :valid_to do %>
       <%= f.label :valid_to %>
-      <%= f.text_field :valid_to, value: f.object.valid_to&.iso8601, class: 'fullwidth datepicker' %>
+      <%= f.datetime_local_field :valid_to, class: 'fullwidth' %>
     <% end %>
   </div>
 

data/solidus_advanced_pricing.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Price types, validity windows and role targeting for Solidus prices"
   spec.description = "Adds an admin-managed price type, an optional validity window, optional single-role targeting and internal admin notes to Spree::Price, selected through Solidus' own variant_price_selector_class seam."
-  spec.homepage = "https://github.com/solidusio-contrib/solidus_advanced_pricing#readme"
+  spec.homepage = "https://github.com/fcpeuro/solidus_advanced_pricing#readme"
   spec.license = "BSD-3-Clause"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/solidusio-contrib/solidus_advanced_pricing"
-  spec.metadata["changelog_uri"] = "https://github.com/solidusio-contrib/solidus_advanced_pricing/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/fcpeuro/solidus_advanced_pricing"
+  spec.metadata["changelog_uri"] = "https://github.com/fcpeuro/solidus_advanced_pricing/blob/main/CHANGELOG.md"
 
   spec.required_ruby_version = ">= 3.1"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_advanced_pricing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patrick McMorran
@@ -156,6 +156,7 @@ files:
 - app/decorators/models/solidus_advanced_pricing/spree/price_decorator.rb
 - app/decorators/models/solidus_advanced_pricing/spree/role_decorator.rb
 - app/decorators/models/solidus_advanced_pricing/spree/variant_decorator.rb
+- app/models/solidus_advanced_pricing/price_batch.rb
 - app/models/solidus_advanced_pricing/price_selector.rb
 - app/models/solidus_advanced_pricing/price_type.rb
 - app/models/solidus_advanced_pricing/price_type_cache.rb
@@ -178,9 +179,11 @@ files:
 - db/migrate/20260915000001_create_solidus_advanced_pricing_price_types.rb
 - db/migrate/20260915000002_seed_solidus_advanced_pricing_price_types.rb
 - db/migrate/20260915000003_add_advanced_pricing_to_spree_prices.rb
-- docs/superpowers/specs/2026-09-14-solidus-advanced-pricing-design.md
+- db/migrate/20260923000001_add_role_to_solidus_advanced_pricing_price_types.rb
 - lib/components/admin/solidus_admin/price_types/index/component.rb
 - lib/controllers/admin/solidus_admin/price_types_controller.rb
+- lib/controllers/api/spree/api/price_batches_controller.rb
+- lib/controllers/api/spree/api/price_types_controller.rb
 - lib/controllers/api/spree/api/prices_controller.rb
 - lib/controllers/backend/spree/admin/price_types_controller.rb
 - lib/generators/solidus_advanced_pricing/install/install_generator.rb
@@ -191,6 +194,9 @@ files:
 - lib/solidus_advanced_pricing/testing_support/factories.rb
 - lib/solidus_advanced_pricing/testing_support/factories/price_type_factory.rb
 - lib/solidus_advanced_pricing/version.rb
+- lib/views/api/spree/api/price_batches/create.json.jbuilder
+- lib/views/api/spree/api/price_types/_price_type.json.jbuilder
+- lib/views/api/spree/api/price_types/index.json.jbuilder
 - lib/views/api/spree/api/prices/_price.json.jbuilder
 - lib/views/api/spree/api/prices/index.json.jbuilder
 - lib/views/api/spree/api/prices/show.json.jbuilder
@@ -201,13 +207,13 @@ files:
 - lib/views/backend/spree/admin/prices/_advanced_columns.html.erb
 - lib/views/backend/spree/admin/prices/_advanced_fields.html.erb
 - solidus_advanced_pricing.gemspec
-homepage: https://github.com/solidusio-contrib/solidus_advanced_pricing#readme
+homepage: https://github.com/fcpeuro/solidus_advanced_pricing#readme
 licenses:
 - BSD-3-Clause
 metadata:
-  homepage_uri: https://github.com/solidusio-contrib/solidus_advanced_pricing#readme
-  source_code_uri: https://github.com/solidusio-contrib/solidus_advanced_pricing
-  changelog_uri: https://github.com/solidusio-contrib/solidus_advanced_pricing/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/fcpeuro/solidus_advanced_pricing#readme
+  source_code_uri: https://github.com/fcpeuro/solidus_advanced_pricing
+  changelog_uri: https://github.com/fcpeuro/solidus_advanced_pricing/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib

data/docs/superpowers/specs/2026-09-14-solidus-advanced-pricing-design.md

@@ -1,351 +0,0 @@
-# solidus_advanced_pricing — Design
-
-Status: FINAL (approved design, ready for implementation planning)
-Date: 2026-09-14
-
-## Problem
-
-Solidus core models a price as `(variant, currency, country_iso, amount)`. There is no way to
-express that a price is a particular *kind* of price, that it applies only during a window of
-time, or that it applies only to a certain kind of customer.
-
-Stores that need wholesale or dealer pricing, scheduled price-list rollovers, or simply a record
-of why a price exists currently reach for promotions. Promotions are the wrong tool for the
-first two: they *discount* a price rather than replacing it, which leaks the retail price to a
-B2B customer, reads as a discount on invoices, and reports as promotional revenue when it is
-not. See the promotions decision below for the full evaluation.
-
-## Goal
-
-A Solidus extension gem adding three things to `Spree::Price`, plus internal commentary:
-
-1. Configurable, admin-managed **price types**
-2. An optional **validity window** (`valid_from` / `valid_to`)
-3. Optional **role targeting** — one `Spree::Role` a price is visible to
-4. **`admin_notes`** — internal-facing commentary on why a price exists
-
-...delivered through Solidus' existing `Spree::Config.variant_price_selector_class` seam rather
-than by monkey-patching price lookup.
-
-## Non-goals
-
-- **Promotion machinery** — lanes, codes, usage limits, stacking rules, order-level
-  adjustments. A windowed `sale` or `clearance` price *is* supported; anything needing
-  promotional logic belongs in `solidus_promotions`.
-- **Role exclusion.** Only inclusion is expressible. "Everyone except employees" requires one
-  targeted price per included role.
-- **Re-pricing existing line items.** Carts are left alone, matching core.
-- **A prices screen in solidus_admin.** Upstream has not built one; this gem will not guess it.
-- **Display-only / compare-at price types.** Every price is a selection candidate.
-
-## Architecture
-
-Two subclasses registered in one initializer line. Core delegates `pricing_options_class` from
-the selector class, so this wires both:
-
-```ruby
-Spree::Config.variant_price_selector_class = "SolidusAdvancedPricing::PriceSelector"
-```
-
-Everything else is additive columns, one new table, view overrides, and an API controller.
-
-## Data model
-
-```
-solidus_advanced_pricing_price_types
-  id, name, code (unique), position, default (boolean), deleted_at, timestamps
-
-spree_prices                                   (columns added)
-  price_type_id  bigint,   NOT NULL, FK → price_types, indexed
-  role_id        bigint,   NULL,     FK → spree_roles, indexed
-  valid_from     datetime, NULL      (nil = open-ended start)
-  valid_to       datetime, NULL      (nil = never expires)
-  admin_notes    text,     NULL
-  index (variant_id, currency, country_iso, role_id, valid_from, valid_to)
-```
-
-`role_id` is modeled on `country_iso`: nullable, where `nil` means "every customer, including
-guests". There is no join table and no exclusion.
-
-The install migration seeds five price types, keyed by `code` so re-running is idempotent,
-then backfills every existing price into `default` before adding the NOT NULL constraint:
-
-| code | position | default | notes |
-|---|---|---|---|
-| `default` | 1 | yes | backfill target; guarded against discard |
-| `wholesale` | 2 | | |
-| `sale` | 3 | | typically paired with a validity window |
-| `clearance` | 4 | | |
-| `employee` | 5 | | typically paired with `role_id` |
-
-Only `default` is structural. The other four are conveniences — admins may rename, reposition
-or discard them freely, and may add their own.
-
-**A price type grants no access control.** Type and `role_id` are independent columns: naming a
-price `employee` does not hide it from anyone. An employee-only price is
-`price_type: employee` **and** `role_id: <employee role>`. This is the most likely
-misconfiguration in the whole gem and must be called out in both the README and the admin form
-hint text.
-
-## Price selection
-
-`SolidusAdvancedPricing::PricingOptions < Spree::Variant::PricingOptions`
-
-`desired_attributes` gains two real, assignable `Spree::Price` columns:
-
-- `price_type_id` — pinned to the default type in `default_price_attributes`
-- `role_id` — pinned to `nil` in `default_price_attributes`
-
-Both must be assignable columns because core calls `prices.build(default_price_attributes)` in
-`DefaultPrice#default_price_or_build`. They also make core's public `Spree::Price
-.with_default_attributes` scope correct for consumers.
-
-Two contextual readers live *outside* `desired_attributes`, because they are not price columns:
-
-| reader | default | meaning |
-|---|---|---|
-| `at` | `Time.current` | only prices whose window contains this instant |
-| `customer_role_ids` | `[]` | the roles this customer holds; `[]` is a guest |
-
-Built from context as:
-
-- `from_context(ctx)` → `customer_role_ids: ctx.current_spree_user&.spree_role_ids || []`
-- `from_line_item(li)` → `customer_role_ids: li.order&.user&.spree_role_ids || []`
-
-The association is `spree_roles` (see `Spree::UserMethods`), so the reader is `spree_role_ids`,
-not `role_ids`.
-
-**Pricing-relevant narrowing.** Both constructors intersect the customer's roles with the set of
-roles that actually appear on some price — `Spree::Price.distinct.pluck(:role_id).compact`,
-cached and invalidated by a `Spree::Price` `after_commit`. A customer holding
-`[admin, wholesale, newsletter]` narrows to `[wholesale]`. This changes no selection outcome —
-a role no price references can never match — but it collapses cache-key cardinality from
-2^(every role in the store) to 2^(roles used in pricing), which in practice is zero to two.
-
-`SolidusAdvancedPricing::PriceSelector < Spree::Variant::PriceSelector`
-
-`#price_for_options` runs in memory over `variant.prices`, as core does, so unsaved prices and
-preloaded associations keep working. Order of operations:
-
-1. **Filter** — drop discarded (unless the variant itself is discarded, per core); currency must
-   match exactly; the window must contain `at`; and the price must be visible:
-   `price.role_id.nil? || customer_role_ids.include?(price.role_id)`
-2. **Country specificity** — if any survivor matches the desired `country_iso`, keep only those;
-   otherwise keep the `country_iso IS NULL` fallback. This preserves core's behavior exactly:
-   country is specificity, not competition.
-3. **Cheapest wins** — `min_by(&:amount)` across the surviving bucket. Ties break on price type
-   `position`, then `updated_at` desc, then `id` desc, mirroring core's ordering.
-
-Role is **eligibility only** (step 1), never specificity. A wholesale customer sees both the
-wholesale and the untargeted price and gets whichever is cheaper. A wholesale price set *above*
-retail therefore never applies — that is intended and must be documented prominently, since it
-is the one genuinely surprising consequence of this model.
-
-The same predicates exist as AR scopes — `valid_at(time)`, `visible_to_roles(ids)`,
-`for_price_type(x)` — and `Spree::Variant.with_prices` is overridden in a decorator to use them.
-Without that override, a variant whose only price expired yesterday still counts as purchasable
-in product listings, because core's `with_prices` checks only currency and country.
-
-## Backward compatibility
-
-The guarantee: **a store with no typed, windowed or targeted prices behaves identically to
-core.** This gets an explicit spec that fails loudly, because every other compatibility claim
-rests on it.
-
-It holds because the backfill gives every existing price the default type, `role_id` defaults to
-`nil` (visible to all), and both window bounds default to `nil` (always valid). Defaulting `at`
-to `Time.current` changes nothing for a price with no window.
-
-One consequence to document: if a variant's only base prices all have windows and none is
-currently valid, `variant.price` returns `nil`, exactly as core returns `nil` when no price
-matches. Stores should keep one open-ended base price per variant.
-
-## Admin surfaces
-
-**Legacy backend.** `spree/admin/prices/_form` and `_table` both carry `data-hook` attributes, so
-Deface inserts at `admin_product_price_fields`: a price type select, a role select (mirroring the
-existing country select, blank = all customers), `valid_from`/`valid_to` datetime fields, and an
-`admin_notes` textarea. The prices index gains type, role and window columns.
-`Spree::Admin::ResourceController#permitted_resource_params` calls `permit!`, so the new columns
-need no strong-params work.
-
-Plus `Spree::Admin::PriceTypesController` — standard `ResourceController` CRUD.
-
-**solidus_admin.** A price types CRUD only, mirroring the existing `adjustment_reasons` /
-`refund_reasons` resource components. Per-variant price management stays in the legacy backend.
-
-## API
-
-Core's API has no prices resource; variants serialize only `price` / `display_price` via
-`price_for_options(current_pricing_options)`, which the new selector improves for free.
-
-v1 adds `Spree::Api::PricesController` plus jbuilder views exposing price type, role, validity
-window, and `admin_notes`. Two rules:
-
-- **Explicit pricing options, never `current_pricing_options`.** Core builds those
-  `from_context`, which reads `current_spree_user` — on an admin-token request that would
-  silently filter storefront prices by the *admin's* roles.
-- **`admin_notes` is serialized only when `can?(:update, price)`.** It is internal commentary and
-  must never reach a storefront payload.
-
-## Caching
-
-`PricingOptions#cache_key` in core is `desired_attributes.values.select(&:present?).join("/")`.
-Since `customer_role_ids` and `at` deliberately live outside that hash, an unmodified
-`cache_key` would render a wholesale customer's price into a fragment cache and then serve it to
-guests. The subclass **must** override `cache_key` to include sorted `customer_role_ids`.
-
-Note that having `role_id` in `desired_attributes` does *not* solve this. That attribute
-describes the price being sought, not the customer asking: `from_context` leaves it `nil`, so it
-is `nil` for guest and wholesale customer alike — and `select(&:present?)` drops nils regardless.
-Making core's key work unmodified would mean collapsing the customer to a single role, which
-cannot express "visible to any of my roles, cheapest wins".
-
-Time is the harder half: keying on raw `at` gives a 0% hit rate, while omitting it serves prices
-from cache past their window. v1 ships a coarse bucket —
-`Spree::Config.advanced_pricing_cache_granularity`, default 60 seconds — with the trade-off
-documented plainly: a price transition can be up to one granularity window late in cached views.
-Stores that cannot tolerate that set it to `nil` and lose price-dependent fragment caching.
-
-## Validations and edge cases
-
-- `valid_to` must be after `valid_from` when both are present.
-- Price types are soft-deletable. Discarding one removes it from the new-price dropdown but
-  leaves historical prices intact and still selectable, so "Overstock Sale of 2012" keeps its
-  type forever.
-- The `default: true` type is guarded against both discard and having its flag cleared while it
-  is the only default.
-- `role_id` and `price_type_id` integrity is enforced by foreign keys.
-
-## Testing
-
-- Model and scope specs, including the price type default/discard guards.
-- Selector specs driven by `ActiveSupport::Testing::TimeHelpers` across window boundaries.
-- An explicit backward-compatibility spec asserting `default_pricing_options` behavior is
-  unchanged from core.
-- A cache-key spec asserting two different role sets never collide.
-- Request specs for the API, including the `admin_notes` authorization boundary.
-- Feature specs for the legacy backend; component specs for the solidus_admin price types CRUD.
-- Factories under `lib/solidus_advanced_pricing/testing_support/factories.rb`, per contrib
-  convention.
-
-## Packaging
-
-`solidus_dev_support` skeleton: dummy app, RSpec, RuboCop, CI matrix. The engine uses
-`solidus_support`'s `backend_available?` / `admin_available?` / `api_available?` guards to add
-engine paths conditionally, so a headless store without `solidus_backend` does not load Deface
-overrides it cannot use. Solidus floor is 4.0 (`solidus_admin` exists only from 4.3, hence a
-guard rather than a hard dependency).
-
-## Decisions
-
-Every explicit decision from the brainstorm, with rationale.
-
-- **Price types are an admin-managed model**, not a config list or free-form string.
-  Rationale: store admins can add types without a deploy, and `position` gives a deterministic
-  tie-breaker.
-- **v1 ships the full stack**: model + price-selection core, legacy backend admin UI,
-  solidus_admin UI, and REST API exposure. (The solidus_admin half was later scoped down to a
-  price types CRUD — see that decision below.)
-  Rationale: an extension nobody can edit or read over the API isn't usable in a real store.
-- **Role targeting uses `Spree::Role`**, not a gem-owned group model or lambda predicates.
-  Rationale: works out of the box with solidus_auth_devise and any roles a store already
-  defines; keeps targeting queryable in SQL.
-- **Public contrib-style gem**: broad Solidus support, solidus_dev_support dummy app, CI matrix,
-  README, released to RubyGems.
-  Rationale: the feature is generally useful; building to contrib conventions from the start is
-  cheaper than retrofitting them.
-- **No display-only price types.** Every price is a selection candidate; compare-at/MSRP display
-  is the storefront's concern.
-  Rationale: keeps the model small; a `sellable` flag can be added later without breaking
-  anything.
-- **Stale carts are left alone.** A line item keeps its captured price when the source price
-  expires or the customer loses a role; the gem does not hook the order updater.
-  Rationale: matches core, which never re-prices line items on its own.
-- **Additive columns on `spree_prices`** plus a gem-owned price types table, rather than a
-  sidecar `price_details` table or a parallel prices table.
-  Rationale: the selector stays a single joinable query and eligibility becomes composable AR
-  scopes, instead of the LEFT-OUTER-JOIN dance a sidecar would force on every lookup.
-- **`price_type_id` is NOT NULL**; the install migration seeds a `default` type and backfills
-  every existing price into it.
-  Rationale: "every price has a type" is a far easier invariant to hold than "nil is secretly a
-  type", and admins see a real name in the UI.
-- **Filter first, then cheapest wins.** Currency, window and role visibility narrow the
-  candidates; country specificity picks the bucket; the lowest amount wins within it.
-  Rationale: core treats country as specificity, not competition — a `nil`-country fallback must
-  not undercut a deliberate country-specific price.
-- **One `role_id` per price, modeled on `country_iso`** — nullable FK to `spree_roles`, `nil`
-  meaning every customer including guests. No join table, no exclusion.
-  Rationale: matches how country already works, removes a table and with it an N+1 preloading
-  problem, and makes `role_id` a plain indexed column `with_prices` can filter in SQL.
-  Cost: "everyone except role X" is no longer expressible.
-- **Role is eligibility only, not specificity.** A role match qualifies a customer to see a
-  price; among everything visible, cheapest wins after country specificity.
-  Rationale: chosen over "role beats country" and "country beats role". Consequence: a
-  role-targeted price set above the untargeted price never applies.
-- **`price_type_id` and `role_id` are `desired_attributes`; `at` and `customer_role_ids` are
-  not.** Rationale: core calls `prices.build(default_price_attributes)`, so every key in that
-  hash must be an assignable `Spree::Price` column. The first two are columns; the contextual
-  filters are not.
-- **Five price types ship seeded**: `default`, `wholesale`, `sale`, `clearance`, `employee`,
-  seeded idempotently by `code`. Only `default` is structural and guarded; the rest are
-  editable and discardable conveniences.
-  Rationale: a store gets a usable vocabulary on install instead of an empty table, and the
-  names document the intended use cases. Consequence recorded above: a type name conveys no
-  access control — `employee` without `role_id` is visible to everyone.
-- **Customer roles are narrowed to pricing-relevant roles** before they reach the cache key.
-  Rationale: selection is unaffected (a role no price references can never match), but cache
-  cardinality drops from every role combination in the store to just combinations of roles
-  actually used in pricing.
-- **`admin_notes` text column on `spree_prices`** for internal commentary ("Labor Day Sale 2025",
-  "Overstock Sale of 2012"), never rendered to customers.
-  Rationale: makes historical prices legible years after whoever created them left.
-- **solidus_admin scope is price types CRUD only.** Per-variant price management stays in the
-  legacy backend.
-  Rationale: the new admin has no price management at all — `Products::Show` exposes a single
-  `f.text_field(:price)` writing through `DefaultPrice`, with no prices index, form or route.
-  Building that screen is a larger project than this feature and would guess at a design
-  upstream has not landed.
-- **The API passes explicit pricing options** rather than inheriting `current_pricing_options`.
-  Rationale: core builds those `from_context`, which reads `current_spree_user`; on an
-  admin-token request that would silently filter storefront prices by the admin's roles.
-- **Promotions were investigated and set aside.** `solidus_promotions` already ships
-  `Benefits::AdvertisePrice`, price-level conditions (`PriceProduct` / `PriceTaxon` /
-  `PriceOptionValue`), `Conditions::UserRole`, `PricePatch` (`discounts` / `discounted_amount`)
-  and `ProductAdvertiser`. Not adopted because: a promotion *discounts* a price rather than
-  replacing it (wrong semantics for B2B — it leaks retail and reports as promotional revenue);
-  `Conditions::UserRole` implements only `order_eligible?` with `any`/`all` policies, so there
-  is no price-level or exclude form; `ProductAdvertiser` is never invoked by Solidus and needs
-  an order, which is awkward on catalog pages and for guests; and promotions have no concept of
-  a price type at all. Revisit for time-boxed sale pricing, which the promotion engine does
-  better.
-
-### Superseded during the brainstorm
-
-Kept so the reasoning trail survives; do not implement these.
-
-- *Role rules in a join table with a `restrict` / `exclude` mode column.* Superseded by the
-  single `role_id` column. Exclusion went with it.
-- *Contextual filters as tri-state, where `nil` means "ignore this filter".* Superseded once
-  role became eligibility-only: `nil` and `[]` became indistinguishable for
-  `customer_role_ids`, and an `at` of `nil` would have made an admin lookup pick arbitrarily
-  between an expiring price and its replacement. Both now take plain defaults
-  (`[]` and `Time.current`).
-- *A `priority` column on price types driving selection.* Superseded by cheapest-wins;
-  `position` survives as a tie-breaker and admin sort order only.
-
-## Context gathered
-
-- Local Solidus checkout: `4.8.0.dev` (`~/RubymineProjects/solidus`), minimum Rails 7.2.
-- Ruby 3.3.10, Bundler 4.0.16.
-- Relevant core seams:
-  - `Spree::Price` — `core/app/models/spree/price.rb`
-  - `Spree::Variant::PricingOptions` — `desired_attributes`, built `from_line_item`,
-    `from_price`, `from_context`
-  - `Spree::Variant::PriceSelector#price_for_options` — already pluggable
-  - `Spree::Config.variant_price_selector_class`, which core delegates
-    `pricing_options_class` from
-  - `Spree::DefaultPrice` — `default_price` routes through the same selector, and
-    `default_price_or_build` calls `prices.build(default_price_attributes)`
-  - `Spree::Variant.with_prices` — checks only currency and country; needs overriding
-  - `Spree::Role` / `Spree::RoleUser` — `has_many :users, through: :role_users`