rspec-rabl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9a36cec71cf30a760be8e02f5ce12fbb6659040
+  data.tar.gz: 4ad2e2335d3b9be558e549a3047b836b70ccf724
+SHA512:
+  metadata.gz: e9c0e11a4ea868b5a3aca341cae622e4e8ba930aa7709241e9af0050579db94cb10161ad344f3dc1863a10fd5a4cd98f485c3b92a40d301462a8f7ea6c8b2efb
+  data.tar.gz: 0ece30ab3bcbffb037e1cb4825daf3800febbb2dac3296a586fad162a462683e94b9b15f15309f749f4dadeb2314ee11b15d80e3897ecd679879acee224bea3e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - jruby-head
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_rabl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Ries
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+[![Build Status](https://travis-ci.org/mmmries/rspec_rabl.svg?branch=master)](https://travis-ci.org/mmmries/rspec_rabl)
+[![Code Climate](https://codeclimate.com/github/mmmries/rspec_rabl/badges/gpa.svg)](https://codeclimate.com/github/mmmries/rspec_rabl)
+[![Dependency Status](https://gemnasium.com/mmmries/rspec_rabl.svg)](https://gemnasium.com/mmmries/rspec_rabl)
+
+# RspecRabl
+
+A collection of convenient helpers for writing view specs with rabl templates.
+
+## Update Notes
+
+If you were previously using the `rspec_rabl` gem please note that you will need to fix a few things in order to upgrade to the latest version:
+
+* change your Gemfile to require `rspec-rabl` (a hyphen instead of an underscore see #8 for more details)
+* in spec\_helper.rb you need to require `rspec/rabl` instead of `rspec_rabl`
+* if you are using rails and you want the default configuration you will need to require `rspec/rabl/rails` instead of `rspec/rails_rabl`
+
+## Usage
+
+First make sure you configure rspec-rabl in your spec\_helper.rb file (see Configuration below).
+
+Now your templates can be rendered with whatever data you like for testing:
+
+```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)
+
+  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 { expect(subject).to render_attribute(:amount) }                        # parsed_json['budget']['amount'] == budget.amount
+  it { expect(subject).to render_attribute(:amount).with(:friendly_amount) } # parsed_json['budget']['amount'] == budget.friendly_amount
+  it { expect(subject).to 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 { expect(subject).to render_attribute(:amount) }                       # parsed_json['budgets'].first['budget']['amount'] == budgets.first.amount
+end
+```
+
+If you don't want to specify the template you are testing via the describe/context string you can specify the template like this:
+
+```ruby
+describe "Users are rendered with the humorous attribute" do
+  rabl_template { "users/show.rabl" }
+  rabl_data(:root => 'user') { user }
+
+  specify { expect(subject).to render_attribute(:humorous).with_value("not really") }
+end
+```
+
+## Configuration
+
+The easiest way to configure this is simple
+
+```ruby
+require 'rspec/rabl/rails'
+```
+
+For more detailed configuration just look at that file to see what configurations it is making.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/rspec/rabl/attribute_matcher.rb

@@ -0,0 +1,96 @@
+module RSpec
+  module Rabl
+    class AttributeMatcher
+      def initialize(rendered_attribute, opts = {})
+        @rendered_attribute = rendered_attribute
+        @opts = opts
+      end
+
+      def description
+        "render the #{rendered_attribute} attribute"
+      end
+
+      def failure_message
+        "expected #{parsed} to render #{rendered_attribute} = #{expected_value}"
+      end
+
+      def matches?(subject)
+        @subject = subject
+        attribute_rendered? && rendered_value == expected_value
+      end
+
+      def with(model_attribute)
+        @model_attribute = model_attribute
+        self
+      end
+
+      def with_value(expected_value)
+        @expected_value = expected_value
+        self
+      end
+
+      private
+      attr_reader :rendered_attribute, :subject, :opts
+
+      def model_attribute
+        @model_attribute ||= rendered_attribute
+      end
+
+      def expected_value
+        @expected_value ||= get_attribute_from_rendered_object
+      end
+
+      def rendered_value
+        parsed_object[rendered_attribute.to_s]
+      end
+
+      def rendered_object
+        subject.object
+      end
+
+      def attribute_rendered?
+        parsed_object.has_key?(rendered_attribute.to_s)
+      end
+
+      def get_attribute_from_rendered_object
+        if collection?
+          rendered_object.first.public_send(model_attribute)
+        else
+          rendered_object.public_send(model_attribute)
+        end
+      end
+
+      def collection?
+        rendered_object.is_a?(Array)
+      end
+
+      def parsed_object
+        collection? ? parse_collection_object : parse_object
+      end
+
+      def parse_collection_object
+        data = parsed
+        if opts[:root]
+          data = data.fetch(opts[:root]){ raise ::RSpec::Rabl::Error.new("Missing Root #{opts[:root]}") }
+        end
+        data = data.first
+        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
+        if opts[:root]
+          parsed.fetch(opts[:root]){ raise ::RSpec::Rabl::Error.new("Missing Object Root") }
+        else
+          parsed
+        end
+      end
+
+      def parsed
+        @parsed ||= JSON.parse(subject.render)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module RSpec
+  module Rabl
+    module ExampleGroup
+      def parsed_json
+        JSON.parse(rendered_template)
+      end
+
+      def rendered_template
+        renderer.render
+      end
+
+      def renderer
+        @renderer ||= ::Rabl::Renderer.new(
+          _rabl_template.gsub('.rabl',''),
+          _rabl_data,
+          :view_path => _rabl_config[:view_paths],
+        )
+      end
+
+      def subject
+        renderer
+      end
+
+      private
+      def _rabl_config
+        RSpec.configuration.rabl_configuration
+      end
+
+      def _rabl_data
+        nil
+      end
+
+      def _rabl_opts
+        {}
+      end
+
+      def _rabl_template
+        RSpec.current_example.metadata[:example_group][:description]
+      end
+    end
+  end
+end

data/lib/rspec/rabl/helpers.rb

@@ -0,0 +1,22 @@
+module RSpec
+  module Rabl
+    module Helpers
+      def rabl_data(opts = {},&block)
+        let(:_rabl_opts){ opts }
+        let(:_rabl_data, &block)
+      end
+
+      def rabl_template(&block)
+        let(:_rabl_template, &block)
+      end
+
+      def view_path(relative_path)
+        let(:_view_path) { relative_path }
+      end
+
+      def rabl_config(local_config)
+        let(:_rabl_config) { RSpec.configuration.rabl_configuration.merge(local_config) }
+      end
+    end
+  end
+end

data/lib/rspec/rabl/matchers.rb

@@ -0,0 +1,9 @@
+module RSpec
+  module Rabl
+    module Matchers
+      def render_attribute(attribute)
+        AttributeMatcher.new(attribute, _rabl_opts)
+      end
+    end
+  end
+end

data/lib/rspec/rabl/rails.rb

@@ -0,0 +1,6 @@
+::RSpec.configure do |config|
+  config.include ::RSpec::Rabl::Matchers, :file_path => %r(spec/views)
+  config.include ::RSpec::Rabl::ExampleGroup, :file_path => %r(spec/views)
+  config.rabl_configuration = {:view_paths => ['app/views']}
+  config.extend ::RSpec::Rabl::Helpers
+end

data/lib/rspec/rabl/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Rabl
+    VERSION = "1.0.0"
+  end
+end

data/lib/rspec/rabl.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require "rspec/rabl/version"
+require "rspec/rabl/error"
+
+# helpers to access the rendered template and parsed template
+require 'rspec/rabl/example_group'
+# helpers that can be called outside an it block to configure data and settings
+require 'rspec/rabl/helpers'
+# custom matchers
+require 'rspec/rabl/attribute_matcher'
+# helpers for invoking the custom matchers
+require 'rspec/rabl/matchers'
+
+RSpec.configure do |c|
+  c.add_setting :rabl_configuration
+  c.include RSpec::Rabl::Matchers
+end

data/rspec-rabl.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/rabl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-rabl"
+  spec.version       = RSpec::Rabl::VERSION
+  spec.authors       = ["Michael Ries"]
+  spec.email         = ["michael@riesd.com"]
+  spec.description   = "Provides a more declarative form of view testing for users of rabl"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/mmmries/rspec_rabl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-nav"
+  spec.add_runtime_dependency "rspec" , "~> 3.0"
+  spec.add_runtime_dependency "rabl", "~> 0.9"
+end

data/spec/fixtures/bare_index.rabl

@@ -0,0 +1,2 @@
+collection @users, :root => false, :object_root => false
+extends "user"

data/spec/fixtures/index.rabl

@@ -0,0 +1,2 @@
+collection @users, :root => 'users', :object_root => 'user'
+extends "user"

data/spec/fixtures/nested/test.rabl

@@ -0,0 +1,2 @@
+object @user => :test
+attributes :guid

data/spec/fixtures/rootless_index.rabl

@@ -0,0 +1,2 @@
+collection @users, :root => false, :object_root => 'user'
+extends "user"

data/spec/fixtures/user.rabl

@@ -0,0 +1,5 @@
+object @user => :user
+attributes  :guid,
+            :first_name,
+            :last_name,
+            :email

data/spec/fixtures/user_aliases.rabl

@@ -0,0 +1,3 @@
+object @user => :user
+attributes  :guid => :id
+node(:team){ 'Gorby Puff' }

data/spec/functional/custom_matchers_spec.rb

@@ -0,0 +1,62 @@
+describe "Customer Matchers" do
+  include_context "user_context"
+
+  describe "user.rabl" do
+    rabl_data(:root => 'user'){ user }
+    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{ 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{ 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{ 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{ 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{ expect(subject).to render_attribute(:guid) }
+  end
+end

data/spec/functional/render_object_spec.rb

@@ -0,0 +1,29 @@
+describe "User Views" do
+  include_context "user_context"
+  rabl_data{ user }
+
+  describe "user.rabl" do
+    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 "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
+
+  describe "test.rabl" do
+    rabl_config( {:view_paths => 'spec/fixtures/nested'} )
+
+    it "should allow us to override the Rabl config" do
+      expect(parsed_json).to eq({'test' => {'guid' => user.guid}})
+    end
+  end
+end

data/spec/functional/shared_examples_spec.rb

@@ -0,0 +1,11 @@
+require 'support/full_name_renderer_examples'
+
+RSpec.describe "using shared examples" do
+  include_context "user_context"
+  rabl_template { "user.rabl" }
+  rabl_data(:root => 'user'){ user }
+
+  include_examples "full name renderer"
+  it_behaves_like "full name renderer"
+  it_should_behave_like "full name renderer"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'json'
+require 'pry-nav'
+require 'rabl'
+require 'rspec'
+require 'rspec/rabl'
+
+require 'support/user_context'
+
+RSpec.configure do |c|
+  c.order = :rand
+  c.include RSpec::Rabl::ExampleGroup
+  c.rabl_configuration = {:view_paths => 'spec/fixtures'}
+end
+
+include RSpec::Rabl::Helpers

data/spec/support/full_name_renderer_examples.rb

@@ -0,0 +1,4 @@
+shared_examples "full name renderer" do
+  it { should render_attribute(:first_name) }
+  it { should render_attribute(:last_name) }
+end

data/spec/support/user_context.rb

@@ -0,0 +1,9 @@
+shared_context "user_context" do
+  let(:user){ double('user',
+    guid: 'abc',
+    first_name: 'gob',
+    last_name: 'bluth',
+    email: 'gob@bluth.com',
+    password: 'very secret',
+  )}
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rabl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Ries
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/rabl.rb
+- 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
+- lib/rspec/rabl/rails.rb
+- lib/rspec/rabl/version.rb
+- rspec-rabl.gemspec
+- spec/fixtures/bare_index.rabl
+- spec/fixtures/index.rabl
+- spec/fixtures/nested/test.rabl
+- spec/fixtures/rootless_index.rabl
+- spec/fixtures/user.rabl
+- spec/fixtures/user_aliases.rabl
+- spec/functional/custom_matchers_spec.rb
+- spec/functional/render_object_spec.rb
+- spec/functional/shared_examples_spec.rb
+- spec/spec_helper.rb
+- spec/support/full_name_renderer_examples.rb
+- spec/support/user_context.rb
+homepage: https://github.com/mmmries/rspec_rabl
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Provides a more declarative form of view testing for users of rabl
+test_files:
+- spec/fixtures/bare_index.rabl
+- spec/fixtures/index.rabl
+- spec/fixtures/nested/test.rabl
+- spec/fixtures/rootless_index.rabl
+- spec/fixtures/user.rabl
+- spec/fixtures/user_aliases.rabl
+- spec/functional/custom_matchers_spec.rb
+- spec/functional/render_object_spec.rb
+- spec/functional/shared_examples_spec.rb
+- spec/spec_helper.rb
+- spec/support/full_name_renderer_examples.rb
+- spec/support/user_context.rb