schematic 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*~
+.DS_Store
+.bundle
+.idea
+Gemfile.lock
+doc
+pkg/*
+tags

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-p136@schematic

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in schematic.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010-11 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Schematic
+
+Automatic schema generation.

data/Rakefile

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

data/lib/schematic.rb

@@ -0,0 +1,15 @@
+module Schematic
+  class InvalidClass < Exception
+    def message
+      "This class does not include ActiveModel. You cannot generate an XSD from it."
+    end
+  end
+end
+
+require "builder"
+
+require 'active_support/inflector/inflections'
+require 'active_support/inflections'
+require "schematic/serializers/xsd"
+
+ActiveRecord::Base.send(:extend, Schematic::Serializers::Xsd)

data/lib/schematic/serializers/xsd.rb

@@ -0,0 +1,115 @@
+module Schematic
+  module Serializers
+    module Xsd
+      class << self
+        def extended(klass)
+          raise InvalidClass unless klass.ancestors.include?(ActiveRecord::Base)
+        end
+      end
+
+      def to_xsd(options = {}, builder = nil)
+        if builder.nil?
+          output = ""
+          builder = Builder::XmlMarkup.new(:target => output)
+          builder.instruct!
+          builder.xs :schema, "xmlns:xs" => "http://www.w3.org/2001/XMLSchema" do |schema|
+            schema.xs :element, "name" => xsd_element_collection_name, "type" => xsd_type_collection_name
+            self.to_xsd(options, schema)
+          end
+          output
+        else
+          xsd_nested_attributes.each do |nested_attribute|
+            nested_attribute.klass.to_xsd(options, builder)
+          end
+          builder.xs :complexType, "name" => xsd_type_collection_name do |complex_type|
+            complex_type.xs :sequence do |sequence|
+              sequence.xs :element, "name" => xsd_element_name, "type" => xsd_type_name, "minOccurs" => "0", "maxOccurs" => "unbounded"
+            end
+            complex_type.xs :attribute, "name" => "type", "type" => "xs:string", "fixed" => "array"
+          end
+          builder.xs :complexType, "name" => xsd_type_name do |complex_type|
+            additional_methods = xsd_methods.merge(options[:methods] || {})
+            complex_type.xs :all do |all|
+              xsd_columns.each do |column|
+                next if additional_methods.keys.map(&:to_s).include?(column.name)
+
+                all.xs :element, "name" => column.name.dasherize, "minOccurs" => "0", "maxOccurs" => "1" do |field|
+                  field.xs :complexType do |complex_type|
+                    complex_type.xs :simpleContent do |simple_content|
+                      simple_content.xs :extension, "base" => map_column_type_to_xsd_type(column) do |extension|
+                        extension.xs :attribute, "name" => "type", "type" => "xs:string", "use" => "optional"
+                      end
+                    end
+                  end
+                end
+              end
+              xsd_nested_attributes.each do |nested_attribute|
+                all.xs :element, "name" => "#{nested_attribute.name.to_s.dasherize}-attributes", "type" => nested_attribute.klass.xsd_type_collection_name, "minOccurs" => "0", "maxOccurs" => "1"
+              end
+              additional_methods.each do |method_name, values|
+                method_xsd_name = method_name.to_s.dasherize
+                if values.present?
+                  all.xs :element, "name" => method_xsd_name, "minOccurs" => "0", "maxOccurs" => "1" do |element|
+                    element.xs :complexType do |complex_type|
+                      complex_type.xs :all do |nested_all|
+                        values.each do |value|
+                          nested_all.xs :element, "name" => value.to_s.dasherize, "minOccurs" => "0"
+                        end
+                      end
+                      complex_type.xs :attribute, "name" => "type", "type" => "xs:string", "fixed" => "array", "use" => "optional"
+                    end
+                  end
+                else
+                  all.xs :element, "name" => method_xsd_name, "minOccurs" => "0", "maxOccurs" => "1"
+                end
+              end
+            end
+          end
+          builder
+        end
+      end
+
+      def xsd_methods
+        {}
+      end
+
+      def xsd_nested_attributes
+        self.reflect_on_all_associations.select do |association|
+          self.instance_methods.include?("#{association.name}_attributes=".to_sym) && association.options[:polymorphic] != true
+        end
+      end
+
+      def xsd_columns
+        self.columns
+      end
+
+      def map_column_type_to_xsd_type(column)
+        {
+          :integer => "xs:integer",
+          :float => "xs:float",
+          :string => "xs:string",
+          :text => "xs:string",
+          :datetime => "xs:dateTime",
+          :date => "xs:date",
+          :boolean => "xs:boolean"
+        }[column.type]
+      end
+
+      def xsd_type_name
+        self.name
+      end
+
+      def xsd_type_collection_name
+        xsd_type_name.pluralize
+      end
+
+      def xsd_element_name
+        self.name.underscore.dasherize
+      end
+
+      def xsd_element_collection_name
+        xsd_element_name.pluralize
+      end
+    end
+  end
+end

data/lib/schematic/version.rb

@@ -0,0 +1,3 @@
+module Schematic
+  VERSION = "0.0.1"
+end

data/schematic.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "schematic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "schematic"
+  s.version     = Schematic::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Case Commons, LLC"]
+  s.email       = ["casecommons-dev@googlegroups.com"]
+  s.homepage    = "https://github.com/Casecommons/schematic"
+  s.summary     = %q{Automatic XSD generation from ActiveRecord models}
+  s.description = %q{Automatic XSD generation from ActiveRecord models}
+
+  s.rubyforge_project = "schematic"
+
+  s.add_dependency('activerecord', '>= 3.0.0')
+  s.add_dependency('builder')
+  s.add_development_dependency('rspec-rails', '>= 2.1')
+  s.add_development_dependency('with_model')
+  s.add_development_dependency('nokogiri')
+  s.add_development_dependency('sqlite3')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/schematic_serializers_xsd_spec.rb

@@ -0,0 +1,172 @@
+require "spec_helper"
+
+describe Schematic::Serializers::Xsd do
+  before do
+    class EmptyModel < ActiveRecord::Base
+
+      def self.columns
+        []
+      end
+    end
+  end
+
+  describe ".extend" do
+    context "when the model inherits ActiveRecord::Base" do
+      subject { EmptyModel }
+
+      it "should allow the model to be extended" do
+        lambda {
+          subject.class_eval do
+          extend Schematic::Serializers::Xsd
+          end
+        }.should_not raise_error
+      end
+    end
+
+    context "when the model does not inherit ActiveRecord::Base" do
+      subject { Object }
+
+      it "should raise an exception" do
+        lambda {
+          subject.class_eval do
+          extend Schematic::Serializers::Xsd
+          end
+        }.should raise_error(Schematic::InvalidClass)
+      end
+    end
+  end
+
+  describe ".to_xsd" do
+    context "for an empty model with no attributes or validations" do
+      subject { EmptyModel.to_xsd }
+
+      it "should return an xsd for an array of the model" do
+        xsd = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="empty-models" type="EmptyModels"/>
+  <xs:complexType name="EmptyModels">
+    <xs:sequence>
+      <xs:element name="empty-model" type="EmptyModel" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="type" type="xs:string" fixed="array"/>
+  </xs:complexType>
+  <xs:complexType name="EmptyModel">
+    <xs:all>
+    </xs:all>
+  </xs:complexType>
+</xs:schema>
+        XML
+        subject.should == sanitize_xml(xsd)
+      end
+
+    end
+
+    context "for a model with attributes" do
+
+      subject { SomeModel.to_xsd }
+
+      context "for a any attribute" do
+        with_model :some_model do
+          table :id => false do |t|
+            t.float 'some_float'
+          end
+        end
+
+        it "should define the correct xsd element" do
+          xsd = generate_xsd_for_model(SomeModel) do
+            <<-XML
+              <xs:element name="some-float" minOccurs="0" maxOccurs="1">
+                <xs:complexType>
+                  <xs:simpleContent>
+                    <xs:extension base="xs:float">
+                      <xs:attribute name="type" type="xs:string" use="optional"/>
+                    </xs:extension>
+                  </xs:simpleContent>
+                </xs:complexType>
+              </xs:element>
+            XML
+          end
+
+          subject.should == sanitize_xml(xsd)
+        end
+
+      end
+
+      describe "additional methods" do
+        with_model :some_model do
+          table {}
+        end
+
+        it "should include the additional method" do
+            xsd = generate_xsd_for_model(SomeModel) do
+            <<-XML
+              <xs:element name="id" minOccurs="0" maxOccurs="1">
+                <xs:complexType>
+                  <xs:simpleContent>
+                    <xs:extension base="xs:integer">
+                      <xs:attribute name="type" type="xs:string" use="optional"/>
+                    </xs:extension>
+                  </xs:simpleContent>
+                </xs:complexType>
+              </xs:element>
+              <xs:element name="foo-bar" minOccurs="0" maxOccurs="1"/>
+            XML
+          end
+
+          SomeModel.to_xsd(:methods => {:foo_bar => nil}).should == sanitize_xml(xsd)
+        end
+      end
+
+      describe "nested attributes" do
+
+      end
+
+    end
+
+    context "with a model with validations" do
+      context "presence of validation" do
+        context "when allow blank is true" do
+
+        end
+
+        context "when allow blank is false" do
+        end
+      end
+
+      describe "length validation" do
+
+      end
+
+      describe "inclusion validation" do
+
+      end
+    end
+  end
+
+  private
+
+  def sanitize_xml(xml)
+    xml.split("\n").map(&:strip).join("")
+  end
+
+  def generate_xsd_for_model(model)
+    <<-XML
+    <?xml version="1.0" encoding="UTF-8"?>
+    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+      <xs:element name="#{model.xsd_element_collection_name}" type="#{model.xsd_type_collection_name}"/>
+      <xs:complexType name="#{model.xsd_type_collection_name}">
+        <xs:sequence>
+          <xs:element name="#{model.xsd_element_name}" type="#{model.xsd_type_name}" minOccurs="0" maxOccurs="unbounded"/>
+        </xs:sequence>
+        <xs:attribute name="type" type="xs:string" fixed="array"/>
+      </xs:complexType>
+      <xs:complexType name="#{model.xsd_type_name}">
+        <xs:all>
+          #{yield}
+        </xs:all>
+      </xs:complexType>
+    </xs:schema>
+    XML
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "active_record"
+require "with_model"
+require "schematic"
+
+RSpec.configure do |config|
+  config.extend WithModel
+end
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: schematic
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Case Commons, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: with_model
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Automatic XSD generation from ActiveRecord models
+email: 
+- casecommons-dev@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/schematic.rb
+- lib/schematic/serializers/xsd.rb
+- lib/schematic/version.rb
+- schematic.gemspec
+- spec/schematic_serializers_xsd_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/Casecommons/schematic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: schematic
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Automatic XSD generation from ActiveRecord models
+test_files: 
+- spec/schematic_serializers_xsd_spec.rb
+- spec/spec_helper.rb