ansi_string 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d27e27a89f1bc2e725db1275b73b741dda60878
+  data.tar.gz: 65b257a825eb8e50fcba397647596d01164b7cae
+SHA512:
+  metadata.gz: a3d1a8dc6aa9bbcca32192a2268d46e2614ed50cf35ee8a5eb5f6ed81f10218da9c56a2297e7a3d92147922c01d32bf96a5530f7ee489fc28aa34240ffa474a6
+  data.tar.gz: 1d910cfd8d008811ac332ed8569db14dc8125ce2dc49f05e602aa769aa3a20630c64ce4b8fb89624b28c2448b38cacd45fbca244fd5fcf9b6fdd975e6eb5b591

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ansi_string.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zach Dennis
+
+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,41 @@
+# AnsiString
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ansi_string`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ansi_string'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ansi_string
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/ansi_string.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/ansi_string.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansi_string/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ansi_string"
+  spec.version       = AnsiString::VERSION
+  spec.authors       = ["Zach Dennis"]
+  spec.email         = ["zach.dennis@gmail.com"]
+
+  spec.summary       = %q{ANSIString is a String library that is ANSI-sequence-aware}
+  spec.description   = %q{ANSIString is a String library that is ANSI-sequence-aware}
+  spec.homepage      = "https://github.com/zdennis/ansi_string"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "term-ansicolor", "~> 1.3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ansi_string"
+
+# 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

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/lib/ansi_string.rb

@@ -0,0 +1,371 @@
+# encoding: UTF-8
+require 'ansi_string/version'
+require 'forwardable'
+
+class ANSIString
+  extend Forwardable
+  attr_reader :raw, :without_ansi
+
+  def_delegators :@without_ansi, :each_char, :each_byte, :index,
+    :match, :=~
+
+  def initialize(str)
+    process_string raw_string_for(str)
+  end
+
+  def +(other)
+    self.class.new @raw + raw_string_for(other)
+  end
+
+  def <<(other)
+    range = length..length
+    str = replace_in_string(range, other)
+    process_string raw_string_for(str)
+    self
+  end
+
+  def insert(position, string)
+    if position < 0
+      position = @without_ansi.length + position + 1
+    end
+    self[position...position] = string
+    self
+  end
+
+  def empty?
+    length == 0
+  end
+
+  def [](range)
+    # convert numeric position to a range
+    range = (range..range) if range.is_a?(Integer)
+
+    range_begin = range.begin
+    range_end = range.end
+
+    if range.exclude_end?
+      if range_begin == 0 && range_end == 0
+        return ""
+      else
+        range_end -= 1
+      end
+    end
+
+    range_begin = @without_ansi.length - range.begin.abs if range.begin < 0
+    range_end = @without_ansi.length - range.end.abs if range.end < 0
+
+    str = build_string_with_ansi_for(range_begin..range_end)
+    ANSIString.new str if str
+  end
+
+  def []=(range, replacement_str)
+    # convert numeric position to a range
+    range = (range..range) if range.is_a?(Integer)
+
+    range_begin = range.begin
+    range_end = range.exclude_end? ? range.end - 1 : range.end
+
+    range_begin = @without_ansi.length - range.begin.abs if range.begin < 0
+    range_end = @without_ansi.length - range.end.abs if range.end < 0
+
+    updated_string = replace_in_string(range_begin..range_end, replacement_str)
+    process_string raw_string_for(updated_string)
+    self
+  end
+
+  # See String#rindex for arguments
+  def rindex(*args)
+    @without_ansi.rindex(*args)
+  end
+
+  def replace(str)
+    process_string raw_string_for(str)
+    self
+  end
+
+  def reverse
+    str = @ansi_sequence_locations.reverse.map do |location|
+      [location[:start_ansi_sequence], location[:text].reverse, location[:end_ansi_sequence]].join
+    end.join
+    ANSIString.new str
+  end
+
+  def scan(pattern)
+    results = []
+    without_ansi.enum_for(:scan, pattern).each do
+      md = Regexp.last_match
+      if md.captures.any?
+        results << md.captures.map.with_index do |_, i|
+          # captures use 1-based indexing
+          self[md.begin(i+1)..md.end(i+1)-1]
+        end
+      else
+        results << self[md.begin(0)..md.end(0)-1]
+      end
+    end
+    results
+  end
+
+  def slice(index, length=nil)
+    return ANSIString.new("") if length == 0
+    range = nil
+    index = index.without_ansi if index.is_a?(ANSIString)
+    index = Regexp.new Regexp.escape(index) if index.is_a?(String)
+    if index.is_a?(Integer)
+      length ||= 1
+      range = (index..index+length-1)
+    elsif index.is_a?(Range)
+      range = index
+    elsif index.is_a?(Regexp)
+      md = @without_ansi.match(index)
+      capture_group_index = length || 0
+      if md
+        capture_group = md.offset(capture_group_index)
+        range = (capture_group.first..capture_group.last-1)
+      end
+    else
+      raise(ArgumentError, "Must pass in at least an index or a range.")
+    end
+    self[range] if range
+  end
+
+  def split(*args)
+    raw.split(*args).map { |s| ANSIString.new(s) }
+  end
+
+  def strip
+    ANSIString.new raw.strip
+  end
+
+  def length
+    @without_ansi.length
+  end
+
+  def lines
+    result = []
+    current_string = ""
+    @ansi_sequence_locations.map do |location|
+      if location[:text] == "\n"
+        result << ANSIString.new(current_string + "\n")
+        current_string = ""
+        next
+      end
+
+      location[:text].scan(/.*(?:\n|$)/).each_with_index do |line, i|
+        break if line == ""
+
+        if i == 0
+          current_string << [
+            location[:start_ansi_sequence],
+            line,
+            location[:end_ansi_sequence]
+          ].join
+        else
+          result << ANSIString.new(current_string)
+          current_string = ""
+          current_string << [
+            location[:start_ansi_sequence],
+            line,
+            location[:end_ansi_sequence]
+          ].join
+        end
+      end
+
+      if location[:text].end_with?("\n")
+        result << ANSIString.new(current_string)
+        current_string = ""
+        next
+      end
+    end
+    result << ANSIString.new(current_string) if current_string.length > 0
+    result
+  end
+
+  def dup
+    ANSIString.new(@raw.dup)
+  end
+
+  def sub(pattern, replacement)
+    str = ""
+    count = 0
+    max_count = 1
+    index = 0
+    @without_ansi.enum_for(:scan, pattern).each do
+      md = Regexp.last_match
+      str << build_string_with_ansi_for(index...(index + md.begin(0)))
+      index = md.end(0)
+      break if (count += 1) == max_count
+    end
+    if index != @without_ansi.length
+      str << build_string_with_ansi_for(index..@without_ansi.length)
+    end
+    nstr = str.gsub /(\033\[[0-9;]*m)(.+?)\033\[0m\1/, '\1\2'
+    ANSIString.new(nstr)
+  end
+
+  def to_s
+    @raw.dup
+  end
+  alias :to_str :to_s
+
+  def inspect
+    to_s.inspect
+  end
+
+  def ==(other)
+    (other.class == self.class && other.raw == @raw) || (other.kind_of?(String) && other == @raw)
+  end
+
+  def <=>(other)
+    (other.class == self.class && @raw <=> other.raw)
+  end
+
+  private
+
+  def raw_string_for(str)
+    str.is_a?(ANSIString) ? str.raw : str.to_s
+  end
+
+  def process_string(raw_str)
+    @without_ansi = ""
+    @ansi_sequence_locations = []
+    raw_str.enum_for(:scan, /(\e\[[0-9;]*m)?(.*?)(?=\e\[[0-9;]*m|\Z)/m ).each do
+      md = Regexp.last_match
+      ansi_sequence, text = md.captures
+
+      previous_sequence_location = @ansi_sequence_locations.last
+      if previous_sequence_location
+        if ansi_sequence == "\e[0m"
+          previous_sequence_location[:end_ansi_sequence] = ansi_sequence
+          ansi_sequence = nil
+        elsif previous_sequence_location[:start_ansi_sequence] == ansi_sequence
+          previous_sequence_location[:text] << text
+          previous_sequence_location[:ends_at] += text.length
+          previous_sequence_location[:length] += text.length
+          @without_ansi << text
+          next
+        end
+      end
+
+      if ansi_sequence.nil? && text.to_s.length == 0
+        next
+      end
+
+      @ansi_sequence_locations.push(
+        begins_at: @without_ansi.length,
+        ends_at: [@without_ansi.length + text.length - 1, 0].max,
+        length: text.length,
+        text: text,
+        start_ansi_sequence: ansi_sequence
+      )
+
+      @without_ansi << text
+    end
+
+    @raw = @ansi_sequence_locations.map do |location|
+      [location[:start_ansi_sequence], location[:text], location[:end_ansi_sequence]].compact.join
+    end.join
+
+    @ansi_sequence_locations
+  end
+
+  def replace_in_string(range, replacement_str)
+    raise RangeError, "#{range.inspect} out of range" if range.begin > length
+    return replacement_str if @ansi_sequence_locations.empty?
+
+    range = range.begin..(range.end - 1) if range.exclude_end?
+    str = ""
+    @ansi_sequence_locations.each_with_index do |location, j|
+      # If the given range encompasses part of the location, then we want to
+      # include the whole location
+      if location[:begins_at] >= range.begin && location[:ends_at] <= range.end
+        end_index = range.end - location[:begins_at] + 1
+
+        str << [
+          location[:start_ansi_sequence],
+          replacement_str,
+          location[:text][end_index..-1],
+          location[:end_ansi_sequence]
+        ].join
+
+      # If the location falls within the given range then  make sure we pull
+      # out the bits that we want, and keep ANSI escape sequenece intact while
+      # doing so.
+      elsif location[:begins_at] <= range.begin && location[:ends_at] >= range.end
+        start_index = range.begin - location[:begins_at]
+        end_index = range.end - location[:begins_at] + 1
+
+        str << [
+          location[:start_ansi_sequence],
+          location[:text][0...start_index],
+          replacement_str,
+          location[:text][end_index..-1],
+          location[:end_ansi_sequence]
+        ].join
+
+      elsif location[:ends_at] == range.begin
+        start_index = range.begin - location[:begins_at]
+        end_index = range.end
+        num_chars_to_remove_from_next_location = range.end - location[:ends_at]
+
+        str << [
+          location[:start_ansi_sequence],
+          location[:text][location[:begins_at]...(location[:begins_at]+start_index)],
+          replacement_str,
+          location[:text][end_index..-1],
+          location[:end_ansi_sequence],
+        ].join
+
+        if location=@ansi_sequence_locations[j+1]
+          old = location.dup
+          location[:text][0...num_chars_to_remove_from_next_location] = ""
+          location[:begins_at] += num_chars_to_remove_from_next_location
+          location[:ends_at] += num_chars_to_remove_from_next_location
+        end
+
+      # If we're pushing onto the end of the string
+      elsif range.begin == length && location[:ends_at] == length - 1
+        if replacement_str.is_a?(ANSIString)
+          str << [location[:start_ansi_sequence], location[:text], location[:end_ansi_sequence], replacement_str].join
+        else
+          str << [location[:start_ansi_sequence], location[:text], replacement_str, location[:end_ansi_sequence]].join
+        end
+      else
+        str << [location[:start_ansi_sequence], location[:text], location[:end_ansi_sequence]].join
+      end
+    end
+
+    str
+  end
+
+  def build_string_with_ansi_for(range)
+    return nil if range.begin > length
+
+    str = ""
+
+    if range.exclude_end?
+      range = range.begin..(range.end - 1)
+    end
+
+    @ansi_sequence_locations.each do |location|
+      # If the given range encompasses part of the location, then we want to
+      # include the whole location
+      if location[:begins_at] >= range.begin && location[:ends_at] <= range.end
+        str << [location[:start_ansi_sequence], location[:text], location[:end_ansi_sequence]].join
+
+      elsif location[:begins_at] >= range.begin && location[:begins_at] <= range.end
+        str << [location[:start_ansi_sequence], location[:text][0..(range.end - location[:begins_at])], location[:end_ansi_sequence]].join
+
+      # If the location falls within the given range then  make sure we pull
+      # out the bits that we want, and keep ANSI escape sequenece intact while
+      # doing so.
+      elsif (location[:begins_at] <= range.begin && location[:ends_at] >= range.end) || range.cover?(location[:ends_at])
+        start_index = range.begin - location[:begins_at]
+        end_index = range.end - location[:begins_at]
+        str << [location[:start_ansi_sequence], location[:text][start_index..end_index], location[:end_ansi_sequence]].join
+      end
+    end
+    str
+  end
+
+end

data/lib/ansi_string/version.rb

@@ -0,0 +1,3 @@
+class AnsiString
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ansi_string
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Dennis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ANSIString is a String library that is ANSI-sequence-aware
+email:
+- zach.dennis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ansi_string.gemspec
+- bin/console
+- bin/setup
+- lib/ansi_string.rb
+- lib/ansi_string/version.rb
+homepage: https://github.com/zdennis/ansi_string
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ANSIString is a String library that is ANSI-sequence-aware
+test_files: []
+has_rdoc: