github-to-canvas 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d720431e21790c476e0cb901dc357a6c9535df029f9a73739a2d6d7acccb0758
-  data.tar.gz: a4826c7a1a660e85754f26063a24c277f4991261d460617042e8f14b3df83fb1
+  metadata.gz: a4ebf48161f0c0ac7ad012460961650eba100d006aa84a945a863278238a27a5
+  data.tar.gz: 1316e7036aa3032cbe4fa0d883b32f9c2bb142f585915d3045acbcb884e326b5
 SHA512:
-  metadata.gz: b0cf044ec46931fc2ff748b6e05a57513ab669aed896118a6db61d745b2f7546af8366dc3a33ea92e98c4b3278be62e0dea024a211f23aadf7ff95967c44558a
-  data.tar.gz: 3b2115286e05dc581c3b953c778e5ab00a4781ca46560666365481cc92bfaa80789080a9002a622a9faed43cd11626e45bdeaaf47406df21adbd81e5552d8b50
+  metadata.gz: a7005054aae77a3c0212c6be57e9ecd1a6c6066d3882a25ef2fef6bafd96abf71b2ad2283bde23a80830379adfffb5dd56913d56709d8ed4ecd9b4c7aa5a745f
+  data.tar.gz: d3516690ddcbec8c8df013530c399a38f8d8ddb4f69513385dc1339eb1a04dac141446931000a6aa37daea1b74905fafa8793657107aea9075d41c1d6bf1d988

data/bin/github-to-canvas

@@ -19,7 +19,7 @@ OptionParser.new do |opts|
     github-to-canvas --create COURSE [--branch BRANCH] [--name NAME] [--type TYPE]
     github-to-canvas --create COURSE [--dry-run]
     github-to-canvas --create COURSE [--fis-links]
-    github-to-canvas --create COURSE [--fis-links] [--remove-header]
+    github-to-canvas --create COURSE [--fis-links] [--remove-header-and-footer]
     github-to-canvas --align
     github-to-canvas --align [--branch BRANCH]
     github-to-canvas --align [--branch BRANCH] [--fis-links]
@@ -37,7 +37,7 @@ OptionParser.new do |opts|
     github-to-canvas --create 154 --name "Fetch Lab" --branch solution -> Creates a lesson in course 154 with the provided name, uses the repository's solution branch and derives the type from the local repo
     github-to-canvas --align                                           -> Patches existing lessons in Canvas based on the .canvas file  
     github-to-canvas --align --fis-links                               -> Patches existing lessons in Canvas based on the .canvas file, adds addition Flatiron School specific HTML
-    github-to-canvas --align --remove-header                           -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to HTML
+    github-to-canvas --align --remove-header-and-footer                           -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to HTML
 
   EOBANNER
 
@@ -79,9 +79,9 @@ OptionParser.new do |opts|
           "Adds additional Flatiron School HTML after markdown conversion") do |f|
             options[:fis] = true
           end
-  opts.on("-r", "--remove-header",
-          "Removes top lesson header before converting to HTML") do |r|
-            options[:remove_header] = true
+  opts.on("-r", "--remove-header-and-footer",
+          "Removes top lesson header and any Learn.co specific footer links before converting to HTML") do |r|
+            options[:remove_header_and_footer] = true
           end
   
 end.parse!
@@ -115,7 +115,7 @@ if options[:create]
                     type: options[:type], 
                     dry: !!options[:dry], 
                     fis_links: !!options[:fis], 
-                    remove_header: !!options[:remove_header])
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 end
 
 if options[:align]
@@ -127,5 +127,5 @@ if options[:align]
                     type: options[:type], 
                     dry: !!options[:dry], 
                     fis_links: !!options[:fis], 
-                    remove_header: !!options[:remove_header])
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 end

data/lib/github-to-canvas.rb

@@ -17,7 +17,7 @@ class GithubToCanvas
                 type:"page", 
                 dry:false, 
                 fis_links:false,
-                remove_header:false)
+                remove_header_and_footer:false)
 
     if mode == 'version'
       puts VERSION
@@ -26,12 +26,12 @@ class GithubToCanvas
 
     if mode == 'create'
       puts "github-to-canvas will now create a Canvas lesson based on the current repo"
-      CreateCanvasLesson.new(course, filepath, branch, name, type, dry, fis_links, remove_header)
+      CreateCanvasLesson.new(course, filepath, branch, name, type, dry, fis_links, remove_header_and_footer)
     end
 
     if mode == 'align'
       puts "github-to-canvas will now align any existing Canvas lessons based on the current repo. NOTE: .canvas file must be present"
-      UpdateCanvasLesson.new(filepath, branch, name, type, dry, fis_links, remove_header)
+      UpdateCanvasLesson.new(filepath, branch, name, type, dry, fis_links, remove_header_and_footer)
     end
   end
 

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

@@ -1,18 +1,18 @@
 class CreateCanvasLesson
 
-  def initialize(course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def initialize(course, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     name = name.split(/[- _]/).map(&:capitalize).join(' ')
     original_readme = File.read("#{filepath}/README.md")
     if !original_readme
       puts 'README.md not found in current directory. Exiting...'
       abort
     end
-    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
   end
 
-  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
     if fis_links
       new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
     end

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

@@ -1,17 +1,21 @@
 require 'redcarpet'
-require 'byebug'
 class RepositoryConverter
 
-  def self.convert(filepath, readme, branch, remove_header)
-    if remove_header
-      self.remove_header(readme)
+  def self.convert(filepath, readme, branch, remove_header_and_footer)
+    if remove_header_and_footer
+      readme = self.remove_header(readme)
+      readme = self.remove_footer(readme)
     end
     self.fix_local_images(filepath, readme, branch)
     self.convert_to_html(filepath, readme)
   end
 
   def self.remove_header(readme)
-    readme.gsub!(/^#.+?\n\n/,"")
+    readme.gsub(/^# .+\n\n/,"")
+  end
+
+  def self.remove_footer(readme)
+    readme.gsub(/<p (.+?)<\/p>/,"")
   end
 
   def self.fix_local_images(filepath, readme, branch)
@@ -69,12 +73,14 @@ class RepositoryConverter
 
   def self.add_fis_links(filepath, readme)
     repo = self.get_repo_url(filepath)
-    github_repo_link = "<a style='text-decoration: none;' href='#{repo}' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Open GitHub Repo' src='https://curriculum-content.s3.amazonaws.com/git-logo-gray.png' alt='Link to GitHub Repo' /></a>"
-    github_issue_link = "<a style='text-decoration: none;' href='#{repo}/issues/new' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Create New Issue' src='https://curriculum-content.s3.amazonaws.com/flag-icon-gray.png' alt='Link to GitHub Repo Issue Form' /></a>"
-
-    html = "<p style='margin: 0; padding: 0; position: absolute; right: 5px; top: 5px; margin: 0; padding: 0;'>#{github_repo_link}#{github_issue_link}</p>"
-    
-    readme + html
+    github_repo_link = "<a class='fis-git-link' href='#{repo}' target='_blank' rel='noopener'><img id='repo-img' title='Open GitHub Repo' alt='GitHub Repo' /></a>"
+    github_issue_link = "<a class='fis-git-link' href='#{repo}/issues/new' target='_blank' rel='noopener'><img id='issue-img' title='Create New Issue' alt='Create New Issue' /></a>"
+    thumbs_up_link = "<a id='thumbs-up' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs up!' alt='thumbs up' /></a>"
+    thumbs_down_link = "<a id='thumbs-down' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs down!' alt='thumbs down' /></a>"
+    feedback_link = "<h5>Have specific feedback? <a href='#{repo}/issues/new'>Tell us here!</a></h5>"
+    header = "<header class='fis-header' style='visibility: hidden;'>#{github_repo_link}#{github_issue_link}</header>"
+    footer = "<footer class='fis-footer' style='visibility: hidden;'><div class='fis-feedback'><h5>How do you feel about this lesson?</h5>#{thumbs_up_link}#{thumbs_down_link}</div>#{feedback_link}</footer>"
+    header + readme + footer
   end
 
 end

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

@@ -1,18 +1,18 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def initialize(filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     name = name.split(/[- _]/).map(&:capitalize).join(' ')
     readme = File.read("#{filepath}/README.md")
     if !readme
       puts 'README.md not found in current directory. Exiting...'
       abort
     end
-    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
+    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
   end
 
-  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
     if fis_links
       new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
     end

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.24"
+  VERSION = "0.0.25"
 end

metadata

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