nokogiri_schematron_builder 0.1.0

data/lib/nokogiri/xml/schematron/paragraph.rb

@@ -0,0 +1,36 @@
+require "nokogiri/xml/schematron/base"
+
+module Nokogiri
+  module XML
+    module Schematron
+      # The internal representation of the +<sch:p>+ XML element.
+      #
+      # For example:
+      #
+      #   paragraph = Nokogiri::XML::Schematron::Paragraph.new(nil, message: "Hello, world!")
+      #   # => #<Nokogiri::XML::Schematron::Paragraph:0x00007f848783e628 @parent=nil, @children=[], @options={:message=>"Hello, world!"}>
+      #   paragraph.to_builder.to_xml
+      #   # => "<?xml version=\"1.0\"?>\n<sch:p xmlns:sch=\"http://purl.oclc.org/dsdl/schematron\">Hello, world!</sch:p>\n"
+      #
+      class Paragraph < Nokogiri::XML::Schematron::Base
+        # @!attribute [rw] message
+        #   @return [String] the text content of the +<sch:p>+ XML element.
+        attribute :message
+
+        protected
+
+        def build!(xml)
+          xml["sch"].send(:p, xmlns) do
+            unless (s = send(:message)).nil?
+              xml.text(s)
+            end
+
+            super(xml)
+          end
+
+          return
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/schematron/pattern.rb

@@ -0,0 +1,150 @@
+require "nokogiri/xml/schematron/base"
+require "nokogiri/xml/schematron/nodes/context"
+require "nokogiri/xml/schematron/paragraph"
+require "nokogiri/xml/schematron/rule"
+
+module Nokogiri
+  module XML
+    module Schematron
+      # The internal representation of the +<sch:pattern>+ XML element.
+      #
+      # For example:
+      #
+      #   pattern = Nokogiri::XML::Schematron::Pattern.new(nil, id: "pattern1", name: "Example pattern")
+      #   # => #<Nokogiri::XML::Schematron::Pattern:0x00007f8486a71f18 @parent=nil, @children=[], @options={:id=>"pattern1", :name=>"Example pattern"}>
+      #   pattern.to_builder.to_xml
+      #   # => "<?xml version=\"1.0\"?>\n<sch:pattern xmlns:sch=\"http://purl.oclc.org/dsdl/schematron\" id=\"pattern1\" name=\"Example pattern\"/>\n"
+      #
+      class Pattern < Nokogiri::XML::Schematron::Base
+        # @!attribute [rw] id
+        #   @return [String] the value of the +@id+ XML attribute.
+        attribute :id
+
+        # @!attribute [rw] name
+        #   @return [String] the value of the +@name+ XML attribute.
+        attribute :name
+
+        # @!method context(context, **options, &block)
+        #   Create a new +Node::Context+ object.
+        #   @example Denest an abstract syntax tree into a sequence of zero or more +<sch:rule>+ XML elements.
+        #     # For example, the following...
+        #     context("/") do
+        #       require("ex:A") do
+        #         permit("ex:B") do
+        #           reject("ex:C")
+        #         end
+        #       end
+        #     end
+        #
+        #     # ...is equivalent to:
+        #     rule(context: "/") do
+        #       assert(test: "count(ex:A) &gt;= 1", message: "element \"ex:A\" is REQUIRED")
+        #     end
+        #     rule(context: "/ex:A") do
+        #       assert(test: "count(ex:B) &gt;= 0", message: "element \"ex:B\" is OPTIONAL")
+        #     end
+        #     rule(context: "/ex:A/ex:B") do
+        #       assert(test: "not(ex:C)", message: "element \"ex:C\" is NOT RECOMMENDED")
+        #     end
+        #   @example Create business rules for the XML representation of a set of values.
+        #     context("/") do
+        #       require("ex:Example") do
+        #         permit("ex:ExampleType") do
+        #           validates_inclusion_of "text()", in: ["A", "B", "C"]
+        #         end
+        #       end
+        #     end
+        #   @example Create business rules for the XML representation of a set of values that is augmented with an "Other" value.
+        #     context("/") do
+        #       require("ex:Example") do
+        #         permit("ex:ExampleType") do
+        #           validates_inclusion_of "text()", in: ["A", "B", "C", "Other"]
+        #         end
+        #       end
+        #       permit("ex:Example[ex:ExampleType and (ex:ExampleType/text() != 'Other')]") do
+        #         reject("ex:OtherExampleType")
+        #       end
+        #       permit("ex:Example[ex:ExampleType and (ex:ExampleType/text() = 'Other')]") do
+        #         require("ex:OtherExampleType")
+        #       end
+        #       permit("ex:Example[ex:OtherExampleType]") do
+        #         require("ex:ExampleType") do
+        #           validates_inclusion_of "text()", in: ["Other"]
+        #         end
+        #       end
+        #     end
+        #   @example Create business rules for the XML representation of a set of zero or more key-value pairs.
+        #     context("/") do
+        #       require("ex:KeyValuePairs") do
+        #         permit("ex:KeyValuePair") do
+        #           require("ex:Key") do
+        #             validates_inclusion_of "text()", in: ["A", "B", "C"]
+        #           end
+        #           require("ex:Value")
+        #         end
+        #         permit("ex:KeyValuePair[ex:Key/text() = 'A']/ex:Value") do
+        #           validates_inclusion_of "text()", in: ["a"]
+        #         end
+        #         permit("ex:KeyValuePair[ex:Key/text() = 'B']/ex:Value") do
+        #           validates_inclusion_of "text()", in: ["b"]
+        #         end
+        #         permit("ex:KeyValuePair[ex:Key/text() = 'C']/ex:Value") do
+        #           validates_inclusion_of "text()", in: ["c"]
+        #         end
+        #       end
+        #     end
+        #   @example Create business rules for an entity-relationship model.
+        #     context("//ex:UserAccount") do
+        #       require("@ID") do
+        #         validates_numericality_of "text()", greater_than_or_equal_to: 1
+        #       end
+        #       permit("ex:Username") do
+        #         validates_exclusion_of "text()", in: ["admin"]
+        #       end
+        #       reject("ex:Password")
+        #     end
+        #   @param context [String] the XPath.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @yieldparam node [Nokogiri::XML::Schematron::Node::Context] the +Node::Context+ object.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Node::Context] the +Node::Context+ object.
+        element :context, Nokogiri::XML::Schematron::Nodes::Context
+
+        # @!method p(**options, &block)
+        #   Create a new +Paragraph+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :message the text content of the +<sch:p>+ XML element.
+        #   @yieldparam p [Nokogiri::XML::Schematron::Paragraph] the internal representation of the +<sch:p>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Paragraph] the +Paragraph+ object.
+        element :p, Nokogiri::XML::Schematron::Paragraph
+
+        # @!method rule(**options, &block)
+        #   Create a new +Rule+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :context the value of the +@context+ XML attribute.
+        #   @option options [String] :id the value of the +@id+ XML attribute.
+        #   @yieldparam rule [Nokogiri::XML::Schematron::Rule] the internal representation of the +<sch:rule>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Rule] the +Rule+ object.
+        element :rule, Nokogiri::XML::Schematron::Rule
+
+        protected
+
+        def build!(xml)
+          xml["sch"].send(:pattern, %w(id name).inject(xmlns) { |acc, method_name|
+            unless (s = send(method_name.to_sym)).nil?
+              acc[method_name.to_s] = s
+            end
+
+            acc
+          }) do
+            super(xml)
+          end
+
+          return
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/schematron/rule.rb

@@ -0,0 +1,53 @@
+require "nokogiri/xml/schematron/assertion"
+require "nokogiri/xml/schematron/base"
+
+module Nokogiri
+  module XML
+    module Schematron
+      # The internal representation of the +<sch:rule>+ XML element.
+      #
+      # For example:
+      #
+      #   rule = Nokogiri::XML::Schematron::Rule.new(nil, id: "rule1", context: "//ex:Example")
+      #   # => #<Nokogiri::XML::Schematron::Rule:0x00007fa1fb9e8410 @parent=nil, @children=[], @options={:id=>"rule1", :context=>"//ex:Example"}>
+      #   rule.to_builder.to_xml
+      #   # => "<?xml version=\"1.0\"?>\n<sch:rule xmlns:sch=\"http://purl.oclc.org/dsdl/schematron\" id=\"rule1\" context=\"//ex:Example\"/>\n"
+      #
+      class Rule < Nokogiri::XML::Schematron::Base
+        # @!attribute [rw] context
+        #   @return [String] the value of the +@context+ XML attribute.
+        attribute :context
+
+        # @!attribute [rw] id
+        #   @return [String] the value of the +@id+ XML attribute.
+        attribute :id
+
+        # @!method assert(**options, &block)
+        #   Create a new +Assertion+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :message the text content of the +<sch:assert>+ XML element.
+        #   @option options [String] :test the value of the +@test+ XML attribute.
+        #   @yieldparam assert [Nokogiri::XML::Schematron::Assertion] the internal representation of the +<sch:assert>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Assertion] the +Assertion+ object.
+        element :assert, Nokogiri::XML::Schematron::Assertion
+
+        protected
+
+        def build!(xml)
+          xml["sch"].send(:rule, %w(id context).inject(xmlns) { |acc, method_name|
+            unless (s = send(method_name.to_sym)).nil?
+              acc[method_name.to_s] = s
+            end
+
+            acc
+          }) do
+            super(xml)
+          end
+
+          return
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/schematron/schema.rb

@@ -0,0 +1,85 @@
+require "nokogiri/xml/schematron/base"
+require "nokogiri/xml/schematron/namespace"
+require "nokogiri/xml/schematron/paragraph"
+require "nokogiri/xml/schematron/pattern"
+
+module Nokogiri
+  module XML
+    module Schematron
+      # The internal representation of the +<sch:schema>+ XML element.
+      #
+      # For example:
+      #
+      #   schema = Nokogiri::XML::Schematron::Schema.new(id: "schema1", title: "Example schema")
+      #   # => #<Nokogiri::XML::Schematron::Schema:0x00007fa1fb9e3b68 @parent=nil, @children=[], @options={:id=>"schema1", :title=>"Example schema"}>
+      #   schema.to_builder.to_xml
+      #   # => "<?xml version=\"1.0\"?>\n<sch:schema xmlns:sch=\"http://purl.oclc.org/dsdl/schematron\" id=\"schema1\" title=\"Example schema\"/>\n"
+      #
+      class Schema < Nokogiri::XML::Schematron::Base
+        # @!attribute [rw] id
+        #   @return [String] the value of the +@id+ XML attribute.
+        attribute :id
+
+        # @!attribute [rw] title
+        #   @return [String] the value of the +@title+ XML attribute.
+        attribute :title
+
+        # @!method ns(**options, &block)
+        #   Create a new +Namespace+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :prefix the value of the +@prefix+ XML attribute.
+        #   @option options [String] :uri the value of the +@uri+ XML attribute.
+        #   @yieldparam ns [Nokogiri::XML::Schematron::Namespace] the internal representation of the +<sch:ns>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Namespace] the +Namespace+ object.
+        element :ns, Nokogiri::XML::Schematron::Namespace
+
+        # @!method p(**options, &block)
+        #   Create a new +Paragraph+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :message the text content of the +<sch:p>+ XML element.
+        #   @yieldparam p [Nokogiri::XML::Schematron::Paragraph] the internal representation of the +<sch:p>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Paragraph] the +Paragraph+ object.
+        element :p, Nokogiri::XML::Schematron::Paragraph
+
+        # @!method pattern(**options, &block)
+        #   Create a new +Pattern+ object.
+        #   @param options [Hash<Symbol, Object>] the options.
+        #   @option options [String] :id the value of the +@id+ XML attribute.
+        #   @option options [String] :name the value of the +@name+ XML attribute.
+        #   @yieldparam pattern [Nokogiri::XML::Schematron::Pattern] the internal representation of the +<sch:pattern>+ XML element.
+        #   @yieldreturn [void]
+        #   @return [Nokogiri::XML::Schematron::Pattern] the +Pattern+ object.
+        element :pattern, Nokogiri::XML::Schematron::Pattern
+
+        # Create a new +Schema+ object.
+        #
+        # @param options [Hash<Symbol, Object>] the options.
+        # @option options [#to_s] :id the value of the +@id+ XML attribute.
+        # @option options [#to_s] :title the value of the +@title+ XML attribute.
+        # @yieldparam schema [Nokogiri::XML::Schematron::Schema] the internal representation of the +<sch:schema>+ XML element.
+        # @yieldreturn [void]
+        def initialize(**options, &block)
+          super(nil, **options, &block)
+        end
+
+        protected
+
+        def build!(xml)
+          xml["sch"].send(:schema, %w(id title).inject(xmlns) { |acc, method_name|
+            unless (s = send(method_name.to_sym)).nil?
+              acc[method_name.to_s] = s
+            end
+
+            acc
+          }) do
+            super(xml)
+          end
+
+          return
+        end
+      end
+    end
+  end
+end

data/lib/nokogiri/xml/schematron/version.rb

@@ -0,0 +1,7 @@
+module Nokogiri
+  module XML
+    module Schematron
+      VERSION = "0.1.0"
+    end
+  end
+end

data/nokogiri_schematron_builder.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nokogiri/xml/schematron/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nokogiri_schematron_builder"
+  spec.version       = Nokogiri::XML::Schematron::VERSION
+  spec.authors       = ["Mark Borkum"]
+  spec.email         = ["mark.borkum@pnnl.gov"]
+  spec.license       = "BSD-2-Clause"
+  spec.summary       = %q{Build Schematron XML documents using Nokogiri.}
+  spec.description   = %q{NokogiriSchematronBuilder is a Ruby library for building Schematron XML documents using Nokogiri.}
+  spec.homepage      = "https://github.com/pnnl/nokogiri_schematron_builder"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: nokogiri_schematron_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Borkum
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: NokogiriSchematronBuilder is a Ruby library for building Schematron XML
+  documents using Nokogiri.
+email:
+- mark.borkum@pnnl.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- WARRANTY.txt
+- bin/console
+- bin/setup
+- lib/nokogiri/xml/schematron.rb
+- lib/nokogiri/xml/schematron/assertion.rb
+- lib/nokogiri/xml/schematron/base.rb
+- lib/nokogiri/xml/schematron/internal/core_ext/array.rb
+- lib/nokogiri/xml/schematron/namespace.rb
+- lib/nokogiri/xml/schematron/nodes/base.rb
+- lib/nokogiri/xml/schematron/nodes/context.rb
+- lib/nokogiri/xml/schematron/nodes/permit.rb
+- lib/nokogiri/xml/schematron/nodes/reject.rb
+- lib/nokogiri/xml/schematron/nodes/require.rb
+- lib/nokogiri/xml/schematron/nodes/validations/exclusion.rb
+- lib/nokogiri/xml/schematron/nodes/validations/inclusion.rb
+- lib/nokogiri/xml/schematron/nodes/validations/numericality.rb
+- lib/nokogiri/xml/schematron/paragraph.rb
+- lib/nokogiri/xml/schematron/pattern.rb
+- lib/nokogiri/xml/schematron/rule.rb
+- lib/nokogiri/xml/schematron/schema.rb
+- lib/nokogiri/xml/schematron/version.rb
+- nokogiri_schematron_builder.gemspec
+homepage: https://github.com/pnnl/nokogiri_schematron_builder
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Build Schematron XML documents using Nokogiri.
+test_files: []