Sha256: 5e4ea4e2b4bb74d374d7cb34c027164609817c4d156aa0576264efa35cfb6d8d

Contents?: true

Size: 1017 Bytes

Versions: 20

Compression:

Stored size: 1017 Bytes

Contents

module YARD
  module Serializers
    # A serializer that writes data to standard output.
    class StdoutSerializer < Base
      # Creates a serializer to print text to stdout
      # 
      # @param [Fixnum, nil] wrap if wrap is a number, wraps text to +wrap+
      #   columns, otherwise no wrapping is done.
      def initialize(wrap = nil)
        @wrap = wrap
      end
      
      # Overrides serialize behaviour to write data to standard output
      def serialize(object, data)
        print(@wrap ? word_wrap(data, @wrap) : data)
      end
      
      private
      
      # Wraps text to a specific column length
      # 
      # @param [String] text the text to wrap
      # @param [Fixnum] length the column length to wrap to
      # @return [String] the wrapped text
      def word_wrap(text, length = 80)
        # See ruby-talk/10655 / Ernest Ellingson
        text.gsub(/\t/,"     ").gsub(/.{1,50}(?:\s|\Z)/){($& + 
          5.chr).gsub(/\n\005/,"\n").gsub(/\005/,"\n")}
      end
    end
  end
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
yard-0.6.8 lib/yard/serializers/stdout_serializer.rb
yard-0.6.7 lib/yard/serializers/stdout_serializer.rb
yard-0.6.6 lib/yard/serializers/stdout_serializer.rb
yard-0.6.5 lib/yard/serializers/stdout_serializer.rb
yard-0.6.4 lib/yard/serializers/stdout_serializer.rb
yard-0.6.3 lib/yard/serializers/stdout_serializer.rb
yard-0.6.2 lib/yard/serializers/stdout_serializer.rb
yard-0.6.1 lib/yard/serializers/stdout_serializer.rb
yard-0.6.0 lib/yard/serializers/stdout_serializer.rb
yard-0.5.8 lib/yard/serializers/stdout_serializer.rb
yard-0.5.7 lib/yard/serializers/stdout_serializer.rb
yard-0.5.6 lib/yard/serializers/stdout_serializer.rb
yard-0.5.5 lib/yard/serializers/stdout_serializer.rb
yard-0.5.4 lib/yard/serializers/stdout_serializer.rb
yard-0.5.3 lib/yard/serializers/stdout_serializer.rb
yard-0.5.2 lib/yard/serializers/stdout_serializer.rb
yard-0.5.1p1 lib/yard/serializers/stdout_serializer.rb
yard-0.5.1 lib/yard/serializers/stdout_serializer.rb
yard-0.5.0 lib/yard/serializers/stdout_serializer.rb
yard-0.4.0 lib/yard/serializers/stdout_serializer.rb