Merge pull request #138 from sebastianconcept/adds-ci

adds CI instructions and edit readme and changelog

Author: sebastianconcept

.github/workflows/build.yml

@@ -0,0 +1,50 @@
+name: Unit Tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        smalltalk: [Pharo64-7.0]
+        redis-version: [7]
+        mongodb-version: ['4.4']
+    name: ${{ matrix.smalltalk }}
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432    
+    steps:
+      - name: Start Redis
+        uses: supercharge/[email protected]
+        with:
+          redis-version: ${{ matrix.redis-version }}
+      - name: Start MongoDB
+        uses: supercharge/[email protected]
+        with:
+          mongodb-version: ${{ matrix.mongodb-version }}
+          mongodb-replica-set: test-rs          
+      - uses: actions/checkout@v2
+      - uses: hpi-swa/setup-smalltalkCI@v1
+        with:
+          smalltalk-image: ${{ matrix.smalltalk }}
+      - name: Load Image and Run Tests
+        run: smalltalkci -s ${{ matrix.smalltalk }} .smalltalkci/.unit-tests.ston
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        timeout-minutes: 15
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          name: ${{matrix.os}}-${{matrix.smalltalk}}
+          token: ${{ secrets.CODECOV_TOKEN }}

.smalltalk.ston

@@ -0,0 +1,16 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'Mapless',
+      #directory : 'src',
+      #load : [ 'Core',
+        'Memory',
+        'Postgres',
+        'Mongo',
+        'Redis'
+      ],
+      #platforms : [ #pharo
+      ]
+    }
+  ]
+}

.smalltalkci/.unit-tests.ston

@@ -0,0 +1,26 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'Mapless',
+      #directory : '../src',
+      #load : [ 'Core',
+        'Memory',
+        'Postgres',
+        'Mongo',
+        'Redis' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #coverage : {
+      #packages : [ 
+        'Mapless-Base-Core', 
+        'Mapless-Memory-Core', 
+        'Mapless-Postgres-Core',
+        'Mapless-Mongo-Core',
+        'Mapless-Redis-Core'
+         ],
+      #format: #lcov
+    }
+  }
+}

README.md

@@ -4,13 +4,19 @@
 
 Schema-less persistence for Smalltalk with support for multiple backends.
 
-[![Release](https://img.shields.io/github/v/tag/sebastianconcept/Mapless?label=release)](https://github.com/sebastianconcept/Mapless/releases)
-![Tests](https://img.shields.io/badge/tests-178-green)
+[![Unit Tests](https://github.com/sebastianconcept/Mapless/actions/workflows/build.yml/badge.svg)](https://github.com/sebastianconcept/Mapless/actions/workflows/build.yml)
+![Tests](https://img.shields.io/badge/tests-193-green)
+[![Coverage Status](https://codecov.io/github/sebastianconcept/Mapless/coverage.svg?branch=main)](https://codecov.io/gh/sebastianconcept/Mapless/branch/master)
+
 [![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE.txt)
+[![Release](https://img.shields.io/github/v/tag/sebastianconcept/Mapless?label=release)](https://github.com/sebastianconcept/Mapless/releases)
+
+
+[![Pharo 7](https://img.shields.io/badge/Pharo-7-%23383932.svg)](https://pharo.org/download)
+[![Pharo 10](https://img.shields.io/badge/Pharo-10-%23383932.svg)](https://pharo.org/download)
 
 [![Social](https://img.shields.io/github/stars/sebastianconcept/Mapless?style=social)]()
 [![Forks](https://img.shields.io/github/forks/sebastianconcept/Mapless?style=sociall)]()
-[![](https://img.shields.io/reddit/subreddit-subscribers/mapless_data?style=social)](https://www.reddit.com/r/mapless_data/)
 
 ---
 
@@ -21,62 +27,84 @@ Schema-less persistence for Smalltalk with support for multiple backends.
 - Composable.
 - JSON friendly.
 - No need to create accessors and mutators.
-- Multiple backends to chose from.
+- Multiple backends to choose from.
 - Enables smooth data migration/interoperation among backends.
-- Via Redis PUB/SUB, scalable observer-pattern functionality across images.
+- ~~Via Redis PUB/SUB, scalable observer-pattern functionality across images.~~ In the roadmap.
+
+## Description
+
+Mapless is a schema-less persistence framework supporting multiple backends and offering a user-friendly API. For instance, querying Mapless objects involves a common family of methods, and there's no need to declare accessors and mutators. See [examples below](#examples).
+
+Designed to be schema-less, Mapless eliminates the need for schema maintenance and avoids any Object-Relational Mapping requirements.
+
+Mapless achieves a balance of maximum data survivability and robust architectural flexibility without imposing a heavy burden in terms of adoption and maintenance.
 
 ## Ambition
 
-Mapless gives you performant state plasticity and high availability in a scale that goes beyond one Smalltalk image and without backend vendor locking nor object-mapping impedance mismatch.
+To deliver a high-performance solution that preserves arbitrary application state (data) with a focus on flexibility, availability, and capacity. It aims to strategically aid in scaling without causing backend vendor lock-in, across various persistence backends, and by neutralizing the costs associated with object-mapping impedance mismatch.
 
 ## Supported backends
 
 1. MongoDB
 2. Redis
 3. Memory
 4. PostgreSQL
-5. UnQLite
+5. ~~UnQLite~~ `deprecated` / retiring soon
 
 ## Examples
 
 ```Smalltalk
 "Instanciates a mapless object."
-genius := DummyPerson new
+philosopher := Person new
 	firstName: 'Aristotle';
 	yourself.
 
 "Saves it."
-repository save: genius.
+repository save: philosopher.
 ```
 
 ```Smalltalk
 "Loads one by known ID."
-identified := repository findOne: DummyPerson atId: genius id.
+identified := repository findOne: Person atId: philosopher id.
 ```
 
 ```Smalltalk
 "Loads all instances of that class that were stored in that database."
-allOrEmpty := repository findAll: DummyPerson.
+allOrEmpty := repository findAll: Person.
 ```
 
 ```Smalltalk
 "Query to load all the instances that match the condition."
-someOrEmpty := repository findAll: DummyPerson where: [ :each | each lastName = 'Peterson' ].
+someOrEmpty := repository findAll: Person where: [ :each | each lastName = 'Peterson' ].
 ```
 
 ```Smalltalk
 "Conditionally loading the first matching instance."
-oneOrNil := repository findOne: DummyPerson where: [ :each | each lastName = 'Peterson' ].
+oneOrNil := repository findOne: Person where: [ :each | each lastName = 'Peterson' ].
 ```
 
+```Smalltalk
+"Create a Person mapless model"
+philosopher := Person new
+	firstName: 'Aristotle';
+	save.
+
+"Set it as the person for a new User mapless model"
+philosopherUser := User new
+	person: philosopher;
+	save.  
+
+"Query for that user by ID and get its person instance"
+aristotle := (User findId: philosopherUser id) person.
+```
 ## Installation
 
-Open a Pharo workspace and evaluate:
+Open a workspace in a supported Pharo image and evaluate:
 
 ```smalltalk
 Metacello new
   baseline: 'Mapless';
-  repository: 'github://sebastianconcept/Mapless:v0.5.7/src';
+  repository: 'github://sebastianconcept/Mapless:latest/src';
   load
 ```
 
@@ -88,6 +116,6 @@ In BaselineOf or ConfigurationOf it can be added in this way:
 spec
   baseline: 'Mapless'
     with: [ spec
-    repository: 'github://sebastianconcept/Mapless:v0.5.0-alpha/src';
-    load: #('Core' 'Mongo' 'Memory' 'Redis' 'UnQLite') ]
+    repository: 'github://sebastianconcept/Mapless:latest/src';
+    load: #('Core' 'Postgres' 'Mongo' 'Redis' 'Memory') ]
 ```

changelog.md

@@ -1,3 +1,9 @@
+Jan 25, 2024
+===================================
+- Updating `master` branch to keep up with the latests useful upgrades.
+- Adding badges to the README.md for constant monitoring of CI, unit tests, regression detection capacity and supported Pharo versions.
+- Adds CI via GitHub actions.
+
 May 22, 2023
 ===================================
 - Improved `MongoAPI` by adding `initializeMongoUrl` and a lazy accessor using it and `Array` instead of `Set` so comparing it on the fly from `getIdleReadOnlyClient` is significantly faster now.