rambo_ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 181b7e230121fc0dd07a1577c7dd39697ab18409
-  data.tar.gz: 399cbdee63d18ff87611250c0f0b9e8d9ecdf4d9
+  metadata.gz: 0cce940ea2b21f4db0e40bdc31be6e8c8193b0bb
+  data.tar.gz: d44fe75445872974782a1d0f79b5da966175897d
 SHA512:
-  metadata.gz: 61746a4c0f25f15a25cfe25588045506040fb2dcff720ae38d7f322802227b196dec5fed092eae158877d99e8e62f794acba20fe8e05f11fa9df43a35a2b8635
-  data.tar.gz: e254055accaecd97a45e116fbd9e9522484e8b6aeae75244da60fa076afc9594d1f65dbd23911a6eed82d1142e30d0cf876f19fe82d0909f66dbe57157d9c906
+  metadata.gz: 349fbeddb405567e4276791a1b6682c950a56164403a14f4a788ae3afe546c80c09e654e0ce1155f5df0ae8c8dbeb03f849686eaa2c5bf5cfb4327666af39996
+  data.tar.gz: 355b9f9c0604387b3d4640a853d68bd2cedfbd60016a74d6b9ba3e765ef869550fa0cd7b842af9d7572ce42512ee50f0e46d92991e4eb486b48d708021b06362

data/README.md

@@ -1,10 +1,10 @@
 # Rambo
-[![Build Status](https://travis-ci.org/danascheider/rambo.svg?branch=master)](https://travis-ci.org/danascheider/rambo) [![Code Climate](https://codeclimate.com/github/danascheider/rambo/badges/gpa.svg)](https://codeclimate.com/github/danascheider/rambo) [![Dependency Status](https://gemnasium.com/badges/github.com/danascheider/rambo.svg)](https://gemnasium.com/github.com/danascheider/rambo)
+[![Gem Version](https://badge.fury.io/rb/rambo_ruby.svg)](https://badge.fury.io/rb/rambo_ruby)  [![Build Status](https://travis-ci.org/danascheider/rambo.svg?branch=master)](https://travis-ci.org/danascheider/rambo) [![Code Climate](https://codeclimate.com/github/danascheider/rambo/badges/gpa.svg)](https://codeclimate.com/github/danascheider/rambo) [![Dependency Status](https://gemnasium.com/badges/github.com/danascheider/rambo.svg)](https://gemnasium.com/github.com/danascheider/rambo)
  [![Coverage Status](https://coveralls.io/repos/github/danascheider/rambo/badge.svg?branch=dev)](https://coveralls.io/github/danascheider/rambo?branch=master)
 
-Rambo is a gem that generates API contract tests from API docs in [RAML](http://raml.org/).
+Rambo is a gem that generates API contract tests from API docs in [RAML](http://raml.org/). Rambo is being developed to test APIs complying with standard REST practices. Mileage may vary with other architectures, but I'm happy to consider pull requests.
 
-#### The current version of Rambo is 0.1.0. It is highly unstable and has a limited feature set. Use at your own risk and please file issue reports if they come up!
+#### The current version of Rambo is 0.2.0. It is highly unstable and has a limited feature set. Use at your own risk and please file issue reports if they come up!
 
 ## Usage
 You can install Rambo using:
@@ -14,22 +14,72 @@ gem install rambo_ruby
 You can also add it to your project's Gemfile: <
 ```ruby
 group :development, :test do
-  gem 'rambo_ruby', '~> 0.0.1'
+  gem 'rambo_ruby', '~> 0.2.0'
 end
 ```
-To run Rambo, from the root directory of your project, run:
-```
-$ rambo foobar.raml
-```
+There are three options for generating tests from Rambo: The command line tool, the rake task, and the Ruby API. In all cases, Rambo will look for a `.rambo.yml` file in the root directory of your project for configuration options. Options may also be passed in through the command line as arguments or the Ruby API as a hash. There is currently no option to pass arguments to the Rake task, but Rambo comes pre-loaded with sensible defaults, and the `.rambo.yml` file is always an option.
+
 Rambo will create `spec/contract` directory and a `spec/rambo_helper.rb` file if they don't exist, and will create a `spec/contract/foobar_spec.rb` file. The latter will overwrite any existing spec file by the same name. This is intentional behavior and will not change in future versions.
 
+The Rack::Test API uses different syntax for Rails and non-Rails Rack apps. By default, Rambo assumes it is dealing with a Rails app, but this is easily modified by passing options or using a .rambo.yml file.
+
 To run the RSpec examples Rambo generates, you will need to have `require`s in your `spec_helper.rb` or `rambo_helper.rb` file:
 
 - `require "rack/test"`
 - `require "json"`
 - `require "json-schema"`
 
-Rambo is being developed to test APIs complying with standard REST practices. Mileage may vary with other architectures, but I'm happy to consider pull requests.
+### The Command Line Tool
+To use the command line tool, simply `cd` into the root directory of your project and run
+```
+$ rambo foobar.raml
+```
+Replace `foobar.raml` with the path of the actual RAML file from which you want to generate tests.
+
+#### Options
+By default, Rambo assumes you are testing a Rails app and generates tests using the Rails Rack::Test syntax. If you are testing a non-Rails Rack app, you can use the `--no-rails` switch to use the non-Rails syntax. Rambo does not currently support non-Rack-based frameworks.
+
+### The Rake Task
+After adding `rambo_ruby` to your Gemfile or gemspec, you will need to add the following to your Rakefile:
+```ruby
+require "rambo"
+
+Rambo::Rake::Task.new
+```
+This will create a Rake task called `rambo`. Now, you can generate tests by running:
+```
+rake rambo
+```
+
+### The Ruby API
+You can generate Rambo tests from a Ruby script using:
+```ruby
+require "rambo"
+
+Rambo.generate_contract_tests!(File.expand_path("doc/foobar.raml"), {})
+```
+You can pass any options in as a hash. Currently, the only supported option is `"rails"`, which can be set to `true` or `false`, with `true` being the default value. Set `"rails"` to `false` if your app is built with a different Rack-based framework. Currently, Non-Rack-based frameworks are not supported, but pull requests are welcome if your use case requires such support.
+
+## The .rambo.yml File
+By default, Rambo will always check for a `.rambo.yml` file in the root directory of your projects and load options from there. If there is no `.rambo.yml` file, default values will be used (see below).
+
+A sample `.rambo.yml` file could look like this:
+```yaml
+raml: docs/contracts/foobar.raml
+rails: false
+```
+The two possible keys are:
+  - `raml` - specifies the RAML file to use to generate the tests. The default, relative
+    to the root of your project directory, is `doc/raml/foobar.raml`, where `foobar.raml` is the first RAML file found in the `doc/raml` directory.
+  - `rails` - specifies whether your app is a Rails app. The default value is `true`.
+
+## Default Behavior
+In order to provide the best user experience to a majority of users, Rambo comes with some sensible defaults that are easily overridden in an optional `.rambo.yml` file, or by using command line flags or a Ruby option hash (see above).
+
+### RAML File
+In the present version, Rambo only generates tests from a single RAML file. If you're using the command line tool, the name of this file is passed in as an argument. If you're not using the command line tool and don't specify by another means (Ruby hash, `.rambo.yml` file) which RAML file to use, Rambo will look in `your_project/doc/raml` and use the first RAML file it finds.
+
+As noted above, Rambo currently supports only Rack-based apps. Since Rails is the most popular Ruby framework, it assumes your app is a Rails app unless specified otherwise. Since Rack::Test syntax differs when testing Rails and non-Rails apps, you will need to tell Rambo if your app is not a Rails app using the `--no-rails` switch on the command line, the `{ rails: false }` option hash for the Ruby API, or specifying `rails: false` in your `.rambo.yml` file.
 
 ## About the Project
 I started Rambo in March of 2016 as part of my work at [Renew Financial](http://renewfinancial.com). RF has since put a second full-time engineer on the project. For this reason, our primary focus is on adding the features and functionality that are most important for testing RF's back-end services. One of these services, Repaymnt Estimatr, forms the basis for the Rambo MVP.

data/bin/rambo

@@ -4,7 +4,7 @@ lib = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "fileutils"
-require "cli"
+require "rambo/cli"
 require "optparse"
 
 filename = ARGV[0] ? File.expand_path(ARGV[0], FileUtils.pwd) : nil

data/features/support/cucumber_helper.rb

@@ -1,9 +1,9 @@
 module CucumberHelper
   def read_example(example)
     possible_paths = [
-      File.expand_path("../examples/raml/#{example}", __FILE__),
-      File.expand_path("../examples/rspec/#{example}", __FILE__),
-      File.expand_path("../examples/rspec/#{example}", __FILE__)
+      File.join(CUCUMBER_DIR_ROOT, "examples/raml/#{example}"),
+      File.join(CUCUMBER_DIR_ROOT, "examples/rspec/#{example}"),
+      File.join(CUCUMBER_DIR_ROOT, "examples/rspec/#{example}")
     ]
 
     possible_paths.each do |path|

data/features/support/env.rb

@@ -6,3 +6,6 @@ require 'aruba/cucumber'
 require_relative './cucumber_helper'
 
 World(CucumberHelper)
+
+CUCUMBER_DIR_ROOT = File.expand_path("../", __FILE__)
+RAMBO_ROOT =  File.expand_path("../../lib", __FILE__)

data/lib/rambo.rb

@@ -0,0 +1,36 @@
+Dir["#{File.dirname(__FILE__)}/rambo/**/*.rb"].each {|file| require file }
+
+module Rambo
+  class << self
+    attr_reader :options, :file
+
+    def generate_contract_tests!(file = nil, opts = nil)
+      @options = opts || yaml_options
+      @file    = file || @options.fetch(:raml, nil) || raml_file
+
+      DocumentGenerator.generate!(@file, @options)
+    end
+
+    private
+
+    def yaml_options
+      opts = YAML.load(File.read(File.expand_path(".rambo.yml")))
+
+      if opts && opts.fetch("raml", nil)
+        opts["raml"] = File.expand_path(opts.fetch("raml"))
+      end
+
+      opts
+    rescue
+      { rails: true }
+    end
+
+    # TODO: Permit use of multiple RAML files, since right now this only takes
+    #       the first one it finds in the "doc" directory.
+
+    def raml_file
+      return options.fetch("raml") if options && options.fetch("raml", nil)
+      Dir.foreach("doc/raml") {|file| return "doc/raml/#{file}" if file.match(/\.raml$/) }
+    end
+  end
+end

data/lib/{cli.rb → rambo/cli.rb}

@@ -1,5 +1,5 @@
 require "colorize"
-require "document_generator"
+require "rambo/document_generator"
 
 module Rambo
   class CLI
@@ -10,23 +10,17 @@ module Rambo
       @options = opts
 
       validate!
-
-      @generator = Rambo::DocumentGenerator.new(file, options)
     end
 
     def run!
       print_logo
-      generator.generate_spec_dir!
-      generator.generate_rambo_helper!
-      generator.generate_matcher_dir!
-      generator.generate_examples!
-      generator.generate_matchers!
-
-      stdout.puts("Generating contract tests...")
-      sleep 0.4
 
       begin
-        generator.generate_spec_file!
+        Rambo::DocumentGenerator.generate!(file, options)
+
+        stdout.puts("Generating contract tests...")
+        sleep 0.4
+
         stdout.puts("Done!".green)
       rescue NoMethodError => e
         stderr.puts("Error: #{e.message}".red)
@@ -59,7 +53,7 @@ module Rambo
     end
 
     def logo
-      File.read(File.expand_path("../../assets/logo.txt", __FILE__))
+      File.read(File.expand_path("../../../assets/logo.txt", __FILE__))
     end
   end
 end

data/lib/{document_generator.rb → rambo/document_generator.rb}

@@ -1,13 +1,25 @@
 require "fileutils"
 require "raml-rb"
 
-require "rspec/spec_file"
-require "rspec/helper_file"
+require "rambo/rspec/spec_file"
+require "rambo/rspec/helper_file"
 
 module Rambo
   class DocumentGenerator
     attr_accessor :file, :raml, :options
 
+    class << self
+      def generate!(file, options={})
+        generator = new(file, options)
+        generator.generate_spec_dir!
+        generator.generate_matcher_dir!
+        generator.generate_examples!
+        generator.generate_spec_file!
+        generator.generate_rambo_helper!
+        generator.generate_matchers!
+      end
+    end
+
     def initialize(file, options={})
       @file    = file
       @raml    = Raml::Parser.parse_file(file)

data/lib/rambo/rake.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/rake/**/*.rb"].each {|file| require file }

data/lib/rambo/rake/task.rb

@@ -0,0 +1,30 @@
+lib = File.expand_path("../../..", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "rake"
+require "yaml"
+require "colorize"
+require "rambo"
+
+module Rambo
+  module Rake
+    class Task
+      include ::Rake::DSL
+
+      def initialize
+        define_task
+      end
+
+      private
+
+      def define_task
+        desc "Generate contract tests"
+        task :rambo do
+          Rambo.generate_contract_tests!
+
+          puts "Done generating contract tests.".green
+        end
+      end
+    end
+  end
+end

data/lib/{rspec → rambo/rspec}/example_group.rb

@@ -8,7 +8,7 @@ module Rambo
 
       def initialize(resource, options={})
         @resource = resource
-        @options  = options
+        @options  = options || { rails: true }
       end
 
       def template

data/lib/{rspec → rambo/rspec}/examples.rb

@@ -1,11 +1,11 @@
-require "rspec/example_group"
+require "rambo/rspec/example_group"
 
 module Rambo
   module RSpec
     class Examples
       attr_reader :raml, :resources, :examples, :options
 
-      def initialize(raml, options={})
+      def initialize(raml, options=nil)
         @raml    = raml
         @options = options
       end

data/lib/{rspec → rambo/rspec}/spec_file.rb

@@ -1,8 +1,8 @@
 require 'erb'
 require 'raml'
 
-require "rspec/examples"
-require "raml_models"
+require "rambo/rspec/examples"
+require "rambo/raml_models"
 
 module Rambo
   module RSpec

data/lib/version.rb

@@ -1,6 +1,6 @@
 module Rambo
   MAJOR = '0'
-  MINOR = '1'
+  MINOR = '2'
   PATCH = '0'
 
   def self.version

data/rambo_ruby.gemspec

@@ -1,7 +1,5 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "version"
+require File.expand_path "../lib/version.rb", __FILE__
 
 Gem::Specification.new do |s|
   s.name        = "rambo_ruby"
@@ -16,14 +14,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rspec", "~> 3.4"
   s.add_dependency "raml-rb", "~> 0.0.6"
-  s.add_dependency "rack-test", "~> 0.6"
   s.add_dependency "colorize", "~> 0.7"
-  s.add_dependency "json_test_data", "~> 1.0"
+  s.add_dependency "json_test_data", "~> 1.1", ">= 1.1.1"
   s.add_dependency "json-schema", "~> 2.6"
+  s.add_dependency "rake", "~> 11.0"
 
   s.add_development_dependency "cucumber", "~> 2.1"
   s.add_development_dependency "json", "~> 1.7"
-  s.add_development_dependency "rake", "~> 11.0"
   s.add_development_dependency "coveralls", "~> 0.7"
   s.add_development_dependency "aruba", "~> 0.13"
 

data/spec/lib/{cli_spec.rb → rambo/cli_spec.rb}

@@ -2,7 +2,7 @@ RSpec.describe Rambo::CLI do
   let(:io)         { StringIO.new }
   let(:stderr)     { StringIO.new }
   let(:opts)       { { rails: true } }
-  let(:valid_file) { File.expand_path('../../support/foobar.raml', __FILE__) }
+  let(:valid_file) { File.join(SPEC_DIR_ROOT, 'support/foobar.raml',) }
 
   describe "run!" do
     let(:cli) { Rambo::CLI.new(valid_file, opts, io, stderr) }

data/spec/lib/{document_generator_spec.rb → rambo/document_generator_spec.rb}

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::DocumentGenerator do
-  let(:valid_file) { File.expand_path('../../support/foobar.raml', __FILE__) }
+  let(:valid_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
   let(:options) { { rails: true } }
   let(:generator) { Rambo::DocumentGenerator.new(valid_file, options) }
 
@@ -7,6 +7,47 @@ RSpec.describe Rambo::DocumentGenerator do
     allow_any_instance_of(Rambo::DocumentGenerator).to receive(:extract_raml)
   end
 
+  describe ".generate!" do
+    before(:each) do
+      allow_any_instance_of(described_class).to receive(:generate_matchers!)
+      allow_any_instance_of(described_class).to receive(:generate_spec_dir!)
+      allow_any_instance_of(described_class).to receive(:generate_spec_file!)
+      allow_any_instance_of(described_class).to receive(:generate_matcher_dir!)
+      allow_any_instance_of(described_class).to receive(:generate_rambo_helper!)
+      allow_any_instance_of(described_class).to receive(:generate_examples!)
+    end
+
+    it "generates a spec directory" do
+      expect_any_instance_of(described_class).to receive(:generate_spec_dir!)
+      described_class.generate!(valid_file, options)
+    end
+
+    it "generates the Rambo helper" do
+      expect_any_instance_of(described_class).to receive(:generate_rambo_helper!)
+      described_class.generate!(valid_file, options)
+    end
+
+    it "generates the matcher directory" do
+      expect_any_instance_of(described_class).to receive(:generate_matcher_dir!)
+      described_class.generate!(valid_file, options)
+    end
+
+    it "generates the matchers" do
+      expect_any_instance_of(described_class).to receive(:generate_matchers!)
+      described_class.generate!(valid_file, options)
+    end
+
+    it "generates the examples" do
+      expect_any_instance_of(described_class).to receive(:generate_examples!)
+      described_class.generate!(valid_file, options)
+    end
+
+    it "generates a spec file" do
+      expect_any_instance_of(described_class).to receive(:generate_spec_file!)
+      described_class.generate!(valid_file, options)
+    end
+  end
+
   describe "#generate_spec_dir!" do
     it "generates the spec/contract directory" do
       expect(FileUtils).to receive(:mkdir_p).with("spec/contract/output")
@@ -20,7 +61,7 @@ RSpec.describe Rambo::DocumentGenerator do
         expect_any_instance_of(Rambo::RSpec::HelperFile)
           .to receive(:initialize)
           .with({
-            :template_path => File.expand_path("lib/rspec/templates/rambo_helper_file_template.erb"),
+            :template_path => File.join(RAMBO_ROOT, "rambo/rspec/templates/rambo_helper_file_template.erb"),
             :file_path     => "spec/rambo_helper.rb"
           })
         expect_any_instance_of(Rambo::RSpec::HelperFile).to receive(:generate)
@@ -55,7 +96,7 @@ RSpec.describe Rambo::DocumentGenerator do
         expect_any_instance_of(Rambo::RSpec::HelperFile)
           .to receive(:initialize)
           .with(
-            template_path: File.expand_path("lib/rspec/templates/matcher_file_template.erb"),
+            template_path: File.join(RAMBO_ROOT, "rambo/rspec/templates/matcher_file_template.erb"),
             file_path: "spec/support/matchers/rambo_matchers.rb"
           )
         expect_any_instance_of(Rambo::RSpec::HelperFile).to receive(:generate)

data/spec/lib/rambo/rake/task_spec.rb

@@ -0,0 +1,20 @@
+RSpec.describe Rambo::Rake::Task do
+  describe "#initialize" do
+    it "defines the task" do
+      expect_any_instance_of(Rambo::Rake::Task)
+        .to receive(:define_task)
+      described_class.new
+    end
+  end
+
+  describe "rambo task" do
+    before(:each) do
+      Rambo::Rake::Task.new
+    end
+
+    it "calls generate_contract_tests!" do
+      expect(Rambo).to receive(:generate_contract_tests!)
+      Rake::Task[:rambo].invoke
+    end
+  end
+end

data/spec/lib/{raml_models → rambo/raml_models}/api_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RamlModels::Api do
-  let(:raml_file) { File.expand_path("../../../support/multiple_resources.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/multiple_resources.raml") }
   let(:raml)      { Raml::Parser.parse_file(raml_file) }
 
   subject { described_class.new(raml) }

data/spec/lib/{raml_models → rambo/raml_models}/body_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Rambo::RamlModels::Body do
   subject { described_class.new(body) }
 
   describe "#content_type" do
-    let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+    let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
 
     it "returns the content type" do
       expect(subject.content_type).to eql body.content_type
@@ -14,7 +14,7 @@ RSpec.describe Rambo::RamlModels::Body do
 
   describe "#example" do
     context "when an example is given" do
-      let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+      let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
 
       it "returns an example" do
         expect(subject.example).to eql body.example
@@ -22,7 +22,7 @@ RSpec.describe Rambo::RamlModels::Body do
     end
 
     context "when a schema is given" do
-      let(:raml_file) { File.expand_path("../../../../features/support/examples/raml/basic_raml_with_schema.raml", __FILE__) }
+      let(:raml_file) { File.join(SPEC_DIR_ROOT, "../features/support/examples/raml/basic_raml_with_schema.raml") }
 
       it "returns generated JSON data" do
         expect(JSON.parse(subject.example)).to have_key "data"

data/spec/lib/{raml_models → rambo/raml_models}/headers_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Rambo::RamlModels::Headers do
   let(:raml) { Raml::Parser.parse_file(raml_file) }
-  let(:raml_file) { File.expand_path("../../../support/post_with_request_headers.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/post_with_request_headers.raml") }
   let(:headers) { raml.resources.first.methods.first.headers }
 
   subject { described_class.new(headers) }

data/spec/lib/{raml_models → rambo/raml_models}/method_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RamlModels::Method do
-  let(:raml_file) { File.expand_path("../../../support/foo.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foo.raml") }
   let(:raml) { Raml::Parser.parse_file(raml_file) }
   let(:method) { raml.resources.first.methods.first }
 

data/spec/lib/{raml_models → rambo/raml_models}/resource_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RamlModels::Resource do
-  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
   let(:raml) { Raml::Parser.parse_file(raml_file) }
   let(:resource) { raml.resources.first }
 

data/spec/lib/{raml_models → rambo/raml_models}/response_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RamlModels::Response do
-  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
   let(:raml) { Raml::Parser.parse_file(raml_file) }
   let(:response) { raml.resources.first.methods.first.responses.first }
 

data/spec/lib/{rspec → rambo/rspec}/example_group_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RSpec::ExampleGroup do
-  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "/support/foobar.raml") }
   let(:raml)      { Raml::Parser.parse_file(raml_file) }
   let(:resource)  { Rambo::RamlModels::Resource.new(raml.resources.first) }
   let(:options)   { { rails: true } }
@@ -31,7 +31,7 @@ RSpec.describe Rambo::RSpec::ExampleGroup do
     end
 
     context "when the route has a response schema" do
-      let(:raml_file) { File.expand_path("../../../support/basic_raml_with_post_route.raml", __FILE__) }
+      let(:raml_file) {File.join(SPEC_DIR_ROOT, "support/basic_raml_with_post_route.raml") }
 
       it "creates a response schema object" do
         aggregate_failures do
@@ -51,7 +51,7 @@ RSpec.describe Rambo::RSpec::ExampleGroup do
     end
 
     context "when the route has a request body" do
-      let(:raml_file) { File.expand_path("../../../support/basic_raml_with_post_route.raml", __FILE__) }
+      let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/basic_raml_with_post_route.raml") }
 
       it "adds a request body" do
         expect(subject.render).to include("let(:request_body) do")
@@ -63,7 +63,7 @@ RSpec.describe Rambo::RSpec::ExampleGroup do
     end
 
     context "when the route has request headers" do
-      let(:raml_file) { File.expand_path("../../../support/post_with_request_headers.raml", __FILE__) }
+      let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/post_with_request_headers.raml") }
 
       it "adds headers" do
         expect(subject.render).to include("let(:headers) do")

data/spec/lib/{rspec → rambo/rspec}/examples_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Rambo::RSpec::Examples do
-  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
   let(:raw_raml)  { Raml::Parser.parse_file(raml_file) }
   let(:options)   { { rails: true } }
   let(:raml)      { Rambo::RamlModels::Api.new(raw_raml) }

data/spec/lib/{rspec → rambo/rspec}/helper_file_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe Rambo::RSpec::HelperFile do
   let(:template_path) {
-    File.expand_path("lib/rspec/templates/matcher_file_template.erb")
+    File.join(RAMBO_ROOT, "rambo/rspec/templates/matcher_file_template.erb")
   }
 
   let(:file_path) {
-    File.expand_path("spec/support/matchers/rambo_matchers.rb")
+    File.join(SPEC_DIR_ROOT, "support/matchers/rambo_matchers.rb")
   }
 
   subject { described_class.new(template_path: template_path, file_path: file_path) }

data/spec/lib/{rspec → rambo/rspec}/spec_file_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Rambo::RSpec::SpecFile do
   end
 
   context "file with examples" do
-    let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+    let(:raml_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
 
     describe "#initialize" do
       it "assigns @raml" do
@@ -40,7 +40,7 @@ RSpec.describe Rambo::RSpec::SpecFile do
 
   context "file with schema" do
     let(:raml_file) do
-      File.expand_path("../../../../features/support/examples/raml/basic_raml_with_schema.raml", __FILE__)
+      File.join(RAMBO_ROOT, "../features/support/examples/raml/basic_raml_with_schema.raml")
     end
 
     describe "#initialize" do

data/spec/lib/rambo_spec.rb

@@ -0,0 +1,55 @@
+RSpec.describe Rambo do
+  let(:file_contents) do
+    <<-EOF
+raml: doc/raml/foobar.raml
+rails: false
+    EOF
+  end
+
+  describe ".generate_contract_tests!" do
+    let(:valid_file)      { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
+    let(:default_options) { { rails: true } }
+
+    before(:each) do
+      allow(Dir).to receive(:foreach).and_return(valid_file)
+    end
+
+    context "in all cases" do
+      it "generates documents" do
+        expect(Rambo::DocumentGenerator).to receive(:generate!).with(valid_file, default_options)
+        Rambo.generate_contract_tests!(valid_file, default_options)
+      end
+    end
+
+    context "when there is a .rambo.yml file" do
+      before(:each) do
+        allow(Rambo::DocumentGenerator).to receive(:generate!)
+
+        allow(File)
+          .to receive(:read)
+          .with(File.expand_path(".rambo.yml"))
+          .and_return(file_contents)
+      end
+
+      it "reads from the file" do
+        expect(File).to receive(:read).with(File.expand_path(".rambo.yml"))
+        Rambo.generate_contract_tests!
+      end
+
+      it "sets the RAML file to the one from the file" do
+        expect(Rambo::DocumentGenerator)
+          .to receive(:generate!)
+          .with(File.expand_path("doc/raml/foobar.raml"), { "raml" => File.expand_path("doc/raml/foobar.raml"), "rails" => false })
+
+        Rambo.generate_contract_tests!
+      end
+    end
+
+    context "when there is no .rambo.yml file" do
+      it "uses default options" do
+        expect(Rambo::DocumentGenerator).to receive(:generate!).with(valid_file, default_options)
+        Rambo.generate_contract_tests!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,10 +10,10 @@ require "raml-rb"
 require "json_test_data"
 require "fileutils"
 
-lib = File.expand_path("../../lib", __FILE__)
 SPEC_DIR_ROOT = File.expand_path("../", __FILE__)
-
-Dir.foreach("#{lib}")   {|f| require f if f.match(/.*\.rb\z/) }
+RAMBO_ROOT =  File.expand_path("../../lib", __FILE__)
+lib = File.expand_path(File.join(RAMBO_ROOT, "**/*.rb"))
+Dir[lib].each {|f| require f }
 
 RSpec.configure do |c|
   c.disable_monkey_patching!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rambo_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dana Scheider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.6
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -95,47 +87,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: '11.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -208,38 +200,43 @@ files:
 - features/support/examples/rspec/spec_helper_only_rack_test.rb.example
 - features/support/examples/rspec/spec_helper_rack_test_added.rb.example
 - features/support/foobar.raml
-- lib/cli.rb
-- lib/document_generator.rb
-- lib/raml_models.rb
-- lib/raml_models/api.rb
-- lib/raml_models/body.rb
-- lib/raml_models/headers.rb
-- lib/raml_models/method.rb
-- lib/raml_models/resource.rb
-- lib/raml_models/response.rb
-- lib/rspec.rb
-- lib/rspec/example_group.rb
-- lib/rspec/examples.rb
-- lib/rspec/helper_file.rb
-- lib/rspec/spec_file.rb
-- lib/rspec/templates/example_group_template.erb
-- lib/rspec/templates/matcher_file_template.erb
-- lib/rspec/templates/rambo_helper_file_template.erb
-- lib/rspec/templates/spec_file_template.erb
+- lib/rambo.rb
+- lib/rambo/cli.rb
+- lib/rambo/document_generator.rb
+- lib/rambo/rake.rb
+- lib/rambo/rake/task.rb
+- lib/rambo/raml_models.rb
+- lib/rambo/raml_models/api.rb
+- lib/rambo/raml_models/body.rb
+- lib/rambo/raml_models/headers.rb
+- lib/rambo/raml_models/method.rb
+- lib/rambo/raml_models/resource.rb
+- lib/rambo/raml_models/response.rb
+- lib/rambo/rspec.rb
+- lib/rambo/rspec/example_group.rb
+- lib/rambo/rspec/examples.rb
+- lib/rambo/rspec/helper_file.rb
+- lib/rambo/rspec/spec_file.rb
+- lib/rambo/rspec/templates/example_group_template.erb
+- lib/rambo/rspec/templates/matcher_file_template.erb
+- lib/rambo/rspec/templates/rambo_helper_file_template.erb
+- lib/rambo/rspec/templates/spec_file_template.erb
 - lib/version.rb
 - rambo_ruby.gemspec
-- spec/lib/cli_spec.rb
-- spec/lib/document_generator_spec.rb
-- spec/lib/raml_models/api_spec.rb
-- spec/lib/raml_models/body_spec.rb
-- spec/lib/raml_models/headers_spec.rb
-- spec/lib/raml_models/method_spec.rb
-- spec/lib/raml_models/resource_spec.rb
-- spec/lib/raml_models/response_spec.rb
-- spec/lib/rspec/example_group_spec.rb
-- spec/lib/rspec/examples_spec.rb
-- spec/lib/rspec/helper_file_spec.rb
-- spec/lib/rspec/spec_file_spec.rb
+- spec/lib/rambo/cli_spec.rb
+- spec/lib/rambo/document_generator_spec.rb
+- spec/lib/rambo/rake/task_spec.rb
+- spec/lib/rambo/raml_models/api_spec.rb
+- spec/lib/rambo/raml_models/body_spec.rb
+- spec/lib/rambo/raml_models/headers_spec.rb
+- spec/lib/rambo/raml_models/method_spec.rb
+- spec/lib/rambo/raml_models/resource_spec.rb
+- spec/lib/rambo/raml_models/response_spec.rb
+- spec/lib/rambo/rspec/example_group_spec.rb
+- spec/lib/rambo/rspec/examples_spec.rb
+- spec/lib/rambo/rspec/helper_file_spec.rb
+- spec/lib/rambo/rspec/spec_file_spec.rb
+- spec/lib/rambo_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_raml_with_post_route.raml
 - spec/support/foo.raml
@@ -268,10 +265,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: rambo_ruby-0.1.0
+summary: rambo_ruby-0.2.0
 test_files:
 - features/create_files.feature
 - features/error_modes.feature
@@ -300,18 +297,20 @@ test_files:
 - features/support/examples/rspec/spec_helper_only_rack_test.rb.example
 - features/support/examples/rspec/spec_helper_rack_test_added.rb.example
 - features/support/foobar.raml
-- spec/lib/cli_spec.rb
-- spec/lib/document_generator_spec.rb
-- spec/lib/raml_models/api_spec.rb
-- spec/lib/raml_models/body_spec.rb
-- spec/lib/raml_models/headers_spec.rb
-- spec/lib/raml_models/method_spec.rb
-- spec/lib/raml_models/resource_spec.rb
-- spec/lib/raml_models/response_spec.rb
-- spec/lib/rspec/example_group_spec.rb
-- spec/lib/rspec/examples_spec.rb
-- spec/lib/rspec/helper_file_spec.rb
-- spec/lib/rspec/spec_file_spec.rb
+- spec/lib/rambo/cli_spec.rb
+- spec/lib/rambo/document_generator_spec.rb
+- spec/lib/rambo/rake/task_spec.rb
+- spec/lib/rambo/raml_models/api_spec.rb
+- spec/lib/rambo/raml_models/body_spec.rb
+- spec/lib/rambo/raml_models/headers_spec.rb
+- spec/lib/rambo/raml_models/method_spec.rb
+- spec/lib/rambo/raml_models/resource_spec.rb
+- spec/lib/rambo/raml_models/response_spec.rb
+- spec/lib/rambo/rspec/example_group_spec.rb
+- spec/lib/rambo/rspec/examples_spec.rb
+- spec/lib/rambo/rspec/helper_file_spec.rb
+- spec/lib/rambo/rspec/spec_file_spec.rb
+- spec/lib/rambo_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_raml_with_post_route.raml
 - spec/support/foo.raml
@@ -319,3 +318,4 @@ test_files:
 - spec/support/foobar.yml
 - spec/support/multiple_resources.raml
 - spec/support/post_with_request_headers.raml
+has_rdoc: