grayskull 0.1.2 → 0.1.3

data/lib/grayskull/formats.rb

@@ -1,12 +1,18 @@
 module Grayskull
   
+  # The *Formats* module contains handlers for all the supported formats and 
+  # methods for format detection.
   module Formats
     
     autoload :YAMLHandler, 'grayskull/formats/yaml_handler'
     autoload :JSONHandler, 'grayskull/formats/json_handler'
     
+    # Regular Expression to get file extension.
     FILENAME_PATTERN = /(.+)\.([^\/\.]+)/
     
+    # Gets the file extension of the given file and returns the file format.
+    #
+    # Raises an exception if file is not of a valid type.
     def self.detect_format(filename)
       matches = FILENAME_PATTERN.match(filename.downcase).to_a
       if matches

data/lib/grayskull/formats/json_handler.rb

@@ -4,8 +4,12 @@ module Grayskull
   
   module Formats
     
+    # Handler for JSON file format.
     class JSONHandler
       
+      # Loads the JSON file and parses it into a ruby type.
+      #
+      # Raises an expection if file can not be parsed.
        def self.load(file)
          loaded = File.open(file)
          content = loaded.gets nil

data/lib/grayskull/formats/yaml_handler.rb

@@ -4,8 +4,12 @@ module Grayskull
   
   module Formats
     
+    # Handler for YAML file format
     class YAMLHandler
       
+      # Loads the YAML file and parses it into a ruby type.
+      #
+      # Raises an expection if file can not be parsed.
       def self.load(file)
         begin
           return YAML.load_file(file)

data/lib/grayskull/validator.rb

@@ -1,7 +1,10 @@
 module Grayskull
   
+  # The *Validator* class contains the core methods of the Grayskull library.
+  # It loads the passed files, converts them to Ruby types and validates them.
   class Validator
     
+    # Creates a new *Validator* instance
     def initialize(file,schema)
       
       @file = file
@@ -14,6 +17,7 @@ module Grayskull
       @errors = []
     end
     
+    # Loads the specified file depending on the format
     def load(file)
      
       format = Formats::detect_format File.basename(file)
@@ -27,6 +31,7 @@ module Grayskull
        
     end
     
+    # Validates the file against the schema
     def validate()
        failed = []
         
@@ -57,7 +62,7 @@ module Grayskull
         return result
       end
       
-      # Checks template node matches the schema.
+      # Checks file node matches the schema.
       #
       # Checks type of node against expected type and 
       # checks any children are of the accepted types.

data/lib/grayskull/version.rb

@@ -1,3 +1,4 @@
 module Grayskull
-  Grayskull::VERSION = "0.1.2"
+  # Current version number
+  VERSION = "0.1.3"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Will McKenzie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-01 00:00:00 +01:00
+date: 2011-10-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
 - LICENSE
 - lib/grayskull/cli.rb
 - lib/grayskull/formats/json_handler.rb