fixture-riveter

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelogopen in new window.

Unreleasedopen in new window

Changed

  • Make explicit that overriding an attribute to undefined will leave the property entirely off the resulting object.
  • Allow overriding an attribute to null.
  • Set relations in attributeFor to null, not undefined.

v2.4.2open in new window

Changed

  • Updated Typescript to 4.3.x
  • Handle nested implicit attribute calls in definitions.

v2.4.1open in new window

Fixed

  • Update types filepath in package.json.

v2.4.0open in new window

Added

  • Add Mutation testing to CI.
  • Add Markdown linting to CI.

Changed

  • Remove Model parameter from nested fixture definitions. Defaults to parent fixture Model, or can be passed in through the options map with the optional key model.
  • Remove Sequence constructor and SequenceHandler.registerSequence overloads. Only implement Sequence-related overloads in DefinitionProxy and FixtureRiveter.
  • Make Sequence not generic, as it should not be used directly.
  • Change Sequence constructor to take aliases as an object instead of a list.
  • Allow for all arguments in sequence-creating functions to be passed in a single object alongside aliases:
    • aliases?: an array of strings (only available to global sequences)
    • callback?: a 1-arg function
    • initial?: a string or number, to use the default generators (excludes using gen)
    • gen?: a generator (excludes using initial)
  • Change all of the hierarchy-related names to adapterMethods:
    • DefinitionHeirarchy -> AdapterMethodBuilder
    • _heirarchyClass and hierarchyClass -> _adapterMethodsClass and adapterMethodsClass
    • _heirarchyInstance and hierarchyInstance -> _adapterMethodsInstance and adapterMethodsInstance
    • buildHierarchy -> setAdapterMethods
  • Change all of the callback-related names to hook:
    • Callback class -> Hook
    • CallbackFunction type -> Callback
    • addCallback -> registerHook

Fixed

  • Fix errors with evaluator being passed into the attribute fns.
  • Foreign key checking to SQLite in tests

v2.3.1open in new window

Changed

  • Only set attributes if they're not null or undefined.
  • Remove duplicate names from attributesForObject and attributesForInstance.

v2.3.0open in new window

Added

  • Global traitsForEnum callback through setTraitsForEnumCallback method on FixtureRiveter.
  • instance property on Evaluator which is the currently built object, for use in relations.

Changed

  • traitsForEnum accepts a callback that is applied to the value to create the trait name.
  • traitsForEnum global callback defaults to identity (no change on given string), and per invocation defaults to global if none is given.

Removed

  • Removed Definition's attributes array as the attribute are generated each call.

v2.2.0open in new window

Added

  • traitsForEnum method on DefinitionProxy.
  • Implement DefinitionHierarchy and setting specific adapter methods instead of creating a whole new clas.

Changed

  • Updated Typescript to 4.1.4.
  • Clean up attribute and callback getters, associated methods.
  • Throw error if getStrategy on StrategyHandler fails.
  • Move global getCallbacks to NullFixture. (Still unsure about this, but whatever.)
  • Move CI to Github Actions.

Removed

  • Removed NullStrategy, directly return undefined from attributeFor.

v2.1.0open in new window

Added

Changed

  • Move all default build method overloads to separate interfaces
  • Change fixture#run to fixture#prepare
  • Revert _methodMissing back to methodMissing
  • Enforce RelationAttribute fixture property being only an array
  • Clean up eslint rules, update @batterii/eslint-config-ts
  • Remove unnecessary type indirection from AdapterHandler
  • Switch mocharc to json.

Fixed

  • ObjectionAdapter: only call delete on instances that might be in the database, and wrap call in a try-catch for when we call it on instances that were constructed with build.
  • Make fixture property of Trait optional.

v2.0.0open in new window - 2021-01-29

Added

  • Expanded GUIDE

Changed

  • Convert association to relation to match Objection.js and TypeORM naming
  • Throw an error in optionsParser if given incorrect options
  • Change fixture: option to allow string array to match factory_botopen in new window specification

v1.7.0open in new window - 2021-01-28

Changed

  • Make Sequence generic on next return type

Fixed

  • Decouple inline sequences and globals as intended so internal sequences can share a name with global sequences

Removed

  • Inline sequences can no longer specify aliases

v1.6.0open in new window - 2021-01-28

Added

  • FixtureRiveter and DefinitionProxy sequence method overloads
  • FixtureRiveter run, runList, and registerStrategy method overloads
  • SequenceHandler registerSequence method overloads
  • numberGen and stringGen generators for use in Sequence

Changed

  • Callback return void or Promise<void>
  • methodMissing is now _methodMissing to further hide it
  • Add fixture option to override argument of associate methods
  • Rewrite FixtureRiveter's run method to enforce internal types
  • Completely rewrite Sequence to rely on generators instead of subclasses
  • Use implementation of Ruby's String#succ method for string sequence
  • Change Strategy base class to be concrete (stub implementation is same as attributeFor)

Removed

  • Remove IntegerSequence and StringSequence
  • Disallow defining multiple fixtures with the same name or aliases
  • Disallow defining multiple global sequences or sequences within a given fixture with the same name or aliases

v1.5.0open in new window - 2021-01-24

Added

  • FixtureRiveter fixture method overloads

v1.4.0open in new window - 2021-01-22

Changed

  • ObjectionAdapter calls insertFetch on save
  • ObjectionAdapter's associate properly sets the ids of both instances

v1.3.0open in new window - 2021-01-21

Added

  • Add typed overloads to DefinitionProxy methods attr and association
  • Add typed overloads to Evaluator method association
  • Allow fixture definitions to accept just a Model, deriving the fixture name implicitly

Changed

  • Rename callbackFunction type to CallbackFunction
  • Change DefinitionProxy and Evaluator attr and implicit attribute methods to properly type when they're attributes and when they're associations

Fixed

  • Readd source-map-support, oops

v1.2.0open in new window - 2021-01-20

Fixed

  • Include model properties in callback evaluator props

Removed

  • Remove unnecessary dev dependencies

v1.1.0open in new window - 2021-01-19

Changed

  • Make callbacks generic
  • Change input types of DefinitionProxy and Evaluator blocks to better match API

[v1.0.3] - 2021-01-19

Changed

  • Make adapter methods generic
  • Explicitly type internal methods
  • Add method overloads to DefinitionProxy methods
  • Type DefinitionProxy methods

v1.0.2open in new window - 2021-01-19

Changed

  • Switch strategy tubs to using helper types for consistency

v1.0.1open in new window - 2021-01-19

Fixed

  • Change fr.create method to return an array instead of a tuple

v1.0.0open in new window - 2021-01-15

Added

  • CI with CircleCI

Changed

  • Type block functions for fixture and trait definitions
  • Update arguments to stub strategy methods, fully type arguments and return

v0.4.0open in new window - 2020-09-17

Added

  • Add destroy method to adapters, allowing for ORM-specific clean up
  • Add cleanUp method to fr, which calls delete on all instances

Changed

  • Update arguments to stub strategy methods, basic types

v0.3.0open in new window - 2020-07-22

Changed

  • Make ObjectionAdapter upsert missing models

v0.2.0open in new window - 2020-07-22

Added

  • Add nested fixtures to guide
  • Write tests that cover code in guide
  • Allow transients to call properties by method

Fixed

v0.1.2open in new window - 2020-07-09

Changed

  • Fix repo url in package.json

v0.1.1open in new window - 2020-07-09

Changed

  • Moved tutorial to docs/GUIDE.md, expanded it

v0.1.0open in new window - 2020-07-09

Added

  • Barebones release of Fixture Riveter: fixtures, traits, associations
  • Barebones tutorial