Fix spec for projects:create_starter Rake task (#266)

The `spec/tasks/create_starter_spec.rb` was triggering a `NameError`
exception when run on its own (using `bundle exec rspec
spec/tasks/create_starter_spec.rb`) and when the whole test suite was
run in a certain order (e.g. `bundle exec rspec --seed 54367`). The main
goal of this PR is to fix that problem.

I've achieved that by extracting all the code out of the Rake task and
into a new `FilesystemProject.import_all!` method and testing that
directly rather than testing the Rake task which tends to cause class
loading problems.

As part of doing this, I've also removed the stubbing from the spec,
because I found it confusing and it turns out it doesn't take too long
to run import all the projects for real in the spec.

See individual commit notes for more details.

Author: floehopper

.rubocop_todo.yml

@@ -9,4 +9,4 @@
 # Offense count: 2
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/tasks/projects.rake'
+    - 'app/models/filesystem_project.rb'

Procfile

@@ -1,3 +1,3 @@
 web: bundle exec puma -C config/puma.rb
-release: bundle exec rails db:migrate && bundle exec rake projects:create_starter
+release: bundle exec rails db:migrate && bundle exec rake projects:create_all
 worker: bundle exec good_job start --max-threads=8

app/models/filesystem_project.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+class FilesystemProject
+  CODE_FORMATS = ['.py', '.csv', '.txt', '.html', '.css'].freeze
+  IMAGE_FORMATS = ['.png', '.jpg', '.jpeg', '.webp'].freeze
+  PROJECTS_ROOT = Rails.root.join('lib/tasks/project_components')
+
+  def self.import_all! # rubocop:disable Metrics/AbcSize
+    PROJECTS_ROOT.each_child do |dir|
+      proj_config = YAML.safe_load_file(dir.join('project_config.yml').to_s)
+      files = dir.children
+      code_files = files.filter { |file| CODE_FORMATS.include? File.extname(file) }
+      image_files = files.filter { |file| IMAGE_FORMATS.include? File.extname(file) }
+
+      components = []
+      code_files.each do |file|
+        components << component(file, dir)
+      end
+
+      images = []
+      image_files.each do |file|
+        images << image(file, dir)
+      end
+
+      project_importer = ProjectImporter.new(name: proj_config['NAME'], identifier: proj_config['IDENTIFIER'],
+                                             type: proj_config['TYPE'] || 'python',
+                                             locale: proj_config['LOCALE'] || 'en', components:, images:)
+      project_importer.import!
+    end
+  end
+
+  def self.component(file, dir)
+    name = File.basename(file, '.*')
+    extension = File.extname(file).delete('.')
+    code = File.read(dir.join(File.basename(file)).to_s)
+    default = (File.basename(file) == 'main.py')
+    component = { name:, extension:, content: code, default: }
+  end
+
+  def self.image(file, dir)
+    filename = File.basename(file)
+    io = File.open(dir.join(filename).to_s)
+    image = { filename:, io: }
+  end
+end

db/seeds.rb

@@ -7,8 +7,4 @@
 #
 #   movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }])
 #   Character.create(name: "Luke", movie: movies.first)
-words = File.readlines('words.txt').map { |w| w.delete!("\n") }
-
-words.each do |word|
-  Word.create(word: word)
-end
+PhraseIdentifier.seed!

lib/phrase_identifier.rb

@@ -4,6 +4,12 @@ class PhraseIdentifier
   class Error < RuntimeError
   end
 
+  def self.seed!
+    words = File.readlines('words.txt', chomp: true)
+    Word.delete_all
+    words.each { |word| Word.create!(word:) }
+  end
+
   def self.generate
     10.times do
       phrase = Word.order(Arel.sql('RANDOM()')).take(3).pluck(:word).join('-')

lib/tasks/README.md

@@ -9,7 +9,7 @@ Please note that in this document, to avoid confusion, `project` refers to an en
 ## Creating the project directory
 Each version of a Projects site 'project' such as a starter or finished example needs its own directory in `/project_components` as they will form separate `project`s in the database. Although the naming of these directories is inconsequential, at the moment they are roughly named in the form `{project_name}_starter` and `{project_name}_example` for the sake of consistency.
 
-Each directory for a `project` should contain copies of the `python` files and any `text`, `csv` and image files that the `project` should contain. Any content reused across multiple `project`s should be duplicated in the relevant directory for each `project`. 
+Each directory for a `project` should contain copies of the `python` files and any `text`, `csv` and image files that the `project` should contain. Any content reused across multiple `project`s should be duplicated in the relevant directory for each `project`.
 
 ### Populating `project_config.yml`
 Every directory representing a `project` must contain a `project_config.yml`. This should include the following information:
@@ -27,7 +27,7 @@ Every directory representing a `project` must contain a `project_config.yml`. Th
 An example `project_config.yml` with all of the above properties can be seen [here](https://github.com/RaspberryPiFoundation/editor-api/blob/main/lib/tasks/project_components/persuasive_data_presentation_iss_starter/project_config.yml).
 
 ## Getting the projects created in the database
-Please commit the required changes to a branch in the [`editor-api` repository](https://github.com/RaspberryPiFoundation/editor-ui/) and create a pull request to merge your branch into `main`. Once merged, we will run the task to create your `project`s in the database.
+Please commit the required changes to a branch in the [`editor-api` repository](https://github.com/RaspberryPiFoundation/editor-api/) and create a pull request to merge your branch into `main`. Once merged, we will run the task to create your `project`s in the database.
 
 ## Amending existing projects
 Existing `project`s can be ammended by updating the content in the directory corresponding to that `project`. Please create a pull request with the required changes as described above and we will ensure they are applied once the pull request has been merged.

lib/tasks/projects.rake

@@ -1,49 +1,8 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
-CODE_FORMATS = ['.py', '.csv', '.txt', '.html', '.css'].freeze
-IMAGE_FORMATS = ['.png', '.jpg', '.jpeg', '.webp'].freeze
-
 namespace :projects do
-  desc 'Import starter projects'
-  task create_starter: :environment do
-    Dir.each_child("#{File.dirname(__FILE__)}/project_components") do |dir|
-      proj_config = YAML.safe_load(File.read("#{File.dirname(__FILE__)}/project_components/#{dir}/project_config.yml"))
-      files = Dir.children("#{File.dirname(__FILE__)}/project_components/#{dir}")
-      code_files = files.filter { |file| CODE_FORMATS.include? File.extname(file) }
-      image_files = files.filter { |file| IMAGE_FORMATS.include? File.extname(file) }
-
-      components = []
-      code_files.each do |file|
-        components << component(file, dir)
-      end
-
-      images = []
-      image_files.each do |file|
-        images << image(file, dir)
-      end
-
-      project_importer = ProjectImporter.new(name: proj_config['NAME'], identifier: proj_config['IDENTIFIER'],
-                                             type: proj_config['TYPE'] ||= 'python',
-                                             locale: proj_config['LOCALE'] ||= 'en', components:, images:)
-      project_importer.import!
-    end
+  desc 'Import starter & example projects'
+  task create_all: :environment do
+    FilesystemProject.import_all!
   end
 end
-
-private
-
-def component(file, dir)
-  name = File.basename(file, '.*')
-  extension = File.extname(file).delete('.')
-  code = File.read(File.dirname(__FILE__) + "/project_components/#{dir}/#{File.basename(file)}")
-  default = (File.basename(file) == 'main.py')
-  component = { name:, extension:, content: code, default: }
-end
-
-def image(file, dir)
-  filename = File.basename(file)
-  io = File.open(File.dirname(__FILE__) + "/project_components/#{dir}/#{filename}")
-  image = { filename:, io: }
-end

spec/models/filesystem_project_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe FilesystemProject do
+  before do
+    PhraseIdentifier.seed!
+  end
+
+  it 'imports all starter projects' do
+    expect { described_class.import_all! }.not_to raise_error
+  end
+end