Improve syncing (#7902)

* Improve syncing

* Fix test

Author: iHiD

app/commands/user/github_solution_syncer/files_for_iteration.rb

@@ -18,7 +18,7 @@ def call
     end
 
     private
-    delegate :user, :track, :exercise, to: :iteration
+    delegate :user, :solution, :track, :exercise, to: :iteration
 
     def files
       exercise_files.merge(submission_files)
@@ -27,7 +27,7 @@ def files
     def exercise_files
       return {} unless syncer.sync_exercise_files?
 
-      iteration.solution.git_exercise.cli_files
+      solution.git_exercise.cli_files(solution)
     end
 
     def submission_files

app/commands/user/github_solution_syncer/sync_everything.rb

@@ -21,7 +21,7 @@ def sync_everything(branch_name, token = nil)
       repo = LocalGitRepo.new(syncer, syncer.main_branch_name, branch_name, token:)
 
       user_tracks = user.user_tracks.includes(solutions: [:track, {
-        exercise: [:track], iterations: [{ submission: :files }, :exercise, :track]
+        exercise: [:track], iterations: [{ submission: :files }, :solution, :exercise, :track]
       }])
 
       num_commits = 0

app/commands/user/github_solution_syncer/sync_track.rb

@@ -24,7 +24,7 @@ def sync_solutions(branch_name, token = nil)
       repo = LocalGitRepo.new(syncer, syncer.main_branch_name, branch_name, token:)
 
       solutions = user_track.solutions.
-        includes(:track, exercise: [:track], iterations: [{ submission: :files }, :exercise, :track])
+        includes(:track, exercise: [:track], iterations: [{ submission: :files }, :solution, :exercise, :track])
 
       num_commits = 0
       repo.update do

app/models/git/exercise.rb

@@ -205,10 +205,17 @@ def important_files
       end
     end
 
-    memoize
-    def cli_files
+    def cli_files(solution)
       cli_filepaths.each.with_object({}) do |filepath, hash|
-        hash[filepath] = read_file_blob(filepath)
+        if filepath == Git::Exercise::SPECIAL_FILEPATHS[:readme]
+          hash[filepath] = Solution::GenerateReadmeFile.(solution)
+        elsif filepath == Git::Exercise::SPECIAL_FILEPATHS[:help]
+          hash[filepath] = Solution::GenerateHelpFile.(solution)
+        elsif filepath == Git::Exercise::SPECIAL_FILEPATHS[:hints]
+          hash[filepath] = Solution::GenerateHintsFile.(solution)
+        else
+          hash[filepath] = read_file_blob(filepath)
+        end
       end
     end
 

test/commands/user/github_solution_syncer/files_for_iteration_test.rb

@@ -52,12 +52,90 @@ class FilesForIterationTest < ActiveSupport::TestCase
       )
 
       expected = [
+        { path: "solutions/ruby/bob/3/README.md", mode: "100644", type: "blob", content: readme },
+        { path: "solutions/ruby/bob/3/HELP.md", mode: "100644", type: "blob", content: help },
+        { path: "solutions/ruby/bob/3/HINTS.md", mode: "100644", type: "blob", content: hints },
         { path: "solutions/ruby/bob/3/bob.rb", mode: "100644", type: "blob", content: "puts 'hi'" },
         { path: "solutions/ruby/bob/3/bob_test.rb", mode: "100644", type: "blob", content: "test content\n" },
         { path: "solutions/ruby/bob/3/subdir/more_bob.rb", mode: "100644", type: "blob", content: "Some subdir content\n" }
       ]
       actual = FilesForIteration.(syncer, iteration)
       assert_equal expected, actual
     end
+
+    # rubocop:disable Naming/HeredocDelimiterNaming
+    def readme = <<~EOS.strip
+      # Bob
+
+      Welcome to Bob on Exercism's Ruby Track.
+      If you need help running the tests or submitting your code, check out `HELP.md`.
+      If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)
+
+      ## Introduction
+
+      Introduction for bob
+
+      Extra introduction for bob
+
+      ## Instructions
+
+      Instructions for bob
+
+      Extra instructions for bob
+
+      ## Source
+
+      ### Created by
+
+      - @erikschierboom
+
+      ### Contributed to by
+
+      - @ihid
+
+      ### Based on
+
+      Inspired by the 'Deaf Grandma' exercise in Chris Pine's Learn to Program tutorial. - http://pine.fm/LearnToProgram/?Chapter=06
+    EOS
+
+    def help = <<~EOS.strip
+      # Help
+
+      ## Running the tests
+
+      Run the tests using `ruby test`.
+
+      ## Submitting your solution
+
+      You can submit your solution using the `exercism submit bob.rb` command.
+      This command will upload your solution to the Exercism website and print the solution page's URL.
+
+      It's possible to submit an incomplete solution which allows you to:
+
+      - See how others have completed the exercise
+      - Request help from a mentor
+
+      ## Need to get help?
+
+      If you'd like help solving the exercise, check the following pages:
+
+      - The [Ruby track's documentation](https://exercism.org/docs/tracks/ruby)
+      - The [Ruby track's programming category on the forum](https://forum.exercism.org/c/programming/ruby)
+      - [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
+      - The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
+
+      Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
+
+      Stuck? Try the Ruby gitter channel.
+    EOS
+
+    def hints = <<~EOS.strip
+      # Hints
+
+      ## General
+
+      - There are many useful string methods built-in
+    EOS
   end
+  # rubocop:enable Naming/HeredocDelimiterNaming
 end