oval 0.0.1

data/spec/unit/oval/subclass_of_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'oval/subclass_of'
+
+
+describe Oval::SubclassOf do
+  it "should be subclass of Oval::ClassDeclBase" do
+    described_class.should < Oval::ClassDeclBase
+  end
+  describe "#validate" do
+    [
+      [Integer,[Fixnum]],
+    ].each do |klass,args|
+      context "#{described_class.name}[#{klass.name}].validate(#{args.map{|x| x.inspect}.join(', ')})" do
+        let(:klass) { klass }
+        let(:args) { args }
+        let(:subject) { described_class[klass] }
+        it { expect { subject.validate(*args) }.to_not raise_error }
+      end
+    end
+    [
+      [Integer,[:foo], "Invalid class :foo. Should be subclass of Integer"],
+      [Integer,[String], "Invalid class String. Should be subclass of Integer"],
+      [Integer,[String,'foo'], "Invalid class String for foo. Should be subclass of Integer"],
+    ].each do |klass,args,msg|
+      context "#{described_class.name}[#{klass.name}].validate(#{args.map{|x| x.inspect}.join(', ')})" do
+        let(:klass) { klass }
+        let(:args) { args }
+        let(:msg) { msg }
+        let(:subject) { described_class[klass] }
+        it { expect { subject.validate(*args) }.to raise_error Oval::ValueError, msg}
+      end
+    end
+  end
+end

data/spec/unit/oval_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'oval'
+
+describe Oval do
+  let(:subject) { Class.new { extend Oval; def to_s; 'OvalReceiver'; end } }
+  describe "the receiver" do
+    let(:subject) { Class.new { extend Oval } }
+    it { should respond_to :ov_anything }
+    it { should respond_to :ov_collection }
+    it { should respond_to :ov_instance_of }
+    it { should respond_to :ov_kind_of }
+    it { should respond_to :ov_one_of }
+    it { should respond_to :ov_options }
+    it { should respond_to :ov_subclass_of }
+  end
+
+  its(:ov_anything) { should be Oval::Anything }
+  its(:ov_collection) { should be Oval::Collection }
+  its(:ov_instance_of) { should be Oval::InstanceOf }
+  its(:ov_kind_of) { should be Oval::KindOf }
+  its(:ov_one_of) { should be Oval::OneOf }
+  its(:ov_options) { should be Oval::Options }
+  its(:ov_subclass_of) { should be Oval::SubclassOf }
+end
+
+# examples from README.md and other sources
+describe Oval do
+  describe "Example 1" do
+    let(:subject) do
+      Class.new do
+        extend Oval
+        def self.foo(ops = {})
+          ov_options[ :foo => ov_anything ].validate(ops, 'ops')
+        end
+      end
+    end
+    it("should compile"){ subject }
+    context "foo" do
+      it { expect { subject.foo }.to_not raise_error }
+    end
+    context "foo :foo => 10" do
+      it { expect { subject.foo :foo => 10 }.to_not raise_error }
+    end
+    context "foo :foo => 10, :bar => 20" do
+      let(:msg) { "Invalid option :bar for ops. Allowed options are :foo" }
+      it { expect { subject.foo :foo => 10, :bar => 20 }.to raise_error Oval::ValueError, msg}
+    end
+  end
+  describe "Example 2" do
+    let(:subject) do
+      Class.new do
+        extend Oval
+        # create a singleton declaration ov
+        def self.ov
+          @ov ||= ov_options[ :foo => ov_anything ]
+        end
+        # use ov to validate ops
+        def self.foo(ops = {})
+          ov.validate(ops, 'ops')
+        end
+      end
+    end
+    it("should compile"){ subject }
+    context "foo" do
+      it { expect { subject.foo }.to_not raise_error }
+    end
+    context "foo :foo => 10" do
+      it { expect { subject.foo :foo => 10 }.to_not raise_error }
+    end
+    context "foo :foo => 10, :bar => 20" do
+      let(:msg) { "Invalid option :bar for ops. Allowed options are :foo" }
+      it { expect { subject.foo :foo => 10, :bar => 20 }.to raise_error Oval::ValueError, msg}
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: oval
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pawel Tomulik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validate options when passed to methods
+email:
+- ptomulik@meil.pw.edu.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .fixtures.yml
+- .gitignore
+- .rspec
+- .scripts/build-module.sh
+- .travis.yml
+- .yardopts
+- CHANGELOG
+- Gemfile
+- LICENSE
+- Modulefile
+- README.md
+- README_DEVEL.md
+- Rakefile
+- lib/oval.rb
+- lib/oval/anything.rb
+- lib/oval/array_item.rb
+- lib/oval/base.rb
+- lib/oval/class_decl_base.rb
+- lib/oval/collection.rb
+- lib/oval/hash_item.rb
+- lib/oval/instance_of.rb
+- lib/oval/kind_of.rb
+- lib/oval/one_of.rb
+- lib/oval/options.rb
+- lib/oval/subclass_of.rb
+- oval.gemspec
+- spec/spec_helper.rb
+- spec/unit/oval/anything_spec.rb
+- spec/unit/oval/array_item_spec.rb
+- spec/unit/oval/base_spec.rb
+- spec/unit/oval/class_decl_base_spec.rb
+- spec/unit/oval/collection_spec.rb
+- spec/unit/oval/hash_item_spec.rb
+- spec/unit/oval/instance_of_spec.rb
+- spec/unit/oval/kind_of_spec.rb
+- spec/unit/oval/one_of_spec.rb
+- spec/unit/oval/options_spec.rb
+- spec/unit/oval/subclass_of_spec.rb
+- spec/unit/oval_spec.rb
+homepage: https://github.com/ptomulik/rubygems-oval
+licenses:
+- Apache 2.0
+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: 2694836225048202330
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2694836225048202330
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Using hashes to pass options to methods is a very common ruby practice. With
+  **Oval** method authors may restrict callers to pass only declared options that
+  meet requirements described in a hash declaration.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/oval/anything_spec.rb
+- spec/unit/oval/array_item_spec.rb
+- spec/unit/oval/base_spec.rb
+- spec/unit/oval/class_decl_base_spec.rb
+- spec/unit/oval/collection_spec.rb
+- spec/unit/oval/hash_item_spec.rb
+- spec/unit/oval/instance_of_spec.rb
+- spec/unit/oval/kind_of_spec.rb
+- spec/unit/oval/one_of_spec.rb
+- spec/unit/oval/options_spec.rb
+- spec/unit/oval/subclass_of_spec.rb
+- spec/unit/oval_spec.rb
+has_rdoc: