research_metadata_announcement 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc9974c6b361bb579f8454ffcf2602d78a62746
-  data.tar.gz: 33da4d070192919b91c45317d7a026f6c8f19f20
+  metadata.gz: 2474614693454017d76644d6a463da347253fa8c
+  data.tar.gz: 7fe0aba78ef40f5bc3db8c2b5a2f406ec2db7ab5
 SHA512:
-  metadata.gz: 5db2978940ff75facb1fba4cf2d53f9a3abd462c3131b78cb1c518bbf77335f61116f7d993c213af663c7e7598c4baa4292fa8bfee4f4d2d9fbf4bb00e9142f0
-  data.tar.gz: bd79b981ed25b340755a255f609789415c695afbdea235d1e75cb9f9da6650ee39204e235273d0053e4fe6de9a7504501c5830655adecc59128bf4577c088875
+  metadata.gz: 247bdcac312ab4ef37ede3db3f83bccb05fa00424ddcb92cca51d51fb09cd1b7fb46ed987c81e153822ca1ed3161f60732dcb79280fbfd5fdc32e29362af5a31
+  data.tar.gz: ff3e0ab75eeb45c2cb744476f0cc5953c723d116a1cbd68dee4ecc690eee3a9d371927d01ac9627ae9f929848a4acdc560a7dc281155e95ae9e434c9f30164c1

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## 0.2.0 - 2017-09-29
+### Added
+- Publication.
+
 ## 0.1.0 - 2017-09-26
 ### Added
 - Working product supports datasets.

data/lib/research_metadata_announcement.rb

@@ -2,6 +2,7 @@ require 'puree'
 
 require 'research_metadata_announcement/transformer/base'
 require 'research_metadata_announcement/transformer/dataset'
+require 'research_metadata_announcement/transformer/publication'
 require 'research_metadata_announcement/version'
 
 # Metadata extraction from the Pure Research Information System and

data/lib/research_metadata_announcement/transformer/base.rb

@@ -26,12 +26,67 @@ module ResearchMetadataAnnouncement
         end
       end
 
+      # Title followed by uri format
+      #
+      # @param max_length [Fixnum]
+      # @return [String, nil] Announcement returned if the metadata is available and the announcement length does not exceed the max_length argument.
+      def title_uri(max_length: nil)
+        title_formats format: :title_uri_format,
+                      max_length: max_length
+      end
+
+      # Uri followed by title format
+      #
+      # @see #title_uri
+      def uri_title(max_length: nil)
+        title_formats format: :uri_title_format,
+                      max_length: max_length
+      end
+
+      # Keywords followed by uri format
+      #
+      # @param max_length [Fixnum] Maximum length of announcement.
+      # @param max_descriptors [Fixnum] Maximum number of descriptors (common name for keywords, tags, hashtags).
+      # @return [String, nil] Announcement returned if the metadata is available and the announcement length does not exceed the max_length argument.
+      def keywords_uri(max_length: nil, max_descriptors: 2)
+        descriptors_formats format: :keywords_uri_format,
+                            max_length: max_length,
+                            max_descriptors: max_descriptors
+      end
+
+      # Uri followed by keywords format
+      #
+      # @see #keywords_uri
+      def uri_keywords(max_length: nil, max_descriptors: 2)
+        descriptors_formats format: :uri_keywords_format,
+                            max_length: max_length,
+                            max_descriptors: max_descriptors
+      end
+
+      # Hashtags followed by uri format
+      #
+      # @see #keywords_uri
+      def hashtags_uri(max_length: nil, max_descriptors: 2)
+        descriptors_formats format: :hashtags_uri_format,
+                            max_length: max_length,
+                            max_descriptors: max_descriptors
+      end
+
+      # Uri followed by hashtags format
+      #
+      # @see #keywords_uri
+      def uri_hashtags(max_length: nil, max_descriptors: 2)
+        descriptors_formats format: :uri_hashtags_format,
+                            max_length: max_length,
+                            max_descriptors: max_descriptors
+      end
+
       private
 
       def append_sentence(str, str_to_append)
-        if str_to_append && str_to_append.size > 0
+        if str_to_append && !str_to_append.empty?
           if str
-            if str.size > 0
+            if !str.empty?
               "#{str}. #{str_to_append}."
             else
               "#{str_to_append}."
@@ -43,13 +98,117 @@ module ResearchMetadataAnnouncement
       end
 
       def strip_uri_scheme(uri)
-        uri.sub /^.+\/\//, ''
+        uri.sub %r{^.+//}, ''
       end
 
       def length_constrained?(max_length)
         max_length && max_length > 0
       end
 
+      def title_formats(format:, max_length:)
+        return nil unless @resource
+        uri = prepare_uri
+        return nil unless uri
+        title = @resource.title
+        build_title_formats(format: format,
+                            uri: uri,
+                            title: title,
+                            max_length: max_length)
+      end
+
+      def descriptors_formats(format:, max_length:, max_descriptors:)
+        return nil unless @resource
+        uri = prepare_uri
+        return nil unless uri
+        keywords = @resource.keywords
+        return nil if keywords.empty?
+        build_descriptors_formats(format: format,
+                                  keywords: keywords,
+                                  uri: uri,
+                                  max_length: max_length,
+                                  max_descriptors: max_descriptors)
+      end
+
+      def validate_string_length(str, max_length)
+        if length_constrained? max_length
+          str if str.size <= max_length
+        else
+          str
+        end
+      end
+
+      def build_descriptors_formats(format:, keywords:, uri:, max_length:, max_descriptors:)
+        case format
+          when :keywords_uri_format
+            str = append_sentence(build_keywords(keywords, max_descriptors), uri)
+          when :uri_keywords_format
+            str = append_sentence(uri, build_keywords(keywords, max_descriptors))
+          when :hashtags_uri_format
+            str = append_sentence(build_hashtags(keywords, max_descriptors), uri)
+          when :uri_hashtags_format
+            str = append_sentence(uri, build_hashtags(keywords, max_descriptors))
+        end
+        validate_string_length str, max_length
+      end
+
+      def build_title_format(format:, title:, uri:)
+        case format
+          when :title_uri_format
+            append_sentence title, uri
+          when :uri_title_format
+            append_sentence uri, title
+        end
+      end
+
+      def build_title_format_truncated(format:, title:, uri:, available_chars:)
+        truncated_title = title[0..available_chars-3].strip + '...'
+        case format
+          when :title_uri_format
+            "#{truncated_title} #{uri}."
+          when :uri_title_format
+            "#{uri}. #{truncated_title}"
+        end
+      end
+
+      def build_title_formats(format:, title:, uri:, max_length:)
+        if length_constrained? max_length
+          available_chars = max_length - (uri.size + 3)
+          available_chars = 0 if available_chars < 0
+          if title.size <= available_chars
+            return build_title_format(format: format,
+                                      title: title,
+                                      uri: uri)
+          end
+          if available_chars - 3 > 0
+            return build_title_format_truncated(format: format,
+                                                title: title,
+                                                uri: uri,
+                                                available_chars: available_chars)
+          end
+        else
+          build_title_format(format: format,
+                             title: title,
+                             uri: uri)
+        end
+      end
+
+      def build_keywords(keywords, max)
+        keywords[0..max - 1].join ', '
+      end
+
+      def build_hashtags(keywords, max)
+        a = keywords[0..max - 1].map(&:downcase)
+        a = a.map { |i| i.gsub(/[^a-zA-Z0-9]/, '') }
+        a = a.map { |i| i.gsub(/\s+/, '') }
+        a = a.map { |i| "##{i}" }
+        a.join ' '
+      end
+
+      def make_extractor(resource_type)
+        resource_class = "Puree::Extractor::#{resource_type.capitalize}"
+        @resource_extractor = Object.const_get(resource_class).new @config
+      end
+
     end
   end
 

data/lib/research_metadata_announcement/transformer/dataset.rb

@@ -13,206 +13,13 @@ module ResearchMetadataAnnouncement
       # @option config [String] :password The password of the Pure host account.
       def initialize(config)
         super
-        @resource_extractor = Puree::Extractor::Dataset.new config
-      end
-
-      # Keywords followed by uri format
-      #
-      # @param max_length [Fixnum] Maximum length of announcement.
-      # @param max_descriptors [Fixnum] Maximum number of descriptors (common name for keywords, tags, hashtags).
-      # @return [String, nil] Announcement returned if the metadata is available and the announcement length does not exceed the max_length argument.
-      def keywords_uri(max_length: nil, max_descriptors: 2)
-        return nil if !@resource
-        keywords = @resource.keywords
-        uri = prepare_uri
-        if uri
-          return build_keywords_uri(keywords: keywords,
-                                    uri: uri,
-                                    max_length: max_length,
-                                    max_descriptors: max_descriptors)
-        end
-        nil
-      end
-
-      # Uri followed by keywords format
-      #
-      # @see #keywords_uri
-      def uri_keywords(max_length: nil, max_descriptors: 2)
-        return nil if !@resource
-        keywords = @resource.keywords
-        uri = prepare_uri
-        if uri
-          return build_uri_keywords(keywords: keywords,
-                                    uri: uri,
-                                    max_length: max_length,
-                                    max_descriptors: max_descriptors)
-        end
-        nil
-      end
-
-      # Uri followed by hashtags format
-      #
-      # @see #keywords_uri
-      def uri_hashtags(max_length: nil, max_descriptors: 2)
-        return nil if !@resource
-        keywords = @resource.keywords
-        uri = prepare_uri
-        if uri
-          return build_uri_hashtags(keywords: keywords,
-                                    uri: uri,
-                                    max_length: max_length,
-                                    max_descriptors: max_descriptors)
-        end
-        nil
-      end
-
-      # Hashtags followed by uri format
-      #
-      # @see #keywords_uri
-      def hashtags_uri(max_length: nil, max_descriptors: 2)
-        return nil if !@resource
-        keywords = @resource.keywords
-        uri = prepare_uri
-        if uri
-          return build_hashtags_uri(keywords: keywords,
-                                    uri: uri,
-                                    max_length: max_length,
-                                    max_descriptors: max_descriptors)
-        end
-        nil
-      end
-
-      # Title followed by uri format
-      #
-      # @param max_length [Fixnum]
-      # @return [String, nil] Announcement returned if the metadata is available and the announcement length does not exceed the max_length argument.
-      def title_uri(max_length: nil)
-        return nil if !@resource
-        title = @resource.title
-        uri = prepare_uri
-        if uri
-          return build_title_uri(uri: uri, title: title, max_length: max_length)
-        end
-        nil
-      end
-
-      # Uri followed by title format
-      #
-      # @see #title_uri
-      def uri_title(max_length: nil)
-        return nil if !@resource
-        title = @resource.title
-        uri = prepare_uri
-        if uri
-          return build_uri_title(uri: uri, title: title, max_length: max_length)
-        end
-        nil
+        make_extractor :dataset
       end
 
       private
 
       def prepare_uri
-        if @resource && @resource.doi
-          return strip_uri_scheme @resource.doi
-        end
-        nil
-      end
-
-      def build_keywords_uri(keywords:, uri:, max_length:, max_descriptors:)
-        if !keywords.empty?
-          str = append_sentence(build_keywords(keywords, max_descriptors), uri)
-          if length_constrained? max_length
-            return str if str.size <= max_length
-          else
-            return str
-          end
-        end
-        nil
-      end
-
-      def build_uri_keywords(keywords:, uri:, max_length:, max_descriptors:)
-        if !keywords.empty?
-          str = append_sentence(uri, build_keywords(keywords, max_descriptors))
-          if length_constrained? max_length
-            return str if str.size <= max_length
-          else
-            return str
-          end
-        end
-        nil
-      end
-
-      def build_uri_hashtags(keywords:, uri:, max_length:, max_descriptors:)
-        if !keywords.empty?
-          str = append_sentence(uri, build_hashtags(keywords, max_descriptors))
-          if length_constrained? max_length
-            return str if str.size <= max_length
-          else
-            return str
-          end
-        end
-        nil
-      end
-
-      def build_hashtags_uri(keywords:, uri:, max_length:, max_descriptors:)
-        if !keywords.empty?
-          str = append_sentence(build_hashtags(keywords, max_descriptors), uri)
-          if length_constrained? max_length
-            return str if str.size <= max_length
-          else
-            return str
-          end
-        end
-        nil
-      end
-
-      def build_title_uri(title:, uri:, max_length:)
-        if length_constrained? max_length
-          available_chars = max_length - (uri.size + 3)
-          available_chars = 0 if available_chars < 0
-          if title.size <= available_chars
-            return append_sentence title, uri
-          end
-          if available_chars-3 > 0
-            truncated_title = title[0..available_chars-3].strip + '...'
-            return "#{truncated_title} #{uri}."
-          end
-        else
-          return append_sentence title, uri
-        end
-      end
-
-      def build_uri_title(uri:, title:, max_length:)
-        if length_constrained? max_length
-          available_chars = max_length - (uri.size + 3)
-          available_chars = 0 if available_chars < 0
-          if title.size <= available_chars
-            return append_sentence uri, title
-          end
-          if available_chars-3 > 0
-            truncated_title = title[0..available_chars-3].strip + '...'
-            return "#{uri}. #{truncated_title}"
-          end
-        else
-          return append_sentence uri, title
-        end
-      end
-
-      def build_keywords(keywords, max)
-        return keywords[0..max-1].join ', ' if keywords
-        nil
-      end
-
-      def build_hashtags(keywords, max)
-        a = keywords[0..max-1].map { |i| i.downcase }
-        a = a.map { |i| i.gsub(/[^a-zA-Z0-9]/,'') }
-        a = a.map { |i| i.gsub(/\s+/, '')  }
-        a = a.map { |i| "##{i}" }
-        if a.size > 0
-          return a.join ' '
-        else
-          return nil
-        end
+        strip_uri_scheme @resource.doi if @resource && @resource.doi
       end
 
     end

data/lib/research_metadata_announcement/transformer/publication.rb

@@ -0,0 +1,29 @@
+module ResearchMetadataAnnouncement
+
+  module Transformer
+
+    # Extracts publication metadata from the Pure Research Information System and
+    # converts it into an announcement
+    #
+    class Publication < ResearchMetadataAnnouncement::Transformer::Base
+
+      # @param config [Hash]
+      # @option config [String] :url The URL of the Pure host.
+      # @option config [String] :username The username of the Pure host account.
+      # @option config [String] :password The password of the Pure host account.
+      def initialize(config)
+        super
+        make_extractor :publication
+      end
+
+      private
+
+      def prepare_uri
+        strip_uri_scheme @resource.dois[0] if @resource && @resource.dois[0]
+      end
+
+    end
+
+  end
+
+end

data/lib/research_metadata_announcement/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: research_metadata_announcement
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puree
@@ -53,6 +53,7 @@ files:
 - lib/research_metadata_announcement.rb
 - lib/research_metadata_announcement/transformer/base.rb
 - lib/research_metadata_announcement/transformer/dataset.rb
+- lib/research_metadata_announcement/transformer/publication.rb
 - lib/research_metadata_announcement/transformer/transformer.rb
 - lib/research_metadata_announcement/version.rb
 - research_metadata_announcement.gemspec