jekyll-zybook-tag 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acf9da92e83954d65542a35b007bfaf14d48953afaa4a2cefa186ea1ddcecd87
+  data.tar.gz: 1440c068311b82d5f2e52e55e6c915e2db9f6365eb204113cf49b70340c5a9ff
+SHA512:
+  metadata.gz: 0ac9a7f636e231239ee186255c14dc4981edb4c82ff01734c88f4e590ed3418a8c75d9df4e438cc059a2fb9a3c9f7c28b16b178916f41c3c4cbc433f993e9dba
+  data.tar.gz: d1b6cff25a5a80f2d9ede503e37c7c4fde81ae2ea9340188cb9a038393d640f66f7716bc7d1b62a960eb17305ac201d35893eea019994df434680523ece878cf

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Colorado State University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Zybooks Liquid Tag Plugin
+
+
+This allows a link to the most recent version of zybooks, without having to 
+change links throughout the entire website. Instead the link updates based on the contents 
+of the _config.yml direction.
+
+## Setup
+Make sure the _config.yml includes the line zybook, and book-id
+
+```yaml
+zybook:  
+  book_id: "COLOSTATECS1634Summer2020"
+```
+Replace COLOSTATE... with your latest book ID, that is find in the URL of the book. For example:
+
+```
+https://learn.zybooks.com/zybook/COLOSTATECS1634Summer2020/`
+```
+
+
+## Usage
+
+```
+{% zybook chapter:x section:x %}Link text{% endzybook %}
+```
+
+For example:
+```
+{% zybook chapter:13 section:2 %}Loops{%endzybook%}
+```
+would create the following link (assuming Summer Book)
+```html
+<a href="https://learn.zybooks.com/zybook/COLOSTATECS1634Summer2020/chapter/13/section/2" target="_blank">Loops</a>
+```
+
+Arguments are optional, possible arguments are as follows:
+
+* chapter  
+  defaults to nothing, directing the link to the zybook TOC if omitted
+* section  
+  defaults to 1 
+* resource_id  
+  for the content_resource_id in links, defaults to nothing
+  
+The text between the tag block is used for the link text.
+
+## _config.yml options
+All arguments can also be included in the _config.yml. They will
+be used as default arguments, but local (placing in the tag) use overwrites
+the _config.yml setting. In most cases, the only option 
+in _config.yml that makes sense is `book-id`.

data/lib/jekyll-zybook-tag.rb

@@ -0,0 +1,94 @@
+# Zybooks Link Plugin
+#
+# The following plugin creates a liquid tag that links to the most recent zybooks for the course
+# it needs to have the zybook in the _config.yml file for it successfully link for students.
+#
+#
+# example usage
+# {% zybook chapter:x section:x %}{% endzybook %}
+#
+#  For example:
+#   {% zybook chapter:13 section:2 %}Loops{%endzybook%}
+# would create the following link (assuming Summer Book)
+# <a href="http://https://learn.zybooks.com/zybook/COLOSTATECS1634Summer2020/chapter/13/section/2" target="_blank">Loops</a>
+#
+# All arguments are OPTIONAL  the defaults are follows
+# chapter = nothing
+# section = 1 (if chapter is specified)
+# resource_id = nothing
+# So just putting in {% zybook %} would link to the TOC of your zybook.
+#
+#
+#
+module Jekyll
+  module CSU_Plugin_Zybook
+    class ZybookTag < Liquid::Block
+
+
+       @@DEFAULTS = {
+          :chapter => '',
+          :section => '1',
+          :book_base => 'https://learn.zybooks.com/zybook/',
+          :book_id => 'invalid',
+          :resource_id => ''
+        }
+
+        def self.DEFAULTS
+            return @@DEFAULTS
+        end
+
+        def initialize(tag_name, markup, tokens)
+            super
+
+            @config = {}
+            # set defaults
+            override_config(@@DEFAULTS)
+
+            # override configuration with values defined within _config.yml
+
+            if Jekyll.configuration({}).has_key?('zybook')
+                jek_config = Jekyll.configuration({})['zybook']
+                override_config(jek_config)
+            end
+
+            params = markup.split
+
+
+
+            if params.size > 0
+                # override configuration with parameters
+                pconfig = {} # reset local config
+                params.each do |param|
+                    param = param.gsub /\s+/, '' # remove whitespaces
+                    key, value = param.split(':',2) # split first occurrence of ':' only
+                    pconfig[key.to_sym] = value
+                end
+                override_config(pconfig)
+            end
+        end
+
+      def override_config(config)
+         config.each{ |key,value| @config[key] = value }
+      end
+
+      def render(context)
+        content = super
+
+        rtn = ""
+        if @config[:chapter].empty?
+            rtn = "<a href='#{@config[:book_base]}/#{@config["book_id"]}/' target='_blank'>#{content}</a>".gsub(%r{/{2,}}, '/')
+        elsif @config[:resource_id].empty?
+            rtn = "<a href='#{@config[:book_base]}/#{@config["book_id"]}/chapter/#{@config[:chapter]}/section/#{@config[:section]}/' target='_blank'>#{content}</a>".gsub(%r{/{2,}}, '/')
+        else #content_resource_id was included
+            rtn = "<a href='#{@config[:book_base]}/#{@config["book_id"]}/chapter/#{@config[:chapter]}/section/#{@config[:section]}?content_resource_id=#{@config[:resource_id]}' target='_blank'>#{content}</a>".gsub(%r{/{2,}}, '/')
+        end
+
+        return rtn
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('zybook', Jekyll::CSU_Plugin_Zybook::ZybookTag)
+
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-zybook-tag
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Albert Lionelle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- Albert.Lionelle@colostate.edu
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-zybook-tag.rb
+homepage: https://github.com/Dept-of-Computer-Science/jekyll-zybook-tag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Jekyll-zybook Tag for include zybooks content from Semester to Semester,
+  developed to work with Colorado State University Courses, but can be used for any
+  course that uses zybooks and jekyll.
+test_files: []