to_llm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 522bcb09f3066274f26eba424d65b7bd520f74e04c55c83f0b0a56640f787b69
+  data.tar.gz: 59c1905979d7beae0930d23a465e6ee0b3c6e64a0451fed97c90f90daa6aa566
+SHA512:
+  metadata.gz: 6ef6416cc24a686d615add69c851cc1241797f1ef20ec2913fc8c2029296771aef89877c93ab8e9c7a2fb4f4e7e7dfffad9c790249f45593e0c3e02a37665158
+  data.tar.gz: 44ce278ed645cec0fbbebb282da7e69a9b87f921643a0c6fac6404b28f68ad37073973ca8102aa044daf117cabb2b33d4a6306472878b1eb749ab332f4e28535

data/README.md

@@ -0,0 +1,171 @@
+Below is an example of a **README.md** that you might include in your GitHub repository for a gem named **to_llm**. Feel free to adjust any sections (e.g., badges, license, usage details) to match your project’s specifics.
+
+---
+
+# to_llm
+
+[![Gem Version](https://badge.fury.io/rb/to_llm.svg)](https://badge.fury.io/rb/to_llm)
+[![Build Status](https://github.com/your_user/to_llm/actions/workflows/ci.yml/badge.svg)](https://github.com/your_user/to_llm/actions)
+[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.txt)
+
+**to_llm** is a lightweight Ruby gem that provides a simple set of tasks (or commands) to extract code from a Rails application into text files. This is useful if you want to feed your Rails codebase into a Large Language Model (LLM) or any text-based analysis tool.
+
+---
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Configuration](#configuration)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Features
+
+- **Simple extraction**: Automatically scans your Rails app for files in `app/models`, `app/views`, `app/controllers`, etc.  
+- **Configurable**: By default, extracts `.rb`, `.erb`, `.js`, and `.yml` file types, but you can easily adjust.  
+- **Rake tasks**: Provides a Rake task (`to_llm:extract`) to keep usage straightforward.  
+- **Keeps files separate**: Creates separate `.txt` output files (e.g., `models.txt`, `views.txt`) for easier organization (or combine them, if you prefer).
+
+---
+
+## Installation
+
+Add this line to your Rails project’s `Gemfile`:
+
+```ruby
+gem 'to_llm', git: 'https://github.com/jcmaciel/to_llm.git'
+```
+
+> Or using RubyGems
+> ```ruby
+> gem 'to_llm'
+> ```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+---
+
+## Usage
+
+Once installed, the gem integrates with your Rails app via a Railtie that exposes one or more rake tasks. By default, you can run:
+
+```bash
+rails to_llm:extract -[ALL|MODELS|CONTROLLERS|VIEWS|CONFIG|SCHEMA]
+```
+
+Each of these commands will scan the relevant folders in your Rails app and produce text files containing all the code it finds.
+
+---
+
+## Commands
+
+### 1. `rails to_llm:extract ALL`
+
+- **Description**: Extracts from all supported Rails directories:
+  - `app/models` -> `models.txt`  
+  - `app/controllers` -> `controllers.txt`  
+  - `app/views` -> `views.txt`  
+  - `app/helpers` -> `helpers.txt`  
+  - `config` -> `config.txt` (including `config/initializers`)  
+  - `db/schema.rb` -> `schema.txt`  
+- **Result**: Creates a folder named `to_llm/` with separate `.txt` files.
+
+### 2. `rails to_llm:extract MODELS`
+
+- **Description**: Extracts only files from `app/models`.
+- **Output**: Creates (or overwrites) `to_llm/models.txt`.
+
+### 3. `rails to_llm:extract CONTROLLERS`
+
+- **Description**: Extracts only from `app/controllers`.
+- **Output**: `to_llm/controllers.txt`.
+
+### 4. `rails to_llm:extract VIEWS`
+
+- **Description**: Extracts from `app/views`.
+- **Output**: `to_llm/views.txt`.
+
+### 5. `rails to_llm:extract CONFIG`
+
+- **Description**: Extracts from `config`, including `config/initializers`.
+- **Output**: `to_llm/config.txt`.
+
+### 6. `rails to_llm:extract SCHEMA`
+
+- **Description**: Extracts only `db/schema.rb`.
+- **Output**: `to_llm/schema.txt`.
+
+---
+
+## Configuration
+
+If you want to customize what extensions are included or which directories map to which output files, open the `lib/tasks/to_llm.rake` file (inside this gem) and edit:
+
+```ruby
+file_extensions = %w[.rb .erb .js .yml]
+directories_to_files = {
+  "app/models"      => "models.txt",
+  "app/controllers" => "controllers.txt",
+  # ...
+}
+```
+
+This gem is intentionally minimalist. Feel free to fork or override these settings in your local app.
+
+---
+
+## Examples
+
+1. **Extract everything**:
+   ```bash
+   rails to_llm:extract -ALL
+   ```
+   Generates:
+   ```
+   extracted_files/
+     models.txt
+     controllers.txt
+     views.txt
+     helpers.txt
+     config.txt
+     schema.txt
+   ```
+
+2. **Extract only views**:
+   ```bash
+   rails to_llm:extract -VIEWS
+   ```
+   Generates:
+   ```
+   extracted_files/
+     views.txt
+   ```
+   (Note that any previously existing files in `to_llm` will be untouched or overwritten if they have the same filename.)
+
+---
+
+## Contributing
+
+1. Fork the repo on GitHub.
+2. Create a new branch for your feature (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to your branch (`git push origin my-new-feature`).
+5. Create a Pull Request on GitHub.
+
+We welcome issues, PRs, and general feedback!
+
+---
+
+## License
+
+This project is available as open source under the terms of the [MIT License](./LICENSE.txt). Feel free to use it in your own projects.

data/lib/tasks/to_llm.rake

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+#
+# rails to_llm:extract -ALL
+# rails to_llm:extract -MODELS
+# rails to_llm:extract -CONTROLLERS
+# rails to_llm:extract -VIEWS
+# rails to_llm:extract -CONFIG
+# rails to_llm:extract -SCHEMA
+#
+
+
+namespace :to_llm do
+  desc "Extract code for LLM usage. Usage: rails to_llm:extract [ALL|MODELS|CONTROLLERS|VIEWS|CONFIG|SCHEMA]"
+  task :extract, [:type] => :environment do |_t, args|
+    # Default to "ALL" if no argument
+    extract_type = args[:type]&.upcase || "ALL"
+    
+    puts "----- to_llm:extract started with type=#{extract_type} -----"
+
+    # Directory where extracted files will be stored
+    output_dir = "to_llm"
+    FileUtils.mkdir_p(output_dir)
+
+    # Define which directories to process
+    directories_to_files = {
+      "app/models"      => "models.txt",
+      "app/controllers" => "controllers.txt",
+      "app/views"       => "views.txt",
+      "app/helpers"     => "helpers.txt",
+      "config"          => "config.txt", 
+      "db/schema.rb"    => "schema.txt"
+    }
+
+    # We can filter which directories to process based on the user input
+    filter_map = {
+      "ALL"         => %w[app/models app/controllers app/views app/helpers config db/schema.rb],
+      "MODELS"      => %w[app/models],
+      "CONTROLLERS" => %w[app/controllers],
+      "VIEWS"       => %w[app/views],
+      "CONFIG"      => %w[config],
+      "SCHEMA"      => %w[db/schema.rb]
+    }
+
+    # Define which extensions you want to extract
+    file_extensions = %w[.rb .erb .js .yml]
+
+    directories_to_files.values.each do |filename|
+      file_path = File.join(output_dir, filename)
+      File.delete(file_path) if File.exist?(file_path)
+    end
+
+    def extract_files(dir_path, file_extensions, output_file, output_dir)
+      Dir.glob(File.join(dir_path, "**", "*")) do |path|
+        next if File.directory?(path)
+        next unless file_extensions.include?(File.extname(path))
+
+        File.open(File.join(output_dir, output_file), "a") do |f|
+          f.puts "#{path}:"
+          f.puts "----------------------------------------------------"
+          f.puts File.read(path)
+          f.puts "\n"
+        end
+      end
+    end
+
+    (filter_map[extract_type] || []).each do |dir_or_file|
+      next unless directories_to_files.key?(dir_or_file)
+      output_name = directories_to_files[dir_or_file]
+
+      if File.file?(dir_or_file)
+        if File.exist?(dir_or_file)
+          File.open(File.join(output_dir, output_name), "a") do |f|
+            f.puts "#{dir_or_file}:"
+            f.puts "----------------------------------------------------"
+            f.puts File.read(dir_or_file)
+            f.puts "\n"
+          end
+        end
+      else
+        extract_files(dir_or_file, file_extensions, output_name, output_dir)
+      end
+    end
+
+    puts "----- to_llm:extract finished! Output is located in '#{output_dir}' -----"
+  end
+end

data/lib/to_llm/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module ToLLM
+  class Railtie < ::Rails::Railtie
+    railtie_name :to_llm
+
+    rake_tasks do
+      load 'tasks/to_llm.rake'
+    end
+  end
+end

data/lib/to_llm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ToLLM
+  VERSION = "0.1.0"
+end

data/lib/to_llm.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "to_llm/version"
+require_relative "to_llm/railtie" if defined?(Rails)
+
+module ToLLM
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: to_llm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- José Carlos Maciel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple gem that provides a Rails command or Rake tasks to export .rb,
+  .erb, .js, and .yml files into .txt for LLM ingestion.
+email:
+- jcmacielp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tasks/to_llm.rake
+- lib/to_llm.rb
+- lib/to_llm/railtie.rb
+- lib/to_llm/version.rb
+homepage: https://github.com/jcmaciel/to_llm
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Extracts code from a Rails project to text files for LLM usage.
+test_files: []