bsd_wtf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66b00e46d1389bd3f2f42f2af708d2f9eaa27073
+  data.tar.gz: 8fd19b20e5d56548b3219aaf880543e930691d9b
+SHA512:
+  metadata.gz: 97889ae5784601b6c925b05530770ddd82433dc0dd76dd59f3f249a5ff0662d4f51bb81cd50a4a2dfe51e45530dfd28bc59ef4de8c005dfd301e6b84fc0667c1
+  data.tar.gz: 29a4b7c007f2c6cb30a78e71ea335b1a0e12151430fe61066e68cd486fcbad237cd053ea3a06b181f17e11a26d30d8314f941eaa1f323e01d26f40fe82b7b4e8

data/.gitignore

@@ -0,0 +1,87 @@
+### https://raw.github.com/github/gitignore/ea2aa40cb4620e334a87e8494e03d0e7d1ec11df/Ruby.gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/.rspec_status
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### https://raw.github.com/github/gitignore/ea2aa40cb4620e334a87e8494e03d0e7d1ec11df/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### https://raw.github.com/github/gitignore/ea2aa40cb4620e334a87e8494e03d0e7d1ec11df/Global/Vim.gitignore
+
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.16.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 steve.huff@runkeeper.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"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "json", "~> 2"
+gem "whiches", "~> 0"
+
+group :development do
+  gem "irbtools", "~> 2"
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    binding.repl (3.0.0)
+    cd (1.0.1)
+    clipboard (1.1.1)
+    code (0.9.2)
+      coderay (~> 1.1)
+      method_source (~> 0.9)
+    coderay (1.1.2)
+    debugging (1.1.1)
+      binding.repl (~> 3.0)
+      paint (>= 0.9, < 3.0)
+    diff-lcs (1.3)
+    every_day_irb (2.0.0)
+      cd (~> 1.0)
+    fancy_irb (1.1.0)
+      paint (>= 0.9, < 3.0)
+      unicode-display_width (~> 1.1)
+    ffi (1.9.18)
+    hirb (0.7.3)
+    instance (0.2.0)
+    interactive_editor (0.0.11)
+      spoon (>= 0.0.1)
+    irbtools (2.2.0)
+      binding.repl (~> 3.0)
+      clipboard (~> 1.1)
+      code (~> 0.9)
+      coderay (~> 1.1)
+      debugging (~> 1.1)
+      every_day_irb (~> 2.0)
+      fancy_irb (~> 1.1)
+      hirb (~> 0.7, >= 0.7.3)
+      instance (~> 0.2)
+      interactive_editor (~> 0.0, >= 0.0.10)
+      method_locator (~> 0.0, >= 0.0.4)
+      methodfinder (~> 2.0)
+      ori (~> 0.1.0)
+      os (~> 1.0)
+      paint (>= 0.9, < 3.0)
+      ruby_engine (~> 1.0)
+      ruby_info (~> 1.0)
+      ruby_version (~> 1.0)
+      wirb (~> 2.0)
+    json (2.1.0)
+    method_locator (0.0.4)
+    method_source (0.9.0)
+    methodfinder (2.1.1)
+    ori (0.1.0)
+    os (1.0.0)
+    paint (2.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_engine (1.0.1)
+    ruby_info (1.0.1)
+    ruby_version (1.0.1)
+    spoon (0.0.6)
+      ffi
+    unicode-display_width (1.3.0)
+    whiches (0.0.2)
+      awesome_print
+    wirb (2.1.2)
+      paint (>= 0.9, < 3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  irbtools (~> 2)
+  json (~> 2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  whiches (~> 0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steve Huff
+
+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,49 @@
+# BsdWtf
+
+This gem wraps the [BSD wtf](https://www.freebsd.org/cgi/man.cgi?query=wtf&manpath=NetBSD+7.1) command in a Ruby interface.
+
+The `wtf` executable must already be present on this system and located in `$PATH`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bsd_wtf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bsd_wtf
+
+## Usage
+
+```ruby
+$ irb -r bsd_wtf
+irb(main):001:0> BsdWtf.wtf("wtf")
+=> {:success=>[{:acronym=>"WTF", :definition=>"where's the food"}], :failure=>[]}
+irb(main):002:0> BsdWtf.wtf(["wtf","lolwut"]).to_json
+=> "{\"success\":[{\"acronym\":\"WTF\",\"definition\":\"where's the food\"}],\"failure\":[\"lolwut\"]}"
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hakamadare/rubygem-bsd_wtf. 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 BsdWtf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hakamadare/rubygem-bsd_wtf/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bsd_wtf/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bsd_wtf"
+  spec.version       = BsdWtf::VERSION
+  spec.authors       = ["Steve Huff"]
+  spec.email         = ["shuff@vecna.org"]
+
+  spec.summary       = %q{Wrap the `wtf` command}
+  spec.description   = %q{Capture the output of the BSD `wtf` command}
+  spec.homepage      = "https://github.com/hakamadare/rubygem-bsd_wtf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "json", "~> 2"
+  spec.add_dependency "whiches", "~> 0"
+end

data/lib/bsd_wtf.rb

@@ -0,0 +1,55 @@
+require "bsd_wtf/version"
+require "open3"
+require "whiches"
+require "json"
+
+module BsdWtf
+  def self.wtf(acronyms = [])
+    _do_wtf(_get_wtf, acronyms)
+  end
+
+  private
+
+  def self._do_wtf(wtf=_get_wtf, acronyms=[])
+    wtf_cmd = wtf + ' ' + Array(acronyms).join(' ')
+
+    stdout_str, stderr_str, status = Open3.capture3(wtf_cmd)
+
+    if status.success?
+      _process_wtf(stdout_str)
+    else
+      raise StandardError.new(stderr_str.chomp)
+    end
+  end
+
+  def self._get_wtf
+    results = Whiches.whiches("wtf")
+
+    if results
+      results[0]
+    else
+      raise StandardError.new("unable to find 'wtf' in path")
+    end
+  end
+
+  def self._process_wtf(raw='')
+    result = {
+      :success => [],
+      :failure => [],
+    }
+
+    raw.chomp.split("\n").each do |line|
+      acronym, definition = line.split(':', 2)
+
+      /nothing appropriate/ =~ definition
+
+      if Regexp.last_match.nil?
+        result[:success].push({:acronym => acronym, :definition => definition.strip})
+      else
+        result[:failure].push(acronym)
+      end
+    end
+
+    result
+  end
+end

data/lib/bsd_wtf/version.rb

@@ -0,0 +1,3 @@
+module BsdWtf
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: bsd_wtf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Huff
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-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'
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: whiches
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capture the output of the BSD `wtf` command
+email:
+- shuff@vecna.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bsd_wtf.gemspec
+- lib/bsd_wtf.rb
+- lib/bsd_wtf/version.rb
+homepage: https://github.com/hakamadare/rubygem-bsd_wtf
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Wrap the `wtf` command
+test_files: []