smdev 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58945c4808bf1e113f8c9b2b3ea2a7ea56ac7d6d923ca72981e74fb1b0e2a43
-  data.tar.gz: f019058ffd24ab81660af47afb3d12a379bcbdad54c8f6190bafa6a2380ffa59
+  metadata.gz: 5f4e2aa439eb52fe028b25c321831575d0f1a9543da3320b849f07187d66ccc8
+  data.tar.gz: 66f79482307a323b1c96bf2f2e6bee35ae4b700ed9fa6fa6dcff7cd9b61c7d7c
 SHA512:
-  metadata.gz: c0949fa365a34eebafd409ca28a9ebedc390fd817f32908571f9475b0d981bfa80cdb4dccb2ffdaabb8b98516c7be1c3c920ae3d5f3a5a7df218716f2c865510
-  data.tar.gz: a314498451823793038cf014c529b2ccc1c1aa98283b5f507f05b5d5c68f2ec732908371f16ac95400d7d8b495758ea6590231815c489fecb91ab40717d3c909
+  metadata.gz: 55da40456e494d693c8aeff2e47dcffb4d82731db5129f2e1a1b0a3e33050e6be7bdc1833ffbed49d514be3ac45f9182387d15ecd29f574a8d526f11efa265c1
+  data.tar.gz: 3577639b832c7064b7fe54a90688eba6cc1eaa72aa09757a7fb82bb5c8f4ffdeeb6133d5dd23890e73f725ecf03b1a96575a09485dcbfbfcf788dd3b7b7a14bb

data/lib/smdev/cursor_rules/backup_manager.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+
+module Smdev
+  module CursorRules
+    class BackupManager
+      def initialize(target_dir, timestamp)
+        @target_dir = target_dir
+        @timestamp = timestamp
+        @backup_created = false
+      end
+
+      def create_backup
+        @backup_dir = File.join(@target_dir, '.cursor/backups', @timestamp)
+        FileUtils.mkdir_p(@backup_dir)
+        
+        backup_cursor_directory
+        backup_docs
+        
+        puts "📦 Created backup in: #{@backup_dir}"
+        @backup_created = true
+        true
+      end
+
+      def restore
+        return unless backup_exists?
+        
+        restore_directory('rules')
+        restore_directory('templates')
+        restore_docs
+
+        puts "♻️  Restored previous version from backup"
+        true
+      end
+
+      def backup_exists?
+        @backup_created
+      end
+
+      private
+
+      def backup_cursor_directory
+        ['rules', 'templates'].each do |dir|
+          backup_subdirectory(dir)
+        end
+      end
+
+      def backup_subdirectory(dir)
+        source_dir = File.join(@target_dir, '.cursor', dir)
+        return unless File.directory?(source_dir)
+
+        target_dir = File.join(@backup_dir, dir)
+        FileUtils.mkdir_p(target_dir)
+        
+        copy_directory_contents(source_dir, target_dir)
+      end
+
+      def copy_directory_contents(source_dir, target_dir)
+        Dir.glob(File.join(source_dir, '**/*')).each do |file|
+          next unless File.file?(file)
+          copy_file(file, source_dir, target_dir)
+        end
+      end
+
+      def copy_file(file, source_dir, target_dir)
+        rel_path = Pathname.new(file).relative_path_from(Pathname.new(source_dir)).to_s
+        target_file = File.join(target_dir, rel_path)
+        
+        FileUtils.mkdir_p(File.dirname(target_file))
+        FileUtils.cp(file, target_file)
+      end
+
+      def backup_docs
+        docs_dir = File.join(@target_dir, 'docs')
+        return unless File.directory?(docs_dir)
+
+        target_dir = File.join(@backup_dir, 'docs')
+        FileUtils.mkdir_p(target_dir)
+        
+        copy_directory_contents(docs_dir, target_dir)
+      end
+
+      def restore_directory(dir)
+        source_dir = File.join(@backup_dir, dir)
+        return unless File.directory?(source_dir)
+
+        target_dir = File.join(@target_dir, '.cursor', dir)
+        FileUtils.mkdir_p(target_dir)
+        
+        copy_directory_contents(source_dir, target_dir)
+      end
+
+      def restore_docs
+        source_dir = File.join(@backup_dir, 'docs')
+        return unless File.directory?(source_dir)
+
+        target_dir = File.join(@target_dir, 'docs')
+        FileUtils.mkdir_p(target_dir)
+        
+        copy_directory_contents(source_dir, target_dir)
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/config_manager.rb

@@ -0,0 +1,60 @@
+module Smdev
+  module CursorRules
+    # Handles configuration file updates for cursor rules
+    module ConfigManager
+      # Updates configuration files (.gitignore, .cursorignore, .cursorindexingignore)
+      #
+      # @return [void]
+      def update_configuration_files
+        update_gitignore
+        update_cursorignore
+        update_cursorindexingignore
+        puts "📝 Updated configuration files"
+      end
+
+      private
+
+      def update_gitignore
+        gitignore_path = File.join(@target_dir, '.gitignore')
+        gitignore_entries = [
+          "\n# Private individual user cursor rules",
+          ".cursor/rules/_*.mdc"
+        ]
+        
+        update_config_file(gitignore_path, gitignore_entries)
+      end
+
+      def update_cursorignore
+        cursorignore_path = File.join(@target_dir, '.cursorignore')
+        cursorignore_entries = [
+          "\n# Project notes and templates",
+          "xnotes/"
+        ]
+        
+        update_config_file(cursorignore_path, cursorignore_entries)
+      end
+
+      def update_cursorindexingignore
+        indexingignore_path = File.join(@target_dir, '.cursorindexingignore')
+        indexingignore_entries = [
+          "\n# Templates - accessible but not indexed",
+          ".cursor/templates/"
+        ]
+        
+        update_config_file(indexingignore_path, indexingignore_entries)
+      end
+
+      def update_config_file(file_path, entries)
+        content = File.exist?(file_path) ? File.read(file_path) : ""
+        
+        entries.each do |entry|
+          unless content.include?(entry)
+            content += "\n#{entry}"
+          end
+        end
+        
+        File.write(file_path, content.strip + "\n")
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/directory_manager.rb

@@ -0,0 +1,55 @@
+module Smdev
+  module CursorRules
+    # Handles directory creation and validation operations
+    class DirectoryManager
+      # Directory containing cursor rules and templates
+      CURSOR_DIR = '.cursor'
+      # Directory for cursor rules
+      RULES_DIR = File.join(CURSOR_DIR, 'rules')
+      # Directory for cursor templates
+      TEMPLATES_DIR = File.join(CURSOR_DIR, 'templates')
+      # Directory for documentation
+      DOCS_DIR = 'docs'
+      # Directory for backups
+      BACKUPS_DIR = File.join(CURSOR_DIR, 'backups')
+
+      def initialize(target_dir)
+        @target_dir = target_dir
+      end
+
+      def create_required_directories
+        [
+          CURSOR_DIR,
+          RULES_DIR,
+          TEMPLATES_DIR,
+          DOCS_DIR,
+          BACKUPS_DIR
+        ].each do |dir|
+          path = File.join(@target_dir, dir)
+          FileUtils.mkdir_p(path)
+          puts "📁 Created directory: #{dir}"
+        end
+      end
+
+      def cursor_rules_exist?
+        File.directory?(File.join(@target_dir, CURSOR_DIR))
+      end
+
+      def validate_target_directory
+        unless File.directory?(@target_dir)
+          raise Error, "Target directory '#{@target_dir}' does not exist"
+        end
+      end
+
+      def validate_source_directory(source_dir)
+        return if Dir.exist?(source_dir)
+        raise Error, "Source cursor directory not found in gem"
+      end
+
+      def validate_docs_directory(source_docs)
+        return if Dir.exist?(source_docs)
+        raise Error, "Source documentation not found in gem"
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/file_copier.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require 'pathname'
+
+module Smdev
+  module CursorRules
+    class FileCopier
+      def initialize(source_dir, target_dir)
+        @source_dir = source_dir
+        @target_dir = target_dir
+      end
+
+      def copy_rules(source_rules, target_rules)
+        FileUtils.mkdir_p(target_rules)
+        
+        Dir.glob(File.join(source_rules, '**', '*.mdc')).each do |source_file|
+          copy_with_path(source_file, source_rules, target_rules)
+        end
+      end
+
+      def copy_templates(source_templates, target_templates)
+        return unless Dir.exist?(source_templates)
+        
+        FileUtils.mkdir_p(target_templates)
+        FileUtils.cp_r(Dir.glob("#{source_templates}/*"), target_templates)
+      end
+
+      def copy_documentation(source_docs, target_docs)
+        FileUtils.mkdir_p(target_docs)
+        
+        Dir.glob(File.join(source_docs, '**', '*')).each do |file|
+          if File.file?(file)
+            copy_with_path(file, source_docs, target_docs)
+          elsif File.directory?(file)
+            rel_path = Pathname.new(file).relative_path_from(Pathname.new(source_docs)).to_s
+            FileUtils.mkdir_p(File.join(target_docs, rel_path))
+          end
+        end
+      end
+
+      private
+
+      def copy_with_path(source_file, source_base, target_base)
+        return unless File.file?(source_file)
+        
+        relative_path = Pathname.new(source_file).relative_path_from(Pathname.new(source_base)).to_s
+        target_file = File.join(target_base, relative_path)
+        
+        FileUtils.mkdir_p(File.dirname(target_file))
+        FileUtils.cp(source_file, target_file)
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/file_operations.rb

@@ -0,0 +1,83 @@
+require 'fileutils'
+
+module Smdev
+  module CursorRules
+    # Handles file operations for cursor rules installation
+    module FileOperations
+      # Constants for directory paths
+      CURSOR_DIR = '.cursor'
+      DOCS_DIR = 'docs'
+      CURSOR_SUBDIRS = ['rules', 'templates'].freeze
+
+      # Copies cursor rules and templates from source to target
+      #
+      # @raise [Error] if source directory is not found
+      def copy_cursor_files
+        validate_source_directory(File.join(@source_dir, CURSOR_DIR))
+        debug("Copying cursor files from #{@source_dir} to #{File.join(@target_dir, CURSOR_DIR)}")
+        
+        create_cursor_directories
+        copy_cursor_subdirectories
+        
+        puts "📝 Copied cursor rules and templates"
+      end
+
+      # Copies documentation files from source to target
+      #
+      # @raise [Error] if source documentation is not found
+      def copy_docs
+        docs_source = File.join(@source_dir, DOCS_DIR)
+        validate_source_directory(docs_source)
+        
+        debug("Copying docs from #{docs_source} to #{File.join(@target_dir, DOCS_DIR)}")
+        
+        # Create target directory
+        FileUtils.mkdir_p(File.join(@target_dir, DOCS_DIR))
+        
+        # Copy documentation files
+        copy_directory_contents(docs_source, File.join(@target_dir, DOCS_DIR))
+        
+        puts "📚 Copied documentation files"
+      end
+
+      private
+
+      def create_cursor_directories
+        CURSOR_SUBDIRS.each do |dir|
+          FileUtils.mkdir_p(File.join(@target_dir, CURSOR_DIR, dir))
+        end
+      end
+
+      def copy_cursor_subdirectories
+        CURSOR_SUBDIRS.each do |dir|
+          source = File.join(@source_dir, CURSOR_DIR, dir)
+          target = File.join(@target_dir, CURSOR_DIR, dir)
+          
+          copy_directory_contents(source, target) if File.directory?(source)
+        end
+      end
+
+      def copy_directory_contents(source_dir, target_dir)
+        Dir.glob(File.join(source_dir, '**/*')).each do |file|
+          next unless File.file?(file)
+          
+          rel_path = Pathname.new(file).relative_path_from(Pathname.new(source_dir)).to_s
+          target_file = File.join(target_dir, rel_path)
+          
+          debug("Copying #{file} to #{target_file}")
+          FileUtils.mkdir_p(File.dirname(target_file))
+          FileUtils.cp(file, target_file)
+        end
+      end
+
+      def validate_source_directory(dir)
+        return if File.directory?(dir)
+        raise Error, "Source directory '#{dir}' does not exist"
+      end
+
+      def debug(message)
+        puts "Debug: #{message}"
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/installer.rb

@@ -0,0 +1,128 @@
+require 'fileutils'
+require 'time'
+require_relative 'backup_manager'
+require_relative 'directory_manager'
+require_relative 'file_copier'
+require_relative 'user_interface'
+require_relative 'config_manager'
+
+module Smdev
+  module CursorRules
+    class Installer
+      include ConfigManager
+
+      CURSOR_DIR = '.cursor'
+      RULES_DIR = File.join(CURSOR_DIR, 'rules')
+      TEMPLATES_DIR = File.join(CURSOR_DIR, 'templates')
+      DOCS_DIR = 'docs'
+      BACKUPS_DIR = File.join(CURSOR_DIR, 'backups')
+
+      def initialize(target_dir, ui: UserInterface.new)
+        @target_dir = target_dir
+        @source_dir = CursorRules.templates_path
+        @directory_manager = DirectoryManager.new(target_dir)
+        @file_copier = FileCopier.new(@source_dir, target_dir)
+        @ui = ui
+        @backup_manager = BackupManager.new(target_dir, Time.now.strftime('%Y%m%d_%H%M%S'))
+      end
+
+      def install
+        begin
+          validate_and_prepare
+          perform_installation
+          @ui.display_success_message(@target_dir)
+          true
+        rescue StandardError => e
+          handle_error(e)
+          raise
+        end
+      end
+
+      private
+
+      def validate_and_prepare
+        @directory_manager.validate_target_directory
+        check_target_directory
+      end
+
+      def check_target_directory
+        if @directory_manager.cursor_rules_exist?
+          @ui.prompt_for_override
+          @backup_manager.create_backup
+        end
+        @directory_manager.create_required_directories
+      end
+
+      def perform_installation
+        copy_cursor_files
+        copy_docs
+        update_configuration_files
+      end
+
+      def copy_cursor_files
+        @directory_manager.validate_source_directory(@source_dir)
+        
+        source_rules = File.join(@source_dir, DirectoryManager::CURSOR_DIR, 'rules')
+        target_rules = File.join(@target_dir, DirectoryManager::RULES_DIR)
+        @file_copier.copy_rules(source_rules, target_rules)
+        
+        source_templates = File.join(@source_dir, DirectoryManager::CURSOR_DIR, 'templates')
+        target_templates = File.join(@target_dir, DirectoryManager::TEMPLATES_DIR)
+        @file_copier.copy_templates(source_templates, target_templates)
+        
+        puts "📝 Copied cursor rules and templates"
+      end
+
+      def copy_docs
+        source_docs = File.join(@source_dir, DirectoryManager::DOCS_DIR)
+        target_docs = File.join(@target_dir, DirectoryManager::DOCS_DIR)
+        
+        @directory_manager.validate_docs_directory(source_docs)
+        @file_copier.copy_documentation(source_docs, target_docs)
+        puts "📚 Copied documentation files"
+      end
+
+      def handle_error(error)
+        @ui.display_error(error)
+        @backup_manager.restore if @backup_manager.backup_exists?
+      end
+
+      def update_configuration_files
+        update_gitignore
+        update_cursorignore
+        update_cursorindexingignore
+        puts "📝 Updated configuration files"
+      end
+
+      def update_gitignore
+        gitignore_path = File.join(@target_dir, '.gitignore')
+        gitignore_entries = [
+          "\n# Private individual user cursor rules",
+          ".cursor/rules/_*.mdc"
+        ]
+        
+        update_config_file(gitignore_path, gitignore_entries)
+      end
+
+      def update_cursorignore
+        cursorignore_path = File.join(@target_dir, '.cursorignore')
+        cursorignore_entries = [
+          "\n# Project notes and templates",
+          "xnotes/"
+        ]
+        
+        update_config_file(cursorignore_path, cursorignore_entries)
+      end
+
+      def update_cursorindexingignore
+        indexingignore_path = File.join(@target_dir, '.cursorindexingignore')
+        indexingignore_entries = [
+          "\n# Templates - accessible but not indexed",
+          ".cursor/templates/"
+        ]
+        
+        update_config_file(indexingignore_path, indexingignore_entries)
+      end
+    end
+  end
+end 

data/lib/smdev/cursor_rules/templates/.cursor/rules/core-rules/readme.md

@@ -0,0 +1 @@
+Core rules related to cursor or rule generation

data/lib/smdev/cursor_rules/templates/.cursor/rules/core-rules/rule-generating-agent.mdc

@@ -0,0 +1,86 @@
+---
+description: Always follow this when the user requests that a rule be added or modified, or asks you to remember to always do something in the future
+globs: 
+alwaysApply: false
+---
+# Cursor Rules Format
+
+## Template Structure for Rules Files
+
+```mdc
+---
+description: `Explicit concise description to ensure the agent knows when to apply the rule` OR blank
+globs: .cursor/rules/**/*.mdc OR blank
+alwaysApply: {true or false}
+---
+
+# Rule Title
+
+## Context
+
+- When to apply this rule
+- Prerequisites or conditions
+- Why the rule was added or is needed
+
+## Critical Rules
+
+- Concise, bulleted list of actionable rules the agent MUST follow
+
+## Examples
+
+<example>
+{valid rule application}
+</example>
+
+<example type="invalid">
+{invalid rule application}
+<example>
+```
+
+### Organizational Folders (Create if non existent)
+All rules files will be under an organizational folder:
+- .cursor/rules/core-rules - rules related to cursor agent behavior or rule generation specifically
+- .cursor/rules/my-rules - gitignore in a shared repo, rules specifically for ME only
+- .cursor/rules/global-rules - these will be rules that are ALWAYS applied to every chat and cmd/ctrl-k context
+- .cursor/rules/testing-rules - rules about testing
+- .cursor/rules/tool-rules - rules specific to different tools, such as git, linux commands, direction of usage of MCP tools
+- .cursor/rules/ts-rules - typescript language specific rules
+- .cursor/rules/rb-rules - ruby specific rules
+- .cursor/rules/py-rules - python specific rules
+- .cursor/rules/ui-rules - rules about html, css, react
+* create new folders under .cursor/rules/ as needed following similar grouping conventions,
+    - for example `.cursor/rules/cs-rules` if we started using c# in a project
+
+## Glob Pattern Examples
+Common glob patterns for different rule types:
+- Core standards: .cursor/rules/*.mdc
+- Language rules: *.cs, *.cpp
+- Testing standards: *.test.ts, *.test.js
+- React components: src/components/**/*.tsx
+- Documentation: docs/**/*.md, *.md
+- Configuration files: *.config.js
+- Build artifacts: dist/**/*
+- Multiple extensions: *.js, *.ts, *.tsx, *.rb
+- Multiple patterns: dist/**/*.*, docs/**/*.md, *test*.*
+
+## Critical Rules
+  - Rule files will be located and named ALWAYS as: `.cursor/rules/{organizational-folder}/rule-name-{auto|agent|manual|always}.mdc`
+  - FrontMatter Rules Types:
+    - The front matter section must always start the file and include all 3 fields, even if the field value will be blank - the types are:
+      - Manual Rule: IF a Manual rule is requested - description and globs MUST be blank and alwaysApply: false and filename ends with -manual.mdc.
+      - Auto Rule: IF a rule is requested that should apply always to certain glob patterns (example all typescript files or all markdown files) - description must be blank, and alwaysApply: false and filename ends with -auto.mdc.
+      - Always Rule: Global Rule applies to every chat and cmd/ctrl-k - description and globs blank, and alwaysApply: true  and filename ends with -always.mdc.
+      - Agent Select Rule: The rule does not need to be loaded into every chat thread, it serves a specific purpose. The agent can see the descriptions, and choose to load the full rule in to context on its own - description is critical, globs blank, and alwaysApply:false and filename ends with -agent.mdc
+  - For the Rule Context and Bullets - do not repeat yourself and do not be overly explanatory
+  - When a rule will only be used sometimes (useAlways: false) it is CRITICAL that the description describes when the AI will load the full rule into its context
+  - Use Concise Markdown Tailored to Agent Context Window usage
+  - Always indent content within XML Example section with 2 spaces
+  - Emojis and Mermaid diagrams are allowed and encouraged if it is not redundant and better explains the rule for the AI comprehension.
+  - TRY to keep the total rule line count under 50 lines, better under 25 lines
+  - Always include a valid and invalid example
+  - NEVER use quotes around glob patterns, NEVER group glob extensions with `{}`
+  - If the request for a rule or a future behavior change includes context of a mistake is made, this would be great to use in the example for the rule
+  - After rule is created or updated, Respond with the following:
+    - AutoRuleGen Success: path/rule-name.mdc
+    - Rule Type: {Rule Type}
+    - Short summary of what the rule will do

data/lib/smdev/cursor_rules/templates/.cursor/rules/default.mdc

@@ -0,0 +1,42 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Default Cursor Rules
+
+## Manual Rules
+These rules can be triggered manually by the user.
+
+```cursor
+# Example manual rule
+@manual("Generate test file")
+def generate_test():
+    """Generate a new test file for the current module"""
+    # Your rule implementation here
+    pass
+```
+
+## Auto Rules
+These rules are triggered automatically based on file patterns.
+
+```cursor
+# Example auto rule
+@auto("*.py")
+def format_python(file):
+    """Format Python files on save"""
+    # Your rule implementation here
+    pass
+```
+
+## Always Rules
+These rules are always active.
+
+```cursor
+# Example always rule
+@always
+def maintain_style():
+    """Maintain code style consistency"""
+    # Your rule implementation here
+    pass
+``` 

data/lib/smdev/cursor_rules/templates/.cursor/rules/documentation/markdown-auto.mdc

@@ -0,0 +1,59 @@
+---
+description: ALWAYS use when writing or updating Markdown files to ensure consistent formatting and readability
+globs: **/*.md
+alwaysApply: false
+---
+
+# Markdown Documentation Standards
+
+## Context
+
+- When creating or modifying any Markdown documentation
+- When establishing documentation structure and style
+- When including diagrams, code blocks, or special elements in documentation
+
+## Critical Rules
+
+- Follow Markdown best practices for formatting
+- Maintain clear document structure with proper heading hierarchy
+- Use Mermaid UML diagrams for documenting complex sequences or architecture
+- Maximum heading depth: 4 levels
+- Indent content within XML tags by 2 spaces
+- Code Block need to indicate the language properly after the initial 3 backticks
+- Keep tables properly aligned
+
+## Examples
+
+<example>
+# Document Title
+
+## Section Heading
+
+Content with **bold text** and *italics*.
+
+```typescript
+function example(): void {
+  console.log('Hello, Universe!');
+}
+```
+
+| Name  | Type   | Description  |
+|:-----:|:------:|:------------:|
+| id    | number | Primary key  |
+| name  | string | User's name  |
+
+> 💡 **Tip:** Helpful suggestion.
+</example>
+
+<example type="invalid">
+#Incorrect Heading
+content without proper spacing
+
+```
+function withoutLanguageSpecified() {
+}
+```
+
+|No|proper|alignment|And|invalid|table
+| or | proper | formatting |||||
+</example>

data/lib/smdev/cursor_rules/templates/.cursor/rules/documentation/readme.md

@@ -0,0 +1 @@
+Rules related to documenting files