strings-ansi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 540eea845a26f994ba09c899527626924af8e093fa4a34732ad55cb1b58bb931
+  data.tar.gz: ad0d1580f3242d77f7a6629ae8d890658aa8d151d5ee3350296a531e623213c8
+SHA512:
+  metadata.gz: c0cdd5660042a10533cefea4fa776007219ac46671c62128f9e922697087a088e56aed1d6d7bcc0fbff01e09dd239c97230368bb8d043b2dd1ce6843acbe5469
+  data.tar.gz: d4818de6992115b1a0a56680dc681d7783fb4824ebe078992d9a11c26910d1ee0ddc28c5d35c9d01b461e3f57635037c09610e539aaa01ce63c649361faf0a96

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2018-08-27
+
+* Inital implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/strings-ansi/compare/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Piotr Murach
+
+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,140 @@
+<div align="center">
+  <img width="225" src="https://cdn.rawgit.com/piotrmurach/strings/master/assets/strings_logo.png" alt="strings logo" />
+</div>
+
+# Strings::ANSI
+
+[![Gem Version](https://badge.fury.io/rb/strings-ansi.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/strings-ansi.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/amffv5g25m02yu9h?svg=true)][appveyor]
+[![Maintainability](https://api.codeclimate.com/v1/badges/7c018a761a342ccb0746/maintainability)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/strings-ansi/badge.svg?branch=master)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/strings-ansi.svg?branch=master)][inchpages]
+
+[gem]: http://badge.fury.io/rb/strings-ansi
+[travis]: http://travis-ci.org/piotrmurach/strings-ansi
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/strings-ansi
+[codeclimate]: https://codeclimate.com/github/piotrmurach/strings-ansi/maintainability
+[coverage]: https://coveralls.io/github/piotrmurach/strings-ansi?branch=master
+[inchpages]: http://inch-ci.org/github/piotrmurach/strings-ansi
+
+> Handle ANSI escape codes in strings.
+
+**Strings::ANSI** provides ANSI handling for [Strings](https://github.com/piotrmurach/strings) utilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strings-ansi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strings-ansi
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. API](#2-api)
+  * [2.1 ansi?](#21-ansi)
+  * [2.2 only_ansi?](#22-only_ansi)
+  * [2.3 sanitize](#23-sanitize)
+* [3. Extending String class](#3-extending-string-class)
+
+## Usage
+
+The `Strings::ANSI` is a module with functions that can be called directly.
+
+```ruby
+Strings::ANSI.ansi?('...')
+```
+
+## 2. API
+
+### 2.1 ansi?
+
+To check if a string includes ANSI escape codes use `ansi?` like so:
+
+```ruby
+Strings::ANSI.ansi?("\e[33;44mfoo\e[0m")
+# => true
+```
+
+### 2.2 only_ansi?
+
+To check if a string includes only ANSI escape codes use `only_ansi?`:
+
+```ruby
+Strings::ANSI.only_ansi?("\e[33;44mfoo\e[0m")
+# => false
+```
+
+### 2.3 sanitize
+
+To remove ANSI codes from a string use `sanitize`:
+
+```ruby
+Strings::ANSI.sanitize("\e[0;33;49mHello\e[0m")
+# => Hello
+```
+
+## 3. Extending String class
+
+Though it is highly discouraged to polute core Ruby classes, you can add the required methods to `String` class by using refinements.
+
+For example, if you wish to only extend strings with `sanitize` method do:
+
+```ruby
+module MyStringExt
+  refine String do
+    def sanitize
+      Strings::ANSI.sanitize(self)
+    end
+  end
+end
+```
+
+then `sanitize` method will be available for any strings where refinement is applied:
+
+```ruby
+using MyStringExt
+
+string.sanitize("\e[32mHello\e[0m")
+# => Hello
+```
+
+Alternatively, if you want to include all the **Strings::ANSI** methods:
+
+```ruby
+require 'strings/ansi/extensions'
+
+using Strings::ANSI::Extensions
+```
+
+## 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/piotrmurach/strings-ansi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Strings::Ansi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/strings-ansi/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2018 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1 @@
+require_relative 'strings/ansi'

data/lib/strings/ansi.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'ansi/version'
+
+module Strings
+  # Helper functions for handling ANSI escape sequences
+  module ANSI
+    # The control sequence indicator
+    CSI = "\033"
+
+    # The code for reseting styling
+    RESET = "\e[0m"
+
+    # The regex to match ANSI codes
+    ANSI_MATCHER = '(\[)?\033(\[)?[;?\d]*[\dA-Za-z]([\];])?'
+
+    # Return a copy of string with ANSI characters removed
+    #
+    # @param [String] string
+    #
+    # @example
+    #   Strings::ANSI.sanitize("\e[33mfoo\[e0m")
+    #   # => "foo"
+    #
+    # @return [String]
+    #
+    # @api public
+    def sanitize(string)
+      string.gsub(/#{ANSI_MATCHER}/, '')
+    end
+    module_function :sanitize
+
+    # Check if string contains ANSI codes
+    #
+    # @param [String] string
+    #   the string to check
+    #
+    # @example
+    #   Strings::ANSI.ansi?("\e[33mfoo\[e0m")
+    #   # => true
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ansi?(string)
+      !!(string =~ /#{ANSI_MATCHER}/)
+    end
+    module_function :ansi?
+
+    # Check if string contains only ANSI codes
+    #
+    # @param [String] string
+    #   the string to check
+    #
+    # @example
+    #   Strings::ANSI.only_ansi?("\e[33mfoo\[e0m")
+    #   # => false
+    #
+    #   Strings::ANSI.only_ansi?("\e[33m")
+    #   # => false
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def only_ansi?(string)
+      !!(string =~ /^(#{ANSI_MATCHER})+$/)
+    end
+    module_function :only_ansi?
+  end # ANSI
+end # Strings

data/lib/strings/ansi/extensions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../ansi'
+
+module Strings
+  module ANSI
+    module Extensions
+      refine String do
+        def ansi?
+          ANSI.ansi?(self)
+        end
+
+        def only_ansi?
+          ANSI.only_ansi?(self)
+        end
+
+        def sanitize
+          ANSI.sanitize(self)
+        end
+      end
+    end # Extensions
+  end # ANSI
+end # Strings

data/lib/strings/ansi/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Strings
+  module ANSI
+    VERSION = "0.1.0"
+  end # ANSI
+end # Strings

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require "bundler/setup"
+require "strings/ansi"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/ansi_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::ANSI, '#ansi?' do
+  it "does't report empty string" do
+    expect(Strings::ANSI.ansi?('')).to eq(false)
+  end
+
+  it "reports non-ansi string correctly" do
+    expect(Strings::ANSI.ansi?("foo")).to eq(false)
+  end
+
+  it "checks if code is ansi" do
+    expect(Strings::ANSI.ansi?("\e[33;44mfoo\e[0m")).to eq(true)
+  end
+end

data/spec/unit/extensions_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'strings/ansi/extensions'
+
+using Strings::ANSI::Extensions
+
+RSpec.describe Strings::ANSI::Extensions do
+  it "checks for presence of ansi codes" do
+    expect("\e[33mfoo\e[0m".ansi?).to eq(true)
+  end
+
+  it "checks if string contains only ansi codes" do
+    expect("\e[33mfoo\e[0m".ansi?).to eq(true)
+  end
+
+  it "strips ansi codes" do
+    expect("\e[33mfoo\e[0m".sanitize).to eq('foo')
+  end
+end

data/spec/unit/only_ansi_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::ANSI, '#only_ansi?' do
+  it "doesn't report empty string as having ansi codes" do
+    expect(Strings::ANSI.only_ansi?('')).to eq(false)
+  end
+
+  it "doesn't report string without ansi" do
+    expect(Strings::ANSI.only_ansi?("foo")).to eq(false)
+  end
+
+  it "doesn't report string containing ansi codes" do
+    expect(Strings::ANSI.only_ansi?("\e[33;44mfoo\e[0m")).to eq(false)
+  end
+
+  it "reports string with only ansi codes correctly" do
+    expect(Strings::ANSI.only_ansi?("\e[33;44m\e[0m")).to eq(true)
+  end
+end

data/spec/unit/sanitize_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe Strings::ANSI, '#sanitize' do
+  {
+    "\e[20h" => '',
+    "\e[?1h" => '',
+    "\e[20l" => '',
+    "\e[?9l" => '',
+    "\eO"    => '',
+    "\e[m"   => '',
+    "\e[0m"  => '',
+    "\eA"    => '',
+    "\e[0;33;49;3;9;4m\e[0m" => ''
+  }.each do |code, expected|
+    it "remove #{code.inspect} from string" do
+      expect(Strings::ANSI.sanitize(code)).to eq(expected)
+    end
+  end
+end

data/strings-ansi.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "strings/ansi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strings-ansi"
+  spec.version       = Strings::ANSI::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+
+  spec.summary       = %q{Methods for processing ANSI escape codes in strings.}
+  spec.description   = %q{Methods for processing ANSI escape codes in strings.}
+  spec.homepage      = "https://github.com/piotrmurach/strings"
+  spec.license       = "MIT"
+
+  spec.files         = Dir['{lib,spec}/**/*.rb', '{bin,tasks}/*', 'strings-ansi.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
+  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/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/strings-ansi')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: strings-ansi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-27 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: Methods for processing ANSI escape codes in strings.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strings-ansi.rb
+- lib/strings/ansi.rb
+- lib/strings/ansi/extensions.rb
+- lib/strings/ansi/version.rb
+- spec/spec_helper.rb
+- spec/unit/ansi_spec.rb
+- spec/unit/extensions_spec.rb
+- spec/unit/only_ansi_spec.rb
+- spec/unit/sanitize_spec.rb
+- strings-ansi.gemspec
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+homepage: https://github.com/piotrmurach/strings
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Methods for processing ANSI escape codes in strings.
+test_files: []