rspec-varys 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9b5d6746ad0ced69ace33d7f785783a1a9289c3
-  data.tar.gz: e5579d289843714febeddd99b882d95f79c94779
+SHA256:
+  metadata.gz: 84ad5d3575e590204e17a0dc39078c65bb0305b37bf817119fd754b2535dd504
+  data.tar.gz: d63f46eaa21e08baeafb492d02f710e23ed9a8a4064f24ccb6a832c5af50cb4a
 SHA512:
-  metadata.gz: 4b25c426e5f447bb33d3d2216c0b593d0d1be37ab1be19223217b706a4a54a1d8dd796e779fea428c487a34443086e2da95178ae78e1d6613ea1dfb60ab99ddc
-  data.tar.gz: e485f28b72288b5ecf2212e1c3f7bcfd115a32918838f6a8a1e9ac93ed6ae4046a3cd0c7a07b9de7ed15cfc9b22e2d53b96f9b9e99645a4fbb9a28e727b58c3d
+  metadata.gz: 88d00f04f6bfed58a6937e26648f13f467efbf1ad7492bf06895419ef7607586b39ec6f7b05c81c40e14afd634f21493a41cf3095b176290f85add0257b1b589
+  data.tar.gz: f1308ced4b06f2def0f3c733cb6e707c58d477352a32c82fd7b007ac552f1b5b80492f62816b3fc3e178fbd3f98488dbfd340a32c405947add4d21cc50ff0d16

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+3.0.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.1

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+bundler_args: 
+rvm:
+- 2.1.2
+
+addons:
+  code_climate:
+    repo_token: dbd468edcfe120e56aec92ebf99ff6c030becc1910a8d1684102c6fa2e907439
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: WLQzsGZ6aPzqsyS1Mu4YCZjer4ZXRFQo5j1XPkTdR/bYmip2GBQAoVIUihlIXrcTSDKRk4VVZ62GkVSOkTA41vAVvD69ARGNIgwSDzLfoVp7RWEIi7peUBdYhzOoQM8eFnOKa3UeZbEqjolsTjtQfMQISNCeL9TCmdRcyLa/avk=
+  gem: rspec-varys
+  on:
+    tags: true
+    repo: ritchiey/rspec-varys

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'pry-rescue'
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,10 +1,56 @@
-[![Gem Version](https://badge.fury.io/rb/rspec-varys.svg)](http://badge.fury.io/rb/rspec-varys)
+[![Gem Version](https://badge.fury.io/rb/rspec-varys.svg)](http://badge.fury.io/rb/rspec-varys) [![Build Status](https://travis-ci.org/ritchiey/rspec-varys.svg?branch=master)](https://travis-ci.org/ritchiey/rspec-varys) [![Code Climate](https://codeclimate.com/github/ritchiey/rspec-varys/badges/gpa.svg)](https://codeclimate.com/github/ritchiey/rspec-varys)
 
 # Rspec::Varys
 
-Generate RSpec specs from intelligence gathered from doubles and spies.
+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.
 
-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.
+When you define a test-double in your spec:
+
+```ruby
+describe ExampleClass, "#max_margin_for" do
+  it "returns the maximum margin for the supplied text" do
+    allow(subject).to receive(:margin_for).and_return(2, 4)
+    expect(subject.max_margin_for("  unindent line\n    indented line\n")).to eq(4)
+  end
+end
+```
+
+And your code calls it:
+
+```ruby
+class ExampleClass
+  def max_margin_for(text)
+    text.split("\n").map {|line| margin_for(line)}.max
+  end
+end
+```
+
+
+Varys will generate the corresponding specs so you can verify the validity of your test-doubles:
+
+```ruby
+# Generated by Varys:
+
+describe ExampleClass, "#margin_for" do
+  it "returns something" do
+    confirm(subject).can receive(:margin_for).with("  unindent line").and_return(2)
+    skip "remove this line once implemented"
+    expect(subject.margin_for("  unindent line")).to eq(2)
+  end
+end
+
+describe ExampleClass, "#margin_for" do
+  it "returns something" do
+    confirm(subject).can receive(:margin_for).with("    indented line").and_return(4)
+    skip "remove this line once implemented"
+    expect(subject.margin_for("    indented line")).to eq(4)
+  end
+end
+```
+
+## Limitations
+
+Varys is very early release software and it has many limitations. If you find one, please check the Github issues and add it if it's not already listed.
 
 ## Installation
 
@@ -20,9 +66,35 @@ Or install it yourself as:
 
     $ gem install rspec-varys
 
+## Configuration
+
+Add these lines to your `spec/spec_helper.rb`:
+
+```ruby
+require "rspec/varys"
+require "rspec/varys/rspec_generator"
+
+RSpec.configure do |config|
+  config.include RSpec::Varys::DSL
+
+  config.before(:suite) do
+    RSpec::Varys.reset
+  end
+
+  config.after(:suite) do
+    # Required: create varys.yml
+    RSpec::Varys.print_report
+
+    # Optional: create generated_specs.yml from varys.yml
+    RSpec::Varys::RSpecGenerator.run
+  end
+end
+```
+
 ## Usage
 
-See the [Cucumber features](https://relishapp.com/spechero/rspec-varys/docs) for examples of intended usage.
+See the [Cucumber features](https://relishapp.com/spechero/rspec-varys/docs) for examples of intended usage or watch [this screencast](https://vimeo.com/119725799) for a simple tutorial.
+
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,14 @@
 require "bundler/gem_tasks"
 
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+
+Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]
+RSpec::Core::RakeTask.new

data/bin/genspecs

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/features/generating_specs.feature

@@ -6,6 +6,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     $:.unshift File.expand_path('../../lib', File.dirname(__FILE__))
 
     require "rspec/varys"
+    require "rspec/varys/rspec_generator"
 
     RSpec.configure do |config|
 
@@ -17,11 +18,138 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
       config.after(:suite) do
         RSpec::Varys.print_report
+        RSpec::Varys::RSpecGenerator.run
       end
     end
     """
 
 
+  Scenario: For a test double
+    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
+        name = double('Name', full_name: "Dick Jones")
+        boss = Person.new(name)
+        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(name)
+        @name = name
+      end
+
+      def welcome
+        "Welcome to OCP, I'm #{@name.full_name}"
+      end
+
+    end
+    """
+
+    When I run `rspec top_level_spec.rb`
+    Then it should pass with:
+    """ruby
+    Specs have been generated based on mocks you aren't currently testing.
+    """
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Name
+      :type: instance
+      :method: full_name
+      :returns: Dick Jones
+    """
+
+    And the file "generated_specs.rb" should contain:
+    """ruby
+    describe Name, "#full_name" do
+
+      it "returns something" do
+        confirm(subject).can receive(:full_name).and_return("Dick Jones")
+        skip "remove this line once implemented"
+        expect(subject.full_name).to eq("Dick Jones")
+      end
+
+    end
+
+
+    """
+  Scenario: For a class method
+    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')
+        allow(Person).to receive(:full_name).with("Dick", "Jones").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)
+        @firstname = firstname
+        @lastname = lastname
+      end
+
+      def welcome
+        "Welcome to OCP, I'm #{Person.full_name(@firstname, @lastname)}"
+      end
+
+    end
+    """
+
+    When I run `rspec top_level_spec.rb`
+    Then it should pass with:
+    """ruby
+    Specs have been generated based on mocks you aren't currently testing.
+    """
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Person
+      :type: class
+      :method: full_name
+      :returns: Dick Jones
+      :arguments:
+      - Dick
+      - Jones
+    """
+
+    And the file "generated_specs.rb" should contain:
+    """ruby
+    describe Person, ".full_name" do
+
+      it "returns something" do
+        confirm(described_class).can receive(:full_name).with("Dick", "Jones").and_return("Dick Jones")
+        skip "remove this line once implemented"
+        expect(described_class.full_name("Dick", "Jones")).to eq("Dick Jones")
+      end
+
+    end
+
+
+    """
+
+
   Scenario: For a single unmatched expectation
     Given a file named "top_level_spec.rb" with:
     """ruby
@@ -54,24 +182,32 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
     When I run `rspec top_level_spec.rb`
     Then it should pass with:
-    """
+    """ruby
     Specs have been generated based on mocks you aren't currently testing.
     """
-    And the file "generated_specs/person_spec.rb" should contain:
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Person
+      :type: instance
+      :method: full_name
+      :returns: Dick Jones
     """
-    describe Person do
 
-      describe "#full_name" do
-
-        it "returns the correct value" do
-          pending
-          confirm(subject).can receive(:full_name).and_return("Dick Jones")
-          expect(subject.full_name).to eq("Dick Jones")
-        end
+    And the file "generated_specs.rb" should contain:
+    """ruby
+    describe Person, "#full_name" do
 
+      it "returns something" do
+        confirm(subject).can receive(:full_name).and_return("Dick Jones")
+        skip "remove this line once implemented"
+        expect(subject.full_name).to eq("Dick Jones")
       end
 
     end
+
+
     """
 
 
@@ -108,36 +244,50 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
     When I run `rspec top_level_spec.rb`
     Then it should pass with:
-    """
+    """ruby
     Specs have been generated based on mocks you aren't currently testing.
     """
-    And the file "generated_specs/person_spec.rb" should contain:
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Person
+      :type: instance
+      :method: title
+      :returns: Vice President
+    - :class_name: Person
+      :type: instance
+      :method: full_name
+      :returns: Dick Jones
     """
-    describe Person do
-
-      describe "#title" do
 
-        it "returns the correct value" do
-          pending
-          confirm(subject).can receive(:title).and_return("Vice President")
-          expect(subject.title).to eq("Vice President")
-        end
+    And the file "generated_specs.rb" should contain:
+    """ruby
+    describe Person, "#title" do
 
+      it "returns something" do
+        confirm(subject).can receive(:title).and_return("Vice President")
+        skip "remove this line once implemented"
+        expect(subject.title).to eq("Vice President")
       end
 
-      describe "#full_name" do
+    end
 
-        it "returns the correct value" do
-          pending
-          confirm(subject).can receive(:full_name).and_return("Dick Jones")
-          expect(subject.full_name).to eq("Dick Jones")
-        end
 
+    describe Person, "#full_name" do
+
+      it "returns something" do
+        confirm(subject).can receive(:full_name).and_return("Dick Jones")
+        skip "remove this line once implemented"
+        expect(subject.full_name).to eq("Dick Jones")
       end
 
     end
+
+
     """
 
+
   Scenario: For one matched and one unmatched expectation
     Given a file named "top_level_spec.rb" with:
     """ruby
@@ -148,8 +298,8 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
       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")
+        allow(boss).to receive(:full_name).and_return("Dick Jones")
+        allow(boss).to receive(:title).and_return("Vice President")
         expect(boss.welcome).to eq "Welcome to OCP, I'm Vice President Dick Jones"
       end
 
@@ -162,7 +312,6 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
       describe "#full_name" do
 
         it "returns the correct value" do
-          pending
           confirm(subject).can receive(:full_name).and_return("Dick Jones")
           # ...
         end
@@ -188,24 +337,17 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
     When I run `rspec top_level_spec.rb`
     Then it should pass with:
-    """
+    """ruby
     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
-          pending
-          confirm(subject).can receive(:title).and_return("Vice President")
-          expect(subject.title).to eq("Vice President")
-        end
-
-      end
-
-    end
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Person
+      :type: instance
+      :method: title
+      :returns: Vice President
     """
 
   Scenario: For an expectation with parameters
@@ -221,8 +363,6 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
       describe "#full_name" do
 
         it "returns the correct value" do
-          pending
-          confirm(subject).can receive(:full_name).and_return("Dick Jones")
           expect(subject).to receive(:join_names).with("Dick", "Jones").and_return("Dick Jones")
           subject.full_name
         end
@@ -254,22 +394,37 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
     When I run `rspec top_level_spec.rb`
     Then it should pass with:
-    """
+    """ruby
     Specs have been generated based on mocks you aren't currently testing.
     """
-    And the file "generated_specs/person_spec.rb" should contain:
+    And the file "varys.yaml" should contain:
+    """yaml
+    ---
+    :untested_stubs:
+    - :class_name: Person
+      :type: instance
+      :method: join_names
+      :returns: Dick Jones
+      :arguments:
+      - Dick
+      - Jones
     """
-    describe Person do
 
-      describe "#join_names" do
-
-        it "returns the correct value" do
-          pending
-          confirm(subject).can receive(:join_names).with("Dick", "Jones").and_return("Dick Jones")
-          expect(subject.join_names("Dick", "Jones")).to eq("Dick Jones")
-        end
+    And the file "generated_specs.rb" should contain:
+    """ruby
+    describe Person, "#join_names" do
 
+      it "returns something" do
+        confirm(subject).can receive(:join_names).with("Dick", "Jones").and_return("Dick Jones")
+        skip "remove this line once implemented"
+        expect(subject.join_names("Dick", "Jones")).to eq("Dick Jones")
       end
 
     end
+
+
     """
+
+
+
+

data/features/readme.md

@@ -1,4 +1,4 @@
-*Everything should be built top-down, except the first time - Alan
+*Everything should be built top-down, except the first time 1. Alan
 Perlis*
 
 RSpec-Varys automatically generates RSpec specs from your mocked methods each time your suite is run.
@@ -7,4 +7,27 @@ 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)
+Installation instructions can be found [here](https://github.com/ritchiey/rspec-varys).
+
+  A typical workflow using rspec-varys looks like this. Note, I haven't
+written "and run your specs again" at the end of each step, that's
+implied.
+
+  - if you have no failing specs and you need some new functionality, write a new top-level spec.
+
+  - if your specs are failing because your **spec** calls a non-existent function,  
+      write the code for that function. Feel free to call methods that
+      don't exist yet.
+
+  - if your specs are failing because your **code** calls a non-existent function
+      stub that function out in the spec using `allow`.
+
+  - if your specs pass but varys generates new specs for untested stubs,
+      copy the generated specs into the appropriate spec file.
+
+  - if varys warns you about unneeded specs, delete those specs and any
+      code that can be removed without making other specs fail.
+
+  - if your specs pass but there are pending specs, pick one and remove
+      the `pending` statement.
+

data/features/support/{env.rb → external.rb}

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

data/lib/rspec/varys.rb

@@ -1,5 +1,6 @@
 require "rspec/varys/version"
 require "fileutils"
+require 'yaml'
 
 module RSpec
   module Varys
@@ -26,11 +27,25 @@ module RSpec
           {
             class_name: class_name,
             message: message,
-            args: [],
-            return_value: "Dick Jones"
+            args: args,
+            return_value: return_value
           }
         end
 
+        def args
+          customization = customizations.find{|c| c.instance_variable_get('@method_name') == :with}
+          (customization && customization.instance_variable_get('@args')) || []
+        end
+
+        def return_value
+          customization = customizations.find{|c| c.instance_variable_get('@method_name') == :and_return}
+          customization && customization.instance_variable_get('@args').first
+        end
+
+        def customizations
+          @ability.instance_variable_get('@recorded_customizations')
+        end
+
         def class_name
           @object.class.name
         end
@@ -68,10 +83,6 @@ module RSpec::Varys
     @recorded_messages
   end
 
-  def self.generated_specs
-    @generated_specs ||= generate_specs
-  end
-
   def self.reset
     @recorded_messages = []
     @generated_specs = nil
@@ -80,96 +91,61 @@ module RSpec::Varys
 
   def self.record(object, message, args, block, return_value)
     @recorded_messages << {
-      class_name: object.class.name,
+      class_name: class_name_for(object),
+      type:   type_for(object),
       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
-      pending
-      confirm(subject).can receive(:#{s[:message]})#{with_parameters(s)}.and_return(#{serialize s[:return_value]})
-      expect(subject.#{s[:message]}#{parameters(s)}).to eq(#{serialize s[:return_value]})
-    end
-
-  end
-
-    GENERATED
+  def self.type_for(object)
+    object.kind_of?(Class) ? 'class' : 'instance'
   end
 
-  def self.with_parameters(spec)
-    if spec[:args].length > 0
-      %Q[.with(#{params spec[:args]})]
+  def self.class_name_for(object)
+    if object.kind_of? RSpec::Mocks::Double
+      'Name'
     else
-      ""
+      object.kind_of?(Class) ? object.name : object.class.name
     end
   end
 
-  def self.params(args)
-     args.map{|a| serialize(a)}.join(", ")
-  end
-
-  def self.parameters(spec)
-    if spec[:args].length > 0
-      %Q[(#{params spec[:args]})]
-    else
-      ""
-    end
-  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
+    open_yaml_file do |yaml_file|
+      yaml_file.write YAML.dump(report)
     end
     puts "Specs have been generated based on mocks you aren't currently testing."
   end
 
-  def self.unconfirmed_messages
-    recorded_messages - confirmed_messages
+  def self.report
+    {
+      untested_stubs: unconfirmed_messages.map do |call|
+        {
+          class_name:  call[:class_name],
+          type:        call[:type],
+          method:      call[:message].to_s,
+          returns:     call[:return_value]
+        }.merge(arguments_if_any(call))
+      end
+    }
   end
 
-  def self.underscore(camel_cased_word)
-    camel_cased_word.downcase
+  def self.arguments_if_any(call)
+    call[:args].length > 0 ?  { arguments: call[:args] } : { }
   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
+  def self.open_yaml_file
+    File.open("varys.yaml", 'w') do |io|
+      yield io
     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)})"
+
+  def self.unconfirmed_messages
+    recorded_messages - confirmed_messages
   end
+
 end
 

data/lib/rspec/varys/rspec_generator.rb

@@ -0,0 +1,67 @@
+require 'pp'
+
+class RSpec::Varys::RSpecGenerator
+
+  def self.run
+
+    specs = YAML.load(File.read "varys.yaml")
+
+    File.open('generated_specs.rb', 'w') do |file|
+      process_specs(specs, file)
+    end
+
+  end
+
+  def self.process_specs(specs, file)
+    specs[:untested_stubs].each do |spec|
+      file.puts <<-EOF
+describe #{spec[:class_name]}, "#{class_method?(spec) ? '.' : '#'}#{spec[:method]}" do
+
+  it "returns something" do
+    confirm(#{sut(spec)}).can receive(:#{spec[:method]})#{with_args_if_any(spec)}.and_return(#{serialize spec[:returns]})
+    skip "remove this line once implemented"
+    expect(#{sut(spec)}.#{spec[:method]}#{args_if_any(spec)}).to eq(#{serialize spec[:returns]})
+  end
+
+end
+
+
+      EOF
+    end
+  end
+
+  def self.with_args_if_any(call)
+    args_if_any(call, ".with")
+  end
+
+  def self.args_if_any(call, prefix="")
+    args = call[:arguments]
+    (args && args.length > 0) ?  "#{prefix}(#{args.map{|a| serialize a}.join ', '})" : ""
+  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 NilClass TrueClass FalseClass).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
+
+  def self.class_method?(call)
+    call[:type] == 'class'
+  end
+
+  def self.sut(call)
+    class_method?(call) ? "described_class" : "subject"
+  end
+
+end

data/lib/rspec/varys/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Varys
-    VERSION = "0.0.3"
+    VERSION = "0.2.0"
   end
 end

data/rspec-varys.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", '~> 13.0', ">= 13.0"
   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'
+  spec.add_development_dependency "cucumber", '~> 6.1', ">= 6.1.0"
+  spec.add_development_dependency "aruba", '~> 0.1', '>= 0.1.1'
+  spec.add_dependency 'pp', '~> 0.2.0'
 end

data/spec/rspec/varys_spec.rb

@@ -1,6 +1,6 @@
 require 'rspec'
 require 'rspec/varys'
-require 'pry'
+
 
 class Person
 
@@ -34,6 +34,7 @@ describe RSpec::Varys do
         { class_name: 'Object', message: :a_message, args: [:a_parameter], return_value: 42 }
       ])
     end
+
   end
 
   describe ".confirmed_messages" do
@@ -50,6 +51,17 @@ describe RSpec::Varys do
       }])
     end
 
+    it "parses parameters" do
+      described_class.reset
+      confirm(Person.new 'Dick', 'Jones').can receive(:full_name).with(:blah).and_return("Dick Jones")
+      expect(described_class.confirmed_messages).to match_array([{
+        class_name: 'Person',
+        message: :full_name,
+        args: [:blah],
+        return_value: "Dick Jones"
+      }])
+    end
+
   end
 
   it "records the messages sent to a spy" do
@@ -61,6 +73,7 @@ describe RSpec::Varys do
 
     expect(described_class.recorded_messages).to match_array([{
       class_name: 'Object',
+      type: 'instance',
       message: :a_message,
       args: [:a_parameter],
       return_value: 42
@@ -69,27 +82,13 @@ describe RSpec::Varys do
 
 
   context "given the test-suite calls a mocked method" do
-    context "with no paramters" do
-
-      let(:expected_spec) do
-        <<GENERATED
-  describe "#full_name" do
-
-    it "returns the correct value" do
-      pending
-      confirm(subject).can receive(:full_name).and_return("Dick Jones")
-      expect(subject.full_name).to eq("Dick Jones")
-    end
-
-  end
-
-GENERATED
-      end
+    context "with no parameters" do
 
       let(:recognised_specs) {
         [
           {
             class_name: 'Person',
+            type: 'instance',
             message: :full_name,
             args: [],
             return_value: "Dick Jones"
@@ -105,38 +104,19 @@ GENERATED
         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
+      it "record the methods called" do
         expect(described_class.recorded_messages).to match_array(recognised_specs)
-
-        # did it generate an in-memory version of the specs?
-        expect(described_class.generated_specs).to eq('Person' => [ expected_spec ])
-
       end
 
     end
 
     context "with parameters" do
 
-      let(:expected_spec) do
-        <<GENERATED
-  describe "#join_names" do
-
-    it "returns the correct value" do
-      pending
-      confirm(subject).can receive(:join_names).with("Dick", "Jones").and_return("Dick Jones")
-      expect(subject.join_names("Dick", "Jones")).to eq("Dick Jones")
-    end
-
-  end
-
-GENERATED
-      end
-
       let(:recognised_specs) {
         [
           {
             class_name: 'Person',
+            type: 'instance',
             message: :join_names,
             args: ["Dick", "Jones"],
             return_value: "Dick Jones"
@@ -152,13 +132,8 @@ GENERATED
         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
+      it "records that the method was called" do
         expect(described_class.recorded_messages).to match_array(recognised_specs)
-
-        # did it generate an in-memory version of the specs?
-        expect(described_class.generated_specs).to eq('Person' => [ expected_spec ])
-
       end
 
     end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+Dir.glob(::File.expand_path('../../lib/*.rb', __FILE__)).each { |f| require_relative f }
+

data/spec/varys/rspec_generator_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require_relative '../../lib/rspec/varys/rspec_generator'
+
+describe RSpec::Varys::RSpecGenerator do
+
+  describe ".process_specs" do
+
+    context "given a file YAML file with one missing spec with arguments" do
+      let(:specs) {
+        YAML.load <<-SPECS
+---
+:untested_stubs:
+- :class_name: Person
+  :method: full_name
+  :arguments:
+    - Dick
+    - Jones
+  :returns: Dick Jones
+SPECS
+      }
+
+      it "generates the spec" do
+        output = ""
+        StringIO.open(output, 'w') do |file|
+          described_class.process_specs(specs, file)
+        end
+        expect(output).to eq <<-EOF
+describe Person, "#full_name" do
+
+  it "returns something" do
+    confirm(subject).can receive(:full_name).with("Dick", "Jones").and_return("Dick Jones")
+    skip "remove this line once implemented"
+    expect(subject.full_name("Dick", "Jones")).to eq("Dick Jones")
+  end
+
+end
+
+
+EOF
+      end
+    end
+
+
+    context "given a file YAML file with one missing spec" do
+      let(:specs) {
+        YAML.load <<-SPECS
+---
+:untested_stubs:
+- :class_name: Person
+  :method: full_name
+  :returns: Dick Jones
+SPECS
+      }
+
+      it "generates the spec" do
+        output = ""
+        StringIO.open(output, 'w') do |file|
+          described_class.process_specs(specs, file)
+        end
+        expect(output).to eq <<-EOF
+describe Person, "#full_name" do
+
+  it "returns something" do
+    confirm(subject).can receive(:full_name).and_return("Dick Jones")
+    skip "remove this line once implemented"
+    expect(subject.full_name).to eq("Dick Jones")
+  end
+
+end
+
+
+EOF
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-varys
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ritchie Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,62 +70,83 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.15
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.15
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: pp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Automatically track which assumptions you've made in the form or mocks
   and stubs actually work.
 email:
 - ritchiey@gmail.com
-executables: []
+executables:
+- genspecs
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".tool-versions"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/genspecs
+- config/cucumber.yml
 - features/generating_specs.feature
 - features/readme.md
-- features/support/env.rb
+- features/support/external.rb
 - lib/rspec/varys.rb
+- lib/rspec/varys/rspec_generator.rb
 - lib/rspec/varys/version.rb
 - rspec-varys.gemspec
 - spec/rspec/varys_spec.rb
+- spec/spec_helper.rb
+- spec/varys/rspec_generator_spec.rb
 homepage: https://github.com/ritchiey/rspec-varys
 licenses:
 - MIT
@@ -145,14 +166,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.2.15
 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
+- features/support/external.rb
 - spec/rspec/varys_spec.rb
-has_rdoc: 
+- spec/spec_helper.rb
+- spec/varys/rspec_generator_spec.rb