contextizer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f686acf8deb4c945333560100cca7bc0132461edb87a7e5b75746e9aff9482b1
+  data.tar.gz: 95d945436b9f4756fc85fef28c6400b73e22a5f754366c3aefadb7fe13fc76b7
+SHA512:
+  metadata.gz: bbb33df56969a8803c1baa62a49525fd8a90399d7a962078c717f40ce2fcf72b055effcf2a4bd959bc11ca01d1641db15b86d460bf0dc7098b64b82656c556a3
+  data.tar.gz: f9ed53fbb18f9a819e4b7f3b5b05027b28c676f6df711f1106f3193e0bad2e8fea7a45f2a570e168fad3137a9ed4e36a4133ca85aa8276812e1162041f9c102e

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG.md
+
+## 0.1.0 (September 01, 2025)
+
+* Initial public release.
+* Core functionality: context extraction for local and remote Git repositories.
+* Automatic stack analysis for Ruby and JavaScript projects.
+* Flexible configuration via `.contextizer.yml`.
+* Markdown report generation with file tree and metadata.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# Contextizer
+
+**Contextizer** is a versatile command-line tool for extracting, analyzing, and packaging the context of any software project. It scans a codebase, gathers key metadata (language, framework, dependencies, git status), and aggregates the source code into a single, easy-to-digest Markdown report.
+
+It's the perfect tool for:
+-   Preparing context for analysis by Large Language Models (LLMs).
+-   Quickly onboarding a new developer to a project.
+-   Archiving a project snapshot for a code review.
+-   Creating comprehensive bug reports.
+
+
+## Key Features
+
+* **Polyglot by Design:** Automatically detects a project's primary language and framework (Ruby/Rails, JavaScript, etc.) using a smart "signals and weights" system.
+* **Plug-and-Play Architecture:** Easily extendable to support new languages and frameworks by adding new "Analyzers" and "Providers".
+* **Rich Metadata Collection:** Extracts Git information (branch, commit), key dependencies (`Gemfile`, `package.json`), and the project's structure.
+* **Remote Repository Analysis:** Can clone and analyze any public Git repository directly from a URL, no manual cloning required.
+* **Flexible Configuration:** Controlled via a simple YAML file (`.contextizer.yml`) in your project's root, allowing you to fine-tune the data collection process.
+* **Clean & Readable Reports:** Generates a single Markdown file with a visual file tree, project metadata, and syntax-highlighted source code.
+
+
+## Installation
+
+### Standalone (Recommended)
+
+Install the gem globally to use it in any project on your system:
+
+```bash
+gem install contextizer
+```
+
+### As a Project Dependency (Bundler)
+
+Add it to your project's `Gemfile` within the `:development` group:
+
+```ruby
+# Gemfile
+group :development do
+  gem 'contextizer'
+end
+```
+
+Then, execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### Analyzing a Local Project
+
+Navigate to your project's root directory and run:
+
+```bash
+contextizer extract
+```
+
+The report will be saved in the current directory by default.
+
+### Analyzing a Remote Git Repository
+
+Use the `--git-url` option to analyze any public repository:
+
+```bash
+contextizer extract --git-url https://github.com/rails/rails
+```
+
+### Common Options
+
+- `[TARGET_PATH]`: (Optional) The path to the directory to analyze. Defaults to the current directory.
+- `--git-url URL`: The URL of a remote Git repository to analyze.
+- `-o, --output PATH`: The destination path for the final report file.
+- `-f, --format FORMAT`: The output format (currently supports `markdown`).
+
+## Configuration
+
+To customize Contextizer for your project, create a `.contextizer.yml` file in its root directory.
+
+The tool uses a three-tiered configuration system with the following priority:
+
+CLI Options > .contextizer.yml > Gem Defaults
+
+### Example `.contextizer.yml`
+
+YAML
+
+```yml
+# .contextizer.yml
+
+# Path to save the report.
+# Available placeholders: {project_name}, {timestamp}
+output: "docs/context/{project_name}_{timestamp}.md"
+
+# Settings for specific providers
+settings:
+  # Settings for the Ruby gems provider
+  gems:
+    key_gems: # List your project's most important gems here
+      - rails
+      - devise
+      - sidekiq
+      - rspec-rails
+      - pg
+      - pundit
+
+  # Settings for the filesystem provider
+  filesystem:
+    # Specify which files and directories to include in the report
+    components:
+      models: "app/models/**/*.rb"
+      controllers: "app/controllers/**/*.rb"
+      services: "app/services/**/*.rb"
+      javascript: "app/javascript/**/*.js"
+      config:
+        - "config/routes.rb"
+        - "config/application.rb"
+      documentation:
+        - "README.md"
+        - "CONTRIBUTING.md"
+
+    # Global exclusion patterns
+    exclude:
+      - "tmp/**/*"
+      - "log/**/*"
+      - "node_modules/**/*"
+      - ".git/**/*"
+      - "vendor/**/*"
+```
+
+## Extensibility (Adding a New Language)
+
+Thanks to the plug-and-play architecture, adding support for a new language is straightforward:
+
+1. **Create a Specialist Analyzer**: Add a new file in `lib/contextizer/analyzers/` that detects the language based on its characteristic files and directories.
+2. **Create Providers**: Add a new directory in `lib/contextizer/providers/` with providers that extract language-specific information (e.g., dependencies from a `pom.xml` file for Java).
+
+The main `Analyzer` and `Collector` will automatically discover and use your new components.
+
+## Contributing
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.
+
+
+---
+
+## License
+
+This project is released under the MIT License.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require_relative "lib/contextizer/version"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/config/default.yml

@@ -0,0 +1,53 @@
+# config/default.yml
+# Gem's default configuration. DO NOT EDIT.
+# Create a .contextizer.yml in your project to override.
+
+# Default output path.
+# Placeholders: {profile}, {timestamp}, {project_name}
+#output: "tmp/contextizer/{profile}_{timestamp}.md"
+output: "{project_name}_{timestamp}.md"
+
+# Default rendering format.
+format: "markdown"
+
+# Provider settings.
+providers:
+  git: true
+  filesystem: true
+  gems: true
+  project_info: true
+  # Framework-specific providers are disabled by default.
+  # They will be auto-enabled if the environment is detected.
+  rails_routes: "auto"
+  rails_schema: "auto"
+
+# Settings for specific providers.
+settings:
+  gems:
+    key_gems:
+      - rails
+      - devise
+      - sidekiq
+      - rspec-rails
+      - pg
+  filesystem:
+    # Default component definitions for a typical Ruby/Rails project.
+    components:
+      models: "app/models/**/*.rb"
+      views: "app/views/**/*.{erb,haml,slim,arb}"
+      controllers: "app/controllers/**/*.rb"
+      services: "app/services/**/*.rb"
+      lib: "lib/**/*.rb"
+      config: "config/**/*.{rb,yml}"
+      gem: # For gem development
+        - "*.gemspec"
+        - "lib/**/*.rb"
+        - "README.md"
+        - "CHANGELOG.md"
+      documentation: "*.md"
+    # Files/directories to exclude globally.
+    exclude:
+      - "tmp/**/*"
+      - "log/**/*"
+      - "node_modules/**/*"
+      - ".git/**/*"