indented_io 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 912e798e34c1c61e53b1cdaf9743383085503671e3ba318995a434ff1ec2fac7
+  data.tar.gz: 5ca6c729d02ff390720b3faf76adffe22a10aec20236adbafe5edcd21b364955
+SHA512:
+  metadata.gz: f9b98e7f028b6386b6b2caca76690fa53e87e6d06c9a28e6967147e54abca098ed11364a54f9bc1acaf3bd489baafcb46351acbef471527d7b53f4dddad470ea
+  data.tar.gz: b2962b48817a7a5a5803484f0ff82a335d955e140b3a9b5003a91c538612842918cbaf24992e12d7ce630a1e1b866786a781290a75ccecf78af4f7fa8efd0505

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore Gemfile.lock. See https://stackoverflow.com/questions/4151495/should-gemfile-lock-be-included-in-gitignore
+/Gemfile.lock
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in indented_io.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Claus Rasmussen
+
+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,208 @@
+# IndentedIO
+
+Print indented text
+
+`IndentedIO` extends `Kernel`, `IO`, and `StringIO` with an `#indent` method
+that returns an `IndentedIO` object. The `IndentedIO` object acts as the
+original object but redefines the output methods `#print`, `#printf`, `#puts`,
+and `#p` to print their output indented.  Indentations are stacked so that each
+new indentation adds to the previous indendation
+
+## Usage
+
+```ruby
+require 'indented_io'
+
+puts "Not indented"
+indent { puts "Indented one level" }
+indent(2, "* ").puts "Indented two levels"
+```
+
+outputs
+
+```ruby
+Not indented
+  Indented one level
+* * Indented two levels
+```
+
+#### `#indent`
+
+`#indent` without a block returns an `IndentedIO` object that acts as the
+receiver but redefine `#print`, `#printf`, `#puts`, and `#p` to print indented
+If given a block, the block will be called with the IndentedIO object as
+argument:
+
+```ruby
+$stdout.puts "Not indented"
+$stdout.indent.puts "Indented"
+$stdout.indent { |f| f.puts "Indented" }
+
+# Not indented
+#   Indented
+#   Indented
+```
+(please note that when `Kernel` is the receiver, the returned object will
+act as the `$stdout` object and not the `Kernel` object)
+
+`#indent` can take up to two positional arguments: `level`, that is the number
+of levels to indent (default 1), and the indent string that defaults to the
+indent string of the previous level or `IndentedIO.default_string` if at the
+first level. It is also possible to specify the indentation string using the
+symbolic argument `:string`. If level is negative, the text will be outdented
+instead:
+
+```ruby
+$stdout.puts "Not indented"
+$stdout.indent(2, "> ") { |f|
+  f.indent(string: "* ").puts "Indented three levels"
+  f.indent(-1).puts "Indented one level"
+}
+
+# Not indented
+# > > * Indented three levels
+# > Indented one level
+```
+When text is outdented, the indentation string defaults to the previous level's
+indentation string - not the parent's
+
+#### `Kernel#indent {}`
+
+If given a block without an argument, `Kernel#indent` manipulates `$stdout` so
+that `Kernel#print`, `Kernel#printf`, `Kernel#puts`, and `Kernel#p` will output
+indented within that block:
+
+```ruby
+puts "Not indented"
+indent {
+  puts "Indented one level"
+  indent {
+    puts "Indented two levels"
+  }
+  puts "Indented one level"
+}
+puts "Not indented"
+
+# Not indented
+#   Indented one level
+#     Indented two levels
+#   Indented one level
+# Not indented
+```
+Because this manipulates `$stdout`, the indentation carries through to methods
+that doesn't even know about `IndentedIO`:
+
+```ruby
+def legacy(phrase)
+  puts phrase
+end
+
+legacy("Not indented")
+indent { legacy("Indented" }
+
+# Not indented
+#   Indented
+```
+This is probably the style that'll be used most of the time. It is of course
+still possible use `Kernel#indent` with a block argument if needed
+
+#### bol - Beginning-Of-Line argument
+
+`#indent` takes a symbolic `:bol` argument (`true` or `false`, default `true`) 
+that specify if the output device is at the beginning of a line and that printing
+should start with an indentation string:
+
+```ruby
+indent(1, bol: true).puts "Indented"
+indent(1, bol: false).puts "Not indented\nIndented"
+
+#   Indented
+# Not indented
+#   Indented
+```
+
+## Constants
+
+The default indentation string is defined in `IndentedIO`:
+
+```ruby
+IndentedIO.default_indent = ">> "
+indent.puts "Indented by #{IndentedIO.default_indent.inspect}"
+
+# >> Indented by ">> "
+```
+
+The default at start-up is two spaces. It should normally be set only once
+at the start of the program. Use the indent string argument to `#indent` 
+to get a different indentation for a part of the program
+
+## Exceptions
+
+In case of errors an `IndentedIO::Error` exception is raised
+
+## Add support for other classes
+
+You can add support for your own IO objects by including
+`IndentedIO::IndentedIOInterface` in your class.  All that is required is that
+the class define a `#print` method with the same semantics as the system
+`#print`
+
+```ruby
+require 'indented_io'
+class MyIO
+  include IndentedIO::IndentedIOInterface
+  def print(*args) ... end
+end
+
+my_io = MyIO.new
+my_io.indent.puts "It works!"
+```
+
+## Implementation & performance
+
+`IndentedIO` is intrusive because it extends the standard classes `Kernel`,
+`IO`, and `StringIO` with the `#indent` method. In addition, `Kernel#indent`
+with a block without parameters manipulates `$stdout`, replacing it with an
+`IndentedIO` object for the duration of the block
+
+The implementation carries no overhead if it is not used but the core indentation
+mechanism processes characters one-by-one which is slow compared to what could
+be achived with a native C implementation
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'indented_io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install indented_io
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/indented_io.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO

@@ -0,0 +1,19 @@
+
+TODO
+  o Check if IO object is writable - no good solution ?
+  o better name for @this_indent ? 'string' ?
+
+  + explain bol
+  + Allow a symbolic :string argument
+  + #printf !
+  + Make IndentedIO a pseudo IO object and forward to the root object
+  + Clean-up ugliness in IndentedIO#initialize
+  + Move bol to global
+  + Handle negative indent level
+  + #indent without block
+  + StringIO#indent !
+  + Rename Device -> IndentedIO
+
+  - Make Kernel.indent behave like Kernel ?
+
+  ? Create a BaseIndentedIO class ?

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "indented_io"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/indented_io.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "indented_io/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "indented_io"
+  spec.version       = IndentedIO::VERSION
+  spec.authors       = ["Claus Rasmussen"]
+  spec.email         = ["claus.l.rasmussen@gmail.com"]
+
+  spec.summary       = %q{Print indented text}
+  spec.description   = %q{
+                          IndentedIO extends Kernel, IO, and StringIO
+                          with an #indent method that returns an IndentedIO
+                          object. The IndentedIO object acts as the original
+                          object but redefines the output methods #print,
+                          #printf, #puts, and #p to print their output
+                          indented. Indentations are stacked so that each new
+                          indentation adds to the previous indendation
+                       }
+  spec.homepage      = "https://github.com/clrgit/indented_io"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/indented_io/error.rb

@@ -0,0 +1,6 @@
+
+module IndentedIO
+  # Error class
+  class Error < RuntimeError; end
+end
+

data/lib/indented_io/indented_io.rb

@@ -0,0 +1,165 @@
+require 'indented_io/indented_io_interface'
+
+module IndentedIO
+  # An IO device that writes indented text
+  #
+  # IndentedIO objects forms a chain that acts as a stack. The lowest element
+  # in the stack is always a "pure" IO object (eg. $stdout) and as indentation
+  # levels rise or fall IndentedIO objects are moved on and off the stack
+  #
+  # Note that #new is private. The only way to create a IndentedIO object is to
+  # call #indent on a object that supports it
+  class IndentedIO
+    include IndentedIOInterface
+
+    # :nodoc:
+    alias :interface_indent :indent
+    # :startdoc:
+
+    # Return a IndentedIO object
+    #
+    # See IndentedIO::IndentedIOInterface#indent for documentation
+    def indent(levels=1, string_ = self.this_indent, string: string_, bol: nil, &block)
+      interface_indent(levels, string, bol: bol, &block)
+    end
+
+    # Current level
+    def level
+      @level ||= @levels + (parent.is_a?(::IndentedIO::IndentedIO) ? parent.level : 0)
+    end
+
+    # Indent and print args to the underlying device. #print has the same semantic
+    # as Kernel#print
+    def print(*args)
+      if bol
+        @device.print @combined_indent
+        self.bol = false
+      end
+      args.join.each_char { |c|
+        if c == "\n"
+          self.bol = true
+        elsif bol
+          @device.print @combined_indent
+          self.bol = false
+        end
+        @device.print c
+      }
+      nil
+    end
+
+    # Indent and print args to the underlying device. #printf has the same semantic
+    # as Kernel#printf
+    def printf(format, *args)
+      print format % args
+    end
+
+    # Indent and print args to the underlying device. #puts has the same semantic
+    # as Kernel#puts
+    def puts(*args)
+      args.each { |arg| print(arg, "\n") }
+      nil
+    end
+
+    # Indent and print args to the underlying device. #p has the same semantic
+    # as Kernel#p. Please note that #p is usually not defined on other classes
+    # then Kernel but can be used on any IndentedIO object
+    def p(*args)
+      if bol
+        args.each { |arg| print(arg.inspect, "\n") }
+      else
+        @device.print args.first.inspect, "\n"
+        bol = true
+        args[1..-1].each { |arg| print(arg.inspect, "\n") }
+      end
+      args.size == 1 ? args.first : args
+    end
+
+    # :stopdoc:
+
+    # Make IndentedIO behave like the underlying @device
+    def respond_to?(method)
+      [:indent, :level, :print, :puts, :p].include?(method) || device.respond_to?(method)
+    end
+
+    # Make IndentedIO behave like the underlying @device
+    def method_missing(method, *args)
+      device.send(method, *args)
+    end
+
+  protected
+    # Reference to the pure IO object at the bottom of the stack. It is used to
+    # write directly to the IO object without having to recurse down the IndentedIO
+    # stack
+    attr_reader :device
+
+    # First IndentedIO object on the stack. Equal to self if self is the first
+    # indentation object. #base is used to keep track of #bol for the whole
+    # stack of IndentedIO objects
+    attr_reader :base
+
+    # Parent IndentedIO or IO object
+    attr_reader :parent
+
+    # Number of indent levels
+    attr_reader :levels
+
+    # Indent string for this device
+    attr_reader :this_indent
+
+    # The combined indent strings of previous levels plus this device's indent string
+    attr_reader :combined_indent
+
+    # True iff at Beginning-Of-Line
+    def bol()
+      @base == self ? @bol : @base.bol # @bol only exists in the #base object
+    end
+
+    # Set Beginning-Of-Line to true or false
+    def bol=(bol)
+      @base.instance_variable_set(:@bol, bol) # @bol only exists in the #base object
+    end
+
+    # Hide new
+    private_class_method :new
+
+    def initialize(parent, levels, this_indent, bol)
+      if levels < 0
+        parent.is_a?(::IndentedIO::IndentedIO) or raise IndentedIO::Error.new "Negative levels argument"
+        parent.level + levels >= 0 or raise IndentedIO::Error.new "levels out of range"
+        sibling = parent
+        while parent.is_a?(::IndentedIO::IndentedIO) && levels < 0
+          levels += parent.levels
+          sibling = parent
+          parent = parent.parent
+        end
+        this_indent ||= sibling.indent
+      end
+      @parent = parent
+      @levels = levels
+      @this_indent = this_indent
+      if @parent.is_a?(::IndentedIO::IndentedIO)
+        @device = @parent.device
+        @base = @parent.base
+        @combined_indent = @parent.combined_indent + @this_indent * @levels
+        self.bol = bol if !bol.nil?
+      else
+        @device = parent
+        @base = self
+        @combined_indent = @this_indent * @levels
+        self.bol = (bol.nil? ? true : bol)
+      end
+    end
+
+  public
+    def dump
+      $stderr.puts "#{self.class} [#{self.object_id}]"
+      $stderr.puts "  device: #{device.class} [#{device.object_id}]"
+      $stderr.puts "  base  : #{base.class} [#{base.object_id}]"
+      $stderr.puts "  parent: #{parent.class} [#{parent.object_id}]"
+      $stderr.puts "  levels: #{levels}"
+      $stderr.puts "  this_indent: #{this_indent.inspect}"
+      $stderr.puts "  combined_indent: #{combined_indent.inspect}"
+      $stderr.puts "  bol: #{bol}"
+    end
+  end
+end

data/lib/indented_io/indented_io_interface.rb

@@ -0,0 +1,29 @@
+module IndentedIO
+  # IndentedIO interface that provides the #indent method. Used by IO,
+  # StringIO, and IndentedIO. It can be included in any class that define a
+  # #print method
+  module IndentedIOInterface
+    # Returns a IndentedIO object that can be used for printing. The IO object
+    # will pass-through all method calls except #print, #printf, #puts, and #p
+    # to the enclosing object
+    #
+    # :call-seq:
+    #   indent(levels = 1)
+    #   indent(levels, string)
+    #   indent(levels, string: indent_string, bol: beginning_of_line)
+    #   indent(levels, string, bol: beginning_of_line)
+    #
+    # +levels+:: Number of indentation levels. Default is one level
+    # +string+:: The indentation string. Default is the indent string of the
+    #            outer level or ::IndentedIO.default_indent if this is the
+    #            first level
+    # +bol+:: Beginning of line. If true, #indent will begin writing with an
+    #         indentation string. If false, it will only indent after the next
+    #         newline. Default true
+    def indent(levels = 1, string_ = ::IndentedIO.default_indent, string: string_, bol: nil, &block)
+      block.nil? || block.arity == 1 or raise ::IndentedIO::Error.new "Wrong number of parameters"
+      obj = ::IndentedIO::IndentedIO.send(:new, self, levels, string, bol)
+      block_given? ? yield(obj) : obj
+    end
+  end
+end

data/lib/indented_io/io.rb

@@ -0,0 +1,7 @@
+require 'indented_io/indented_io_interface'
+
+# :nodoc:
+class IO
+  include IndentedIO::IndentedIOInterface
+end
+

data/lib/indented_io/kernel.rb

@@ -0,0 +1,26 @@
+require 'indented_io/indented_io_interface'
+
+# :nodoc:
+module Kernel
+  def indent(levels = 1, string_ = IndentedIO.default_indent, string: string_, bol: nil, &block)
+    block.nil? || block.arity <= 1 or raise IndentedIO::Error.new "Wrong number of parameters"
+    obj = IndentedIO::IndentedIO.send(:new, $stdout, levels, string, bol)
+    if block_given?
+      if block.arity == 1
+        r = yield obj
+      elsif block.arity == 0
+        saved_stdout = $stdout
+        begin
+          $stdout = obj
+          r = yield
+        ensure
+          $stdout = saved_stdout
+        end
+      end
+    else
+      r = obj
+    end
+    r
+  end
+end
+

data/lib/indented_io/stringio.rb

@@ -0,0 +1,6 @@
+require 'indented_io/indented_io_interface'
+
+# :nodoc:
+class StringIO
+  include IndentedIO::IndentedIOInterface
+end

data/lib/indented_io/version.rb

@@ -0,0 +1,4 @@
+module IndentedIO
+  # Version number
+  VERSION = "0.7.0"
+end

data/lib/indented_io.rb

@@ -0,0 +1,23 @@
+
+require 'indented_io/version'
+require 'indented_io/error'
+require 'indented_io/indented_io'
+require 'indented_io/indented_io_interface'
+require 'indented_io/kernel'
+require 'indented_io/io'
+require 'indented_io/stringio'
+
+# IndentedIO module
+
+module IndentedIO
+  # Returns default indentation. '  ' (two spaces) is the default but it can be
+  # set by #default_indent
+  def self.default_indent() @DEFAULT_INDENT end
+
+  # Set default indentation
+  def self.default_indent=(indent) @DEFAULT_INDENT = indent end
+
+private
+  @DEFAULT_INDENT = "  "
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: indented_io
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Claus Rasmussen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n                          IndentedIO extends Kernel, IO, and StringIO\n
+  \                         with an #indent method that returns an IndentedIO\n                          object.
+  The IndentedIO object acts as the original\n                          object but
+  redefines the output methods #print,\n                          #printf, #puts,
+  and #p to print their output\n                          indented. Indentations are
+  stacked so that each new\n                          indentation adds to the previous
+  indendation\n                       "
+email:
+- claus.l.rasmussen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/console
+- bin/setup
+- indented_io.gemspec
+- lib/indented_io.rb
+- lib/indented_io/error.rb
+- lib/indented_io/indented_io.rb
+- lib/indented_io/indented_io_interface.rb
+- lib/indented_io/io.rb
+- lib/indented_io/kernel.rb
+- lib/indented_io/stringio.rb
+- lib/indented_io/version.rb
+homepage: https://github.com/clrgit/indented_io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Print indented text
+test_files: []