rspec-varys 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9b5d6746ad0ced69ace33d7f785783a1a9289c3
-  data.tar.gz: e5579d289843714febeddd99b882d95f79c94779
+  metadata.gz: cbc742320b2d49ca1b0ccfb05d60c189212820f4
+  data.tar.gz: d56e9a8c273902aedab09c984a1e7c17249dad03
 SHA512:
-  metadata.gz: 4b25c426e5f447bb33d3d2216c0b593d0d1be37ab1be19223217b706a4a54a1d8dd796e779fea428c487a34443086e2da95178ae78e1d6613ea1dfb60ab99ddc
-  data.tar.gz: e485f28b72288b5ecf2212e1c3f7bcfd115a32918838f6a8a1e9ac93ed6ae4046a3cd0c7a07b9de7ed15cfc9b22e2d53b96f9b9e99645a4fbb9a28e727b58c3d
+  metadata.gz: 1494635acd2c1106fe2309477866dcb3cb9782d4937144e1feaf0bf681cbb3197c051c6e56eb0fdf02cad15921a1afedb27c0b27db0cc5c2ce90c68718a0e81b
+  data.tar.gz: 79b1b8d13c8b9bf5fbd23fa14d48cfc9ebe4972f69fea4ec4ef184524ef7a6f4e4a05b411c748d5e86ae4320778d0d89927ea679f202adc9a42e5c3343b3d22c

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'pry-rescue'

data/bin/genspecs

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

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,6 +18,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
       config.after(:suite) do
         RSpec::Varys.print_report
+        RSpec::Varys::RSpecGenerator.run
       end
     end
     """
@@ -54,24 +56,29 @@ 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
+      :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
+        expect(subject.full_name).to return("Dick Jones")
       end
 
     end
+
+
     """
 
 
@@ -108,36 +115,44 @@ 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
+      :method: title
+      :returns: Vice President
+    - :class_name: Person
+      :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
+        expect(subject.title).to return("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
+        expect(subject.full_name).to return("Dick Jones")
       end
 
     end
+
+
     """
 
+
   Scenario: For one matched and one unmatched expectation
     Given a file named "top_level_spec.rb" with:
     """ruby
@@ -148,8 +163,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 +177,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 +202,16 @@ 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
+      :method: title
+      :returns: Vice President
     """
 
   Scenario: For an expectation with parameters
@@ -221,7 +227,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
@@ -254,22 +259,30 @@ 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
+      :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
+        expect(subject.join_names("Dick", "Jones")).to return("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
@@ -121,7 +136,7 @@ module RSpec::Varys
   end
 
   def self.params(args)
-     args.map{|a| serialize(a)}.join(", ")
+    args.map{|a| serialize(a)}.join(", ")
   end
 
   def self.parameters(spec)
@@ -133,20 +148,35 @@ module RSpec::Varys
   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.report
+    {
+      untested_stubs: unconfirmed_messages.map do |call|
+        {
+          class_name:  call[:class_name],
+          method:      call[:message].to_s,
+          returns:     call[:return_value]
+        }.merge(arguments_if_any(call))
+      end
+    }
+  end
+
+  def self.arguments_if_any(call)
+    call[:args].length > 0 ?  { arguments: call[:args] } : { }
+  end
+
+  def self.open_yaml_file
+    File.open("varys.yaml", 'w') do |io|
+      yield io
+    end
+  end
+
+
   def self.unconfirmed_messages
     recorded_messages - confirmed_messages
   end

data/lib/rspec/varys/rspec_generator.rb

@@ -0,0 +1,51 @@
+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]}, "##{spec[:method]}" do
+
+  it "returns something" do
+    expect(subject.#{spec[:method]}#{args_if_any(spec)}).to return(#{serialize spec[:returns]})
+  end
+
+end
+
+
+      EOF
+    end
+  end
+
+  def self.args_if_any(call)
+    args = call[:arguments]
+    (args && args.length > 0) ?  "(#{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).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/lib/rspec/varys/version.rb

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

data/spec/rspec/varys_spec.rb

@@ -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

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+
+require 'pry'
+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,74 @@
+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
+    expect(subject.full_name("Dick", "Jones")).to return("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
+    expect(subject.full_name).to return("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.1.0
 platform: ruby
 authors:
 - Ritchie Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,8 @@ description: Automatically track which assumptions you've made in the form or mo
   and stubs actually work.
 email:
 - ritchiey@gmail.com
-executables: []
+executables:
+- genspecs
 extensions: []
 extra_rdoc_files: []
 files:
@@ -119,13 +120,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/genspecs
 - 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
@@ -153,6 +158,8 @@ 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
+- spec/spec_helper.rb
+- spec/varys/rspec_generator_spec.rb
 has_rdoc: