masterplan 0.4.0 → 0.5.0

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "activesupport", '~>2.3.5'
+gem "activesupport"
 
 group :development do
   gem "rspec", "~> 2.3.0"

data/Gemfile.lock

@@ -1,15 +1,19 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (2.3.10)
-    diff-lcs (1.1.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
-    rcov (0.9.9)
+    multi_json (1.1.0)
+    rake (0.9.2.2)
+    rcov (1.0.0)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -23,7 +27,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 2.3.5)
+  activesupport
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
   rcov

data/README.rdoc

@@ -128,6 +128,12 @@ The implicit rules are:
 
 You can add extra rules with the rule method - see Masterplan::DefineRules#rule for details.
 
+You can control the verbosity of the output with the :format option:
+
+    >> Masterplan.compare(:scheme => doc, :to => {:example => :data}, :format => :mini)
+
+Valid values are :full (the default), or :mini. :mini produces only a one-line output (leaving out the "Expected...but was" part).
+
 There is also an added assertion for unit tests or specs:
 
     assert_masterplan(doc, [{:example => :data})
@@ -152,15 +158,12 @@ Note that for the moment, schemes, i.e. the outermost object, can only be hashes
 
     (sudo) gem install masterplan
 
+(Note that the latest version is probably not available as a gem directly).
+
 Or, install latest version from Github with bundler by adding this to your Gemfile:
 
     gem 'masterplan', :git => 'git://github.com/traveliq/masterplan.git'
 
-== Dependencies
-
-You'll need ActiveSupport, but that should be handled automatically.
-Under Ruby 1.9.x, however, you need the test-unit gem. It works for us with test-unit 1.2.3.
-
 == Authors
 
 Martin Tepper (monogreen.de), Holger Pillmann (holger.pillmann@gmail.com), Dr. Florian Odronitz (odo@mac.com)

data/Rakefile

@@ -13,12 +13,12 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "masterplan"
-  gem.homepage = "http://github.com/traveliq/masterplan"
+  gem.homepage = "http://github.com/MGPalmer/masterplan"
   gem.license = "MIT"
   summary = %Q{Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML.}
   gem.summary = summary
   gem.description = summary + " Please see the README on github for more information."
-  gem.email = "developer@traveliq.net"
+  gem.email = "mgpalmer@monogreen.de"
   gem.authors = ["Martin Tepper"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/masterplan.rb

@@ -3,9 +3,6 @@ require 'active_support/version'
 if ActiveSupport::VERSION::STRING >= "3.0.0"
   require 'active_support/core_ext'
 end
-if RUBY_VERSION > '1.9'
-  gem 'test-unit'
-end
 require 'test/unit/assertions'
 require 'masterplan'
 require 'masterplan/rule'
@@ -20,12 +17,14 @@ module Masterplan
 
   class << self
 
-    def compare(options = {:scheme => {}, :to => {}})
+    def compare(options = {:scheme => {}, :to => {}, :format => :full})
       scheme = options[:scheme]
       testee = options[:to]
+      format = options[:format] || :full
       raise ArgumentError, ":to needs to be a hash !" unless testee.is_a?(Hash)
       raise ArgumentError, ":scheme needs to be a Masterplan::Document !" unless scheme.is_a?(Document)
-      compare_hash(scheme, testee)
+      raise ArgumentError, ":format needs to be one of [:full, :mini] !" unless [:full, :mini].include?(format)
+      compare_hash(scheme, testee, format)
       true
     end
 
@@ -39,14 +38,44 @@ module Masterplan
       end
     end
 
-    def compare_hash(template, testee, trail = ["root"])
-      template.stringify_keys!
+    def compare_hash_keys(template, testee, trail)
+      mandatory_keys = Set.new
+      optional_keys = Set.new
+      template.keys.each do |key|
+        if key.is_a?(Masterplan::Rule) && key.options["optional"]
+          optional_keys << key.example_value.to_s
+        else
+          mandatory_keys << key.to_s
+        end
+      end
+      failed = false
       testee.stringify_keys!
-      raise FailedError, "keys don't match in #{format_path(trail)}:\nexpected:\t#{template.keys.sort.join(',')}\nreceived:\t#{testee.keys.sort.join(',')}" if template.keys.sort != testee.keys.sort
-      template.each do |t_key, t_value|
+      testee_set = Set.new(testee.keys)
+      if((mandatory_keys - testee_set).size > 0) # missing keys
+        failed = true
+      else
+        extra_keys = (testee_set - mandatory_keys)
+        if extra_keys.size > 0 && !extra_keys.subset?(optional_keys)
+          failed = true
+        end
+      end
+      if failed
+        raise FailedError, "keys don't match in #{format_path(trail)}:\nexpected:\t#{mandatory_keys.sort.join(',')}\nreceived:\t#{testee.keys.sort.join(',')}"
+      end
+    end
+
+    def compare_hash(template, testee, format, trail = ["root"])
+      compare_hash_keys(template, testee, trail)
+      template.each do |t_key_or_rule, t_value|
+        key_is_optional = t_key_or_rule.is_a?(Masterplan::Rule) && t_key_or_rule.options["optional"]
+        t_key = if key_is_optional
+          t_key_or_rule.example_value.to_s
+        else
+          t_key_or_rule.to_s
+        end
         current_path = trail + [t_key]
         value = testee[t_key]
-        compare_value(t_value, value, format_path(current_path))
+        compare_value(t_value, value, format_path(current_path)) unless key_is_optional and value.nil?
         if value && t_value.is_a?(Array)
           # all array elements need to be of the same type as the first value in the template
           elements_template = t_value.first
@@ -54,7 +83,7 @@ module Masterplan
             array_path = current_path + [index]
             compare_value(elements_template, elements_value, format_path(array_path))
             if elements_value.is_a?(Hash)
-              compare_hash(elements_template, elements_value, array_path)
+              compare_hash(elements_template, elements_value, format, array_path)
             end
           end
         end
@@ -64,16 +93,16 @@ module Masterplan
             array_path = current_path + [index]
             compare_value(elements_template, elements_value, format_path(array_path))
             if elements_value.is_a?(Hash)
-              compare_hash(elements_template, elements_value, array_path)
+              compare_hash(elements_template, elements_value, format, array_path)
             end
           end
         end
         if value.is_a?(Hash)
           if t_value.is_a?(Masterplan::Rule)
             compare_value(t_value, value, current_path)
-            compare_hash(t_value.example_value, value, current_path)
+            compare_hash(t_value.example_value, value, format, current_path)
           else
-            compare_hash(t_value, value, current_path)
+            compare_hash(t_value, value, format, current_path)
           end
         end
       end
@@ -84,10 +113,14 @@ module Masterplan
       error = Masterplan::FailedError.new
       error.printed = true
 
-      expected = PP.pp(template, '')
-      outcome = PP.pp(testee, '')
+      if format == :mini
+        raise error, e.message, caller
+      else
+        expected = PP.pp(template, '')
+        outcome = PP.pp(testee, '')
 
-      raise error, "#{e.message}\n\nExpected:\n#{expected}\n\nbut was:\n#{outcome}", caller
+        raise error, "#{e.message}\n\nExpected:\n#{expected}\n\nbut was:\n#{outcome}", caller
+      end
     end
 
     def format_path(trail)

data/lib/masterplan/define_rules.rb

@@ -5,11 +5,14 @@ module Masterplan
   module DefineRules
 
     # This turns the supplied +example_value+ (any object) into an object that carries rules about itself with it.
-    # The rules will be applied when a template is compared with assert_masterplan. Rules are:
+    # The rules will be applied when a template is compared with assert_masterplan or Masterplan.compare. Rules are:
     # (default): This always applies - the value must be of the same class as the +example_value+
     # 'allow_nil': This allows the value to be nil (breaking the first rule)
     # 'included_in': Pass an array of values - the value must be one of these
     # 'matches': Pass a regexp - the value must match it, and be a String
+    #
+    # There is one special rule that only works on hash keys:
+    # 'optional' : This makes the hash key optional, i.e. no error will occur if the key (and its value) are missing.
     def rule(example_value, options = {})
       Rule.new(example_value, options)
     end

data/lib/masterplan/document.rb

@@ -14,7 +14,7 @@ module Masterplan
     def to_hash
       result = {}
       each do |k, v|
-        result[k] = self.class.derulerize(v)
+        result[self.class.derulerize(k)] = self.class.derulerize(v)
       end
       result
     end

data/lib/masterplan/rule.rb

@@ -1,7 +1,7 @@
 module Masterplan
   class Rule
 
-    OPTIONS = ["allow_nil", "compare_each", "included_in", "matches"]
+    OPTIONS = ["allow_nil", "compare_each", "included_in", "matches", "optional"]
 
     attr_accessor :options, :example_value
 
@@ -11,6 +11,7 @@ module Masterplan
       options['compare_each'] ||= false
       options["included_in"] ||= false
       options["matches"] ||= false
+      options["optional"] ||= false
       raise ArgumentError, "options can be #{OPTIONS.join(',')}, not #{options.keys.inspect}" unless options.keys.sort == OPTIONS.sort
       self.example_value = example
       self.options = options

data/masterplan.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{masterplan}
-  s.version = "0.4.0"
+  s.name = "masterplan"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Tepper"]
-  s.date = %q{2011-02-09}
-  s.description = %q{Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML. Please see the README on github for more information.}
-  s.email = %q{developer@traveliq.net}
+  s.date = "2012-04-11"
+  s.description = "Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML. Please see the README on github for more information."
+  s.email = "mgpalmer@monogreen.de"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -34,11 +34,11 @@ Gem::Specification.new do |s|
     "spec/masterplan_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/traveliq/masterplan}
+  s.homepage = "http://github.com/MGPalmer/masterplan"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
-  s.summary = %q{Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML.}
+  s.rubygems_version = "1.8.19"
+  s.summary = "Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML."
   s.test_files = [
     "spec/masterplan_spec.rb",
     "spec/spec_helper.rb"
@@ -48,20 +48,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

data/spec/masterplan_spec.rb

@@ -6,7 +6,7 @@ describe "Masterplan" do
   before(:each) do
     @scheme = Masterplan::Document.new({
       "ship" => {
-        "parts" => [
+        :parts => [
           {
             "name" => "Mast",
             "length" => rule(12.3, :allow_nil => true),
@@ -19,7 +19,11 @@ describe "Masterplan" do
             "material" => "steel",
             "scream" => "HAAAAAARGH"
           }
-        ]
+        ],
+        rule(:flags, :optional => true) => {
+          "image" => "jolly roger",
+          "count" => 1
+        }
       }
     })
   end
@@ -67,7 +71,17 @@ describe "Masterplan" do
       end.should raise_error(ArgumentError, /scheme needs to be a Masterplan::Document/)
     end
 
-    it "complains if there are extra keys" do
+    it "complains if not given a proper format key" do
+      lambda do
+        Masterplan.compare(
+          :scheme => Masterplan::Document.new({}),
+          :to => {},
+          :format => :medium
+        )
+      end.should raise_error(ArgumentError, ":format needs to be one of [:full, :mini] !")
+    end
+
+    it "complains if there are extra keys (unless they are optional)" do
       test_value_and_expect(
         { :ship => {}, :boat => {} },
         Masterplan::FailedError, /expected:	ship*\n*received:	boat,ship/
@@ -88,6 +102,119 @@ describe "Masterplan" do
       )
     end
 
+    context "optional keys" do
+
+      it "complains if a value is nil when in an optional but given value" do
+        test_value_and_expect(
+          {
+            :ship => {
+              :parts => [
+                :name => "Thingy",
+                :length => 1.0,
+                :material => "human",
+                :scream => "UUUUUUUUH"
+              ],
+              :flags => {
+                "image" => nil,
+                "count" => 1
+              }
+            }
+          },
+          Masterplan::FailedError, /value at 'root'=>'ship'=>'flags'=>'image' \(NilClass\) is not a String/
+        )
+      end
+
+      it "complains if keys don't match up when in an optional but given value" do
+        test_value_and_expect(
+          {
+            :ship => {
+              :parts => [
+                :name => "Thingy",
+                :length => 1.0,
+                :material => "human",
+                :scream => "UUUUUUUUH"
+              ],
+              "flags" => {
+                "count" => 1
+              }
+            }
+          },
+          Masterplan::FailedError, /expected:	count,image*\n*received:	count/
+        )
+      end
+      
+      context "with subsets of mandatory and optional keys" do
+        before(:each) do
+          @multi_scheme = Masterplan::Document.new({
+            :mandatory_1 => "aaa",
+            :mandatory_2 => "aaa",
+            rule(:optional_1, :optional => true)  => "aaa",
+            rule(:optional_2, :optional => true)  => "aaa",
+          })
+        end
+
+        it "doesn't complain when all keys are given" do
+          Masterplan.compare(
+            :scheme => @multi_scheme,
+            :to => {
+              :mandatory_1 => "aaa",
+              :mandatory_2 => "aaa",
+              :optional_1  => "aaa",
+              :optional_2  => "aaa",
+            }
+          ).should be_true
+        end
+
+        it "doesn't complain when only mandatory keys are given" do
+          Masterplan.compare(
+            :scheme => @multi_scheme,
+            :to => {
+              :mandatory_1 => "aaa",
+              :mandatory_2 => "aaa",
+            }
+          ).should be_true
+        end
+
+        it "doesn't complain when only some optional keys are given" do
+          Masterplan.compare(
+            :scheme => @multi_scheme,
+            :to => {
+              :mandatory_1 => "aaa",
+              :mandatory_2 => "aaa",
+              :optional_2  => "aaa"
+            }
+          ).should be_true
+        end
+
+        it "complains when one mandatory key is missing" do
+          lambda do
+            Masterplan.compare(
+              :scheme => @multi_scheme,
+              :to => {:optional_1 => "aa", :optional_2 => "aaa", :mandatory_2 => "aaa"}
+            )
+          end.should raise_error(Masterplan::FailedError, /expected:	mandatory_1,mandatory_2*\n*received:	mandatory_2,optional_1,optional_2/)
+        end
+
+        it "complains when all mandatory keys are missing" do
+          lambda do
+            Masterplan.compare(
+              :scheme => @multi_scheme,
+              :to => {:optional_1 => "aa", :optional_2 => "aaa"}
+            )
+          end.should raise_error(Masterplan::FailedError, /expected:	mandatory_1,mandatory_2*\n*received:/)
+        end
+
+        it "complains when everything is missing" do
+          lambda do
+            Masterplan.compare(
+              :scheme => @multi_scheme,
+              :to => {}
+            )
+          end.should raise_error(Masterplan::FailedError, /expected:	mandatory_1,mandatory_2*\n*received:/)
+        end
+      end
+    end
+
     it "does not complain if a value is nil and the rule allows nil" do
       Masterplan.compare(
           :scheme => @scheme,
@@ -109,11 +236,60 @@ describe "Masterplan" do
       )
     end
 
+    [nil, :full].each do |format|
+      it "produces full output for format = #{format}" do
+        lambda do
+          Masterplan.compare(
+            :scheme => @scheme,
+            :to => { :ship => [] },
+            :format => format
+          )
+        end.should raise_error(
+          /value at 'root'=>'ship' \(Array\) is not a Hash !\n\s*?Expected:.*?but was/m
+        )
+      end
+    end
+
+    it "produces one-line output when using :mini format" do
+      lambda do
+        Masterplan.compare(
+          :scheme => @scheme,
+          :to => { :ship => [] },
+          :format => :mini
+        )
+      end.should raise_error(
+        "value at 'root'=>'ship' (Array) is not a Hash !"
+      )
+    end
+
     it "checks all values of value arrays, but only against the first array value of the scheme"
     it "checks all array values one-to-one if the compare_each rule is used"
   end
 
-  it "convertsinto plain example hashes"
+  it "converts into plain example hashes" do
+    @scheme.to_hash.should == {
+      "ship" => {
+        :parts => [
+          {
+            "name" => "Mast",
+            "scream" => "AAAAAAH",
+            "length" => 12.3,
+            "material" => "wood"
+          },
+          {
+            "name" => "Rudder",
+            "scream" => "HAAAAAARGH",
+            "length" => nil,
+            "material" => "steel"
+          }
+        ],
+        :flags => {
+          "image" => "jolly roger",
+          "count" => 1
+        }
+      }
+    }
+  end
   it "doesn't create a Document out of anything other than a Hash"
   it "checks that the examples of rules obey the rules"
   it "has a unit test extension method"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: masterplan
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Martin Tepper
@@ -15,28 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
-default_executable: 
+date: 2012-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 3
         segments: 
-        - 2
-        - 3
-        - 5
-        version: 2.3.5
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: activesupport
   prerelease: false
   type: :runtime
-  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +43,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
+  version_requirements: *id002
+  name: rspec
   prerelease: false
   type: :development
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +59,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  version_requirements: *id003
+  name: bundler
   prerelease: false
   type: :development
-  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +75,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
+  version_requirements: *id004
+  name: jeweler
   prerelease: false
   type: :development
-  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: rcov
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,11 +89,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id005
+  name: rcov
   prerelease: false
   type: :development
-  requirement: *id005
 description: Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML. Please see the README on github for more information.
-email: developer@traveliq.net
+email: mgpalmer@monogreen.de
 executables: []
 
 extensions: []
@@ -122,8 +119,7 @@ files:
 - masterplan.gemspec
 - spec/masterplan_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/traveliq/masterplan
+homepage: http://github.com/MGPalmer/masterplan
 licenses: 
 - MIT
 post_install_message: 
@@ -152,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML.