bps-kit 1.0.1 → 1.0.2

package/templates/vault/shopify-development/scripts/tests/test_shopify_init.py

@@ -0,0 +1,379 @@
+"""
+Tests for shopify_init.py
+
+Run with: pytest test_shopify_init.py -v --cov=shopify_init --cov-report=term-missing
+"""
+
+import os
+import sys
+import json
+import pytest
+import subprocess
+from pathlib import Path
+from unittest.mock import Mock, patch, mock_open, MagicMock
+
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from shopify_init import EnvLoader, EnvConfig, ShopifyInitializer
+
+
+class TestEnvLoader:
+    """Test EnvLoader class."""
+
+    def test_load_env_file_success(self, tmp_path):
+        """Test loading valid .env file."""
+        env_file = tmp_path / ".env"
+        env_file.write_text("""
+SHOPIFY_API_KEY=test_key
+SHOPIFY_API_SECRET=test_secret
+SHOP_DOMAIN=test.myshopify.com
+# Comment line
+SCOPES=read_products,write_products
+""")
+
+        result = EnvLoader.load_env_file(env_file)
+
+        assert result['SHOPIFY_API_KEY'] == 'test_key'
+        assert result['SHOPIFY_API_SECRET'] == 'test_secret'
+        assert result['SHOP_DOMAIN'] == 'test.myshopify.com'
+        assert result['SCOPES'] == 'read_products,write_products'
+
+    def test_load_env_file_with_quotes(self, tmp_path):
+        """Test loading .env file with quoted values."""
+        env_file = tmp_path / ".env"
+        env_file.write_text("""
+SHOPIFY_API_KEY="test_key"
+SHOPIFY_API_SECRET='test_secret'
+""")
+
+        result = EnvLoader.load_env_file(env_file)
+
+        assert result['SHOPIFY_API_KEY'] == 'test_key'
+        assert result['SHOPIFY_API_SECRET'] == 'test_secret'
+
+    def test_load_env_file_nonexistent(self, tmp_path):
+        """Test loading non-existent .env file."""
+        result = EnvLoader.load_env_file(tmp_path / "nonexistent.env")
+        assert result == {}
+
+    def test_load_env_file_invalid_format(self, tmp_path):
+        """Test loading .env file with invalid lines."""
+        env_file = tmp_path / ".env"
+        env_file.write_text("""
+VALID_KEY=value
+INVALID_LINE_NO_EQUALS
+ANOTHER_VALID=test
+""")
+
+        result = EnvLoader.load_env_file(env_file)
+
+        assert result['VALID_KEY'] == 'value'
+        assert result['ANOTHER_VALID'] == 'test'
+        assert 'INVALID_LINE_NO_EQUALS' not in result
+
+    def test_get_env_paths(self, tmp_path):
+        """Test getting .env file paths from universal directory structure."""
+        # Create directory structure (works with .agent, .claude, .gemini, .cursor)
+        agent_dir = tmp_path / ".agent"
+        skills_dir = agent_dir / "skills"
+        skill_dir = skills_dir / "shopify"
+
+        skill_dir.mkdir(parents=True)
+
+        # Create .env files at each level
+        (skill_dir / ".env").write_text("SKILL=1")
+        (skills_dir / ".env").write_text("SKILLS=1")
+        (agent_dir / ".env").write_text("AGENT=1")
+
+        paths = EnvLoader.get_env_paths(skill_dir)
+
+        assert len(paths) == 3
+        assert skill_dir / ".env" in paths
+        assert skills_dir / ".env" in paths
+        assert agent_dir / ".env" in paths
+
+    def test_load_config_priority(self, tmp_path, monkeypatch):
+        """Test configuration loading priority across different AI tool directories."""
+        skill_dir = tmp_path / "skill"
+        skills_dir = tmp_path
+        agent_dir = tmp_path.parent  # Could be .agent, .claude, .gemini, .cursor
+
+        skill_dir.mkdir(parents=True)
+
+        (skill_dir / ".env").write_text("SHOPIFY_API_KEY=skill_key")
+        (skills_dir / ".env").write_text("SHOPIFY_API_KEY=skills_key\nSHOP_DOMAIN=skills.myshopify.com")
+
+        monkeypatch.setenv("SHOPIFY_API_KEY", "process_key")
+
+        config = EnvLoader.load_config(skill_dir)
+
+        assert config.shopify_api_key == "process_key"
+        # Shop domain from skills/.env
+        assert config.shop_domain == "skills.myshopify.com"
+
+    def test_load_config_no_files(self, tmp_path):
+        """Test configuration loading with no .env files."""
+        config = EnvLoader.load_config(tmp_path)
+
+        assert config.shopify_api_key is None
+        assert config.shopify_api_secret is None
+        assert config.shop_domain is None
+        assert config.scopes is None
+
+
+class TestShopifyInitializer:
+    """Test ShopifyInitializer class."""
+
+    @pytest.fixture
+    def config(self):
+        """Create test config."""
+        return EnvConfig(
+            shopify_api_key="test_key",
+            shopify_api_secret="test_secret",
+            shop_domain="test.myshopify.com",
+            scopes="read_products,write_products"
+        )
+
+    @pytest.fixture
+    def initializer(self, config):
+        """Create initializer instance."""
+        return ShopifyInitializer(config)
+
+    def test_prompt_with_default(self, initializer):
+        """Test prompt with default value."""
+        with patch('builtins.input', return_value=''):
+            result = initializer.prompt("Test", "default_value")
+            assert result == "default_value"
+
+    def test_prompt_with_input(self, initializer):
+        """Test prompt with user input."""
+        with patch('builtins.input', return_value='user_input'):
+            result = initializer.prompt("Test", "default_value")
+            assert result == "user_input"
+
+    def test_select_option_valid(self, initializer):
+        """Test select option with valid choice."""
+        options = ['app', 'extension', 'theme']
+        with patch('builtins.input', return_value='2'):
+            result = initializer.select_option("Choose", options)
+            assert result == 'extension'
+
+    def test_select_option_invalid_then_valid(self, initializer):
+        """Test select option with invalid then valid choice."""
+        options = ['app', 'extension']
+        with patch('builtins.input', side_effect=['5', 'invalid', '1']):
+            result = initializer.select_option("Choose", options)
+            assert result == 'app'
+
+    def test_check_cli_installed_success(self, initializer):
+        """Test CLI installed check - success."""
+        mock_result = Mock()
+        mock_result.returncode = 0
+
+        with patch('subprocess.run', return_value=mock_result):
+            assert initializer.check_cli_installed() is True
+
+    def test_check_cli_installed_failure(self, initializer):
+        """Test CLI installed check - failure."""
+        with patch('subprocess.run', side_effect=FileNotFoundError):
+            assert initializer.check_cli_installed() is False
+
+    def test_create_app_config(self, initializer, tmp_path):
+        """Test creating app configuration file."""
+        initializer.create_app_config(tmp_path, "test-app", "read_products")
+
+        config_file = tmp_path / "shopify.app.toml"
+        assert config_file.exists()
+
+        content = config_file.read_text()
+        assert 'name = "test-app"' in content
+        assert 'scopes = "read_products"' in content
+        assert 'client_id = "test_key"' in content
+
+    def test_create_extension_config(self, initializer, tmp_path):
+        """Test creating extension configuration file."""
+        initializer.create_extension_config(tmp_path, "test-ext", "checkout")
+
+        config_file = tmp_path / "shopify.extension.toml"
+        assert config_file.exists()
+
+        content = config_file.read_text()
+        assert 'name = "test-ext"' in content
+        assert 'purchase.checkout.block.render' in content
+
+    def test_create_extension_config_admin_action(self, initializer, tmp_path):
+        """Test creating admin action extension config."""
+        initializer.create_extension_config(tmp_path, "admin-ext", "admin_action")
+
+        config_file = tmp_path / "shopify.extension.toml"
+        content = config_file.read_text()
+        assert 'admin.product-details.action.render' in content
+
+    def test_create_readme(self, initializer, tmp_path):
+        """Test creating README file."""
+        initializer.create_readme(tmp_path, "app", "Test App")
+
+        readme_file = tmp_path / "README.md"
+        assert readme_file.exists()
+
+        content = readme_file.read_text()
+        assert '# Test App' in content
+        assert 'shopify app dev' in content
+
+    @patch('builtins.input')
+    @patch('builtins.print')
+    def test_init_app(self, mock_print, mock_input, initializer, tmp_path, monkeypatch):
+        """Test app initialization."""
+        monkeypatch.chdir(tmp_path)
+
+        # Mock user inputs
+        mock_input.side_effect = ['my-app', 'read_products,write_products']
+
+        initializer.init_app()
+
+        # Check directory created
+        app_dir = tmp_path / "my-app"
+        assert app_dir.exists()
+
+        # Check files created
+        assert (app_dir / "shopify.app.toml").exists()
+        assert (app_dir / "README.md").exists()
+        assert (app_dir / "package.json").exists()
+
+        # Check package.json content
+        package_json = json.loads((app_dir / "package.json").read_text())
+        assert package_json['name'] == 'my-app'
+        assert 'dev' in package_json['scripts']
+
+    @patch('builtins.input')
+    @patch('builtins.print')
+    def test_init_extension(self, mock_print, mock_input, initializer, tmp_path, monkeypatch):
+        """Test extension initialization."""
+        monkeypatch.chdir(tmp_path)
+
+        # Mock user inputs: type selection (1 = checkout), name
+        mock_input.side_effect = ['1', 'my-extension']
+
+        initializer.init_extension()
+
+        # Check directory and files created
+        ext_dir = tmp_path / "my-extension"
+        assert ext_dir.exists()
+        assert (ext_dir / "shopify.extension.toml").exists()
+        assert (ext_dir / "README.md").exists()
+
+    @patch('builtins.input')
+    @patch('builtins.print')
+    def test_init_theme(self, mock_print, mock_input, initializer):
+        """Test theme initialization."""
+        mock_input.return_value = 'my-theme'
+
+        initializer.init_theme()
+
+        assert mock_print.called
+
+    @patch('builtins.print')
+    def test_run_no_cli(self, mock_print, initializer):
+        """Test run when CLI not installed."""
+        with patch.object(initializer, 'check_cli_installed', return_value=False):
+            with pytest.raises(SystemExit) as exc_info:
+                initializer.run()
+            assert exc_info.value.code == 1
+
+    @patch.object(ShopifyInitializer, 'check_cli_installed', return_value=True)
+    @patch.object(ShopifyInitializer, 'init_app')
+    @patch('builtins.input')
+    @patch('builtins.print')
+    def test_run_app_selected(self, mock_print, mock_input, mock_init_app, mock_cli_check, initializer):
+        """Test run with app selection."""
+        mock_input.return_value = '1'  # Select app
+
+        initializer.run()
+
+        mock_init_app.assert_called_once()
+
+    @patch.object(ShopifyInitializer, 'check_cli_installed', return_value=True)
+    @patch.object(ShopifyInitializer, 'init_extension')
+    @patch('builtins.input')
+    @patch('builtins.print')
+    def test_run_extension_selected(self, mock_print, mock_input, mock_init_ext, mock_cli_check, initializer):
+        """Test run with extension selection."""
+        mock_input.return_value = '2'  # Select extension
+
+        initializer.run()
+
+        mock_init_ext.assert_called_once()
+
+
+class TestMain:
+    """Test main function."""
+
+    @patch('shopify_init.ShopifyInitializer')
+    @patch('shopify_init.EnvLoader')
+    def test_main_success(self, mock_loader, mock_initializer):
+        """Test main function success path."""
+        from shopify_init import main
+
+        mock_config = Mock()
+        mock_loader.load_config.return_value = mock_config
+
+        mock_init_instance = Mock()
+        mock_initializer.return_value = mock_init_instance
+
+        with patch('builtins.print'):
+            main()
+
+        mock_init_instance.run.assert_called_once()
+
+    @patch('shopify_init.ShopifyInitializer')
+    @patch('sys.exit')
+    def test_main_keyboard_interrupt(self, mock_exit, mock_initializer):
+        """Test main function with keyboard interrupt."""
+        from shopify_init import main
+
+        mock_initializer.return_value.run.side_effect = KeyboardInterrupt
+
+        with patch('builtins.print'):
+            main()
+
+        mock_exit.assert_called_with(0)
+
+    @patch('shopify_init.ShopifyInitializer')
+    @patch('sys.exit')
+    def test_main_exception(self, mock_exit, mock_initializer):
+        """Test main function with exception."""
+        from shopify_init import main
+
+        mock_initializer.return_value.run.side_effect = Exception("Test error")
+
+        with patch('builtins.print'):
+            main()
+
+        mock_exit.assert_called_with(1)
+
+
+class TestEnvConfig:
+    """Test EnvConfig dataclass."""
+
+    def test_env_config_defaults(self):
+        """Test EnvConfig default values."""
+        config = EnvConfig()
+
+        assert config.shopify_api_key is None
+        assert config.shopify_api_secret is None
+        assert config.shop_domain is None
+        assert config.scopes is None
+
+    def test_env_config_with_values(self):
+        """Test EnvConfig with values."""
+        config = EnvConfig(
+            shopify_api_key="key",
+            shopify_api_secret="secret",
+            shop_domain="test.myshopify.com",
+            scopes="read_products"
+        )
+
+        assert config.shopify_api_key == "key"
+        assert config.shopify_api_secret == "secret"
+        assert config.shop_domain == "test.myshopify.com"
+        assert config.scopes == "read_products"

package/templates/vault/skill-creator/scripts/init_skill.py

@@ -0,0 +1,303 @@
+#!/usr/bin/env python3
+"""
+Skill Initializer - Creates a new skill from template
+
+Usage:
+    init_skill.py <skill-name> --path <path>
+
+Examples:
+    init_skill.py my-new-skill --path skills/public
+    init_skill.py my-api-helper --path skills/private
+    init_skill.py custom-skill --path /custom/location
+"""
+
+import sys
+from pathlib import Path
+
+
+SKILL_TEMPLATE = """---
+name: {skill_name}
+description: [TODO: Complete and informative explanation of what the skill does and when to use it. Include WHEN to use this skill - specific scenarios, file types, or tasks that trigger it.]
+---
+
+# {skill_title}
+
+## Overview
+
+[TODO: 1-2 sentences explaining what this skill enables]
+
+## Structuring This Skill
+
+[TODO: Choose the structure that best fits this skill's purpose. Common patterns:
+
+**1. Workflow-Based** (best for sequential processes)
+- Works well when there are clear step-by-step procedures
+- Example: DOCX skill with "Workflow Decision Tree" → "Reading" → "Creating" → "Editing"
+- Structure: ## Overview → ## Workflow Decision Tree → ## Step 1 → ## Step 2...
+
+**2. Task-Based** (best for tool collections)
+- Works well when the skill offers different operations/capabilities
+- Example: PDF skill with "Quick Start" → "Merge PDFs" → "Split PDFs" → "Extract Text"
+- Structure: ## Overview → ## Quick Start → ## Task Category 1 → ## Task Category 2...
+
+**3. Reference/Guidelines** (best for standards or specifications)
+- Works well for brand guidelines, coding standards, or requirements
+- Example: Brand styling with "Brand Guidelines" → "Colors" → "Typography" → "Features"
+- Structure: ## Overview → ## Guidelines → ## Specifications → ## Usage...
+
+**4. Capabilities-Based** (best for integrated systems)
+- Works well when the skill provides multiple interrelated features
+- Example: Product Management with "Core Capabilities" → numbered capability list
+- Structure: ## Overview → ## Core Capabilities → ### 1. Feature → ### 2. Feature...
+
+Patterns can be mixed and matched as needed. Most skills combine patterns (e.g., start with task-based, add workflow for complex operations).
+
+Delete this entire "Structuring This Skill" section when done - it's just guidance.]
+
+## [TODO: Replace with the first main section based on chosen structure]
+
+[TODO: Add content here. See examples in existing skills:
+- Code samples for technical skills
+- Decision trees for complex workflows
+- Concrete examples with realistic user requests
+- References to scripts/templates/references as needed]
+
+## Resources
+
+This skill includes example resource directories that demonstrate how to organize different types of bundled resources:
+
+### scripts/
+Executable code (Python/Bash/etc.) that can be run directly to perform specific operations.
+
+**Examples from other skills:**
+- PDF skill: `fill_fillable_fields.py`, `extract_form_field_info.py` - utilities for PDF manipulation
+- DOCX skill: `document.py`, `utilities.py` - Python modules for document processing
+
+**Appropriate for:** Python scripts, shell scripts, or any executable code that performs automation, data processing, or specific operations.
+
+**Note:** Scripts may be executed without loading into context, but can still be read by Claude for patching or environment adjustments.
+
+### references/
+Documentation and reference material intended to be loaded into context to inform Claude's process and thinking.
+
+**Examples from other skills:**
+- Product management: `communication.md`, `context_building.md` - detailed workflow guides
+- BigQuery: API reference documentation and query examples
+- Finance: Schema documentation, company policies
+
+**Appropriate for:** In-depth documentation, API references, database schemas, comprehensive guides, or any detailed information that Claude should reference while working.
+
+### assets/
+Files not intended to be loaded into context, but rather used within the output Claude produces.
+
+**Examples from other skills:**
+- Brand styling: PowerPoint template files (.pptx), logo files
+- Frontend builder: HTML/React boilerplate project directories
+- Typography: Font files (.ttf, .woff2)
+
+**Appropriate for:** Templates, boilerplate code, document templates, images, icons, fonts, or any files meant to be copied or used in the final output.
+
+---
+
+**Any unneeded directories can be deleted.** Not every skill requires all three types of resources.
+"""
+
+EXAMPLE_SCRIPT = '''#!/usr/bin/env python3
+"""
+Example helper script for {skill_name}
+
+This is a placeholder script that can be executed directly.
+Replace with actual implementation or delete if not needed.
+
+Example real scripts from other skills:
+- pdf/scripts/fill_fillable_fields.py - Fills PDF form fields
+- pdf/scripts/convert_pdf_to_images.py - Converts PDF pages to images
+"""
+
+def main():
+    print("This is an example script for {skill_name}")
+    # TODO: Add actual script logic here
+    # This could be data processing, file conversion, API calls, etc.
+
+if __name__ == "__main__":
+    main()
+'''
+
+EXAMPLE_REFERENCE = """# Reference Documentation for {skill_title}
+
+This is a placeholder for detailed reference documentation.
+Replace with actual reference content or delete if not needed.
+
+Example real reference docs from other skills:
+- product-management/references/communication.md - Comprehensive guide for status updates
+- product-management/references/context_building.md - Deep-dive on gathering context
+- bigquery/references/ - API references and query examples
+
+## When Reference Docs Are Useful
+
+Reference docs are ideal for:
+- Comprehensive API documentation
+- Detailed workflow guides
+- Complex multi-step processes
+- Information too lengthy for main SKILL.md
+- Content that's only needed for specific use cases
+
+## Structure Suggestions
+
+### API Reference Example
+- Overview
+- Authentication
+- Endpoints with examples
+- Error codes
+- Rate limits
+
+### Workflow Guide Example
+- Prerequisites
+- Step-by-step instructions
+- Common patterns
+- Troubleshooting
+- Best practices
+"""
+
+EXAMPLE_ASSET = """# Example Asset File
+
+This placeholder represents where asset files would be stored.
+Replace with actual asset files (templates, images, fonts, etc.) or delete if not needed.
+
+Asset files are NOT intended to be loaded into context, but rather used within
+the output Claude produces.
+
+Example asset files from other skills:
+- Brand guidelines: logo.png, slides_template.pptx
+- Frontend builder: hello-world/ directory with HTML/React boilerplate
+- Typography: custom-font.ttf, font-family.woff2
+- Data: sample_data.csv, test_dataset.json
+
+## Common Asset Types
+
+- Templates: .pptx, .docx, boilerplate directories
+- Images: .png, .jpg, .svg, .gif
+- Fonts: .ttf, .otf, .woff, .woff2
+- Boilerplate code: Project directories, starter files
+- Icons: .ico, .svg
+- Data files: .csv, .json, .xml, .yaml
+
+Note: This is a text placeholder. Actual assets can be any file type.
+"""
+
+
+def title_case_skill_name(skill_name):
+    """Convert hyphenated skill name to Title Case for display."""
+    return ' '.join(word.capitalize() for word in skill_name.split('-'))
+
+
+def init_skill(skill_name, path):
+    """
+    Initialize a new skill directory with template SKILL.md.
+
+    Args:
+        skill_name: Name of the skill
+        path: Path where the skill directory should be created
+
+    Returns:
+        Path to created skill directory, or None if error
+    """
+    # Determine skill directory path
+    skill_dir = Path(path).resolve() / skill_name
+
+    # Check if directory already exists
+    if skill_dir.exists():
+        print(f"❌ Error: Skill directory already exists: {skill_dir}")
+        return None
+
+    # Create skill directory
+    try:
+        skill_dir.mkdir(parents=True, exist_ok=False)
+        print(f"✅ Created skill directory: {skill_dir}")
+    except Exception as e:
+        print(f"❌ Error creating directory: {e}")
+        return None
+
+    # Create SKILL.md from template
+    skill_title = title_case_skill_name(skill_name)
+    skill_content = SKILL_TEMPLATE.format(
+        skill_name=skill_name,
+        skill_title=skill_title
+    )
+
+    skill_md_path = skill_dir / 'SKILL.md'
+    try:
+        skill_md_path.write_text(skill_content)
+        print("✅ Created SKILL.md")
+    except Exception as e:
+        print(f"❌ Error creating SKILL.md: {e}")
+        return None
+
+    # Create resource directories with example files
+    try:
+        # Create scripts/ directory with example script
+        scripts_dir = skill_dir / 'scripts'
+        scripts_dir.mkdir(exist_ok=True)
+        example_script = scripts_dir / 'example.py'
+        example_script.write_text(EXAMPLE_SCRIPT.format(skill_name=skill_name))
+        example_script.chmod(0o755)
+        print("✅ Created scripts/example.py")
+
+        # Create references/ directory with example reference doc
+        references_dir = skill_dir / 'references'
+        references_dir.mkdir(exist_ok=True)
+        example_reference = references_dir / 'api_reference.md'
+        example_reference.write_text(EXAMPLE_REFERENCE.format(skill_title=skill_title))
+        print("✅ Created references/api_reference.md")
+
+        # Create assets/ directory with example asset placeholder
+        assets_dir = skill_dir / 'assets'
+        assets_dir.mkdir(exist_ok=True)
+        example_asset = assets_dir / 'example_asset.txt'
+        example_asset.write_text(EXAMPLE_ASSET)
+        print("✅ Created assets/example_asset.txt")
+    except Exception as e:
+        print(f"❌ Error creating resource directories: {e}")
+        return None
+
+    # Print next steps
+    print(f"\n✅ Skill '{skill_name}' initialized successfully at {skill_dir}")
+    print("\nNext steps:")
+    print("1. Edit SKILL.md to complete the TODO items and update the description")
+    print("2. Customize or delete the example files in scripts/, references/, and assets/")
+    print("3. Run the validator when ready to check the skill structure")
+
+    return skill_dir
+
+
+def main():
+    if len(sys.argv) < 4 or sys.argv[2] != '--path':
+        print("Usage: init_skill.py <skill-name> --path <path>")
+        print("\nSkill name requirements:")
+        print("  - Hyphen-case identifier (e.g., 'data-analyzer')")
+        print("  - Lowercase letters, digits, and hyphens only")
+        print("  - Max 40 characters")
+        print("  - Must match directory name exactly")
+        print("\nExamples:")
+        print("  init_skill.py my-new-skill --path skills/public")
+        print("  init_skill.py my-api-helper --path skills/private")
+        print("  init_skill.py custom-skill --path /custom/location")
+        sys.exit(1)
+
+    skill_name = sys.argv[1]
+    path = sys.argv[3]
+
+    print(f"🚀 Initializing skill: {skill_name}")
+    print(f"   Location: {path}")
+    print()
+
+    result = init_skill(skill_name, path)
+
+    if result:
+        sys.exit(0)
+    else:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()