improving markdown parser

4 files changed, 177 insertions, 21 deletions

diff --git a/spec/data/cartridges/block.md b/spec/data/cartridges/block.md
new file mode 100644
index 0000000..ef8588d
--- /dev/null
+++ b/spec/data/cartridges/block.md
@@ -0,0 +1,7 @@
+First, we need to add some important details:
+```yaml
+safety:
+  functions:
+    sandboxed: false
+```
+Hi!
diff --git a/spec/data/cartridges/tools.md b/spec/data/cartridges/tools.md
new file mode 100644
index 0000000..5d2da5a
--- /dev/null
+++ b/spec/data/cartridges/tools.md
@@ -0,0 +1,76 @@
+A cartridge is a YAML file with human-readable data that outlines the bot's goals, expected behaviors, and settings for authentication and provider utilization.
+
+We begin with the meta section, which provides information about what this cartridge is designed for:
+
+```yaml
+meta:
+  symbol: 🕛
+  name: Date and Time
+  author: icebaker
+  version: 0.0.1
+  license: CC0-1.0
+  description: A helpful assistant.
+```
+
+It includes details like versioning and license.
+
+Next, we add a behavior section that will provide the bot with a directive on how it should behave:
+
+```yaml
+behaviors:
+  interaction:
+    directive: You are a helpful assistant.
+```
+
+Now, we need to provide instructions on how this Nano Bot should connect with a provider, which credentials to use, and what specific configurations for the LLM are required:
+
+```yaml
+provider:
+  id: openai
+  credentials:
+    access-token: ENV/OPENAI_API_KEY
+  settings:
+    user: ENV/NANO_BOTS_END_USER
+    model: gpt-4-1106-preview
+```
+
+In my API, I have set the environment variables `OPENAI_API_KEY` and `NANO_BOTS_END_USER`, which is where the values for these will come from.
+
+Nano Bot ready; let's start adding some extra power to it.
+
+## Random Numbers
+
+```yml
+tools:
+- name: random-number
+  description: Generates a random number within a given range.
+  parameters:
+    type: object
+    properties:
+      from:
+        type: integer
+        description: The minimum expected number for random generation.
+      to:
+        type: integer
+        description: The maximum expected number for random generation.
+    required:
+      - from
+      - to
+```
+
+```clj
+(let [{:strs [from to]} parameters]
+  (+ from (rand-int (+ 1 (- to from)))))
+```
+
+## Date and Time
+
+```yaml
+tools:
+- name: date-and-time
+  description: Returns the current date and time.
+```
+
+```fnl
+(os.date)
+```
diff --git a/spec/logic/cartridge/parser_spec.rb b/spec/logic/cartridge/parser_spec.rb
index f8d1302..e8bac0b 100644
--- a/spec/logic/cartridge/parser_spec.rb
+++ b/spec/logic/cartridge/parser_spec.rb
@@ -4,28 +4,92 @@ require_relative '../../../logic/cartridge/parser'
 
 RSpec.describe NanoBot::Logic::Cartridge::Parser do
   context 'markdown' do
-    let(:raw) { File.read('spec/data/cartridges/markdown.md') }
+    context 'default' do
+      let(:raw) { File.read('spec/data/cartridges/markdown.md') }
 
-    it 'parses markdown cartridge' do
-      expect(described_class.parse(raw, format: 'md')).to eq(
-        { meta: {
-            symbol: '🤖',
-            name: 'ChatGPT 4 Turbo',
-            author: 'icebaker',
-            version: '0.0.1',
-            license: 'CC0-1.0',
-            description: 'A helpful assistant.'
-          },
-          behaviors: { interaction: { directive: 'You are a helpful assistant.' } },
-          provider: {
-            id: 'openai',
-            credentials: { 'access-token': 'ENV/OPENAI_API_KEY' },
-            settings: {
-              user: 'ENV/NANO_BOTS_END_USER',
-              model: 'gpt-4-1106-preview'
-            }
-          } }
-      )
+      it 'parses markdown cartridge' do
+        expect(described_class.parse(raw, format: 'md')).to eq(
+          { meta: {
+              symbol: '🤖',
+              name: 'ChatGPT 4 Turbo',
+              author: 'icebaker',
+              version: '0.0.1',
+              license: 'CC0-1.0',
+              description: 'A helpful assistant.'
+            },
+            behaviors: { interaction: { directive: 'You are a helpful assistant.' } },
+            provider: {
+              id: 'openai',
+              credentials: { 'access-token': 'ENV/OPENAI_API_KEY' },
+              settings: {
+                user: 'ENV/NANO_BOTS_END_USER',
+                model: 'gpt-4-1106-preview'
+              }
+            } }
+        )
+      end
+    end
+
+    context 'tools' do
+      let(:raw) { File.read('spec/data/cartridges/tools.md') }
+
+      it 'parses markdown cartridge' do
+        expect(described_class.parse(raw, format: 'md')).to eq(
+          { meta: {
+              symbol: '🕛',
+              name: 'Date and Time',
+              author: 'icebaker',
+              version: '0.0.1',
+              license: 'CC0-1.0',
+              description: 'A helpful assistant.'
+            },
+            behaviors: {
+              interaction: {
+                directive: 'You are a helpful assistant.'
+              }
+            },
+            provider: {
+              id: 'openai',
+              credentials: { 'access-token': 'ENV/OPENAI_API_KEY' },
+              settings: {
+                user: 'ENV/NANO_BOTS_END_USER',
+                model: 'gpt-4-1106-preview'
+              }
+            },
+            tools: [
+              { name: 'random-number',
+                description: 'Generates a random number within a given range.',
+                parameters: {
+                  type: 'object',
+                  properties: {
+                    from: {
+                      type: 'integer',
+                      description: 'The minimum expected number for random generation.'
+                    },
+                    to: {
+                      type: 'integer',
+                      description: 'The maximum expected number for random generation.'
+                    }
+                  },
+                  required: %w[from to]
+                },
+                clojure: "(let [{:strs [from to]} parameters]\n  (+ from (rand-int (+ 1 (- to from)))))\n" },
+              { name: 'date-and-time',
+                description: 'Returns the current date and time.',
+                fennel: "(os.date)\n" }
+            ] }
+        )
+      end
+    end
+
+    context 'block' do
+      let(:raw) { File.read('spec/data/cartridges/block.md') }
+
+      it 'parses markdown cartridge' do
+        expect(described_class.parse(raw, format: 'md')).to eq(
+          { safety: { functions: { sandboxed: false } } }
+        )
+      end
     end
   end
 end
diff --git a/spec/logic/helpers/hash_spec.rb b/spec/logic/helpers/hash_spec.rb
index 09012c8..5e4ec60 100644
--- a/spec/logic/helpers/hash_spec.rb
+++ b/spec/logic/helpers/hash_spec.rb
@@ -7,7 +7,16 @@ RSpec.describe NanoBot::Logic::Helpers::Hash do
     expect(described_class.symbolize_keys({ 'a' => 'b', 'c' => { 'd' => ['e'] } })).to eq(
       { a: 'b', c: { d: ['e'] } }
     )
+  end
+
+  it 'stringify keys' do
+    pp described_class.stringify_keys({ a: 'b', c: { d: [:e] } })
+    expect(described_class.stringify_keys({ a: 'b', c: { d: [:e] } })).to eq(
+      { 'a' => 'b', 'c' => { 'd' => [:e] } }
+    )
+  end
 
+  it 'fetch a path of keys' do
     expect(described_class.fetch({ a: 'b', c: { d: ['e'] } }, %i[c d])).to eq(
       ['e']
     )