ukiryu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a829b8c3437032c87c7dc360fec0aacd18a2ce7fe627b82defbb972e00047c2
+  data.tar.gz: 811407bd87c8e7665e78a970506d1591584a8a51ff95d6426333dd57b0749339
+SHA512:
+  metadata.gz: 03a7575c15d808461881baebe51ffaca79f868f93ef4e073e026ab2385f88a0540e20168bcfe2299edcec0a68a7e0a5074cd01f60aaee786267665eb56a568cd
+  data.tar.gz: 15d32df885540d695c0a439acc03e4c1d144056ca5f7fa481c12934237b61350bab4b2e83c2ee4f184c3bb1f9dd905a3085d283b81f625cf4073cbc4d520f488

data/.github/workflows/test.yml

@@ -0,0 +1,143 @@
+name: Test Tool Profiles
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['3.3']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          working-directory: ./ukiryu
+
+      - name: Install system dependencies (Ubuntu)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y imagemagick ffmpeg ghostscript
+
+      - name: Install system dependencies (macOS)
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew install imagemagick ffmpeg ghostscript
+
+      - name: Show installed tool versions
+        run: |
+          echo "=== Installed Tool Versions ==="
+          echo -n "ImageMagick: " && magick -version | head -1 || echo "Not installed"
+          echo -n "FFmpeg: " && ffmpeg -version | head -1 || echo "Not installed"
+          echo -n "Ghostscript: " && gs --version || echo "Not installed"
+          echo -n "Pandoc: " && pandoc --version | head -1 || echo "Not installed"
+          echo -n "jpegoptim: " && jpegoptim --version 2>&1 | head -1 || echo "Not installed"
+          echo -n "optipng: " && optipng -v 2>&1 | head -1 || echo "Not installed"
+
+      - name: Run tests
+        working-directory: ./ukiryu
+        run: bundle exec rspec --format documentation
+
+      - name: Run all tests with coverage
+        working-directory: ./ukiryu
+        run: bundle exec rspec
+
+  schema-validation:
+    name: Validate Tool Profiles Schema
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+          working-directory: ./ukiryu
+
+      - name: Validate all tool profiles
+        working-directory: ./ukiryu
+        run: |
+          ruby -r ./lib/ukiryu.rb -r ./lib/ukiryu/schema_validator.rb <<-'RUBY'
+          require 'yaml'
+          require 'json-schema'
+
+          schema_path = File.expand_path('../../schema/tool-profile.schema.yaml', __dir__)
+          schema = JSON::Schema.parse(File.read(schema_path))
+
+          # Find all tool profiles
+          profiles = Dir.glob('../../register/tools/**/*.yaml').sort
+
+          puts "Validating #{profiles.count} tool profiles..."
+          errors = []
+
+          profiles.each do |profile_path|
+            profile_name = profile_path.sub('../../register/tools/', '')
+            begin
+              profile = YAML.safe_load(File.read(profile_path))
+              schema.validate(profile)
+              puts "  ✓ #{profile_name}"
+            rescue => e
+              errors << "#{profile_name}: #{e.message}"
+              puts "  ✗ #{profile_name}: #{e.message}"
+            end
+          end
+
+          if errors.any?
+            puts "\n#{errors.count} validation errors:"
+            errors.each { |err| puts "  - #{err}" }
+            exit 1
+          end
+
+          puts "\n✓ All #{profiles.count} tool profiles are valid!"
+          RUBY
+
+  # Optional: Test on Windows with native Windows tools
+  test-windows:
+    name: Test on Windows
+    runs-on: windows-latest
+    if: github.event_name == 'push' || (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'test-windows'))
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+          working-directory: ./ukiryu
+
+      - name: Install Chocolatey packages
+        run: |
+          choco install imagemagick ffmpeg ghostscript -y
+
+      - name: Show installed tool versions
+        shell: pwsh
+        run: |
+          Write-Host "=== Installed Tool Versions ==="
+          Write-Host "ImageMagick: $(magick -version | Select-Object -First 1)"
+          Write-Host "FFmpeg: $(ffmpeg -version | Select-Object -First 1)"
+          Write-Host "Ghostscript: $(gs --version)"
+
+      - name: Run tests (skip unavailable tools)
+        working-directory: ./ukiryu
+        run: bundle exec rspec --format documentation
+        continue-on-error: true

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+Gemfile.lock
+.rspec_status
+.rubocop-*
+
+.sass-cache
+_site
+*.gem

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "schema"]
+	path = schema
+	url = git@github.com:ukiryu/schema.git

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ukiryu.gemspec
+gemspec
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+
+# For optional YAML schema validation in registry
+gem "json-schema", "~> 3.0"

data/README.adoc

@@ -0,0 +1,295 @@
+= Ukiryu
+
+Platform-adaptive command execution framework using declarative YAML tool
+profiles.
+
+image:https://img.shields.io/gem/v/ukiryu.svg[RubyGems Version]
+image:https://img.shields.io/github/license/ukiryu/ukiryu.svg[License]
+image:https://github.com/ukiryu/ukiryu/actions/workflows/test.yml/badge.svg["Build", link="https://github.com/ukiryu/ukiryu/actions/workflows/test.yml"]
+
+== Purpose
+
+Ukiryu provides a Ruby framework for executing external commands with:
+
+* Declarative YAML tool profiles
+* Platform-specific command formatting (macOS, Linux, Windows)
+* Shell-specific syntax (bash, zsh, fish, PowerShell, cmd)
+* Version-aware tool detection
+* Fully object-oriented result handling
+
+== Features
+
+=== Tool Registry
+
+Load tool definitions from YAML profiles:
+
+[source,ruby]
+----
+Ukiryu::Registry.default_registry_path = 'path/to/register'
+tool = Ukiryu::Tool.get(:imagemagick)
+----
+
+=== Platform Detection
+
+Automatic platform and shell detection:
+
+[source,ruby]
+----
+Ukiryu::Platform.detect       # => :macos, :linux, or :windows
+Ukiryu::Shell.detect          # => :bash, :zsh, :powershell, etc.
+----
+
+=== Version Awareness
+
+Handle different tool versions with specific profiles:
+
+[source,ruby]
+----
+tool = Ukiryu::Tool.get(:inkscape)
+# Automatically selects 1.0.yaml or 0.92.yaml based on detected version
+----
+
+=== OOP Result Handling
+
+Rich, object-oriented execution results:
+
+[source,ruby]
+----
+result = tool.execute(:convert, { inputs: ['input.png'], output: 'output.jpg' })
+
+result.command_info.executable     # => "/opt/homebrew/bin/magick"
+result.output.stdout                # => ""
+result.output.success?              # => true
+result.metadata.duration            # => 0.5
+result.metadata.formatted_duration  # => "500ms"
+----
+
+== Architecture
+
+=== Class Hierarchy
+
+[source]
+----
+Ukiryu
+├── Executor
+│   ├── CommandInfo      (command details)
+│   ├── Output           (stdout/stderr with utilities)
+│   ├── ExecutionMetadata(timing information)
+│   └── Result           (composes above three)
+├── Tool               (YAML profile loader and executor)
+├── Registry           (profile discovery and loading)
+├── Platform           (platform detection and utilities)
+├── Shell
+│   ├── Base            (abstract shell interface)
+│   ├── Bash
+│   ├── Zsh
+│   ├── Fish
+│   ├── Sh
+│   ├── PowerShell
+│   └── Cmd
+└── Errors             (custom exception hierarchy)
+----
+
+=== Data Flow
+
+[source]
+----
+┌─────────────────┐      ┌─────────────────┐      ┌──────────────────┐
+│  YAML Profile   │─────►│   Tool Class    │─────►│   Executor       │
+│  (declarative)  │      │  (loader &      │      │  (platform &     │
+│                 │      │   executor)     │      │   shell aware)   │
+└─────────────────┘      └─────────────────┘      └────────┬─────────┘
+                                                             │
+                                                             ▼
+                                                      ┌─────────────┐
+                                                      │   Result    │
+                                                      │  (OOP with  │
+                                                      │  CommandInfo│
+                                                      │  + Output   │
+                                                      │  + Metadata)│
+                                                      └─────────────┘
+----
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'ukiryu'
+----
+
+And then execute:
+
+[source,shell]
+----
+bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+gem install ukiryu
+----
+
+== Usage
+
+=== Basic Command Execution
+
+[source,ruby]
+----
+require 'ukiryu'
+
+# Set registry path to tool profiles
+Ukiryu::Registry.default_registry_path = 'path/to/register'
+
+# Get a tool
+tool = Ukiryu::Tool.get(:imagemagick)
+
+# Execute a command
+result = tool.execute(:convert, {
+  inputs: ['input.png'],
+  output: 'output.jpg',
+  resize: '50x50',
+  quality: 85
+})
+
+# Check result
+if result.success?
+  puts "Converted in #{result.metadata.formatted_duration}"
+else
+  puts "Error: #{result.output.stderr}"
+end
+----
+
+=== Accessing Result Details
+
+[source,ruby]
+----
+result = tool.execute(:identify, { input: ['test.png'] })
+
+# Command information
+result.command_info.executable     # Full path to executable
+result.command_info.arguments      # Array of arguments
+result.command_info.full_command   # Complete command string
+result.command_info.shell          # Shell type used
+
+# Output
+result.output.stdout                # Stripped stdout
+result.output.stderr                # Stripped stderr
+result.output.stdout_lines          # Array of lines
+result.output.stdout_contains?(/PNG/)
+
+# Metadata
+result.metadata.started_at          # Time object
+result.metadata.finished_at         # Time object
+result.metadata.duration            # Float (seconds)
+result.metadata.timed_out?          # Boolean
+----
+
+=== Error Handling
+
+[source,ruby]
+----
+begin
+  result = tool.execute(:convert, { inputs: ['nonexistent.png'], output: 'out.jpg' })
+rescue Ukiryu::ExecutionError => e
+  puts "Command failed: #{e.message}"
+rescue Ukiryu::TimeoutError => e
+  puts "Command timed out: #{e.message}"
+end
+----
+
+=== Tool Availability
+
+[source,ruby]
+----
+tool = Ukiryu::Tool.get(:ffmpeg)
+
+if tool.available?
+  puts "FFmpeg #{tool.version} found at #{tool.executable}"
+else
+  puts "FFmpeg not installed"
+end
+----
+
+== Tool Profiles
+
+Tool profiles are defined in separate https://github.com/ukiryu/register[Ukiryu Register] repository.
+
+Example profile structure:
+
+[source,yaml]
+----
+name: imagemagick
+version: "7.1"
+
+version_detection:
+  command: "--version"
+  pattern: "(\\d+\\.\\d+)"
+
+profiles:
+  - name: unix
+    platforms: [macos, linux]
+    shells: [bash, zsh, fish, sh]
+    commands:
+      convert:
+        arguments:
+          - name: inputs
+            type: file
+            variadic: true
+            position: last
+        options:
+          - name: resize
+            cli: "-resize"
+        flags:
+          - name: strip
+            cli: "-strip"
+----
+
+== Development
+
+=== Running Tests
+
+[source,shell]
+----
+bundle exec rspec
+----
+
+=== Schema Validation
+
+[source,shell]
+----
+bundle exec rspec spec/ukiryu/schema_validator_spec.rb
+----
+
+=== GitHub Actions
+
+Tests run on:
+* Ubuntu latest
+* macOS latest
+
+== Contributing
+
+1. Fork the repository
+2. Create your feature branch
+3. Write tests for your changes
+4. Ensure all tests pass
+5. Submit a pull request
+
+
+== License
+
+The content is available as open source under the terms of the Ribose BSD
+2-Clause License.
+
+== Copyright
+
+Copyright Ribose.
+
+
+== Related Repositories
+
+* https://github.com/ukiryu/register[ukiryu/register] - Tool profile registry
+* https://github.com/ukiryu/schema[ukiryu/schema] - Profile validation schema

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec