wrapio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45094b97507f0d3de37b6722e7c2bb71954b9afb
+  data.tar.gz: 2557f7625b9331e6b7f8086fbed025099c8eaf02
+SHA512:
+  metadata.gz: 758593985bcd6ddb259423f368e5e0a59fe1005d502db4331b63b8444cfa15240b4a2871f73f54f6479df0df30710f156c7634833dc37ddea6531f5320e01225
+  data.tar.gz: eaf37351a2d1d954bd6b81c1d32e5d8060c3d8c917aadac0c541b3a4afd6a5c068fa880eca5b3b835a5444a0a3cfc9e84adf7aca1184849f238f997ad72c3837

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*todo*
+*TODO*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wrapio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Scavello
+
+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,116 @@
+# WrapIO
+
+Allows the faking of input to STDIN and capturing of output from STDOUT with semantic method names. Great for testing!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrapio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wrapio
+
+## Usage
+
+### WrapIO
+#### Captures output from STDOUT
+
+```ruby
+# wrapio_test.rb
+
+output = WrapIO.of do
+	puts "Hello World!"
+end
+
+puts output
+```
+
+```
+$ ruby wrapio_test.rb
+
+"Hello World!"
+```
+
+#### Enable debug to see the faked STDIN
+
+```ruby
+# wrapio_test.rb
+
+WrapIO.debug = true
+output = WrapIO.of('input') do
+	gets
+	puts 'output'
+end
+```
+
+```
+$ ruby wrapio_test.rb
+
+-- WrapIO Capture#output  --
+-- WrapIO Fake#gets 1 --
+input
+________________________
+output
+
+____________________________
+```
+
+### Or use the internal module classes separately
+
+#### WrapIO::Fake
+
+```ruby
+# fake_test.rb
+
+WrapIO::Fake.input('Hello!') do
+	input = gets
+end
+puts input
+```
+
+```
+$ ruby fake_test.rb
+
+"Hello!"
+```
+
+#### WrapIO::Capture
+
+```ruby
+# capture_test.rb
+
+output = WrapIO::Capture.output do
+	print "Hi!"
+end
+puts output
+```
+
+```
+$ ruby capture_test.rb
+
+"Hi!"
+```
+
+## 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/BideoWego/wrapio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/wrapio.rb"
+
+WrapIO.debug = true
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wrapio.rb

@@ -0,0 +1,108 @@
+require_relative 'wrapio/version.rb'
+require_relative 'wrapio/capture.rb'
+require_relative 'wrapio/fake.rb'
+
+##
+# A small module that allows performs both
+# capturing output from STDOUT
+# and faking input to STDIN.
+
+module WrapIO
+
+	##
+	# @!attribute debug
+	# @return [Boolean] +true+ if debugging is enabled
+
+	@@debug = false
+
+	##
+	# Internal markers for debug logging
+
+	@@delimiters = {
+		:input => 'Fake#gets',
+		:output => 'Capture#output'
+	} 
+
+	##
+	# @!attribute default_input
+	# @return [String, Array] the default input if not specified in +WrapIO#of+
+
+	@@default_input = ''
+
+	##
+	# @return [Boolean] +true+ if debugging is enabled
+
+	def self.debug
+		@@debug
+	end
+
+	##
+	# Enable or disables debugging
+	# @param value [Boolean] +true+ if debugging is enabled
+
+	def self.debug=(value)
+		@@debug = value
+	end
+
+	##
+	# @return [String, Array] the default input if not specified in +WrapIO#of+
+
+	def self.default_input
+		@@default_input
+	end
+
+	##
+	# Set the default input if not specified in +WrapIO#of+
+	# @param value [String, Array] the default input if not specified in +WrapIO#of+
+
+	def self.default_input=(value)
+		@@default_input = value
+	end
+
+	##
+	# The main action of the +WrapIO+ module
+	# As the semantic reading of the module name and function implies.
+	# It wraps the input and output of the given block, making the input
+	# passable as a parameter and the output accessible as a return value.
+	#
+	# @param input [String, Array<String>] the input or array of inputs
+	# @yield the block of code from which to wrap I/O
+	# @return [String] the captured output from STDOUT
+
+	def self.of(input=nil)
+		input = WrapIO.default_input.map{|i| i.to_s.dup} unless input
+		Capture.output do
+			Fake.input(input) do
+				yield
+			end
+		end
+	end
+
+	##
+	# Used within module classes to output debug data
+	#
+	# @param data [String] the string to output
+	# @param type [Symbol] the type of data e.g. +:input+ or +:output+
+	# @param index [Integer] optionally provide an index of the data
+
+	def self.log(data, type, index=nil)
+		puts delimit(data, type, index.to_s)
+	end
+
+	private
+
+		##
+		# Used internally to mark beginnings and endings of debug logging sections
+		#
+		# @param data [String] the string to delimit
+		# @param type [Symbol] the type of data
+		# @param index [Index] a the index of the data
+
+		def self.delimit(data, type, index)
+			delimitation = "-- WrapIO %T% %I% --"
+			b = delimitation.gsub(/%T%/, @@delimiters[type]).gsub(/%I%/, index)
+			c = data
+			e = '_' * b.length
+			[b, c, e].join("\n")
+		end
+end

data/lib/wrapio/capture.rb

@@ -0,0 +1,25 @@
+module WrapIO
+
+	##
+	# A small class built to capture the output from STDOUT.
+
+	class Capture
+
+		##
+		# Captures the output of +$stdout+.
+		# Temporarily swaps +$stdout+ with an instance of the +StringIO+ class.
+		# 
+		# @yield the block of code from which to capture output
+
+		def self.output
+			begin
+				$stdout = captor = StringIO.new
+				yield
+			ensure
+				$stdout = STDOUT
+			end
+			WrapIO.log(captor.string, :output) if WrapIO.debug
+			captor.string
+		end
+	end
+end

data/lib/wrapio/fake.rb

@@ -0,0 +1,60 @@
+module WrapIO
+	
+	##
+	# Enables faking of input to STDIN
+
+	class Fake
+
+		##
+		# Used interally to store the given input data
+
+		@data = nil
+
+		##
+		# @note Do not create instances of the +WrapIO::Fake+ class. Instead call +WrapIO::Fake#input+ to fake input to STDIN
+		# @param input [String, Array<String>] the input
+
+		def initialize(input)
+			@data = input
+			@length = input.length
+		end
+
+		##
+		# Provides a proxy for +STDIN#gets+.
+		# When the instance of +$stdin+ is swapped in +WrapIO::Fake#input+
+		# this method with be called instead of the usual +STDIN#gets+.
+		# Allowing injection of faked input.
+		#
+		# This function destructively iterates through the +@data+
+		# array injecting the next value into +$stdin+. Once all indexes
+		# in the given data are sent to +$stdin+, all subsequent calls to +gets+
+		# will receive an empty string.
+
+		def gets
+			next_input = @data.shift
+			index = @length - @data.length
+			WrapIO.log(next_input, :input, index) if WrapIO.debug
+			next_input.to_s
+		end
+
+		##
+		# This is the main action of the +WrapIO::Fake+ class.
+		# It passes the given input to +$stdin+.
+		# Pass a single string or an array of strings to it and
+		# each time +gets+ is called, a string from that array with be passed
+		# to +$stdin+ starting from index 0 and moving to the end.
+		#
+		# @param value [String, Array<String>] the value of the faked input(s)
+		# @yield the block of code to which you want to pass the given input(s)
+
+		def self.input(value=nil)
+			value = [value] unless value.is_a?(Array)
+			begin
+				$stdin = new(value)
+				yield
+			ensure
+				$stdin = STDIN
+			end
+		end
+	end
+end

data/lib/wrapio/version.rb

@@ -0,0 +1,7 @@
+module WrapIO
+
+	##
+	# The curent version
+
+	VERSION = "0.0.1"
+end

data/wrapio.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wrapio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wrapio"
+  spec.version       = WrapIO::VERSION
+  spec.authors       = ["Chris Scavello"]
+  spec.email         = ["bideowego@gmail.com"]
+
+  spec.summary       = %q{Allows the faking of input to STDIN and capturing of output from STDOUT with semantic method names. Great for testing!}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/BideoWego/wrapio"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: wrapio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Scavello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bideowego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wrapio.rb
+- lib/wrapio/capture.rb
+- lib/wrapio/fake.rb
+- lib/wrapio/version.rb
+- wrapio.gemspec
+homepage: https://github.com/BideoWego/wrapio
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Allows the faking of input to STDIN and capturing of output from STDOUT with
+  semantic method names. Great for testing!
+test_files: []
+has_rdoc: