tout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dd26fe372240267e97718a8a6a66279c2482b37
+  data.tar.gz: 5d7e155fef8dd2893d7dc416a3b77abf1fd33bbf
+SHA512:
+  metadata.gz: eabb2f6f7701f576a80f12ff119df5af728a8d4ba3e36cbb3af94e8820b0eb643caa1e80e68d2d51e5dbff65a75562bceb5f245a506c8b44d6b53dc33de0c5eb
+  data.tar.gz: 9a253fac5991eb8bbc3adf58e7adb735606b4b45f61c116329e39a51dd04909bd7f7aa012a27481ba13b900fc2ab390afee2468743b0e84879ab5e5baff80f28

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron Gough
+
+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,68 @@
+# Tout
+
+Tout is a small helper for altering the visibility of methods while testing them. This allows classes to be structured with normal public/private methods while still maintaining full test coverage.
+
+Tout allows a private method to be made public only for the duration of the test group, it sets the method back to private at the end of the example group to avoid any possible side effects.
+
+## Usage
+
+Tout allows the easy and safe testing of private methods via the `publicize` helper like so:
+
+```ruby
+publicize(class, :method_name)
+```
+
+Here it is in use in a small test suite:
+
+```ruby
+class NormalClass
+  def public_foo
+    "public"
+  end
+
+  private
+
+  def private_foo
+    "private"
+  end
+end
+
+describe NormalClass do
+  describe "#private_foo"
+    publicize(described_class, :private_foo)
+
+    it "returns 'private'" do
+      expect(described_class.private_foo).to eq("private")
+    end
+  end  
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tout
+
+After the gem is installed setup Tout in your RSpec config like so:
+
+```ruby
+RSpec.configure do |config|
+  config.extend(Tout)
+end
+```
+
+## 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/lib/tout.rb

@@ -0,0 +1,19 @@
+require "tout/version"
+
+module Tout
+  def publicize(klass, method)
+    method_already_public = klass.method_defined?(method)
+    private_method_defined = klass.private_method_defined?(method)
+
+    before(:each) do
+      raise "Cannot publicize #{klass.name}##{method} as it is already public." if method_already_public
+      raise "Cannot publicize #{klass.name}##{method} no private method by that name exists." unless private_method_defined
+
+      klass.send(:public, method) if private_method_defined && !method_already_public
+    end
+
+    after(:each) do
+      klass.send(:private, method) if private_method_defined && !method_already_public
+    end
+  end
+end

data/lib/tout/version.rb

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

data/tout.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tout"
+  spec.version       = Tout::VERSION
+  spec.authors       = ["Aaron Gough"]
+  spec.email         = ["aaron@aarongough.com"]
+
+  spec.summary       = %q{Allow the easy testing of private methods.}
+  spec.description   = %q{Allow the easy testing of private methods.}
+  spec.homepage      = "https://github.com/aarongough/tout"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: tout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Gough
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Allow the easy testing of private methods.
+email:
+- aaron@aarongough.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tout.rb
+- lib/tout/version.rb
+- tout.gemspec
+homepage: https://github.com/aarongough/tout
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Allow the easy testing of private methods.
+test_files: []