json_schema_tools 0.0.7 → 0.0.8

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog JSON Schema Tools
 
 
-12-2012
+2013-02
 
+* add validations for classes generated by KlassFactory
+
+2012-12
 * initial version with reader, hasher, params cleaner, attributes module

data/README.md

@@ -97,7 +97,7 @@ For example in a client controller
 
 ## Object attributes from Schema
 
-The use-case here is to add methods, defined in schema properties, to an object.
+Add methods, defined in schema properties, to an existing class.
 Very usefull if you are building a API client and don't want to manually add
 methods to you local classes .. like people NOT using JSON schema
 
@@ -111,31 +111,31 @@ methods to you local classes .. like people NOT using JSON schema
     # raw access
     contact.schema_attrs
 
-## Objects from Schema - KlassFactory
+## Classes from Schema - KlassFactory
 
 Use the KlassFactory to directly create classes, with all attributes from a
-schema. The classes are named after each schema[name] found in from global path.
+schema. Instead of adding attributes to an existing class like in above example.
+The classes are named after each schema's [name] (in global path).
 So lets assume you have a 'client.json' schema with a name attribute in it, for
 the following examples:
 
     SchemaTools::KlassFactory.build
-    client = Client.new
-    client.name = 'Mändy'
+    client = Client.new first_name: 'Heinz'
+    client.name = 'Schultz'
+    client.valid?
+    client.errors.full_messages
 
 
-Rather like a namespace? Good idea, but the class or module must be defined.
+Rather like a namespace? Good idea, but don't forget the class or module must
+be defined.
 
-    module SalesKing; end
     SchemaTools::KlassFactory.build namespace: SalesKing
     client = SalesKing::Client.new
 
-Add a custom schema reader
+Add a custom schema reader most likely usefull in conjunction with a custom path
 
     reader = SchemaTools::Reader.new
-    reader.path = HappyPdf::Schema.path
-    SchemaTools::KlassFactory.build reader: reader
-
-
+    SchemaTools::KlassFactory.build reader: reader, path: HappyPdf::Schema.path
 
 ## Real world examples
 

data/json_schema_tools.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'json'
   s.add_dependency 'activesupport'
+  s.add_dependency 'activemodel'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'simplecov'

data/lib/schema_tools/klass_factory.rb

@@ -6,11 +6,24 @@ module SchemaTools
     class << self
 
       # Build classes from schema inside the given namespace. Uses all classes
-      # found in schema path
+      # found in schema path:
+      # @example
+      #
+      # First set a global schema path:
+      #     SchemaTools.schema_path = File.expand_path('../fixtures', __FILE__)
+      #
+      # Bake classes from all schema.json found
+      #     SchemaTools::KlassFactory.build
+      #
+      # Go use it
+      #     client = Client.new organisation: 'SalesKing'
+      #     client.valid?
+      #     client.errors.should be_blank
       #
-      # @param [String|Symbol|Module] namespace of the new classes e.g. MyCustomNamespace::MySchemaClass
       # @param [Hash] opts
       # @options opts [SchemaTools::Reader] :reader to use instead of global one
+      # @options opts [SchemaTools::Reader] :path to schema files instead of global one
+      # @options opts [SchemaTools::Reader] :namespace of the new classes e.g. MyCustomNamespace::MySchemaClass
       def build(opts={})
         reader = opts[:reader] || SchemaTools::Reader
         schemata = reader.read_all( opts[:path] || SchemaTools.schema_path )
@@ -18,14 +31,27 @@ module SchemaTools
         if namespace.is_a?(String) || namespace.is_a?(Symbol)
           namespace = "#{namespace}".constantize
         end
-
+        # bake classes
         schemata.each do |schema|
           klass_name = schema['name'].classify
           next if namespace.const_defined?(klass_name, false)
           klass = namespace.const_set(klass_name, Class.new)
           klass.class_eval do
             include SchemaTools::Modules::Attributes
+            include ActiveModel::Conversion
+            include SchemaTools::Modules::Validations # +naming + transl + conversion
             has_schema_attrs schema['name'], reader: reader
+            validate_with schema['name'], reader:reader
+            getter_names = schema['properties'].select{|name,prop| !prop['readonly'] }.keys.map { |name| name.to_sym}
+            attr_accessor *getter_names
+
+            def initialize(attributes = {})
+              attributes.each do |name, value|
+                send("#{name}=", value)
+              end
+            end
+
+            def persisted?; false end
           end
         end
       end

data/lib/schema_tools/modules/validations.rb

@@ -0,0 +1,78 @@
+require 'active_support/concern'
+require 'active_model/validations'
+require 'active_model/naming'
+require 'active_model/translation'
+require 'active_model/conversion'
+module SchemaTools
+  module Modules
+    # Add schema properties to a class by including this module and defining from
+    # which schema to inherit attributes.
+    module Validations
+      extend ActiveSupport::Concern
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+
+      #included do
+      #  validate_with_schema :schema_name
+      #end
+      # Runs all the validations within the specified context. Returns true if no errors are found,
+      # false otherwise.
+      #
+      # If the argument is false (default is +nil+), the context is set to <tt>:create</tt> if
+      # <tt>new_record?</tt> is true, and to <tt>:update</tt> if it is not.
+      #
+      # Validations with no <tt>:on</tt> option will run no matter the context. Validations with
+      # some <tt>:on</tt> option will only run in the specified context.
+      def valid?(context = nil)
+        #context ||= (new_record? ? :create : :update)
+        output = super(context)
+        errors.empty? && output
+      end
+
+      module ClassMethods
+
+        # @param [Symbol|String] schema name
+        # @param [Hash<Symbol|String>] opts
+        # @options opts [String] :path schema path
+        # @options opts [SchemaTools::Reader] :reader instance, instead of global reader/registry
+        def validate_with(schema, opts={})
+          reader = opts[:reader] || SchemaTools::Reader
+          schema = reader.read(schema, opts[:path])
+          # make getter / setter
+          schema[:properties].each do |key, val|
+            validates_length_of key, validate_length_opts(val) if val['maxLength'] || val['minLength']
+            validates_presence_of key if val['required'] || val['required'] == 'true'
+            validates_numericality_of key, validate_number_opts(val) if val['type'] == 'number'
+            #TODO array minItems, max unique,  null, string
+            # format: date-time, regex color style, email,uri,  ..
+            validates_numericality_of key, validate_number_opts(val) if val['type'] == 'number'
+            #end
+          end
+        end
+
+        def validate_length_opts(attr)
+          opts = {}
+          opts[:within] = attr['minLength']..attr['maxLength'] if attr['minLength'] && attr['maxLength']
+          opts[:maximum] = attr['maxLength'] if attr['maxLength'] && !attr['minLength']
+          opts[:minimum] = attr['minLength'] if attr['minLength'] && !attr['maxLength']
+          opts[:allow_blank] = true if !attr['required']
+          opts
+        end
+
+        # @param [Hash<String>] attr property values
+        def validate_number_opts(attr)
+          opts = {}
+          opts[:allow_blank] = true
+          # those vals should not be set both in one property
+          opts[:greater_than_or_equal_to] = attr['minimum'] if attr['minimum'].present?
+          opts[:less_than_or_equal_to] = attr['maximum'] if attr['maximum'].present?
+          opts[:less_than] = attr['exclusiveMinimum'] if attr['exclusiveMinimum'].present?
+          opts[:greater_than] = attr['exclusiveMaximum'] if attr['exclusiveMaximum'].present?
+          opts
+        end
+
+      end # ClassMethods
+
+    end
+  end
+end

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/schema_tools.rb

@@ -3,6 +3,7 @@ require 'schema_tools/version'
 require 'schema_tools/modules/read'
 require 'schema_tools/modules/hash'
 require 'schema_tools/modules/attributes'
+require 'schema_tools/modules/validations'
 require 'schema_tools/reader'
 require 'schema_tools/cleaner'
 require 'schema_tools/hash'

data/spec/fixtures/client.json

@@ -1,7 +1,7 @@
 {"type":"object",
   "title": "client",
   "name": "client",
-  "description": "A client as seen by SalesKing",
+  "description": "A client in SalesKing",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -164,6 +164,8 @@
     },
     "cash_discount":{
       "description": "Default cash discount for new invoices.",
+      "maximum": 100,
+      "minimum": 0,
       "type":"number"
     },
     "due_days":{

data/spec/fixtures/lead.json

@@ -10,14 +10,14 @@
       "maxLength": 255
     },
     "links_clicked":{
-      "description": "Timestamps of clicks. Just an example to test nested array values without object reference",
+      "description": "Timestamps of clicks. Test nested array values without object reference",
       "type":"array",
       "properties":{
         "type": "string"
       }
     },
     "conversion":{
-      "description": "Just an example to test nested object value without object reference",
+      "description": "Test nested object value without object reference",
       "type":"object",
       "properties":{
         "from": {

data/spec/schema_tools/klass_factory_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class TestNamespaceKlass
-  # for schema classes
+  # namepsace for schema classes
 end
 
 module TestNamespaceModule
@@ -28,6 +28,42 @@ describe SchemaTools::KlassFactory do
 
   end
 
+  context 'with validations' do
+    it 'should add validations' do
+      SchemaTools::KlassFactory.build
+      client = Client.new
+      client.valid?
+      client.errors[:organisation][0].should include 'blank'
+    end
+
+    it 'should build with params' do
+      SchemaTools::KlassFactory.build
+      client = Client.new organisation: 'SalesKing'
+      client.valid?
+      client.errors.should be_blank
+    end
+
+    it 'should validate number maximum and minimum' do
+      SchemaTools::KlassFactory.build
+      client = Client.new cash_discount: 100, organisation: 'SalesKing'
+      client.should be_valid
+      #to big
+      client.cash_discount = 101
+      client.valid?
+      client.errors.full_messages[0].should include('less_than_or_equal_to')
+      # to small
+      client.cash_discount = -1
+      client.valid?
+      client.errors.full_messages[0].should include('greater_than_or_equal_to')
+    end
+
+    it 'should raise with invalid params' do
+      SchemaTools::KlassFactory.build
+      expect { Client.new id: 'SalesKing' }.to raise_error NoMethodError
+    end
+
+  end
+
   context 'class building with namespace' do
 
     after :each do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-01 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +131,7 @@ files:
 - lib/schema_tools/modules/attributes.rb
 - lib/schema_tools/modules/hash.rb
 - lib/schema_tools/modules/read.rb
+- lib/schema_tools/modules/validations.rb
 - lib/schema_tools/reader.rb
 - lib/schema_tools/version.rb
 - spec/fixtures/address.json
@@ -142,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3983792296207531443
+      hash: 4078782522717715484
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3983792296207531443
+      hash: 4078782522717715484
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24