gaggle 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 664fb3a60aaaf857cc33ca007635ed9648f184125e7a1ffe90966ebc225b3d29
+  data.tar.gz: 46958501cc2bffa80ec0ab7760720d7f6cea4ec96e8387f316da9cccbc2a8214
+SHA512:
+  metadata.gz: 711987c0e036a45f86ccc6c050fdd8ec4236ee399f9a7d1dba4137ca06039f2af2981dd915291f718ef4f7cc08347370ffb063ec3775f22c1fcd6c9bb3378d80
+  data.tar.gz: 6a5d30f9119fe13a76d822962f33287fbf15c0c8387e99dc0064342d6c39bed9f4529285ba3e9cd95f88c16d1a18963be9834175ecc453702c399b8ae0bd16d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Tonksthebear
+
+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,167 @@
+# Gaggle
+
+Gaggle is a Rails engine designed for development use that orchestrates multiple instances of [Goose](https://github.com/block/goose). The name is a play on words inspired by the term for a group of geese, reflecting its role in managing and coordinating multiple instances of the underlying "Goose" service.
+
+**These are Goose instances. They can and will do things on your computer confidently. They will churn through tokens and also potentially change things you don't want. Be responsible**
+
+**Want to just run the app? Check out the sample [Gaggle Chat](https://github.com/Tonksthebear/GaggleChat)**
+
+## Features
+- Assign names and prompts to Goose instances
+  - View and interact with goose instances through the running terminal directly through the web interface
+  - Message and collaborate with your gaggle through message threads
+- Both Goose and Human can
+  - Create and manage channels
+  - Send messages to channels
+- Human can
+  - Decide who is in a channel
+- Goose can
+  - Check their unread notifications
+  - Checking threads only show new messages since the last time they were checked (hopefully saving some tokens)
+- Goose instance can then do anything Goose can do (with great power comes great responsibility)
+
+## Design
+
+- Designed exclusively for development environments.
+- Built with:
+  - **Turbo** (via [turbo-rails](https://github.com/hotwired/turbo-rails)) for accelerated page updates.
+  - **Stimulus** (via [stimulus-rails](https://github.com/hotwired/stimulus-rails)) for lightweight JavaScript interactions.
+  - **TailwindCSS** (via [tailwindcss-rails](https://github.com/rails/tailwindcss-rails)) for utility-first styling. 
+  - **Importmap** (via [importmap-rails](https://github.com/rails/importmap-rails)) for managing JavaScript dependencies without Node.js.
+  - **Cline** (via [cline.bot](https://cline.bot)) for the AI assistant to this project. Why not make an AI gem with AI aid?
+
+
+#### Homepage
+![homepage](docs/images/homepage-1.png)
+
+#### Goose Creation
+![goose creation](docs/images/goose-creation-1.png)
+
+#### Live Console
+![goose console](docs/images/console-output-1.png)
+
+#### Channels
+![channels](docs/images/channel-1.png)
+
+#### Channel Management
+![channel management](docs/images/channel-management-1.png)
+
+#### Dark Mode
+![dark mode](docs/images/dark_mode-1.png)
+
+## Installation in an Existing Rails App
+
+Install and configure [Goose CLI](https://block.github.io/goose/docs/getting-started/installation/)
+
+
+Add this line to your application's Gemfile inside the development group:
+
+```ruby
+group :development do
+  gem 'gaggle', git: 'https://github.com/Tonksthebear/gaggle'
+end
+```
+
+Then execute:
+
+```shell
+bundle install
+```
+
+
+Mount the engine in your `config/routes.rb` file:
+
+```ruby
+Rails.application.routes.draw do
+  mount Gaggle::Engine => "/gaggle"
+end
+```
+
+Generate the MCP server:
+```shell
+bin/rails mcp:rails:generate_server
+```
+
+It is recommended to give Gaggle its own database. An example schema is:
+```yaml
+development:
+  primary:
+    <<: *default
+    database: storage/development.sqlite3
+  gaggle:
+    <<: *default
+    database: storage/gaggle.sqlite3
+    migrations_paths:: <%= Gaggle::Engine.root.join("db/gaggle_migrate") %>
+```
+
+Gaggle uses it's own database schema, so you will need to run the migrations:
+
+```shell
+bin/rails db:migrate:gaggle
+```
+
+Now, whenever your application is running, you can access the Gaggle dashboard at `http://your_local_server/gaggle`.
+
+## Testing
+
+None yet
+
+## TODO
+
+... testing
+
+- Fix threading issue
+  - For some reason, messages don't always get sent to the Goose instance, requiring poking them to check notifications in their terminal. I assume this has something to do with threads and knowing when to send messages. I already implemented a Queue, but no luck
+- Private messages (partially done)
+- Let goose instances know who is in a channel (partially done)
+- Let goose instances decide who is in a channel (partially done)
+- Configure team structure
+- Include more presets (personalities, team structure, channels)
+
+### Running this repo locally
+
+To run the project locally, you will need to have the following dependencies installed:
+
+- Ruby on Rails (and associated dependencies)
+- Goose CLI (make sure it's working)
+
+
+Once you have the dependencies installed, you can run the project locally by running the following commands:
+
+```shell
+bundle
+```
+```shell
+bundle exec appraisal install
+```
+```shell
+cd test/dummy
+```
+```shell
+bin/rails db:prepare
+```
+```shell
+bin/dev
+```
+
+If all goes well, by the end you will have the rails server running on port 60053.
+Gaggle should then be running on http://localhost:60053/gaggle.
+
+#### Speicial Note
+
+This engine uses [Appraisal](https://github.com/thoughtbot/appraisal) to test against multiple versions of Rails. As such, there may be some funkiness if you're unfamiliar. When running standard rails commands during development from the *root* of the project, you will need to run them with
+```bash
+bundle exec appraisal rails-8-propshaft [command]`
+```
+When running standard rails commands inside `test/dummy`, `bin/rails` should automatically inject the rails 8 propshaft appraisal environment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. 
+
+### Bonus
+Since this was built with Cline, your cline should be able to use the [memory bank](https://docs.cline.bot/improving-your-prompting-skills/custom-instructions-library/cline-memory-bank) as well. Configure the prompt as instructed and have fun
+
+## License
+
+This project is licensed under the [MIT License](MIT-LICENSE).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/gaggle_manifest.js

@@ -0,0 +1,4 @@
+//= link gaggle/application.js
+//= link gaggle/tailwind.css
+//= link gaggle/el-transition.js
+//= link_directory ../../javascript/controllers/gaggle .js

data/app/assets/stylesheets/application.css

@@ -0,0 +1 @@
+@import "tailwindcss";