schoolie 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a242116cac43cc3deaebac1e2baa11548e77ee7b53840832abc011fd76242b81
-  data.tar.gz: 235885b2b5945c48dabfaeb2806cd268fae3ecdf4b7c46f16e4ad8b19f9dcbb2
+  metadata.gz: be154513ab375404085cb27f1f613f981806d363310ab9a338ddbdf23ebd2c6e
+  data.tar.gz: 6b367c4bfb76739d28a0d20fbc1685db68977d04aa14710230ae8958a18d4dc0
 SHA512:
-  metadata.gz: 6b00b1c4d8788b169279b2a85867762b05c3d45b38a2f79313adf35758ea72244660471e2be379b9cb299a0141f67804313d4eb76eb900f442b91e9cf68bf654
-  data.tar.gz: 23a9e2060c67fd8056d1a5a3c7738ddd47ea763143bb1c2235981ab898f08a2cf3fd27d675c940b55bef29dd53d45c5c19eea20e3c1e76200d99dc237620f29c
+  metadata.gz: 7cd533267eca777564624d01462e8c9ff2df2416cccd83e6fff289f9a30d7cda9e19b03ec5be39fea0c48d9ec391730c805f85f3abb706a7299eef1ccf487e9f
+  data.tar.gz: 5c49117108e7f738809ef74394ccc0c8b37c805e295fd78dbddc62b516899c9a1349f700211931fdca7eb2c3b3a0e9e7239ae9dffab54f06bc9af70abb0fe5d1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schoolie (0.1.2)
+    schoolie (0.1.3)
       actionview (~> 5)
 
 GEM

data/README.md

@@ -3,7 +3,7 @@
 <a href="https://codeclimate.com/github/curationexperts/schoolie/maintainability"><img src="https://api.codeclimate.com/v1/badges/bc6ef5bc9e76c6c3dcc9/maintainability" /></a>
 [![Coverage Status](https://coveralls.io/repos/github/curationexperts/schoolie/badge.svg?branch=main)](https://coveralls.io/github/curationexperts/schoolie?branch=main)
 
-The gem that generates a site map and meta tags for google scholar
+A gem that generates a site map and meta tags for google scholar (or any other tags you might want)
 
 ## Installation
 
@@ -23,21 +23,20 @@ Or install it yourself as:
 
 ## Usage
 
-In order to map your particular metadata into the google scholar fields, create a file in Rails.root/config named schoolie.yml.
-
+Install your schoolie configuration file in ```config/schoolie.yml```
 
 This file should contain contents similar to this:
 
 ```
 ---
-:static:
-  Institution: Emory & University
-:attributes:
-  Title: title
-  Author: creator
-  Abstract: abstract
-  Type: submitting_type
-  Date: degree_awarded
+static:
+  citation_dissertation_institution: Your University
+attributes:
+  citation_title: title
+  citation_author: creator
+  citation_date: publication_date
+  citation_keywords: keywords
+  citation_pdf_url: permanent_url
 ```
 
 The 'static' section will be written directly into the meta tags as is, attributes will be sent as method calls to the current curation
@@ -50,13 +49,55 @@ Missing methods will be ignored.
 bundle exec rails schoolie:sitemap
 ```
 
-This will generate a sitemap in public/sitemap.txt You should refer to this file in your robots.txt 
+The 'static' section maps a particular meta tag name to a static string
+
+The attributes section maps meta tag names to _methods that will be
+called on whatever you pass into the ```schoolie_tags``` helper_.
+
+If the method does not exist, the tag will not be generated (though no
+error will be thrown).
 
-NB. this task just uses curl to query solr currently, so make sure you have that installed first
 
-## Development
+Call the helper like any other helper in your view:
+
+
+```erb
+<%= schoolie_tags my_object %>
+```
+That's all there is to it!
+
+## SiteMaps
+
+If you'd like to generate a sitemap for your Hyrax-based application, a simple rake task can be used (not included in schoolie):
+
+```ruby
+  task sitemap: :environment do
+    date_field = 'system_modified_dtsi'
+    result = ActiveFedora::SolrService.query("has_model_ssim:MyModel",
+                                             fq: "selectin_criteria:here",
+                                             fl: "id,#{date_field}",
+                                             sort: "sort_field,sortfield ASC",
+                                             rows: 20_000)
+    ids = result.map do |x|
+      ["https://etd.example.com/concern/theses/#{x['id']}", x[date_field].to_s]
+    end
+    builder = Nokogiri::XML::Builder.new do |sitemap|
+      sitemap.urlset("xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
+                 xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9",
+                 "xsi:schemaLocation": "http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd") {
+                   ids.each { |url, date|
+                     sitemap.url {
+                       sitemap.loc url
+                       sitemap.lastmod date
+                     }
+                   }
+                 }
+    end
+    File.open(Rails.root.join("public", "sitemap.xml"), "w") { |f| f.write(builder.to_xml) }
+end
+```
 
-Check out the repo, and bundle install as per normal.
+Don't forget to add your sitemap url to robots.txt too!
 
 ## Contributing
 

data/lib/helpers/schoolie_helper.rb

@@ -10,11 +10,16 @@ module SchoolieHelper
     tags = m["static"].map do |k, v|
       tag.meta(name: k, value: v)
     end
-    tags << m["attributes"].map do |k, v|
-      tag.meta(name: k, value: concern.send(v))
-    rescue StandardError
-      warn("Undefined attribute mapping: #{k} -> #{v}")
-    end
+    tags =  m["attributes"].inject(tags) do |m, (k, v)|
+      begin
+        [concern.send(v)].flatten.each do |z|
+          m << tag.meta(name: k, value: z)
+        end
+        rescue StandardError
+          warn("Undefined attribute mapping: #{k} -> #{v}")
+        end
+      m
+      end
     tags.join("\n")
   end
 

data/lib/schoolie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schoolie
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schoolie
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - McClain Looney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-02 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: A gem to generate sitemaps & meta tags for Samvera repositories