grayskull 0.1.6 → 0.1.7

data/README.md

@@ -0,0 +1,122 @@
+Grayskull
+=========
+
+Grayskull is a Ruby library for validating data files against custom schema. It currently validates YAML and JSON files. It can be used as a library in your 
+ruby code and also comes with a command line tool.
+
+Installation
+------------
+
+	gem install grayskull
+	
+Usage
+-----
+
+###Library###
+
+	require 'grayskull'
+	validator = Grayskull::Validator.new(file,schema)
+	results = validator.validate
+	
+Grayskulls `validate` function will return one of the following Hashes.
+
+Succes:
+	
+	{
+		"result":true
+	}
+	
+Failure:
+
+	{
+		"result":false,
+		"errors":errors #Array of error messages
+		
+	}
+	
+###Command Line###
+
+	grayskull validate path/to/file path/to/schema
+	
+###Schema Files###
+
+Schema files should be in the following format:
+
+YAML:
+
+	sections:
+      - name: section1 #section name
+        required: yes yes|no
+    	type: Array #Valid ruby type or a custom type as defined in types.
+    	ok_empty: yes|no
+        accepts: #list of accepted types
+          - custom_type1
+          - custom_type2
+    types:
+      custom_type1:
+        type: Hash #Valid ruby type or a custom type as defined in types.
+        ok_empty: yes|no 
+        accepts:
+          - String #list of accepted types
+      custom_type2:
+        type: Array
+        ok_empty: yes|no
+        accepts:
+          - Array
+      
+JSON
+
+	{
+		"sections":[
+					{
+						"name": "section_name",
+						"required": true|false,
+						"type": "Array", #Valid ruby type or a custom type as defined in types.
+						"ok_empty": true,
+						"accepts":[ #list of accepted types
+							"custom_type1",
+							"String"
+						]
+					}
+    			],
+    	"types":{
+    		"custom_type1":{
+    			"type":"Hash",#Valid ruby type or a custom type as defined in types.
+    			"ok_empty":true|false,
+    			"accepts":[ #list of accepted types
+    				"Hash"
+    			]
+			},
+		}
+	}
+	
+As all files are converted to native ruby formats you can mix json files with yaml schemas and vice versa.
+
+Coming Soon
+-----------
+
+* More formats
+* Unit Tests
+
+Notes
+-----
+
+This is an extraction of the validation code from my first gem skeletor. I'm still pretty new to ruby so I'd be really grateful for any constructive feedback, input, suggestions etc. As usual, if anybody wants to
+contribute feel free, just check out the guidelines below.
+
+Contributing to Skeletor
+------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 OiNutter. See LICENSE.txt for
+further details.

data/lib/grayskull.rb

@@ -3,6 +3,7 @@ require 'grayskull/version'
 # Base module for gem.
 module Grayskull
   autoload :Formats, 'grayskull/formats'
+  autoload :DataFile, 'grayskull/datafile'
   autoload :Validator, 'grayskull/validator'
   autoload :CLI, 'grayskull/cli'
 end

data/lib/grayskull/DataFile.rb

@@ -0,0 +1,23 @@
+module Grayskull
+  
+  # The *DataFile* class contains methods for loading
+  # and working with the supported data files.
+  class DataFile
+    
+     # Loads the specified file depending on the format
+    def self.load(file)
+     
+      format = Formats::detect_format File.basename(file)
+     
+      case format
+        when 'yaml'
+          return Formats::YAMLHandler.load(file)
+        when 'json'
+          return Formats::JSONHandler.load(file)
+       end
+       
+    end
+    
+  end
+  
+end

data/lib/grayskull/validator.rb

@@ -11,13 +11,13 @@ module Grayskull
       @schema = schema
       
       if file.kind_of?(String) && !Formats::FILENAME_PATTERN.match(file).nil?
-        @loaded_file = self.load(file)
+        @loaded_file = DataFile.load(file)
       else
         @loaded_file = file
       end
       
       if schema.kind_of?(String) && !Formats::FILENAME_PATTERN.match(schema).nil?
-        @loaded_schema = self.load(schema)
+        @loaded_schema = DataFile.load(schema)
       else
         @loaded_schema = schema
       end
@@ -26,21 +26,7 @@ module Grayskull
       
       @errors = []
     end
-    
-    # Loads the specified file depending on the format
-    def load(file)
-     
-      format = Formats::detect_format File.basename(file)
      
-      case format
-        when 'yaml'
-          return Formats::YAMLHandler.load(file)
-        when 'json'
-          return Formats::JSONHandler.load(file)
-       end
-       
-    end
-    
     # Validates the file against the schema
     def validate()
        failed = []

data/lib/grayskull/version.rb

@@ -1,4 +1,4 @@
 module Grayskull
   # Current version number
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,60 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: grayskull
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 6
-  version: 0.1.6
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Will McKenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-02 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70341851833000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70341851833000
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70341851832220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70341851832220
 description: Will validate YAML and JSON files based on a provided schema
-email: 
+email:
 - will@oinutter.co.uk
-executables: 
+executables:
 - grayskull
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- README.md
 - LICENSE
 - lib/grayskull/cli.rb
+- lib/grayskull/DataFile.rb
 - lib/grayskull/formats/json_handler.rb
 - lib/grayskull/formats/yaml_handler.rb
 - lib/grayskull/formats.rb
@@ -62,37 +52,29 @@ files:
 - lib/grayskull/version.rb
 - lib/grayskull.rb
 - bin/grayskull
-has_rdoc: true
 homepage: http://github.com/OiNutter/grayskull
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: grayskull
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Validates data files based on a provided schema
 test_files: []
-