glassesneo/oolib

A nimble package for object-oriented programming

👑OOlib

OOlib is currently work in progress🔥

🗺Overview

OOlib is a nimble package for object oriented programming.

📜Usage

class

import oolib

class Person:
  var
    name: string
    age = 0

let steve = Person.new(name = "Steve")
let tony = Person.new(name = "Tony", age = 30)

protocol

import oolib

protocol Readable:
  var text: string

protocol Writable:
  var text: string
  proc `text=`(value: string)

protocol Product:
  var price: int

protocol pub Writer:
  proc write(text: string)

class Book impl (Readable, Product):
  var
    text: string = ""
    price: int

class Diary impl (Readable, Writable, Product):
  var text {.initial.}: string = ""
  var price: int
  proc `text=`(value: string) =
    self.text = value

class HTMLWriter impl Writer:
  var writable: Writable
  proc write(text: string) =
    self.writable.text = text

✨Features

• class macro
  • Automatic generation of constructor
  • self inserted in procedures
  • all routines (e.g., method, converter, template) with the only exception of macro
• protocol macro
  • Provide an Kotlin-like interface
  • defining setter/getter

Changelog

See CHANGELOG

🥷Author

License

Copyright © 2021 Neo [email protected] This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See http://www.wtfpl.net/ for more details.

oolib's Issues

Improve README

• Add badges
• Add some items

`{.impl: ISomeInterface.}` for non-classes

Add an icon

• Add icon to repo

`{.noNewDef.}` to not define constructor

• Add this pragma

write README

• Overview
• Usage
• Features
• License

Class data constants

I would like to be able to store data per class.

import oolib


class A {.open.}:
  const className = "A"
  const speed = 10.0f

class B of A:
  const className = "B"
  const speed = 15.0f

var a = newA()
var b = newB()

check A.className == "A"
check B.className == "B"
check a.className == "A"
check b.className == "B"
check b.speed > a.speed

Named tuple implementation

• Implement named tuple instead of Alias of tuple

class pub SomeTuple(tuple):
  var a: int
  var b: string
  proc f(num: int) =
    discard

This will be converted to below

type SomeTuple* = tuple
  a: int
  b: string

proc f(self: SomeTuple, num: int) =
  discard

`let` variables

• let member variables via getter or dotOperator

Support for `converter`

• Support for converter

create class macro

• make it to parse modifiers around class name(e.g. pub, of)
• make it to define member variables and procedures
• make it to parse procedure types(e.g. proc, method)
• make it to insert self as a first argument to proc

Allow `pClass` to have class info

• Allow pClass to have class info(e.g. ClassKind, isPub)

Fix constructor

• Auto call base class's constructor

`{.oolibExperimental.}` to limit experimental features

• {.oolibExperimental.}pragma

Adopt state pattern

• Adopt state pattern

`isClass()`

• Insert {.class.} to class
• Add isClass()

Documentation comments

• Documentation comments for class and protocol

Refactor and style

• Refactor and style the code
• Add {.compileTime.} to procs only used at compile time
• Write comments

Define `new` like Python's `__init__` when constructor is defined

• Define new that has generic params

Add CHANGELOG

• Add CHANGELOG.md

Implement `super`

• Impletent super keyword for method

idea: interface validation

Many people use interface as a design tool.
perhaps it is possible to use Nim's when compiles(...) feature
to expand something like checkImpl(myClass, ISomeInterface)
where ISomeInterface will be scanned (typetraits perhaps) for the public procs and fields, and then for each it will be checked in the (hidden by template) when compiles block. then we get a compiler error message, that this proc was not yet implemented.
What do you think of this idea? btw, very cool lib. just came across it!

Inheritance without `{.open.}`

• Fix this problem
• Warn when {.open.} is used with of

Rewrite README

• Make very bad English sentences in README better
• Add description of new features

oolibpkg ディレクトリ名を oolib にリネームしてはどうか

提案

• oolibpkg ディレクトリ名を oolib にリネームしてはどうか

理由

nimble install OOlib したところ、以下のWarningが表示されました。

Warning: Package 'oolib' has an incorrect structure. It should contain a single directory hierarchy for source files, named 'oolib', but file 'tmpl.nim' is in a directory named 'oolibpkg' instead. This will be an error in the future.
Hint: If 'oolibpkg' contains source files for building 'oolib', rename it to 'oolib'. Otherwise, prevent its installation by adding skipDirs = @["oolibpkg"] to the .nimble file.

警告：パッケージ 'oolib'の構造が正しくありません。 'oolib'という名前のソースファイル用の単一のディレクトリ階層が含まれている必要がありますが、ファイル 'tmpl.nim'は代わりに 'oolibpkg'という名前のディレクトリにあります。これは将来エラーになります。
ヒント：「oolibpkg」に「oolib」をビルドするためのソースファイルが含まれている場合は、名前を「oolib」に変更します。それ以外の場合は、.nimbleファイルにskipDirs = @ ["oolibpkg"]を追加して、インストールを防止します。

これは oolib の内部用モジュールが oolibpkg ディレクトリ配下に存在するため表示されています。

通常、Nimのパッケージは library として提供する場合、プロジェクト構造を以下のようにします

1. src直下に パッケージ名.nim をエントリーポイントとして配置する
2. パッケージ名.nim から参照する内部用モジュールは パッケージ名 ディレクトリ配下に配置する

参考: Project structure - nim-lang/nimble

パッケージ名pkg といった命名にするのは、Hybridなパッケージとして公開する場合に必要なアプローチでしたが、現在は解消していると思われます

参考: Hybrids - nim-lang/nimble

Improve tests

• Increase tests
• Fix settings of testament
• Fix source if test fails

`dataclass`

• Add == template for data class like Kotlin's dataclass

Cannot export member variables

error when member variables is marked with *

• Fix it

Rewrite oolib.nimble

• Add installDirs

Support for more modifiers

• #73
• template

Improve README

• Add an icon
• Improve docs

Add some keywords to enable completion

• Add some keywords such as pub

Support for constructor

• Automatically define constructor
• Define constructor easily

Protocol(Interface)

• Create protocol
• Support for proc, func
• Support for variables
• {.pProtocol.}

Alternative constructor

• Type.new(args)

Constructor can't be exported

`protocol`

• protocol
• implementation protocol for class
• private procedures as private fields for tuple

Type alias

• Type alias

git tagを打って欲しい

提案

• このリポジトリの最新の master に git tag v0.2.2 を打ってほしい
• 以降、新バージョンが公開されるたびに git tag vX.X.X を打つようにしてほしい

※ 今より古いコミットについて、その当時のバージョンに合わせて git tag を打つまではしなくてよいと思います

理由

バージョン番号指定で nimble install ができないため

⟩ nimble install '[email protected]'
Downloading https://github.com/Glasses-Neo/OOlib using git
   Warning: Package 'oolib' has an incorrect structure. It should contain a single directory hierarchy for source files, named 'oolib', but file 'tmpl.nim' is in a directory named 'oolibpkg' instead. This will be an error in the future.
      Hint: If 'oolibpkg' contains source files for building 'oolib', rename it to 'oolib'. Otherwise, prevent its installation by adding `skipDirs = @["oolibpkg"]` to the .nimble file.
       Tip: 2 messages have been suppressed, use --verbose to show them.
     Error: Downloaded package's version does not satisfy requested version range: wanted 0.2.1 got 0.2.2.

正常にインストールできる場合は、以下のように出力されます。

⟩ nimble install '[email protected]'
Downloading https://github.com/c-blake/cligen.git using git
  Verifying dependencies for [email protected]
 Installing [email protected]
   Success: cligen installed successfully.

詳細

nimble でパッケージをバージョン指定してインストールする場合、バージョン情報はGitリポジトリのタグに基づいて判別されます。nimbleファイルのバージョン番号のみでは不足しています。

参考: Versions - nim-lang/nimble

このリポジトリはタグが振られていないため、最新版のインストールしかできない状態です。

参考

他の nimble パッケージでバージョン番号運用をしているパッケージを紹介します

• https://github.com/itsumura-h/nim-basolato/
• https://github.com/jiro4989/faker
• https://github.com/c-blake/cligen

Create examples directory

• Modifiers of class head (e.g. pub, of, distinct)
• proc, func, iterator, converter
• Base method using method
• template
• Auto definition of constructor
• Assistance with constructor definition

Write nimble file

• Write description for classes.nimble

Disable automatic constructor definition of subclasses

• Disable automatic definition of subclasses

Index each error

• Index each error.
• Improve error messages.

Improve inheritance

• {.final.} as default
• {.open.} to allow inheritance

Support for pragma(`{.pragma.}`)

Stricter constructor

Make constructor stricter.

Rename repo

• Rename repo

`struct` like Swift

• Value type
• No inheritance
• Immutable members
• No constructor by default

Support for `Option`

• Support for Option
• Set nil as default value to member variables of type Option

Refactor and style code

• Refactor
• Add documentation comments
• Style code
• Update tests
• Update error msg
• Add parameter constraints

`Pick` macro

• Add Pick macro like Type Script's Pick