peppers-ghost 0.0.0 → 0.0.1.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c4990710319dbcc755fa8e9651b277ea26c94db
-  data.tar.gz: a39e7dca88220240fdd6be33c1210fc2baac987b
+  metadata.gz: fb4767e7fefac57d01e5c9e1bbde36cf7fb59870
+  data.tar.gz: badd39258d23e417c1f1a133d4056287b4f383e3
 SHA512:
-  metadata.gz: c2fda7ce252b9959861633268deb497e3b47c86efb73c93b796ee51eea3add569f0c2f17efb94e7e90c786bf7ac81697c52cc7d872f92be0291046e3ae2886db
-  data.tar.gz: 78a728fe87cd8f04015531f33343d6d0486e26dccecb1b617ac5385584d392b6cd818a87d110e7ad95e6c3a008fbb46987f071ea4d0f2520176b717e0c83d71e
+  metadata.gz: ee1667f92c9415f36181d25b8a6f1cc46ce9e472a51be55699e205f38caa1f0d241db565681facf3c27baea4fe0e5370a3610fb386a4cdf75f58c1cd340db99e
+  data.tar.gz: 2a61937f5bb389aa2a3ddc43cd5316c673834bcd6a36bff1f11ae447ab2019995ffd91af236a3567e45c7f0534027b166834b3166301f27f9088b28ad12435e4

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    peppers-ghost (0.0.0)
+    peppers-ghost (0.0.1)
       rspec
 
 GEM
   remote: http://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.4)
-    rspec-expectations (2.14.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.2)
+    rspec-mocks (2.13.1)
 
 PLATFORMS
   ruby

data/lib/peppers-ghost.rb

@@ -1,25 +1,14 @@
+require 'time'
+
+require 'uuidtools'
 require 'rspec'
 
 module PeppersGhost
 end
 
-require_relative 'peppers-ghost/core'
-
-require_relative 'peppers-ghost/ghost'
 require_relative 'peppers-ghost/ghost_factory'
-
-require_relative 'peppers-ghost/shared/json_context'
-require_relative 'peppers-ghost/shared/list_example'
-
 require_relative 'peppers-ghost/matchers'
-require_relative 'peppers-ghost/matchers/match_structure_of'
-require_relative 'peppers-ghost/matchers/match_resource'
-
-module PeppersGhost
-  extend PeppersGhost::GhostFactory
-end
 
 RSpec.configure do |config|
-  config.include PeppersGhost::Core
-  config.include PeppersGhost::Matchers
+  config.include PeppersGhost::Matchers, :json => true
 end

data/lib/peppers-ghost/ghost_factory.rb

@@ -1,21 +1,125 @@
 module PeppersGhost::GhostFactory
-  def define(&block)
+  def self.registry
+    @registry ||= Registry.new
+  end
+
+  class << self
+    delegate :find, to: :registry
+  end
+
+  def self.define(&block)
     instance_eval &block
   end
 
-  def ghost_for(resource)
-    ghosts[resource]
+  def self.reload
+    Dir[File.join(File.expand_path('spec/ghosts'), '**', '*.rb')].sort.each do |file|
+      load file
+    end
+  end
+
+  def self.resource(name, &block)
+    resource = Resource.new
+    resource.instance_eval(&block) if block_given?
+
+    registry.add_resource name, resource
+  end
+
+  class Registry
+    def initialize
+      @resources = {}
+    end
+
+    def add_resource(name, resource)
+      @resources[name] = resource
+    end
+
+    def find(name)
+      @resources[name]
+    end
+  end
+
+  class Resource
+    def initialize
+      @attributes = {}
+    end
+
+    def attribute_names
+      @attributes.keys
+    end
+
+    def attribute_definition_for(name)
+      @attributes[name]
+    end
+
+    def attribute(name, options={}, &block)
+      if block_given?
+        add_dynamic_attribute(name, options, &block)
+      else
+        add_implicit_attribute(name, options)
+      end
+    end
+
+    private
+
+    def add_dynamic_attribute(name, options={}, &block)
+      @attributes[name] = DynamicAttributeDefinition.new(name, options, block)
+    end
+
+    def add_implicit_attribute(name, options={})
+      @attributes[name] = ImplicitAttributeDefinition.new(name, options)
+    end
+
+    def method_missing(name, *args, &block)
+      attribute(name, *args, &block)
+    end
+  end
+
+  class AttributeDefinition
+    attr_reader :name, :resource
+
+    def initialize(name, options={})
+      @name = name
+      @resource = options[:resource]
+    end
+
+    private
+
+    def transform(value)
+      case value
+      when UUIDTools::UUID
+        value.to_s
+      when Date, Time
+        value.iso8601
+      else
+        value
+      end
+    end
   end
 
-  def ghost(name, &block)
-    ghost = PeppersGhost::Ghost.new
-    ghost.instance_eval &block
-    ghosts[name] = ghost
+  class ImplicitAttributeDefinition < AttributeDefinition
+    def evaluate(object)
+      if object.respond_to?(name)
+        transform object.send(name)
+      elsif object.is_a?(Hash)
+        transform(object[name.to_s] || object[name.to_sym])
+      end
+    end
   end
 
-  private
+  class DynamicAttributeDefinition < AttributeDefinition
+    def initialize(name, options={}, block)
+      super name, options
+      @block = block
+    end
 
-  def ghosts
-    @ghosts ||= {}
+    def evaluate(object)
+      transform object.instance_eval(&block)
+    end
+
+    private
+
+    attr_reader :block
   end
 end
+
+PeppersGhost::GhostFactory.reload

data/lib/peppers-ghost/matchers.rb

@@ -1,5 +1,160 @@
-module PeppersGhost
-  module Matchers
-    extend RSpec::Matchers::DSL
+module PeppersGhost::Matchers
+  def mirrors_ghost(json_resource, resource, type, strict = false)
+    mirrors_structure json_resource, type, 1
+    match_values json_resource, resource, type, strict
+  end
+
+  def mirrors_structure(json_resource, type, count = nil)
+    expect(json_resource).to_not eq(nil),
+      "Expected the #{type} to not be nil"
+
+    if json_resource.is_a?(Array)
+      match_array_structures json_resource, type, count
+    elsif !count.nil? and count != 1
+      expect(count).to eq(1),
+        "Got a singular resource, expected #{count} #{type.to_s.pluralize}"
+    else
+      match_individual_structure json_resource, type
+    end
+  end
+
+  def mirrors_many(json_resources, resources, type, strict = false)
+    check_resource_count json_resources, resources, type
+    json_resources.each_with_index do |json_resource, i|
+      mirrors_ghost json_resource, resources[i], type, strict
+    end
+  end
+
+  private
+
+  def match_values(json_resource, resource, type, strict = false)
+    attributes = attributes_for_resource(type)
+    json_resource = json_resource.first if json_resource.is_a?(Array)
+    match_attributes json_resource, resource, type, attributes, strict
+  end
+
+  def match_individual_structure(json_resource, type)
+    attributes = attributes_for_resource(type)
+    expect(json_resource.keys).to match_array attributes.map(&:to_s)
+    deep_structure json_resource, type
+  end
+
+  def match_array_structures(json_resources, type, count)
+    if count
+      expected_resource_count json_resources, count, type
+    end
+
+    json_resources.each do |json_resource|
+      mirrors_structure json_resource, type
+    end
+  end
+
+  def match_attributes(json_resource, resource, type, attributes, strict = false)
+    attributes.each do |attribute|
+      resource_doc = resource_doc_for(type)
+      definition = resource_doc.attribute_definition_for(attribute)
+
+      value = definition.evaluate(resource)
+      json_value = json_resource[attribute.to_s]
+
+      if definition.resource
+        deep_match json_value, value, definition
+      else
+        match_attribute json_value, value, type, attribute, strict
+      end
+    end
+  end
+
+  def deep_match(json_value, value, definition)
+    valid = false
+    if array?(definition)
+      valid = true if json_value.count > 0
+      mirrors_many json_value, value, definition.resource
+    else
+      expect(json_value).to_not be_an Array
+      if json_value or value
+        valid = true
+        mirrors_ghost json_value, value, definition.resource
+      end
+    end
+    Frogger.log_resource(definition.resource, valid)
+  end
+
+  def check_resource_count(json_resources, resources, type)
+    expect(json_resources).to be_an Array
+    expected_resource_count json_resources, resources.count, type
+  end
+
+  def expected_resource_count(json_resources, count, type)
+    structure = type.to_s.pluralize(count)
+    expect(json_resources).to have(count).send(structure)
+  end
+
+  def deep_structure(json_resource, type)
+    resource_doc = resource_doc_for(type)
+    resource_doc.attribute_names.each do |attribute_name|
+      definition = resource_doc.attribute_definition_for(attribute_name)
+      json_value = json_resource[attribute_name.to_s]
+      if definition.resource && json_value
+        check_structure json_value, definition
+      end
+    end
+  end
+
+  def check_structure(json_value, definition)
+    check_array_for json_value, definition
+    mirrors_structure json_value, definition.resource
+  end
+
+  def check_array_for(json_value, definition)
+    if array?(definition)
+      expect(json_value).to be_an Array
+    else
+      expect(json_value).to_not be_an Array
+    end
+  end
+
+  def match_attribute(json_value, value, type, attribute, strict = false)
+    if strict
+      expect(json_value).to_not eq(nil),
+        "#{type}.#{attribute} is nil.\n" +
+        "Turn off strict mode for this test if a nil value is expected."
+    end
+
+    expect(json_value).to eq(value),
+      mismatch_message(type, attribute, json_value, value)
+  end
+
+  def mismatch_message(type, attribute, json_value, value)
+    mask = "%s.%s does not match.\n\n" +
+      "expected: %s\n" +
+      "     got: %s"
+
+    mask % [
+      type,
+      attribute,
+      stringify_value(value),
+      stringify_value(json_value),
+    ]
+  end
+
+  def stringify_value(value)
+    "#{value.class}:#{value}"
+  end
+
+  def resource_doc_for(type)
+    type = type.to_s.singularize.to_sym
+    resource_doc = PeppersGhost::GhostFactory.find(type)
+    expect(resource_doc).to be_a(PeppersGhost::GhostFactory::Resource),
+      "Resource specification could not be found for #{type}."
+    resource_doc
+  end
+
+  def attributes_for_resource(type)
+    resource_doc_for(type).attribute_names
+  end
+
+  def array?(definition)
+    definition.resource.to_s.pluralize == definition.resource.to_s
   end
 end

data/peppers-ghost.gemspec

@@ -1,13 +1,14 @@
 Gem::Specification.new do |s|
   s.name    = 'peppers-ghost'
-  s.version = '0.0.0'
+  s.version = '0.0.1.alpha.1'
 
   s.summary     = 'Adds some helpers for testing api resources'
-  s.description = %Q{}.strip
+  s.description = %Q{
+}.strip
 
   s.author   = 'Travis Herrick'
   s.email    = 'tthetoad@gmail.com'
-  s.homepage = 'http://www.bitbucket.org/ToadJamb/peppers-ghost'
+  s.homepage = 'http://www.bitbucket.org/ToadJamb/gems-peppers-ghost'
 
   s.license = 'LGPLv3'
 
@@ -18,6 +19,7 @@ Gem::Specification.new do |s|
   s.test_files = Dir['spec/**/*.rb']
 
   s.add_dependency 'rspec'
+  s.add_dependency 'uuidtools'
 
   s.has_rdoc = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peppers-ghost
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1.alpha.1
 platform: ruby
 authors:
 - Travis Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email: tthetoad@gmail.com
 executables: []
@@ -33,16 +47,10 @@ files:
 - Gemfile
 - Gemfile.lock
 - peppers-ghost.gemspec
-- lib/peppers-ghost/core.rb
-- lib/peppers-ghost/ghost.rb
+- lib/peppers-ghost.rb
 - lib/peppers-ghost/ghost_factory.rb
-- lib/peppers-ghost/matchers/match_resource.rb
-- lib/peppers-ghost/matchers/match_structure_of.rb
 - lib/peppers-ghost/matchers.rb
-- lib/peppers-ghost/shared/json_context.rb
-- lib/peppers-ghost/shared/list_example.rb
-- lib/peppers-ghost.rb
-homepage: http://www.bitbucket.org/ToadJamb/peppers-ghost
+homepage: http://www.bitbucket.org/ToadJamb/gems-peppers-ghost
 licenses:
 - LGPLv3
 metadata: {}
@@ -57,12 +65,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Adds some helpers for testing api resources

data/lib/peppers-ghost/core.rb

@@ -1,58 +0,0 @@
-module PeppersGhost::Core
-  def match_resource_type(json_resource, resource, attributes, strict = false)
-    match_structure json_resource, attributes
-    match_values json_resource, resource, attributes, strict
-  end
-
-  def match_structure(json_resource, attributes, count = nil, method = nil)
-    method ||= :resource
-    expect(json_resource).to_not be_nil
-
-    if json_resource.is_a?(Array)
-      expect(json_resource).to have(count).method_missing(method) if count
-      match_single_structure json_resource, attributes, count
-    else
-      expect(json_resource.keys).to match_array attributes.map(&:to_s)
-    end
-  end
-
-  def match_values(json_resource, resource, attributes, strict = false)
-    if json_resource.is_a?(Array)
-      expect(json_resource).to have(1).resource
-      json_resource = json_resource.first
-    end
-    match_attributes json_resource, resource, attributes, strict
-  end
-
-  private
-
-  def match_single_structure(json_resources, attributes, count)
-    json_resources.each do |json_resource|
-      match_structure json_resource, attributes
-    end
-  end
-
-  def match_attributes(json_resource, resource, attributes, strict = false)
-    attributes.each do |attribute|
-      next unless resource.respond_to?(attribute) or
-        (resource.is_a?(Hash) and
-         (resource.has_key?(attribute.to_s) or resource.has_key?(attribute.to_sym)))
-
-      value =
-        if resource.respond_to?(attribute)
-          resource.send attribute
-        elsif resource.is_a? Hash
-          resource[attribute.to_s] || resource[attribute.to_sym]
-        end
-
-      json_value = json_resource[attribute.to_s]
-
-      match_attribute json_value, value, strict
-    end
-  end
-
-  def match_attribute(json_value, value, strict = false)
-    expect(value).to_not be_nil if strict
-    expect(json_value).to eq value
-  end
-end

data/lib/peppers-ghost/ghost.rb

@@ -1,9 +0,0 @@
-class PeppersGhost::Ghost
-  def attributes
-    @attributes ||= []
-  end
-
-  def method_missing(method, *args, &block)
-    attributes << method
-  end
-end

data/lib/peppers-ghost/matchers/match_resource.rb

@@ -1,21 +0,0 @@
-module PeppersGhost::Matchers
-  matcher :match_resource do |expected, type|
-    chain :strictly do
-      @strict = true
-    end
-
-    match do |actual|
-      begin
-        resource = PeppersGhost.ghost_for(type)
-        match_resource_type actual, expected, resource.attributes, @strict
-      rescue RSpec::Expectations::ExpectationNotMetError => e
-        @error = e.message
-        false
-      end
-    end
-
-    failure_message_for_should do
-      @error
-    end
-  end
-end

data/lib/peppers-ghost/matchers/match_structure_of.rb

@@ -1,30 +0,0 @@
-module PeppersGhost::Matchers
-  matcher :match_structure_of do |expected|
-    chain :with do |count|
-      @count = count
-    end
-
-    match do |actual|
-      begin
-        resource = PeppersGhost.ghost_for(expected)
-        match_structure actual, resource.attributes, @count, @method
-      rescue RSpec::Expectations::ExpectationNotMetError => e
-        @error = e.message
-        false
-      end
-    end
-
-    failure_message_for_should do
-      @error
-    end
-
-    def method_missing(method, *args, &block)
-      if defined?(@method)
-        super
-      else
-        @method = method
-      end
-      self
-    end
-  end
-end

data/lib/peppers-ghost/shared/json_context.rb

@@ -1,5 +0,0 @@
-shared_context 'json' do
-  let(:json)      { JSON last_response.body }
-  let(:root_key)  { json.keys.reject { |k| k == 'meta' }.first }
-  let(:json_root) { json[root_key] }
-end

data/lib/peppers-ghost/shared/list_example.rb

@@ -1,7 +0,0 @@
-shared_examples_for 'a list of' do |type, count|
-  include_context 'json'
-
-  it "returns a list of #{type}" do
-    expect(json_root).to match_structure_of(type).with(count).method_missing(type)
-  end
-end