agents_skill_vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b05e0650894ce571b50930b4aac065e83d6581483a0598f16e013438b6072b90
+  data.tar.gz: d4eb75579062ff3f3b40b3c4a86afc73a5ff09a032507c4197ee84719eb328c4
+SHA512:
+  metadata.gz: 83157f20b44848507c3704957254d7fa7498054aeafdfdff1c3d1e59f465f2e2bee67b3c9b4f9aa35b2723e56331479695b5ac936378ea21ca9303ef14693d33
+  data.tar.gz: 4735da42f45aebb580afd1cb9cd205bf09260b6e80e8196f8afb5d9626edd2004a2c6c3397efe55763b2847719b556d7ecf8acc0c003baaddc3c27ae933f2b31

data/AGENTS.md

@@ -0,0 +1,93 @@
+# AgentsSkillVault
+
+A Ruby gem for managing a local vault of GitHub resources (repositories, folders, or files). Supports sparse checkout, sync management, and skill validation.
+
+## Quick Reference
+
+```bash
+# Run tests
+bundle exec rake test
+
+# Run linter
+bundle exec rake rubocop
+
+# Run both (default task)
+bundle exec rake
+
+# Interactive console
+bin/console
+```
+
+## Architecture
+
+### Core Components
+
+- **Vault** (`lib/agents_skill_vault/vault.rb`) - Main interface for managing resources. Handles add, sync, remove, validate operations.
+- **UrlParser** (`lib/agents_skill_vault/url_parser.rb`) - Parses GitHub URLs into components (username, repo, branch, path, type).
+- **GitOperations** (`lib/agents_skill_vault/git_operations.rb`) - Git commands wrapper for clone, sparse checkout, pull.
+- **Resource** (`lib/agents_skill_vault/resource.rb`) - Data object representing a tracked resource.
+- **Manifest** (`lib/agents_skill_vault/manifest.rb`) - JSON manifest persistence for tracking resources.
+- **SkillScanner** (`lib/agents_skill_vault/skill_scanner.rb`) - Scans directories for SKILL.md files.
+- **SkillValidator** (`lib/agents_skill_vault/skill_validator.rb`) - Validates SKILL.md file structure.
+- **SyncResult** (`lib/agents_skill_vault/sync_result.rb`) - Result object for sync operations.
+- **Errors** (`lib/agents_skill_vault/errors/`) - Custom error classes.
+
+### Key Patterns
+
+**Label Format**: Labels follow `username/repo/skill_name` format for skills and folders, `username/repo` for repositories.
+
+**Storage Structure**: Resources are stored at `<VAULT>/username/repo/relative_path`.
+
+**URL Types**:
+- `:repo` - Full repository (`https://github.com/user/repo`)
+- `:folder` - Directory via tree (`https://github.com/user/repo/tree/main/path`)
+- `:file` - File via blob (`https://github.com/user/repo/blob/main/path/SKILL.md`)
+
+**Autoloading**: Uses Zeitwerk for autoloading. File names must match class names (snake_case to CamelCase).
+
+## Testing
+
+- **Framework**: Minitest
+- **Mocking**: Mocha (`mocha/minitest`)
+- **Test files**: `test/*_test.rb`
+- **Helper**: `test/test_helper.rb` provides `TestHelper.temp_vault_path` for temp directories
+
+### Test Conventions
+
+```ruby
+class MyClassTest < Minitest::Test
+  def setup
+    @storage_path = TestHelper.temp_vault_path
+    FileUtils.mkdir_p(@storage_path)
+  end
+
+  def teardown
+    FileUtils.rm_rf(@storage_path)
+  end
+
+  def test_something
+    # Use stubs for GitOperations to avoid real git calls
+    AgentsSkillVault::GitOperations.stubs(:clone_repo)
+    AgentsSkillVault::GitOperations.stubs(:sparse_checkout)
+  end
+end
+```
+
+## Code Style
+
+- Ruby 3.4+ required
+- Double quotes for strings (configured in `.rubocop.yml`)
+- `frozen_string_literal: true` in all Ruby files
+- YARD-style documentation for public methods
+- Max method length: 20 lines
+- Max class length: 150 lines
+
+## Dependencies
+
+- `addressable` - URL parsing with proper encoding
+- `zeitwerk` - Autoloading
+- `mocha` - Test mocking (development)
+
+## Git Requirements
+
+Requires Git 2.25.0+ for sparse checkout support. The gem validates git availability on Vault initialization.

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-01-25
+
+### Features
+
+- Add GitHub repositories, folders, or individual files to a local vault
+- Sync resources to pull latest changes from remote repositories
+- Remove tracked resources from the vault
+- Sparse checkout support for efficient partial repository cloning
+- JSON manifest persistence for tracking resources
+- Skill validation for SKILL.md files
+- GitHub URL parsing supporting repositories, tree/folder, and blob/file URLs
+- Git operations abstraction (clone, sparse checkout, pull)
+- Resource labeling with username/repo/skill_name format
+
+### Supported URL Types
+
+- Repository: `https://github.com/user/repo`
+- Folder: `https://github.com/user/repo/tree/main/path/to/folder`
+- File: `https://github.com/user/repo/blob/main/path/to/file.md`

data/CLAUDE.md

@@ -0,0 +1 @@
+Read AGENTS.md file

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"agents_skill_vault" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["lucianghinda@users.noreply.github.com"](mailto:"lucianghinda@users.noreply.github.com").

data/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucianghinda/agents_skill_vault.
+
+## Development Setup
+
+1. Clone the repository
+2. Install dependencies: `bundle install`
+
+## Running Tests
+
+Run the full test suite:
+```bash
+bundle exec rake
+```
+
+Run specific tests:
+```bash
+bundle exec ruby -Ilib:test test/some_test.rb
+```
+
+## Code Style
+
+Run RuboCop to check code style:
+```bash
+bundle exec rake rubocop
+```
+
+Auto-fix style issues:
+```bash
+bundle exec rubocop -a
+```
+
+## Development Workflow
+
+1. Create a new branch for your feature or bugfix
+2. Write tests for your changes
+3. Make your changes
+4. Run `bundle exec rake` to ensure tests pass and code style is correct
+5. Commit your changes with a clear message
+6. Push to your fork and submit a pull request
+
+## Code Style Guidelines
+
+- Follow Ruby style as configured in `.rubocop.yml`
+- Use double quotes for strings
+- Include `frozen_string_literal: true` in all Ruby files
+- Max method length: 20 lines
+- Max class length: 150 lines
+- Write YARD-style documentation for public methods
+
+## Architecture
+
+The codebase is organized into several core components:
+
+- `Vault` - Main interface for managing resources
+- `UrlParser` - Parses GitHub URLs into components
+- `GitOperations` - Git commands wrapper
+- `Resource` - Data object representing a tracked resource
+- `Manifest` - JSON manifest persistence
+- `SkillScanner` - Scans directories for SKILL.md files
+- `SkillValidator` - Validates SKILL.md file structure
+
+See `AGENTS.md` for more detailed architecture documentation.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,268 @@
+# AgentsSkillVault
+
+A Ruby gem for managing a local vault of GitHub resources that contains Agent Skill specifications. 
+Clone entire repositories or specific folders, keep them synced, and query them by username or repository name.
+
+Currently works only with Github. Future plans will include to support any Git based repository. 
+
+## Overview
+
+AgentsSkillVault helps you maintain a local collection of GitHub resources (repositories, folders, or files) with:
+
+- **Easy addition** - Add resources via GitHub URL
+- **Sparse checkout** - Clone only the folders you need, not entire repos
+- **Sync management** - Pull latest changes with one command
+- **Querying** - Filter resources by username or repository name
+- **Manifest tracking** - All resources tracked in a JSON manifest for portability
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "agents_skill_vault"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install agents_skill_vault
+```
+
+**Requirements:**
+- Ruby 3.4+
+- Git 2.25.0+ (for sparse checkout support)
+
+## Quick Start
+
+```ruby
+require "agents_skill_vault"
+
+# Create a vault in a directory
+vault = AgentsSkillVault::Vault.new(storage_path: "~/.my_vault")
+
+# Add a full repository
+vault.add("https://github.com/rails/rails")
+
+# Add a specific folder with a custom label
+vault.add(
+  "https://github.com/user/dotfiles/tree/main/.claude/skills/deep-research",
+  label: "deep-research"
+)
+
+# List all resources
+vault.list.each do |resource|
+  puts "#{resource.label} -> #{resource.local_path}"
+end
+
+# Sync a specific resource
+result = vault.sync("rails/rails")
+puts "Synced!" if result.success?
+
+# Sync all resources
+vault.sync_all
+```
+
+## API Reference
+
+### Vault
+
+The main interface for managing resources.
+
+#### Creating a Vault
+
+```ruby
+vault = AgentsSkillVault::Vault.new(storage_path: "/path/to/vault")
+```
+
+#### Adding Resources
+
+```ruby
+# Add a repository (auto-generates label: "username/repo")
+vault.add("https://github.com/user/repo")
+
+# Add with custom label
+vault.add("https://github.com/user/repo", label: "my-custom-label")
+
+# Add a specific folder (uses sparse checkout)
+vault.add("https://github.com/user/repo/tree/main/lib/skills")
+
+# Add a specific file
+vault.add("https://github.com/user/repo/blob/main/config.yml")
+```
+
+#### Querying Resources
+
+```ruby
+# List all resources
+resources = vault.list
+
+# Find by label (returns nil if not found)
+resource = vault.find_by_label("user/repo")
+
+# Fetch by label (raises Errors::NotFound if not found)
+resource = vault.fetch("user/repo")
+
+# Filter by GitHub username
+vault.filter_by_username("octocat")  # => [Resource, ...]
+
+# Filter by repository name
+vault.filter_by_repo("dotfiles")  # => [Resource, ...]
+```
+
+#### Syncing Resources
+
+```ruby
+# Sync a single resource
+result = vault.sync("user/repo")
+if result.success?
+  puts "Changes: #{result.changes?}"
+else
+  puts "Error: #{result.error}"
+end
+
+# Sync all resources
+results = vault.sync_all
+results.each do |label, result|
+  status = result.success? ? "OK" : result.error
+  puts "#{label}: #{status}"
+end
+```
+
+#### Removing Resources
+
+```ruby
+# Remove from manifest only (keep files on disk)
+vault.remove("user/repo")
+
+# Remove from manifest AND delete files
+vault.remove("user/repo", delete_files: true)
+```
+
+#### Backup and Restore
+
+```ruby
+# Export manifest for backup
+vault.export_manifest("/backups/manifest.json")
+
+# Import manifest (merges with existing resources)
+vault.import_manifest("/shared/manifest.json")
+
+# Re-download all resources from scratch
+vault.redownload_all
+```
+
+### Resource
+
+Represents a tracked GitHub resource.
+
+```ruby
+resource = vault.fetch("user/repo")
+
+resource.label          # => "user/repo"
+resource.url            # => "https://github.com/user/repo"
+resource.username       # => "user"
+resource.repo           # => "repo"
+resource.type           # => :repo, :folder, or :file
+resource.branch         # => "main"
+resource.local_path     # => "/vault/user/repo"
+resource.relative_path  # => nil (or path within repo for folders/files)
+resource.added_at       # => Time
+resource.synced_at      # => Time
+```
+
+### SyncResult
+
+Returned by sync operations.
+
+```ruby
+result = vault.sync("user/repo")
+
+result.success?  # => true/false
+result.changes?  # => true/false (did the sync pull new changes?)
+result.error     # => nil or error message string
+```
+
+### Error Handling
+
+```ruby
+begin
+  vault.add("invalid-url")
+rescue AgentsSkillVault::Errors::InvalidUrl => e
+  puts "Bad URL: #{e.message}"
+end
+
+begin
+  vault.fetch("nonexistent")
+rescue AgentsSkillVault::Errors::NotFound => e
+  puts "Not found: #{e.message}"
+end
+
+begin
+  vault.add("https://github.com/user/repo")
+  vault.add("https://github.com/other/thing", label: "user/repo")
+rescue AgentsSkillVault::Errors::DuplicateLabel => e
+  puts "Duplicate: #{e.message}"
+end
+```
+
+## Common Use Cases
+
+### Managing Claude Code Skills
+
+```ruby
+vault = AgentsSkillVault::Vault.new(storage_path: "~/.claude/skill_vault")
+
+# Add skills from various sources
+vault.add("https://github.com/anthropics/claude-code/tree/main/skills/web-search")
+vault.add("https://github.com/user/my-skills/tree/main/coding-assistant", label: "coding")
+
+# Keep everything up to date
+vault.sync_all
+```
+
+### Sharing Resource Collections
+
+```ruby
+# On machine A: Export your vault configuration
+vault.export_manifest("~/Dropbox/vault-manifest.json")
+
+# On machine B: Import and download
+new_vault = AgentsSkillVault::Vault.new(storage_path: "~/.vault")
+new_vault.import_manifest("~/Dropbox/vault-manifest.json")
+new_vault.redownload_all
+```
+
+### Selective Repository Checkout
+
+```ruby
+# Instead of cloning a huge monorepo, just get the folder you need
+vault.add(
+  "https://github.com/big-org/monorepo/tree/main/packages/useful-lib",
+  label: "useful-lib"
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+```bash
+bundle exec rake test
+```
+
+You can also run `bin/console` for an interactive prompt.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucianghinda/agents_skill_vault.
+
+## License
+
+The gem is available as open source under the terms of the Apache 2.0 License.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/agents_skill_vault/errors/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AgentsSkillVault
+  module Errors
+    class Error < StandardError; end
+  end
+end