research_metadata_announcement 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d646820ca8f080ad370ed466c22d23ccc35c480
-  data.tar.gz: cdbec817ebfa40fb55c32cc46cdc99b21786e7bf
+  metadata.gz: bf6041062e657458ff627bb4623ce6a408478c37
+  data.tar.gz: 06aace3883c44e456765a763cb8d08fb9922d836
 SHA512:
-  metadata.gz: 7b5e9897a9d99d67627fe7371f6310c3169809b90b8c0d143d4df3fe362c1b6e57b0b5e521902bd8dbb429f2d7e45f0b52c1316f5d445113f0b39c77775ddbf4
-  data.tar.gz: 5679dbac4a6dc25b30ff422ebfbc219881e84bd340b90149024c38c8ccdf53893dab2ef308a8ab85d3a585168ff59dc651344f919f1a2d144ae0f084c8a4e367
+  metadata.gz: 5902442207fa4b7451ec68c46e338ec1949209392f097c9a0d2291b2dc40d6608eb22a6abef218649564c9312ae52bf0411bdacad6b4c0125282190234fa7e8a
+  data.tar.gz: a264bd7ea56ba82c434d1389872d737509d073274fe918a750d0635347e566c1779cfee2659d532aec4640144df11bd30be93bdc3a0677c2d4b69dd4e75f7465

data/CHANGELOG.md

@@ -4,9 +4,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## 0.4.0 - 2017-10-10
+### Changed
+- Permutation keyword argument renamed to composition.
+
 ## 0.3.0 - 2017-10-09
 ### Changed
-- Simplified API, allowing flexible permutations of announcement components.
+- Simplified API, allowing flexible compositions of announcement components.
 
 ## 0.2.0 - 2017-09-29
 ### Added

data/README.md

@@ -58,7 +58,7 @@ Give it a Pure identifier and get an announcement.
 transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 ```
 
-Optionally, use the ```:permutation``` keyword argument to pass in an array of
+Optionally, use the ```:composition``` keyword argument to pass in an array of
 components (duplicates are ignored). The order of the components determines the
 order of the metadata in the announcement.
 
@@ -71,16 +71,16 @@ Possible components:
 Ideally, an announcement will be obtained using all the requested components,
 with the following exceptions:
 
-+ If the permutation includes ```:keywords``` or ```:hashtags``` and the
++ If the composition includes ```:keywords``` or ```:hashtags``` and the
 resource does not have any descriptors, the metadata is simply omitted.
 
-+ If the permutation includes ```:uri```, the resource must have a URI for an
++ If the composition includes ```:uri```, the resource must have a URI for an
 announcement to be returned.
 
 + If, after ```:title``` truncation/removal, the length still exceeds the
 optional ```:max_length``` keyword argument, an announcement will not be returned.
 
-If the permutation includes ```:new```, a phrase based upon the resource type
+If the composition includes ```:new```, a phrase based upon the resource type
 is generated e.g. New dataset. However, this gem does not determine whether
 the resource is deemed to be new.
 
@@ -94,28 +94,28 @@ transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 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."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:new, :title, :hashtags] # resource has no descriptors
+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', permutation: [:new, :title, :keywords, :uri]
+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."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:new, :title, :uri]
+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."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:uri, :title]
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :title]
 #=> "dx.doi.org/10.17635/lancaster/researchdata/29. Herpes simplex virus 1 (HSV-1) evolution."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:keywords, :uri]
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:keywords, :uri]
 #=> "smart cities, sustainability. dx.doi.org/10.17635/lancaster/researchdata/35."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:hashtags, :uri]
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:hashtags, :uri]
 #=> "#treatedhypertension #microvascularbloodflow. dx.doi.org/10.17635/lancaster/researchdata/148."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:uri, :keywords]
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :keywords]
 #=> "dx.doi.org/10.17635/lancaster/researchdata/134. metagenomics, deep sequencing."
 
-transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', permutation: [:uri, :hashtags], max_descriptors: 4
+transformer.transform uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx', composition: [:uri, :hashtags], max_descriptors: 4
 #=> "dx.doi.org/10.17635/lancaster/researchdata/111. #influenza #nasopharynx #virology #virus."
 
 ```

data/lib/research_metadata_announcement/transformer/base.rb

@@ -16,16 +16,16 @@ module ResearchMetadataAnnouncement
 
       # @param id [String] Pure ID.
       # @param uuid [String] Pure UUID.
-      # @param permutation [Array<Symbol>] Metadata presentation sequence e.g. [:new, :title, :hashtags, :uri].
+      # @param composition [Array<Symbol>] Metadata presentation sequence e.g. [:new, :title, :hashtags, :uri].
       # @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 transform(uuid: nil, id: nil, permutation: [:new, :title, :hashtags, :uri],
+      def transform(uuid: nil, id: nil, composition: [:new, :title, :hashtags, :uri],
                     max_length: nil, max_descriptors: 2)
-        permutation.uniq!
+        composition.uniq!
         extract uuid: uuid, id: id
         return nil unless @resource
-        if permutation.include? :uri
+        if composition.include? :uri
           return nil unless prepare_uri
         end
         title = @resource.title
@@ -35,7 +35,7 @@ module ResearchMetadataAnnouncement
         if length_constrained? max_length
           chars_needed = 0
           chars_component_end = 2
-          permutation.each do |component|
+          composition.each do |component|
             case component
               when :new
                 resource = self.class.name.sub('ResearchMetadataAnnouncement::Transformer::', '')
@@ -56,19 +56,19 @@ module ResearchMetadataAnnouncement
           # determine if title needs truncating/removing before combining
           if chars_needed > max_length
             # truncate title
-            if permutation.include? :title
+            if composition.include? :title
               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 + '..'
-              permutation -= [:title] if title.size <= 5 # give up on title if just too small
+              composition -= [:title] if title.size <= 5 # give up on title if just too small
             end
           end
         end
 
         # get data for combining
         buffer = []
-        permutation.each do |component|
+        composition.each do |component|
           case component
             when :new
               resource = self.class.name.sub('ResearchMetadataAnnouncement::Transformer::', '')

data/lib/research_metadata_announcement/version.rb

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

metadata

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