github-to-canvas 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5628681c8cda313989c521770b0b7f2a20e9b7a0aa0f661446d25d1040eca8d
-  data.tar.gz: da78038dd5492dbb897c9fb6d65e05c76f02e7e57df952630c859d9b446d6c79
+  metadata.gz: d3d7cf49277d1fb40bb6a956a16865fded3e5a722b115313ab598c8b0ac16338
+  data.tar.gz: '01129c91256e4391343d2dd4bafc0c87acf57d7f8e0a4f3b040289ab045b6dea'
 SHA512:
-  metadata.gz: abc12344a24c0c7d67980dc4911462e7c7eb3aba0c31e18b42e5f95fda97fef7b60a994c4ce59fc6da3d6fb7db044fc47ae443979e06455a82906e4ae863f4cd
-  data.tar.gz: 467e1d799b929fccf52cb155d27411050232c30b704fde8d216516c1bc7891d69c6617252cfdd8782ceb35a10fd05b2d5efdf5dd6754bfb097f22ee740876f36
+  metadata.gz: ead1b6073842a1d3c65214ffc3e3cd8bd20048df97a878d8f12dd522655090e02b98f9fb2d45be70a16a044d05aea682bf5c6c71cd31ccd8a6ab9fb215591948
+  data.tar.gz: cb340a9d7f4910116ede731ad44cb44a02f90bf77dae5e632669d2b54879af2eab38a8ff1ebf4e1fd639ee1c68ac22fdd5ded4d3ae5f57cd283696b4e32b0834

data/README.md

@@ -294,29 +294,45 @@ 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 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.
-
-Read the GitHub repo as HTML:
-
-```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. 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.
+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.
+
+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)`).
+
+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
+  ```
+
+- 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.
 
 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 with the gem will break the
-rendering for these lessons again. A fix is planned for this issue, but has not
-been implemented.
+Note that realigning after fixing this content may overwrite fixes.
 
 ### Multi-Line Code Snippets Render as a Single Line
 

data/bin/github-to-canvas

@@ -77,7 +77,6 @@ OptionParser.new do |opts|
   opts.on("-tTYPE", "--type TYPE", 
           "Sets the type Canvas lesson to be created (page or assignment). If no type, type decided based on repository structure") do |type| 
             # byebug
-            puts type.downcase
             options[:type] = type.downcase
             abort if type == 'quiz' || type == 'discussion'
             # if type == 'page' || type == 'assignment' || type == 'discussion' || type == 'quiz' || type == 'Page' || type == 'Assignment' || type == 'Discussion' || type == 'Quiz'
@@ -107,6 +106,10 @@ OptionParser.new do |opts|
           "Adds additional Flatiron School HTML after markdown conversion") do |f|
             options[:fis] = true
           end
+  opts.on("--aaq", 
+          "Adds AAQ flag to HTML header appended with --fis-links") do |aaq|
+            options[:aaq] = aaq
+          end
   opts.on("--forkable",
           "Used with --fis-links, adds fork button to HTML header injected into Canvas lesson") do |remote|
             options[:forkable] = true
@@ -175,6 +178,10 @@ OptionParser.new do |opts|
           "Iterates over provided course YAML file and clones repos locally") do |file|
             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
+          end
   
 end.parse!
 
@@ -184,12 +191,19 @@ if options[:version]
 end
 
 if options[:read_from_canvas]
-  GithubToCanvas.new(mode: 'canvas_read', filepath: options[:read_from_canvas])
+  GithubToCanvas.new(mode: 'canvas_read', 
+                    filepath: options[:read_from_canvas])
   abort
 end
 
 if options[:read_from_github]
-  GithubToCanvas.new(mode: 'github_read', filepath: options[:read_from_github])
+  GithubToCanvas.new(mode: 'github_read', 
+                    filepath: options[:read_from_github],
+                    remove_header_and_footer: !!options[:remove_header_and_footer],
+                    forkable: !!options[:forkable],
+                    fis_links: !!options[:fis],
+                    aaq: !!options[:aaq],
+                    contains_html: options[:contains_html])
   abort
 end
 
@@ -199,9 +213,12 @@ if options[:create_from_github]
                       filepath: options[:create_from_github], 
                       course_id: options[:course_id], 
                       type: options[:type],
+                      name: options[:name],
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
-                      fis_links: !!options[:fis])
+                      fis_links: !!options[:fis],
+                      aaq: !!options[:aaq],
+                      contains_html: options[:contains_html])
   else
     puts 'Canvas course ID and lesson type required. Example: github-to-canvas --create-from-github URL --course ID --type TYPE'
   end
@@ -218,7 +235,9 @@ if options[:align_from_github]
                       name: options[:name],
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
-                      fis_links: !!options[:fis])
+                      fis_links: !!options[:fis],
+                      aaq: !!options[:aaq],
+                      contains_html: options[:contains_html])
   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
@@ -245,6 +264,7 @@ if options[:build_course]
                     file_to_convert: options[:build_course],
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
+                    aaq: !!options[:aaq],
                     forkable: !!options[:forkable])
   abort
 end
@@ -256,7 +276,9 @@ if options[:add_to_course]
                       file_to_convert: options[:add_to_course],
                       fis_links: !!options[:fis], 
                       remove_header_and_footer: !!options[:remove_header_and_footer],
-                      forkable: !!options[:forkable])
+                      forkable: !!options[:forkable],
+                      aaq: !!options[:aaq],
+                      contains_html: options[:contains_html])
   else
     puts '--course required'
   end
@@ -268,7 +290,9 @@ if options[:update_course_lessons]
                     file_to_convert: options[:update_course_lessons],
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    contains_html: options[:contains_html])
   abort
 end
 
@@ -330,7 +354,9 @@ if options[:create_lesson]
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     only_update_content: !!options[:only_content],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    contains_html: options[:contains_html])
 end
 
 if options[:align]
@@ -346,5 +372,7 @@ if options[:align]
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     only_update_content: !!options[:only_content],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    contains_html: options[:contains_html])
 end

data/lib/github-to-canvas.rb

@@ -27,8 +27,8 @@ class GithubToCanvas
     when 'canvas_read'
       puts CanvasInterface.read_lesson(options[:filepath])
     when 'github_read'
-      markdown = GithubInterface.read_remote(options[:filepath])
-      puts RepositoryConverter.convert_to_html(markdown)
+      html = RepositoryConverter.remote_file_conversion(options)
+      puts RepositoryConverter.adjust_converted_html(options, html)
     when 'create' # used with a local repo
       html = RepositoryConverter.local_file_conversion(options)
       name = RepositoryInterface.get_name(options[:filepath], html)
@@ -38,13 +38,13 @@ class GithubToCanvas
       puts "Canvas lesson created. Lesson available at #{response['html_url']}"
     when 'align' # used with a local repo
       html = RepositoryConverter.local_file_conversion(options)
-      name = RepositoryInterface.get_name(options[:filepath], html)
+      name = options[:name] ? options[:name] : RepositoryInterface.get_name(options[:filepath], html)
       html = RepositoryConverter.adjust_converted_html(options, html)
       CanvasInterface.update_all_related_lessons(options, name, html)
       
     when 'github_create'
       html = RepositoryConverter.remote_file_conversion(options)
-      name = RepositoryInterface.get_name(options[:filepath], html)
+      name = options[:name] ? options[:name] : RepositoryInterface.get_name(options[:filepath], html)
       html = RepositoryConverter.adjust_converted_html(options, html)
       
       response = CanvasInterface.create_lesson(options, name, html)

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

@@ -47,10 +47,6 @@ class CanvasInterface
     JSON.parse(response.body)
   end
 
-  def self.create_quiz(options, quiz_data)
-    
-  end
-
   def self.add_to_module(course_id, module_info, lesson_info)
     # POST /api/v1/courses/:course_id/modules/:module_id/items
     url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/modules/#{module_info["id"]}/items"
@@ -76,15 +72,12 @@ class CanvasInterface
       }
     end
     begin
-      byebug
       response = RestClient.post(url, payload, self.headers)
     rescue
       puts "Something went wrong while adding lesson #{lesson_info["id"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Assignment"
       puts "Something went wrong while adding lesson #{lesson_info["page_url"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Page"
       abort
     end
-
-    
     response
     
   end

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

@@ -17,7 +17,7 @@ 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])
@@ -26,6 +26,7 @@ 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])
+    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])
@@ -46,9 +47,24 @@ class RepositoryConverter
     if options[:fis_links]
       html = self.add_fis_links(options, html)
     end
+
+    html = self.fix_escaped_inline_html_code(html)
+
     html
   end
 
+  def self.fix_escaped_inline_html_code(html)
+    html = html.gsub("<code>&amp;lt;", "<code>&lt;")
+    html = html.gsub("&amp;gt;</code>", "&gt;</code>")
+  end
+
+
+  def self.escape_existing_html(markdown)
+    markdown = markdown.gsub(/<\/(?!iframe)/, "&lt;/")
+    markdown = markdown.gsub(/<(?!iframe)/, "&lt;")
+    markdown = markdown.gsub(/(?<!iframe)>/, "&gt;")
+  end
+
   def self.remove_header_and_footer(html)
     new_html = self.remove_html_header(html)
     new_html = self.remove_footer(new_html)
@@ -56,7 +72,7 @@ class RepositoryConverter
   end
 
   def self.remove_header(readme)
-    readme.gsub!(/^# .+?\n\n/,"")
+    readme = readme.gsub(/^# .+?\n\n/,"")
     readme.gsub(/^# .+?\n/,"")
   end
 
@@ -163,7 +179,7 @@ class RepositoryConverter
     repo_info = self.get_repo_info(options[:filepath])
     html = html.sub(/<div id="git-data-element.*<header class="fis-header.*<\/header>/,'') # remove existing fis header
     header = self.create_github_link_header(repo_info[:repo_path], options[:forkable])
-    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name])
+    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name], options[:aaq])
     data_element + header + html
   end
 
@@ -183,8 +199,12 @@ class RepositoryConverter
     end
   end
 
-  def self.create_data_element(repo_org, repo_name)
-    "<div id='git-data-element' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
+  def self.create_data_element(repo_org, repo_name, aaq)
+    if (aaq)
+      "<div id='git-data-element' data-aaq='enabled' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
+    else
+      "<div id='git-data-element' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
+    end
   end
 
   

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

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