strings-ansi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 540eea845a26f994ba09c899527626924af8e093fa4a34732ad55cb1b58bb931
-  data.tar.gz: ad0d1580f3242d77f7a6629ae8d890658aa8d151d5ee3350296a531e623213c8
+  metadata.gz: a966ca7d6455dbc43c9e2c93124304c5ae31c0b1b26dfe9e6f469bda773f25d6
+  data.tar.gz: a39fc8ed1d904fc3dfcca887a5a24e27daae0a9e97b3d8aad487768261444898
 SHA512:
-  metadata.gz: c0cdd5660042a10533cefea4fa776007219ac46671c62128f9e922697087a088e56aed1d6d7bcc0fbff01e09dd239c97230368bb8d043b2dd1ce6843acbe5469
-  data.tar.gz: d4818de6992115b1a0a56680dc681d7783fb4824ebe078992d9a11c26910d1ee0ddc28c5d35c9d01b461e3f57635037c09610e539aaa01ce63c649361faf0a96
+  metadata.gz: 61de476ad781d4e08d90a76486c1b696672693a5087fb691008c6203e4bc59da0df8542d7fb034bafb911b904bf998e773c98be2fc366f9560f50ceb3e7eb07b
+  data.tar.gz: 526b28d9c1b4a85230bc30f20a954cf992f00e701cdc7b399bb6095f45459ac86f358cfb85ade8a5d2930b673750d90913dae063e21834b32a889f09c8f7228c

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Change log
 
+## [v0.2.0] - 2019-11-12
+
+### Change
+* Change gemspec to include metadata
+* Change gemspec to limit Ruby version to >= 2.0
+* Change gemspec to relax dev dependency of bundler version
+
 ## [v0.1.0] - 2018-08-27
 
-* Inital implementation and release
+* Initial implementation and release
 
+[v0.2.0]: https://github.com/piotrmurach/strings-ansi/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/strings-ansi/compare/v0.1.0

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img width="225" src="https://cdn.rawgit.com/piotrmurach/strings/master/assets/strings_logo.png" alt="strings logo" />
+  <img width="225" src="https://github.com/piotrmurach/strings/blob/master/assets/strings_logo.png" alt="strings logo" />
 </div>
 
 # Strings::ANSI
@@ -20,7 +20,7 @@
 
 > Handle ANSI escape codes in strings.
 
-**Strings::ANSI** provides ANSI handling for [Strings](https://github.com/piotrmurach/strings) utilities.
+**Strings::ANSI** provides ANSI handling component for [Strings](https://github.com/piotrmurach/strings).
 
 ## Installation
 
@@ -49,10 +49,25 @@ Or install it yourself as:
 
 ## Usage
 
-The `Strings::ANSI` is a module with functions that can be called directly.
+The `Strings::ANSI` is a module that can check if a string has ANSI escape codes:
 
 ```ruby
-Strings::ANSI.ansi?('...')
+Strings::ANSI.ansi?("\e[32mHello\e[0m")
+# => true
+```
+
+It can also check if a string consists of only ANSI codes:
+
+```ruby
+Strings::ANSI.only_ansi?("\e[32mHello\e[0m")
+# => false
+```
+
+Finally, you can remove any ANSI codes from a string:
+
+```ruby
+Strings::ANSI.sanitize("\e[32mHello\e[0m")
+# => "Hello"
 ```
 
 ## 2. API
@@ -86,7 +101,7 @@ Strings::ANSI.sanitize("\e[0;33;49mHello\e[0m")
 
 ## 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.
+Though it is highly discouraged to pollute 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:
 
@@ -100,7 +115,7 @@ module MyStringExt
 end
 ```
 
-then `sanitize` method will be available for any strings where refinement is applied:
+This will make `sanitize` method available for any strings where refinement is applied:
 
 ```ruby
 using MyStringExt
@@ -133,7 +148,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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
 

data/lib/strings/ansi/version.rb

@@ -2,6 +2,6 @@
 
 module Strings
   module ANSI
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # ANSI
 end # Strings

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'
@@ -14,7 +16,7 @@ if ENV['COVERAGE'] || ENV['TRAVIS']
 end
 
 require "bundler/setup"
-require "strings/ansi"
+require "strings-ansi"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

data/spec/unit/sanitize_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Strings::ANSI, '#sanitize' do
     "\eA"    => '',
     "\e[0;33;49;3;9;4m\e[0m" => ''
   }.each do |code, expected|
-    it "remove #{code.inspect} from string" do
+    it "removes #{code.inspect} from string" do
       expect(Strings::ANSI.sanitize(code)).to eq(expected)
     end
   end

data/strings-ansi.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "strings/ansi/version"
@@ -7,19 +6,29 @@ Gem::Specification.new do |spec|
   spec.name          = "strings-ansi"
   spec.version       = Strings::ANSI::VERSION
   spec.authors       = ["Piotr Murach"]
-  spec.email         = [""]
+  spec.email         = ["me@piotrmurach.com"]
 
   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.homepage      = "https://github.com/piotrmurach/strings-ansi"
   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.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/piotrmurach/strings-ansi/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/piotrmurach/strings-ansi/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/strings-ansi"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/piotrmurach/strings-ansi"
+
+  spec.files         = Dir["{lib,spec}/**/*.rb"]
+  spec.files        += Dir["{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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", ">= 1.5"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/tasks/console.rake

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-desc 'Load gem inside irb console'
+desc "Load gem inside irb console"
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require File.join(__FILE__, '../../lib/strings-ansi')
+  require "irb"
+  require "irb/completion"
+  require File.join(__FILE__, "../../lib/strings-ansi")
   ARGV.clear
   IRB.start
 end

data/tasks/coverage.rake

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

data/tasks/spec.rake

@@ -1,22 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
 
-  desc 'Run all specs'
+  desc "Run all specs"
   RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+    task.pattern = "spec/{unit,integration}{,/*/**}/*_spec.rb"
   end
 
   namespace :spec do
-    desc 'Run unit specs'
+    desc "Run unit specs"
     RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+      task.pattern = "spec/unit{,/*/**}/*_spec.rb"
     end
 
-    desc 'Run integration specs'
+    desc "Run integration specs"
     RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+      task.pattern = "spec/integration{,/*/**}/*_spec.rb"
     end
   end
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: strings-ansi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-27 00:00:00.000000000 Z
+date: 2019-11-12 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'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +54,7 @@ dependencies:
         version: '3.0'
 description: Methods for processing ANSI escape codes in strings.
 email:
-- ''
+- me@piotrmurach.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -78,10 +78,16 @@ files:
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
-homepage: https://github.com/piotrmurach/strings
+homepage: https://github.com/piotrmurach/strings-ansi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/strings-ansi/issues
+  changelog_uri: https://github.com/piotrmurach/strings-ansi/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/strings-ansi
+  homepage_uri: https://github.com/piotrmurach/strings-ansi
+  source_code_uri: https://github.com/piotrmurach/strings-ansi
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,15 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Methods for processing ANSI escape codes in strings.