Swiftpack.co - Package - Bartlebys/BartlebysCore

Swift 4 Platform

What is Bartleby's Core?

BarlebysCore is a framework written in Swift4, available for macOS, iOS, tvOS et Linux, that allows to :

  1. Insure the persistency Objects Collection, and FilePersistent Objects.
  2. Create serializable HTTP Operation (with off line support)
  3. Deal efficiently with runtime Object Relations resolution

BartlebysCore's goal is to keep things simples and "Swifty" by Design. BartlebysCore is the core Engine of BartlebyKit but is suitable for various usages.

If your data can be totally loaded in Memory, Bartleby's Core is probably a good solution for your App. It will allow to use simple functional programming approach to manipulate your data synchronously very efficiently, and integrate easily with your RESTFul API.

Bartleby's core Data containers

The collection, and the datapoint object registry can useKároly Lőrentey's Binary Trees implementation. To use the Binary trees set up : CollectionOf typealias _ContainerType = List and DataPoint typealias _ContainerType = Map. Benchmarks are still in progress, but the BinaryTrees seems not to perform better than Array on real World object.

Installation

You can use the Swift Package Manager, a git submodule, or Carthage to install BartlebysCore Framework. You can clone BartlebyKit and run ./install.sh. It will synchronise update the submodules a offer a configured workspace.

Using the swift Package manager

You can check the SPM sample CURRENTLY A USELESS PLACEHOLDER

Linking BartlebysCore as a Submodule in Xcode

You need to create a workspace with

1. as an external target

  1. You create submodules in a repository git submodule add -b master https://github.com/Bartlebys/BartlebysCore & git submodule add -b master https://github.com/Bartlebys/BTree
  2. Drop the BartlebysCore/Projects/BartlebysCore/BartlebysCore.xcodeproj & BTree/BTree.xcodeproj files in your Xcode workspace
  3. Add BartlebysCore.framework as Linked Frameworks and libraries from the target general Tab.

2. integrated to your sources

This approach may improve performance and can be suitable is you want to aggregate all the sources.

  1. You create submodules in a repository git submodule add -b master https://github.com/Bartlebys/BartlebysCore & git submodule add -b master https://github.com/Bartlebys/BTree
  2. Drop the source into your Workspace directly.
  3. You should add -DUSE_EMBEDDED_MODULES in the target Build Settings tab > Other swift flags.

If you want to use mixed approach you should import BartlebysCore as :

#if !USE_EMBEDDED_MODULES
import BartlebysCore
#endif

You can also use Carthage.

Add in your Cartfile:

github "Bartlebys/BTree"
github "Bartlebys/BartlebysCore"

DataPoint

The objects are stored in a DataPoint that:

  1. references, load and saves the collections.
  2. allow aliases, and relations resolution.
  3. deals with RestFull HTTP operations (on & Off Line).

A Datapoint is equivalent to a Document that holds a consistent Data Graph.

A Datapoint can use volatile storage to persist in memory only, or by default relies on a File Storage that handles efficiently persistency.

How to implement your own Model?

  1. You can create a Class that Inheritates from Model.swift override Codable, override bunch of the Collectable and implement the Tolerent patch method.
  2. Or You Can generate Model from JSON schema / Swagger / OpenApi / CoreData Models using Flexions (Detailed explanations on the generative tools to come soon)

In fact, Bartleby's Core Models are standard Swift instances, and their Collections are generic. Working with in memory Object Graph insures efficient real time computation.

How to instantiate a Model?

You can instantiate and register a Model using the DataPoint factory method

// Syntax #1
let metrics1:Metrics = dataPoint.newInstance()

// Syntax #2
let metrics2 = dataPoint.newInstance() as Metrics

// Syntax #3
let metrics3 = dataPoint.new(type: Metrics.self)

Or instantiating an Object and appending it to its collection.

// Decomposed approach
let metrics4 = Metrics()
dataPoint.metrics.append(metrics4)

Does Bartleby's Core support CocoaBindings?

YES on macOS but you need to opt in by adding in other swift flag -DUSE_COCOA_BINDINGS in build settings.

Flexions generates by default a Dynamic and a Common model and choose at compile time witch to use, you should always use the TypeAlias.

Let's imagine you have an Entity named MyModel:

// Created by flexions during generation
#if os(macOS) && USE_COCOA_BINDINGS
public typealias MyModel = DynamicMyModel
#else
public typealias MyModel = CommonMyModel
#endif

Documents

Bartleby's

Bartleby's Core License

Bartleby's stack is Licensed under the Apache License version 2.0 By [Benoit Pereira da Silva] (https://Pereira-da-Silva.com)

Github

link
Stars: 2
Help us keep the lights on

Dependencies

Used By

Total: 1

Releases

v1.1.0 - Jan 20, 2018

  • Use Binary Trees (for collection items, and to reference the Instances in the DataPoint)
  • Supports Cocoa Bindings in a dedicated Target BartlebysCore macOSCocoaBindings
  • Thread safety improvements
  • Allow to use distinct queues in the Storage layer
  • Preparing Multi-storage Architecture

v1.0.2 - Jan 13, 2018

v1.0.1 - Dec 28, 2017