Skip to main content

RubyFormatter

Struct RubyFormatter 

Source
pub struct RubyFormatter;
Expand description

Ruby code formatter implementing language-specific conventions

Formats generated Ruby code to comply with:

  • Ruby 3.2+ syntax requirements
  • Rubocop linting rules
  • YARD documentation standards
  • RBS type annotation compatibility

§Example

use spikard_cli::codegen::formatters::{Formatter, RubyFormatter, HeaderMetadata, Import};

let formatter = RubyFormatter::new();
let metadata = HeaderMetadata {
    auto_generated: true,
    schema_file: Some("api.openapi.json".to_string()),
    generator_version: Some("0.6.2".to_string()),
};

let header = formatter.format_header(&metadata);
assert!(header.contains("frozen_string_literal"));
assert!(header.contains("DO NOT EDIT"));

Implementations§

Source§

impl RubyFormatter

Source

pub const fn new() -> Self

Create a new Ruby code formatter

Trait Implementations§

Source§

impl Clone for RubyFormatter

Source§

fn clone(&self) -> RubyFormatter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RubyFormatter

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RubyFormatter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Formatter for RubyFormatter

Source§

fn format_header(&self, metadata: &HeaderMetadata) -> String

Format a file header with metadata about auto-generation Read more
Source§

fn format_imports(&self, imports: &[Import]) -> String

Format import/require/use statements Read more
Source§

fn format_docstring(&self, content: &str) -> String

Format a docstring with proper escaping and indentation Read more
Source§

fn merge_sections(&self, sections: &[Section]) -> String

Merge multiple code sections into final output Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more