spoor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e753dfd8783faeab768126a5e3bc0345a1aedd4685f03e4312c51793d59e27d
+  data.tar.gz: 9177f98d6fae90df617a85d045b10c445088bb892669bb203e1d30dfad749790
+SHA512:
+  metadata.gz: 473146d3972978b0cf78b5897404a22d72688d58791d2ca5133521b48abbc3c11d0f911cae4de1dd466294065e32084b139fcf3014ca0bd5de56ece2cc70dfd6
+  data.tar.gz: 1a103f17f9e49b4787de023e9413ade6966cd117ec863db6ab8a79351e54b7312a2557cef6a90e10314142691cca0e26f525f8a8a3c5e6423379355d2b0d88c7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 mohammed-bageri
+
+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,200 @@
+# Spoor
+
+[![Gem Version](https://badge.fury.io/rb/spoor.svg)](https://badge.fury.io/rb/spoor)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Spoor is a **Docker-based development environment** for Ruby on Rails applications, inspired by Laravel Sail. It simplifies setting up and managing a Dockerized development environment, allowing you to focus on building your Rails application.
+
+---
+
+## Prerequisites
+
+Before using Spoor, ensure that **Docker** is installed and running on your system. You can download Docker from [https://www.docker.com/](https://www.docker.com/).
+
+---
+
+## Installation
+
+Add the gem to your Rails application's `Gemfile`:
+
+```ruby
+gem "spoor"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+After installing the gem, set up Spoor in your project:
+
+```bash
+spoor install
+```
+
+This will generate the necessary `docker-compose.yml` and `.env` files. If your project already has a `Dockerfile`, it will not be overwritten unless you use the `--force-dockerfile` flag:
+
+```bash
+spoor install --force-dockerfile
+```
+
+---
+
+## Usage
+
+### Start the Environment
+
+To start the Spoor environment, run:
+
+```bash
+spoor up
+```
+
+This will start the Docker containers in the background.
+
+### Stop the Environment
+
+To stop the environment, run:
+
+```bash
+spoor down
+```
+
+### Run Rails Commands
+
+You can run Rails commands inside the Docker container using:
+
+```bash
+spoor rails <command>
+```
+
+For example:
+
+```bash
+spoor rails console
+spoor rails db:migrate
+```
+
+### Run Bundler Commands
+
+To run Bundler commands, use:
+
+```bash
+spoor bundle <command>
+```
+
+For example:
+
+```bash
+spoor bundle install
+```
+
+### Access the Database
+
+To start a PostgreSQL CLI session, run:
+
+```bash
+spoor psql
+```
+
+### Access Redis
+
+To start a Redis CLI session, run:
+
+```bash
+spoor redis
+```
+
+### Start a Shell in the App Container
+
+To start a Bash shell in the app container, run:
+
+```bash
+spoor bash
+```
+
+---
+
+## Configuration
+
+### Environment Variables
+
+The `.env` file generated during installation contains the following environment variables:
+
+```env
+APP_PORT=3000
+FORWARD_DB_PORT=5432
+FORWARD_REDIS_PORT=6379
+WWWUSER=1000
+WWWGROUP=1000
+```
+
+You can customize these values to fit your project's needs.
+
+### Docker Compose
+
+The `docker-compose.yml` file is pre-configured with the following services:
+
+- **web**: The Rails application.
+- **db**: PostgreSQL database.
+- **redis**: Redis for caching or background jobs.
+
+You can modify this file to add or remove services as needed.
+
+---
+
+## Example Workflow
+
+1. Install Spoor:
+
+   ```bash
+   spoor install
+   ```
+
+2. Start the environment:
+
+   ```bash
+   spoor up
+   ```
+
+3. Run database migrations:
+
+   ```bash
+   spoor rails db:migrate
+   ```
+
+4. Access the Rails console:
+
+   ```bash
+   spoor rails console
+   ```
+
+5. Stop the environment when done:
+
+   ```bash
+   spoor down
+   ```
+
+---
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute to Spoor, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Commit your changes.
+4. Submit a pull request.
+
+---
+
+## License
+
+Spoor is open-source software licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+## Support
+
+If you encounter any issues or have questions, please [open an issue](https://github.com/mohammed-bageri/spoor/issues) on GitHub.

data/exe/spoor

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "spoor"
+
+Spoor::CLI.start(ARGV)

data/lib/spoor/cli.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "thor"
+require "dotenv"
+
+module Spoor
+  # Main CLI that run the command
+  class CLI < Thor
+    include Thor::Actions
+
+    def initialize(*args)
+      super
+      Dotenv.load(".env") # Load .env file
+    end
+
+    desc "install", "Install Spoor in the current project"
+    option :force_dockerfile, type: :boolean, default: false, desc: "Overwrite the existing Dockerfile"
+    def install
+      Spoor.install(force_dockerfile: options[:force_dockerfile])
+    end
+
+    desc "up", "Start the Spoor environment"
+    def up
+      Spoor.check_docker
+      say "Starting Spoor..."
+      system("docker-compose up -d")
+    end
+
+    desc "down", "Stop the Spoor environment"
+    def down
+      Spoor.check_docker
+      say "Stopping Spoor..."
+      system("docker-compose down")
+    end
+
+    desc "rails COMMAND", "Run a Rails command"
+    def rails(*args)
+      Spoor.check_docker
+      run_in_container("web", "rails", *args)
+    end
+
+    desc "bundle COMMAND", "Run a Bundler command"
+    def bundle(*args)
+      Spoor.check_docker
+      run_in_container("web", "bundle", *args)
+    end
+
+    desc "rake COMMAND", "Run a Rake command"
+    def rake(*args)
+      Spoor.check_docker
+      run_in_container("web", "rake", *args)
+    end
+
+    desc "psql", "Start a PostgreSQL CLI session"
+    def psql
+      Spoor.check_docker
+      run_in_container("db", "psql", "-U", "rails", "-d", "rails_development")
+    end
+
+    desc "redis", "Start a Redis CLI session"
+    def redis
+      Spoor.check_docker
+      run_in_container("redis", "redis-cli")
+    end
+
+    desc "bash", "Start a Bash shell in the app container"
+    def bash
+      Spoor.check_docker
+      run_in_container("web", "bash")
+    end
+
+    private
+
+    def run_in_container(service, *command)
+      system("docker-compose exec #{service} #{command.join(" ")}")
+    end
+  end
+end

data/lib/spoor/templates/Dockerfile.erb

@@ -0,0 +1,21 @@
+# Use the Ruby version detected from the Rails app
+FROM ruby:<%= ruby_version %>
+
+# Install dependencies
+RUN apt-get update -qq && apt-get install -y build-essential libpq-dev nodejs
+
+# Set the working directory
+WORKDIR /myapp
+
+# Install gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install
+
+# Copy the application code
+COPY . .
+
+# Expose port 3000
+EXPOSE 3000
+
+# Start the Rails server
+CMD ["rails", "server", "-b", "0.0.0.0"]

data/lib/spoor/templates/docker-compose.yml

@@ -0,0 +1,55 @@
+version: "3.8"
+
+services:
+  web:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: rails-app
+    environment:
+      RAILS_ENV: development
+      DATABASE_HOST: db
+      REDIS_HOST: redis
+      WWWUSER: "${WWWUSER:-1000}"
+      WWWGROUP: "${WWWGROUP:-1000}"
+    ports:
+      - "${APP_PORT:-3000}:3000"
+    volumes:
+      - ".:/myapp"
+    networks:
+      - spoor-network
+    depends_on:
+      - db
+      - redis
+
+  db:
+    image: postgres:latest
+    environment:
+      POSTGRES_USER: rails
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: rails_development
+    ports:
+      - "${FORWARD_DB_PORT:-5432}:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    networks:
+      - spoor-network
+
+  redis:
+    image: redis:latest
+    ports:
+      - "${FORWARD_REDIS_PORT:-6379}:6379"
+    volumes:
+      - redis_data:/data
+    networks:
+      - spoor-network
+
+networks:
+  spoor-network:
+    driver: bridge
+
+volumes:
+  postgres_data:
+    driver: local
+  redis_data:
+    driver: local

data/lib/spoor/version.rb

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

data/lib/spoor.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "spoor/version"
+require "spoor/cli"
+require "fileutils"
+
+# Spoor ClI
+module Spoor
+  def self.docker_installed?
+    # Check if Docker is installed
+    system("docker --version > /dev/null 2>&1")
+  end
+
+  def self.docker_running?
+    # Check if Docker is running
+    system("docker info > /dev/null 2>&1")
+  end
+
+  def self.check_docker
+    unless docker_installed?
+      puts "Docker is not installed. Please install Docker and try again."
+      exit 1
+    end
+
+    return if docker_running?
+
+    puts "Docker is not running. Please start Docker and try again."
+    exit 1
+  end
+
+  def self.detect_ruby_version
+    # Check for .ruby-version file
+    return File.read(".ruby-version").strip if File.exist?(".ruby-version")
+
+    # Check for Ruby version in Gemfile
+    if File.exist?("Gemfile")
+      gemfile_content = File.read("Gemfile")
+      if match = gemfile_content.match(/ruby ['"]([^'"]+)['"]/)
+        return match[1]
+      end
+    end
+
+    # Default to a supported Ruby version
+    "3.2.0"
+  end
+
+  def self.install(force_dockerfile: false) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    check_docker
+
+    # Copy docker-compose.yml
+    FileUtils.cp(
+      File.join(__dir__, "spoor", "templates", "docker-compose.yml"),
+      "docker-compose.yml"
+    )
+
+    # Copy .env
+    FileUtils.cp(
+      File.join(__dir__, "spoor", "templates", ".env"),
+      ".env"
+    )
+
+    # Copy Dockerfile only if it doesn't exist or if forced
+    dockerfile_path = File.join(Dir.pwd, "Dockerfile")
+    if force_dockerfile || !File.exist?(dockerfile_path)
+      ruby_version = detect_ruby_version
+      dockerfile_content = ERB.new(File.read(File.join(__dir__, "spoor", "templates",
+                                                       "Dockerfile.erb"))).result(binding)
+      File.write(dockerfile_path, dockerfile_content)
+    end
+
+    puts "Spoor has been installed! Run `spoor up` to start the environment."
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: spoor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mohammed Bageri
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Spoor simplifies setting up and managing a Dockerized development environment
+  for Ruby on Rails applications.
+email:
+- mohammed.bajiri.00@gmail.com
+executables:
+- spoor
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/spoor
+- lib/spoor.rb
+- lib/spoor/cli.rb
+- lib/spoor/templates/Dockerfile.erb
+- lib/spoor/templates/docker-compose.yml
+- lib/spoor/version.rb
+homepage: https://github.com/mohammed-bageri/spoor
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/mohammed-bageri/spoor
+  changelog_uri: https://github.com/mohammed-bageri/spoor/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+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.16
+signing_key:
+specification_version: 4
+summary: A Docker-based development environment for Rails, inspired by Laravel Sail.
+test_files: []