jekyll-github-pages-gem 1.0.1 → 1.1.0

data/lib/services/kramdown_service.rb

@@ -41,7 +41,7 @@ end
 
 module Services
   ##
-  # This class contains all operations with interacting with the kramdown engine
+  # This class contains operations related to the kramdown engine
   class KramdownService
     DEFAULT_HERO = 'https://source.unsplash.com/collection/145103/'
     ##
@@ -91,75 +91,8 @@ module Services
       result.compact
     end
 
-    ##
-    # This method takes parameters for a given post and formats them
-    # as a valid jekyll post for a Jekyll website
-    #
-    # Params:
-    # +text+:: the markdown contents of the post
-    # +author+:: the author of the post
-    # +title+:: the title of the post
-    # +tags+:: tags specific to the post
-    # +overlay+:: the overlay color of the post
-    # +hero+:: a link to an optional background image for a post
-    def create_jekyll_post_text(text, author, title, tags, overlay, hero)
-      header_converted_text = fix_header_syntax(text)
-      header_converted_text = add_line_break_to_markdown_if_necessary(header_converted_text)
-
-      parsed_tags = parse_tags(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.empty?
-      result += %(hero: #{hero_to_use}
-overlay: #{overlay.downcase}
-published: true
----
-#{lead_break_section}
-#{header_converted_text})
-
-      result
-    end
-
     private
 
-    def parse_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 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 get_document_descendants(current_element, result)
       current_element.children.each do |element|
         result << element
@@ -170,17 +103,5 @@ published: true
     def get_filename_for_image_tag(image_el)
       File.basename(image_el.attr['src'])
     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/services/page_service.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative '../factories/page_factory'
+
+module Services
+  ##
+  # This class contains all operations related to pages on a Jekyll website
+  class PageService < BaseEditingService
+    def initialize(repo_name, access_token)
+      super(repo_name, access_token)
+      @page_factory = Factories::PageFactory.new
+    end
+
+    ##
+    # Returns a given page from a Jekyll website from the default branch unless a pull request body
+    # is specified. In that case then it will return the page from the source branch of the first open
+    # pull request matching the given body
+    #
+    # Params:
+    # +file_path+:: the path to the file in a GitHub repository
+    # +pr_body+:: an optional parameter indicating the pull request body of any updates to a given page, defaults to nil
+    def get_markdown_page(file_path, pr_body = nil)
+      if pr_body
+        open_prs = @github_service.get_open_pull_requests_with_body(pr_body)
+        unless open_prs.empty?
+          pr_files = @github_service.get_pr_files(open_prs[0][:number])
+          markdown_file = pr_files.find { |file| file[:filename].end_with?('.md') }
+          if markdown_file
+            ref = @github_service.get_ref_from_contents_url(markdown_file[:contents_url])
+            text_contents = @github_service.get_text_contents_from_file(file_path, ref)
+            return @page_factory.create_page(text_contents, ref, open_prs[0][:html_url])
+          end
+        end
+      end
+
+      text_contents = @github_service.get_text_contents_from_file(file_path)
+      @page_factory.create_page(text_contents, nil, nil)
+    end
+
+    ##
+    # Saves a given page update by updating the page contents and creating a pull request into master
+    # if a ref is not given. Otherwise if a ref is supplied it will update the branch matching the given ref without creating a pull request.
+    #
+    # Params:
+    # +file_path+:: the path to the file in a GitHub repository
+    # +page_title+:: the title of the page
+    # +ref+::an optional branch indicating the page should be updated on a branch that's not the default branch, defaults to nil
+    # +pr_body+::an optional pull request body when updating the page on the default branch, defaults to an empty string
+    # +reviewers+::an optional array of reviewers for opening a pull request when updating the page on the default branch, defaults to no reviewers
+    def save_page_update(file_path, page_title, file_contents, ref = nil, pr_body = '', reviewers = [])
+      if ref
+        ref_name = @github_service.get_ref_name_by_sha(ref)
+        sha_base_tree = @github_service.get_base_tree_for_branch(ref)
+
+        new_tree_sha = create_new_tree(file_contents, page_title, file_path, sha_base_tree)
+        @github_service.commit_and_push_to_repo("Edited page #{page_title}", new_tree_sha, ref, ref_name)
+        nil
+      else
+        branch_name = "editPage#{page_title.gsub(/\s+/, '')}"
+        ref_name = "heads/#{branch_name}"
+
+        master_head_sha = @github_service.get_master_head_sha
+        sha_base_tree = @github_service.get_base_tree_for_branch(master_head_sha)
+
+        @github_service.create_ref_if_necessary(ref_name, master_head_sha)
+        new_tree_sha = create_new_tree(file_contents, page_title, file_path, sha_base_tree)
+
+        ref_sha = @github_service.commit_and_push_to_repo("Edited page #{page_title}", new_tree_sha, master_head_sha, ref_name)
+        pull_request_url = @github_service.create_pull_request(branch_name, 'master', "Edited page #{page_title}",
+                                                               pr_body,
+                                                               reviewers)
+        create_save_page_update_result(ref_sha, pull_request_url)
+      end
+    end
+
+    private
+
+    def create_save_page_update_result(ref_sha, pull_request_url)
+      result = Page.new
+      result.github_ref = ref_sha
+      result.pull_request_url = pull_request_url
+      result
+    end
+  end
+end

data/lib/services/post_service.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative '../factories/post_factory'
+
+module Services
+  ##
+  # This class contains all operations related to posts on a Jekyll website
+  class PostService < BaseEditingService
+    def initialize(repo_name, access_token)
+      super(repo_name, access_token)
+      @post_factory = Factories::PostFactory.new
+      @kramdown_service = Services::KramdownService.new
+    end
+
+    ##
+    # This method fetches all the markdown contents of all the posts on a Jekyll website
+    # that have been written and returns a list of models representing a Post.
+    def get_all_posts
+      result = []
+      api_posts = @github_service.get_contents_from_path('_posts')
+      api_posts.each do |api_post|
+        post_text_contents = @github_service.get_text_contents_from_file(api_post.path)
+        post_model = @post_factory.create_post(post_text_contents, api_post.path, nil)
+        image_paths = @kramdown_service.get_all_image_paths(post_model.contents)
+
+        images = []
+        image_paths.each do |image_path|
+          image_content = @github_service.get_contents_from_path(image_path)
+          images << create_post_image(image_path, image_content.content)
+        end
+
+        post_model.images = images
+
+        result << post_model
+      end
+      result
+    end
+
+    ##
+    # This method fetches all of the posts that have been written but have not been merged into master yet
+    #
+    # Params
+    # +pr_body+::the pr body for the posts in PR
+    def get_all_posts_in_pr(pr_body)
+      result = []
+      pull_requests = @github_service.get_open_pull_requests_with_body(pr_body)
+      pull_requests.each do |pull_request|
+        pull_request_files = @github_service.get_pr_files(pull_request[:number])
+
+        post = nil
+        images = []
+        pull_request_files.each do |pull_request_file|
+          ref = @github_service.get_ref_from_contents_url(pull_request_file[:contents_url])
+          pr_file_contents = @github_service.get_contents_from_path(pull_request_file[:filename], ref)
+
+          if pull_request_file[:filename].end_with?('.md')
+            post_text_contents = @github_service.get_text_content_from_file(pr_file_contents.path, ref)
+            post = @post_factory.create_post(post_text_contents, pr_file_contents.path, ref)
+            result << post
+          else
+            images << create_post_image(pr_file_contents.path, pr_file_contents.content)
+          end
+        end
+
+        post.images = images
+      end
+      result
+    end
+
+    ##
+    # This method fetches a single post from a Jekyll website given a post title
+    # and returns a Post model
+    #
+    # Params:
+    # +title+:: A title of a Jekyll website post
+    # +ref+::a sha for a ref indicating the head of a branch a post is pushed to on the GitHub server
+    def get_post_by_title(title, ref)
+      result = nil
+      result = get_all_posts_in_pr.find { |x| x.title == title } if ref
+      result = get_all_posts.find { |x| x.title == title } unless ref
+      result&.images&.each { |x| PostImageManager.instance.add_downloaded_image(x) }
+      result
+    end
+
+    ##
+    # This method submits a new post to GitHub by checking out a new branch for the post,
+    # if the branch already doesn't exist. Commiting and pushing the markdown and any photos
+    # attached to the post to the branch. And then finally opening a pull request into master
+    # for the new post.
+    #
+    # Params
+    # +oauth_token+::a user's oauth access token
+    # +post_markdown+:: the markdown contents of a post
+    # +pull_request_body+::an optional pull request body for the post, it will be blank if nothing is provided
+    # +reviewers+:: an optional list of reviewers for the post PR
+    def create_post(post_markdown, post_title, pull_request_body = '', reviewers = [])
+      # This ref_name variable represents the branch name
+      # for creating a post. At the end we strip out all of the whitespace in
+      # the post_title to create a valid branch name
+      branch_name = "createPost#{post_title.gsub(/\s+/, '')}"
+      ref_name = "heads/#{branch_name}"
+
+      master_head_sha = @github_service.get_master_head_sha
+      sha_base_tree = @github_service.get_base_tree_for_branch(master_head_sha)
+
+      @github_service.create_ref_if_necessary(ref_name, master_head_sha)
+
+      new_post_path = create_new_filepath_for_post(post_title)
+      new_tree_sha = create_new_tree(post_markdown, post_title, new_post_path, sha_base_tree)
+
+      @github_service.commit_and_push_to_repo("Created post #{post_title}",
+                                              new_tree_sha, master_head_sha, ref_name)
+      @github_service.create_pull_request(branch_name, 'master', "Created Post #{post_title}",
+                                          pull_request_body,
+                                          reviewers)
+
+      PostImageManager.instance.clear
+    end
+
+    ##
+    # This method submits changes to an existing post to GitHub by checking out a new branch for the post,
+    # if the branch already doesn't exist. Commiting and pushing the markdown changes and any added photos
+    # for the existing post to the branch. And the finally opening a pull request into master for the new post.
+    #
+    # Params
+    # +post_markdown+::the modified markdown to submit
+    # +post_title+::the title for the existing post
+    # +existing_post_file_path+::the file path to the existing post on GitHub
+    # +pull_request_body+::an optional pull request body for the post, it will be blank if nothing is provided
+    # +reviewers+:: an optional list of reviewers for the post PR
+    def edit_post(post_markdown, post_title, existing_post_file_path, pull_request_body = '', reviewers = [])
+      # This ref_name variable represents the branch name
+      # for editing a post. At the end we strip out all of the whitespace in
+      # the post_title to create a valid branch name
+      branch_name = "editPost#{post_title.gsub(/\s+/, '')}"
+      ref_name = "heads/#{branch_name}"
+
+      master_head_sha = @github_service.get_master_head_sha
+      sha_base_tree = @github_service.get_base_tree_for_branch(master_head_sha)
+
+      @github_service.create_ref_if_necessary(ref_name, master_head_sha)
+      new_tree_sha = create_new_tree(post_markdown, post_title, existing_post_file_path, sha_base_tree)
+
+      @github_service.commit_and_push_to_repo("Edited post #{post_title}", new_tree_sha, master_head_sha, ref_name)
+      @github_service.create_pull_request(branch_name, 'master', "Edited Post #{post_title}",
+                                          pull_request_body,
+                                          reviewers)
+
+      PostImageManager.instance.clear
+    end
+
+    ##
+    # This method submits changes to a post that is already in PR, commiting and pushing the markdown changes
+    # and any added photos to the branch. Since the post is in PR these changes will be a PR updated to the given branch
+    #
+    # Params:
+    # +post_markdown+::the modified markdown to submit
+    # +post_title+::the title for the existing post
+    # +existing_post_file_path+::the file path to the existing post on GitHub
+    # +ref+::the ref to update
+    def edit_post_in_pr(post_markdown, post_title, existing_post_file_path, ref)
+      ref_name = @github_service.get_ref_name_by_sha(ref)
+      sha_base_tree = @github_service.get_base_tree_for_branch(ref)
+
+      new_tree_sha = create_new_tree(post_markdown, post_title, existing_post_file_path, sha_base_tree)
+      @github_service.commit_and_push_to_repo("Edited post #{post_title}", new_tree_sha, ref, ref_name)
+
+      PostImageManager.instance.clear
+    end
+
+    private
+
+    def create_new_filepath_for_post(post_title)
+      "_posts/#{DateTime.now.strftime('%Y-%m-%d')}-#{post_title.gsub(/\s+/, '')}.md"
+    end
+
+    def create_post_image(filename, contents)
+      result = PostImage.new
+      result.filename = filename
+      result.contents = contents
+      result
+    end
+  end
+end

metadata

@@ -1,15 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-pages-gem
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - MSOE SSE Web Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
 description: 
 email: 
 executables: []
@@ -21,16 +69,18 @@ files:
 - README.md
 - Rakefile
 - jekyll_github_pages.gemspec
+- lib/factories/base_factory.rb
+- lib/factories/page_factory.rb
 - lib/factories/post_factory.rb
 - lib/jekyll_github_pages.rb
+- lib/models/page.rb
 - lib/models/post.rb
 - lib/models/post_image_manager.rb
+- lib/services/base_editing_service.rb
 - lib/services/github_service.rb
 - lib/services/kramdown_service.rb
-- lib/services/post_services/base_post_service.rb
-- lib/services/post_services/post_creation_service.rb
-- lib/services/post_services/post_editing_service.rb
-- lib/services/post_services/post_pull_request_editing_service.rb
+- lib/services/page_service.rb
+- lib/services/post_service.rb
 - lib/uploaders/post_image_uploader.rb
 homepage: 
 licenses:
@@ -44,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="