json_schema_tools 0.1.0 → 0.1.1

data/.travis.yml

@@ -1,5 +1,8 @@
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
 gemfile:
-  - Gemfile
+  - Gemfile
+env:
+- 'RAILS_VERSION=4'
+- 'RAILS_VERSION=3.2.13'

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog JSON Schema Tools
 
 
+2013-06
+
+* *has_schema_attr :schema=>{schema as ruby hash}* allow pass a schema as hash
+* *SchemaTools::Reader.read('name', {Schema Hash}|'String Path'  )*  init a schema from hash additionally to passing a string as schema path
+* rails 4 (ActiveModel) compatibility
+* Testing with different ActiveModel Versions
+
+
 2013-02
 
 * add validations for classes generated by KlassFactory

data/Gemfile

@@ -1,2 +1,8 @@
 source :rubygems
-gemspec
+gemspec
+
+# allow testing with rails 4
+version = ENV['RAILS_VERSION'] || '>3'
+
+gem 'activesupport', version
+gem 'activemodel', version

data/README.md

@@ -21,34 +21,48 @@ Before the fun begins, with any of the tools, one or multiple JSON schema files
 must be available(read into a hash). So first provide a base path where the
 schema.json files are located.
 
-    SchemaTools.schema_path = '/path/to/schema-json-files'
+```ruby
+SchemaTools.schema_path = '/path/to/schema-json-files'
+```
 
 Read a single schema:
 
-    schema = SchemaTools::Reader.read :client
-    
+```ruby
+schema = SchemaTools::Reader.read :client
+```
+
 Read a schema from an existing Ruby hash:
 
-    schema = SchemaTools::Reader.read :client, { ... } 
+```ruby
+schema = SchemaTools::Reader.read :client, { ... }
+```
 
 Read multiple schemas, all *.json files in schema path
 
-    schemata = SchemaTools::Reader.read_all
+```ruby
+schemata = SchemaTools::Reader.read_all
+```
 
 Schemata are cached in registry
 
-    SchemaTools::Reader.registry[:client]
+```ruby
+SchemaTools::Reader.registry[:client]
+```
 
 Read files from a custom path?
 
-    schema = SchemaTools::Reader.read :client, 'my/path/to/json-files'
-    schemata = SchemaTools::Reader.read_all 'my/path/to/json-files'
+```ruby
+schema = SchemaTools::Reader.read :client, 'my/path/to/json-files'
+schemata = SchemaTools::Reader.read_all 'my/path/to/json-files'
+```
 
 Don't like the global path and registry? Go local:
 
-    reader = SchemaTools::Reader.new
-    reader.read :client, 'from/path'
-    reader.registry
+```ruby
+reader = SchemaTools::Reader.new
+reader.read :client, 'from/path'
+reader.registry
+```
 
 ## Object to Schema JSON
 
@@ -62,28 +76,36 @@ Following uses client.json schema(same as peter.class name) inside the global
 schema_path and adds properties to the clients_hash simply calling
 client.send('property-name'):
 
-    peter = Client.new name: 'Peter'
-    client_hash = SchemaTools::Hash.from_schema(peter)
-    #=> "client"=>{"id"=>12, "name"=> "Peter", "email"=>"",..} # whatever else you have as properties
-    # to_json is up to you .. or your rails controller
+```ruby
+peter = Client.new name: 'Peter'
+client_hash = SchemaTools::Hash.from_schema(peter)
+#=> "client"=>{"id"=>12, "name"=> "Peter", "email"=>"",..} # whatever else you have as properties
+# to_json is up to you .. or your rails controller
+```
 
 ### Customise Schema Hash
 
 Only use some fields e.g. to save bandwidth
 
-    client_hash = SchemaTools::Hash.from_schema(peter, fields:['id', 'name'])
-    #=> "client"=>{"id"=>12, "name"=> "Peter"}
+```ruby
+client_hash = SchemaTools::Hash.from_schema(peter, fields:['id', 'name'])
+#=> "client"=>{"id"=>12, "name"=> "Peter"}
+```
 
 Use a custom schema name e.g. to represent a client as contact. Assumes you also
 have a schema named contact.json
 
-    client_hash = SchemaTools::Hash.from_schema(peter, class_name: 'contact')
-    #=> "contact"=>{"id"=>12, "name"=> "Peter"}
+```ruby
+client_hash = SchemaTools::Hash.from_schema(peter, class_name: 'contact')
+#=> "contact"=>{"id"=>12, "name"=> "Peter"}
+```
 
 Use a custom schema path
 
-    client_hash = SchemaTools::Hash.from_schema(peter, path: 'path-to/json-files/')
-    #=> "client"=>{"id"=>12, "name"=> "Peter"}
+```ruby
+client_hash = SchemaTools::Hash.from_schema(peter, path: 'path-to/json-files/')
+#=> "client"=>{"id"=>12, "name"=> "Peter"}
+```
 
 ## Parameter cleaning
 
@@ -92,11 +114,13 @@ check incoming params.
 
 For example in a client controller
 
-    def create
-      SchemaTools::Cleaner.clean_params!(:client, params[:client])
-      # params[:client] now only has keys defined as writable in client.json schema
-      #..create and save client
-    end
+```ruby
+def create
+  SchemaTools::Cleaner.clean_params!(:client, params[:client])
+  # params[:client] now only has keys defined as writable in client.json schema
+  #..create and save client
+end
+```
 
 ## Object attributes from Schema
 
@@ -104,15 +128,17 @@ 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
 
-    class Contact
-      include SchemaTools::Modules::Attributes
-      has_schema_attrs :client
-    end
+```ruby
+class Contact
+  include SchemaTools::Modules::Attributes
+  has_schema_attrs :client
+end
 
-    contact = Client.new
-    contact.last_name = 'Rambo'
-    # raw access
-    contact.schema_attrs
+contact = Client.new
+contact.last_name = 'Rambo'
+# raw access
+contact.schema_attrs
+```
 
 ## Classes from Schema - KlassFactory
 
@@ -122,36 +148,56 @@ 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 first_name: 'Heinz'
-    client.name = 'Schultz'
-    client.valid?
-    client.errors.full_messages
-
+```ruby
+SchemaTools::KlassFactory.build
+client = Client.new first_name: 'Heinz'
+client.name = 'Schultz'
+client.valid?
+client.errors.full_messages
+```
 
 Rather like a namespace? Good idea, but don't forget the class or module must
 be defined.
 
-    SchemaTools::KlassFactory.build namespace: SalesKing
-    client = SalesKing::Client.new
+```ruby
+SchemaTools::KlassFactory.build namespace: SalesKing
+client = SalesKing::Client.new
+```
 
 Add a custom schema reader most likely usefull in conjunction with a custom path
 
-    reader = SchemaTools::Reader.new
-    SchemaTools::KlassFactory.build reader: reader, path: HappyPdf::Schema.path
+```ruby
+reader = SchemaTools::Reader.new
+SchemaTools::KlassFactory.build reader: reader, path: HappyPdf::Schema.path
+```
 
 ## 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)
+* .. Your UseCase here
 
 ## Test
 
-Only runs on Ruby 1.9
+Only runs on Ruby 1.9 and by default uses most recent ActiveModel version (>3).
 
     bundle install
-    bundle exec rake spec
+    rake spec
+
+Testing with different ActiveModel / ActiveSupport Versions:
+
+    RAILS_VERSION=3.1 bundle install
+    rake spec
+    # or if already installed
+    RAILS_VERSION=4 rake spec
+
+The RAILS_VERSION switch sets the version of the gems in the Gemfile and is only
+usefull in test env.
+
+
+# Credits
 
+* [Andy Nicholson](https://github.com/anicholson)
 
 Copyright 2012-1013, Georg Leciejewski, MIT License

data/json_schema_tools.gemspec

@@ -17,9 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'json'
-  s.add_dependency 'activesupport', '~> 3.2.13'
-  s.add_dependency 'activemodel',   '~> 3.2.13'
-
   s.add_development_dependency 'rake'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rspec'

data/lib/schema_tools/modules/attributes.rb

@@ -17,8 +17,9 @@ module SchemaTools
         # @options opts [String] :path schema path
         # @options opts [SchemaTools::Reader] :reader instance, instead of global reader/registry
         def has_schema_attrs(schema, opts={})
-          reader = opts[:reader] || SchemaTools::Reader
-          schema = reader.read(schema, opts[:path])
+          reader          = opts[:reader] || SchemaTools::Reader
+          schema_location = opts[:path]   || opts[:schema]
+          schema          = reader.read(schema, schema_location)
           # make getter / setter
           schema[:properties].each do |key, val|
             # getter
@@ -39,4 +40,4 @@ module SchemaTools
 
     end
   end
-end
+end

data/lib/schema_tools/modules/validations.rb

@@ -1,8 +1,12 @@
 require 'active_support/concern'
-require 'active_model/validations'
-require 'active_model/naming'
-require 'active_model/translation'
-require 'active_model/conversion'
+require 'active_model'
+# comment single files bcs. AM requires lazy and in rails 4 names have changed!
+# left them in for reference
+#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

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/schema_tools/klass_factory_spec.rb

@@ -50,11 +50,11 @@ describe SchemaTools::KlassFactory do
       #to big
       client.cash_discount = 101
       client.valid?
-      client.errors.full_messages[0].should include('less_than_or_equal_to')
+      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')
+      client.errors.full_messages[0].should include('greater than or equal to')
     end
 
     it 'should raise with invalid params' do

data/spec/schema_tools/modules/attributes_spec.rb

@@ -5,21 +5,42 @@ class Contact
   has_schema_attrs :client
 end
 
+class Numbers
+  include SchemaTools::Modules::Attributes
+  has_schema_attrs :numbers, :schema => schema_as_ruby_object
+end
+
 describe SchemaTools::Modules::Attributes do
 
   context 'included' do
-    let(:contact){Contact.new}
+    subject { Contact.new }
+
+    it 'should add getter methods' do
+      subject.should respond_to(:last_name)
+    end
+
+    it 'should add setter methods' do
+      subject.should respond_to('first_name=')
+    end
+
+    it 'should not add setter for readonly properties' do
+      subject.should_not respond_to('id=')
+    end
+  end
+
+  context 'attributes from dynamic schema' do
+    subject { Numbers.new }
 
     it 'should add getter methods' do
-      contact.respond_to?(:last_name).should be_true
+      subject.should respond_to(:numbers)
     end
 
     it 'should add setter methods' do
-      contact.respond_to?('first_name=').should be_true
+      subject.should respond_to('numbers=')
     end
 
     it 'should not add setter for readonly properties' do
-      contact.respond_to?('id=').should be_false
+      subject.should_not respond_to('id=')
     end
   end
 end

data/spec/schema_tools/reader_spec.rb

@@ -1,24 +1,6 @@
 require 'spec_helper'
 
 describe SchemaTools::Reader do
-  let(:ruby_schema) do
-    {
-      "type"=> "object",
-      "name"=> "numbers",
-      "properties"=> {
-        "numbers"=> {
-          "type"=> "array",
-          "items"=> {
-            "type"=> "number",
-            "minimum"=> 1,
-            "maximum"=> 100
-          },
-          "additionalProperties"=> false
-        }
-      },
-      "additionalProperties"=> false
-    }
-  end
 
   context 'class methods' do
 
@@ -44,7 +26,7 @@ describe SchemaTools::Reader do
     end
 
     it 'should read a schema from a Ruby Hash' do
-      schema = SchemaTools::Reader.read(:numbers, ruby_schema)
+      schema = SchemaTools::Reader.read(:numbers, schema_as_ruby_object)
 
       SchemaTools::Reader.registry[:numbers].should_not be_empty
 
@@ -68,7 +50,7 @@ describe SchemaTools::Reader do
     end
 
     it 'should read a single schema from Ruby Hash' do
-      schema = reader.read(:numbers, ruby_schema)
+      schema = reader.read(:numbers, schema_as_ruby_object)
       schema[:name].should == 'numbers'
       schema[:properties].should_not be_empty
     end

data/spec/spec_helper.rb

@@ -11,9 +11,12 @@ end
 $:.unshift(File.dirname(__FILE__))
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'json_schema_tools'
+require 'test_helpers'
 
 RSpec.configure do |config|
 end
 
 # set global json schema path for examples
 SchemaTools.schema_path = File.expand_path('../fixtures', __FILE__)
+
+puts "Testing with ActiveModel Version: #{ActiveModel.version rescue ActiveModel::VERSION::STRING}"

data/spec/test_helpers.rb

@@ -0,0 +1,22 @@
+def schema_as_ruby_object
+  {
+    "type" => "object",
+    "name" => "numbers",
+    "properties" => {
+      "numbers" => {
+        "type"  => "array",
+        "items" => {
+          "type"    => "number",
+          "minimum" => 1,
+          "maximum" => 100
+        },
+        "id" => {
+          "type"     => "number",
+          "readonly" => true
+        },
+        "additionalProperties" => false
+      }
+    },
+    "additionalProperties" => false
+  }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -27,38 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +113,7 @@ files:
 - spec/schema_tools/modules/attributes_spec.rb
 - spec/schema_tools/reader_spec.rb
 - spec/spec_helper.rb
+- spec/test_helpers.rb
 homepage: https://github.com/salesking/json_schema_tools
 licenses: []
 post_install_message: 
@@ -159,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1701013660137054767
+      hash: 2544977169694822683
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1701013660137054767
+      hash: 2544977169694822683
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24