schoolie 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ee9af604607b99f83b25807c01206eb2857f3d072373dc2f28a2890fca936d
-  data.tar.gz: f150dd1f8a49c4ce353f80664fe1b926821031707c75d2cc254cb298bffe7aff
+  metadata.gz: a242116cac43cc3deaebac1e2baa11548e77ee7b53840832abc011fd76242b81
+  data.tar.gz: 235885b2b5945c48dabfaeb2806cd268fae3ecdf4b7c46f16e4ad8b19f9dcbb2
 SHA512:
-  metadata.gz: f73c0467e3c360bc7b935b59b3c6a84458324bf9fc655f4b2a0cb7a517fa35e5ca2f43a5e7643ae768abe67ee28e271fd4dd726435184d7615450d19178eeda2
-  data.tar.gz: 267770e9c8345dd36eca6e422e4579c8ca54dfc08411cf846c803621cdcef15a8960ff5382be413d927334dc7a4472e7cd0b1c2fd6d0d11957138bd6bb1cdeb6
+  metadata.gz: 6b00b1c4d8788b169279b2a85867762b05c3d45b38a2f79313adf35758ea72244660471e2be379b9cb299a0141f67804313d4eb76eb900f442b91e9cf68bf654
+  data.tar.gz: 23a9e2060c67fd8056d1a5a3c7738ddd47ea763143bb1c2235981ab898f08a2cf3fd27d675c940b55bef29dd53d45c5c19eea20e3c1e76200d99dc237620f29c

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: circleci

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile

@@ -5,11 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in schoolie.gemspec
 gemspec
 
+gem "actionview", "~>5"
 group :development, :test do
-  gem "rake", "~> 13.0"
+  gem "byebug"
+  gem "coveralls-ruby", require: false
   gem "minitest", "~> 5.0"
-
+  gem "rake", "~> 13.0"
   gem "rubocop", "~> 1.21"
   gem "rubocop-minitest"
-  gem "byebug"
+  gem "simplecov", require: false
 end

data/Gemfile.lock

@@ -1,17 +1,54 @@
 PATH
   remote: .
   specs:
-    schoolie (0.1.0)
+    schoolie (0.1.2)
+      actionview (~> 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionview (5.2.6.2)
+      activesupport (= 5.2.6.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.6.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.2)
+    builder (3.2.4)
     byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    coveralls-ruby (0.2.0)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crass (1.0.6)
+    docile (1.4.0)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    loofah (2.14.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
     minitest (5.15.0)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
+    racc (1.6.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.1)
@@ -30,18 +67,35 @@ GEM
     rubocop-minitest (0.17.2)
       rubocop (>= 0.90, < 2.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tins (1.31.0)
+      sync
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  actionview (~> 5)
   byebug
+  coveralls-ruby
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-minitest
   schoolie!
+  simplecov
 
 BUNDLED WITH
    2.2.33

data/README.md

@@ -1,8 +1,9 @@
 # Schoolie
+[![CircleCI](https://circleci.com/gh/curationexperts/schoolie/tree/main.svg?style=svg)](https://circleci.com/gh/curationexperts/schoolie/tree/main)
+<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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/schoolie`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The gem that generates a site map and meta tags for google scholar
 
 ## Installation
 
@@ -22,13 +23,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In order to map your particular metadata into the google scholar fields, create a file in Rails.root/config named schoolie.yml.
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The 'static' section will be written directly into the meta tags as is, attributes will be sent as method calls to the current curation
+concern object, and the value thus returned will be written into the meta tag.
+
+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 
+
+NB. this task just uses curl to query solr currently, so make sure you have that installed first
+
+## Development
+
+Check out the repo, and bundle install as per normal.
 
 ## Contributing
 
@@ -36,8 +64,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Schoolie project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schoolie/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
 end
 
 require "rubocop/rake_task"

data/lib/helpers/schoolie_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "yaml"
+# A simple helper that creates <meta> tags required for google scholar information.
+# The default configuration attempts to load from Rails.root/config/schoolie.yml,
+# though can be overridden
+module SchoolieHelper
+  def schoolie_tags(concern, config = Rails.root.join("config/schoolie.yml"))
+    m = load_map(config)
+    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.join("\n")
+  end
+
+  private
+
+  def load_map(config)
+    @load_map ||= YAML.safe_load(File.open(config, "r"), [Symbol])
+  end
+end

data/lib/schoolie/version.rb

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

data/lib/schoolie.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
+require "action_view"
 require_relative "schoolie/version"
-
-module Schoolie
-  class Error < StandardError; end
-  # Your code goes here...
-end
+require_relative "helpers/schoolie_helper"
+ActionView::Base.include SchoolieHelper

metadata

@@ -1,59 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: schoolie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - McClain Looney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '1.25'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -73,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
@@ -81,6 +96,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/helpers/schoolie_helper.rb
 - lib/schoolie.rb
 - lib/schoolie/version.rb
 - sig/schoolie.rbs
@@ -107,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: A gem to generate sitemaps & meta tags for Samvera repositories