xml_schema 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff48690d0cb01933c7741f459b3e2f0f5659b345
+  data.tar.gz: 3ee04f08574b8348ab331b95d944167eb34780a6
+SHA512:
+  metadata.gz: 7dee738cb196c977812d2753394c8fc614abe4dffd2ca2125e5a5d2392825a405975b946069cfbe4ef26f8dc3a7d81813d06d6caf90b12903378d30e0427d0a6
+  data.tar.gz: aad15ed12b80ca1ef3cbd11c2d87040a1e353b14c6c8f5312802d56a7a110fb52791956da76d44fd23632fcec2831fb324677db45d61796b61a640c17823bda9

data/ChangeLog

@@ -1,3 +1,7 @@
+xml_schema (0.2.0)
+
+  * introducing LocalizedString to handle string literals like "hello@en"
+
 xml_schema (0.1.2)
 
   * fix for comparing URIs ending in "/"

data/README.md

@@ -0,0 +1,41 @@
+# XML Schema
+
+`XmlSchema` gem is a simple convertor utility for XML Schema (literal) datatypes to/from native Ruby objects.
+
+
+# Usage
+
+    $ require "xml_schema"
+
+    $ XmlSchema.datatype_of(true)  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2001/XMLSchema#boolean>
+    $ XmlSchema.datatype_of(Time.now)  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2001/XMLSchema#time>
+
+    $ XmlSchema.instantiate("55^^<http://www.w3.org/2001/XMLSchema#int>")  # => 55
+
+XmlSchema also provides means to access and work with frequently used namespaces:
+
+    $ NS::OWL.uri  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2002/07/owl>
+    $ NS::RDFS["hello"]  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2000/01/rdf-schema#hello>
+
+That's pretty much all there is to it.
+
+
+# Extras
+
+This gem introduces LocalizedString to handle localized string literals.
+
+    $ s = LocalizedString.new("hello", :en)
+    $ s.lang  # => :en
+    $ XMLSchema.instantiate("hello@en")  # => <LocalizedString: "hello">
+
+When compared to a String object, language is ignored and only the string content is compared.
+When compared to another LocalizedString, languages are also compared.
+
+You can also initialize a LocalizedString as follows:
+
+    $ "bonjour".with_lang(:fr)  # => "bonjour"
+
+
+# Authors
+
+- [Slava Kravchenko](https://github.com/cordawyn)

data/lib/ext/localized_string.rb

@@ -0,0 +1,30 @@
+# LocalizedString is just a common String with "lang" attribute,
+# which specifies the language of the text stored in the string.
+#
+# @example
+#   str = LocalizedString.new("Hello", :en)
+#   "Bonjour".with_lang(:fr) == str # => false
+class LocalizedString < String
+  attr_reader :lang
+
+  def initialize(str, lng = nil)
+    @lang = lng
+    super str
+  end
+
+  # In addition to comparing string values
+  # LocalizedString also compares "lang" values.
+  # When compared to a common String,
+  # "lang" value is ignored.
+  #
+  # @param [String, LocalizedString] str
+  # @return [Boolean]
+  def eql?(str)
+    if str.respond_to?(:lang)
+      self.lang == str.lang && super
+    else
+      super
+    end
+  end
+  alias :== :eql?
+end

data/lib/ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  # Helper method to set the language of the string.
+  #
+  # @example
+  #   "Bonjour".with_lang(:fr).sub(/.$/, "s")
+  #
+  # @return [self]
+  def with_lang(lng)
+    LocalizedString.new(self, lng)
+  end
+end

data/lib/xml_schema.rb

@@ -1,15 +1,15 @@
 require 'time'
 require 'xml_schema/ns'
+require 'ext/string'
+require 'ext/localized_string'
 
 module XmlSchema
   TYPES = %w(integer boolean float dateTime time date string decimal double duration gYearMonth gYear gMonthDay gDay gMonth hexBinary base64Binary anyURI QName NOTATION)
 
-
   # Obtain XML Schema datatype URI for a Ruby object.
   def self.datatype_of(object)
     #--
     # TODO: decimal, double, duration (Range?), gYearMonth, gYear, gMonthDay, gDay, gMonth, hexBinary, base64Binary, anyURI, QName, NOTATION
-    # TODO: language tag?
     #++
     case object.class.name
     when "Fixnum", "Integer"
@@ -24,7 +24,7 @@ module XmlSchema
       NS::XMLSchema['time']
     when "Date"
       NS::XMLSchema['date']
-    when "String"
+    when "String", "LocalizedString"
       NS::XMLSchema['string']
     else
       raise "#{object.class} cannot be coerced into any XMLSchema datatype"
@@ -36,7 +36,15 @@ module XmlSchema
   # +literal+ is interpreted as RDF typed literal (with datatype postfix).
   def self.instantiate(literal, datatype_uri = nil)
     # NOTE: removing language tag (e.g. "@en")
-    full_literal = datatype_uri ? literal.sub(/@\w+$/, '') + "^^<#{datatype_uri}>" : literal.sub(/@\w+$/, '')
+    lang_regexp = /@(\w+{2})$/
+    lang = nil
+    if literal =~ lang_regexp
+      lang = $1
+      # make a local copy of literal, with removed lang tag
+      literal = literal.sub(lang_regexp, "")
+    end
+    
+    full_literal = datatype_uri ? literal + "^^<#{datatype_uri}>" : literal
     literal_value, literal_type = full_literal.split('^^')
     datatype =
       if literal_type
@@ -51,7 +59,7 @@ module XmlSchema
         'string'
       end
 
-    # clean-up the literal_value
+    # clean-up literal_value
     literal_value.sub!(/^["']/, '')
     literal_value.sub!(/["']$/, '')
 
@@ -69,8 +77,12 @@ module XmlSchema
     when 'float'
       literal_value.to_f
     else
-      # FIXME: fallback for unknown datatypes and 'string'
-      literal_value
+      if lang
+        LocalizedString.new(literal_value, lang.to_sym)
+      else
+        # FIXME: fallback for unknown datatypes and 'string'
+        literal_value
+      end
     end
   end
 end

data/lib/xml_schema/version.rb

@@ -1,3 +1,3 @@
 module XmlSchema
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/test/localized_string_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+class LocalizedStringTest < Test::Unit::TestCase
+  def test_initialized_with_no_lang
+    assert_equal nil, LocalizedString.new("hello").lang
+  end
+
+  def test_initialized_with_given_locale
+    assert_equal :de, LocalizedString.new("tag", :de).lang
+  end
+
+  def test_compared_to_another_localized_string
+    assert_equal LocalizedString.new("hello"), LocalizedString.new("hello")
+  end
+
+  def test_does_not_compare_to_localized_string_in_another_language
+    assert_not_equal LocalizedString.new("hello"), LocalizedString.new("hello", :ja)
+  end
+
+  def test_compared_to_string
+    assert_equal LocalizedString.new("hello"), "hello"
+  end
+
+  def test_initialized_via_string_with_lang
+    assert "hello".with_lang(:en).is_a?(LocalizedString)
+  end
+end

data/test/xml_schema_test.rb

@@ -41,6 +41,12 @@ class XmlSchemaTest < Test::Unit::TestCase
     assert_equal "hello", value
   end
 
+  def test_should_instantiate_a_localized_string
+    value = XmlSchema.instantiate "bonjour@fr"
+    assert_equal "bonjour", value
+    assert_equal :fr, value.lang
+  end
+
   def test_should_instantiate_a_string_by_default
     value = XmlSchema.instantiate "ahoy!"
     assert_equal "ahoy!", value
@@ -80,6 +86,10 @@ class XmlSchemaTest < Test::Unit::TestCase
     assert_equal URI("http://www.w3.org/2001/XMLSchema#string"), XmlSchema.datatype_of("test")
   end
 
+  def test_should_return_datatype_for_localized_string
+    assert_equal URI("http://www.w3.org/2001/XMLSchema#string"), XmlSchema.datatype_of("test".with_lang(:de))
+  end
+
   def test_should_raise_exception_on_unknown_class
     assert_raise RuntimeError do
       XmlSchema.datatype_of(Object.new)

data/xml_schema.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
@@ -20,5 +18,7 @@ Gem::Specification.new do |s|
   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.license       = "The MIT License (MIT)"
+  s.extra_rdoc_files = ['README.md']
   s.require_paths = ["lib"]
 end

metadata

@@ -1,59 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: xml_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Slava Kravchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies: []
 description: Helper methods and constants to handle XmlSchema
 email:
 - slava.kravchenko@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .gitignore
 - ChangeLog
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- lib/ext/localized_string.rb
+- lib/ext/string.rb
 - lib/xml_schema.rb
 - lib/xml_schema/ns.rb
 - lib/xml_schema/version.rb
+- test/localized_string_test.rb
 - test/test_helper.rb
 - test/xml_schema_test.rb
 - xml_schema.gemspec
 homepage: https://github.com/cordawyn/xml_schema
-licenses: []
+licenses:
+- The MIT License (MIT)
+metadata: {}
 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: xml_schema
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helper methods and constants to handle XmlSchema
 test_files: []
 has_rdoc: 

data/README.rdoc

@@ -1,23 +0,0 @@
-= XML Schema
-
-XmlSchema gem is a simple convertor utility for XML Schema (literal) datatypes to/from native Ruby objects.
-
-= Usage
-
-  $ require "xml_schema"
-
-  $ XmlSchema.datatype_of(true)  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2001/XMLSchema#boolean>
-  $ XmlSchema.datatype_of(Time.now)  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2001/XMLSchema#time>
-
-  $ XmlSchema.instantiate("55^^<http://www.w3.org/2001/XMLSchema#int>")  # => 55
-
-XmlSchema also provides means to access and work with frequently used namespaces:
-
-  $ NS::OWL.uri  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2002/07/owl>
-  $ NS::RDFS["hello"]  # => #<URI::HTTP:0x00000000dcff78 URL:http://www.w3.org/2000/01/rdf-schema#hello>
-
-That's pretty much all there is to it.
-
-= Authors
-
-Slava Kravchenko <slava.kravchenko@gmail.com>