iso-bib-item 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 28b47902774baa20582877c3f4bb40b511858665
-  data.tar.gz: 0b91cba1d8b30a5b725ef4cb5c6945ac17fdc197
+SHA256:
+  metadata.gz: 5d664c071e9428da35d9ec460b4a8b34abadbf03abd1d1a8c202ea757e498418
+  data.tar.gz: 5434689ba3040c366a40f6c1049ed87c26cfed7fe8adeb076698171b880dffa5
 SHA512:
-  metadata.gz: 9fe3106f7ce849ad2f8687abb31c936ab782e9cb143c8a6cd94a0e276ace015fd9289bce6fb1426537dcd5aa9d0c2998c58087d7888252cbdcef23ca52e04bc4
-  data.tar.gz: 7a8de9331fa305198f6f63c04a93f913d34a276687dd9ff164d7575ef1648ce5900bd594d3b879d26fc6d198ec5abec633870eb3fa1b378471e4d57ebd9f087e
+  metadata.gz: 8a29fd83d139dc5b077a7f5118925ef700d6e0b9a71487358d0a59a09226576f3d2b9ec09444f4f20a6534724beedad12325dbb3897f9a81b2bb2c3785950790
+  data.tar.gz: 80e6797f1387d1bc7823f5d4c32d7849ecf91d82aff99e55cdcb44df5058d82063387d0b64c025020881dd42c85331c881edb01583348c07bc2f7bcced02b0aa

data/Gemfile

@@ -1,3 +1,6 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+ 
 source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

data/README.adoc

@@ -57,7 +57,7 @@ item = IsoBibItem::IsoBibliographicItem.new(
     url: "www.iso.org", abbreviation: "ISO"
   }, roles: ["publisher"]}],
   workgroup: {
-    name=>"International Organization for Standardization",
+    name: "International Organization for Standardization",
     abbreviation: "ISO",
     url: "www.iso.org",
     technical_committee: {
@@ -203,12 +203,73 @@ wg.uri
 
 [source,ruby]
 ----
-iso191152.relations
+item.relations
 => [<IsoBibItem::DocumentRelation:0x007f983c3c2a18 @bib_locality=[], @identifier="ISO 19115:2003", @type="obsoletes", @url="/standard/26020.html">,
  <IsoBibItem::DocumentRelation:0x007f983c3c2950 @bib_locality=[], @identifier="ISO 19115:2003/Cor 1:2006", @type="obsoletes", @url="/standard/44361.html">,
  <IsoBibItem::DocumentRelation:0x007f983c3c28d8 @bib_locality=[], @identifier="ISO 19115-1:2014/Amd 1:2018", @type="updates", @url="/standard/73118.html">]
 ----
 
+=== Reference modification: convert to all parts reference
+
+In ISO, an All Parts reference is a reference to all parts of a standard. If a standard consists of parts,
+only those parts are referenced in the ISO web site (as retrieved by the isobib gem). A part reference is
+converted to an All Parts reference by making the part reference a partOf relation to a new reference,
+which strips the part number and part title of the original, and its abstract. The operation is destructive.
+
+[source,ruby]
+----
+item.to_all_parts
+item.title(lang: "en")
+=> <IsoBibItem::IsoLocalizedTitle:0x007fd1d92e2b30
+ @language="en",
+ @script="Latn",
+ @title_intro="Geographic information",
+ @title_main="Metadata",
+ @title_part=nil>
+item.shortref
+=> "ISO 19115:2014"
+item.relations.last
+=> <IsoBibItem::DocumentRelation:0x00007f94009a2158 @type="partOf", @identifier=nil, @url=nil, @bib_locality=[], 
+    @bibitem=#<IsoBibItem::IsoBibliographicItem:0x00007f94009f37d8 
+      @id=nil, 
+      @title=[#<IsoBibItem::IsoLocalizedTitle:0x00007f94009f3530 
+        @title_intro="Geographic information", 
+        @title_main="Metadata", 
+        @title_part="Part 1: Fundamentals", 
+        @language="en", 
+        @script="Latn">
+....
+----
+
+=== Reference modification: convert to most recent reference
+
+In ISO, an undated reference is interpreted as a _de dicto_ reference to the most recent instance of the
+reference; if the document is read after a new version of the reference has been issued, the reference is taken
+to refer to that new instance, even if that instance had not been published at the time the bibliography was authored.
+All references on the ISO web site (as retrieved by the isobib gem) are dated. A dated reference is
+converted to a Most Recent referece by making the dated reference an instance relation to a new reference,
+which strips the date of publication of the original, and its abstract. The operation is destructive.
+
+[source,ruby]
+----
+item.dates
+=> [#<IsoBibItem::BibliographicDate:0x00007f9994977680 @type="published", @on=2014-01-04 00:00:00 +1100>]
+item.to_most_recent_reference
+item.dates
+[]
+item.shortref
+=> "ISO 19115-1"
+item.relations.last
+=> <IsoBibItem::DocumentRelation:0x00007f9a33976a60 @type="instance", @identifier=nil, @url=nil, @bib_locality=[], 
+     @bibitem=#<IsoBibItem::IsoBibliographicItem:0x00007f9a3399ea60 
+     @id=nil, 
+     @title=[#<IsoBibItem::IsoLocalizedTitle:0x00007f9a3399e650 @title_intro="Geographic information", @title_main="Metadata", @title_part="Part 1: Fundamentals", @language="en", @script="Latn">, #<IsoBibItem::IsoLocalizedTitle:0x00007f9a3399e2e0 @title_intro="Information géographique", @title_main="Métadonnées", @title_part="Partie 1: Principes de base", @language="fr", @script="Latn">],
+     @docidentifier=#<IsoBibItem::IsoDocumentId:0x00007f9a3399e010 @project_number="19115", @part_number="1">, 
+     @dates=[#<IsoBibItem::BibliographicDate:0x00007f9a3399dd90 @type="published", @on=2014-01-04 00:00:00 +1100>], 
+....
+----
+
+
 === XML serialization
 
 [source,ruby]

data/lib/iso_bib_item/iso_bibliographic_item.rb

@@ -130,14 +130,20 @@ module IsoBibItem
       @workgroup     = IsoProjectGroup.new(args[:workgroup]) if args[:workgroup]
       @ics = args[:ics].map { |i| Ics.new(i) }
       @copyright = CopyrightAssociation.new args[:copyright] if args[:copyright]
+      @source = args[:source].map { |s| TypedUri.new(s) }
+      @id_attribute = true
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    
+    def disable_id_attribute
+      @id_attribute = false
+    end
   
     # convert ISO nnn-1 reference into an All Parts reference: 
     # remove title part components and abstract  
-    # TODO: make nnn-1 partOf relation of the redacted document
     def to_all_parts
       me = Duplicate.duplicate(self)
+      me.disable_id_attribute
       @relations << DocumentRelation.new(type: "partOf", identifier: nil, url: nil, bibitem: me)
 
       @title.each(&:remove_part)
@@ -152,6 +158,7 @@ module IsoBibItem
     # of the redacated document
     def to_most_recent_reference
       me = Duplicate.duplicate(self)
+      me.disable_id_attribute
       @relations << DocumentRelation.new(type: "instance", identifier: nil, url: nil, bibitem: me)
       @abstract = []
       @dates = []
@@ -170,12 +177,13 @@ module IsoBibItem
     # @todo need to add ISO/IEC/IEEE
     # @return [String]
     def shortref(**opts)
-      year = if opts[:all_parts] then ':All Parts'
-             elsif opts[:no_year] then ''
-             else ':' + @copyright.from&.year&.to_s
+      pubdate = dates.select { |d| d.type == "published" }
+      year = if opts[:no_year] || pubdate.empty? then ""
+             else ':' + pubdate&.first&.on&.year&.to_s
              end
+      year += ": All Parts" if opts[:all_parts] || @all_parts
 
-      "#{id(' ')}#{year}"
+      "#{id(false, ' ')}#{year}"
     end
 
     # @param type [Symbol] type of url, can be :src/:obp/:rss
@@ -203,7 +211,8 @@ module IsoBibItem
       end
     end
 
-    def id(delim = '')
+    def id(attribute, delim = '')
+      return nil if attribute && !@id_attribute
       contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
       idstr = "#{contribs}#{delim}#{@docidentifier.project_number}"
       if @docidentifier.part_number&.size&.positive?
@@ -212,8 +221,15 @@ module IsoBibItem
       idstr.strip
     end
 
+    def xml_attrs(type)
+      attrs = { type: type }
+      attr_id = id(true)
+      attrs[:id] = attr_id if attr_id
+      attrs
+    end
+
     def render_xml(builder, **opts)
-      builder.send(:bibitem, type: type, id: id) do
+      builder.send(:bibitem, xml_attrs(type)) do
         title.each { |t| t.to_xml builder }
         source.each { |s| s.to_xml builder }
         # docidentifier.to_xml builder

data/lib/iso_bib_item/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module IsoBibItem
-  VERSION = '0.1.7'.freeze
+  VERSION = '0.1.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iso-bib-item
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 'IsoBibItem: Ruby ISOXMLDOC impementation.'