Create 'memoization' shard [MEM-1] (#1)

* Create 'memoization' shard [MEM-1]

* Credit Lucky as the starting point for this library

* [readme] Use only one h1 and make other headings h2s

* Remove "Contributing" and "License" sections

I think it's sort of implied that bug reports and pull requests are at
least semi-welcome. If they weren't, I could disable the issues and PR
tabs.

There is a `LICENSE.txt` file and also a `license` field in `shard.yml`.
I don't think we also need license info here.

Author: davidrunger

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: Lint & Test
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+
+      - name: Install Crystal
+        uses: crystal-lang/install-crystal@v1
+
+      - name: Cache shards
+        uses: actions/cache@v4
+        with:
+          path: lib
+          key: ${{ runner.os }}-shards-${{ hashFiles('**/shard.lock') }}
+
+      - name: Install shards
+        run: shards check || shards install
+
+      - name: Cache ameba
+        uses: actions/cache@v4
+        with:
+          path: bin/ameba
+          key: ${{ runner.os }}-ameba-${{ hashFiles('bin/ameba.cr', '**/shard.lock') }}
+
+      - name: Force ameba rebuild if needed
+        run: '[ -f bin/ameba ] || (rm -rf lib/ameba && shards install)'
+
+      - name: Run Ameba
+        run: bin/ameba
+
+      - name: Run tests
+        run: crystal spec

.gitignore

@@ -0,0 +1,2 @@
+/bin/ameba
+/lib/

.runger-config.yml

@@ -0,0 +1 @@
+expected-num-github-checks: 1

CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.0.1 (2025-03-16)
+- Create `memoization` shard.

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) David Runger
+
+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

@@ -1 +1,60 @@
-# memoization
+# Memoization
+
+Easy Crystal memoization.
+
+## Installation
+
+Add to your `shard.yml`:
+
+```yml
+dependencies:
+  memoization:
+    github: davidrunger/memoization
+```
+
+## Usage
+
+Just add `memoize` before the method that you would like to memoize.
+
+```crystal
+require "memoization"
+
+class Example
+  memoize def random_number : Float64
+    Random.rand
+  end
+
+  memoize def hello_with_random_number(name_to_greet : String) : String
+    "Hello, #{name_to_greet}! #{Random.rand}"
+  end
+
+  def call_private_method
+    private_method
+  end
+
+  private memoize def private_method : String
+    "private #{Random.rand}"
+  end
+end
+
+example = Example.new
+
+# Memoize a public method:
+pp! example.random_number # => 0.7239151427874982
+pp! example.random_number # => 0.7239151427874982
+
+# Memoize a method that takes argument(s):
+pp! example.hello_with_random_number("Jane") # => "Hello, Jane! 0.18170318331241622"
+pp! example.hello_with_random_number("John") # => "Hello, John! 0.8370694373403952"
+pp! example.hello_with_random_number("Jane") # => "Hello, Jane! 0.18170318331241622"
+
+# Memoize a private method:
+pp! example.call_private_method # => "private 0.5261598848669066"
+pp! example.call_private_method # => "private 0.5261598848669066"
+```
+
+## Credit
+
+This library is based on the [Lucky web framework's memoization code][lucky-memoization].
+
+[lucky-memoization]: https://github.com/luckyframework/lucky/blob/v1.3.0/spec/lucky/memoize_spec.cr

bin/ameba.cr

@@ -0,0 +1,7 @@
+# Require ameba cli which starts the inspection.
+require "ameba/cli"
+
+# Require ameba extensions here which are added as project dependencies.
+# Example:
+#
+# require "ameba-performance"

bin/githooks/pre-push

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail # exit on any error, don't allow undefined variables, pipes don't swallow errors
+
+lint gitleaks
+
+background-and-notify lint newlines

shard.lock

@@ -0,0 +1,6 @@
+version: 2.0
+shards:
+  ameba:
+    git: https://github.com/crystal-ameba/ameba.git
+    version: 1.6.4
+

shard.yml

@@ -0,0 +1,8 @@
+name: memoization
+version: 0.0.1
+
+development_dependencies:
+  ameba:
+    github: crystal-ameba/ameba
+
+license: MIT