github-to-canvas 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fdb3495cf035026b326415c643f799389f104d417f3131504bc173756f6139b
-  data.tar.gz: 1e33feb5268015f1db19089686fe8c10299ec925f2b49c2c4a1f9b759fe5092f
+  metadata.gz: c22dc2963d6dd8ee12c704de58f8a82a636c24abcea448ae49d84f25e8aad3f1
+  data.tar.gz: b96b71607b765ba283829e0dc5912a5034a9a4e2e1898bb853a36e53e996e0b3
 SHA512:
-  metadata.gz: 4e3db83d774f1b815faf65f09b7cb63b2e76a04c80eef1671b1bf2130540a387ed89333556fc96257e56862885a3ce83670ebeb4094abd142e83b50c5dae3a5f
-  data.tar.gz: abe6c2dbd1ccc1e710f5ca9e32bfba5dadb7e1651ed03656115b3db1cbfc11b378d12f224a075952c87ada6411c2f989e401504290d0c8a71748adf664eef216
+  metadata.gz: bb25c2e7cdcc0c06dd9a63f28b830e0cb7ae3248c0ad4d83f32de4039b9bb169a1a77c18f242b935ac5bf4fd3be950f23114b3354ac6125bed059f0adac17013
+  data.tar.gz: 62bcc1253d43a08ef2837d45f23eb781a6c80509f50ea5befe3711664e740db58d2770ee1652ca4f503e15b036187d2fd19c1d8884bbf73052edba76d7b4eaf8

data/Gemfile

@@ -1,11 +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
+# Specify your gem's dependencies in github-to-canvas.gemspec

data/README.md

@@ -30,13 +30,13 @@ called `CANVAS_API_KEY`.
 If you are using Zsh, the following command will add your new key to the top of `~/.zshrc`:
 
 ```sh
-echo "$(export 'CANVAS_API_KEY=your-new-API-key-here' | cat - ~/.zshrc)" > ~/.zshrc
+echo "$(export 'CANVAS_API_KEY=<your-new-API-key-here>' | cat - ~/.zshrc)" > ~/.zshrc
 ```
 
 If you are using Bash, use this command instead:
 
 ```sh
-echo "$(export 'CANVAS_API_KEY=your-new-API-key-here' | cat - ~/.bash_profile)" > ~/.bash_profile
+echo "$(export 'CANVAS_API_KEY=<your-new-API-key-here>' | cat - ~/.bash_profile)" > ~/.bash_profile
 ```
 
 > If you aren't sure which you use, run `echo $SHELL`
@@ -294,45 +294,30 @@ includes HTML that is not meant to be rendered, the content will be rendered as
 part of the page's HTML, resulting in unusual display errors in Canvas. Examples of
 this would be lessons on HTML or JavaScript that include HTML code snippets.
 
-To prevent HTML from being rendered, include the `--contains-html` option when
-running the GitHub to Canvas gem. This replaces `<` and `>` characters with HTML
-charset values wrapped in `span` elements. This will stop Canvas from rendering
-the HTML.
+To fix any rendering issues in Canvas, go to the Canvas WYSIWYG editor for the
+afflicted lesson. Click the HTML editor option (`</>` button in the lower right) to
+switch to HTML.
 
-If your markdown contains a mix of HTML that should and should not be rendered,
-you will need to either replace HTML that you want to be rendered with markdown
-syntax equivalents. For example, HTML you want to display as code and an `<img>`
-element you want to render as the image itself, replace the `<img>` tag with
-markdown syntax (`![alt text](url)`).
+Read the GitHub repo as HTML:
 
-The one exception is the `<iframe>` element. There is no way to easily embed
-videos in GitHub markdown without HTML, so this tag will always be allowed to
-render in Canvas, whether or not you use `--contains-html`.
-
-If you have HTML related rendering issues in Canvas that can't be fixed with
-`--contains-html`:
-
-- Go to the Canvas WYSIWYG editor for the afflicted lesson.
-- Click the HTML editor option (`</>` button in the lower right) to switch to
-  HTML.
-- Read the GitHub repo as HTML:
-
-  ```sh
-  github-to-canvas --read-from-github URL
-  ```
+```sh
+github-to-canvas --read-from-github URL
+```
 
-- Copy the output HTML and paste it in to the Canvas editor. This should clear up
-some larger page rendering issues, but may not fix all code snippets issues. 
-- Switch back to the regular Canvas WYSIWYG editor
-- Open a second tab to the GitHub repo you're converting from.
-- Copy any HTML code snippets from GitHub and paste them into the Canvas editor
-  where they should be displayed.
+Copy the output HTML and paste it into the Canvas editor (if your lesson has a
+`<header>` with github links, leave this in). This should clear up some larger
+page rendering issues, but may not fix all code snippets issues. To fix these,
+switch back to the regular Canvas WYSIWYG editor, then open a second tab to the
+GitHub repo you're converting from. Copy any HTML code snippets from GitHub and
+paste them into the Canvas editor where they should be displayed.
 
 The Canvas editor will treat the pasted HTML content as code and will
 automatically replace some characters, escaping the code from the
 normal rendering process.
 
-Note that realigning after fixing this content may overwrite fixes.
+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
 

data/lib/github-to-canvas.rb

@@ -23,7 +23,7 @@ class GithubToCanvas
     when 'map'
       CanvasInterface.map_course_info(options)
     when 'csv'
-      CanvasInterface.csv(options[:file_to_convert])
+      CanvasInterface.csv(options[:file_to_convert]) # not working properly
     when 'canvas_read'
       puts CanvasInterface.read_lesson(options[:filepath])
     when 'canvas_copy'

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

@@ -1,7 +1,6 @@
 require 'json'
 require 'rest-client'
 require 'yaml'
-# require 'byebug'
 class CanvasInterface
 
   def self.create_course(course_info)

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

@@ -1,5 +1,4 @@
 require 'redcarpet'
-require 'byebug'
 class CustomRender < Redcarpet::Render::HTML
   def block_code(code, lang)
     "<pre>" \
@@ -51,7 +50,6 @@ class RepositoryConverter
   end
 
   def self.adjust_converted_html(options, html)
-    
     if options[:remove_header_and_footer]
       html = self.remove_header_and_footer(html)
     end
@@ -63,70 +61,26 @@ class RepositoryConverter
     if options[:contains_html]
       html = self.fix_escaped_inline_html_code(html)
     end
-
     html
   end
 
   def self.fix_escaped_inline_html_code(html)
     
-    # stops HTML/JSX code blocks from rendering as HTML in Canvas
-    # html = html.gsub("&amp;gt;</code>", "&gt;</code>")
-    # html = html.gsub("&amp;gt;</code>", "&gt;</code>")
-
-    # fixes < and > code snippets
-
-    # html = html.gsub(/<pre><code>(.*?)<\/code><\/pre>/) { |string|
-    #   byebug
-    # }
-    # html = html.gsub("&amp;gt;", "&gt;")
-
-    # # fixes blockquotes
-    # html = html.gsub(/\n<p>&gt\;(.*)\n&gt\;/) { |bq|
-    #   bq.delete_prefix!("\n<p>&gt;")
-    #   "\n<blockquote>" + bq
-    # }
-    # html = html.gsub(/\n&gt\;(.*)\n&gt\;/) { |bq|
-    #   bq.delete_prefix!("\n&gt;")
-    #   " " + bq
-    # }
-    # html = html.gsub(/\n&gt\;(.*)<\/p>/) { |bq|
-    #   bq.delete_prefix!("\n&gt\;")
-    #   bq.delete_suffix!("</p>")
-    #   " " + bq + "</blockquote>"
-    # }
-
     html
   end
 
-
   def self.escape_existing_html(markdown)
-    markdown = markdown.gsub(/```(\n|.)*```/) { |code|
-      # all blocks
+    markdown = markdown.gsub(/```(\n|.)*?```/) { |code|
+      # all code blocks
       code = code.gsub("<", "&lt;")
       code = code.gsub(">", "&gt;")
     }
-    # markdown = markdown.gsub(/(`)(.+?)(`)/) { |code|
-    #   # all backticks
-      
-    #   if code.match?(/<(.*?)>/)
-    #     code = code.gsub("<", "&lt;")
-    #     code = code.gsub(">", "&gt;")
-    #   end
-      
-    #   code
-    # }
-    # markdown = markdown.gsub(/<(?!iframe)/, "&lt;")
-    # markdown = markdown.gsub(/(?<!iframe)>/, "&gt;")
-
-    # markdown = markdown.gsub(/```(.*?)```/) {|s|
-    #   byebug
-    # }
     markdown
   end
 
   def self.remove_header_and_footer(html)
     new_html = self.remove_html_header(html)
-    new_html = self.remove_footer(new_html)
+    # new_html = self.remove_footer(new_html)
     new_html
   end
 
@@ -143,7 +97,7 @@ class RepositoryConverter
   end
 
   def self.remove_html_header(html)
-    html.gsub(/<h1>.*<\/h1>/,"")
+    html.gsub(/<h1>.*?<\/h1>/,"")
   end
 
   def self.fix_local_html_links(options, html, filepath)

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - maxwellbenton