Alembic

v4.0.0

Table of Contents generated with DocToc

Changelog

v4.0.0

Enhancements

  • #56 - @jeffutter

    • Update alembic to support Ecto 3.0

      • This required very minimal code changes, only updates to doctests

    • Dropping support for Ecto 2.x and Elixir < 1.7

      • These versions should still continue to work, but we don’t have matrix builds setup so we can’t guarantee backwards compatibility going forward

    • Update circle.yml

      • Erlang 21
      • Elixir 1.7.2
    • Introduce mix format and enforce it on CI

v3.4.0

Enhancements

  • #44 - @KronicDeth

    • Alembic.Document.from_ecto_changeset/2 converts the errors in ecto_changeset to Alembic.Error.t in a single Alembic.Document.t. Bypasses a bug in JaSerializer where it assumes all fields that don’t end in _id are attribute names, which leads to association names (as opposed to their foreign key) being put under /data/attributes. Alembic.Document.from_ecto_changeset reflects on the Ecto.Changeset.t data struct module to get the __schema__/1 information from the Ecto.Schema.t. It also assumes that if the field maps to no known attribute, association or foreign key, then the error should not have an Alembic.Source.t instead of defaulting to /data/attributes.

    • Update circle.yml

      • Erlang 19.3
      • Elixir 1.4.2

  • #45 - @KronicDeth

    • Alembic.Pagination.Page.count calculates the number of pages given the page size and the total_size of resources to be paginated.
    • Alembic.Pagination.Page.first returns the Alembic.Pagination.Page.t for the first for Alembic.Pagination.t given any page and the page count.
    • Alembic.Pagination.Page.last is the last page for Alembic.Pagination.t given any page and the page count.
    • Alembic.Pagination.Page.next is the next page after the current page. If page number matches count, then it must be the last page and so next will be nil.
    • Alembic.Paginaton.Page.previous is the previous page to the current page. If the page number is 1, then it is the first page, and the previous page is nil.
    • Alembic.Pagination.Page.to_pagination takes the current page and the total_size of resources to paginated and produces the Alembic.Pagination with first, last, next, and previous around that page. If page number is greater than the calculated page count {:error, Alembic.Document.t} is returned instead of {:ok, Alembic.Pagination.t}.
    • Alembic.FromJson.integer_from_json
    • Alembic.FromJson.integer_to_positive_integer takes an integer and returns it if positive, otherwise returns error Document if 0 or below.
    • Alembic.Pagination.Page.from_params parses param format with quoted integer page number and size or JSON format with integer page number and size.
    • Allow pagination opt-out with %{"page" => nil}. Alembic.Pagination.Page.from_params(%{"page" => nil}) will return {:ok, :all} while no "page" param will return {:ok, nil}.

    • Update dependencies

      • Update ex_doc to 0.16.1
      • Update excoveralls to 0.7.0
      • Update credo to 0.8.1
  • #46 - Use IntelliJ Elixir formatter for make the formatting consistent - @KronicDeth

  • #47 - @KronicDeth

    • Convert to CircleCI 2.0

      • Turn on workflows, so that build, which includes mix deps.get and mix compile is a dependency of all, but mix dialyze, mix docs, mix inch.report, and mix coveralls.circleci can run in parallel after it.
  • #48 - Wrap } after wrapped keys - @KronicDeth

  • #49

Bug Fixes

  • #45 - @KronicDeth

    • Allow next and previous to be nil in Pagination.t @type since they were already allowed to be nil in use for the last and first page, respectively.
    • Alembic.Pagination.Page number is pos_integer because non_neg_integer allows 0, but that’s not valid because number is 1-based, not 0-based.
    • Remove extra blank lines from @docs
    • Switch to github version of earmark to get bug fix in pragdave/earmark#144.
    • Remove spaces inside { }.

v3.3.0

Enhancements

  • #44 - @KronicDeth

    • Alembic.Document.from_ecto_changeset/2 converts the errors in ecto_changeset to Alembic.Error.t in a single Alembic.Document.t. Bypasses a bug in JaSerializer where it assumes all fields that don’t end in _id are attribute names, which leads to association names (as opposed to their foreign key) being put under /data/attributes. Alembic.Document.from_ecto_changeset reflects on the Ecto.Changeset.t data struct module to get the __schema__/1 information from the Ecto.Schema.t. It also assumes that if the field maps to no known attribute, association or foreign key, then the error should not have an Alembic.Source.t instead of defaulting to /data/attributes.

    • Update circle.yml

      • Erlang 19.3
      • Elixir 1.4.1

Bug Fixes

  • #43 - @KronicDeth

    • Allow Alembic.Error.t source to be nil
    • Lower minimum coverage because coverage number varies from run to run.

v3.2.0

Enhancements

  • #42 - @KronicDeth

    • Switch from coverex to excoveralls, so coverage data can be published to Coveralls.io.

    • Update dependencies

      • ex_doc to 0.15.1
      • inch_ex to 0.5.6
      • ecto to 2.1.4
      • junit_formatter to 1.3.0
      • credo to 0.7.3
    • Allow poison to include ~> 3.0

Bug Fixes

v3.1.1

Bug Fixes

  • #41 - @KronicDeth

    • Allow atom for Alembic.Error.t :meta value as atom is used for "action" and "sender" values in error templates.
    • Alembic.Source.t needs to be clarified to show that either the :parameter is a String.t and :pointer is nil OR :parameter is nil and :pointer is a JSON pointer.

v3.1.0

Enhancements

  • #40 - Alembic.Fetch.from_params, in addition to parsing out the includes will not also parse out the sorts in the "sort" parameter using Alembic.Fetch.Sorts.from_params. To transform the Alembic.Fetch.Sorts.t back to the string format in "sort", you can use Alembic.Fetch.Sorts.to_string/1. - @KronicDeth

Bug Fixes

  • #40 - Change :include to :includes in the @typedoc for Alembic.Fetch.t - @KronicDeth

v3.0.0

Enhancements

  • #39 - @KronicDeth

    • Update dependencies

      • credo to 0.5.2
      • ex_doc to 0.14.3
      • inch_ex to 0.5.5
      • junit_formatter to 1.1.0
    • Build with Erlang 19.1 and Elixir 1.3.4 on CircleCI.

Bug Fixes

  • #39 - @KronicDeth

    • Ecto 2.1 makes the warning about cast/4 instead of cast/3 noisy, but Ecto 1.X had the opposite warning to use cast/4 instead of cast/3, so use cast/3.
    • Fix all Erlang 19.1 dialyzer warnings.

Incompatible Changes

  • #39 - Drop Ecto 1.0 since Ecto 1.0’s cast/3 is different than Ecto 2.0’s cast/3. - @KronicDeth

v2.4.0

Enhancements

  • #38 - CodeClimate just added credo support to their beta engines channel. Running on CodeClimate will allow the credo tests to run in parallel with CircleCI, leading to faster overall build times. - @KronicDeth

v2.3.0

Enhancements

  • #32 - Alembic.Pagination.to_links/2 allows converting Alembic.Pagination.t from Alembic.Links.to_pagination back to Alembic.Links.t with urls. - @KronicDeth

  • #33 - @KronicDeth

    • Update coverex to 1.4.10
    • Update credo to 0.4.11
    • Update ecto to 2.0.5
    • Update hackney to 1.6.1
    • Update httpoison to 0.9.1
    • Update inch_ex to 0.5.4

    • Update junit_formatter to 1.1.0

      • JUnit output location changed from _build/test/test-junit-report.xml to _build/test/lib/alembic/test-junit-report.xml

Bug Fixes

v2.2.0

Enhancements

  • #31 - @KronicDeth

    • Update ex_doc to 0.12.0
    • Update credo to 0.4.5
    • Update ecto to 2.0.2. Compatibility range is changed from ~> 1.1 to ~> 1.1 or ~> 2.0, so no incompatibility is introduced for runtime dependencies.

v2.1.1

Bug Fixes

v2.1.0

Enhancements

  • #27 - Add more doctests to Alembic.ToParams.nested_to_foreign_keys - @KronicDeth

    • nil for the nested parameters converts to a nil foreign key parameter
    • When the nested parameters are not even present, the foreign key won’t be added *has_many nested params are unchanged

Bug Fixes

v2.0.1

Bug Fixes

  • #25 - Documentation formatting - @KronicDeth

    • Wrong number of spaces and missing closing backquotes led to some doctests not being rendered correctly.

    • Fix docs for FromJson.from_json callback

      • Use <name> :: <type> format for parameters, so they don’t appear as arg0 and arg1 in the generated docs.
      • Use those names in the Paramaters section and code block teh format of the error template.

v2.0.0

Enhancements

  • #10 - ToEctoSchema and ToParams - @KronicDeth

  • #11 - Parse include params - @KronicDeth

    • Alembic.Fetch.from_params can extract and normalize params for controlling JSON API fetching into an %Alembic.Fetch{}.
    • Alembic.Fetch.Includes.to_preloads can convert the normalized includes to a list of preloads for Ecto.Repo.preload or Ecto.Query.preload.
    • Alembic.Fetch.to_query will add the preloads for %Alembic.Fetch{} includes to a query.

  • #12 - Fetch.Include.preload and preload_by_include types - @KronicDeth

    • Use Fetch.Include.preload and preload_by_include types types instead of generic term and map.
  • #14 - Allow jsonapi field in Document.t, so that jsonapi can be set to %{ "version" => "1.0" } to match JaSerializer output. - @KronicDeth
  • #15 - ToParams.nest_to_foreign_keys/2 converts nested parameters for belongs_to associations to a foreign key parameter. - @KronicDeth
  • #16 - Check for “Closing unclosed backquotes” from mix docs on CircleCI - @KronicDeth

  • #17 - Pagination - @KronicDeth

    • Pagination.Page can store the page[number] and page[size] from a URI.
    • Link.to_page can convert a URL to an Pagination.Page
    • Pagination can store the first, last, next, and previous Pagination.Pages
    • Document.to_pagination will extract the first, last, and next, and previous Pagination.Page from the "first", "last", "next", and "prev" top-level links. The total_size will be extracted from the top-level meta "record_count". This gives compatibility with the paged paginator in JSONAPI::Resources with config.top_level_meta_include_record_count = true.

  • #18 - Document.error_status_consensus - @KronicDeth

    • Document.error_status_consensus(document :: Document.t) :: String.t returns the consensus Error.t status for all the errors in the document. If there are no errors or statuses, then it is nil; otherwise, the consensus is the status shared between all (non-nil) errors or the max 100s status. For example, "404" and "422" would have a consensus of "400" because 400 covers both errors. For "404" and "500" the consensus would be "500" because "500" is more serious than any 4XX error.

  • #20 - Indirect relationships - @KronicDeth

    • ToEctoSchema.to_ecto_schema(params, module) recursively converts nested params to the associated structs
    • Fetch.Includes.to_string will take a list of includes and convert it back to the common-separated string format used by JSONAPI query parameters.

  • #23 - Allow Poison ~> 1.5 or ~> 2.0 - @KronicDeth

    • Allow compatibility with projects that haven’t upgraded to Poison 2.0. Nothing in the Poison.Encoder implementations is 2.0 specific, so allow both major versions.

Bug Fixes

  • #10 - ToEctoSchema and ToParams - @KronicDeth

    • Use Alembic.ResourceIdentifier.t in Alembic.Relationship.t for data’s value type.
    • Use Alembic.Meta.t in Alembic.Relationship.t for meta’s value type.

  • #13 - @KronicDeth

    • Use :unset instead of nil for unset %Alembic.Document{} data as it was too difficult to properly infer when nil was unset and when it was a singleton that was not present.
    • Alembic.Resource.to_params now treats nil %Alembic.Resource{} attributes as %{} when building the params so invalid input from user does not cause an exception.
  • #14 - Don’t encode ResourceIdentifier.meta when it is nil, so that "meta":null doesn’t occur in the encoded version. - @KronicDeth
  • #16 - Add missing backquotes - @KronicDeth

  • #19 - @KronicDeth

    • Resource.to_ecto_schema now ignores relationships that don’t map to known associations, which manifested as an ArgumentError to String.to_existing_atom.
    • Resource.to_ecto_schema only sets the foreign key when the relationship is present, which prevent running nil.id.

  • #20 - Indirect relationships - @KronicDeth

    • to_params and to_ecto_schema properly handles indirect relationships.

  • #21 - Fix deprecation warnings for Ecto 1.1 - @KronicDeth

  • #22 - Represent no relationship data different than null data - @KronicDeth

    • Like Document, Relationship needs to differentiate between "data":null in the JSON and no data key at all, so have Relationship.t default to :unset instead of nil, the same way Document.t works now. This means adding a Poison.Encoder implementation to not encode the :unset and changing the ToParams behaviour to allow for an {:error, :unset} return that the Relationship.to_params can return when data is :unset, so that Relationships.to_params will skip including the output in the map of all relationship params.

Incompatible Changes

  • #10 - ToEctoSchema and ToParams - @KronicDeth

    • Removed the Alembic.Relationship.resource_identifier type that was made obsolete by Alembic.ResourceIdentifier.t
    • Updating relations by nesting attributes is no longer supported as it is not supported in the JSONAPI spec.
  • #17 - Make Link.href_from_json private as it should have alway been. - @KronicDeth

  • #20 - Indirect relationships - @KronicDeth

    • ToParams behaviour now requires to_params/3 in addition to to_params/2

    • Remove to_ecto_schema/3 that are no longer called because of recursion in ToEctoSchema.to_ecto_schema/2

      • Relationship
      • Relationships
      • ResourceIdentifier
      • ResourceLinkage

v1.0.0

Enhancements

  • #1 - @KronicDeth

    • CircleCI build setup
    • JUnit formatter for CircleCI’s test output parsing

  • #2 - @KronicDeth

    • mix test --cover with CoverEx
    • Archive coverage reports on CircleCI

  • #3 - @KronicDeth

    • Use ex_doc and earmark to generate documentation with mix docs
    • Use mix inch (--pedantic) to see coverage for documentation

  • #4 - @KronicDeth

    • Add repository to hexfaktor, so that outdated hex dependencies are automatically notified through CI.
    • Add hexfaktor badge to README.md

  • #5 - @KronicDeth

    • Configure mix credo to run against lib and test to maintain consistency with Ruby projects that use rubocop on lib and spec.
    • Run mix credo --strict on CircleCI to check style and consistency in CI

  • #6 - @KronicDeth

    • Use dialyze for dialyzer access with mix dialyze

  • #7 - Validation and conversion of JSON API errors Documents - @KronicDeth

    • JSON API errors documents can be validated and converted to %Alembic.Document{} using Alembic.Document.from_json/2. Invalid documents return {:error, %Alembic.Document{}}. The %Alembic.Document{} can be sent back to the sender, which can be validated on the other end using from_json/2. Valid documents return {:ok, %Alembic.Document{}}.

  • #8 - JSON API (non-errors) Documents - @KronicDeth

Incompatible Changes

  • #8 - JSON API (non-errors) Documents - @KronicDeth

    • Alembic.FromJsonTest.assert_idempotent has moved to Alembic.FromJsonCase.