research_metadata_announcement 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf6041062e657458ff627bb4623ce6a408478c37
-  data.tar.gz: 06aace3883c44e456765a763cb8d08fb9922d836
+  metadata.gz: a542c132d6fcf394939a69f6c67a7033296784e7
+  data.tar.gz: d1e643242bbd097f209a6b7acc58f2d74b33ba6d
 SHA512:
-  metadata.gz: 5902442207fa4b7451ec68c46e338ec1949209392f097c9a0d2291b2dc40d6608eb22a6abef218649564c9312ae52bf0411bdacad6b4c0125282190234fa7e8a
-  data.tar.gz: a264bd7ea56ba82c434d1389872d737509d073274fe918a750d0635347e566c1779cfee2659d532aec4640144df11bd30be93bdc3a0677c2d4b69dd4e75f7465
+  metadata.gz: 750f01701be117b022af62131fa2c63c02e5aed66e43c1fa11981d8a704d35f2596dabce89e6072ff0046bc854ce086c5a516cf8bbfd15ce246a7c7aa90dc7ed
+  data.tar.gz: a15ad831ea6fcce3ac0bad646d4501397cabd26e5b6ad3972f454e1a5140a3b4eaf4f085f7ab35da89da7f3179ece33e48b2deda750f01e652192bdef89db757

data/CHANGELOG.md

@@ -2,7 +2,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## Unreleased
+## 0.4.1 - 2018-01-17
+### Added
+- Testing announcements against known live data.
+
+### Fixed
+- Ellipsis after truncated title.
+
+### Changed
+- Cope with missing resolver in DOI.
+- Cope with full stop in title.
 
 ## 0.4.0 - 2017-10-10
 ### Changed

data/README.md

@@ -89,16 +89,16 @@ Each example uses a different resource for illustrative purposes.
 ```ruby
 
 transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
-#=> "New publication. Can poly-parameter linear-free energy relationships (pp-LFERs) improve modelling bioaccumulation in fish? #partitioncoefficients #pplfer. dx.doi.org/10.1016/j.chemosphere.2017.10.007."
+#=> "New journal article. Can poly-parameter linear-free energy relationships (pp-LFERs) improve modelling bioaccumulation in fish? #partitioncoefficients #pplfer. dx.doi.org/10.1016/j.chemosphere.2017.10.007."
 
 transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', max_length: 140
-#=> "New publication. The Parting of Burroughs and... #americancounterculture #arthurrimbaud. dx.doi.org/10.1179/1477570013Z.00000000045."
+#=> "New journal article. The Parting of Burroughs and Ker... #americancounterculture #arthurrimbaud. dx.doi.org/10.1179/1477570013Z.00000000045."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :hashtags] # resource has no descriptors
-#=> "New publication. Deductive and inductive data collection for agent-based modelling."
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :hashtags] # research output has no descriptors
+#=> "New conference paper. Deductive and inductive data collection for agent-based modelling."
 
 transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :keywords, :uri]
-#=> "New publication. Torsion pairs in a triangulated category generated by a spherical object. Auslander–Reiten theory, Calabi–Yau triangulated category. dx.doi.org/10.1016/j.jalgebra.2015.09.011."
+#=> "New journal article. Torsion pairs in a triangulated category generated by a spherical object. Auslander–Reiten theory, Calabi–Yau triangulated category. dx.doi.org/10.1016/j.jalgebra.2015.09.011."
 
 transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:new, :title, :uri]
 #=> "New dataset. Operating Nanobeams in a Quantum Fluid. dx.doi.org/10.17635/lancaster/researchdata/139."

data/lib/research_metadata_announcement/transformer/base.rb

@@ -28,7 +28,7 @@ module ResearchMetadataAnnouncement
         if composition.include? :uri
           return nil unless prepare_uri
         end
-        title = @resource.title
+        title = remove_full_stop @resource.title
         keywords = @resource.keywords
 
         # sizing
@@ -38,8 +38,7 @@ module ResearchMetadataAnnouncement
           composition.each do |component|
             case component
               when :new
-                resource = self.class.name.sub('ResearchMetadataAnnouncement::Transformer::', '')
-                phrase = "New research #{resource.downcase}"
+                phrase = new_phrase(@resource)
                 chars_needed += phrase.size + chars_component_end
               when :title
                 chars_needed += title.size + chars_component_end
@@ -49,10 +48,16 @@ module ResearchMetadataAnnouncement
                 chars_needed += build_hashtags(keywords, max_descriptors).size + chars_component_end if !keywords.empty?
               when :uri
                 uri = prepare_uri
-                chars_needed += uri.size if uri
+                chars_needed += uri.size + chars_component_end if uri
             end
           end
 
+          # since the arrangement of the composition is unknown, after sizing
+          # chars_needed has two extra spaces allocated
+          # one is used for the terminating full stop
+          # one is not needed
+          chars_needed -= 1
+
           # determine if title needs truncating/removing before combining
           if chars_needed > max_length
             # truncate title
@@ -60,7 +65,7 @@ module ResearchMetadataAnnouncement
               excess_chars = chars_needed - max_length
               truncated_title_length = title.size - excess_chars
               truncated_title_length = 0 if truncated_title_length < 0
-              title = title[0..truncated_title_length - 2].strip + '..'
+              title = title[0..truncated_title_length - 3].strip + '..'
               composition -= [:title] if title.size <= 5 # give up on title if just too small
             end
           end
@@ -71,9 +76,7 @@ module ResearchMetadataAnnouncement
         composition.each do |component|
           case component
             when :new
-              resource = self.class.name.sub('ResearchMetadataAnnouncement::Transformer::', '')
-              phrase = "New #{resource.downcase}"
-              buffer << phrase
+              buffer << new_phrase(@resource)
             when :title
               buffer << title
             when :keywords
@@ -101,6 +104,42 @@ module ResearchMetadataAnnouncement
 
       private
 
+      def handle_resolver(uri)
+        return unless uri
+        resolver = 'dx.doi.org'
+        if uri.include? resolver
+          uri
+        else
+          File.join resolver, uri
+        end
+      end
+
+      def remove_full_stop(str)
+        arr = str.split('')
+        if arr.pop == '.' && arr.pop != '.'
+          return str.chomp('.')
+        else
+          return str
+        end
+      end
+
+      def new_phrase(resource)
+        part_1 = 'New'
+        part_2 = ''
+
+        case resource.class.to_s
+          when 'Puree::Model::Dataset'
+            part_2 = 'dataset'
+          when 'Puree::Model::Publication'
+            part_2 = resource.type.downcase
+        end
+        if part_2.empty?
+          return part_1
+        else
+          return "#{part_1} #{part_2}"
+        end
+      end
+
       # Extract metadata from Pure
       #
       # @param id [String]

data/lib/research_metadata_announcement/transformer/dataset.rb

@@ -19,7 +19,8 @@ module ResearchMetadataAnnouncement
       private
 
       def prepare_uri
-        strip_uri_scheme @resource.doi if @resource && @resource.doi
+        uri = strip_uri_scheme @resource.doi if @resource && @resource.doi
+        handle_resolver uri
       end
 
     end

data/lib/research_metadata_announcement/transformer/publication.rb

@@ -19,7 +19,8 @@ module ResearchMetadataAnnouncement
       private
 
       def prepare_uri
-        strip_uri_scheme @resource.dois[0] if @resource && @resource.dois[0]
+        uri = strip_uri_scheme @resource.dois[0] if @resource && @resource.dois[0]
+        handle_resolver uri
       end
 
     end

data/lib/research_metadata_announcement/version.rb

@@ -1,5 +1,5 @@
 module ResearchMetadataAnnouncement
   # Semantic version number
   #
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: research_metadata_announcement
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puree