rspec_rabl 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fde63cce810cb15be320f70d85ed90b9b341834
-  data.tar.gz: b82e65fbea0f00f17978fccc1fadd9303f5e105b
+  metadata.gz: 0eb7b0f70a6a7a7667d50e4aa5de113475d21cc4
+  data.tar.gz: ac565a1fe7f0c7faa5eae3133a4e92853e9a6cd9
 SHA512:
-  metadata.gz: d90331737609848be50b7986d3a5ebb572762abbb60dc5d3809b62b03ede36683941ef33f51f8bd178e9db28bfce1718c3ccb2e22f79d2be959a1f6013e67a84
-  data.tar.gz: 3b94f096140eeb449a97a68f66158a15fd4e1c2557864f1fa155353dcc56ac5a3b7102d2c9fd013809f0b1a8c37d22d12deb40750172c613e8cb7bfd6a506b3e
+  metadata.gz: 27f25bff886dabb8d0d97661d5153f996da602c5be13428469e016a6798ced1cdf3c8b5b423222c846a396d22efc1cf8b45540d6dfe01438370de9797fba9734
+  data.tar.gz: 53f7c59978e2270fff20a2e2fd1a82b69f1ac3112c8767f4fffcea0931c4fb24451431df2f37ad7debe67328dfbfa5a258a1e8003c3ecd12a85322b0253cf37f

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - jruby
+script:
+  - bundle exec rspec

data/README.md

@@ -1,6 +1,6 @@
 # RspecRabl
 
-TODO: Write a gem description
+A collection of convenient helpers for writing view specs with rabl templates.
 
 ## Installation
 
@@ -8,17 +8,58 @@ Add this line to your application's Gemfile:
 
     gem 'rspec_rabl'
 
-And then execute:
+## Usage
 
-    $ bundle
+First make sure you configure rspec\_rabl in your spec\_helper.rb file (see Configuration below).
 
-Or install it yourself as:
+Now your templates can be rendered with whatever data you like for testing:
 
-    $ gem install rspec_rabl
+```ruby
+describe "budgets/show/rabl" do                            # this tells us what template you want to test
+  let(:budget) { Budget.new }
+  rabl_data(:root => 'budget') { budget }                  # this tells us what data to use when rendering and what structure you expect the template to have (use root and object_root just like rabl)
 
-## Usage
+  it "renders valid json" do
+    expect {
+      JSON.parse(rendered_template)                        # rendered_template is the rendered string
+    }.not_to raise_error
+  end
+
+  it "renders the data in some specific way" do
+    expect(parsed_json['budget']['date']).to eq("1984")    # parsed_json is the parsed out version of the rendered string
+  end
+end
+```
+
+But most of the time you want to check some pretty common things like:
+
+```ruby
+describe "budgets/show.rabl" do
+  let(:budget) { Budget.new }
+  rabl_data(:root => 'budget') { budget }
+
+  it { should render_attribute(:amount) }                        # parsed_json['budget']['amount'] == budget.amount
+  it { should render_attribute(:amount).with(:friendly_amount) } # parsed_json['budget']['amount'] == budget.friendly_amount
+  it { should render_attribute(:amount).with_value("45.00") }    # parsed_json['budget']['amount'] == "45.00"
+end
+
+describe "budgets/index.rabl" do
+  let(:budgets) { [ Budget.new ] }
+  rabl_data(:root => 'budgets', :object_root => 'budget') { budgets }
+
+  it { should render_attribute(:amount) }                       # parsed_json['budgets'].first['budget']['amount'] == budgets.first.amount
+end
+```
+
+## Configuration
+
+The easiest way to configure this is simple
+
+```ruby
+require 'rspec/rails_rabl'
+```
 
-TODO: Write usage instructions here
+For more detailed configuration just look at that file to see what configurations it is making.
 
 ## Contributing
 

data/lib/rspec/rabl/attribute_matcher.rb

@@ -70,14 +70,22 @@ module RSpec
 
       def parse_collection_object
         data = parsed
-        data = data[opts[:root]] if opts[:root]
+        if opts[:root]
+          data = data.fetch(opts[:root]){ raise ::RSpec::Rabl::Error.new("Missing Root #{opts[:root]}") }
+        end
         data = data.first
-        data = data[opts[:object_root]] if opts[:object_root]
+        if opts[:object_root]
+          data = data.fetch(opts[:object_root]){ raise ::RSpec::Rabl::Error.new("Missing Object Root #{opts[:object_root]}") }
+        end
         data
       end
 
       def parse_object
-        opts[:root] ? parsed[opts[:root]] : parsed
+        if opts[:root]
+          parsed.fetch(opts[:root]){ raise ::RSpec::Rabl::Error.new("Missing Object Root") }
+        else
+          parsed
+        end
       end
 
       def parsed

data/lib/rspec/rabl/error.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Rabl
+    class Error < ::RuntimeError
+
+    end
+  end
+end

data/lib/rspec/rabl/example_group.rb

@@ -35,7 +35,7 @@ module RSpec
       end
 
       def _rabl_template
-        example.metadata[:example_group][:description]
+        RSpec.current_example.metadata[:example_group][:description]
       end
     end
   end

data/lib/rspec_rabl.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require "rspec_rabl/version"
+require "rspec/rabl/error"
 
 # helpers to access the rendered template and parsed template
 require 'rspec/rabl/example_group'

data/lib/rspec_rabl/version.rb

@@ -1,3 +1,3 @@
 module RspecRabl
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/rspec_rabl.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry-nav"
-  spec.add_runtime_dependency "rspec" , "~> 2.14"
+  spec.add_runtime_dependency "rspec" , ">= 2.14"
   spec.add_runtime_dependency "rabl", "~> 0.9"
 end

data/spec/functional/custom_matchers_spec.rb

@@ -5,42 +5,60 @@ describe "Customer Matchers" do
 
   describe "user.rabl" do
     rabl_data(:root => 'user'){ user }
-    it{ should render_attribute(:guid) }
-    it{ should render_attribute(:first_name) }
-    it{ should render_attribute(:last_name) }
-    it{ should render_attribute(:email) }
-    it{ should_not render_attribute(:password) }
+    it{ expect(subject).to render_attribute(:guid) }
+    it{ expect(subject).to render_attribute(:first_name) }
+    it{ expect(subject).to render_attribute(:last_name) }
+    it{ expect(subject).to render_attribute(:email) }
+    it{ expect(subject).to_not render_attribute(:password) }
   end
 
   describe "user_aliases.rabl" do
     rabl_data(:root => 'user'){ user }
-    it{ should render_attribute(:id).with(:guid) }
-    it{ should render_attribute(:team).with_value('Gorby Puff') }
+    it{ expect(subject).to render_attribute(:id).with(:guid) }
+    it{ expect(subject).to render_attribute(:team).with_value('Gorby Puff') }
   end
 
   describe "index.rabl" do
     rabl_data(:root => 'users', :object_root => 'user'){ [user] }
-    it{ should render_attribute(:guid) }
-    it{ should render_attribute(:first_name) }
-    it{ should render_attribute(:last_name) }
-    it{ should render_attribute(:email) }
-    it{ should_not render_attribute(:password) }
+    it{ expect(subject).to render_attribute(:guid) }
+    it{ expect(subject).to render_attribute(:first_name) }
+    it{ expect(subject).to render_attribute(:last_name) }
+    it{ expect(subject).to render_attribute(:email) }
+    it{ expect(subject).to_not render_attribute(:password) }
+  end
+
+  describe "index.rabl" do
+    rabl_data(:root => 'foobar'){ [user] }
+    it "gives an error specific for missing root" do
+      expect{
+        expect(subject).to render_attribute(:guid)
+      }.to raise_error(RSpec::Rabl::Error, /missing root/i)
+    end
+  end
+
+  describe "index.rabl" do
+    rabl_data(:root => 'users', :object_root => "player"){ [user] }
+    it "gives an error specific for incorrect object_root" do
+      expect{
+        expect(subject).to render_attribute(:guid)
+      }.to raise_error(RSpec::Rabl::Error, /missing object root/i)
+    end
   end
 
   describe "rootless_index.rabl" do
     rabl_data(:root => false, :object_root => 'user'){ [user] }
-    it{ should render_attribute(:guid) }
-    it{ should_not render_attribute(:password) }
+    it{ expect(subject).to render_attribute(:guid) }
+    it{ expect(subject).to_not render_attribute(:password) }
   end
 
   describe "bare_index.rabl" do
     rabl_data(:root => false, :object_root => false){ [user] }
-    it{ should render_attribute(:guid) }
-    it{ should_not render_attribute(:password) }
+    it{ expect(subject).to render_attribute(:guid) }
+    it{ expect(subject).to_not render_attribute(:password) }
   end
 
   describe "nested/test.rabl" do
     rabl_data(:root => 'test'){ user }
-    it{ should render_attribute(:guid) }
+    it{ expect(subject).to render_attribute(:guid) }
   end
 end

data/spec/functional/render_object_spec.rb

@@ -5,19 +5,19 @@ describe "User Views" do
   rabl_data{ user }
 
   describe "user.rabl" do
-    it "should make the rendered template available" do
-      rendered_template.should == '{"user":{"guid":"abc","first_name":"gob","last_name":"bluth","email":"gob@bluth.com"}}'
+    it "makes the rendered template available" do
+      expect(rendered_template).to eq '{"user":{"guid":"abc","first_name":"gob","last_name":"bluth","email":"gob@bluth.com"}}'
     end
 
-    it "should make the parsed template available" do
-      parsed_json.should == {
+    it "makes the parsed template available" do
+      expect(parsed_json).to eq({
         'user' => {
           'guid' => user.guid,
           'first_name' => user.first_name,
           'last_name' => user.last_name,
           'email' => user.email,
         }
-      }
+      })
     end
   end
 
@@ -25,7 +25,7 @@ describe "User Views" do
     rabl_config( {:view_paths => 'spec/fixtures/nested'} )
 
     it "should allow us to override the Rabl config" do
-      parsed_json.should == {'test' => {'guid' => user.guid}}
+      expect(parsed_json).to eq({'test' => {'guid' => user.guid}})
     end
   end
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rspec_rabl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Michael Ries
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry-nav
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rabl
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rabl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Provides a more declarative form of view testing for users of rabl
 email:
 - michael@riesd.com
@@ -87,12 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec/rabl/attribute_matcher.rb
+- lib/rspec/rabl/error.rb
 - lib/rspec/rabl/example_group.rb
 - lib/rspec/rabl/helpers.rb
 - lib/rspec/rabl/matchers.rb
@@ -114,24 +116,24 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: Provides a more declarative form of view testing for users of rabl
 test_files:
@@ -145,4 +147,3 @@ test_files:
 - spec/functional/render_object_spec.rb
 - spec/spec_helper.rb
 - spec/support/user_context.rb
-has_rdoc: