codable 1.0.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 82

codable

Build Status

A library for encoding and decoding dynamic data into Dart objects.

Basic Usage

Data objects extend Coding:

class Person extends Coding {
  String name;

  @override
  void decode(KeyedArchive object) {
    // must call super
    super.decode(object);

    name = object.decode("name");   
  }

  @override
  void encode(KeyedArchive object) {
    object.encode("name", name);
  }
}

An object that extends Coding can be read from JSON:

final json = json.decode(...);
final archive = KeyedArchive.unarchive(json);
final person = Person()..decode(archive);

Objects that extend Coding may also be written to JSON:

final person = Person()..name = "Bob";
final archive = KeyedArchive.archive(person);
final json = json.encode(archive);

Coding objects can encode or decode other Coding objects, including lists of Coding objects and maps where Coding objects are values. You must provide a closure that instantiates the Coding object being decoded.

class Team extends Coding {

  List<Person> members;
  Person manager;

  @override
  void decode(KeyedArchive object) {
    super.decode(object); // must call super

    members = object.decodeObjects("members", () => Person());
    manager = object.decodeObject("manager", () => Person());
  }

  @override
  void encode(KeyedArchive object) {
    object.encodeObject("manager", manager);
    object.encodeObjects("members", members);
  }
}

Dynamic Type Casting

Types with primitive type arguments (e.g., List<String> or Map<String, int>) are a particular pain point when decoding. Override castMap in Coding to perform type coercion. You must import package:codable/cast.dart as cast and prefix type names with cast.

import 'package:codable/cast.dart' as cast;
class Container extends Coding {  
  List<String> things;

  @override
  Map<String, cast.Cast<dynamic>> get castMap => {
    "things": cast.List(cast.String)
  };
  

  @override
  void decode(KeyedArchive object) {
    super.decode(object);

    things = object.decode("things");
  }

  @override
  void encode(KeyedArchive object) {
    object.encode("things", things);
  }
}

Document References

Coding objects may be referred to multiple times in a document without duplicating their structure. An object is referenced with the $key key. For example, consider the following JSON:

{
  "components": {
    "thing": {
      "name": "The Thing"
    }    
  },
  "data": {
    "$ref": "#/components/thing"
  }
}

In the above, the decoded value of data inherits all properties from /components/thing:

{
  "$ref": "#/components/thing",
  "name": "The Thing"
}

You may create references in your in-memory data structures through the Coding.referenceURI.

final person = Person()..referenceURI = Uri(path: "/teams/engineering/manager");

The above person is encoded as:

{
  "$ref": "#/teams/engineering/manager"
}

You may have cyclical references.

See the specification for JSON Schema and the $ref keyword for more details.

1.0.0

  • Initial version

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  codable: ^1.0.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:codable/codable.dart';
  
Version Uploaded Documentation Archive
1.0.0 Aug 6, 2018 Go to the documentation of codable 1.0.0 Download codable 1.0.0 archive
1.0.0-beta.2 Jul 11, 2018 Go to the documentation of codable 1.0.0-beta.2 Download codable 1.0.0-beta.2 archive
1.0.0-beta.1 May 29, 2018 Go to the documentation of codable 1.0.0-beta.1 Download codable 1.0.0-beta.1 archive
1.0.0-beta May 25, 2018 Go to the documentation of codable 1.0.0-beta Download codable 1.0.0-beta archive
Popularity:
Describes how popular the package is relative to other packages. [more]
66
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

We analyzed this package on Aug 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:codable/codable.dart.

Suggestions

Maintain an example.

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use codable.dart.

Format lib/cast.dart.

Run dartfmt to format lib/cast.dart.

Format lib/codable.dart.

Run dartfmt to format lib/codable.dart.

Fix additional 5 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/codable.dart (Run dartfmt to format lib/src/codable.dart.)
  • lib/src/coding.dart (Run dartfmt to format lib/src/coding.dart.)
  • lib/src/keyed_archive.dart (Run dartfmt to format lib/src/keyed_archive.dart.)
  • lib/src/list.dart (Run dartfmt to format lib/src/list.dart.)
  • lib/src/resolver.dart (Run dartfmt to format lib/src/resolver.dart.)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
meta ^1.1.5 1.1.6
Dev dependencies
test ^1.3.0