tty-platform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e68ecc0742c5f300e164e6664cfc3c228cc31f4
+  data.tar.gz: a9abe4cc3950411fe3e2155fc5796347459a7fd7
+SHA512:
+  metadata.gz: 72112f32a469e449c1b897b9a268976b50c8485b8895cb558e09f6f92634ab32189bf1767235e93cd6f198aa68884638188e394ca2e1eb0c5b1d36e9c961ca00
+  data.tar.gz: fe28d96ede597fa9b693937588330739aad7a49ce1bec753509d0748ea60f1fcf854022bb1787d2a2ebc3885d135d35a31524632c5ba93969f208e8ad5b03daa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+bundler_args: --without yard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',    '~> 10.4.2'
+  gem 'rspec',   '~> 3.2.0'
+  gem 'yard',    '~> 0.8.7'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.8.1'
+  gem 'simplecov', '~> 0.10.0'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Piotr Murach
+
+MIT License
+
+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,83 @@
+# TTY::Platform
+[![Gem Version](https://badge.fury.io/rb/tty-platform.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty-platform.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/tty-platform.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-platform/badge.svg)][coverage]
+
+[gem]: http://badge.fury.io/rb/tty-platform
+[travis]: http://travis-ci.org/peter-murach/tty-platform
+[codeclimate]: https://codeclimate.com/github/peter-murach/tty-platform
+[coverage]: https://coveralls.io/r/peter-murach/tty-platform
+
+> Terminal platform query methods for detecting different operating systems.
+
+**TTY::Platform** provides independent operating system detection component for [TTY](https://github.com/peter-murach/tty) toolkit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-platform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-platform
+
+## 1. Usage
+
+With **TTY::Platform** you can find out the properties of your operating system by creating an instance:
+
+```ruby
+platform = TTY::Platform.new
+```
+
+To query for processor name use `cpu` method:
+
+```ruby
+platform.cpu     # => 'x86_64'
+```
+
+A `nil` is returned if the value cannot be determined.
+
+To get the system/OS name use `os` method:
+
+```ruby
+platform.os      # => 'darwin'
+```
+
+A `nil` is returned if the value cannot be determined.
+
+To get system's release version use `version` method:
+
+```ruby
+platform.version # => '10.6.1'
+```
+
+A `nil` is returned. Note that many platforms do not provide this information.
+
+In addition, you can use more generic methods to check the type of operating system out of `windows`, `linux`, `mac` and `unix`:
+
+```ruby
+platform.windows?  # => false
+platform.unix?     # => true
+platform.linux?    # => false
+platform.mac?      # => true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/tty-platform/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

data/Rakefile

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

data/lib/tty-platform.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+
+require 'rbconfig'
+require 'tty/platform'

data/lib/tty/platform.rb

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+require 'tty/platform/version'
+
+module TTY
+  # Detects system platform properties
+  #
+  # @api public
+  class Platform
+    WINDOWS_PATTERN = /(cygwin|mswin|mingw|bccwin|wince|emx)/i
+
+    UNIX_PATTERN = /(aix|arch|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+
+    LINUX_PATTERN = /linux|arch/i
+
+    MAC_PATTERN = /darwin/i
+
+    # Returns processor name, e.g. 'amdk6'
+    #
+    # @api public
+    attr_reader :cpu
+
+    # Returns the system/OS name, e.g. 'darwin'
+    #
+    # @api public
+    attr_reader :os
+
+    # Returns system's release version, e.g. '10.8.1'
+    #
+    # @api public
+    attr_reader :version
+
+    # Create platform properties
+    #
+    # @api public
+    def initialize(arch = nil)
+      @cpu, @os, @version = *detect_system_properties(arch)
+    end
+
+    # Add operating system query methods
+    constants.grep(/PATTERN/).each do |pattern|
+      name = pattern.to_s.split('_').first.downcase
+      system_query = :"#{name}?"
+      define_method(system_query) do
+        match_os?(self.class.const_get(pattern))
+      end
+      self.class.class_eval do
+        define_method(system_query) do
+          new.public_send(system_query)
+        end
+      end
+    end
+
+    # Detect if using windows path delimiter
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def windows_file_path?
+      ::File::ALT_SEPARATOR == '\\'
+    end
+
+    # Check if platform matches given systems
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def match_os?(matcher)
+      !!(@os =~ matcher)
+    end
+
+    # Queries for system architecture information
+    #
+    # @return [String]
+    #
+    # @api public
+    def architecture
+      RbConfig::CONFIG['arch']
+    end
+
+    # @return [Array[String]]
+    #
+    # @api public
+    def to_a
+      [@cpu, @os, @version]
+    end
+
+    # String representation
+    #
+    # @api public
+    def to_s
+      to_a.compact.join('-')
+    end
+
+    private
+
+    # Infer system properties from architecture information
+    #
+    # @return [Array[String, String String]]
+    #
+    # @api private
+    def detect_system_properties(arch)
+      parts = (arch || architecture).split('-', 2)
+
+      if parts.length == 1
+        @cpu, system = nil, parts.shift
+      else
+        @cpu, system = *parts
+      end
+      @os, @version = *find_os_and_version(system)
+      [@cpu, @os, @version]
+    end
+
+    # @param [String] system
+    #
+    # @api private
+    def find_os_and_version(system)
+      case system
+      when /aix(\d+(\.\d+)*)?/         then ['aix',       $1]
+      when /bccwin(\d+(\.\d+)*)?/      then ['bccwin',    $1]
+      when /bitrig(\d+(\.\d+)*)?/      then ['bitrig',    $1]
+      when /cygwin/                    then ['cygwin',    nil]
+      when /darwin(\d+(\.\d+)*)?/      then ['darwin',    $1]
+      when /emx/                       then ['emx',       nil]
+      when /freebsd(\d+(\.\d+)*)?/     then ['freebsd',   $1]
+      when /linux(\d+(\.\d+)*)?/       then ['linux',     $1]
+      when /mingw32/                   then ['mingw32',   nil]
+      when /(mswin\d+)((\_|-)(\d+))?/  then [$1,          $4]
+      when /netbsdelf/                 then ['netbsdelf', nil]
+      when /openbsd(\d+(\.\d+)*)?/     then ['openbsd',   $1]
+      when /solaris(\d+(\.\d+)*)?/     then ['solaris',   $1]
+      when /wince(\d+(\.\d+)*)?/       then ['wince',     $1]
+      else ['unknown', nil]
+      end
+    end
+  end # Platform
+end # TTY

data/lib/tty/platform/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  class Platform
+    VERSION = "0.1.0"
+  end # Platform
+end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+if RUBY_VERSION > '1.9' and (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 'tty-platform'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/new_spec.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+RSpec.describe TTY::Platform, '#new' do
+  it "detects system properties" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('i686-darwin8.10.1')
+    platform = TTY::Platform.new
+    expect(platform.cpu).to eq('i686')
+    expect(platform.os).to eq('darwin')
+    expect(platform.version).to eq('8.10.1')
+  end
+
+  {
+    # aix
+    'powerpc-aix7.1'      => ['powerpc',    'aix',       '7.1'],
+    # bitrig
+    'amd64-bitrig1.0'     => ['amd64',      'bitrig',    '1.0'],
+    'armv7-bitrig1.0'     => ['armv7',      'bitrig',    '1.0'],
+    'bitrig1.0'           => [nil,          'bitrig',    '1.0'],
+    # cygwin
+    'i386-cygwin'         => ['i386',       'cygwin',     nil],
+    # darwin
+    'powerpc-darwin7'     => ['powerpc',    'darwin',    '7'],
+    'universal-darwin9'   => ['universal',  'darwin',    '9'],
+    'x86_64-darwin14.0.0' => ['x86_64',     'darwin',    '14.0.0'],
+    'x86_64-darwin'       => ['x86_64',     'darwin',     nil],
+    # freebsd
+    'amd64-freebsd10.1'   => ['amd64',      'freebsd',   '10.1'],
+    'i386-freebsd10.1'    => ['i386',       'freebsd',   '10.1'],
+    'i386-freebsd10'      => ['i386',       'freebsd',   '10'],
+    'i386-freebsd'        => ['i386',       'freebsd',    nil],
+    'universal-freebsd'   => ['universal',  'freebsd',    nil],
+    # linux
+    'powerpc-linux'       => ['powerpc',    'linux',      nil],
+    'i686-linux'          => ['i686',       'linux',      nil],
+    'x86_64-linux'        => ['x86_64',     'linux',      nil],
+    'i386-linux-gnu'      => ['i386',       'linux',      nil],
+    # mswin
+    'i386-mingw32'        => ['i386',       'mingw32',    nil],
+    'mswin32'             => [nil,          'mswin32',    nil],
+    'i386-mswin32'        => ['i386',       'mswin32',    nil],
+    'i386-mswin32_80'     => ['i386',       'mswin32',   '80'],
+    'i386-mswin32-80'     => ['i386',       'mswin32',   '80'],
+    # netbsd
+    'i386-netbsdelf'      => ['i386',       'netbsdelf',  nil],
+    # openbsd
+    'i386-openbsd4.0'     => ['i386',       'openbsd',   '4.0'],
+    'x86_64-openbsd4.0'   => ['x86_64',     'openbsd',   '4.0'],
+    # solaris
+    'sparc-solaris2.10'   => ['sparc',      'solaris',   '2.10'],
+    'i386-solaris2.10'    => ['i386',       'solaris',   '2.10'],
+    # wince
+    'i386-wince7.0'       => ['i386',       'wince',     '7.0'],
+  }.each do |arch, expected|
+    it "detectes #{sprintf("%-22s", "'#{arch}'")} as #{expected}" do
+      platform = TTY::Platform.new(arch)
+      expect(platform.to_a).to eq(expected)
+    end
+  end
+end

data/spec/unit/platform_spec.rb

@@ -0,0 +1,65 @@
+# coding: utf-8
+
+RSpec.describe TTY::Platform, 'platform' do
+  it "correctly detects windows platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86-mswin32_60')
+    platform = TTY::Platform.new
+    expect(platform.windows?).to eq(true)
+  end
+
+  it "fails to detect windows" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('unknown')
+    platform = TTY::Platform.new
+    expect(platform.windows?).to eq(false)
+  end
+
+  it "correctly detects windows platform at class level" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86-mswin32_60')
+    expect(TTY::Platform.windows?).to eq(true)
+  end
+
+  it "correctly detects linux platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-linux')
+    platform = TTY::Platform.new
+    expect(platform.linux?).to eq(true)
+  end
+
+  it "fails to detect linux platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('unknown')
+    platform = TTY::Platform.new
+    expect(platform.linux?).to eq(false)
+  end
+
+  it "correctly detects linux platform at class level" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-linux')
+    expect(TTY::Platform.linux?).to eq(true)
+  end
+
+  it "correctly detects mac platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-darwin')
+    platform = TTY::Platform.new
+    expect(platform.mac?).to eq(true)
+  end
+
+  it "fails to detect mac platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('unknown')
+    platform = TTY::Platform.new
+    expect(platform.mac?).to eq(false)
+  end
+
+  it "correctly detects mac platform at class level" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-darwin')
+    expect(TTY::Platform.mac?).to eq(true)
+  end
+
+  it "correctly detects unix platform" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-darwin')
+    platform = TTY::Platform.new
+    expect(platform.unix?).to eq(true)
+  end
+
+  it "correctly detects unix platform at class level" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('x86_64-darwin')
+    expect(TTY::Platform.unix?).to eq(true)
+  end
+end

data/spec/unit/to_s_spec.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+RSpec.describe TTY::Platform, '.to_s' do
+  it "display platform information" do
+    allow(RbConfig::CONFIG).to receive(:[]).with('arch').and_return('i686-darwin8.10.1')
+    platform = TTY::Platform.new
+    expect(platform.to_s).to eq('i686-darwin-8.10.1')
+  end
+end

data/tasks/console.rake

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

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

data/tty-platform.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-platform"
+  spec.version       = TTY::Platform::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+  spec.summary       = %q{Query methods for detecting different operating systems.}
+  spec.description   = %q{Query methods for detecting different operating systems.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: tty-platform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Query methods for detecting different operating systems.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tty-platform.rb
+- lib/tty/platform.rb
+- lib/tty/platform/version.rb
+- spec/spec_helper.rb
+- spec/unit/new_spec.rb
+- spec/unit/platform_spec.rb
+- spec/unit/to_s_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-platform.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Query methods for detecting different operating systems.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/new_spec.rb
+- spec/unit/platform_spec.rb
+- spec/unit/to_s_spec.rb
+has_rdoc: