rspec-varys 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1ee4c82227c770124d98e6ea57320b37e2dbceb
+  data.tar.gz: bc60a41dc4f3ea42206f83a601170c20cc98cfae
+SHA512:
+  metadata.gz: 2609cf4e8e4b3f70bb97beb03a602bbee9ea7c7785f5bb65c6b4585cf9759da9cb1183b4210ee0ef2a317761d7b69b7f30c280a3c62dd6d29464fb02396d2fd0
+  data.tar.gz: 8ffd607d581171121703f2090f6870e2efb5a323f02260e2ceb86203edf052defe274d38e9150eb644ca1a2e48596e80e864943913c547cd39cb4bcfb8e80b43

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.6.2)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    bond (0.5.1)
+    builder (3.2.2)
+    childprocess (0.5.5)
+      ffi (~> 1.0, >= 1.0.11)
+    clipboard (1.0.5)
+    coderay (1.1.0)
+    cucumber (1.3.15)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    debug_inspector (0.0.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.6)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    interception (0.5)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-clipboard (0.1.1)
+      clipboard
+      pry
+    pry-rescue (1.4.1)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.1)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bond
+  cucumber
+  pry
+  pry-clipboard
+  pry-rescue
+  pry-stack_explorer
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ritchie Young
+
+MIT License
+
+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,31 @@
+# Rspec::Varys
+
+Generate RSpec specs from intelligence gathered from doubles and spies.
+
+This is an experiment to see if a top-down TDD work-flow can be improved by partially automating the creation of lower level specs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-varys'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-varys
+
+## Usage
+
+See the [Cucumber features](https://relishapp.com/spechero/rspec-varys/docs) for examples of intended usage.
+
+## Contributing
+
+1. Fork it ( https://github.com/ritchiey/rspec-varys/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/features/generating_specs.feature

@@ -0,0 +1,209 @@
+Feature: Generating an RSpec Spec from an RSpec Expectation
+
+  Background:
+    Given a file named "spec_helper.rb" with:
+    """ruby
+    $:.unshift File.expand_path('../../lib', File.dirname(__FILE__))
+
+    require "rspec/varys"
+
+    RSpec.configure do |config|
+
+      config.include RSpec::Varys::DSL
+
+      config.before(:suite) do
+        RSpec::Varys.reset
+      end
+
+      config.after(:suite) do
+        RSpec::Varys.print_report
+      end
+    end
+    """
+
+
+  Scenario: For a single unmatched expectation
+    Given a file named "top_level_spec.rb" with:
+    """ruby
+    require_relative 'spec_helper'
+    require_relative 'person'
+
+    describe "First day at work" do
+
+      it "starts with an introduction" do
+        boss = Person.new('Dick', 'Jones')
+        expect(boss).to receive(:full_name).and_return("Dick Jones")
+        expect(boss.welcome).to eq "Welcome to OCP, I'm Dick Jones"
+      end
+
+    end
+    """
+    And a file named "person.rb" with:
+    """ruby
+    class Person
+
+      def initialize(firstname, lastname)
+      end
+
+      def welcome
+        "Welcome to OCP, I'm #{full_name}"
+      end
+
+    end
+    """
+
+    When I run `rspec top_level_spec.rb`
+    Then it should pass with:
+    """
+    Specs have been generated based on mocks you aren't currently testing.
+    """
+    And the file "generated_specs/person_spec.rb" should contain:
+    """
+    describe Person do
+
+      describe "#full_name" do
+
+        it "returns the correct value" do
+          confirm(subject).can receive(:full_name).and_return("Dick Jones")
+          instance = described_class.new
+          expect(instance.full_name).to eq("Dick Jones")
+        end
+
+      end
+
+    end
+    """
+
+
+  Scenario: For two unmatched expectations on the same class
+    Given a file named "top_level_spec.rb" with:
+    """ruby
+    require_relative 'spec_helper'
+    require_relative 'person'
+
+    describe "First day at work" do
+
+      it "starts with an introduction" do
+        boss = Person.new('Dick', 'Jones')
+        expect(boss).to receive(:full_name).and_return("Dick Jones")
+        expect(boss).to receive(:title).and_return("Vice President")
+        expect(boss.welcome).to eq "Welcome to OCP, I'm Vice President Dick Jones"
+      end
+
+    end
+    """
+    And a file named "person.rb" with:
+    """ruby
+    class Person
+
+      def initialize(firstname, lastname)
+      end
+
+      def welcome
+        "Welcome to OCP, I'm #{title} #{full_name}"
+      end
+
+    end
+    """
+
+    When I run `rspec top_level_spec.rb`
+    Then it should pass with:
+    """
+    Specs have been generated based on mocks you aren't currently testing.
+    """
+    And the file "generated_specs/person_spec.rb" should contain:
+    """
+    describe Person do
+
+      describe "#title" do
+
+        it "returns the correct value" do
+          confirm(subject).can receive(:title).and_return("Vice President")
+          instance = described_class.new
+          expect(instance.title).to eq("Vice President")
+        end
+
+      end
+
+      describe "#full_name" do
+
+        it "returns the correct value" do
+          confirm(subject).can receive(:full_name).and_return("Dick Jones")
+          instance = described_class.new
+          expect(instance.full_name).to eq("Dick Jones")
+        end
+
+      end
+
+    end
+    """
+
+  Scenario: For one matched and one unmatched expectation
+    Given a file named "top_level_spec.rb" with:
+    """ruby
+    require_relative 'spec_helper'
+    require_relative 'person'
+
+    describe "First day at work" do
+
+      it "starts with an introduction" do
+        boss = Person.new('Dick', 'Jones')
+        expect(boss).to receive(:full_name).and_return("Dick Jones")
+        expect(boss).to receive(:title).and_return("Vice President")
+        expect(boss.welcome).to eq "Welcome to OCP, I'm Vice President Dick Jones"
+      end
+
+    end
+
+    describe Person do
+
+      subject { described_class.new('Dick', 'Jones') }
+
+      describe "#full_name" do
+
+        it "returns the correct value" do
+          confirm(subject).can receive(:full_name).and_return("Dick Jones")
+          # ...
+        end
+
+      end
+
+    end
+
+    """
+    And a file named "person.rb" with:
+    """ruby
+    class Person
+
+      def initialize(firstname, lastname)
+      end
+
+      def welcome
+        "Welcome to OCP, I'm #{title} #{full_name}"
+      end
+
+    end
+    """
+
+    When I run `rspec top_level_spec.rb`
+    Then it should pass with:
+    """
+    Specs have been generated based on mocks you aren't currently testing.
+    """
+    And the file "generated_specs/person_spec.rb" should contain:
+    """
+    describe Person do
+
+      describe "#title" do
+
+        it "returns the correct value" do
+          confirm(subject).can receive(:title).and_return("Vice President")
+          instance = described_class.new
+          expect(instance.title).to eq("Vice President")
+        end
+
+      end
+
+    end
+    """
+

data/features/readme.md

@@ -0,0 +1,10 @@
+*Everything should be built top-down, except the first time - Alan
+Perlis*
+
+RSpec-Varys automatically generates RSpec specs from your mocked methods each time your suite is run.
+
+This enables you to build your program from the top-down (or outside-in if
+your prefer) without having to manually keep track of which mocks have
+been validated.
+
+Available on [Github](https://github.com/ritchiey/rspec-varys)

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/rspec/varys/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Varys
+    VERSION = "0.0.1"
+  end
+end

data/lib/rspec/varys.rb

@@ -0,0 +1,155 @@
+require "rspec/varys/version"
+require "fileutils"
+
+module RSpec
+  module Varys
+    module DSL
+
+      def confirm(object)
+        Confirmation.new(object)
+      end
+
+      class Confirmation
+
+        def initialize(object)
+          @object = object
+        end
+
+        def can(ability)
+          @ability = ability
+          RSpec::Varys.confirmed_messages << to_expectation
+        end
+
+        private
+
+        def to_expectation
+          {
+            class_name: class_name,
+            message: message,
+            args: [],
+            return_value: "Dick Jones"
+          }
+        end
+
+        def class_name
+          @object.class.name
+        end
+
+        def message
+          @ability.instance_variable_get('@message')
+        end
+
+      end
+    end
+  end
+end
+
+
+class RSpec::Mocks::Proxy
+
+  alias_method :old_message_received, :message_received
+
+  def message_received(message, *args, &block)
+    old_message_received(message, *args, &block).tap do |return_value|
+      RSpec::Varys.record object, message, args, block, return_value
+    end
+  end
+
+end
+
+
+module RSpec::Varys
+
+  def self.confirmed_messages
+    @confirmed_messages
+  end
+
+  def self.recorded_messages
+    @recorded_messages
+  end
+
+  def self.generated_specs
+    @generated_specs ||= generate_specs
+  end
+
+  def self.reset
+    @recorded_messages = []
+    @generated_specs = nil
+    @confirmed_messages = []
+  end
+
+  def self.record(object, message, args, block, return_value)
+    @recorded_messages << {
+      class_name: object.class.name,
+      message: message,
+      args: args,
+      return_value: return_value
+    }
+  end
+
+  def self.generate_specs
+    {}.tap do |generated_specs|
+      unconfirmed_messages.each do |s|
+        generated_specs[s[:class_name]] ||= []
+        generated_specs[s[:class_name]] << generate_spec(s)
+      end
+    end
+  end
+
+
+  def self.generate_spec(s)
+    <<-GENERATED
+  describe "##{s[:message]}" do
+
+    it "returns the correct value" do
+      confirm(subject).can receive(:#{s[:message]}).and_return(#{serialize s[:return_value]})
+      instance = described_class.new
+      expect(instance.#{s[:message]}).to eq(#{serialize s[:return_value]})
+    end
+
+  end
+
+    GENERATED
+  end
+
+  def self.print_report
+    dest_path = "generated_specs"
+    FileUtils.mkdir_p dest_path
+    generated_specs.each do |class_name, specs|
+      File.open("#{dest_path}/#{underscore class_name}_spec.rb", 'w') do |file|
+        file.write "describe #{class_name} do\n\n"
+        specs.each do |spec|
+          file.write(spec)
+        end
+        file.write "end"
+      end
+    end
+    puts "Specs have been generated based on mocks you aren't currently testing."
+  end
+
+  def self.unconfirmed_messages
+    recorded_messages - confirmed_messages
+  end
+
+  def self.underscore(camel_cased_word)
+    camel_cased_word.downcase
+  end
+
+  # Attempt to recreate the source-code to represent this argument in the setup
+  # for our generated spec.
+  def self.serialize(arg)
+    if %w(Array Hash Float Fixnum String).include? arg.class.name
+      arg.pretty_inspect.chop
+    else
+      guess_constructor arg
+    end
+  end
+
+  # Don't recognise the type so we don't know how to recreate it
+  # in source code. So we'll take a guess at what might work and
+  # let the user fix it up if necessary.
+  def self.guess_constructor(arg)
+    "#{arg.class.name}.new(#{serialize(arg.to_s)})"
+  end
+end
+

data/rspec-varys.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/varys/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-varys"
+  spec.version       = Rspec::Varys::VERSION
+  spec.authors       = ["Ritchie Young"]
+  spec.email         = ["ritchiey@gmail.com"]
+  spec.summary       = %q{Generate RSpec specs from intelligence gathered from doubles and spies.}
+  spec.description   = %q{Automatically track which assumptions you've made in the form or mocks and stubs actually work.}
+  spec.homepage      = "https://github.com/ritchiey/rspec-varys"
+  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.6"
+  spec.add_development_dependency "rake", '~> 10.4', ">= 10.4"
+  spec.add_development_dependency "rspec", '~> 3.1', ">= 3.1.0"
+  spec.add_development_dependency "cucumber", '~> 1.3', ">= 1.3.15"
+  spec.add_development_dependency "aruba", '~> 0.6', '>= 0.6.2'
+end

data/spec/rspec/varys_spec.rb

@@ -0,0 +1,113 @@
+require 'rspec'
+require 'rspec/varys'
+require 'pry'
+
+  class Person
+
+    def initialize(firstname, lastname)
+
+    end
+
+    def welcome
+      "Welcome to OCP, I'm #{full_name}"
+    end
+
+  end
+
+describe RSpec::Varys do
+
+  describe ".unconfirmed_messages" do
+
+    it "returns the messages that don't already have specs" do
+      expect(described_class).to receive(:confirmed_messages).and_return([
+        { class_name: 'Person', message: :full_name, args: [], return_value: "Dick Jones" }
+      ])
+      expect(described_class).to receive(:recorded_messages).and_return([
+        {:class_name=>"Person", :message=>:full_name, :args=>[], :return_value=>"Dick Jones"},
+        { class_name: 'Object', message: :a_message, args: [:a_parameter], return_value: 42 }
+      ])
+      expect(described_class.unconfirmed_messages).to match_array([
+        { class_name: 'Object', message: :a_message, args: [:a_parameter], return_value: 42 }
+      ])
+    end
+  end
+
+  describe ".confirmed_messages" do
+
+    include RSpec::Varys::DSL
+
+    it "returns a list of expectations that have been satisfied" do
+      confirm(Person.new 'Dick', 'Jones').can receive(:full_name).and_return("Dick Jones")
+      expect(described_class.confirmed_messages).to match_array([{
+      class_name: 'Person',
+      message: :full_name,
+      args: [],
+      return_value: "Dick Jones"
+    }])
+    end
+
+  end
+
+  it "records the messages sent to a spy" do
+    described_class.reset
+
+    o = Object.new
+    expect(o).to receive(:a_message).with(:a_parameter).and_return(42)
+    o.a_message(:a_parameter)
+
+    expect(described_class.recorded_messages).to match_array([{
+      class_name: 'Object',
+      message: :a_message,
+      args: [:a_parameter],
+      return_value: 42
+    }])
+  end
+
+
+  context "given the test-suite calls a mocked method" do
+
+    let(:expected_spec) do
+<<GENERATED
+  describe "#full_name" do
+
+    it "returns the correct value" do
+      confirm(subject).can receive(:full_name).and_return("Dick Jones")
+      instance = described_class.new
+      expect(instance.full_name).to eq("Dick Jones")
+    end
+
+  end
+
+GENERATED
+    end
+
+    before do
+      described_class.reset
+
+      dick = Person.new('Dick', 'Jones')
+      expect(dick).to receive(:full_name).and_return("Dick Jones")
+      expect(dick.welcome).to eq "Welcome to OCP, I'm Dick Jones"
+    end
+
+    it "can generate required specs" do
+      # did it correctly record the method called
+      expect(described_class.recorded_messages).to match_array(
+        [
+          {
+            class_name: 'Person',
+            message: :full_name,
+            args: [],
+            return_value: "Dick Jones"
+          }
+        ]
+      )
+
+      # did it generate an in-memory version of the specs?
+      expect(described_class.generated_specs).to eq('Person' => [ expected_spec ])
+
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rspec-varys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ritchie Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.15
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Automatically track which assumptions you've made in the form or mocks
+  and stubs actually work.
+email:
+- ritchiey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/generating_specs.feature
+- features/readme.md
+- features/support/env.rb
+- lib/rspec/varys.rb
+- lib/rspec/varys/version.rb
+- rspec-varys.gemspec
+- spec/rspec/varys_spec.rb
+homepage: https://github.com/ritchiey/rspec-varys
+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.2
+signing_key: 
+specification_version: 4
+summary: Generate RSpec specs from intelligence gathered from doubles and spies.
+test_files:
+- features/generating_specs.feature
+- features/readme.md
+- features/support/env.rb
+- spec/rspec/varys_spec.rb
+has_rdoc: