add optional figure reference baking injected exercises #432

ajluk · 2021-10-27T12:24:53Z

Issue: https://github.com/openstax/cnx-recipes/issues/4177

codecov · 2021-10-27T12:26:03Z

Codecov Report

Merging #432 (6fda1d7) into main (3f72d38) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #432   +/-   ##
=======================================
  Coverage   99.96%   99.96%           
=======================================
  Files         179      181    +2     
  Lines        2712     2739   +27     
=======================================
+ Hits         2711     2738   +27     
  Misses          1        1

Impacted Files	Coverage Δ
lib/kitchen/element_base.rb	`100.00% <ø> (ø)`
lib/kitchen/directions/bake_injected_exercise.rb	`100.00% <100.00%> (ø)`
...jected_exercise/bake_injected_exercise_question.rb	`100.00% <100.00%> (ø)`
lib/kitchen/element_enumerator_base.rb	`100.00% <100.00%> (ø)`
lib/kitchen/injected_exercise_element.rb	`100.00% <100.00%> (ø)`
...ib/kitchen/injected_exercise_element_enumerator.rb	`100.00% <100.00%> (ø)`
lib/kitchen/injected_question_element.rb	`100.00% <100.00%> (ø)`
lib/kitchen/selectors/base.rb	`100.00% <100.00%> (ø)`
lib/kitchen/selectors/standard_1.rb	`100.00% <100.00%> (ø)`

kswanson33

I think a better place for this change would be in the BakeInjectedExercises class -- this is where the 'Refer to...' text is baked in the first place! I assume this change would only be for single-part exercises?

kswanson33 · 2021-10-27T21:08:08Z

lib/kitchen/injected_question_element.rb

+    #
+    # @return [Element]
+    #
+    def exercise_context


this should probably go on the InjectedExerciseElement class -- if it doesn't exist, it seems like it should be created

ajluk · 2021-11-02T19:54:49Z

lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise_question.rb

@@ -41,11 +42,15 @@ def bake(question:, number:, only_number_solution:)
        end
      end

+      context = question.ancestor(:injected_exercise).exercise_context&.cut&.paste if figure_reference


@kswanson33 I have tried refactored the code with your requested changes but I've got stuck in this particular place and got such error:

In my recipe I'm using this loop, where it is not pointing to injected_exercises but exercise_question``:

and I guess this is the reason why I can't select an ancestor for the exercise_question of given type (`:injected_exercise`). Do you think there is a need to change the `BakeInjectedExerciseQuestion` to point `injected_exercises` instead of `exercise_question` I'm asking because it will need to be updated in some of the recipes? I can also use `context = question.parent.first("div[data-type='exercise-context']")&.cut&.paste if figure_reference` instead (it's working properly then). Or maybe you can see a different approach here, rewrite the loop in the recipe somehow? Let me know if you will have some suggestions. 🙂

@kswanson33 could you also explain what did you mean by single-part exercises?

Small EDIT:
I have also tried to use the element class InjectedExerciseElement itsef:

but also got error:

ajluk · 2021-11-12T19:09:07Z

Hi @kswanson33 After Larissa's comment I have reworked the PR to only move the exercise-context if there is only one exercise-question per injected-exercise so this feature will be for now available only for singular part exercises. I have also confirmed it with Larissa. I was also thinking if there will be more exercises questions when there is a exercise-context figure present in some books we perhaps should tag the exercise question with some class, so we will know where to move the exercise-context figure reference but Larissa needs to look into it deeper how the content will look.

kswanson33

looks really good! two little comments but other than that it's fantastic :)

kswanson33 · 2021-11-12T19:20:19Z

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 * Add `BakeScreenreaderSpans` direction (minor)
 * Fix `BakeIndex` to group terms by character in polish books and transliterate it for others (minor)
-
+* Add `figure_reference` option for `BakeNoteInjectedQuestion` to bake exercise-context figure reference (minor)


Don't forget to update the changelog to reflect the new change! I believe this change is major as single-part injected exercises should always be changed.

kswanson33 · 2021-11-12T19:20:51Z

lib/kitchen/directions/bake_injected_exercise/bake_injected_exercise_question.rb

  end

  class V1
-    def bake(question:, number:, only_number_solution:)
+    def bake(question:, number:, only_number_solution:, figure_reference:)


do we need an argument here? probably this should always be true

add optional figure reference baking injected exercises

3982efb

ajluk self-assigned this Oct 27, 2021

ajluk added 3 commits October 27, 2021 17:48

add spec case

728cb0b

add rubocop fixes

5f39a5c

update changelog

39d017e

ajluk mentioned this pull request Oct 27, 2021

Add bake exercises context figure injected exercises World History recipe update openstax/recipes#134

Merged

ajluk requested review from kswanson33 and removed request for kswanson33 October 27, 2021 18:28

kswanson33 requested changes Oct 27, 2021

View reviewed changes

ajluk added 9 commits November 2, 2021 14:23

move exercises context problem container

36d6557

add additional space figure context exercises link

2d65f8a

add test content

2462d7f

revoe test content

dc50c05

add separate space exercise context link

0ce8f8b

add divider

20ae81e

change divider dot

0e848d2

add one more condition

d683567

refactor requested changes

1ef283d

ajluk commented Nov 2, 2021

View reviewed changes

ajluk requested a review from kswanson33 November 2, 2021 19:57

remove duplicate file

4de89f6

ajluk marked this pull request as draft November 5, 2021 18:39

ajluk added 4 commits November 10, 2021 18:54

merge main fix conflicts

a3a8e62

move exercise context to question in BakeInjectedExercise

3e285d6

add check questions amount injected exercise update specs

c516bef

update bake_injected_exercise_question spec add rubocop fixes

41f231d

ajluk marked this pull request as ready for review November 12, 2021 18:51

kswanson33 requested changes Nov 12, 2021

View reviewed changes

apply requested chenges

6fda1d7

ajluk requested a review from kswanson33 November 12, 2021 19:37

kswanson33 approved these changes Nov 12, 2021

View reviewed changes

ajluk merged commit 7fddda2 into main Nov 12, 2021

ajluk deleted the figure-reference-injected-exercises branch November 12, 2021 19:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add optional figure reference baking injected exercises #432

add optional figure reference baking injected exercises #432

ajluk commented Oct 27, 2021 •

edited

Loading

codecov bot commented Oct 27, 2021 •

edited

Loading

kswanson33 left a comment

kswanson33 Oct 27, 2021

ajluk Nov 2, 2021 •

edited

Loading

ajluk Nov 2, 2021

ajluk Nov 3, 2021

ajluk commented Nov 12, 2021

kswanson33 left a comment

kswanson33 Nov 12, 2021

kswanson33 Nov 12, 2021

add optional figure reference baking injected exercises #432

add optional figure reference baking injected exercises #432

Conversation

ajluk commented Oct 27, 2021 • edited Loading

codecov bot commented Oct 27, 2021 • edited Loading

Codecov Report

kswanson33 left a comment

Choose a reason for hiding this comment

kswanson33 Oct 27, 2021

Choose a reason for hiding this comment

ajluk Nov 2, 2021 • edited Loading

Choose a reason for hiding this comment

ajluk Nov 2, 2021

Choose a reason for hiding this comment

ajluk Nov 3, 2021

Choose a reason for hiding this comment

ajluk commented Nov 12, 2021

kswanson33 left a comment

Choose a reason for hiding this comment

kswanson33 Nov 12, 2021

Choose a reason for hiding this comment

kswanson33 Nov 12, 2021

Choose a reason for hiding this comment

ajluk commented Oct 27, 2021 •

edited

Loading

codecov bot commented Oct 27, 2021 •

edited

Loading

ajluk Nov 2, 2021 •

edited

Loading