consolle 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fdeb782267d3cb951cd1e8fece86486dc48eaf1c2e686e782b256e0dc60745e
+  data.tar.gz: d078d1aad3ca4bc063aa5ef15d67f0c66273e30a64ea822dd4a4122c173938f7
+SHA512:
+  metadata.gz: 4afbcd6b93ea353b556000ef601acefcfd0bd0e4f76fc89053c2a20c3b72ccddd4a95ee5073f61420a310011fc2cd6df44ccbb17ee319d777645f5d97fb673e6
+  data.tar.gz: '069a0849b85439b2b9314c2e165ddba1486f86db8b30f13b4346bd137b5607799978c81a78182e6a7f1b956c061763b075a12068fd626445772f9524a6705a4a'

data/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Test
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['3.1', '3.2', '3.3', '3.4']
+        experimental: [false]
+        include:
+          # Test on Windows with each Ruby version
+          - os: windows-latest
+            ruby: '3.1'
+            experimental: true
+          - os: windows-latest
+            ruby: '3.2'
+            experimental: true
+          - os: windows-latest
+            ruby: '3.3'
+            experimental: true
+          - os: windows-latest
+            ruby: '3.4'
+            experimental: true
+          # Test with Ruby head on Ubuntu
+          - os: ubuntu-latest
+            ruby: 'head'
+            experimental: true
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems
+    
+    - name: Run tests
+      run: bundle exec rspec --format documentation
+      continue-on-error: ${{ matrix.experimental }}

data/.gitignore

@@ -0,0 +1,6 @@
+.env.local
+tmp/
+.gem/
+*.gem
+.notes/
+cone-examples.md

data/.mise.toml

@@ -0,0 +1,9 @@
+[tools]
+ruby = "3.4.1"
+
+[env]
+_.file = [".env", ".env.local"]
+
+[tasks.release]
+run = "bash mise/release.sh"
+description = "Release a new version of the gem"

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--color
+--format documentation
+--pattern spec/**/*_spec.rb

data/.version

@@ -0,0 +1 @@
+0.2.6

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.5] - 2025-01-24
+
+### Fixed
+- Handle UTF-8 encoding for strings tagged as ASCII-8BIT when processing multibyte characters
+
+### Changed
+- Minimum Ruby version requirement changed from 3.0.0 to 3.1.0
+- Updated gemspec metadata for RubyGems.org publishing
+
+### Added
+- bin/consolle executable for gem exec support
+- MIT License file
+- GitHub Actions CI workflow for testing across multiple Ruby versions and platforms
+- Release script for automated versioning and publishing
+
+## [0.2.4] - 2025-01-23
+
+### Added
+- Initial release with PTY-based Rails console management
+- Multi-session support
+- Socket-based communication
+- Automatic console restart on failure

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+# Ruby 3.4.0+ requires base64 as a gem
+gem "base64", "~> 0.2"

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    consolle (0.2.6)
+      logger (~> 1.0)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.3.0)
+    diff-lcs (1.6.2)
+    logger (1.7.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    thor (1.3.2)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  base64 (~> 0.2)
+  consolle!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.6.9

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 nacyot
+
+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,190 @@
+# Consolle
+
+Consolle is a library that manages Rails console through PTY (Pseudo-Terminal). Moving away from the traditional eval-based execution method, it manages the actual Rails console process as a subprocess to provide a more stable and secure execution environment.
+
+## Key Features
+
+- **PTY-based Rails Console Management**: Manages the actual Rails console process through PTY
+- **Socket Server Architecture**: Stable client-server communication through Unix socket
+- **Automatic Restart (Watchdog)**: Automatic recovery on process failure
+- **Environment-specific Execution**: Supports Rails environments (development, test, production)
+- **Timeout Handling**: Automatic termination of infinite loops and long-running code
+- **Log Management**: Automatic management of execution history and session logs
+
+## Installation
+
+### 1. Install the Library
+```bash
+# From Rails project root
+gem install consolle
+```
+
+### 2. Rails Project Configuration
+```bash
+# Add to Gemfile
+gem 'consolle'
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+# Start Rails console server
+cone start
+
+# Check status
+cone status
+
+# Execute code
+cone exec "User.count"
+cone -m "2 + 2"
+
+# Stop server
+cone stop
+
+# Restart server
+cone restart
+```
+
+### Advanced Usage
+
+```bash
+# Start with specific environment
+cone start -e test
+
+# Restart with environment change
+cone restart -e production
+
+# Force full server restart
+cone restart --force
+
+# Set timeout
+cone exec "sleep 10" --timeout 5
+
+# Verbose log output
+cone -v exec "User.all"
+```
+
+## Architecture
+
+Consolle consists of the following structure:
+
+```
+┌─────────────────────┐
+│      CLI Tool       │
+│      (cone)         │
+└─────────┬───────────┘
+          │ Unix Socket
+          │
+┌─────────▼───────────┐
+│  ConsoleSocketServer│
+│   (Socket Listener) │
+└─────────┬───────────┘
+          │
+┌─────────▼───────────┐
+│   RequestBroker     │
+│  (Serial Queue)     │
+└─────────┬───────────┘
+          │
+┌─────────▼───────────┐
+│  ConsoleSupervisor  │
+│   (PTY Manager)     │
+└─────────┬───────────┘
+          │ PTY
+          │
+┌─────────▼───────────┐
+│   Rails Console     │
+│   (Subprocess)      │
+└─────────────────────┘
+```
+
+## Key Components
+
+### CLI (Command Line Interface)
+- `cone start`: Start Rails console server
+- `cone stop`: Stop Rails console server
+- `cone restart`: Restart Rails console server
+- `cone status`: Check server status
+- `cone exec`: Execute code
+- `cone version`: Version information
+
+### Server Components
+
+#### ConsoleSocketServer
+- Manages client connections through Unix socket
+- Handles requests/responses through JSON protocol
+- Supports multiple client connections
+
+#### ConsoleSupervisor
+- Manages Rails console process through PTY
+- Automatic restart (Watchdog) feature
+- Environment variable settings and IRB automation configuration
+- Timeout handling and Ctrl-C support
+
+#### RequestBroker
+- Ensures request order through serial queue
+- Prevents concurrent execution and safe multi-client handling
+- Asynchronous response handling through Future pattern
+
+## Environment Configuration
+
+Consolle automatically sets the following environment variables when running Rails console:
+
+```ruby
+env = {
+  "RAILS_ENV" => rails_env,
+  "IRBRC" => "skip",              # Skip IRB configuration file
+  "PAGER" => "cat",               # Immediate output
+  "NO_PAGER" => "1",              # Disable pager
+  "TERM" => "dumb",               # Simple terminal setting
+  "FORCE_COLOR" => "0",           # Disable colors
+  "NO_COLOR" => "1",              # Completely disable color output
+  "COLUMNS" => "120",             # Fixed column count
+  "LINES" => "24"                 # Fixed line count
+}
+```
+
+## File Locations
+
+- **Socket file**: `{Rails.root}/tmp/cone/cone.socket`
+- **PID file**: `{Rails.root}/tmp/cone/cone.pid`
+- **Log file**: `{Rails.root}/tmp/cone/cone.log`
+- **Session file**: `{Rails.root}/tmp/cone/session.json`
+- **User session logs**: `~/.cone/sessions/{project_hash}/session_YYYYMMDD_pid{pid}.log`
+
+## Development Guide
+
+### Running Tests
+
+```bash
+# From library directory
+cd lib/consolle
+bundle install
+bundle exec rspec
+```
+
+### Debugging
+
+```bash
+# Verbose log output
+cone -v exec "your_code"
+
+# Check server logs
+tail -f tmp/cone/cone.log
+
+# Check session logs
+ls ~/.cone/sessions/
+```
+
+## Limitations
+
+- Only available in Rails projects
+- Only works on Unix-like systems (PTY dependency)
+- Only one console server can run per Rails project
+
+## Version Information
+
+- **Current version**: 0.1.0
+- **Ruby version**: 3.0 or higher
+- **Rails version**: 7.0 or higher

data/bin/cone

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/consolle"
+
+Consolle::CLI.start(ARGV)

data/bin/consolle

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/consolle"
+
+Consolle::CLI.start(ARGV)

data/consolle.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/consolle/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "consolle"
+  spec.version       = Consolle::VERSION
+  spec.authors       = ["nacyot"]
+  spec.email         = ["propellerheaven@gmail.com"]
+
+  spec.summary       = "PTY-based Rails console management library"
+  spec.description   = "Consolle is a library that manages Rails console through PTY (Pseudo-Terminal). Moving away from the traditional eval-based execution method, it manages the actual Rails console process as a subprocess to provide a more stable and secure execution environment."
+  spec.homepage      = "https://github.com/nacyot/consolle"
+  spec.required_ruby_version = ">= 3.1.0"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/nacyot/consolle",
+    "changelog_uri" => "https://github.com/nacyot/consolle/blob/main/CHANGELOG.md",
+    "bug_tracker_uri" => "https://github.com/nacyot/consolle/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "thor", "~> 1.0"
+  spec.add_dependency "logger", "~> 1.0"
+
+  # Development dependencies
+  spec.add_development_dependency "rspec", "~> 3.0"
+end