cogbox 0.190.1

data/scripts/generate-docs.rb

@@ -0,0 +1,403 @@
+#!/usr/bin/env ruby
+# Copyright Daytona Platforms Inc.
+# Copyright Cognifyi
+# SPDX-License-Identifier: Apache-2.0
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+require 'yard'
+
+# Configuration
+DOCS_OUTPUT_DIR = File.expand_path('../../../apps/docs/src/content/docs/en/ruby-sdk', __dir__)
+LIB_DIR = File.expand_path('../lib/cogbox', __dir__)
+
+# Classes to document: [file_path, output_filename, class_name]
+CLASSES_TO_DOCUMENT = [
+  ['config.rb', 'config.mdx', 'Cogbox::Config'],
+  ['cogbox.rb', 'cogbox.mdx', 'Cogbox::Cogbox'],
+  ['sandbox.rb', 'sandbox.mdx', 'Cogbox::Sandbox'],
+  ['file_system.rb', 'file-system.mdx', 'Cogbox::FileSystem'],
+  ['git.rb', 'git.mdx', 'Cogbox::Git'],
+  ['process.rb', 'process.mdx', 'Cogbox::Process'],
+  ['lsp_server.rb', 'lsp-server.mdx', 'Cogbox::LspServer'],
+  ['volume.rb', 'volume.mdx', 'Cogbox::Volume'],
+  ['object_storage.rb', 'object-storage.mdx', 'Cogbox::ObjectStorage'],
+  ['computer_use.rb', 'computer-use.mdx', 'Cogbox::ComputerUse'],
+  ['computer_use.rb', 'computer-use.mdx', 'Cogbox::ComputerUse::Accessibility'],
+  ['snapshot_service.rb', 'snapshot.mdx', 'Cogbox::SnapshotService'],
+  ['volume_service.rb', 'volume-service.mdx', 'Cogbox::VolumeService'],
+  ['common/charts.rb', 'charts.mdx', 'Cogbox::Chart'],
+  ['common/image.rb', 'image.mdx', 'Cogbox::Image']
+]
+
+def extract_class_name_from_path(class_name)
+  # Extract the simple class name from the full path
+  class_name.split('::').last
+end
+
+def add_frontmatter(content, class_name)
+  simple_name = extract_class_name_from_path(class_name)
+  frontmatter = <<~FRONTMATTER
+    ---
+    title: "#{simple_name}"
+    hideTitleOnPage: true
+    ---
+
+  FRONTMATTER
+
+  frontmatter + content
+end
+
+def format_type(types)
+  return 'Object' if types.nil? || types.empty?
+
+  # Join types and escape special characters that break MDX
+  type_str = types.join(', ')
+  # Escape special chars that break MDX parsing
+  # Replace :: with a single : to avoid MDX issues while keeping readability
+  type_str = type_str.gsub('::', ':')
+  # Escape angle brackets
+  type_str.gsub('<', '\\<').gsub('>', '\\>')
+end
+
+def clean_description(description)
+  return '' if description.nil? || description.empty?
+
+  # Remove rubocop directive lines
+  cleaned = description.to_s.lines.reject { |line| line.strip.start_with?('rubocop:') }.join
+  cleaned.strip
+end
+
+def extract_class_description(obj)
+  description = clean_description(obj.docstring)
+
+  # If no class-level description, try to get it from the first method or constructor
+  if description.empty? && obj.is_a?(YARD::CodeObjects::ClassObject)
+    # Try to find a description from the constructor or first documented method
+    constructor = obj.meths.find { |m| m.name == :initialize }
+    if constructor && constructor.docstring && !constructor.docstring.empty?
+      # Extract just the summary (first paragraph) from constructor docs
+      constructor_desc = clean_description(constructor.docstring)
+      first_paragraph = constructor_desc.split("\n\n").first
+      if first_paragraph && !first_paragraph.empty?
+        # Make it a class-level description
+        extract_class_name_from_path(obj.path)
+        description = first_paragraph.gsub(/^(Initializes|Creates a new)/, 'Main class for')
+      end
+    end
+
+    # If still empty, generate a basic description
+    if description.empty?
+      simple_name = extract_class_name_from_path(obj.path)
+      description = "#{simple_name} class for Cogbox SDK."
+    end
+  end
+
+  description
+end
+
+def extract_attributes(obj)
+  attributes = []
+
+  return attributes unless obj.is_a?(YARD::CodeObjects::ClassObject)
+
+  # Collect all attributes
+  read_attrs = obj.attributes[:read] || {}
+  write_attrs = obj.attributes[:write] || {}
+  all_attrs = (read_attrs.keys + write_attrs.keys).uniq
+
+  all_attrs.each do |name|
+    attr_obj = read_attrs[name] || write_attrs[name]
+    type = attr_obj.docstring.tag(:return)&.types
+    type_str = format_type(type)
+    desc = attr_obj.docstring.to_s.split("\n").first || ''
+
+    attributes << {
+      name: name,
+      type: type_str,
+      description: desc
+    }
+  end
+
+  attributes
+end
+
+def generate_markdown_for_object(obj)
+  content = []
+
+  # Add main heading
+  content << "## #{obj.name}"
+  content << ''
+
+  # Add class description
+  description = extract_class_description(obj)
+  unless description.empty?
+    content << description
+    content << ''
+  end
+
+  # Add attributes/properties section (matching Python/TypeScript format)
+  if obj.is_a?(YARD::CodeObjects::ClassObject)
+    attributes = extract_attributes(obj)
+
+    if attributes.any?
+      content << '**Attributes**:'
+      content << ''
+      attributes.each do |attr|
+        content << "- `#{attr[:name]}` _#{attr[:type]}_ - #{attr[:description]}"
+      end
+      content << ''
+    end
+  end
+
+  # Add class-level examples (before constructors, matching Python/TypeScript)
+  examples = obj.tags(:example)
+  if examples.any?
+    content << '**Examples:**'
+    content << ''
+    examples.each do |example|
+      content << '```ruby'
+      content << example.text.strip
+      content << '```'
+      content << ''
+    end
+  end
+
+  # Add constructors section
+  if obj.is_a?(YARD::CodeObjects::ClassObject)
+    constructor = obj.meths.find { |m| m.name == :initialize }
+    if constructor
+      content << '### Constructors'
+      content << ''
+      content << "#### new #{extract_class_name_from_path(obj.path)}()"
+      content << ''
+
+      # Method signature
+      content << '```ruby'
+      params_str = constructor.parameters.map { |p| p[0] }.join(', ')
+      content << "def initialize(#{params_str})"
+      content << '```'
+      content << ''
+
+      # Constructor description
+      if constructor.docstring && !constructor.docstring.empty?
+        desc = clean_description(constructor.docstring)
+        unless desc.empty?
+          content << desc
+          content << ''
+        end
+      end
+
+      # Parameters
+      params = constructor.tags(:param)
+      if params.any?
+        content << '**Parameters**:'
+        content << ''
+        params.each do |param|
+          types = format_type(param.types)
+          content << "- `#{param.name}` _#{types}_ - #{param.text}"
+        end
+        content << ''
+      end
+
+      # Returns
+      return_tag = constructor.tag(:return)
+      if return_tag
+        types = format_type(return_tag.types)
+        text = return_tag.text.to_s.strip
+        content << '**Returns**:'
+        content << ''
+        content << if text.empty?
+                     "- `#{types}`"
+                   else
+                     "- `#{types}` - #{text}"
+                   end
+        content << ''
+      end
+
+      # Raises
+      raises = constructor.tags(:raise)
+      if raises.any?
+        content << '**Raises**:'
+        content << ''
+        raises.each do |raise_tag|
+          types = format_type(raise_tag.types)
+          content << "- `#{types}` - #{raise_tag.text}"
+        end
+        content << ''
+      end
+    end
+  end
+
+  # Add methods section
+  if obj.is_a?(YARD::CodeObjects::ClassObject)
+    methods = obj.meths.select { |m| m.scope == :instance && m.visibility == :public && m.name != :initialize }
+
+    if methods.any?
+      content << '### Methods'
+      content << ''
+
+      methods.each do |method|
+        content << "#### #{method.name}()"
+        content << ''
+
+        # Method signature
+        content << '```ruby'
+        params_str = method.parameters.map { |p| p[0] }.join(', ')
+        content << "def #{method.name}(#{params_str})"
+        content << '```'
+        content << ''
+
+        # Method description
+        if method.docstring && !method.docstring.empty?
+          desc = clean_description(method.docstring)
+          unless desc.empty?
+            content << desc
+            content << ''
+          end
+        end
+
+        # Parameters
+        params = method.tags(:param)
+        if params.any?
+          content << '**Parameters**:'
+          content << ''
+          params.each do |param|
+            types = format_type(param.types)
+            content << "- `#{param.name}` _#{types}_ - #{param.text}"
+          end
+          content << ''
+        end
+
+        # Returns
+        return_tag = method.tag(:return)
+        if return_tag
+          types = format_type(return_tag.types)
+          text = return_tag.text.to_s.strip
+          content << '**Returns**:'
+          content << ''
+          # Only add description if it's meaningful and not just repeating the type
+          content << if text.empty? || text.start_with?('Array<') || text.start_with?('Hash<')
+                       "- `#{types}`"
+                     else
+                       "- `#{types}` - #{text}"
+                     end
+          content << ''
+        end
+
+        # Raises
+        raises = method.tags(:raise)
+        if raises.any?
+          content << '**Raises**:'
+          content << ''
+          raises.each do |raise_tag|
+            types = format_type(raise_tag.types)
+            content << "- `#{types}` - #{raise_tag.text}"
+          end
+          content << ''
+        end
+
+        # Method-level examples
+        examples = method.tags(:example)
+        next unless examples.any?
+
+        content << '**Examples:**'
+        content << ''
+        examples.each do |example|
+          content << '```ruby'
+          content << example.text.strip
+          content << '```'
+          content << ''
+        end
+      end
+    end
+  end
+
+  content.join("\n")
+end
+
+def post_process_markdown(content)
+  # Remove excessive blank lines (more than 2 consecutive)
+  content = content.gsub(/\n{3,}/, "\n\n")
+
+  # Remove blank lines inside code blocks
+  content = content.gsub("```ruby\n\n", "```ruby\n")
+  content = content.gsub("\n\n```", "\n```")
+
+  # Ensure consistent spacing around sections
+  content = content.gsub(/\n(\*\*[^*]+\*\*:)\n([^\n])/, "\n\\1\n\n\\2")
+
+  # Ensure code blocks have proper spacing
+  content = content.gsub(/([^\n])\n```/, "\\1\n\n```")
+  content = content.gsub(/```\n([^\n])/, "```\n\n\\1")
+
+  # Clean up trailing whitespace
+  content = content.lines.map(&:rstrip).join("\n")
+
+  # Ensure file ends with single newline
+  content.strip + "\n"
+end
+
+def generate_docs_for_class(file_path, output_filename, class_name)
+  full_path = File.join(LIB_DIR, file_path)
+
+  unless File.exist?(full_path)
+    puts "⚠️  File not found: #{full_path}"
+    return
+  end
+
+  puts "📝 Generating docs for #{class_name}..."
+
+  begin
+    # Clear and parse with YARD
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse(full_path)
+
+    # Get the class object
+    obj = YARD::Registry.at(class_name)
+
+    unless obj
+      puts "⚠️  Class #{class_name} not found in registry"
+      return
+    end
+
+    # Generate markdown content
+    markdown_content = generate_markdown_for_object(obj)
+
+    # Post-process for consistency
+    markdown_content = post_process_markdown(markdown_content)
+
+    # Add frontmatter
+    final_content = add_frontmatter(markdown_content, class_name)
+
+    # Write to output file
+    output_path = File.join(DOCS_OUTPUT_DIR, output_filename)
+    if File.exist?(output_path)
+      File.write(output_path, "#{File.read(output_path).rstrip}\n\n#{markdown_content}")
+    else
+      File.write(output_path, final_content)
+    end
+
+    puts "✅ Generated: #{output_filename}"
+  rescue StandardError => e
+    puts "❌ Error generating docs for #{class_name}: #{e.message}"
+    puts e.backtrace.first(5).join("\n") if ENV['DEBUG']
+  end
+end
+
+# Main execution
+puts '🚀 Starting documentation generation...'
+puts "📂 Output directory: #{DOCS_OUTPUT_DIR}"
+puts ''
+
+# Ensure output directory exists
+FileUtils.mkdir_p(DOCS_OUTPUT_DIR)
+
+# Generate docs for each class
+CLASSES_TO_DOCUMENT.each do |file_path, output_filename, class_name|
+  generate_docs_for_class(file_path, output_filename, class_name)
+end
+
+puts ''
+puts '✨ Documentation generation complete!'

data/sig/cogbox/sdk.rbs

@@ -0,0 +1,6 @@
+module Cogbox
+  module Sdk
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: cogbox
+version: !ruby/object:Gem::Version
+  version: 0.190.1
+platform: ruby
+authors:
+- Cogbox Platforms Inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp-metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-metrics-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cogbox_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.190.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.190.1
+- !ruby/object:Gem::Dependency
+  name: cogbox_toolbox_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.190.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.190.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: observer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: toml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: 'High-level Ruby SDK for Cogbox: sandboxes, git, filesystem, LSP, process,
+  and object storage.'
+email:
+- support@pazity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/cogbox.rb
+- lib/cogbox/code_interpreter.rb
+- lib/cogbox/cogbox.rb
+- lib/cogbox/common/charts.rb
+- lib/cogbox/common/code_interpreter.rb
+- lib/cogbox/common/code_language.rb
+- lib/cogbox/common/cogbox.rb
+- lib/cogbox/common/file_system.rb
+- lib/cogbox/common/git.rb
+- lib/cogbox/common/image.rb
+- lib/cogbox/common/process.rb
+- lib/cogbox/common/pty.rb
+- lib/cogbox/common/resources.rb
+- lib/cogbox/common/response.rb
+- lib/cogbox/common/snapshot.rb
+- lib/cogbox/computer_use.rb
+- lib/cogbox/config.rb
+- lib/cogbox/file_system.rb
+- lib/cogbox/file_transfer.rb
+- lib/cogbox/git.rb
+- lib/cogbox/lsp_server.rb
+- lib/cogbox/object_storage.rb
+- lib/cogbox/otel.rb
+- lib/cogbox/process.rb
+- lib/cogbox/sandbox.rb
+- lib/cogbox/sdk.rb
+- lib/cogbox/sdk/version.rb
+- lib/cogbox/snapshot_service.rb
+- lib/cogbox/util.rb
+- lib/cogbox/volume.rb
+- lib/cogbox/volume_service.rb
+- project.json
+- scripts/generate-docs.rb
+- sig/cogbox/sdk.rbs
+homepage: https://github.com/cognifyi/cogbox
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cognifyi/cogbox
+  source_code_uri: https://github.com/cognifyi/cogbox
+  changelog_uri: https://github.com/cognifyi/cogbox/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby SDK for Cogbox
+test_files: []