relaton-bib 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98577d6e08bf18ceb7bbd5d3f050e472b580605a
-  data.tar.gz: cda0642e266ecb7e639a971d0b4df918b692a403
+  metadata.gz: 60bb4874a237284708c425732d7444c96f3e75ee
+  data.tar.gz: d3f58322324888ca1828e815b8fe4bae16e24470
 SHA512:
-  metadata.gz: ee7ec704250e9a966fc6b85d18bdb961781659f9896ea4e6973d8d5c7b741cb7bc9b5e68af1684c4176308fd67aa7e88a12e8f6cb989f46fce9e6451e6413c32
-  data.tar.gz: a0038770adb2d4dff2bed71a45e2f801ef0f5d384170f704a393a36752d53069b065fa1052e93bd7b2f816b2828a48eff3c11e53fd8957a287fbfe6b12e2cf25
+  metadata.gz: 4cc9c3a7785ed945d774e1838fa1138c51b311eb8a6987c7616d5338e8feb9d98791a0246408e5214e6b814d21d3785c1a5a52bbbc653e18b2d15cbc7da8234f
+  data.tar.gz: 1588562066005b346b7d9bcd424fd41315cc2172d9837e5f886e6382859f9b4066ac707321a0b91dc14ea831eebb4896222b3a5039b5dfaf4aae6cea9909c471

data/Gemfile.lock

@@ -1,12 +1,15 @@
 PATH
   remote: .
   specs:
-    relaton-bib (0.1.2)
+    relaton-bib (0.1.3)
+      addressable
       nokogiri (~> 1.8.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     debase (0.2.2)
       debase-ruby_core_source (>= 0.10.2)
     debase-ruby_core_source (0.10.4)
@@ -18,6 +21,7 @@ GEM
     mini_portile2 (2.3.0)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.3)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

data/README.adoc

@@ -51,8 +51,9 @@ item = RelatonBib::BibliographicItem.new(
   ],
   docnumber: "123456",
   dates: [
+    { type: "issued", on: "2014" },
     { type: "published", on: "2014-04" },
-    { type: "accessed", on: "2015" }
+    { type: "accessed", on: "2015-05-20" }
   ],
   contributors: [
     { entity: {
@@ -175,11 +176,14 @@ item.to_xml
   <uri type=\"rss\">https://www.iso.org/contents/data/standard/05/37/53798.detail.rss</uri>
   <docidentifier type=\"ISO\">TC211</docidentifier>
   <docnumber>123456</docnumber>
-  <date type=\"published\">
-    <on>2014-04</on>
+  <date type="issued">
+    <on>2014</on>
+  </date>
+  <date type="published">
+    <on>2014</on>
   </date>
-  <date type=\"accessed\">
-    <on>2015-01</on>
+  <date type="accessed">
+    <on>2015</on>
   </date>
   <contributor>
     <role type=\"publisher\">
@@ -255,6 +259,44 @@ item.to_xml
   </validity>
 </bibitem>"
 ----
+By default date elements are formatted as year (yyyy). Option `:date_format` allows to output date elements in `:short` (yyyy-mm) and `:full` (yyyy-mm-dd) additiona formats.
+[surce,ruby]
+----
+item.to_xml date_format: :short
+=>"<bibitem id=\"ISO/TC211\" type=\"standard\">
+  <fetched>2019-04-30</fetched>
+  <title type=\"main\" language=\"en\" script=\"Latn\">Geographic information</title>
+  <title language=\"fr\" script=\"Latn\">Information géographique</title>
+  <uri type=\"src\">https://www.iso.org/standard/53798.html</uri>
+  <uri type=\"obp\">https://www.iso.org/obp/ui/#!iso:std:53798:en</uri>
+  <uri type=\"rss\">https://www.iso.org/contents/data/standard/05/37/53798.detail.rss</uri>
+  <docidentifier type=\"ISO\">TC211</docidentifier>
+  <docnumber>123456</docnumber>
+  <date type="issued">
+    <on>2014-01</on>
+  </date>
+  <date type="published">
+    <on>2014-04</on>
+  </date>
+  <date type="accessed">
+    <on>2015-05</on>
+  </date>
+  ...
+
+item.to_xml date_format: :full
+=>"<bibitem id=\"ISO/TC211\" type=\"standard\">
+  ...
+  <date type="issued">
+    <on>2014-01-01</on>
+  </date>
+  <date type="published">
+    <on>2014-04-01</on>
+  </date>
+  <date type="accessed">
+    <on>2015-05-20</on>
+  </date>
+  ...
+----
 
 == Development
 

data/lib/relaton_bib/bibliographic_date.rb

@@ -34,35 +34,38 @@ module RelatonBib
       @to   = parse_date to
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/AbcSize
 
     # @param builder [Nokogiri::XML::Builder]
     # @return [Nokogiri::XML::Builder]
     def to_xml(builder, **opts)
       builder.date(type: type) do
         if on
-          date = opts[:full_date] ? on.strftime("%Y-%m") : on.year
-          builder.on(opts[:no_year] ? "--" : date)
+          builder.on(opts[:no_year] ? "--" : date_format(on, opts[:date_format]))
         elsif from
-          if opts[:full_date]
-            date_form = from.strftime("%Y-%m")
-            date_to = to.strftime("%Y-%m") if to
-          else
-            date_form = from.year
-            date_to = to.year if to
-          end
-          builder.from(opts[:no_year] ? "--" : date_form)
-          builder.to date_to if to
+          builder.from(opts[:no_year] ? "--" : date_format(from, opts[:date_format]))
+          builder.to date_format(to, opts[:date_format]) if to
         end
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize
 
     private
 
-    # @params date [String] 'yyyy' or 'yyyy-mm'
+    # Formats date
+    # @param date [Time]
+    # @param format [Symbol, nil] :full (yyyy-mm-dd), :short (yyyy-mm) or nil (yyyy)
+    # @return [String]
+    def date_format(date, format = nil)
+      case format
+      when :short then date.strftime "%Y-%m"
+      when :full then date.strftime "%Y-%m-%d"
+      else date.year
+      end
+    end
+
+    # @params date [String] 'yyyy', 'yyyy-mm', 'yyyy-mm-dd
+    # @return [Time]
     def parse_date(date)
       return unless date
 

data/lib/relaton_bib/bibliographic_item.rb

@@ -281,12 +281,12 @@ module RelatonBib
 
     # @param builder [Nokogiri::XML::Builder, NillClass] (nil)
     # @return [String]
-    def to_xml(builder = nil, root = "bibitem", &block)
+    def to_xml(builder = nil, **opts, &block)
       if builder
-        render_xml builder, root, &block
+        render_xml builder, **opts, &block
       else
         Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-          render_xml xml, root, &block
+          render_xml xml, **opts, &block
         end.doc.root.to_xml
       end
     end
@@ -298,15 +298,15 @@ module RelatonBib
 
     # @param builder [Nokogiri::XML::Builder]
     # @return [String]
-    def render_xml(builder, root)
-      xml = builder.send(root) do
+    def render_xml(builder, **opts)
+      xml = builder.send(opts.fetch :root, :bibitem) do
         builder.fetched fetched if fetched
         title.each { |t| builder.title { t.to_xml builder } }
         formattedref.to_xml builder if formattedref
         link.each { |s| s.to_xml builder }
         docidentifier.each { |di| di.to_xml builder }
         builder.docnumber docnumber if docnumber
-        dates.each { |d| d.to_xml builder, full_date: true }
+        dates.each { |d| d.to_xml builder, **opts }
         contributors.each do |c|
           builder.contributor do
             c.role.each { |r| r.to_xml builder }
@@ -321,7 +321,7 @@ module RelatonBib
         abstract.each { |a| builder.abstract { a.to_xml(builder) } }
         status.to_xml builder if status
         copyright.to_xml builder if copyright
-        relations.each { |r| r.to_xml builder }
+        relations.each { |r| r.to_xml builder, **opts }
         series.each { |s| s.to_xml builder } if series
         medium.to_xml builder if medium
         place.each { |pl| builder.place pl }

data/lib/relaton_bib/copyright_association.rb

@@ -35,4 +35,4 @@ module RelatonBib
       end
     end
   end
-end
+end

data/lib/relaton_bib/document_relation.rb

@@ -37,9 +37,9 @@ module RelatonBib
     end
 
     # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
+    def to_xml(builder, **opts)
       builder.relation(type: type) do
-        bibitem.to_xml(builder)
+        bibitem.to_xml(builder, **opts)
         bib_locality.each do |l|
           l.to_xml builder
         end

data/lib/relaton_bib/typed_uri.rb

@@ -1,3 +1,5 @@
+require "addressable"
+
 module RelatonBib
   # Typed URI
   class TypedUri
@@ -10,7 +12,7 @@ module RelatonBib
     # @param content [String]
     def initialize(type:, content:)
       @type    = type
-      @content = URI content if content
+      @content = Addressable::URI.parse content if content
     end
 
     def to_xml(builder)

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

data/relaton-bib.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "simplecov"
 
+  spec.add_dependency "addressable"
   spec.add_dependency "nokogiri", "~> 1.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: nokogiri
   requirement: !ruby/object:Gem::Requirement