github-to-canvas 0.0.50 → 0.0.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba8cddad977922a78eb9b92bfac62731ab851e927b906775783a1b18335be82
-  data.tar.gz: acbed2faf13bd447c49b1f4c92730bd02f7862e0ac5bf5fe20ae21bc946cea29
+  metadata.gz: 735438dfea3e2a7aebf8266ab9ad15959cb9a9355f1f1355f2ca421773355b2a
+  data.tar.gz: 27af813a14adfd81bc7591e99681d3da575d5245fb3d1bad6596c77a9159a5af
 SHA512:
-  metadata.gz: 88222800def52566c6d676435a25b144989be96af8fb66968ad5838a851403d063204162a48fc66e1ce57db5a9313a0ad080a40bc5487f775c709bc41ad5d19d
-  data.tar.gz: 925a2f22bd80be3003b3b3338114e270cd97997bfbd3f03f0b56b370b6bf95289fc7ef09fd890af2040eac0a0343b2a029abfd937a36e29af9d2ee7dd2bea80c
+  metadata.gz: 80675ba304508aa284fb025c13004e7dea0d9914b61473ac05ebb389246fa906449b08834b37801484bd8e3d222257bb82a36847d559a506125ea58a70bfa642
+  data.tar.gz: 9e4f51c226aebee9d762106639e5299a7ee6eb69b0307e77626bb0f8e1db23a37ed8b2eb69ee4ca4aafe35de07985c1a8979ff5e0fe07c9fa175f23397ef3c25

data/bin/github-to-canvas

@@ -84,6 +84,10 @@ OptionParser.new do |opts|
           "Adds additional Flatiron School HTML after markdown conversion") do |f|
             options[:fis] = true
           end
+  opts.on("--forkable",
+          "Used with --fis-links, adds fork button to HTML header injected into Canvas lesson") do |remote|
+            options[:forkable] = true
+          end
   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
@@ -109,6 +113,7 @@ OptionParser.new do |opts|
             options[:remote] = true
           end
   
+  
 end.parse!
 
 if options[:version]
@@ -130,6 +135,7 @@ end
 if !options[:type]
   if Dir.glob("**/*/").empty?
     options[:type] = "page"
+    options[:forkable] = false
   else
     options[:type] = "assignment"
   end
@@ -177,7 +183,8 @@ if options[:create_lesson]
                     save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
-                    only_update_content: !!options[:only_content])
+                    only_update_content: !!options[:only_content],
+                    forkable: !!options[:forkable])
 end
 
 if options[:align]
@@ -192,5 +199,6 @@ if options[:align]
                     save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
-                    only_update_content: !!options[:only_content])
+                    only_update_content: !!options[:only_content],
+                    forkable: !!options[:forkable])
 end

data/lib/github-to-canvas.rb

@@ -19,7 +19,8 @@ class GithubToCanvas
                 save_to_github:false, 
                 fis_links:false,
                 remove_header_and_footer:false,
-                only_update_content: false)
+                only_update_content: false,
+                forkable: false)
 
     if mode == 'version'
       puts VERSION
@@ -43,12 +44,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, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
+      CreateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, forkable)
     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(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
+      UpdateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id, forkable)
     end
   end
 

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

@@ -1,6 +1,6 @@
 class CreateCanvasLesson
 
-  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
+  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, forkable)
     # name = name.split(/[- _]/).map(&:capitalize).join(' ')
     begin
       markdown = File.read("#{filepath}/#{file_to_convert}")
@@ -8,14 +8,14 @@ class CreateCanvasLesson
       puts "#{file_to_convert} not found in current directory. Exiting..."
       abort
     end
-    create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
+    create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, forkable)
   end
 
-  def create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
+  def create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, forkable)
     GithubInterface.get_updated_repo(filepath, branch)
     new_html = RepositoryConverter.convert(filepath, markdown, branch, remove_header_and_footer)
     if fis_links
-      new_html = RepositoryConverter.add_fis_links(filepath, new_html)
+      new_html = RepositoryConverter.add_fis_links(filepath, new_html, forkable)
     end
     response = CanvasInterface.submit_to_canvas(course, type, name, new_html)
     

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

@@ -72,25 +72,28 @@ class RepositoryConverter
     redcarpet.render(readme)
   end
 
-  def self.add_fis_links(filepath, readme)
+  def self.add_fis_links(filepath, readme, forkable)
     repo_path = self.get_repo_url(filepath)
-    header = self.create_github_link_header(repo_path)
+    header = self.create_github_link_header(repo_path, forkable)
     header + readme
   end
 
-  def self.create_github_link_header(repo_path)
+  def self.create_github_link_header(repo_path, forkable)
     repo_name = repo_path.split('/')[-1]
 
-    # add link to fork (forking handled by separate Flatiron server, generation of link handled via custom Canvas JS theme file)
-    github_fork_link = "<a class='fis-fork-link' id='fork-link' data-repo='#{repo_name}' href='#' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
-
     # add link to associated repository
     # github_repo_link = "<a class='fis-git-link' href='#{repo_path}' target='_blank' rel='noopener'><img id='repo-img' title='Open GitHub Repo' alt='GitHub Repo' /></a>"
     
     # add link to new issue form
     github_issue_link = "<a class='fis-git-link' href='#{repo_path}/issues/new' target='_blank' rel='noopener'><img id='issue-img' title='Create New Issue' alt='Create New Issue' /></a>"
     
-    "<header class='fis-header' style='visibility: hidden;'>#{github_fork_link}#{github_issue_link}</header>"
+    # add link to fork (forking handled by separate Flatiron server, generation of link handled via custom Canvas JS theme file)
+    if (forkable)
+      github_fork_link = "<a class='fis-fork-link' id='fork-link' data-repo='#{repo_name}' href='#' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
+      "<header class='fis-header' style='visibility: hidden;'>#{github_fork_link}#{github_issue_link}</header>"
+    else
+      "<header class='fis-header' style='visibility: hidden;'>#{github_issue_link}</header>"
+    end
   end
 
 end

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

@@ -1,6 +1,6 @@
 class UpdateCanvasLesson
 
-  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
+  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id, forkable)
     # name = name.split(/[- _]/).map(&:capitalize).join(' ')
     begin
       markdown = File.read("#{filepath}/#{file_to_convert}")
@@ -8,10 +8,10 @@ class UpdateCanvasLesson
       puts "#{file_to_convert} not found in current directory. Exiting..."
       abort
     end
-    update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
+    update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id, forkable)
   end
 
-  def update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
+  def update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id, forkable)
     # Pulls any updates that exist on GitHub
     GithubInterface.get_updated_repo(filepath, branch)
     
@@ -21,7 +21,7 @@ class UpdateCanvasLesson
     
     # adds Flatiron School specific header and footer
     if fis_links
-      new_html = RepositoryConverter.add_fis_links(filepath, new_html) 
+      new_html = RepositoryConverter.add_fis_links(filepath, new_html, forkable) 
     end
 
     # Read the local .canvas file if --id <ID> is not used. Otherwise, use provided ID (--course <COURSE> also required)

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.50"
+  VERSION = "0.0.55"
 end

metadata

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