mockable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afbee1549c1de88e86e03d98455b6f6d2146bc83
+  data.tar.gz: 569ecd8beb60e08734112444706ac7f07f4f6c90
+SHA512:
+  metadata.gz: 9c4047f6a28e7c4a6a9e6971c5d91728476987deeef710023af364227dfae5e1ffb4d91e6d1d98df0fe87282e812c4ed379115140298ba939f9821ead96f4e39
+  data.tar.gz: 920a4e3aca4191011b2328cc2a28118360fb5c5b0f4bcbea401b16828d71ae166b8339396399cd79afcfc94a3ceb41c34ae816c467c08e6925b33aece79bf733

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*~

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+mockable

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dennis Walters
+
+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,99 @@
+# Mockable #
+
+Mockable is a quick and dirty interface that lets you know if your user wants
+you to use mocked interfaces and such.
+
+## WHY?!?!?!?! ##
+
+Well, because I write a lot of API clients and such, and then I end up using
+them in my apps. When I run tests against those apps, I find it easiest if
+the library itself provides a transparent mocked interface.
+
+I prefer to decide if mocking is desired by checking an environment variable,
+because I write a lot of my app-level tests in languages other than Go. As
+I do this sort of thing quite a lot, occasionallly needing to enable mocking
+for several clients at once, it finally made sense to just go ahead and
+formalize the process and use a uniform environment variable, MOCKABLE,
+for everything.
+
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mockable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mockable
+
+## Usage ##
+
+Here's a quasi-real-world example. Let's say your library generates widgets.
+Now, in production, you really want to make good, real, quality widgets. Under
+test, though, the app that uses your widget generator may just need to ensure
+that a widget gets generated. Here's how I like to handle that:
+
+```ruby
+require 'mockable'
+
+module Factory
+  Widget = Struct.new(:name)
+
+  class Generator
+    def generate(name)
+    end
+  end
+
+  class Real < Generator
+    def generate(name)
+      # do a bunch of stuff that hits the real widget service out there in space
+      # ...
+
+      generated_widget
+    end
+  end
+
+  class Fake < Generator
+    def generate(name)
+      Widget.new(name)
+    end
+  end
+
+  def self.generator
+    Mockable.mocked? ? Fake : Real).new
+  end
+end
+```
+
+Now, when the above is used and `Factory.generator` is called, a fake
+generator is returned if mocking is enabled (by setting the `MOCKABLE`
+environment variable to pretty much anything), but a real generator otherwise.
+
+## Development ##
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+***NOTE: This project uses git-flow. Please base your feature branches off of the develop branch.***
+
+1. Fork it ( https://github.com/ess/mockable/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
+
+
+
+## History ##
+
+* 0.1.0 - Initial port from Go

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

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

data/lib/mockable.rb

@@ -0,0 +1,18 @@
+require "mockable/version"
+
+module Mockable
+  VARNAME = 'MOCKABLE'
+
+  def self.mocked?
+    ENV[VARNAME] ? true : false
+  end
+
+  def self.enable
+    ENV[VARNAME] = '1' unless mocked?
+  end
+
+  def self.disable
+    ENV.delete(VARNAME) if mocked?
+  end
+
+end

data/mockable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mockable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mockable"
+  spec.version       = Mockable::VERSION
+  spec.authors       = ["Dennis Walters"]
+  spec.email         = ["dwalters@engineyard.com"]
+
+  spec.summary       = %q{Declare your intention to mock}
+  spec.homepage      = "https://github.com/ess/mockable-ruby"
+  spec.license       = "MIT"
+
+  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.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mockable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: 
+email:
+- dwalters@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mockable.rb
+- lib/mockable/version.rb
+- mockable.gemspec
+homepage: https://github.com/ess/mockable-ruby
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Declare your intention to mock
+test_files: []