initial release

Author: vladfaust

.editorconfig

@@ -0,0 +1,7 @@
+[*.cr]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.gitignore

@@ -0,0 +1,8 @@
+/doc/
+/lib/
+/bin/
+/.shards/
+
+# Libraries don't need dependency lock
+# Dependencies will be locked in application that uses them
+/shard.lock

.travis.yml

@@ -0,0 +1,18 @@
+language: crystal
+services:
+  - postgresql
+script:
+  - crystal spec
+  - crystal docs
+deploy:
+  provider: pages
+  skip_cleanup: true
+  github_token: $GITHUB_TOKEN
+  on:
+    branch: master
+  local_dir: doc
+before_script:
+  - psql -c 'create database core_test;' -U postgres
+  - psql $DATABASE_URL < spec/migration.sql
+env:
+  - DATABASE_URL=postgres://postgres@localhost:5432/core_test

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vlad Faust
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,134 @@
+# Core
+
+**C**rystal **O**bject **RE**lational Mapping you've been waiting for.
+
+[![Build Status](https://travis-ci.org/vladfaust/core.cr.svg?branch=master)](https://travis-ci.org/vladfaust/core.cr) [![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://vladfaust.com/core.cr) [![Dependency Status](https://shards.rocks/badge/github/vladfaust/core.cr/status.svg)](https://shards.rocks/github/vladfaust/core.cr) [![GitHub release](https://img.shields.io/github/release/vladfaust/core.cr.svg)](https://github.com/vladfaust/core.cr/releases)
+
+## About
+
+Tired of [ActiveRecord](https://wikipedia.org/wiki/Active_record_pattern)'s magic? Forget it. It's time for real programming!
+
+**Core** is inspired by [Crecto](https://github.com/Crecto/crecto) but more transparent and Crystal-ish.
+
+## Installation
+
+Add this to your application's `shard.yml`:
+
+```yaml
+dependencies:
+  core:
+    github: vladfaust/core.cr
+    version: ~> 0.1.0
+```
+
+## Usage
+
+Assuming following initial database migration:
+
+```sql
+CREATE TABLE users(
+  id          SERIAL PRIMARY KEY,
+  name        VARCHAR(100)  NOT NULL,
+  created_at  TIMESTAMPTZ   NOT NULL,
+  updated_at  TIMESTAMPTZ
+);
+
+CREATE TABLE posts(
+  id          SERIAL PRIMARY KEY,
+  author_id   INT         NOT NULL  REFERENCES users (id),
+  content     TEXT        NOT NULL,
+  created_at  TIMESTAMPTZ NOT NULL,
+  updated_at  TIMESTAMPTZ
+);
+```
+
+```crystal
+require "core"
+require "db"
+require "pg" # Or another driver
+
+class User < Core::Model
+  schema do
+    primary_key :id
+    field :name, String
+    virtual_field :posts_count, Int64
+    reference :posts, Array(Post), foreign_key: :author_id
+    created_at_field :created_at
+    updated_at_field :updated_at
+  end
+
+  validation do
+    errors.push({:name => "length must be >= 3"}) unless name.try &.size.>= 3
+  end
+end
+
+class Post < Core::Model
+  schema do
+    primary_key :id
+    field :content, String
+    reference :author, User, key: :author_id
+    created_at_field :created_at
+    updated_at_field :updated_at
+  end
+end
+
+db = DB.open(ENV["DATABASE_URL"])
+query_logger = Core::QueryLogger.new(STDOUT)
+
+user_repo = Core::Repository(User).new(db, query_logger)
+post_repo = Core::Repository(Post).new(db, query_logger)
+
+user = User.new(name: "Fo")
+user.valid? # => false
+user.errors # => [{:name => "length must be >= 3"}]
+user.name = "Foo"
+user.valid? # => true
+
+user.id = user_repo.insert(user) # See ^1
+# INSERT INTO users (name, created_at) VALUES ($1, $2) RETURNING id
+
+post = Post.new(author: user, content: "Foo Bar")
+post.id = post_repo.insert(post) # See ^1
+# INSERT INTO posts (author_id, content, created_at) VALUES ($1, $2, $3) RETURNING id
+
+alias Query = Core::Query
+
+posts = post_repo.query(Query(Post).where(author: user))
+# SELECT * FROM posts WHERE author_id = $1
+
+posts.first.content # => "Foo Bar"
+
+query = Query(User)
+  .join(:posts)
+  .select(:*, :"COUNT(posts.id) AS posts_count")
+  .group_by(%i(users.id posts.id))
+  .one
+user = user_repo.query(query).first
+# SELECT *, COUNT (posts.id) AS posts_count
+# FROM users JOIN posts AS posts ON posts.author_id = users.id
+# GROUP BY users.id, posts.id LIMIT 1
+
+user.posts_count # => 1
+
+user.name = "Bar"
+user.changes # => {:name => "Bar"}
+user_repo.update(user)
+# UPDATE users SET name = $1 WHERE id = $2 RETURNING id
+
+post_repo.delete(posts.first)
+# DELETE FROM posts WHERE id = $1
+```
+
+**^1:** Returning IDs is not working for PostgreSQL yet. See https://github.com/will/crystal-pg/issues/112.
+
+## Contributing
+
+1. Fork it ( https://github.com/vladfaust/core.cr/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
+
+## Contributors
+
+- [@vladfaust](https://github.com/vladfaust) Vlad Faust - creator, maintainer

shard.yml

@@ -0,0 +1,22 @@
+name: core
+version: 0.1.0
+
+authors:
+  - Vlad Faust <mail@vladfaust.com>
+
+crystal: 0.23.1
+
+license: MIT
+
+dependencies:
+  db:
+    github: crystal-lang/crystal-db
+    version: ~> 0.4.2
+  time_format:
+    github: vladfaust/time_format.cr
+    version: ~> 0.1.0
+
+development_dependencies:
+  pg:
+    github: will/crystal-pg
+    version: ~> 0.13.3

spec/migration.sql

@@ -0,0 +1,22 @@
+-- Run this before tests:
+
+DROP TABLE IF EXISTS posts;
+DROP TABLE IF EXISTS users;
+
+CREATE TABLE users(
+  id          SERIAL PRIMARY KEY,
+  referrer_id INT                     REFERENCES users (id),
+  role        INT           NOT NULL  DEFAULT 0,
+  name        VARCHAR(100)  NOT NULL,
+  created_at  TIMESTAMPTZ   NOT NULL,
+  updated_at  TIMESTAMPTZ
+);
+
+CREATE TABLE posts(
+  id          SERIAL PRIMARY KEY,
+  author_id   INT         NOT NULL  REFERENCES users (id),
+  editor_id   INT                   REFERENCES users (id),
+  content     TEXT        NOT NULL,
+  created_at  TIMESTAMPTZ NOT NULL,
+  updated_at  TIMESTAMPTZ
+);

spec/model_spec.cr

@@ -0,0 +1,93 @@
+require "./spec_helper"
+
+describe Core::Model do
+  user = uninitialized User
+
+  it do
+    user = User.new(id: 42, name: "Vlad Faust", posts_count: 146)
+  end
+
+  describe "#db_fields" do
+    it do
+      user.db_fields.should eq({:id => 42, :name => "Vlad Faust", :created_at => nil, :updated_at => nil, :role => User::Role::User, :referrer_id => nil})
+    end
+  end
+
+  post = uninitialized Post
+
+  context "with references" do
+    it "has reference properties" do
+      post = Post.new(author: user, content: "Foobar")
+      post.author.should eq user
+      user.posts = [post]
+      user.posts.not_nil!.should contain(post)
+    end
+
+    describe "#db_fields" do
+      it do
+        post.db_fields.should eq({
+          :id         => nil,
+          :author_id  => 42,
+          :editor_id  => nil,
+          :content    => "Foobar",
+          :created_at => nil,
+          :updated_at => nil,
+        })
+      end
+    end
+
+    context "referencing self" do
+      referrer = uninitialized User
+      referral = uninitialized User
+
+      it do
+        referrer = User.new(id: 44)
+        referral = User.new(referrer: referrer)
+        referral.referrer.should eq referrer
+        referrer.referrals = [referral]
+        referrer.referrals.not_nil!.should contain(referral)
+      end
+
+      describe "#db_fields" do
+        it do
+          referral.db_fields[:referrer_id].should eq 44
+        end
+      end
+    end
+  end
+
+  describe "#changes" do
+    it "is initially empty" do
+      user.changes.empty?.should eq true
+    end
+
+    it "tracks changes" do
+      user.name = "Updated User"
+      user.changes.should eq({:name => "Updated User"})
+
+      user.name = "Twice Updated User"
+      user.changes.should eq({:name => "Twice Updated User"})
+    end
+  end
+
+  describe "validation" do
+    describe "#valid?" do
+      it do
+        Post.new.valid?.should eq true
+        user.name = nil
+        user.valid?.should eq false
+        user.name = "foobar"
+        user.valid?.should eq true
+      end
+    end
+
+    describe "#errors" do
+      it do
+        user.errors.empty?.should eq true
+        user.name = nil
+        user.valid?
+        user.errors.should eq([{:name => "length must be > 3"}])
+      end
+    end
+  end
+end

spec/query/group_by_spec.cr

@@ -0,0 +1,11 @@
+require "../query_spec"
+
+describe Query do
+  describe "#group_by" do
+    it do
+      Query(User).group_by(:"foo.id", :"bar.id").to_s.should eq <<-SQL
+      SELECT * FROM users GROUP BY foo.id, bar.id
+      SQL
+    end
+  end
+end