junklet 0.9.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzhmYTIyOTAwZDQ0MzM0YTk4ZWUwZjQ3ODBmYjFjNDVmYWE3YzNiNg==
+  data.tar.gz: !binary |-
+    MDJjMjVlZjJmOWQ1NjBiZDU4MzI5ZDUzZjZmNDM2NDNmZTBhNjRlNQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODg2ODhiMmFmNGE2ZDQ2MjI2OTA4NmZhNDhlNDA1MTVhZDU0NTZhZDQzYjBl
+    NzlkNTg1ZDM2NzhmMjBjYjUyMWQ2NWVjNWE1OTIxYjhkYjU4MDQ1MmIwMjk1
+    MTllOWRhMWNiM2UwNzNkOTAwMTZiY2U5NDM3MThmYTZiN2Q3OGU=
+  data.tar.gz: !binary |-
+    YzE0NzVhYzEzM2QyN2ExMjAwMzk3NmVjOTk2NTc5MjhhODIzOTkyMjU3MzUz
+    OGM5MmY4YWQ2NTlhODQwODczZWIwMjUyZDU0NjYwZjJiMWVkN2MxMjRiMzI2
+    YTA0MTM5OTQ2OTQ0NDFiZjY1MDAxYzExMzFhMTZiYzRlZTMwNjc=

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    junklet (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    cucumber (1.3.18)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  cucumber
+  junklet!
+  rake (~> 10.0)
+  rspec (~> 2.0)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 CoverMyMeds
+
+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,138 @@
+# Junklet
+
+Create tiny chunks of unique junk data in RSpec with `junklet :name`.
+
+Junklet data is fixture data that:
+
+* We essentially don't care about,
+* But we might want to test for equality somewhere later,
+* And we might need to be unique between runs in case a spec crashes
+and SQLServer fails to clean up the test database
+
+So,
+
+* We want it to be easy to create junk data fields quickly and easily,
+  and
+* If equality fails we want to be led to the offending field by the
+  error message and not just the line number in the stack trace.
+
+# Background
+
+At CoverMyMeds we have a legacy impingement that prevents us sometimes
+from clearing out data from previous test runs. As a result we often
+have required fields in tests that must be unique but are tested
+elsewhere, so we don't really care about them in the current test
+run. For the current test we just want to stub out that field with
+something unique but we also want to communicate to the developer that
+the contents of the field are not what we currently care about.
+
+Currently we do this with `SecureRandom.uuid`, so we'll see code like
+this frequently in RSpec:
+
+```ruby
+let(:first_name) { SecureRandom.uuid }
+let(:last_name) { SecureRandom.uuid }
+let(:address) { SecureRandom.uuid }
+let(:city) { SecureRandom.uuid }
+let(:state) { SecureRandom.uuid }
+let(:phone) { SecureRandom.uuid }
+```
+
+...etc. Later in the spec we'll often test against those stubs,
+e.g. with `expect(user.first_name).to eq(first_name)` but this idiom
+expresses that we only care about the equality, not the actual
+contents.
+
+Junklet seeks to improve the readability and conciseness of this
+intention. One thing that bugs me about the above approach is that if
+a weird regression bug appears and an unimportant field is the source
+of a crash. So with Junklet I also wanted to add the ability to call
+out the offending field by name. In theory we could just write
+`let(:first_name) { 'first_name-' + SecureRandom.uuid }` but in
+practice that creates duplication in the code and muddies the original
+idiom of "uncared-about" data.
+
+Enter Junklet:
+
+```ruby
+junklet :first_name
+junklet :last_name
+junklet :address
+junklet :city
+junklet :state
+junklet :phone
+```
+
+Or, if you don't want the junklets to sprawl vertically,
+
+```ruby
+junklet :first_name, :last_name, :address, :city, :state, :phone
+```
+
+This will have the same effect as calling `let` on the named fields
+and setting the fieldname and a UUID to be the memoized value.
+
+No, `junklet!` is NOT also included here because it doesn't really
+make sense until and unless we write custom generators.
+
+# TODO
+
+* Formats - The original motivation for Junklet is to encapsulate the
+  SecureRandom.uuid code into something meaningful and
+  intention-revealing. However, it only works for strings with no
+  formatting. If you have a field that DOES have a formatting
+  requirement, then you have to fall back on a real `let`
+  statement. I'd like Junklet to be able to provide common formatters
+  and/or accept formatters for fields with special values or
+  formats. So an email address could look like
+  'email-junkuser@#{uuid}.com', or a currency field could contain a
+  random value from $0.00 to $99,999,999.00 (or some other equally
+  reasonable upper limit). A small signed int could contain -128 to
+  127 and even a boolean could contain a random true/false value. You
+  could argue that this starts to lead towards nondeterministic tests
+  but the reality is the started heading there when we first started
+  making calls to SecureRandom. My thinking is that a call to
+  `junklet` could accept an optional hash and/or block that defines a
+  formatter and/or generator, and/or the configuration for Junklet
+  could accept definitions of domain-specific formatters that you want
+  to reuse throughout your project.
+
+* True cucumber features - RSpec is tested with cucumber features that
+  express blocks of RSpec and then evaluate that the specs did what
+  was intended. The existing spec suite merely uses junklets and then
+  tests their side effects.
+
+* RSpec 3.x support - Ideally the mechanism for adding the `junklet`
+  method is the same, but if not then a separate version would be nice
+  for building and testing RSpec 3 vs. 2. We need to support both, but
+  at the time of this writing the most pressing need is for
+  RSpec 2. Remember kids, "Enterprise" means "most of our money comes
+  from the legacy platform".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'junklet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install junklet
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/junklet/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

data/Rakefile

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

data/junklet.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'junklet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "junklet"
+  spec.version       = Junklet::VERSION
+  spec.authors       = ["Dave Brady"]
+  spec.email         = ["dbrady@covermymeds.com"]
+  spec.summary       = "Easily create junk data for specs"
+  spec.description   = "Works like let and let! for rspec, but creates unique random junk data"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "cucumber"
+end

data/lib/junklet/version.rb

@@ -0,0 +1,3 @@
+module Junklet
+  VERSION = "0.9.0"
+end

data/lib/junklet.rb

@@ -0,0 +1,15 @@
+require "junklet/version"
+
+module RSpec
+  module Core
+    module MemoizedHelpers
+      module ClassMethods
+        def junklet(*args)
+          Array(args).each do |name|
+            let(name) { "#{name}-#{SecureRandom.uuid}" }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/junklet_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Junklet do
+  specify { expect(Junklet).to be }
+
+  let(:regex) { /-[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/ }
+
+  describe '.junklet' do
+    context "with a single arg" do
+      junklet :junk
+      
+      specify { expect(junk).to be }
+      specify { expect(junk).to match /^junk-/ }
+      specify { expect(junk).to match regex }
+      
+      describe "memoization" do
+        specify { expect(junk).to eq(junk) }
+      end
+    end
+
+    context "with multiple args" do
+      junklet :junk, :toss, :crud, :crap
+
+      specify { expect(junk).to match /^junk-/ }
+      specify { expect(junk).to match regex }
+      specify { expect(toss).to match /^toss-/ }
+      specify { expect(toss).to match regex }
+      specify { expect(crud).to match /^crud-/ }
+      specify { expect(crud).to match regex }
+      specify { expect(crap).to match /^crap-/ }
+      specify { expect(crap).to match regex }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# spec_helper.rb
+
+require_relative '../lib/junklet'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: junklet
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Dave Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: Works like let and let! for rspec, but creates unique random junk data
+email:
+- dbrady@covermymeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- junklet.gemspec
+- lib/junklet.rb
+- lib/junklet/version.rb
+- spec/lib/junklet_spec.rb
+- spec/spec_helper.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Easily create junk data for specs
+test_files:
+- spec/lib/junklet_spec.rb
+- spec/spec_helper.rb