schematic 0.6.2 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c76641aa454b778d4e26f79dc681629dcf6ef6a
+  data.tar.gz: dd47b6effb9ca6bc3036f8a71ebc840faba17fa4
+SHA512:
+  metadata.gz: 910d7a63f610016582b3c8d0a9e569e5c0d5cb2846582c7f142dfe6fa693d024d8f149ea37dc812eecf572c8e83bcbf2b635fd6bb84c6ff81f2f91265f99952a
+  data.tar.gz: 0846991be161e75ac8e44c4c22b2f097ad5a2536926c11cf697603314560b6098f2936237c81919fc94af325eced78b1c139d11a423542faa8d47d83fad24710

data/.gitignore

@@ -1,11 +1,17 @@
-.pairs
 *.gem
-*~
-.DS_Store
+*.rbc
 .bundle
-.idea
-.vimlog
+.config
+.yardoc
 Gemfile.lock
-doc
-pkg/*
-tags
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - "1.9"
+  - "2.0"
+  - "2.1"
+  - "jruby-19mode"
+  - "rbx-2.2"
+
+env:
+  - ACTIVE_RECORD_BRANCH="master"
+  - ACTIVE_RECORD_VERSION="~> 4.1.0"
+  - ACTIVE_RECORD_VERSION="~> 4.0.0"
+
+matrix:
+  allow_failures:
+    - env: ACTIVE_RECORD_BRANCH="master"

data/Gemfile

@@ -1,4 +1,9 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in schematic.gemspec
 gemspec
+
+gem 'activerecord', :github => 'rails', :branch => ENV['ACTIVE_RECORD_BRANCH'] if ENV['ACTIVE_RECORD_BRANCH']
+gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
+gem 'sqlite3', '1.3.8', :platforms => :ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-11 Case Commons, LLC
+Copyright (c) 2010-2014 Case Commons, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,106 @@
+# [Schematic](http://github.com/casecommons/schematic/)
+
+[![Build Status](https://secure.travis-ci.org/Casecommons/schematic.svg?branch=master)](https://travis-ci.org/Casecommons/schematic)
+[![Code Climate](https://img.shields.io/codeclimate/github/Casecommons/schematic.svg)](https://codeclimate.com/github/Casecommons/schematic)
+[![Gem Version](https://badge.fury.io/rb/schematic.svg)](https://rubygems.org/gems/schematic)
+
+Automatic XSD generation for your ActiveRecord models.
+
+## Installation
+
+Install as usual: `gem install schematic` or add `gem 'schematic'` to your Gemfile. See `.travis.yml` for supported (tested) Ruby versions.
+
+## Usage
+  
+```ruby
+class Post < ActiveRecord::Base
+end
+
+Post.to_xsd #=> (a bunch of xml)
+```
+
+Validations will automatically add restrictions to the XSD for fields. If a validation has a conditional if or unless option it will be skipped. However if you wish to force the inclusion of the validation in the XSD you can set: `{ :xsd => { :include => true } }` in the options e.g.
+
+```ruby
+class Post < ActiveRecord::Base
+  validates :category, :inclusion => { :in => ["foo", "bar"], :xsd => { :include => true } }, :if => lambda { ... }
+end
+```
+
+You can include or exclude additional elements:
+
+```ruby
+class Post < ActiveRecord::Base
+  schematic do
+    element :title
+    element :author => [:name, :email, :url]
+    element :blog => { :post => { :category => nil } }
+    ignore :comments
+    ignore :attachments => [:filetype]
+  end
+end
+```
+
+You can also change the name of the root tag:
+
+```ruby
+class Post < ActiveRecord::Base
+  schematic do
+    root "blog-post"
+  end
+end
+```
+
+If you want to programatically include or exclude elements use `Post#schematic_sandbox.added_elements` and `Post#schematic_sandbox.ignored_elements`.
+
+The former is a Hash and the latter is an Array.
+
+You can define your own custom restrictions by inheriting from the Restrictions Base class:
+
+```ruby
+class MyCustomRestriction < Schematic::Generator::Restrictions::Base
+  def generate(builder)
+    for_validator ActiveModel::BlockValidator do |validator|
+      builder.xs(:enumeration, "value" => "foo")
+      builder.xs(:enumeration, "value" => "bar")
+    end
+  end
+end
+```
+
+You can have a custom pattern restriction from a custom validator:
+
+```ruby
+class MyValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    # ...
+  end
+
+  def xsd_pattern_restrictions
+    [/foo/, /bar/]
+  end
+end
+```
+
+You can have a custom enumeration restriction from a custom validator:
+
+```ruby
+class MyValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    # ...
+  end
+
+  def xsd_field_enumeration_restrictions
+    ["foo", "bar"]
+  end
+end
+```
+
+## Requirements
+
+- ActiveRecord 4.x
+
+## License
+
+Copyright © 2010–2014 Case Commons, LLC.
+Licensed under the MIT license, available in the “LICENSE” file.

data/Rakefile

@@ -1,12 +1,7 @@
-require 'rake'
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-require 'bundler'
-Bundler::GemHelper.install_tasks
+desc 'Run specs'
+RSpec::Core::RakeTask.new
 
 task :default => :spec
-
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec)
-

data/lib/schematic.rb

@@ -1,44 +1,5 @@
-module Schematic
-  class ClassMissingXmlSerializer < Exception
-    def message
-      "This class does not include ActiveModel::Serializers::Xml. You cannot generate an XSD from it."
-    end
-  end
-
-  class ClassMissingAttributes < Exception
-    def message
-      "This class does not implement #attributes. You cannot generate an XSD from it."
-    end
-  end
-
-  module Generator
-    autoload :Sandbox, 'schematic/generator/sandbox'
-    autoload :Xsd, 'schematic/generator/xsd'
-    autoload :Names, 'schematic/generator/names'
-    autoload :Namespaces, 'schematic/generator/namespaces'
-    autoload :Column, 'schematic/generator/column'
-    autoload :ColumnValidator, 'schematic/generator/column_validator'
-    autoload :Types, 'schematic/generator/types'
-    autoload :Uniqueness, 'schematic/generator/uniqueness'
-
-    module Restrictions
-      autoload :Base, 'schematic/generator/restrictions/base'
-      autoload :Custom, 'schematic/generator/restrictions/custom'
-      autoload :Enumeration, 'schematic/generator/restrictions/enumeration'
-      autoload :Length, 'schematic/generator/restrictions/length'
-      autoload :Pattern, 'schematic/generator/restrictions/pattern'
-      autoload :Numericality, 'schematic/generator/restrictions/numericality'
-    end
-  end
-  module Serializers
-    autoload :Xsd, 'schematic/serializers/xsd'
-  end
-
-  autoload :Version, 'schematic/version'
-end
-
-require "builder"
-require 'active_support/inflector/inflections'
-require 'active_support/inflections'
+require 'schematic/version'
+require 'schematic/serializers/xsd'
 
+require 'active_record/base'
 ActiveRecord::Base.send(:extend, Schematic::Serializers::Xsd)

data/lib/schematic/exceptions.rb

@@ -0,0 +1,13 @@
+module Schematic
+  class ClassMissingXmlSerializer < Exception
+    def message
+      'This class does not include ActiveModel::Serializers::Xml. You cannot generate an XSD from it.'
+    end
+  end
+
+  class ClassMissingAttributes < Exception
+    def message
+      'This class does not implement #attributes. You cannot generate an XSD from it.'
+    end
+  end
+end

data/lib/schematic/generator/column.rb

@@ -1,11 +1,17 @@
+require 'active_model/validations/presence'
+require 'schematic/generator/restrictions/custom'
+require 'schematic/generator/restrictions/enumeration'
+require 'schematic/generator/restrictions/length'
+require 'schematic/generator/restrictions/numericality'
+require 'schematic/generator/restrictions/pattern'
+
 module Schematic
   module Generator
     class Column
       attr_accessor :restriction_classes
-      class << self
-        def restriction_classes
-          @restriction_classes ||= [Restrictions::Length, Restrictions::Enumeration, Restrictions::Numericality, Restrictions::Pattern, Restrictions::Custom]
-        end
+
+      def self.restriction_classes
+        Restrictions::Base.descendants.freeze
       end
 
       def initialize(klass, column, additional_methods = {}, ignored_methods = {}, required_methods = [], non_required_methods = [])
@@ -21,16 +27,16 @@ module Schematic
         return if skip_generation?
 
         options = {
-          "name" => @column.name.dasherize,
-          "minOccurs" => minimum_occurrences_for_column.to_s,
-          "maxOccurs" => "1"
+          'name' => @column.name.dasherize,
+          'minOccurs' => minimum_occurrences_for_column.to_s,
+          'maxOccurs' => '1'
         }
-        options.merge!({"nillable" => "false"}) if minimum_occurrences_for_column > 0
+        options.merge!({'nillable' => 'false'}) if minimum_occurrences_for_column > 0
 
         builder.xs :element, options do |field|
           field.xs :complexType do |complex_type|
             complex_type.xs :simpleContent do |simple_content|
-              simple_content.xs :restriction, "base" => map_type(@column) do |restriction|
+              simple_content.xs :restriction, 'base' => map_type(@column) do |restriction|
                 self.class.restriction_classes.each do |restriction_class|
                   restriction_class.new(@klass, @column).generate(restriction)
                 end
@@ -45,7 +51,7 @@ module Schematic
         return 1 if @required_methods.include?(@column.name.to_sym)
         return 0 unless @klass.respond_to?(:_validators)
         @klass._validators[@column.name.to_sym].each do |column_validation|
-          next unless column_validation.is_a?  ActiveModel::Validations::PresenceValidator
+          next unless column_validation.is_a? ActiveModel::Validations::PresenceValidator
           if column_validation.options[:allow_blank] != true &&
             column_validation.options[:if].nil? &&
             column_validation.options[:unless].nil?
@@ -57,7 +63,7 @@ module Schematic
       end
 
       def map_type(column)
-        Types::COMPLEX[column.type][:complex_type]
+        Types::COMPLEX.fetch(column.type)[:complex_type]
       end
 
       def skip_generation?

data/lib/schematic/generator/namespaces.rb

@@ -3,9 +3,9 @@ module Schematic
     class Namespaces
       PROVIDERS = {
         :w3 => {
-          :schema => "http://www.w3.org/2001/XMLSchema"
-        }
-      }
+          :schema => 'http://www.w3.org/2001/XMLSchema'.freeze
+        }.freeze
+      }.freeze
     end
   end
 end

data/lib/schematic/generator/restrictions/base.rb

@@ -1,13 +1,13 @@
+require 'active_support/descendants_tracker'
+require 'schematic/generator/column'
+require 'schematic/generator/column_validator'
+
 module Schematic
   module Generator
     module Restrictions
       class Base < Schematic::Generator::ColumnValidator
-        def self.inherited(klass)
-          Schematic::Generator::Column.restriction_classes << klass unless Schematic::Generator::Column.restriction_classes.include?(klass)
-        end
+        extend ActiveSupport::DescendantsTracker
       end
     end
   end
 end
-
-

data/lib/schematic/generator/restrictions/custom.rb

@@ -1,3 +1,5 @@
+require 'schematic/generator/restrictions/base'
+
 module Schematic
   module Generator
     module Restrictions
@@ -6,7 +8,7 @@ module Schematic
           validators_for_column.each do |validator|
             if validator.respond_to?(:xsd_pattern_restrictions)
               validator.xsd_pattern_restrictions.each do |restriction|
-                builder.xs(:pattern, "value" => restriction.is_a?(Regexp) ? restriction.source : restriction)
+                builder.xs(:pattern, 'value' => restriction.is_a?(Regexp) ? restriction.source : restriction)
               end
               return
             end
@@ -16,4 +18,3 @@ module Schematic
     end
   end
 end
-

data/lib/schematic/generator/restrictions/enumeration.rb

@@ -1,3 +1,6 @@
+require 'active_model/validations/inclusion'
+require 'schematic/generator/restrictions/base'
+
 module Schematic
   module Generator
     module Restrictions
@@ -11,13 +14,13 @@ module Schematic
               valid_values = validator.options[:in]
             end
             valid_values.each do |value|
-              builder.xs(:enumeration, "value" => value)
+              builder.xs(:enumeration, 'value' => value)
             end
           end
           enumeration_method = "xsd_#{column.name}_enumeration_restrictions".to_sym
           if klass.respond_to? enumeration_method
             klass.send(enumeration_method).each do |enumeration|
-              builder.xs(:enumeration, "value" => enumeration)
+              builder.xs(:enumeration, 'value' => enumeration)
             end
           end
         end

data/lib/schematic/generator/restrictions/length.rb

@@ -1,11 +1,13 @@
+require 'schematic/generator/restrictions/base'
+
 module Schematic
   module Generator
     module Restrictions
       class Length < Base
         def generate(builder)
           for_validator ActiveModel::Validations::LengthValidator do |validator|
-            builder.xs(:maxLength, "value" => validator.options[:maximum]) if validator.options[:maximum]
-            builder.xs(:minLength, "value" => validator.options[:minimum]) if validator.options[:minimum]
+            builder.xs(:maxLength, 'value' => validator.options[:maximum]) if validator.options[:maximum]
+            builder.xs(:minLength, 'value' => validator.options[:minimum]) if validator.options[:minimum]
           end
         end
       end

data/lib/schematic/generator/restrictions/numericality.rb

@@ -1,10 +1,12 @@
+require 'schematic/generator/restrictions/base'
+
 module Schematic
   module Generator
     module Restrictions
       class Numericality < Base
         def generate(builder)
           for_validator ActiveModel::Validations::NumericalityValidator do |validator|
-            builder.xs(:pattern, "value" => "\\d+")
+            builder.xs(:pattern, 'value' => '\d+')
           end
         end
       end

data/lib/schematic/generator/restrictions/pattern.rb

@@ -1,3 +1,6 @@
+require 'active_model/validations/format'
+require 'schematic/generator/restrictions/base'
+
 module Schematic
   module Generator
     module Restrictions
@@ -10,7 +13,7 @@ module Schematic
               value.gsub!(/(?:\$|\\Z|\\z)?$/, '')
               value.gsub!(/\\\$/, '$')
               value.gsub!(/\(\?:/, '(')
-              builder.xs(:pattern, "value" => value)
+              builder.xs(:pattern, 'value' => value)
             end
           end
         end
@@ -18,5 +21,3 @@ module Schematic
     end
   end
 end
-
-