active_model_serializer-matchers 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 adman65
+
+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,52 @@
+# ActiveModelSerializer::Matchers
+
+RSpec Matchers for testing ActiveModel::Serializers
+
+This gem currently works with the **0.1.0** release. It will be updated
+for the next public release when that happens.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_model_serializer-matchers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_serializer-matchers
+
+## Usage
+
+Matchers are automatically included in all specs in `spec/serializers`.
+
+Here are some examples
+
+```ruby
+describe BlogPostSerializer do
+   it { should have_attribute(:title) }
+   it { should have_attribute(:text) }
+
+   it { should have_one(:author) }
+
+   it { should have_many(:comments) }
+   it { should have_many(:comments).as(:responses) }
+
+   it { should embed(:objects) }
+
+   it { should include_root }
+
+   it { should include_root(:blog_post) } # if you want to test the root is specifically set to a different value
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['-c']
+end
+
+task :default => :spec

data/active_model_serializers-matchers.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_model_serializers/matchers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["adman65"]
+  gem.email         = ["me@broadcastingadam.com"]
+  gem.description   = %q{RSpec matchers for ActiveModel::Serializers}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "active_model_serializer-matchers"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveModel::Serializers::Matchers::VERSION
+
+  gem.add_dependency "active_model_serializers", "~> 0.1.0"
+  gem.add_dependency "rspec", "~> 2.0"
+
+  gem.add_development_dependency "simplecov"
+end

data/lib/active_model_serializers-matchers.rb

@@ -0,0 +1,24 @@
+require 'active_model_serializers'
+
+module ActiveModel::Serializers::Matchers
+end
+
+require "active_model_serializers/matchers/version"
+require "active_model_serializers/matchers"
+
+module SerializerExampleGroup
+  extend ActiveSupport::Concern
+  include ActiveModel::Serializers::Matchers
+
+  included do
+    subject { described_class }
+
+    metadata[:type] = :serializer
+  end
+end
+
+RSpec.configure do |config|
+  config.include SerializerExampleGroup, :example_group => {
+    :file_path => /spec\/serializers/
+  }
+end

data/lib/active_model_serializers/matchers.rb

@@ -0,0 +1,185 @@
+module ActiveModel
+  module Serializers
+    module Matchers
+      class Root
+        attr_accessor :name, :actual
+
+        def initialize(name = true)
+          @name = name
+        end
+
+        def matches?(actual)
+          @actual = actual
+
+          serializer._root == name
+        end
+
+        def description
+          "have attribute #{name}"
+        end
+
+        def failure_message_for_should
+          %Q{expected "#{actual._root}" to be "#{name}", but it wasn't}
+        end
+
+        def failure_message_for_should_not
+          %Q{expected "#{actual._root}" to be "#{name}", but it was}
+        end
+
+        private
+        def serializer
+          if actual.is_a?(Class)
+            actual
+          else
+            actual.class
+          end
+        end
+      end
+
+      def include_root(key = nil)
+        Root.new key
+      end
+
+      class Embed
+        attr_accessor :expected, :actual
+
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+
+          serializer._embed == expected
+        end
+
+        def description
+          "embed #{name}"
+        end
+
+        def failure_message_for_should
+          %Q{expected "#{actual._embed}" to be "#{name}", but it wasn't}
+        end
+
+        def failure_message_for_should_not
+          %Q{expected "#{actual._embed}" to be "#{name}", but it was}
+        end
+
+        private
+        def serializer
+          if actual.is_a?(Class)
+            actual
+          else
+            actual.class
+          end
+        end
+      end
+
+      def embed(value)
+        Embed.new value
+      end
+
+      class HaveAttribute
+        attr_accessor :name, :actual
+
+        def initialize(name)
+          @name = name
+        end
+
+        def matches?(actual)
+          @actual = actual
+
+          attributes.has_key?(name)
+        end
+
+        def description
+          "have attribute #{name}"
+        end
+
+        def failure_message_for_should
+          %Q{expected #{actual.inspect} to include "#{name}", but it did not}
+        end
+
+        def failure_message_for_should_not
+          %Q{expected #{actual.inspect} to not include: "#{name}", but it did}
+        end
+
+        private
+        def serializer
+          if actual.is_a?(Class)
+            actual
+          else
+            actual.class
+          end
+        end
+
+        def attributes
+          serializer._attributes
+        end
+      end
+
+      def have_attribute(name)
+        HaveAttribute.new name
+      end
+
+      class AssociationMatcher
+        attr_accessor :name, :actual, :key
+
+        def initialize(name)
+          @name = name
+        end
+
+        def matches?(actual)
+          @actual = actual
+
+          matched_association = associations.select do |assc|
+            assc.name == name
+          end.first
+
+          return false unless matched_association
+
+          if key
+            return false if matched_association.key != key
+          end
+
+          true
+        end
+
+        def as(value)
+          self.key = value
+          self
+        end
+
+        def description
+          "have attribute #{name}"
+        end
+
+        def failure_message_for_should
+          %Q{expected #{actual.inspect} to include a "#{name}" association, but it did not}
+        end
+
+        def failure_message_for_should_not
+          %Q{expected #{actual.inspect} to not include a "#{name}" association, but it did}
+        end
+
+        private
+        def serializer
+          if actual.is_a?(Class)
+            actual
+          else
+            actual.class
+          end
+        end
+
+        def associations
+          serializer._associations
+        end
+      end
+
+      def have_many(name)
+        AssociationMatcher.new(name)
+      end
+      alias :have_one :have_many
+    end
+  end
+end

data/lib/active_model_serializers/matchers/version.rb

@@ -0,0 +1,7 @@
+module ActiveModel
+  module Serializers
+    module Matchers
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/active_model_serializers_matcher_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ActiveModel::Serializers::Matchers do
+  include ActiveModel::Serializers::Matchers
+
+  it "should be false if the serializer does not have an attribute" do
+    serializer = Class.new ActiveModel::Serializer do
+      attributes :foo
+    end
+
+    serializer.should_not have_attribute :bar
+    serializer.should have_attribute :foo
+  end
+
+  it "should match the embed setting" do
+    serializer = Class.new ActiveModel::Serializer do
+      embed :ids
+    end
+
+    serializer.should embed(:ids)
+    serializer.should_not embed(:objects)
+  end
+
+  describe "The root key" do
+    it "should match the root setting" do
+      serializer = Class.new ActiveModel::Serializer do
+
+      end
+
+      serializer.should include_root
+    end
+
+    it "should be able to match a specific key" do
+      serializer = Class.new ActiveModel::Serializer do
+        root :foo
+      end
+
+      serializer.should include_root(:foo)
+      serializer.should_not include_root(:bar)
+    end
+  end
+
+  describe "Associations" do
+    it "should work with has_many" do
+      serializer = Class.new ActiveModel::Serializer do
+        has_many :foos
+      end
+
+      serializer.should have_many(:foos)
+      serializer.should_not have_many(:bars)
+    end
+
+    it "should work with has_one" do
+      serializer = Class.new ActiveModel::Serializer do
+        has_one :foo
+      end
+
+      serializer.should have_one(:foo)
+      serializer.should_not have_one(:bar)
+    end
+
+    it "should work with has_one key options" do
+      serializer = Class.new ActiveModel::Serializer do
+        has_one :foo, :key => :bar
+      end
+
+      serializer.should have_one(:foo).as(:bar)
+      serializer.should have_one(:foo)
+      serializer.should_not have_one(:foo).as(:qux)
+    end
+
+    it "should work with has_many key options" do
+      serializer = Class.new ActiveModel::Serializer do
+        has_one :foos, :key => :bars
+      end
+
+      serializer.should have_one(:foos).as(:bars)
+      serializer.should have_one(:foos)
+      serializer.should_not have_one(:foos).as(:qux)
+    end
+  end
+end

data/spec/serializers/serializer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "Metadata" do
+  it "should be included for spec/serializers" do
+    example.metadata[:type].should == :serializer
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
+$: << File.expand_path("../../lib",  __FILE__)
+
+require "active_model_serializers-matchers"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: active_model_serializer-matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- adman65
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: &70209336318400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70209336318400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70209336317780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70209336317780
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70209336316600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70209336316600
+description: RSpec matchers for ActiveModel::Serializers
+email:
+- me@broadcastingadam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_model_serializers-matchers.gemspec
+- lib/active_model_serializers-matchers.rb
+- lib/active_model_serializers/matchers.rb
+- lib/active_model_serializers/matchers/version.rb
+- spec/active_model_serializers_matcher_spec.rb
+- spec/serializers/serializer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 849873857067692096
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 849873857067692096
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/active_model_serializers_matcher_spec.rb
+- spec/serializers/serializer_spec.rb
+- spec/spec_helper.rb