rspec-varys 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8add44ff8c8ddece4c482995cb65d1798a102b60
-  data.tar.gz: 9ca6bc274c7969f3f4f22d53e937f1ee85404ffd
+  metadata.gz: 4ae6ca67859c48c958453b1533bed0aee4b87c2d
+  data.tar.gz: 90161136f92496d5d0b8da34258660c4b913330e
 SHA512:
-  metadata.gz: 4a0a48e1e970fdb09f7be35c3116d5b421b9a3ddfe3e4069e4aec1aa21e2aaece36b2ca234273122286f8db2435a90b46df162bc436dfd29b24ee5fc46b897a8
-  data.tar.gz: 95d2d16154f099c218adfe0c6f5c75792411c0b5adfdb9ef4e11179b1b8472b8c42e2a4c95f7bdfc740317bceb06eb2928959cbd580c95f4afc9f1ffdb32ef31
+  metadata.gz: 2bbe1d40a3668a000f8df492394ee97c2f307f6d537d439d615b6e197417080c70b32d05a7722ecbfc5a112909ab4d35b00d38609aeefb54c57bc44f414cff39
+  data.tar.gz: 5b474c92524ddec12b5047682731e228b81b80e0793d95a1c15b81b8f22cbd8388568db918ed150cb65a957c79f8424cc8f7a183275d5e30f7ccf96b0b6de466

data/.travis.yml

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

data/README.md

@@ -1,10 +1,58 @@
 [![Gem Version](https://badge.fury.io/rb/rspec-varys.svg)](http://badge.fury.io/rb/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.
+
+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
+```
 
-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.
+## 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 +68,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/features/generating_specs.feature

@@ -24,6 +24,132 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     """
 
 
+  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
@@ -64,6 +190,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     ---
     :untested_stubs:
     - :class_name: Person
+      :type: instance
       :method: full_name
       :returns: Dick Jones
     """
@@ -125,9 +252,11 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     ---
     :untested_stubs:
     - :class_name: Person
+      :type: instance
       :method: title
       :returns: Vice President
     - :class_name: Person
+      :type: instance
       :method: full_name
       :returns: Dick Jones
     """
@@ -216,6 +345,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     ---
     :untested_stubs:
     - :class_name: Person
+      :type: instance
       :method: title
       :returns: Vice President
     """
@@ -272,6 +402,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
     ---
     :untested_stubs:
     - :class_name: Person
+      :type: instance
       :method: join_names
       :returns: Dick Jones
       :arguments:
@@ -293,3 +424,7 @@ Feature: Generating an RSpec Spec from an RSpec Expectation
 
 
     """
+
+
+
+

data/lib/rspec/varys.rb

@@ -83,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
@@ -95,57 +91,26 @@ 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
     open_yaml_file do |yaml_file|
@@ -159,6 +124,7 @@ module RSpec::Varys
       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))
@@ -181,25 +147,5 @@ module RSpec::Varys
     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 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
 end
 

data/lib/rspec/varys/rspec_generator.rb

@@ -13,12 +13,12 @@ class RSpec::Varys::RSpecGenerator
   def self.process_specs(specs, file)
     specs[:untested_stubs].each do |spec|
       file.puts <<-EOF
-describe #{spec[:class_name]}, "##{spec[:method]}" do
+describe #{spec[:class_name]}, "#{class_method?(spec) ? '.' : '#'}#{spec[:method]}" do
 
   it "returns something" do
-    confirm(subject).can receive(:#{spec[:method]})#{with_args_if_any(spec)}.and_return(#{serialize spec[:returns]})
+    confirm(#{sut(spec)}).can receive(:#{spec[:method]})#{with_args_if_any(spec)}.and_return(#{serialize spec[:returns]})
     skip "remove this line once implemented"
-    expect(subject.#{spec[:method]}#{args_if_any(spec)}).to eq(#{serialize spec[:returns]})
+    expect(#{sut(spec)}.#{spec[:method]}#{args_if_any(spec)}).to eq(#{serialize spec[:returns]})
   end
 
 end
@@ -29,13 +29,12 @@ end
   end
 
   def self.with_args_if_any(call)
-    args = call[:arguments]
-    (args && args.length > 0) ?  ".with(#{args.map{|a| serialize a}.join ', '})" : ""
+    args_if_any(call, ".with")
   end
 
-  def self.args_if_any(call)
+  def self.args_if_any(call, prefix="")
     args = call[:arguments]
-    (args && args.length > 0) ?  "(#{args.map{|a| serialize a}.join ', '})" : ""
+    (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
@@ -55,4 +54,12 @@ end
     "#{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.1.3"
+    VERSION = "0.1.4"
   end
 end

data/spec/rspec/varys_spec.rb

@@ -1,6 +1,7 @@
 require 'rspec'
 require 'rspec/varys'
 
+
 class Person
 
   def initialize(first_name, last_name)
@@ -72,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
@@ -80,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"
@@ -116,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"
@@ -163,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

@@ -1,3 +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 }
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-varys
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ritchie Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt