oval 0.0.1 → 0.0.2

data/.scripts/{build-module.sh → build-puppet-module.sh}

@@ -10,8 +10,8 @@ TARGET=`mktemp -d`
 
 function do_build_module {
   tag=$1
-  tgz="$TARGET/ptomulik-repos-${tag}.tar.gz"
-  dir="ptomulik-repos-$tag/"
+  tgz="$TARGET/ptomulik-oval-${tag}.tar.gz"
+  dir="ptomulik-oval-$tag/"
   git archive --prefix $dir --output $tgz $tag
   (cd $TARGET && tar -xzf $tgz && cd $TARGET/$dir && puppet module build)
 }

data/.travis.yml

@@ -8,15 +8,5 @@ script: "bundle exec rake spec SPEC_OPTS='--format documentation'"
 branches:
   only:
     master
-env:
-  matrix:
-    - FACTER_GEM_VERSION="~> 1.3.0"
-    - FACTER_GEM_VERSION="~> 1.5.0"
-    - FACTER_GEM_VERSION="~> 1.6.0"
-    - FACTER_GEM_VERSION="~> 1.7.0"
-#matrix:
-#  exclude:
-#    - rvm: 2.0.0
-#      env: FACTER_GEM_VERSION="~> 2.7.0"
 notifications:
   email: false

data/CHANGELOG

@@ -1,2 +1,12 @@
-2014-01-30 Pawel Tomulik <ptomulik@meil.pw.edu.pl>
+2014-02-02 Pawel Tomulik <ptomulik@meil.pw.edu.pl>
+  * release 0.0.2
+  * fixed Modulefile
+  * release 0.0.1
+  * added note to README.md
+  * corrected typos in README.md
+  * fixed .travis.yml to reduce matrix size
+  * fixed coveralls badge
+  * fixed some specs for ruby 2.0
+  * removed dead code from lib/oval/collection.rb
+  * fixed build-puppet-module script
   * initial commit

data/Modulefile

@@ -1,8 +1,8 @@
-name    'ptomulik-options_validator'
-version '0.0.1'
-source 'git://github.com/ptomulik/puppet-options_validator.git'
+name    'ptomulik-oval'
+version '0.0.2'
+source 'git://github.com/ptomulik/rubygems-oval.git'
 author 'ptomulik'
 license 'Apache License, Version 2.0'
 summary 'Simple utility to validate Hashes of options.'
 description 'Simple utility to validate Hashes of options.'
-project_page 'https://gitbub.com/ptomulik/puppet-options_validator'
+project_page 'https://gitbub.com/ptomulik/rubygems-oval'

data/README.md

@@ -1,7 +1,7 @@
 #Oval - Options Validator
 
 [![Build Status](https://travis-ci.org/ptomulik/rubygems-oval.png?branch=master)](https://travis-ci.org/ptomulik/rubygems-oval)
-[![Coverage Status](https://coveralls.io/options_validator/ptomulik/rubygems-oval/badge.png)](https://coveralls.io/r/ptomulik/rubygems-oval)
+[![Coverage Status](https://coveralls.io/repos/ptomulik/rubygems-oval/badge.png?branch=master)](https://coveralls.io/r/ptomulik/rubygems-oval?branch=master)
 [![Code Climate](https://codeclimate.com/github/ptomulik/rubygems-oval.png)](https://codeclimate.com/github/ptomulik/rubygems-oval)
 
 ####<a id="table-of-contents"></a>Table of Contents
@@ -24,24 +24,42 @@ Validate option hashes when passed to methods.
 
 ##<a id="module-description"></a>Module Description
 
-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.
+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.
 
-The shape of acceptable hashes is described by a simple grammar. The validation is then carried out by a recursive-descent parser that matches the actual values provided by caller against [declarators](#declarators) that comprise the hash declaration.
+The shape of acceptable hashes is described by a simple grammar. The validation
+is then carried out by a recursive-descent parser that matches the actual
+values provided by caller against [declarators](#declarators) that comprise the
+hash declaration.
 
-A declaration consists of terminal and non-terminal declarators. Non-terminal declarators are created by methods of `Oval` module which have names starting with `ov_` prefix. All other values (such as `:symbol`, `'string'`, `nil`, or `Class`) are terminals. Terminals use `==` operator to match the values provided by caller. Non-teminal use its own logic introducing more elaborate matching criteria (see for example [ov_collection](#ov_collection)).
+A declaration consists of terminal and non-terminal declarators. Non-terminal
+declarators are created by methods of `Oval` module which have names starting
+with `ov_` prefix. All other values (such as `:symbol`, `'string'`, `nil`, or
+`Class`) are terminals. Terminals use `==` operator to match the values
+provided by caller. Non-terminal use its own logic introducing more elaborate
+matching criteria (see for example [ov_collection](#ov_collection)).
 
-**Oval** raises **Oval::DeclError** if the declaration is not well-formed, that is if the description of options shape is erronrneous. This is raised from the point of declaration. Other, more common exception is the **Oval::ValueError** which is raised everytime validation fails. This one is raised from within a method which takes the options as an argument.
+**Oval** raises **Oval::DeclError** if the declaration is not well-formed, that
+is if the description of options shape is erroneous. This is raised from the
+point of declaration. Other, more common exception is the **Oval::ValueError**
+which is raised each time the validation fails. This one is raised from within
+a method which takes the options as an argument.
 
 [[Table of Contents](#table-of-contents)]
 
 ##<a id="usage"></a>Usage
 
-The usage is basically a two-step procedure. The first step is to declare options shape. This would create a validator object. The second step is to validate options within a method using the previously constructed validator. For simple hashes the entire construction may fit to a single line. Let's start with such a simple example.
+The usage is basically a two-step procedure. The first step is to declare
+options shape. This would create a validator object. The second step is to
+validate options within a method using the previously constructed validator.
+For simple hashes the entire construction may fit to a single line. Let's start
+with such a simple example.
 
 ###<a id="example-1-declaring-simple-options"></a>Example 1: Declaring Simple Options
 
 The method `foo` in the following code accepts only `{}` and `{:foo => value}`
-as `options`, where `value` is arbitrary:
+as `ops`, where `value` is arbitrary:
 
 ```ruby
 # Options validator
@@ -62,14 +80,26 @@ C.foo :foo => 10 # should pass
 C.foo :foo => 10, :bar => 20 # Oval::ValueError "Invalid option :bar for ops. Allowed options are :foo"
 ```
 
-Options are declared with [ov_xxx declarators](#declarators). The [ov_options](#ov_options) method should always be at the top level. Then all the allowed options should be listed inside of `[]` square brackets. Keys may be any values convertible to strings (i.e. a key given in declaration must `respond_to? :to_s`). Values are declared recursivelly using [ov_xxx declarators](#declarators) or terminal declarators (any other ruby values).
-
-In [Example 1](#example-1-declaring-simple-options) we have declared options inside of a method for simplicity. This isn't an optimal technique. Usually options' declaration remains same for the entire lifetime of an application, so it is unnecessary to recreate the declaration each time function is called. In other words, we should move the declaration outside of the method, convert it to a singleton and only validate options inside of a function. For that purpose, t
-he [Example 1](#example-1-declaring-simple-options) could be modified to the following form
+Options are declared with [ov_xxx declarators](#declarators). The
+[ov_options](#ov_options) method should always be at the top level. Then all
+the allowed options should be listed inside of `[]` square brackets. Keys may
+be any values convertible to strings (i.e. a key given in declaration must
+`respond_to? :to_s`). Values are declared recursively using [ov_xxx
+declarators](#declarators) or terminal declarators (any other ruby values).
+
+In [Example 1](#example-1-declaring-simple-options) we have declared options
+inside of a method for simplicity. This isn't an optimal technique. Usually
+options' declaration remains same for the entire lifetime of an application, so
+it is unnecessary to recreate the declaration each time function is called. In
+other words, we should move the declaration outside of the method, convert it
+to a singleton and only validate options inside of a function. For that
+purpose, the [Example 1](#example-1-declaring-simple-options) could be modified
+to the following form
 
 ###<a id="example-2-separating-declaration-from-validation"></a>Example 2: Separating declaration from validation
 
-In this example we separate options declaration from the validation to reduce costs related to options declaration:
+In this example we separate options declaration from the validation to reduce
+costs related to options declaration:
 
 ```ruby
 # Options validator
@@ -93,19 +123,30 @@ end
 
 ###<a id="declarators"></a>Declarators
 
-A declaration of options consists entirely of what we call here **declarators**. The [ov_options](#ov_options) should be used as a root of every declaration (starting symbol in grammar terms). It accepts a Hash of the form **{optname => optdecl, ...}** as an argument. The **optname** is an option name, and **optdecl** is a declarator restricting the options's value. Each option name (key) must be convertible to a `String`. Option value declarators are non-terminal declarators (defined later in this section) or terminals (any other ruby values). The simple declaration
+A declaration of options consists entirely of what we call here
+**declarators**. The [ov_options](#ov_options) should be used as a root of
+every declaration (starting symbol in grammar terms). It accepts a Hash of the
+form **{optname => optdecl, ...}** as an argument. The **optname** is an option
+name, and **optdecl** is a declarator restricting the option's value. Each
+option name (key) must be convertible to a `String`. Option value declarators
+are non-terminal declarators (defined later in this section) or terminals (any
+other ruby values). The simple declaration
 
 ```ruby
 ov_options[ :foo => :bar ]
 ```
 
-uses only terminals inside of **ov_options** and literarly permits only the `{:foo => :bar}` or the empty hash `{}` as options (and nothing else). This is how terminal declarators (`:foo` and `:bar` in this example) work. More freedom may be introduced with non-terminal declarators, for example:
+uses only terminals inside of **ov_options** and literary permits only the
+`{:foo => :bar}` or the empty hash `{}` as options (and nothing else). This is
+how terminal declarators (`:foo` and `:bar` in this example) work. More freedom
+may be introduced with non-terminal declarators, for example:
 
 ```ruby
 ov_options[ :foo => ov_anything ]
 ```
 
-defines an option `:foo` which accepts any value. In what follows, we'll document all the core non-terminal declarators implemented in **Oval**.
+defines an option `:foo` which accepts any value. In what follows, we'll
+document all the core non-terminal declarators implemented in **Oval**.
 
 ####<a id="ov\_anything"></a>ov\_anything
 
@@ -140,13 +181,17 @@ defines an option `:foo` which accepts any value. In what follows, we'll documen
   ov_collection[ class_decl, item_decl ]
   ```
 
-- Validation - permits only collections of type **class_decl** with items matching **item_decl** declaration
+- Validation - permits only collections of type **class_decl** with items
+  matching **item_decl** declaration
 - Allowed values for **class\_decl** are:
   - `Hash` or `Array` or any subclass of `Hash` or `Array`,
-  - `ov_subclass_of[klass]` where **klass** is `Hash` or `Array` or a subclass of any of them.
+  - `ov_subclass_of[klass]` where **klass** is `Hash` or `Array` or a subclass
+    of any of them.
 - Allowed values for **item_decl**:
-  - if **class\_decl** is `Array`-like, then any value is allowed as **item\_decl**,
-  - if **class\_decl** is `Hash`-like, then **item\_decl** should be a one-element Hash in form **{ key\_decl => val\_decl }**.
+  - if **class\_decl** is `Array`-like, then any value is allowed as
+    **item\_decl**,
+  - if **class\_decl** is `Hash`-like, then **item\_decl** should be a
+    one-element Hash in form **{ key\_decl => val\_decl }**.
 - Example
 
   ```ruby
@@ -226,7 +271,8 @@ defines an option `:foo` which accepts any value. In what follows, we'll documen
   ```
   
 - Validation - permits only declared options and their values.
-- Allowed values for `optkey_declN` - anything that is convertible to string (namely, anything that responds to `to_s` method).
+- Allowed values for `optkey_declN` - anything that is convertible to string
+  (namely, anything that responds to `to_s` method).
 - Example:
 
   ```ruby
@@ -277,4 +323,6 @@ The API documentation is also available
 
 ##Limitations
 
+- API documentation is currently very poor,
+
 [[Table of Contents](#table-of-contents)]

data/lib/oval/array_item.rb

@@ -17,7 +17,7 @@ class Oval::ArrayItem < Oval::Base
 
   attr_reader :item_decl
 
-  protected
+  private
 
   def item_decl=(decl)
     @item_decl = decl

data/lib/oval/base.rb

@@ -33,7 +33,7 @@ class Oval::Base
   def initialize(*args)
   end
 
-  protected
+  private
 
   def self.for_subject(subject)
     subject ? " for #{subject}" : ""

data/lib/oval/class_decl_base.rb

@@ -9,7 +9,8 @@ class Oval::ClassDeclBase < Oval::Base
     self.klass = klass
   end
 
-  protected
+  private
+
   def klass=(k)
     validate_class(k)
     @klass = k

data/lib/oval/collection.rb

@@ -70,10 +70,9 @@ class Oval::Collection < Oval::Base
 
   attr_reader :class_decl
   attr_reader :item_decl
-  attr_reader :class_validator
   attr_reader :item_validator
 
-  protected
+  private
 
   def class_decl=(decl)
     self.class.validate_class_decl(decl)
@@ -89,19 +88,6 @@ class Oval::Collection < Oval::Base
     @item_validator = select_item_validator[item_decl]
   end
 
-  def select_class_validator
-    if klass.is_a?(Class) and klass <= Hash
-      Oval::HashClass
-    elsif klass.is_a?(Class) and klass <= Array
-      Oval::ArrayClass
-    else
-      # well, we also may have klass that is not a class, but I'm too lazy to
-      # handle all possible exceptions,
-      raise RuntimeError, "Invalid class #{klass.inspect} assigned to klass. " +
-        "It seems like we have a bug in #{self.class.name}"
-    end
-  end
-
   def select_item_validator
     if klass.is_a?(Class) and klass <= Hash
       Oval::HashItem

data/lib/oval/options.rb

@@ -16,7 +16,7 @@ class Oval::Options < Oval::Base
 
   attr_reader :decl
 
-  protected
+  private
 
   def decl=(decl)
     self.class.validate_decl(decl)

data/oval.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = 'oval'
-  gem.version       = '0.0.1'
+  gem.version       = '0.0.2'
   gem.authors       = ["Pawel Tomulik"]
   gem.email         = ["ptomulik@meil.pw.edu.pl"]
   gem.description   = %q{Validate options when passed to methods}

data/spec/unit/oval/base_spec.rb

@@ -18,8 +18,6 @@ describe Oval::Base do
     let(:subject) { described_class[:shape0] }
     [
       :validate,
-      :for_subject,
-      :enumerate,
     ].each do |method|
       it { should respond_to method }
     end

data/spec/unit/oval/class_decl_base_spec.rb

@@ -15,9 +15,7 @@ describe Oval::ClassDeclBase do
     before { described_class.any_instance.stubs(:validate_class) }
     it { should be_kind_of Oval::Base }
     [
-      :validate_class,
       :klass,
-      :klass=,
     ].each do |method|
       it { should respond_to method }
     end

data/spec/unit/oval/collection_spec.rb

@@ -5,13 +5,6 @@ require 'oval/instance_of'
 require 'oval/kind_of'
 
 describe Oval::Collection do
-##  Anything = Oval::Anything
-##  SubclassOf = Oval::SubclassOf
-##  InstanceOf = Oval::InstanceOf
-##  KindOf = Oval::KindOf
-##  OneOf = Oval::OneOf
-##  DeclError = Oval::DeclError
-##  ValueError = Oval::ValueError
   describe 'the class' do
     it { described_class.should respond_to :[] }
     it { described_class.should respond_to :new }
@@ -21,10 +14,7 @@ describe Oval::Collection do
     let(:subject)  { described_class[Array,nil] }
     it { should respond_to :validate }
     it { should respond_to :class_decl }
-    it { should respond_to :class_decl= }
     it { should respond_to :item_decl }
-    it { should respond_to :item_decl= }
-    it { should respond_to :select_item_validator }
   end
 
   describe "[]" do

data/spec/unit/oval/options_spec.rb

@@ -16,9 +16,9 @@ describe Oval::Options do
     before { described_class.stubs(:validate_decl).once.with(:decl0) }
     [
       :validate,
-      :validate_option,
-      :validate_option_name,
-      :validate_option_value,
+#      :validate_option,
+#      :validate_option_name,
+#      :validate_option_value,
     ].each do |method|
       it { should respond_to method }
     end
@@ -151,11 +151,11 @@ describe Oval::Options do
 
   describe "#validate_decl" do
     context "validate_decl({:foo => :F, :bar => 4})" do
-      it { expect { described_class.validate_decl({:foo => :F, :bar => 4}) }.to_not raise_error }
+      it { expect { described_class.send(:validate_decl,{:foo => :F, :bar => 4}) }.to_not raise_error }
     end
     context "validate_decl(:decl1)" do
       let(:msg) { "Invalid declaration :decl1 of type Symbol. Should be a Hash" }
-      it { expect { described_class.validate_decl(:decl1) }.to raise_error Oval::DeclError, msg }
+      it { expect { described_class.send(:validate_decl,:decl1) }.to raise_error Oval::DeclError, msg }
     end
     [
       {},
@@ -167,7 +167,7 @@ describe Oval::Options do
         let(:decl) { decl }
         before { decl.keys.each {|key| described_class.expects(:validate_option_name_decl).once.with(key) } }
         it "calls validate_option_name_decl(key) once for each key from #{decl.inspect} " do
-          expect { described_class.validate_decl(decl) }.to_not raise_error
+          expect { described_class.send(:validate_decl,decl) }.to_not raise_error
         end
       end
     end
@@ -177,7 +177,7 @@ describe Oval::Options do
     [ :one, 'two', 3 ].each do |decl|
       context "validate_option_name_decl(#{decl.inspect})" do
         let(:decl) { decl }
-        it { expect { described_class.validate_option_name_decl(decl) }.to_not raise_error }
+        it { expect { described_class.send(:validate_option_name_decl,decl) }.to_not raise_error }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oval
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -37,7 +37,7 @@ files:
 - .fixtures.yml
 - .gitignore
 - .rspec
-- .scripts/build-module.sh
+- .scripts/build-puppet-module.sh
 - .travis.yml
 - .yardopts
 - CHANGELOG
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2694836225048202330
+      hash: 2044800399727504758
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2694836225048202330
+      hash: 2044800399727504758
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23