json_schema_tools 0.0.6 → 0.0.7

data/README.md

@@ -111,6 +111,38 @@ methods to you local classes .. like people NOT using JSON schema
     # raw access
     contact.schema_attrs
 
+## Objects 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.
+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'
+
+
+Rather like a namespace? Good idea, but the class or module must be defined.
+
+    module SalesKing; end
+    SchemaTools::KlassFactory.build namespace: SalesKing
+    client = SalesKing::Client.new
+
+Add a custom schema reader
+
+    reader = SchemaTools::Reader.new
+    reader.path = HappyPdf::Schema.path
+    SchemaTools::KlassFactory.build reader: reader
+
+
+
+## Real world examples
+
+* [HappyPdf json schema](https://github.com/happyPDF/happypdf_json_schema) .. api gem will follow
+* [DocTag ruby gem](https://github.com/docTag/doctag_rb) and [DocTag json-schema](https://github.com/docTag/doctag_json_schema)
+* [SalesKing json schema](https://github.com/salesking/sk_api_schema)
+
 ## Test
 
 Only runs on Ruby 1.9

data/json_schema_tools.gemspec

@@ -4,12 +4,12 @@ require 'schema_tools/version'
 
 Gem::Specification.new do |s|
   s.name        = 'json_schema_tools'
-  s.version     = SchemaBuilder::VERSION
+  s.version     = SchemaTools::VERSION
   s.authors     = ['Georg Leciejewski']
   s.email       = ['gl@salesking.eu']
-  s.homepage    = 'http://www.salesking.eu/dev'
-  s.summary     = %q{JSON Schema API tools.}
-  s.description = %q{Want to create a JSON Schema powered API? This toolset provides methods to read schemata, render objects as defined in schema, clean parameters according to schema, ...}
+  s.homepage    = 'https://github.com/salesking/json_schema_tools'
+  s.summary     = %q{JSON Schema API tools for server and client side}
+  s.description = %q{Want to create or read a JSON Schema powered API? This toolset provides methods to read schemata, render objects as defined in schema, clean parameters according to schema, ...}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/schema_tools/klass_factory.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'active_support/core_ext/string/inflections'
+module SchemaTools
+  class KlassFactory
+
+    class << self
+
+      # Build classes from schema inside the given namespace. Uses all classes
+      # found in schema path
+      #
+      # @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
+      def build(opts={})
+        reader = opts[:reader] || SchemaTools::Reader
+        schemata = reader.read_all( opts[:path] || SchemaTools.schema_path )
+        namespace = opts[:namespace] || Object
+        if namespace.is_a?(String) || namespace.is_a?(Symbol)
+          namespace = "#{namespace}".constantize
+        end
+
+        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
+            has_schema_attrs schema['name'], reader: reader
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/schema_tools/modules/attributes.rb

@@ -15,8 +15,10 @@ module SchemaTools
         # @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 has_schema_attrs(schema, opts={})
-          schema = SchemaTools::Reader.read(schema, opts[:path])
+          reader = opts[:reader] || SchemaTools::Reader
+          schema = reader.read(schema, opts[:path])
           # make getter / setter
           schema[:properties].each do |key, val|
             # getter

data/lib/schema_tools/version.rb

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

data/lib/schema_tools.rb

@@ -6,6 +6,7 @@ require 'schema_tools/modules/attributes'
 require 'schema_tools/reader'
 require 'schema_tools/cleaner'
 require 'schema_tools/hash'
+require 'schema_tools/klass_factory'
 
 
 module SchemaTools

data/spec/schema_tools/klass_factory_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+class TestNamespaceKlass
+  # for schema classes
+end
+
+module TestNamespaceModule
+
+end
+
+describe SchemaTools::KlassFactory do
+
+  after :each do
+    SchemaTools::Reader.registry_reset
+
+    # try cleaning objs
+    Object.send :remove_const, 'Client' if Object.const_defined? 'Client'
+    TestNamespaceKlass.send :remove_const, 'Client' if TestNamespaceKlass.const_defined? 'Client'
+    TestNamespaceModule.send :remove_const, 'Client' if TestNamespaceModule.const_defined? 'Client'
+  end
+
+  context 'class building' do
+    it 'should build from class name' do
+      SchemaTools::KlassFactory.build
+      expect { Client.new }.to_not raise_error
+      expect { Lead.new }.to_not raise_error
+    end
+
+  end
+
+  context 'class building with namespace' do
+
+    after :each do
+    end
+
+    it 'should build from class name' do
+      SchemaTools::KlassFactory.build(namespace: TestNamespaceKlass)
+      expect { TestNamespaceKlass::Client.new }.to_not raise_error
+    end
+
+    it 'should build from class as string' do
+      SchemaTools::KlassFactory.build(namespace: 'TestNamespaceKlass')
+      expect { TestNamespaceKlass::Client.new }.to_not raise_error
+    end
+    it 'should build from module name' do
+      SchemaTools::KlassFactory.build(namespace: TestNamespaceModule)
+      expect { TestNamespaceModule::Client.new }.to_not raise_error
+    end
+
+    it 'should build from module name as string' do
+      SchemaTools::KlassFactory.build(namespace: 'TestNamespaceModule')
+      expect { TestNamespaceModule::Client.new }.to_not raise_error
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-31 00:00:00.000000000 Z
+date: 2013-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -91,9 +91,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Want to create a JSON Schema powered API? This toolset provides methods
-  to read schemata, render objects as defined in schema, clean parameters according
-  to schema, ...
+description: Want to create or read a JSON Schema powered API? This toolset provides
+  methods to read schemata, render objects as defined in schema, clean parameters
+  according to schema, ...
 email:
 - gl@salesking.eu
 executables: []
@@ -111,6 +111,7 @@ files:
 - lib/schema_tools.rb
 - lib/schema_tools/cleaner.rb
 - lib/schema_tools/hash.rb
+- lib/schema_tools/klass_factory.rb
 - lib/schema_tools/modules/attributes.rb
 - lib/schema_tools/modules/hash.rb
 - lib/schema_tools/modules/read.rb
@@ -123,10 +124,11 @@ files:
 - spec/fixtures/page.json
 - spec/schema_tools/cleaner_spec.rb
 - spec/schema_tools/hash_spec.rb
+- spec/schema_tools/klass_factory_spec.rb
 - spec/schema_tools/modules/attributes_spec.rb
 - spec/schema_tools/reader_spec.rb
 - spec/spec_helper.rb
-homepage: http://www.salesking.eu/dev
+homepage: https://github.com/salesking/json_schema_tools
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -140,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 77879165624642168
+      hash: -3983792296207531443
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,11 +151,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 77879165624642168
+      hash: -3983792296207531443
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: JSON Schema API tools.
+summary: JSON Schema API tools for server and client side
 test_files: []