yaml_exporter 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11669d9671c43a7dced493565d65af864c3e0b61ba583c40b678f547dc952796
-  data.tar.gz: 2f235b07235119bffc293e3030bbeaedfb8f4eca263ef921d0076a83bf658e0c
+  metadata.gz: 6c15fc079f4444a43a53ea849f8ff86162074ace88cc884ed28bef127a59afc0
+  data.tar.gz: 6b51f04b4712e71f1840c61fb323be7127b133e561afaaafcd81f9e382f7919b
 SHA512:
-  metadata.gz: 29676b99c64faa28c7e70fddd67fb1376fe9d0ff1bf1657318197367021313164048eb8e75d8ff7e6cbb90b0eba48bbc71ee7aa3fe8ab32bc23e431adc6a8d0b
-  data.tar.gz: 618c63aa98999137b72d3dfc030cb9d861f29a60c333671d58fa21e71974ced9041dd10a6d2c49176669c627d9edca92a19965743945682225e807bffe8f41ef
+  metadata.gz: 4beae00561aeb8d7da659b6b3b578cb9e9aa95bfcd2d266a63bc9fb0e98a6a6f1310cd73801edc03125fb3c831b6a730458165b56549067a0b5a5eb276a114a8
+  data.tar.gz: 19dfc281188c17041c1d822422b1eb07f11aea06525ba042b261f016945e664ae40ac272e10246f280fbe5c70d1b0f3633a809ec4cb9ea4363eb6563ddf2dc8e

data/.github/workflows/gem-push.yml

@@ -1,36 +1,27 @@
-name: Ruby Gem
+name: Push gem
 
+# Publishes to RubyGems when you publish a GitHub Release (tag `vX.Y.Z`).
+# Uses RubyGems Trusted Publishing (OIDC) — no API key stored as a secret.
+# One-time setup: on rubygems.org -> the gem -> Trusted Publishers -> add a
+# GitHub Actions publisher for this repo with workflow `gem-push.yml`.
+# See RELEASING.md.
 on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
+  release:
+    types: [published]
 
 jobs:
-  build:
-    name: Build + Publish
+  push:
     runs-on: ubuntu-latest
     permissions:
-      contents: read
-      packages: write
-
+      contents: write   # let the action attach a build-provenance attestation to the release
+      id-token: write   # required for Trusted Publishing (OIDC)
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby 3.3.x
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.3.4
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - run: bundle exec rake test
+      # Verifies the tag matches lib/yaml_exporter/version.rb, builds, attests,
+      # and pushes via trusted publishing.
+      - uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: [main, find_by]
+  # No branch filter — run on every PR, including ones targeting `find_by`,
+  # so a change is tested before it is merged onto its base branch.
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', '3.4', '4.0']
+
+    steps:
+      - uses: actions/checkout@v4
+      # Resolve a fresh lockfile so each Ruby gets a compatible dependency set.
+      - run: rm -f Gemfile.lock
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/AGENTS.md

@@ -0,0 +1,34 @@
+# AGENTS.md
+
+## Cursor Cloud specific instructions
+
+### Project overview
+
+`yaml_exporter` is a Ruby gem that provides YAML serialization/deserialization for ActiveRecord models with JSON schema generation. It is a library (not a runnable application) — there are no servers, databases, or background services to run.
+
+### Ruby version management
+
+Ruby is managed via **rbenv** (installed at `~/.rbenv`). The project targets the latest stable Ruby — currently **4.0.2**.
+
+If a future Ruby version is needed and `rbenv install <version>` fails with "definition not found", update ruby-build first:
+
+```bash
+cd ~/.rbenv/plugins/ruby-build && git pull
+rbenv install <version>
+rbenv global <version>
+```
+
+Then re-run `bundle install` in the workspace.
+
+### Key commands
+
+| Task                 | Command                                                     |
+| -------------------- | ----------------------------------------------------------- |
+| Install dependencies | `bundle install`                                            |
+| Build the gem        | `gem build yaml_exporter.gemspec`                           |
+| Verify the gem loads | `ruby -e 'require_relative "lib/yaml_exporter"; puts "OK"'` |
+
+### Notes
+
+- The gem depends on `activerecord`, `activesupport`, and `json-schema` at runtime. For manual testing, `sqlite3` is also needed (`gem install sqlite3`).
+- The gemspec uses `git ls-files` to determine included files — new files must be tracked by git to be included in builds.

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project are documented here.
+This project follows [semantic versioning](https://semver.org).
+
+## Unreleased
+
+## v0.2.1
+
+### Added
+
+- `of:` on `many` reference lists. Both `many :assoc, find_by: :col, of: :nested`
+  and the `through:` flavor `many :assoc, through: :join, find_by: :col, of: :nested`
+  now identify each target indirectly via a 1:[0,1] association on the target
+  (`of:`), mirroring the existing `one … find_by: of:` semantics. The YAML stays
+  a flat list of the related model's `find_by` values (e.g. user slugs) instead
+  of requiring a nested block of hashes.
+
+## v0.2.0
+
+A ground-up rewrite of the export/import engine and its DSL. **Breaking: nothing
+from 0.1.0 carries over** — the module, the entry points, and the mapping API are
+all new. See the README for the full DSL.
+
+### Changed (breaking)
+
+- **New mixin API.** `include YamlExporter` in the model and declare the mapping
+  in a `yaml_structure do … end` block; round-trip with the instance methods
+  `#yaml_export` / `#yaml_import`. This replaces 0.1.0's
+  `YamlSerializable::YamlExporter.export(object, structure)` / `.import` class
+  methods that took an externally built structure — the `YamlSerializable`
+  module no longer exists.
+- **Ownership-driven DSL.** The mapping is three methods — `attributes`, `one`,
+  `many` — where shape decides ownership: a **block** owns the record
+  (YamlExporter creates, updates, and destroys records to match the YAML), while
+  **`find_by:` without a block** only resolves a reference and never creates or
+  destroys the target.
+
+### Added
+
+- `one` associations in three forms: owned (`one :x do … end`), a plain
+  reference (`one :x, find_by:`), and `one_reference_of` to reach a relation's
+  single record.
+- `many` associations: owned lists, `find_by:` reference lists, positional
+  lists, `positioned_by:` ordering, and `many … through:` (with or without a
+  block).
+- Export omits `nil` attributes by default (`yaml_export(omit_nil:)`).
+- Text columns export as YAML multiline block scalars, with surrounding
+  whitespace stripped and emojis preserved.
+- Column-based type inference and a JSON-schema-style description of a structure
+  via `.yaml_schema`.
+
+### Docs
+
+- Rewritten README covering the mental model (cardinality × ownership) and every
+  DSL form.

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    yaml_exporter (0.2.1)
+      activerecord (>= 5.2)
+      activesupport (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.1.3)
+      activesupport (= 8.1.3)
+    activerecord (8.1.3)
+      activemodel (= 8.1.3)
+      activesupport (= 8.1.3)
+      timeout (>= 0.4.0)
+    activesupport (8.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    concurrent-ruby (1.3.7)
+    connection_pool (3.0.2)
+    drb (2.2.3)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    json (2.21.1)
+    logger (1.7.0)
+    minitest (5.27.0)
+    rake (13.4.2)
+    securerandom (0.4.1)
+    sqlite3 (2.9.5-aarch64-linux-gnu)
+    sqlite3 (2.9.5-aarch64-linux-musl)
+    sqlite3 (2.9.5-arm-linux-gnu)
+    sqlite3 (2.9.5-arm-linux-musl)
+    sqlite3 (2.9.5-arm64-darwin)
+    sqlite3 (2.9.5-x86-linux-gnu)
+    sqlite3 (2.9.5-x86-linux-musl)
+    sqlite3 (2.9.5-x86_64-darwin)
+    sqlite3 (2.9.5-x86_64-linux-gnu)
+    sqlite3 (2.9.5-x86_64-linux-musl)
+    timeout (0.6.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.1.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  sqlite3 (>= 1.4)
+  yaml_exporter!
+
+CHECKSUMS
+  activemodel (8.1.3) sha256=90c05cbe4cef3649b8f79f13016191ea94c4525ce4a5c0fb7ef909c4b91c8219
+  activerecord (8.1.3) sha256=8003be7b2466ba0a2a670e603eeb0a61dd66058fccecfc49901e775260ac70ab
+  activesupport (8.1.3) sha256=21a5e0dfbd4c3ddd9e1317ec6a4d782fa226e7867dc70b0743acda81a1dca20e
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  bigdecimal (4.1.2) sha256=53d217666027eab4280346fba98e7d5b66baaae1b9c3c1c0ffe89d48188a3fbd
+  concurrent-ruby (1.3.7) sha256=4412caec3a5ea2e5fdc52076724c071a81f2c0593d83b2ac8cbb8ca63b3151b0
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
+  i18n (1.15.2) sha256=00f9eb62412fe593b2a65a97daa75300d37abb8f7202ec748e94b6d46a9dd1b5
+  json (2.21.1) sha256=13a43df75d95641443f5702dff350f237164a9d811ff0f2c2800d4d980220583
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  sqlite3 (2.9.5-aarch64-linux-gnu) sha256=78075b6337d3d182c6d2b4691049ed45cd220826160c9ea18946bf6a1de200dc
+  sqlite3 (2.9.5-aarch64-linux-musl) sha256=18c801185deb4adc01ddb281e8f672a39e3d1729979ca91e39439cd3eac0402d
+  sqlite3 (2.9.5-arm-linux-gnu) sha256=1bdfca0c7d63998c60b0f4a8e3c8df2d33800ccc4abd2d612eddbbbc92a4c48b
+  sqlite3 (2.9.5-arm-linux-musl) sha256=bae1109d12b2e9f588455967729b008e1ff4feb7761749df695019c9079913c6
+  sqlite3 (2.9.5-arm64-darwin) sha256=d0cf444a70fc9395d513cfbcc1e6719e224aa645314e3824cb0474c721425aa2
+  sqlite3 (2.9.5-x86-linux-gnu) sha256=c94b96b16f17796be6fa099d15218b52e396f55690c4760faaaefa21ebab9dd5
+  sqlite3 (2.9.5-x86-linux-musl) sha256=063a8c13cbadfe7f29453b1706cbdf91fca4a78d244f816ff20bac4fb259f1e4
+  sqlite3 (2.9.5-x86_64-darwin) sha256=8e9caae38bd7ebb29cbeee3e7ab1d12dc2327d9a1b92c7fcf0dda05589627a81
+  sqlite3 (2.9.5-x86_64-linux-gnu) sha256=233dbcb6714148dd23bc5aeb33e8efd6eac974969564ddd5794c23d5f52b231e
+  sqlite3 (2.9.5-x86_64-linux-musl) sha256=e7d3a7474e8af0f96150c21abc203fbab5437206bfcdf11deab7741c0ca516f2
+  timeout (0.6.1) sha256=78f57368a7e7bbadec56971f78a3f5ecbcfb59b7fcbb0a3ed6ddc08a5094accb
+  tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+  yaml_exporter (0.2.1)
+
+BUNDLED WITH
+  4.0.6