dslh 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bea460ff3013100d73e63f5ad28d76314ff27922
-  data.tar.gz: d786b97c2645b741c5dbd301f3a9826f663931a0
+  metadata.gz: ed45c1e092e5109296acdff1cbdf5f04480d54ea
+  data.tar.gz: c01f03de3c202a12f34311ebd38355976547849f
 SHA512:
-  metadata.gz: 44c114e62597267087a86d9676cea3df76ae42a5533d98d8eb45692469ae9d3da2a48dbf6aec8bff32e990927effda441bfd8e9a2cd3790a4f6238c8c10a566d
-  data.tar.gz: 249d851a76f7026e6c334583fa78f71e0aff4629bba2e049aee8ea2bbed83372864ac56008864a49bbbde4de0c977d3032c18a3cfc552f136e905ebee7f161f3
+  metadata.gz: 7a4334b6e9a8a5893090b0c94e1cb0bd2f96ada901d6bfa4781b65b1f8a50b013b614516a3c63043f7639e140444987b17f4f1db98abadc229a17807f2ba8e14
+  data.tar.gz: 12f0f82b30ccbd566b568d4cec226273d6ed96e2e6cc0ee7c4c90b18956e9b7b3d9cf2ab4eb8f97f46c37e9d256b6e430bc717200e0172424effa5fe497f50c0

data/README.md

@@ -197,3 +197,63 @@ puts dsl
 #     }
 #   }
 ```
+
+### Validate schema using [Kwalify](http://www.kuwata-lab.com/kwalify/)
+
+```sh
+gem install kwalify
+```
+
+```ruby
+schema = <<-EOS
+type:      map
+mapping:
+ "company":
+    type:      str
+    required:  yes
+ "email":
+    type:      str
+ "employees":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "code":
+            type:      int
+            required:  yes
+         "name":
+            type:      str
+            required:  yes
+         "email":
+            type:      str
+      EOS
+EOS
+
+begin
+  Dslh.eval(:schema => schema) do
+    block = proc do
+      company "winebarrel inc."
+      email "webmaster@winebarrel.com"
+      employees do |*|
+        code "foo"
+        name 101
+        email "foo@winebarrel.com"
+      end
+      employees do |*|
+        code1 102
+        name1 "bar"
+        email1 "bar@winebarrel.com"
+      end
+    end
+  end
+rescue Dslh::ValidationError => e
+  puts e.message
+  # => [/employees/0/code] 'foo': not a integer.
+  #    [/employees/0/name] '101': not a string.
+  #    [/employees/1] key 'code:' is required.
+  #    [/employees/1] key 'name:' is required.
+  #    [/employees/1/code1] key 'code1:' is undefined.
+  #    [/employees/1/name1] key 'name1:' is undefined.
+  #    [/employees/1/email1] key 'email1:' is undefined.
+end
+```

data/dslh.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'kwalify'
 end

data/lib/dslh.rb

@@ -1,10 +1,40 @@
 require 'dslh/version'
 require 'stringio'
 require 'pp'
+require 'yaml'
 
 class Dslh
+  class ValidationError < StandardError
+    attr_reader :errors
+
+    def initialize(root_errors)
+      super(root_errors.map {|e| e.to_s }.join("\n"))
+      @errors = root_errors
+    end
+  end
+
   INDENT_SPACES = '  '
 
+  VALID_OPTIONS = [
+    :allow_duplicate,
+    :allow_empty_args,
+    :conv,
+    :dump_old_hash_array_format,
+    :exclude_key,
+    :filename,
+    :force_dump_braces,
+    :ignore_methods,
+    :initial_depth,
+    :key_conv,
+    :lineno,
+    :scope_hook,
+    :scope_vars,
+    :time_inspecter,
+    :use_braces_instead_of_do_end,
+    :schema,
+    :value_conv,
+  ]
+
   class << self
     def eval(expr_or_options = nil, options = nil, &block)
       if options and not options.kind_of?(Hash)
@@ -38,6 +68,12 @@ class Dslh
   end # of class methods
 
   def initialize(options = {})
+    invlid_options = options.keys - VALID_OPTIONS
+
+    unless invlid_options.empty?
+      raise ArgumentError, 'invalid option ' + invlid_options.map {|i| i.inspect }.join(',')
+    end
+
     @options = {
       :time_inspecter => method(:inspect_time),
       :dump_old_hash_array_format => false,
@@ -84,6 +120,26 @@ class Dslh
       scope.instance_eval(&block)
     end
 
+    if schema = @options[:schema]
+      begin
+        require 'kwalify'
+      rescue LoadError
+        raise 'cannot load "kwalify". please install "kwalify"'
+      end
+
+      unless schema.kind_of?(String)
+        raise TypeError, "wrong schema type #{schema.class} (expected String)"
+      end
+
+      schema = Kwalify::Yaml.load(schema)
+      validator = Kwalify::Validator.new(schema)
+      errors = validator.validate(retval)
+
+      unless errors.empty?
+        raise ValidationError, errors
+      end
+    end
+
     return retval
   end
 

data/lib/dslh/version.rb

@@ -1,3 +1,3 @@
 class Dslh
-  VERSION = '0.3.9'
+  VERSION = '0.4.0'
 end

data/spec/dslh_spec.rb

@@ -2921,4 +2921,108 @@ glossary {
 }
     EOS
   end
+
+  it 'ignore specific methods' do
+    h = Dslh.eval do
+      sprintf "100"
+    end
+
+    expect(h).to eq({})
+
+    h = Dslh.eval(:ignore_methods => :sprintf) do
+      sprintf "100"
+    end
+
+    expect(h).to eq({"sprintf" => "100"})
+  end
+
+  context 'when validate schema' do
+    let(:schema) do
+      <<-EOS
+type:      map
+mapping:
+ "company":
+    type:      str
+    required:  yes
+ "email":
+    type:      str
+ "employees":
+    type:      seq
+    sequence:
+      - type:    map
+        mapping:
+         "code":
+            type:      int
+            required:  yes
+         "name":
+            type:      str
+            required:  yes
+         "email":
+            type:      str
+      EOS
+    end
+
+    let(:expected_errmsg) do
+      <<-EOS.chomp
+[/employees/0/code] 'foo': not a integer.
+[/employees/0/name] '101': not a string.
+[/employees/1] key 'code:' is required.
+[/employees/1] key 'name:' is required.
+[/employees/1/code1] key 'code1:' is undefined.
+[/employees/1/name1] key 'name1:' is undefined.
+[/employees/1/email1] key 'email1:' is undefined.
+      EOS
+    end
+
+    it 'has no error' do
+      h = Dslh.eval(:schema => schema) do
+        company "winebarrel inc."
+        email "webmaster@winebarrel.com"
+        employees do |*|
+          code 101
+          name "foo"
+          email "foo@winebarrel.com"
+        end
+        employees do |*|
+          code 102
+          name "bar"
+          email "bar@winebarrel.com"
+        end
+      end
+
+      expect(h).to eq(
+        {"company"=>"winebarrel inc.",
+         "email"=>"webmaster@winebarrel.com",
+         "employees"=>
+          [{"code"=>101, "name"=>"foo", "email"=>"foo@winebarrel.com"},
+           {"code"=>102, "name"=>"bar", "email"=>"bar@winebarrel.com"}]}
+      )
+    end
+
+    it 'has errors' do
+      block = proc do
+        company "winebarrel inc."
+        email "webmaster@winebarrel.com"
+        employees do |*|
+          code "foo"
+          name 101
+          email "foo@winebarrel.com"
+        end
+        employees do |*|
+          code1 102
+          name1 "bar"
+          email1 "bar@winebarrel.com"
+        end
+      end
+
+      begin
+        h = Dslh.eval(:schema => schema, &block)
+        fail "must raise validation error"
+      rescue Dslh::ValidationError => e
+        errmsg = e.errors.map {|i| i.to_s }.join("\n")
+        expect(errmsg).to eq expected_errmsg
+        expect(e.message).to eq expected_errmsg
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dslh
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: It define Hash as a DSL.
 email:
 - sugawara@cookpad.com
@@ -93,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: It define Hash as a DSL.