chore: Add prompt property and its associated tests

Author: httpdss

.env.example

@@ -0,0 +1 @@
+OPENAI_API_KEY=your-api-key-here

.gitignore

@@ -1,3 +1,4 @@
 .venv
 __pycache__
 *.egg-info
+.env

example/structure.yaml

@@ -10,3 +10,6 @@ structure:
         echo "Hello, {author_name}!"
   - LICENSE:
       file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE
+  - .gitignore:
+      prompt: |
+        Generate the content for a .gitignore file that is appropriate for a Python project. Include common directories and file types that should be ignored.

requirements.txt

@@ -1,2 +1,4 @@
 PyYAML
 requests
+openai
+python-dotenv

struct_module/main.py

@@ -4,22 +4,50 @@
 import logging
 from string import Template
 import time
+import yaml
+import openai
+from dotenv import load_dotenv
+
+load_dotenv()
+
+openai_api_key = os.getenv("OPENAI_API_KEY")
+
+if not openai_api_key:
+    raise ValueError("OpenAI API key not found. Please set it in the .env file.")
+
+openai.api_key = openai_api_key
 
 class FileItem:
     def __init__(self, properties):
         self.name = properties.get("name")
         self.content = properties.get("content")
         self.remote_location = properties.get("file")
         self.permissions = properties.get("permissions")
+        self.prompt = properties.get("prompt")
+
+    def process_prompt(self):
+        if self.prompt:
+            logging.debug(f"Processing prompt: {self.prompt}")
+            response = openai.Completion.create(
+                engine="davinci",
+                prompt=self.prompt,
+                max_tokens=100
+            )
+            self.content = response.choices[0].text
+            logging.debug(f"Generated content: {self.content}")
 
     def fetch_content(self):
         if self.remote_location:
+            logging.debug(f"Fetching content from: {self.remote_location}")
             response = requests.get(self.remote_location)
+            logging.debug(f"Response status code: {response.status_code}")
             response.raise_for_status()
             self.content = response.text
+            logging.debug(f"Fetched content: {self.content}")
 
     def apply_template_variables(self, template_vars):
         if self.content and template_vars:
+            logging.debug(f"Applying template variables: {template_vars}")
             template = Template(self.content)
             self.content = template.substitute(template_vars)
 
@@ -65,12 +93,21 @@ def validate_configuration(structure):
             if not isinstance(name, str):
                 raise ValueError("Each name in the 'structure' item must be a string.")
             if isinstance(content, dict):
-                if 'content' not in content and 'file' not in content:
-                    raise ValueError(f"Dictionary item '{name}' must contain either 'content' or 'file' key.")
+                # Check that any of the keys 'content', 'file' or 'prompt' is present
+                if 'content' not in content and 'file' not in content and 'prompt' not in content:
+                    raise ValueError(f"Dictionary item '{name}' must contain either 'content' or 'file' or 'prompt' key.")
+                # Check if 'file' key is present and its value is a string
                 if 'file' in content and not isinstance(content['file'], str):
                     raise ValueError(f"The 'file' value for '{name}' must be a string.")
+                # Check if 'permissions' key is present and its value is a string
                 if 'permissions' in content and not isinstance(content['permissions'], str):
                     raise ValueError(f"The 'permissions' value for '{name}' must be a string.")
+                # Check if 'prompt' key is present and its value is a string
+                if 'prompt' in content and not isinstance(content['prompt'], str):
+                    raise ValueError(f"The 'prompt' value for '{name}' must be a string.")
+                # Check if 'prompt' key is present but no OpenAI API key is found
+                if 'prompt' in content and not openai_api_key:
+                    raise ValueError("Using prompt property and no OpenAI API key was found. Please set it in the .env file.")
             elif not isinstance(content, str):
                 raise ValueError(f"The content of '{name}' must be a string or dictionary.")
     logging.info("Configuration validation passed.")
@@ -88,6 +125,7 @@ def create_structure(base_path, structure, dry_run=False, template_vars=None, ba
                 file_item = FileItem({"name": name, "content": content})
 
             file_item.apply_template_variables(template_vars)
+            file_item.process_prompt()
             file_item.create(base_path, dry_run, backup_path, file_strategy)
 
 def main():

tests/test_prompt.py

@@ -0,0 +1,122 @@
+import pytest
+import os
+import tempfile
+import requests
+import logging
+from unittest.mock import patch, MagicMock
+from struct_module.main import FileItem, validate_configuration, create_structure
+
+# Mock the OpenAI API response
+@patch('struct_module.openai.Completion.create')
+def test_process_prompt(mock_openai_create):
+    mock_openai_create.return_value = MagicMock(choices=[MagicMock(text='Generated content from prompt')])
+
+    file_item = FileItem({"name": "generated_file.txt", "prompt": "Write a short story about a dragon."})
+    file_item.process_prompt()
+
+    assert file_item.content == 'Generated content from prompt'
+    mock_openai_create.assert_called_once_with(
+        engine="davinci",
+        prompt="Write a short story about a dragon.",
+        max_tokens=100
+    )
+
+# Test for validate_configuration with prompt
+def test_validate_configuration_with_prompt():
+    valid_structure = [
+        {
+            "story.txt": {
+                "prompt": "Write a short story about a dragon."
+            }
+        }
+    ]
+    invalid_structure = [
+        {
+            "story.txt": {
+                "prompt": 12345  # Invalid type
+            }
+        }
+    ]
+
+    validate_configuration(valid_structure)
+
+    with pytest.raises(ValueError):
+        validate_configuration(invalid_structure)
+
+# Test for creating a file with prompt content
+@patch('struct_module.openai.Completion.create')
+def test_create_structure_with_prompt(mock_openai_create):
+    mock_openai_create.return_value = MagicMock(choices=[MagicMock(text='Generated content from prompt')])
+
+    structure = [
+        {
+            "story.txt": {
+                "prompt": "Write a short story about a dragon."
+            }
+        }
+    ]
+
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        create_structure(tmpdirname, structure)
+
+        story_path = os.path.join(tmpdirname, "story.txt")
+        assert os.path.exists(story_path)
+        with open(story_path, 'r') as f:
+            assert f.read() == 'Generated content from prompt'
+
+# Test for dry run with prompt
+@patch('struct_module.openai.Completion.create')
+def test_dry_run_with_prompt(mock_openai_create, caplog):
+    mock_openai_create.return_value = MagicMock(choices=[MagicMock(text='Generated content from prompt')])
+
+    structure = [
+        {
+            "story.txt": {
+                "prompt": "Write a short story about a dragon."
+            }
+        }
+    ]
+
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        with caplog.at_level(logging.INFO):
+            create_structure(tmpdirname, structure, dry_run=True)
+
+        assert not os.path.exists(os.path.join(tmpdirname, "story.txt"))
+        assert any("[DRY RUN] Would create file:" in message for message in caplog.messages)
+        assert any("Generated content from prompt" in message for message in caplog.messages)
+
+# Mocking requests.get for testing fetch_remote_content within create_structure with prompt
+@patch('struct_module.requests.get')
+@patch('struct_module.openai.Completion.create')
+def test_create_structure_with_remote_content_and_prompt(mock_openai_create, mock_get):
+    mock_get.return_value.status_code = 200
+    mock_get.return_value.text = "Remote content"
+    mock_openai_create.return_value = MagicMock(choices=[MagicMock(text='Generated content from prompt')])
+
+    structure = [
+        {
+            "LICENSE": {
+                "file": "https://example.com/mock"
+            }
+        },
+        {
+            "story.txt": {
+                "prompt": "Write a short story about a dragon."
+            }
+        }
+    ]
+
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        create_structure(tmpdirname, structure)
+
+        license_path = os.path.join(tmpdirname, "LICENSE")
+        story_path = os.path.join(tmpdirname, "story.txt")
+
+        assert os.path.exists(license_path)
+        assert os.path.exists(story_path)
+
+        with open(license_path, 'r') as f:
+            assert f.read() == "Remote content"
+
+        with open(story_path, 'r') as f:
+            assert f.read() == 'Generated content from prompt'