jekyll-github-pages-gem 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e96acc9371c59ba0163040fc42595a54ec2dc7602b9d128313cb1b05d2c4106
-  data.tar.gz: 5310d22171f0150137e9abdbac7c0d3147f47f27f84f1c3c240c664e0033baef
+  metadata.gz: 9482ae3d917e1f9d824bf20f244ba5408a794292c212a356b4fcb58776fb03f9
+  data.tar.gz: 83b6a7c8cb8ced7f48a85b58b14444f8192f32d6914a7738ab69220767cbb14d
 SHA512:
-  metadata.gz: 07c6be16e280cd410f7a0f5c25e16ea7fdbd69611a2a7fb61ec19846428b4ca2fe53a48eb0aec9504b8532b17bb6de815bbde38fc0ce82c6a71e83f0e47881c3
-  data.tar.gz: d9cdef19e6748af33fcd01c8dd1a30fb6a032b38839b924d168b26789720e63aeb032002e7cdbc699fb55f2bf58b45ea13fb6ca7a0c395e4c368a245da4743e8
+  metadata.gz: 65367b9e37826aed8409952ee2bd4f8d68989c4e1275f37d735f3cf22891e3df8055e0d52a9b74d7d9ebbaed2b272dc0f3607b23d99a04520f22e60c1ecf8764
+  data.tar.gz: c4463b7d5f5d079da7c96ddd425726fb5ba35e0d9f86744579b122b2affdb6659984c2c6a56c057b432f1dc695dafa83e2b144018bf4b97ec8b5e307b17768bd

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'kramdown'
+gem 'kramdown', '~> 2.3.0'
 
 gem 'octokit', '~> 4.18'
 
@@ -16,6 +16,8 @@ gem 'faraday', '~> 0.17.1'
 
 gem 'rake'
 
+gem 'rdoc'
+
 group :test do
   gem 'minitest'
   gem 'mocha'

data/Gemfile.lock

@@ -1,22 +1,25 @@
 PATH
   remote: .
   specs:
-    jekyll-github-pages-gem (1.0.0)
+    jekyll-github-pages-gem (1.1.2)
+      carrierwave (>= 2.0.0.rc, < 3.0)
+      kramdown (~> 2.3.0)
+      octokit (~> 4.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.1)
     carrierwave (2.1.0)
       activemodel (>= 5.0.0)
       activesupport (>= 5.0.0)
@@ -24,43 +27,47 @@ GEM
       image_processing (~> 1.1)
       mimemagic (>= 0.3.0)
       mini_mime (>= 0.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     docile (1.3.2)
     faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
-    ffi (1.12.2-x64-mingw32)
-    i18n (1.8.2)
+    ffi (1.13.1-x64-mingw32)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    image_processing (1.10.3)
+    image_processing (1.11.0)
       mini_magick (>= 4.9.5, < 5)
       ruby-vips (>= 2.0.17, < 3)
-    jaro_winkler (1.5.4)
-    kramdown (2.1.0)
-    mimemagic (0.3.4)
+    kramdown (2.3.0)
+      rexml
+    mimemagic (0.3.5)
     mini_magick (4.10.1)
     mini_mime (1.0.2)
-    minitest (5.14.0)
+    minitest (5.14.1)
     mocha (1.11.2)
     multipart-post (2.1.1)
     octokit (4.18.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.19.1)
-    parser (2.7.1.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.4)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (13.0.1)
+    rdoc (6.2.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     ruby-vips (2.0.17)
       ffi (~> 1.9)
@@ -75,21 +82,21 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
-  ruby
   x64-mingw32
 
 DEPENDENCIES
   carrierwave (>= 2.0.0.rc, < 3.0)
   faraday (~> 0.17.1)
   jekyll-github-pages-gem!
-  kramdown
+  kramdown (~> 2.3.0)
   minitest
   mocha
   octokit (~> 4.18)
   rake
+  rdoc
   rubocop (~> 0.71)
   simplecov
 

data/README.md

@@ -9,8 +9,17 @@
 Our git flow process is typical--we have a master branch that gets released to the public, and feature branches for individual tasks. We don't have a development branch yet since this isn't used in production yet.
 If you have questions on how to contribute, please contact admin@msoe-sse.com or msoe.sg.hosting@gmail.com and we will get back to you at our earliest convenience.
 
+## Generating HTML Documentation
+To generate HTML documentation for the Gem run the command `rake rdoc` and the HTML will then be available in the `html/` directory in the project.
+
 ## Continuous Integration
 There are checks that will be performed whenever Pull Requests are opened.  To save time on the build server, please run the tests locally to check for errors that will occur in the CI builds.
 
-1. To run [Rubocop](https://github.com/ashmaroli/rubocop-jekyll), run the command `bundle exec rubocop`
+1. To run [Rubocop](https://github.com/ashmaroli/rubocop-jekyll), run the command `bundle exec rubocop`. Note the command `bundle exec rubocop -a` will attempt to automatically fix any offenses found by rubocop but some still need to be resolved manually.
 2. To run all unit tests, run the command `rake`
+
+## Releasing the Gem
+When the gem is released it's deployed to a https://rubygems.org project. The SSE webmaster controls the rubygems project and will handle releasing the gem to rubygems. The following commands below are used to release the gem if you have permissions to the rubygems project.
+
+1. `gem build jekyll_github_pages`
+2. `gem push jekyll-github-pages-gem-<VERSION>.gem`

data/Rakefile

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 require 'rake/testtask'
+require 'rdoc/task'
 
 task default: 'test'
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['tests/**/*_test.rb']
 end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/jekyll_github_pages.gemspec

@@ -2,10 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = 'jekyll-github-pages-gem'
-  s.version = '1.0.0'
+  s.version = '1.1.3'
   s.summary = 'A gem that uses the github API to make edits with a jekyll blog'
   s.files = Dir['*', 'lib/**/*']
   s.require_paths = ['lib']
   s.licenses = ['MIT']
   s.authors = ['MSOE SSE Web Team']
+  s.add_runtime_dependency('carrierwave', '>= 2.0.0.rc', '< 3.0')
+  s.add_runtime_dependency('kramdown', '~> 2.3.0')
+  s.add_runtime_dependency('octokit', '~> 4.18')
+  s.required_ruby_version = '>= 2.5.1'
 end

data/lib/factories/base_factory.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+
+module Factories
+  ##
+  # The base class for all jekyll factories
+  class BaseFactory
+    protected
+
+    def fix_header_syntax(text)
+      document = Kramdown::Document.new(text)
+      header_elements = document.root.children.select { |x| x.type == :header }
+      lines = text.split("\n")
+      lines = lines.map do |line|
+        if header_elements.any? { |x| line.include? x.options[:raw_text] }
+          # This regex matches the line into 2 groups with the first group being the repeating #
+          # characters and the beginning of the string and the second group being the rest of the string
+          line_match = line.match(/(#*)(.*)/)
+          line = "#{line_match.captures.first} #{line_match.captures.last.strip}"
+        else
+          line.delete("\r\n")
+        end
+      end
+      lines.join("\r\n")
+    end
+
+    def add_line_break_to_markdown_if_necessary(markdown)
+      lines = markdown.split("\n")
+      # The regular expression in the if statement looks for a markdown reference to a link like
+      # [logo]: https://ieeextreme.org/wp-content/uploads/2019/05/Xtreme_colour-e1557478323964.png
+      # If a post starts with that reference in jekyll followed by an image using that reference
+      # the line below will be interperted as a paragraph tag instead of an image tag. To fix that
+      # we add a line break to the start of the markdown.
+      return "\r\n#{markdown}" if lines.first&.match?(/\[(.*)\]: (.*)/)
+
+      markdown
+    end
+  end
+end

data/lib/factories/page_factory.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative '../models/page'
+
+module Factories
+  ##
+  # This class is a factory for parsing page text and creating a correseponding page model
+  class PageFactory < BaseFactory
+    ##
+    # This method parses markdown in a page a returns a page model
+    #
+    # Params:
+    # +page_contents+::markdown in a given page
+    # +github_ref+::a sha for a ref indicating the head of a branch a page is pushed to on the GitHub server
+    # +pull_request_url+::a url to the pull request with the branch the pull request is pushed to on the GitHub server
+    def create_page(page_contents, github_ref, pull_request_url)
+      create_page_model(page_contents, github_ref, pull_request_url) if !page_contents.nil? && page_contents.is_a?(String)
+    end
+
+    ##
+    # This method takes parameters for a given page and formats them
+    # as a valid page for a Jekyll website
+    #
+    # Params:
+    # +text+:: the required markdown contents of the post
+    # +title+:: the required title of the post
+    # +permalink+:: the link to the page on a Jekyll website (e.g /about)
+    def create_jekyll_page_text(text, title, permalink)
+      header_converted_text = fix_header_syntax(text)
+      header_converted_text = add_line_break_to_markdown_if_necessary(header_converted_text)
+
+      %(---
+layout: page
+title: #{title}
+permalink: #{permalink}
+---
+#{header_converted_text})
+    end
+
+    private
+
+    def create_page_model(page_contents, github_ref, pull_request_url)
+      result = Page.new
+
+      result.github_ref = github_ref
+      result.pull_request_url = pull_request_url
+
+      # What this regular expression does is it matches three groups
+      # The first group represents the header of the page which appears
+      # between the two --- lines. The second group is for helping capture newline characters
+      # correctly and the third group is the actual page contents
+      match_obj = page_contents.match(/---(.*)---(\r\n|\r|\n)(.*)/m)
+      header = match_obj.captures[0]
+      parse_page_header(header, result)
+      result.contents = match_obj.captures[2]
+
+      result
+    end
+
+    def parse_page_header(header, page_model)
+      # The following regular expressions in this method look for specific properities
+      # located in the post header.
+      page_model.title = header.match(/title:\s*(.*)(\r\n|\r|\n)/).captures.first
+      page_model.permalink = header.match(/permalink:\s*(.*)(\r\n|\r|\n)/).captures.first
+    end
+  end
+end

data/lib/factories/post_factory.rb

@@ -5,7 +5,7 @@ require_relative '../models/post'
 module Factories
   ##
   # This class is a factory for parsing post text and creating a correseponding post model
-  class PostFactory
+  class PostFactory < BaseFactory
     LEAD = '{: .lead}'
     BREAK = '<!–-break-–>'
 
@@ -23,6 +23,50 @@ module Factories
       create_post_model(post_contents, file_path, ref) if !post_contents.nil? && post_contents.is_a?(String)
     end
 
+    ##
+    # This method takes parameters for a given post and formats them
+    # as a valid post for a Jekyll website
+    #
+    # Params:
+    # +text+:: the required markdown contents of the post
+    # +author+:: the required author of the post
+    # +title+:: the required title of the post
+    # +tags+:: optional tags specific to the post, defaults to nil
+    # +overlay+:: the optional overlay color of the post, defaults to nil
+    # +hero+:: a link to an optional background image for a post, defaults to nil
+    # +set_published_property+::an optional flag to set the published: true property for a post, defaults to false
+    # +append_lead_break_section+::an optional flag indicating whether to append to lead break section to a post, default to false
+    def create_jekyll_post_text(text, author, title, tags = nil, overlay = nil,
+                                hero = nil, set_published_property = false, append_lead_break_section = false)
+      header_converted_text = fix_header_syntax(text)
+      header_converted_text = add_line_break_to_markdown_if_necessary(header_converted_text)
+
+      parsed_tags = nil
+      parsed_tags = format_tags(tags) if tags
+
+      tag_section = %(tags:
+#{parsed_tags})
+
+      lead_break_section = "{: .lead}\r\n<!–-break-–>"
+
+      hero_to_use = hero
+      hero_to_use = DEFAULT_HERO if hero_to_use&.empty?
+      result = %(---
+layout: post
+title: #{title}
+author: #{author}\r\n)
+
+      result += "#{tag_section}\r\n" unless !parsed_tags || parsed_tags.empty?
+      result += "hero: #{hero_to_use}\n" if hero_to_use
+      result += "overlay: #{overlay}\n" if overlay
+      result += "published: true\n" if set_published_property
+      result += "---\n"
+      result += "#{lead_break_section}\n" if append_lead_break_section
+      result += header_converted_text
+
+      result
+    end
+
     private
 
     def parse_tags(header)
@@ -34,6 +78,16 @@ module Factories
       result.join(', ')
     end
 
+    def format_tags(tags)
+      tag_array = tags.split(',')
+      result = ''
+      tag_array.each do |tag|
+        result += "  - #{tag.strip}"
+        result += "\r\n" if tag != tag_array.last
+      end
+      result
+    end
+
     def create_post_model(post_contents, file_path, ref)
       result = Post.new
 

data/lib/jekyll_github_pages.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 # Third Party Dependencies
-require 'carrierwave'
+# require 'carrierwave'
 
 # Source Files
+require 'factories/base_factory'
 require 'factories/post_factory'
-require 'services/post_services/base_post_service'
-require 'services/post_services/post_creation_service'
-require 'services/post_services/post_editing_service'
-require 'services/post_services/post_pull_request_editing_service'
-require 'services/github_service'
+require 'factories/page_factory'
 
+require 'services/base_editing_service'
+require 'services/github_service'
 require 'services/kramdown_service'
+require 'services/page_service'
+require 'services/post_service'
 
+require 'models/page'
 require 'models/post'
 require 'models/post_image_manager'
 
-require 'uploaders/post_image_uploader'
+# require 'uploaders/post_image_uploader'

data/lib/models/page.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+##
+# An object repsenting a page on a Jekyll website
+class Page
+  attr_accessor :title
+  attr_accessor :permalink
+  attr_accessor :contents
+  # The GitHub ref the page's markdown is at. This is used to indicate
+  # whether a page is in PR or not
+  attr_accessor :github_ref
+  attr_accessor :pull_request_url
+end

data/lib/models/post_image_manager.rb

@@ -2,6 +2,8 @@
 
 require 'singleton'
 
+# TODO: This will eventually go away once carrierwave is removed
+
 ##
 # A singleton class for managing all image attachments for a post
 class PostImageManager
@@ -26,10 +28,10 @@ class PostImageManager
   # Params:
   # +file+:: A ActionDispatch::Http::UploadedFile object containing the file to be used in a post
   def add_file(file)
-    uploader_to_add = PostImageUploader.new
-    uploader_to_add.cache!(file)
-    @uploaders.delete_if { |x| x.filename == file.original_filename }
-    @uploaders << uploader_to_add
+    # uploader_to_add = PostImageUploader.new
+    # uploader_to_add.cache!(file)
+    # @uploaders.delete_if { |x| x.filename == file.original_filename }
+    # @uploaders << uploader_to_add
   end
 
   ##
@@ -38,21 +40,21 @@ class PostImageManager
   # Params:
   # +downloaded_image+:: A PostImage object representing the downloaded image
   def add_downloaded_image(downloaded_image)
-    @downloaded_images << downloaded_image
+    # @downloaded_images << downloaded_image
   end
 
   ##
   # Clears the manager of all currently exisiting image uploaders and delete's their cache directories.
   # Also clears the manager of all of the downloaded images
-  def clear(_root_dir)
-    @uploaders.each do |uploader|
-      full_preview_path = "#{@root_dir}/public/uploads/tmp/#{uploader.preview.cache_name}"
-      cache_dir = File.expand_path('..', full_preview_path)
-      uploader.remove!
-      Dir.delete(cache_dir)
-    end
-
-    @uploaders.clear
-    @downloaded_images.clear
+  def clear
+    # @uploaders.each do |uploader|
+    #   full_preview_path = "#{@root_dir}/public/uploads/tmp/#{uploader.preview.cache_name}"
+    #   cache_dir = File.expand_path('..', full_preview_path)
+    #   uploader.remove!
+    #   Dir.delete(cache_dir)
+    # end
+
+    # @uploaders.clear
+    # @downloaded_images.clear
   end
 end