github-to-canvas 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c22dc2963d6dd8ee12c704de58f8a82a636c24abcea448ae49d84f25e8aad3f1
-  data.tar.gz: b96b71607b765ba283829e0dc5912a5034a9a4e2e1898bb853a36e53e996e0b3
+  metadata.gz: 59e47d1d256dca36a7312ef82f6953c5c50df08286a481928233fcdd4dbe0aad
+  data.tar.gz: 4d705224c21ac7c70e6c7543a3484baffed2f64c5069c50c070b991079d8011b
 SHA512:
-  metadata.gz: bb25c2e7cdcc0c06dd9a63f28b830e0cb7ae3248c0ad4d83f32de4039b9bb169a1a77c18f242b935ac5bf4fd3be950f23114b3354ac6125bed059f0adac17013
-  data.tar.gz: 62bcc1253d43a08ef2837d45f23eb781a6c80509f50ea5befe3711664e740db58d2770ee1652ca4f503e15b036187d2fd19c1d8884bbf73052edba76d7b4eaf8
+  metadata.gz: 03f61185beb39e4fc34421ad7c5a90dc18e7897154fdcfe5da7d7501ae16b13974045e5c4071182f1a02c72b839cfb5688df0a73f0a2f0127ec919f1ef1493b7
+  data.tar.gz: 2ad4a5f5d700f377e69ce81c5c26463007faf415ca31aef149b2520e4b843c730e68c052d1467bacedc51a6f9511d94f1a89cd00a94db86081d5f65d803ad967

data/Gemfile

@@ -1,8 +1,8 @@
 source "https://rubygems.org"
+
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
 ruby "2.6.1"
-gem 'require_all'
-gem 'json'
-gem 'redcarpet'
-gem 'rest-client'
+
 # Specify your gem's dependencies in github-to-canvas.gemspec
+gemspec

data/README.md

@@ -25,7 +25,7 @@ also required for some features.
 In order to access the Canvas API, you must first generate an API key. Go to
 your Canvas Account Settings and under **Approved Integrations**, create a
 **New Access Token**. You will need to store this API key as an `ENV` variable
-called `CANVAS_API_KEY`. 
+called `CANVAS_API_KEY`.
 
 If you are using Zsh, the following command will add your new key to the top of `~/.zshrc`:
 
@@ -74,6 +74,7 @@ The GitHub to Canvas gem can be used for the following:
 - [Map GitHub Repositories to a Canvas Course YAML file](#map)
 - [Create New Canvas Course from a YAML file](#buildcourse)
 - [Update Lessons in an Existing Course from a YAML file](#updatecourse)
+- [Syntax Highlighting](#syntaxhighlighting)
 
 ### Creating and Updating Canvas Lessons
 
@@ -123,7 +124,7 @@ To read the contents of a remote repo:
 github-to-canvas --read-from-github <URL>
 ```
 
-This will produce an HTML conversion of the repository's markdwon. This HTML can
+This will produce an HTML conversion of the repository's markdown. This HTML can
 be directly pasted into Canvas' HTML editor if a manual process is needed.
 
 #### Update a Canvas Lesson from a Local Repository <a name="update"></a>
@@ -191,30 +192,30 @@ The output will look similar to this:
 :name: The Course's Title
 :id: 111
 :modules:
-- :id: 2020
-  :name: First Module's Name
-  :lessons:
-  - id: slugified-page-name
-    title: This is the Title Of The First Lesson, a Page
-    indent: 0
-    type: Page
-    html_url: https://learning.flatironschool.com/courses/111/modules/items/27001
-    page_url: slugified-page-name
-    url: https://learning.flatironschool.com/api/v1/courses/111/pages/slugified-page-name
-    published: false
-    repository: ''
-  - id: 333
-    title: This is the Title Of The Second Lesson, an Assignment
-    indent: 1
-    type: Assignment
-    html_url: https://learning.flatironschool.com/courses/111/modules/items/27002
-    page_url: ''
-    url: https://learning.flatironschool.com/api/v1/courses/111/assignments/333
-    published: false
-    repository: ''
-- :id: 2021
-  :name: Second Module's Name
-  :lessons:
+  - :id: 2020
+    :name: First Module's Name
+    :lessons:
+      - id: slugified-page-name
+        title: This is the Title Of The First Lesson, a Page
+        indent: 0
+        type: Page
+        html_url: https://learning.flatironschool.com/courses/111/modules/items/27001
+        page_url: slugified-page-name
+        url: https://learning.flatironschool.com/api/v1/courses/111/pages/slugified-page-name
+        published: false
+        repository: ""
+      - id: 333
+        title: This is the Title Of The Second Lesson, an Assignment
+        indent: 1
+        type: Assignment
+        html_url: https://learning.flatironschool.com/courses/111/modules/items/27002
+        page_url: ""
+        url: https://learning.flatironschool.com/api/v1/courses/111/assignments/333
+        published: false
+        repository: ""
+  - :id: 2021
+    :name: Second Module's Name
+    :lessons:
 ```
 
 The output YAML will not include associated GitHub repository information.
@@ -246,7 +247,27 @@ To create a Canvas course with this gem, you will need a correctly structured
 YAML file with the course info, modules, lessons and associated lesson
 repositories. In addition, all lessons must have a type (`Page` or
 `Assignment`), a repository, and a title. Other lesson options are currently
-ignored. 
+ignored.
+
+Here's an example of what the YAML file should look like. Note that for Pages
+the id needs to be present and match the title, based on how Canvas creates
+URL slugs for pages.
+
+```yaml
+---
+:name: Test Building Course
+:course_code: TEST-GEM-COURSE
+:modules:
+  - :name: Module 1
+    :lessons:
+      - title: Lesson 1
+        type: Assignment
+        repository: https://github.com/learn-co-curriculum/react-hooks-component-props-mini-project
+      - id: lesson-2
+        title: Lesson 2
+        type: Page
+        repository: https://github.com/learn-co-curriculum/phase-0-pac-1-js-variables
+```
 
 With the necessary data configured, use the `--build-course` option and pass in
 the course's YAML file:
@@ -262,7 +283,7 @@ This command will cause the following to happen:
 - Create the first lesson using the repository, title and type, as well as additional command options
 - Add the newly created lesson to the current module
 - Create the second lesson and add it to the module...
-- Repeate process until all modules and lessons are created
+- Repeat process until all modules and lessons are created
 
 #### Update Lessons in an Existing Course from a YAML file <a name="updatecourse"></a>
 
@@ -285,6 +306,23 @@ github-to-canvas --update-course YAML_FILE -lr --forkable
 The gem will iterate over the data and update every lesson according to the
 associated repository.
 
+## Syntax Highlighting <a name="syntaxhighlighting"></a>
+
+This gem uses the [Rouge](https://github.com/rouge-ruby/rouge) Ruby gem to add
+syntax highlighting to
+[fenced code blocks](https://www.markdownguide.org/extended-syntax/#syntax-highlighting).
+Rouge tokenizes the fenced code blocks and generates HTML elements with CSS
+classes to style code blocks. The classes generated by Rouge are intended to
+work with [Pygments](https://pygments.org/).
+
+You can download and customize CSS themes for the classes generated by Rouge at this site:
+
+- [http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html](http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html)
+
+After selecting your preferred CSS, you will need to
+[update your Canvas theme](https://community.canvaslms.com/t5/Admin-Guide/How-do-I-upload-custom-JavaScript-and-CSS-files-to-an-account/ta-p/253)
+so the CSS can run on each page.
+
 ## Known Issues
 
 ### HTML Code Snippets Do Not Render
@@ -319,18 +357,10 @@ Note that realigning after fixing this content with the gem will break the
 rendering for these lessons again. A fix is planned for this issue, but has not
 been implemented.
 
-### Multi-Line Code Snippets Render as a Single Line
-
-The Github to Canvas gem uses an existing gem, Redcarpet, to handle the Markdown to HTML
-conversion. This gem does not currently support multi-line codeblocks. This
-functionality has been added in the Github to Canvas gem through monkeypatching.
-This error should be resolved, but if you encounter code snippet rendering
-issues, please open a new issue with a markdown example to replicate the error.
-
 ### Markdown Formatting Issues Cause Errors in Canvas
 
 An empty line should separate individual markdown headers, paragraphs and code snippets
-in the markdown. Without these empty lines, the contents will be interpretted as one
+in the markdown. Without these empty lines, the contents will be interpreted as one
 continuous paragraph and ignore formatting.
 
 ### New Repos That Use a `main` Branch
@@ -404,7 +434,7 @@ Run `github-to-canvas --help` for additional options not listed in this Readme.
 
 ## Examples of Valid Images This Gem Can Convert
 
-This gem can convert both standard inline markdown and HTML images. 
+This gem can convert both standard inline markdown and HTML images.
 
 Inline Markdown:
 
@@ -416,5 +446,5 @@ HTML:
   <img src="https://curriculum-content.s3.amazonaws.com/fewpjs/fewpjs-fetch-lab/Image_25_AsynchronousJavaScript.png" width="500">
 </p>
 
-[Canvas LMS API]: https://canvas.instructure.com/doc/api/index.html
-[Flatiron School]: https://flatironschool.com/
+[canvas lms api]: https://canvas.instructure.com/doc/api/index.html
+[flatiron school]: https://flatironschool.com/

data/bin/github-to-canvas

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'optparse'
-require 'github-to-canvas'
+require_relative '../lib/github-to-canvas'
 
 options = {}
 OptionParser.new do |opts|
@@ -191,8 +193,8 @@ OptionParser.new do |opts|
             options[:clone_from_yaml] = file
           end
   opts.on("--contains-html", 
-          "Escapes all HTML included in source markdown by replacing '<' and '>' with HTML charset values") do |html|
-            options[:contains_html] = html
+          "DEPRECATED: HTML in code blocks handled by Rouge gem.") do |html|
+            puts "--contains-html flag is DEPRECATED: HTML in code blocks handled by Rouge gem."
           end
   opts.on("--canvas-to-canvas COURSE",
           "Copies an existing Canvas lesson into another Canvas lesson") do |canvas_to_canvas|
@@ -238,8 +240,7 @@ if options[:read_from_github]
                     forkable: !!options[:forkable],
                     fis_links: !!options[:fis],
                     aaq: !!options[:aaq],
-                    prework: !!options[:prework],
-                    contains_html: options[:contains_html])
+                    prework: !!options[:prework])
   abort
 end
 
@@ -254,8 +255,7 @@ if options[:create_from_github]
                       forkable: !!options[:forkable],
                       fis_links: !!options[:fis],
                       aaq: !!options[:aaq],
-                      prework: !!options[:prework],
-                      contains_html: options[:contains_html])
+                      prework: !!options[:prework])
   else
     puts 'Canvas course ID and lesson type required. Example: github-to-canvas --create-from-github URL --course ID --type TYPE'
   end
@@ -274,8 +274,7 @@ if options[:align_from_github]
                       forkable: !!options[:forkable],
                       fis_links: !!options[:fis],
                       aaq: !!options[:aaq],
-                      prework: !!options[:prework],
-                      contains_html: options[:contains_html])
+                      prework: !!options[:prework])
   else
     puts 'Canvas course ID, lesson ID, and type required. Example: github-to-canvas --create-from-github URL --course COURSE_ID --id LESSON_ID --type TYPE'
   end
@@ -309,7 +308,6 @@ if options[:csv_build]
                     aaq: !!options[:aaq],
                     forkable: !!options[:forkable],
                     branch: options[:branch],
-                    contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
   abort
 end
@@ -323,7 +321,6 @@ if options[:csv_align]
                     aaq: !!options[:aaq],
                     forkable: !!options[:forkable],
                     branch: options[:branch],
-                    contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
   abort
 end
@@ -336,7 +333,6 @@ if options[:build_course]
                     aaq: !!options[:aaq],
                     prework: !!options[:prework],
                     forkable: !!options[:forkable],
-                    contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
   abort
 end
@@ -351,7 +347,6 @@ if options[:add_to_course]
                       forkable: !!options[:forkable],
                       aaq: !!options[:aaq],
                       prework: !!options[:prework],
-                      contains_html: options[:contains_html],
                       git_links: !!options[:git_links])
   else
     puts '--course required'
@@ -367,7 +362,6 @@ if options[:update_course_lessons]
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
                     prework: !!options[:prework],
-                    contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
   abort
 end
@@ -433,8 +427,7 @@ if options[:create_lesson]
                     only_update_content: !!options[:only_content],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
-                    prework: !!options[:prework],
-                    contains_html: options[:contains_html])
+                    prework: !!options[:prework])
 end
 
 if options[:align]
@@ -453,6 +446,5 @@ if options[:align]
                     only_update_content: !!options[:only_content],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
-                    prework: !!options[:prework],
-                    contains_html: options[:contains_html])
+                    prework: !!options[:prework])
 end

data/lib/github-to-canvas.rb

@@ -201,9 +201,6 @@ class GithubToCanvas
         options[:name] = lesson[1]
         options[:type] = lesson[3]
         options[:branch] = "master" if !options[:branch]
-        if !options[:contains_html]
-          options[:contains_html] = (lesson[4] == "yes" || lesson[4] == "Yes") ? true : false
-        end
         
 
         html = RepositoryConverter.remote_file_conversion(options)
@@ -243,9 +240,6 @@ class GithubToCanvas
         options[:id] = lesson[5]
         options[:course_id] = lesson[6]
         options[:branch] = "master" if !options[:branch]
-        if !options[:contains_html]
-          options[:contains_html] = (lesson[4] == "yes" || lesson[4] == "Yes") ? true : false
-        end
         
 
         html = RepositoryConverter.remote_file_conversion(options)

data/lib/github-to-canvas/canvas_interface.rb

@@ -217,12 +217,9 @@ class CanvasInterface
             response = RestClient.get(url, self.headers)
             lessons = JSON.parse(response.body)
             lessons = lessons.map do |lesson|
-              if lesson["type"] == "ExternalUrl"
-                next
-              end
               lesson = lesson.slice("id","title","name","indent","type","html_url","page_url","url","completion_requirement", "published")
               lesson["repository"] = ""
-              lesson['id'] = lesson['url'].gsub(/^(.*[\\\/])/,'')
+              lesson['id'] = lesson['url']&.gsub(/^(.*[\\\/])/,'')
               lesson
             end
             if ([200, 201].include? response.code) && (!lessons.empty?)
@@ -247,6 +244,7 @@ class CanvasInterface
     course_info = YAML.load(File.read("#{Dir.pwd}/#{options[:file_to_convert]}"))
     course_info[:modules] = course_info[:modules].map do |mod|
       mod[:lessons] = mod[:lessons].map do |lesson|
+        next lesson unless lesson.key?("url")
 
         url = lesson["url"]
         response = RestClient.get(url, headers={

data/lib/github-to-canvas/repository_converter.rb

@@ -1,14 +1,9 @@
 require 'redcarpet'
-class CustomRender < Redcarpet::Render::HTML
-  def block_code(code, lang)
-    "<pre>" \
-      "<code>#{multi_line(code)}</code>" \
-    "</pre>"
-  end
+require 'rouge'
+require 'rouge/plugins/redcarpet'
 
-  def multi_line(code)
-    code.gsub(/\n(?=[^.])/, "<br />")
-  end
+class CustomRender < Redcarpet::Render::HTML
+  include Rouge::Plugins::Redcarpet
 end
 
 class RepositoryConverter
@@ -16,7 +11,6 @@ class RepositoryConverter
     # GithubInterface.get_updated_repo(options[:filepath], options[:branch])
     markdown = RepositoryInterface.read_local_file(options[:filepath], options[:file_to_convert])
     raw_remote_url = self.set_raw_image_remote_url(options[:filepath])
-    markdown = self.escape_existing_html(markdown) if options[:contains_html]
     markdown = self.fix_local_images(options, markdown, raw_remote_url)
     html = self.convert_to_html(markdown)
     # self.fix_local_html_links(options, html, options[:filepath])
@@ -25,14 +19,6 @@ class RepositoryConverter
   def self.remote_file_conversion(options)
     markdown = GithubInterface.read_remote(options[:filepath])
     raw_remote_url = self.set_raw_image_remote_url(options[:filepath])
-    if options[:contains_html]
-      begin
-        markdown = self.escape_existing_html(markdown)
-      rescue
-        puts "Error reading remote markdown"
-        abort
-      end
-    end
     if (!options[:branch])
       options[:branch] = 'master'
     end
@@ -42,11 +28,16 @@ class RepositoryConverter
   end
 
   def self.convert_to_html(markdown)
-    renderer = CustomRender.new(escape_html: true, prettify: true, hard_wrap: true)
-    redcarpet = Redcarpet::Markdown.new(CustomRender, options={tables: true, autolink: true, fenced_code_blocks: true, disable_indented_code_blocks: true})
+    options = {
+      tables: true,
+      autolink: true,
+      fenced_code_blocks: true,
+      no_intra_emphasis: true
+    }
+    redcarpet = Redcarpet::Markdown.new(CustomRender, options)
     html = redcarpet.render(markdown)
     puts "Markdown converted to HTML"
-    self.remove_line_breaks(html)
+    html
   end
 
   def self.adjust_converted_html(options, html)
@@ -58,26 +49,9 @@ class RepositoryConverter
       html = self.add_fis_links(options, html)
     end
 
-    if options[:contains_html]
-      html = self.fix_escaped_inline_html_code(html)
-    end
     html
   end
-
-  def self.fix_escaped_inline_html_code(html)
-    
-    html
-  end
-
-  def self.escape_existing_html(markdown)
-    markdown = markdown.gsub(/```(\n|.)*?```/) { |code|
-      # all code blocks
-      code = code.gsub("<", "&lt;")
-      code = code.gsub(">", "&gt;")
-    }
-    markdown
-  end
-
+  
   def self.remove_header_and_footer(html)
     new_html = self.remove_html_header(html)
     # new_html = self.remove_footer(new_html)

data/lib/github-to-canvas/version.rb

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.1.16"
+  VERSION = "0.1.17"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - maxwellbenton
@@ -11,47 +11,47 @@ cert_chain: []
 date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.26'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: github-to-canvas is a tool for migrating and aligning GitHub content with