tty-link 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5948d33fa21d9f739d69a6f3d405b463b83a1d81f5f149ab89ad274bbde77391
+  data.tar.gz: 4d896455c178b312659b95ab51014b73e5b6682d82183e0ec62878fdb185cd08
+SHA512:
+  metadata.gz: 5e28d2ad0b2c2bb811b6215baf52a6b3430cbaa40e9d7a7edcd7b97885a711f147d42985a2ed34bff2676b9fcba3db720eaa81ea5664ebde750121b141f1661b
+  data.tar.gz: 71d07d587ec15527d9fc01a4d409a7406633393276c7aaafd1d4d2d3ed40c755d05824a33f7dd895b6a007c485f29d395fdf120a74cc4781aa5723082fc89051

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,23 @@
+---
+language: ruby
+before_install: "gem install bundler -v '< 2.0'"
+script: bundle exec rake ci
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - ruby-head
+  - jruby-9.2.6.0
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-9.2.6.0
+  fast_finish: true
+branches:
+  only: master

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2019-08-10
+
+* Initial implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-link/compare/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@piotrmurach.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'simplecov', '~> 0.16.1'
+  gem 'coveralls', '~> 0.8.22'
+end
+
+group :metrics do
+  gem 'yardstick', '~> 0.9.9'
+end

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### Are you in the right place?
+* For issues or feature requests file a GitHub issue in this repository
+* For general questions or discussion post in [Gitter](https://gitter.im/piotrmurach/tty)
+
+### Describe the problem
+A brief description of the issue/feature.
+
+### Steps to reproduce the problem
+```
+Your code here to reproduce the issue
+```
+
+### Actual behaviour
+What happened? This could be a description, log output, error raised etc...
+
+### Expected behaviour
+What did you expect to happen?
+
+### Describe your environment
+
+* OS version:
+* Ruby version:
+* TTY::Link version:

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Describe the change
+What does this Pull Request do?
+
+### Why are we doing this?
+Any related context as to why is this is a desirable change.
+
+### Benefits
+How will the library improve?
+
+### Drawbacks
+Possible drawbacks applying this change.
+
+### Requirements
+Put an X between brackets on each line if you have done the item:
+[] Tests written & passing locally?
+[] Code style checked?
+[] Rebased with `master` branch?
+[] Documentation updated?

data/README.md

@@ -0,0 +1,80 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
+# TTY::Link
+
+[![Gem Version](https://badge.fury.io/rb/tty-link.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-link.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/4vb3w6wmr9w9vfp7?svg=true)][appveyor]
+[![Maintainability](https://api.codeclimate.com/v1/badges/3f8c368617c464238bf9/maintainability)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-link/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-link.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-link
+[travis]: http://travis-ci.org/piotrmurach/tty-link
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-link
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-link/maintainability
+[coverage]: https://coveralls.io/github/piotrmurach/tty-link
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-link
+
+> Hyperlinks in your terminal
+
+**TTY::Link** allows you to test whether a terminal supports hyperlinks and print them to the console. It is a component in [TTY toolkit](https://github.com/piotrmurach/tty)
+
+Terminal emulators such as `iTerm2` or `GNOME`, `XFCE` that use `VTE` widget support web style hyperlinks via `Ctrl+click` or `Cmd+click`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-link'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-link
+
+## Usage
+
+To print hyperlink in your terminal do:
+
+```ruby
+puts TTY::Link.link_to("TTY toolkit", "https://ttytoolkit.org")
+# =>
+# TTY toolkit
+```
+
+In cases when the terminal cannot support hyperlinks, an alternative is printed:
+
+```ruby
+# TTY toolkit -> https://ttytoolkit.org
+```
+
+## 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/tty-link. 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 TTY::Link project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-link/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2019 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/appveyor.yml

@@ -0,0 +1,28 @@
+---
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - gem install bundler -v '< 2.0'
+  - bundle install
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+build: off
+test_script:
+  - bundle exec rake ci
+environment:
+  matrix:
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"
+    - ruby_version: "26"
+    - ruby_version: "26-x64"

data/bin/console

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

@@ -0,0 +1 @@
+require_relative "tty/link"

data/lib/tty/link.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "link/version"
+
+module TTY
+  module Link
+    class Error < StandardError; end
+
+    ESC = "\u001B["
+    OSC = "\u001B]"
+    BEL = "\u0007"
+    SEP = ";"
+
+    ITERM = /iTerm(\s*\d+){0,1}.app/x.freeze
+
+    # Parse version number
+    #
+    # @param [String] version
+    #
+    # @api private
+    def parse_version(version)
+      if (matches = version.match(/^(\d{1,2})(\d{2})$/))
+        major, minor, patch = 0, matches[1].to_i, matches[2].to_i
+      else
+        major, minor, patch = version.split(".").map(&:to_i)
+      end
+      { major: major, minor: minor, patch: patch }
+    end
+    module_function :parse_version
+
+    # Check if link is supported
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def support_link?(output: $stdout)
+      return false unless output.tty?
+
+      if ENV["TERM_PROGRAM"] =~ ITERM
+        version = parse_version(ENV["TERM_PROGRAM_VERSION"])
+
+        return version[:major] > 3 || version[:major] == 3 && version[:minor] > 0
+      end
+
+      # uses VTE terminal
+      if ENV["VTE_VERSION"]
+        version = parse_version(ENV["VTE_VERSION"])
+
+        return version[:major] > 0 || version[:minor] > 50 ||
+          version[:minor] == 50 && version[:patch] > 0
+      end
+
+      return false
+    end
+    module_function :support_link?
+
+    # Render terminal link
+    #
+    # @param [String] name
+    # @param [String] url
+    #
+    # @return [String]
+    #
+    # @api public
+    def link_to(name, url)
+      if support_link?
+        [ OSC, "8", SEP, SEP, url, BEL, name, OSC, "8", SEP, SEP, BEL ].join("")
+      else
+        "#{name} -> #{url}"
+      end
+    end
+    module_function :link_to
+  end # Link
+end # TTY

data/lib/tty/link/version.rb

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

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+desc "Load gem inside irb console"
+task :console do
+  require "irb"
+  require "irb/completion"
+  require File.join(__FILE__, "../../lib/tty-link")
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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 @@
+# frozen_string_literal: true
+
+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

data/tty-link.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tty/link/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-link"
+  spec.version       = TTY::Link::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = ["me@piotrmurach.com"]
+  spec.summary       = %q{Hyperlinks in your terminal}
+  spec.description   = %q{Hyperlinks in your terminal}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  spec.license       = "MIT"
+  if spec.respond_to?(:metadata=)
+    spec.metadata = {
+      "allowed_push_host" => "https://rubygems.org",
+      "bug_tracker_uri"   => "https://github.com/piotrmurach/tty-link/issues",
+      "changelog_uri"     => "https://github.com/piotrmurach/tty-link/blob/master/CHANGELOG.md",
+      "documentation_uri" => "https://www.rubydoc.info/gems/tty-link",
+      "homepage_uri"      => spec.homepage,
+      "source_code_uri"   => "https://github.com/piotrmurach/tty-link"
+    }
+  end
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", ">= 1.5.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: tty-link
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: Hyperlinks in your terminal
+email:
+- me@piotrmurach.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- ISSUE_TEMPLATE.md
+- LICENSE.txt
+- PULL_REQUEST_TEMPLATE.md
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- lib/tty-link.rb
+- lib/tty/link.rb
+- lib/tty/link/version.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-link.gemspec
+homepage: https://piotrmurach.github.io/tty
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-link/issues
+  changelog_uri: https://github.com/piotrmurach/tty-link/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-link
+  homepage_uri: https://piotrmurach.github.io/tty
+  source_code_uri: https://github.com/piotrmurach/tty-link
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hyperlinks in your terminal
+test_files: []