schema-model 0.7.4 → 0.9.0

data/lib/schema/parsers/string_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Schema
+  module Parsers
+    # Schema::Parsers::StringValue is the shared string handling for parsers
+    module StringValue
+      # strips the string, returns nil when it's blank, and otherwise yields it; a nil result
+      # or an ArgumentError (e.g. Date::Error) from the block is recorded as invalid
+      def parse_string_value(field_name, parsing_errors, value)
+        str = value.strip
+        return nil if str.empty?
+
+        result = begin
+          yield str
+        rescue ArgumentError
+          nil
+        end
+        parsing_errors.add(field_name, ::Schema::ParsingErrors::INVALID) if result.nil?
+        result
+      end
+    end
+  end
+end

data/lib/schema/parsing_status.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Schema
+  # Schema::ParsingStatus reports whether a model parsed cleanly, and raises at an explicit boundary
+  module ParsingStatus
+    def parsed?
+      parsing_errors.empty?
+    end
+
+    def parsed!
+      return if parsed?
+
+      raise ParsingException.new(
+        "schema parsing failed for attributes #{parsing_errors.attribute_names.join(', ')}",
+        self,
+        parsing_errors
+      )
+    end
+  end
+end

data/lib/schema/utils.rb

@@ -5,6 +5,14 @@ module Schema
   module Utils
     module_function
 
+    def check_parser!(model, parser, field_name, type)
+      return if model.respond_to?(parser)
+
+      raise ::Schema::UnknownTypeError,
+            "unknown type #{type.inspect} for #{model.class.name || model.class}##{field_name}: " \
+            "no #{parser} method (schema_include the parser module that defines it)"
+    end
+
     def classify_name(name)
       name.gsub(/[^\da-z_-]/, '').gsub(/(^.|[_|-].)/) { |m| m[-1].upcase }
     end
@@ -14,6 +22,7 @@ module Schema
       kls = Class.new(options[:base_class] || Object)
       kls = base_schema_class.const_set(options[:class_name], kls)
       include_schema_modules(kls, base_schema_class.schema_config) unless options[:base_class]
+      kls.capture_unknown_attributes = base_schema_class.capture_unknown_attributes?
       kls
     end
 
@@ -56,6 +65,24 @@ module Schema
       kls.send(:include, ::Schema::Associations::DynamicTypes)
     end
 
+    # copies nested models and collections so the copy can be changed without touching the original
+    def deep_dup_value(value)
+      case value
+      when ::Schema::Model then value.deep_dup
+      when ::Array then value.map { |element| deep_dup_value(element) }
+      when ::Hash then value.to_h { |key, element| [key, deep_dup_value(element)] }
+      when ::String then value.frozen? ? value : value.dup
+      else value
+      end
+    end
+
+    # [attribute, message] pairs from Schema::Errors or ActiveModel::Errors
+    def parsing_error_pairs(errors)
+      return errors.map { |error| [error.attribute, error.message] } unless errors.is_a?(::Schema::Errors)
+
+      errors.errors.flat_map { |attribute, messages| messages.map { |message| [attribute, message] } }
+    end
+
     # each call gets its own copy so callers can't mutate the shared default
     def copy_default(value)
       return value if value.frozen?

data/lib/schema/version.rb

@@ -2,5 +2,5 @@
 
 module Schema
   # Gem version, bumped by release-please
-  VERSION = '0.7.4'
+  VERSION = '0.9.0'
 end

data/lib/schema-model.rb

@@ -18,14 +18,21 @@ module Schema
   class ParsingException < SchemaException; end
   class ValidationException < SchemaException; end
 
+  # raised when a value is assigned to an attribute whose type has no parse_<type> method
+  class UnknownTypeError < StandardError; end
+
   autoload :ActiveModelValidations, 'schema/active_model_validations'
   autoload :All, 'schema/all'
+  autoload :ActiveModelParsingErrors, 'schema/active_model_parsing_errors'
   autoload :ArrayHeaders, 'schema/array_headers'
   autoload :Arrays, 'schema/arrays'
+  autoload :AttributeValues, 'schema/attribute_values'
   autoload :CSVParser, 'schema/csv_parser'
+  autoload :DeepCopy, 'schema/deep_copy'
   autoload :Errors, 'schema/errors'
   autoload :Model, 'schema/model'
   autoload :ParsingErrors, 'schema/parsing_errors'
+  autoload :ParsingStatus, 'schema/parsing_status'
   autoload :Utils, 'schema/utils'
 
   # Schema::Parsers are used to convert values into the correct data type
@@ -35,6 +42,7 @@ module Schema
     autoload :Common, 'schema/parsers/common'
     autoload :Hash, 'schema/parsers/hash'
     autoload :Json, 'schema/parsers/json'
+    autoload :StringValue, 'schema/parsers/string_value'
   end
 
   # Schema::Associations mange the associations between schema models

data/lib/schema_validator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# SchemaValidator validates nested schemas
+# SchemaValidator validates nested schemas: each one must have no parsing errors and pass its validations
 class SchemaValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     record.errors.add(attribute, options.fetch(:message, :invalid)) unless valid_schema?(value)
@@ -11,12 +11,13 @@ class SchemaValidator < ActiveModel::EachValidator
   def valid_schema?(value)
     return true unless value
 
-    if value.is_a?(Array)
-      value.all? do |schema|
-        !schema || schema.valid?
-      end
-    else
-      value.valid?
-    end
+    schemas = value.is_a?(Array) ? value.compact : [value]
+    # map before all? so every nested schema runs its validations and has its errors filled in
+    schemas.map { |schema| parsed_and_valid?(schema) }.all?
+  end
+
+  def parsed_and_valid?(schema)
+    valid = schema.valid?
+    valid && schema.parsed?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema-model
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Doug Youch
@@ -34,23 +34,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/release.yml"
-- ".gitignore"
-- ".release-please-manifest.json"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
-- ARCHITECTURE.md
 - CHANGELOG.md
-- CLAUDE.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - bin/schema-json2csv
 - lib/schema-model.rb
+- lib/schema/active_model_parsing_errors.rb
 - lib/schema/active_model_validations.rb
 - lib/schema/all.rb
 - lib/schema/array_headers.rb
@@ -60,7 +49,9 @@ files:
 - lib/schema/associations/has_many.rb
 - lib/schema/associations/has_one.rb
 - lib/schema/associations/schema_creator.rb
+- lib/schema/attribute_values.rb
 - lib/schema/csv_parser.rb
+- lib/schema/deep_copy.rb
 - lib/schema/errors.rb
 - lib/schema/model.rb
 - lib/schema/parsers/american.rb
@@ -68,19 +59,20 @@ files:
 - lib/schema/parsers/common.rb
 - lib/schema/parsers/hash.rb
 - lib/schema/parsers/json.rb
+- lib/schema/parsers/string_value.rb
 - lib/schema/parsing_errors.rb
+- lib/schema/parsing_status.rb
 - lib/schema/utils.rb
 - lib/schema/version.rb
 - lib/schema_validator.rb
-- release-please-config.json
-- schema-model.gemspec
-- script/console
-- script/coverage_badge.rb
 homepage: https://github.com/dougyouch/schema
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/dougyouch/schema
+  changelog_uri: https://github.com/dougyouch/schema/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/dougyouch/schema/issues
 rdoc_options: []
 require_paths:
 - lib

data/.github/dependabot.yml

@@ -1,18 +0,0 @@
-version: 2
-updates:
-  # keeps the SHA-pinned actions in .github/workflows current
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: weekly
-    commit-message:
-      prefix: ci
-      include: scope
-
-  - package-ecosystem: bundler
-    directory: /
-    schedule:
-      interval: weekly
-    commit-message:
-      prefix: build
-      include: scope

data/.github/workflows/ci.yml

@@ -1,93 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [master]
-  # release-please PRs change only these files. Their runs are triggered by
-  # github-actions[bot], which GitHub holds for approval until they expire as
-  # failures; release.yml runs this workflow before publishing anyway. A PR is
-  # skipped only if every file it changes is listed here.
-  pull_request:
-    paths-ignore:
-      - CHANGELOG.md
-      - .release-please-manifest.json
-      - lib/schema/version.rb
-  workflow_call:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: ci-${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
-
-jobs:
-  lint:
-    name: RuboCop
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          persist-credentials: false
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: '4.0'
-          bundler-cache: true
-      - run: bundle exec rubocop --format github
-
-  # Runs on the Ruby in .ruby-version, the version Gemfile.lock is resolved against
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          persist-credentials: false
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          # no ruby-version: setup-ruby reads .ruby-version
-          bundler-cache: true
-      - run: bundle exec rspec
-      # feeds the coverage badge
-      - name: Upload coverage report
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
-        with:
-          name: coverage
-          path: coverage/
-          # .last_run.json (read by the badge job) is a dotfile; upload-artifact skips those by default
-          include-hidden-files: true
-          retention-days: 14
-
-  # Publishes coverage.svg and branches.svg to the orphan `badges` branch; the README badges point at them.
-  # Skipped when called from release.yml (github.workflow is the caller's name there).
-  coverage-badge:
-    if: github.workflow == 'CI' && github.event_name == 'push' && github.ref == 'refs/heads/master'
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: '4.0'
-      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: coverage
-          path: coverage/
-      - run: |
-          ruby script/coverage_badge.rb coverage/.last_run.json "$RUNNER_TEMP/coverage.svg"
-          ruby script/coverage_badge.rb coverage/.last_run.json "$RUNNER_TEMP/branches.svg" branch
-      - name: Push badge to badges branch
-        run: |
-          git config user.name 'github-actions[bot]'
-          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          if git fetch --depth=1 origin badges; then
-            git switch badges
-          else
-            git switch --orphan badges
-          fi
-          cp "$RUNNER_TEMP/coverage.svg" "$RUNNER_TEMP/branches.svg" .
-          git add coverage.svg branches.svg
-          git diff --cached --quiet || git commit -m "coverage badge for ${GITHUB_SHA::7}"
-          git push origin badges

data/.github/workflows/release.yml

@@ -1,93 +0,0 @@
-name: Release
-
-# release-please keeps a release PR open that bumps lib/schema/version.rb
-# and CHANGELOG.md from conventional commits. Merging it tags the release,
-# creates the GitHub release and publishes the gem to RubyGems.
-# Run it manually (workflow_dispatch) to retry publishing the current version.
-on:
-  push:
-    branches: [master]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: release
-  cancel-in-progress: false
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write # release commits, tags and GitHub releases
-      issues: write # release labels
-      pull-requests: write # the release PR
-    outputs:
-      release_created: ${{ steps.release.outputs.release_created }}
-      tag_name: ${{ steps.release.outputs.tag_name }}
-      version: ${{ steps.release.outputs.version }}
-      pr_branch: ${{ steps.release.outputs.pr && fromJSON(steps.release.outputs.pr).headBranchName || '' }}
-    steps:
-      - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
-        id: release
-        with:
-          config-file: release-please-config.json
-          manifest-file: .release-please-manifest.json
-
-  # The release PR is opened with GITHUB_TOKEN, which doesn't trigger CI on it,
-  # so run the suite here before anything is published.
-  ci:
-    needs: release-please
-    if: needs.release-please.outputs.release_created == 'true' || github.event_name == 'workflow_dispatch'
-    uses: ./.github/workflows/ci.yml
-    # ceiling for the called workflow: its coverage-badge job declares contents: write
-    # (skipped when called from here); lint/test still run with ci.yml's top-level contents: read
-    permissions:
-      contents: write
-
-  publish:
-    needs: [release-please, ci]
-    runs-on: ubuntu-latest
-    environment:
-      name: rubygems
-      url: https://rubygems.org/gems/schema-model
-    permissions:
-      contents: write # attach the gem to the GitHub release
-      id-token: write # RubyGems trusted publishing (OIDC)
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          # the new tag on release; the dispatched commit on a manual retry
-          ref: ${{ needs.release-please.outputs.tag_name || github.sha }}
-          persist-credentials: false
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: '4.0'
-
-      - name: Read version
-        run: |
-          version=$(ruby -e 'puts Gem::Specification.load("schema-model.gemspec").version')
-          echo "VERSION=$version" >> "$GITHUB_ENV"
-          echo "TAG=v$version" >> "$GITHUB_ENV"
-
-      - name: Build gem
-        run: gem build schema-model.gemspec
-
-      - uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0
-
-      # A version that's already on RubyGems is skipped, so a manual retry can finish a
-      # partially published release.
-      - name: Push gem
-        run: |
-          if curl -sf "https://rubygems.org/api/v2/rubygems/schema-model/versions/$VERSION.json" > /dev/null; then
-            echo "schema-model $VERSION is already published"
-          else
-            gem push "schema-model-$VERSION.gem"
-          fi
-
-      - name: Attach gem to GitHub release
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: |
-          gh release upload "$TAG" "schema-model-$VERSION.gem" --repo "$GITHUB_REPOSITORY" --clobber

data/.gitignore

@@ -1,51 +0,0 @@
-# rcov generated
-coverage
-coverage.data
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# bundler
-.bundle
-
-# jeweler generated
-pkg
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-.DS_Store
-
-# For TextMate
-#*.tmproj
-#tmtags
-
-# For emacs:
-*~
-\#*
-.\#*
-
-# For vim:
-*.swp
-
-# For redcar:
-#.redcar
-
-# For rubinius:
-#*.rbc
-
-*.gem

data/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.7.4"
-}

data/.rubocop.yml

@@ -1,68 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.2
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - 'vendor/**/*'
-    - 'coverage/**/*'
-
-# Relaxed metrics for existing codebase
-Metrics/MethodLength:
-  Max: 35
-
-Metrics/AbcSize:
-  Max: 40
-
-Metrics/ClassLength:
-  Max: 200
-
-Metrics/ModuleLength:
-  Max: 200
-
-Metrics/CyclomaticComplexity:
-  Max: 15
-
-Metrics/PerceivedComplexity:
-  Max: 15
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-    - '*.gemspec'
-
-# Style preferences
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-
-Layout/LineLength:
-  Max: 130
-  Exclude:
-    - 'spec/**/*'
-
-# File naming - allow hyphenated gem name
-Naming/FileName:
-  Exclude:
-    - 'lib/schema-model.rb'
-
-# DSL methods following ActiveRecord conventions (has_one, has_many)
-Naming/PredicatePrefix:
-  Exclude:
-    - 'lib/schema/associations/has_one.rb'
-    - 'lib/schema/associations/has_many.rb'
-    - 'lib/schema/associations/schema_creator.rb'
-
-# Dynamic eval is used for metaprogramming in this DSL gem
-Style/DocumentDynamicEvalDefinition:
-  Enabled: false
-
-# Short parameter names acceptable in simple setters
-Naming/MethodParameterName:
-  AllowedNames:
-    - v
-
-# Boolean parameters acceptable in internal methods
-Style/OptionalBooleanParameter:
-  Enabled: false

data/.ruby-gemset

@@ -1 +0,0 @@
-schema

data/.ruby-version

@@ -1 +0,0 @@
-ruby-4.0.7