mkspec 0.0.1 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmQxOThiYzUxZGJjOTc5Yzg2N2NlNTlkZjI0MmExMWU0NWUxOWZlOQ==
+  data.tar.gz: !binary |-
+    YTdhZTFmY2QzYmY2NTAyN2ZkMDI0Mjk5ODU4OTRmYzkwOGIwYWIyNw==
+SHA512:
+  metadata.gz: !binary |-
+    MjY0ZmJhZTQ2NjA2ZTNkYTRlYmNhM2I3ZWE2MjBlNDcxZmExNzcxYjA5MDMw
+    YTU4YzA0YjRhNzc4OTE3YzZlNzU0YWNjMWE0Y2MyYmFhYzJmNTA4MDRmMjJi
+    MjM2NTA2ZjRhZTAwMTU1OTk1YzhlMTI1Y2M2ZjZmNDQwNmMwZjQ=
+  data.tar.gz: !binary |-
+    YTJhODY5YzdkZDFiM2RjMjQ2OWFhNWYyYWJiNjRhYTgwOTBmZjM1YTA5OWNj
+    MDIzZmY1ZjIzMDI3NDUyZTc1ZTJlMGRkOWUzNmJjNGIyMjNmMTg1OGEzZThl
+    Njg5Nzc2ZGIxMmQyYmZiZDZlMTliMDY3ZjAxYzBjYzNkZWZhNDU=

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p392
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+bundler_args: 
+rvm:
+- 1.9.2
+- 1.9.3
+addons:
+  code_climate:
+    repo_token: 66f413f9c50c6bc2d265e217df307f5de8bf36d8ad97feffb76b0174e9f9acd5
+deploy:
+  provider: rubygems
+  api_key:
+    secure: WLQzsGZ6aPzqsyS1Mu4YCZjer4ZXRFQo5j1XPkTdR/bYmip2GBQAoVIUihlIXrcTSDKRk4VVZ62GkVSOkTA41vAVvD69ARGNIgwSDzLfoVp7RWEIi7peUBdYhzOoQM8eFnOKa3UeZbEqjolsTjtQfMQISNCeL9TCmdRcyLa/avk=
+  gem: mkspec
+  on:
+    tags: true
+    repo: ritchiey/mkspec

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mkspec.gemspec
 gemspec
+gem "rspec"
+gem "pry-plus"
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +1,8 @@
 Mkspec
 ======
+[![Gem Version](https://badge.fury.io/rb/mkspec.png)](http://badge.fury.io/rb/mkspec)
+[![Build Status](https://travis-ci.org/ritchiey/mkspec.png?branch=master)](https://travis-ci.org/ritchiey/mkspec)
+[![Code Climate](https://codeclimate.com/repos/52b530917e00a45ef600294e/badges/9bce4690fe2eca6f2062/gpa.png)](https://codeclimate.com/repos/52b530917e00a45ef600294e/feed)
 
 Generate your Ruby specs straight from your REPL
 
@@ -7,10 +10,9 @@ Whilst mucking around in your Ruby REPL (probably Pry), you decide you
 need a spec to describe your next great feature. Instead of jumping back
 to your editor, just type:
 
-    require 'mkspec'
-    include Mkspec
+    extend Mkspec
     
-    expect(calculator, :calculate, "1+1").to(eq(1+1))
+    puts expect(calculator, :calculate, "1+1").to(eq(1+1))
 
 and it will generate:
 
@@ -25,6 +27,42 @@ and it will generate:
 
       end
     end
+    
+You can then copy and paste that spec into a file and edit to taste. It's not perfect but it does give you a headstart with some of the boiler-plate.
+
+Motivation
+==========
+
+The advantage of generating the spec from within Pry is that you are working with real values from the calling method. This enables you to just put `binding.pry` at the top of a method you need to implement and generate a realistic spec for it based on the values it actually received when called.
+
+
+Installation
+============
+
+Add this to your Gemfile:
+
+    gem 'mkspec'
+
+and run `bundle` at the command prompt to install it.
+
+
+Usage
+=====
+
+Where possible, mkspec syntax follows that of RSpec so it will hopefully be familiar.
+
+    expect(object_to_test, method, params...).to eq(expected_value)
+
+
+It uses Ruby's PrettyPrint to serialise `params` and `expected_value` so it correctly serializes Hashes and Arrays.
+
+See the specs for more examples of usage.
+
+
+Bugs
+====
+
+Mkspec does what it can to create a useful spec from the values it can introspect. It doesn't always get it right though so you'll very likely need to edit the generated spec a little.
 
 WIP
 ===

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/mkspec/version.rb

@@ -1,3 +1,3 @@
 module Mkspec
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/lib/mkspec.rb

@@ -1,9 +1,5 @@
 module Mkspec
 
-  class Matcher
-
-  end
-
   class LeftHand
 
     def initialize(class_name, method_name, args)
@@ -20,16 +16,33 @@ describe #{@class_name} do
   describe "##{@method_name}" do
 
     it "does something" do
-      expect(subject.#{@method_name}("#{@args}")).to #{matcher}
+      expect(subject.#{@method_name}(#{@args.map{|arg| serialise(arg) }.join(', ')})).to #{matcher}
     end
 
   end
 end
       EOF
     end
+
+    # Attempt to recreate the source-code to represent this argument in the setup
+    # for our generated spec.
+    def serialise(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 guess_constructor(arg)
+      "#{arg.class.name}.new(#{serialise(arg.to_s)})"
+    end
   end
 
-  def expect(sut, method, args)
+  def expect(sut, method, *args)
     LeftHand.new(sut.class.name, method, args)
   end
 

data/spec/mkspec_spec.rb

@@ -1,4 +1,5 @@
-require_relative '../lib/mkspec'
+require_relative 'spec_helper'
+
 
 describe Mkspec do
 
@@ -25,4 +26,37 @@ end
     )
   end
 
+
+  it "can generate specs for methods with varying arity and parameter types" do
+    class CustomType
+      def initialize(str)
+        @value = str.to_i
+      end
+
+      def to_s
+        @value.to_s
+      end
+    end
+    class SystemUnderTest
+    end
+    sut = SystemUnderTest.new
+
+    sut.extend described_class
+    expect(sut.expect(sut, :calculate, CustomType.new('1'), '+', 5.4, {formats:[:pdf, 'html']}).to(sut.eq(1+5.4)).to_s).to eq(
+      <<-GENERATED_SPEC
+describe SystemUnderTest do
+  subject {described_class.new}
+
+  describe "#calculate" do
+
+    it "does something" do
+      expect(subject.calculate(CustomType.new("1"), "+", 5.4, {:formats=>[:pdf, "html"]})).to eq(6.4)
+    end
+
+  end
+end
+      GENERATED_SPEC
+    )
+  end
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require_relative '../lib/mkspec'
+require 'pry'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mkspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Ritchie Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -68,8 +61,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .ruby-version
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -78,30 +71,32 @@ files:
 - lib/mkspec/version.rb
 - mkspec.gemspec
 - spec/mkspec_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ritchiey/mkspec
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generate a spec from your REPL using a simple, familiar DSL
 test_files:
 - spec/mkspec_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/Gemfile.lock

@@ -1,18 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.4)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rspec