protobuf_spec 0.3.1

data/features/inclusion.feature

@@ -0,0 +1,72 @@
+Feature: Inclusion
+  Background:
+    Given I create the following ProtoBuf of type "Sample":
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+    Scenario: String
+    When I get the ProtoBuf
+    Then the ProtoBuf should include "foo"
+    Then the ProtoBuf should include:
+    """
+    "foo"
+    """
+
+ Scenario: Integer
+    When I get the ProtoBuf
+    Then the ProtoBuf should include 5
+    And the ProtoBuf should include:
+      """
+      5
+      """
+
+  Scenario: Negative integer
+    When I get the ProtoBuf
+    Then the ProtoBuf should include -9
+    And the ProtoBuf should include:
+      """
+      -9
+      """
+
+  Scenario: Double
+    When I get the ProtoBuf
+    Then the ProtoBuf should include 50.23
+    And the ProtoBuf should include 50.23e0
+    And the ProtoBuf should include 50.23e+0
+    And the ProtoBuf should include 50.23e-0
+    And the ProtoBuf should include 50.23e0
+    And the ProtoBuf should include 50.23e+0
+    And the ProtoBuf should include 50.23e-0
+    And the ProtoBuf should include 5.023e1
+    And the ProtoBuf should include 5.023e+1
+    And the ProtoBuf should include 502.3e-1
+    And the ProtoBuf should include:
+      """
+      50.23
+      """
+    
+    Then the ProtoBuf should not include -15.45
+    
+    Scenario: True
+    When I get the ProtoBuf
+    Then the protobuf should include true
+    Then the protobuf should include:
+    """
+    true
+    """
+
+    Scenario: False
+    When I get the ProtoBuf
+    Then the protobuf should include false
+    Then the protobuf should include:
+    """
+    false
+    """

data/features/memory.feature

@@ -0,0 +1,135 @@
+Feature: Memory 
+  Background:
+    Given I create the following ProtoBuf of type "Sample":
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+    And I get the Protobuf
+
+  Scenario: Entire Protobuf
+    When I keep the Protobuf as "PROTO"
+    Then the Protobuf should be %{PROTO}
+    And the Protobuf should be:
+      """
+      %{PROTO}
+      """
+
+  Scenario: String
+    When I keep the ProtoBuf at "string_field" as "STRING"
+    Then the ProtoBuf at "string_field" should be %{STRING}
+    And the ProtoBuf should be:
+    """
+    {
+      "string_field": %{STRING},
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+  Scenario: Integer
+    When I keep the ProtoBuf at "int_field" as "INTEGER"
+    Then the ProtoBuf at "int_field" should be %{INTEGER}
+    And the ProtoBuf should be:
+    """
+    {
+      "string_field": "foo",
+      "int_field": %{INTEGER},    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+  Scenario: Double
+    When I keep the ProtoBuf at "double_field" as "DOUBLE"
+    Then the ProtoBuf at "double_field" should be %{DOUBLE}
+    And the ProtoBuf should be:
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": %{DOUBLE},    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+  Scenario: True
+    When I keep the ProtoBuf at "bool_field" as "TRUE"
+    Then the ProtoBuf at "bool_field" should be %{TRUE}
+    And the ProtoBuf should be:
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": %{TRUE},
+      "bool_field_2": false
+    }
+    """
+
+  Scenario: False
+    When I keep the ProtoBuf at "bool_field_2" as "FALSE"
+    Then the ProtoBuf at "bool_field_2" should be %{FALSE}
+    And the ProtoBuf should be:
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": %{FALSE}
+    }
+    """
+
+  Scenario: Table format
+    When I keep the ProtoBuf at "string_field" as "STRING"
+    And I keep the ProtoBuf at "int_field" as "INTEGER"
+    And I keep the ProtoBuf at "double_field" as "DOUBLE"
+    And I keep the ProtoBuf at "bool_field" as "TRUE"
+    And I keep the ProtoBuf at "bool_field_2" as "FALSE"
+    Then the ProtoBuf should have the following:
+      | string_field  | %{STRING}  |
+      | int_field     | %{INTEGER} |
+      | double_field  | %{DOUBLE}   |
+      | bool_field    | %{TRUE}    |
+      | bool_field_2  | %{FALSE}   |
+
+  Scenario: Inclusion
+    When I keep the ProtoBuf at "string_field" as "STRING"
+    And I keep the ProtoBuf at "int_field" as "INTEGER"
+    And I keep the ProtoBuf at "double_field" as "DOUBLE"
+    And I keep the ProtoBuf at "bool_field" as "TRUE"
+    And I keep the ProtoBuf at "bool_field_2" as "FALSE"
+    Then the ProtoBuf should include %{STRING}
+    Then the ProtoBuf should include %{INTEGER}
+    Then the ProtoBuf should include %{DOUBLE}
+    Then the ProtoBuf should include %{TRUE}
+    Then the ProtoBuf should include %{FALSE}
+
+  Scenario: I can store the serialized form of a protocol buffer in cuke_mem
+    Given I create a ProtoBuf of type "Sample"
+    And I set the ProtoBuf at "string_field" to "hello"
+    And I set the ProtoBuf at "int_field" to -5
+    And I set the ProtoBuf at "double_field" to 123.45
+    And I get the ProtoBuf
+    When I save the serialized ProtoBuf as "SERIALIZED"
+    And I deserialize a Protobuf of type "Sample" from "%{SERIALIZED}"
+    And I get the ProtoBuf
+    Then the ProtoBuf at "string_field" should be "hello"
+    And the ProtoBuf at "int_field" should be -5
+    And the ProtoBuf at "double_field" should be 123.45

data/features/paths.feature

@@ -0,0 +1,21 @@
+Feature: Paths
+  Background:
+    Given I create the following ProtoBuf of type "Sample":
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5    
+    }
+    """
+
+    Scenario: Base paths
+    When I get the ProtoBuf
+    Then the ProtoBuf should have "string_field"
+    Then the ProtoBuf should have "int_field"
+    Then the ProtoBuf should not have "double_field"
+
+    Scenario: Table format
+    When I get the ProtoBuf
+    Then the ProtoBuf should have the following:
+      | string_field  |
+      | int_field     |

data/features/step_definitions/steps.rb

@@ -0,0 +1,3 @@
+When /^I get the (?:ProtoBuf|protobuf|Protobuf)$/ do
+  @last_protobuf=ProtobufSpec::Builder.protobuf
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path("../../../lib", __FILE__)
+
+require "protobuf_spec/cucumber"
+
+def last_protobuf
+  @last_protobuf
+end
+
+require "protobuf_spec/builder"

data/features/support/sample.pb.rb

@@ -0,0 +1,40 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: sample.proto>
+# message Sample {
+#   optional string string_field = 1;
+#   optional int32 int_field = 2;
+#   optional double double_field = 3;
+# 
+#   optional string string_field_2 = 4;
+#   optional int32 int_field_2 = 5;
+#   optional double double_field_2 = 6;
+# 
+#   optional string string_field_3 = 7;
+#   optional int32 int_field_3 = 8;
+#   optional double double_field_3 = 9;
+# 
+#   optional bool bool_field=10;
+#   optional bool bool_field_2=11;
+#   optional bool bool_field_3=12;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class Sample < ::Protobuf::Message
+  defined_in __FILE__
+  optional :string, :string_field, 1
+  optional :int32, :int_field, 2
+  optional :double, :double_field, 3
+  optional :string, :string_field_2, 4
+  optional :int32, :int_field_2, 5
+  optional :double, :double_field_2, 6
+  optional :string, :string_field_3, 7
+  optional :int32, :int_field_3, 8
+  optional :double, :double_field_3, 9
+  optional :bool, :bool_field, 10
+  optional :bool, :bool_field_2, 11
+  optional :bool, :bool_field_3, 12
+end

data/lib/protobuf_spec.rb

@@ -0,0 +1,4 @@
+require "json_spec"
+
+require 'protobuf_spec/extensions'
+require 'protobuf_spec/matchers'

data/lib/protobuf_spec/builder.rb

@@ -0,0 +1,46 @@
+require 'cuke_mem'
+
+module ProtobufSpec
+module Builder 
+  def self.protobuf
+    @protobuf
+  end
+
+  def self.protobuf= protobuf
+    @protobuf=protobuf 
+  end
+end
+
+end
+
+Given /^I create a (?:ProtoBuf|Protobuf|protobuf) of type "([^"]*)"$/ do |proto_type|
+  ProtobufSpec::Builder.protobuf = eval("#{proto_type}.new") 
+end
+
+Given /^I set the (?:ProtoBuf|Protobuf|protobuf) at "([^"]*)" to "([^"]*)"$/ do |field, val|
+  ProtobufSpec::Builder.protobuf.send("#{field}=".to_sym, val)
+end
+
+Given /^I set the (?:ProtoBuf|Protobuf|protobuf) at "([^"]*)" to (-?\d+)$/ do |field, val|
+  ProtobufSpec::Builder.protobuf.send("#{field}=".to_sym, val.to_i)
+end
+
+Given /^I set the (?:ProtoBuf|Protobuf|protobuf) at "([^"]*)" to (-?\d+\.\d+)$/ do |field, val|
+  ProtobufSpec::Builder.protobuf.send("#{field}=".to_sym, val.to_f)
+end
+
+Given /^I create the following (?:ProtoBuf|Protobuf|protobuf) of type "([^"]*)":$/ do |proto_type, proto_as_json|
+  steps %{Given I create a ProtoBuf of type "#{proto_type}"}
+
+  json = JSON.parse proto_as_json
+  ProtobufSpec::Builder.protobuf.fields.each_value do |field| 
+    field_name = field.name.to_s
+    ProtobufSpec::Builder.protobuf[field_name] = json[field_name] if json.has_key? field_name
+  end
+end
+
+When /^I deserialize a (?:ProtoBuf|Protobuf|protobuf) of type "([^"]*)" from "([^"]*)"$/ do |proto_type, serial|
+  steps %{Given I create a ProtoBuf of type "#{proto_type}"}
+  ProtobufSpec::Builder.protobuf.parse_from_string CukeMem.remember(serial)
+end
+

data/lib/protobuf_spec/cucumber.rb

@@ -0,0 +1,69 @@
+require File.expand_path("../../protobuf_spec", __FILE__)
+require 'cuke_mem'
+
+World(JsonSpec::Helpers, JsonSpec::Matchers)
+World(ProtobufSpec::Matchers)
+
+When /^(?:I )?keep the (?:ProtoBuf|protobuf|Protobuf)(?: response)?(?: at "(.*)")? as "(.*)"$/ do |path, key|
+  CukeMem.memorize(key, normalize_json(last_protobuf.to_json, path))
+end
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)?(?: at "(.*)")? should( not)? include:$/ do |path, negative, json|
+  if negative
+    last_protobuf.to_json.should_not include_json(CukeMem.remember(json)).at_path(path)
+  else
+    last_protobuf.to_json.should include_json(CukeMem.remember(json)).at_path(path)
+  end
+end
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)?(?: at "(.*)")? should( not)? include (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |path, negative, value|
+  if negative
+    last_protobuf.to_json.should_not include_json(CukeMem.remember(value)).at_path(path)
+  else
+    last_protobuf.to_json.should include_json(CukeMem.remember(value)).at_path(path)
+  end
+end
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)?(?: at "(.*)")? should( not)? be:$/ do |path, negative, json|
+  if negative
+    last_protobuf.should_not be_protobuf_eql(CukeMem.remember(json)).at_path(path)
+  else
+    last_protobuf.should be_protobuf_eql(CukeMem.remember(json)).at_path(path)
+  end
+end
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)?(?: at "(.*)")? should( not)? be (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |path, negative, value|
+  if negative
+    last_protobuf.should_not be_protobuf_eql(CukeMem.remember(value)).at_path(path)
+  else
+    last_protobuf.should be_protobuf_eql(CukeMem.remember(value)).at_path(path)
+  end
+end
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)?(?: at "(.*)")? should have the following:$/ do |base, table|
+  table.rows.each do |path, value|
+    path = [base, path].compact.join("/")
+
+    if value
+      step %(the protobuf at "#{path}" should be:), value
+    else
+      step %(the protobuf should have "#{path}")
+    end
+  end
+end
+
+
+
+Then /^the (?:ProtoBuf|Protobuf|protobuf)(?: response)? should( not)? have "(.*)"$/ do |negative, path|
+  if negative
+    last_protobuf.should_not have_protobuf_path(path)
+  else
+    last_protobuf.should have_protobuf_path(path)
+  end
+end
+
+
+When /^I save the serialized (?:ProtoBuf|Protobuf|protobuf) as "([^"]*)"$/ do |key|
+  CukeMem.memorize key, last_protobuf.serialize_to_string
+end
+

data/lib/protobuf_spec/extensions.rb

@@ -0,0 +1,9 @@
+require 'multi_json'
+
+module Protobuf 
+  class Message
+    def to_json
+      MultiJson.encode self.to_hash
+    end
+  end
+end

data/lib/protobuf_spec/matchers.rb

@@ -0,0 +1,18 @@
+require 'protobuf_spec/matchers/be_protobuf_eql'
+require 'protobuf_spec/matchers/have_protobuf_path'
+
+module ProtobufSpec
+  module Matchers
+    def be_protobuf_eql(expected=nil)
+      ProtobufSpec::Matchers::BeProtobufEql.new(expected)
+    end
+
+    def have_protobuf_path(path)
+      ProtobufSpec::Matchers::HaveProtobufPath.new(path)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(ProtobufSpec::Matchers)
+end

data/lib/protobuf_spec/matchers/be_protobuf_eql.rb

@@ -0,0 +1,37 @@
+require 'json_spec/messages'
+
+module ProtobufSpec
+  module Matchers
+    class BeProtobufEql
+      include JsonSpec::Messages
+
+      attr_reader :actual
+
+      def initialize(expected_json = nil)
+        @json_matcher= JsonSpec::Matchers::BeJsonEql.new expected_json
+      end
+
+      def at_path(path)
+        @path=path
+        @json_matcher.at_path path
+        self
+      end
+
+      def matches?(protobuf)
+        @json_matcher.matches? protobuf.to_json
+      end
+
+      def failure_message_for_should
+        message_with_path("Expected equivalent Protobuf")
+      end
+
+      def negative_failure_message
+        message_with_path("Expected inequivalent Protobuf")
+      end
+
+      def description
+        message_with_path("equal Protobuf")
+      end
+    end
+  end
+end