mumukit-assistant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 051724369ddfa47a9d19d3f31775a46428ef4a7b
+  data.tar.gz: 231892340a2a47b23eed47c6fbc3cae82789e446
+SHA512:
+  metadata.gz: 64038b701177a0fa290ee8391bad4d9383290444807258f5cffc26767e03c9e1f08cd95aae98a4b6ae68bea74ecfb2a2a9dd2df11445d5c58783505e72b238dc
+  data.tar.gz: 08d3bf283f06dc28b8ab71f6059eb73e9529f4b1efb5bca031625a2edeb21ebd5fda82804ba2f235fa64f2bf2c554755116085991914e6e5b516a00570587846

data/lib/locales/narrator.en.yml

@@ -0,0 +1,14 @@
+en:
+  narrator:
+    retry_0: Let's try again!
+    retry_1: Keep on!
+    retry_2: Let's fix it!
+    introduction_0: "Oops, it didn't work :frowning:."
+    introduction_1: "Oops, it didn't work :frowning:."
+    introduction_2: "Oops, it didn't work :frowning:."
+    middle_0: Also, %{tip}.
+    middle_1: Also, %{tip}.
+    middle_2: Also, %{tip}.
+    ending_0: Finally, %{tip}.
+    ending_1: Finally, %{tip}.
+    ending_2: Finally, %{tip}.

data/lib/locales/narrator.es.yml

@@ -0,0 +1,14 @@
+es:
+  narrator:
+    retry_0: ¡Intentemos de nuevo!
+    retry_1: 'Pero a no desesperar, intentemos otra vez :muscle:'
+    retry_2: ¡Corrijamos el problema!
+    introduction_0: 'Parece que algo no funcionó :see_no_evil:.'
+    introduction_1: 'Eh, ¿qué pasó acá :frowning:?'
+    introduction_2: 'Parece que algo no anduvo bien :sweat_smile:'
+    middle_0: "Además, %{tip}."
+    middle_1: "También %{tip}."
+    middle_2: "Por otro lado, %{tip}."
+    ending_0: "Por último, %{tip}."
+    ending_1: "Ah, algo más: %{tip}."
+    ending_2: "Y para cerrar, %{tip}."

data/lib/locales/narrator.pt.yml

@@ -0,0 +1,14 @@
+pt:
+  narrator:
+    retry_0: Vamos tentar de novo!
+    retry_1: 'Mas não se desespere, vamos tentar novamente :muscle:'
+    retry_2: Corrigimos o problema!
+    introduction_0: 'Parece que algo não funcionou :see_no_evil:.'
+    introduction_1: 'Ei, o que aconteceu aqui :frowning:?'
+    introduction_2: 'Parece que algo não correu bem :sweat_smile:'
+    middle_0: "Além disso, %{tip}."
+    middle_1: "Também %{tip}."
+    middle_2: "Por outro lado, %{tip}."
+    ending_0: "Finalmente, %{tip}."
+    ending_1: "Oh, algo mais: %{tip}."
+    ending_2: "E para fechar, %{tip}."

data/lib/mumukit/assistant.rb

@@ -0,0 +1,36 @@
+require 'mumukit/core'
+require 'i18n'
+
+I18n.load_translations_path File.join(__dir__, '..', 'locales', '*.yml')
+
+module Mumukit
+  # An assistant is used to generate dynamic feedback
+  # over a student's submission, based on rules.
+  #
+  # This feedback is composed of a list of markdown messages called _tips_,
+  # and the whole processes of creating this feedback is called _assistance_.
+  class Assistant
+    attr_accessor :rules
+
+    def initialize(rules)
+      @rules = rules
+    end
+
+    # Provides tips for the student for the given submission,
+    # based on the `rules`.
+    def assist_with(submission)
+      @rules
+        .select { |it| it.matches?(submission) }
+        .map { |it| it.message_for(submission.attemps_count) }
+    end
+
+    def self.parse(rules)
+      new rules.map { |it| Mumukit::Assistant::Rule.parse it }
+    end
+  end
+end
+
+require_relative './assistant/rule'
+require_relative './assistant/message'
+require_relative './assistant/narrator'
+require_relative './assistant/version'

data/lib/mumukit/assistant/message.rb

@@ -0,0 +1,45 @@
+module Mumukit::Assistant::Message
+  # Fixed messages are independent of the number
+  # of attemps
+  class Fixed
+    def initialize(text)
+      @text = text
+    end
+
+    def call(_)
+      @text
+    end
+  end
+
+  # Progressive messages depend on the number of attemps
+  # They work with exactly two or three messages:
+  #
+  #  * the first message will be displayed in the first three attemps
+  #  * the second message will be displayed in the fourth, fifth and sixth attemps
+  #  * the third message will be displayed starting at the seventh attemp
+  #
+  class Progressive
+    def initialize(alternatives)
+      raise 'You need two or three alternatives' unless alternatives.size.between?(2, 3)
+      @alternatives = alternatives
+    end
+
+    def call(attemps_count)
+      case attemps_count
+        when (1..3) then @alternatives.first
+        when (4..6) then @alternatives.second
+        else @alternatives.last
+      end
+    end
+  end
+
+  def self.parse(text_or_alternatives)
+    if text_or_alternatives.is_a? String
+      Fixed.new text_or_alternatives
+    elsif text_or_alternatives.is_a? Array
+      Progressive.new text_or_alternatives
+    else
+      raise "Wrong message format #{text_or_alternatives}"
+    end
+  end
+end

data/lib/mumukit/assistant/narrator.rb

@@ -0,0 +1,67 @@
+# A narrator can turn tips  - generated by `Mumukit::Assistant` -
+# into a humanized text with the same information but
+# a bit more friendly. This text is called _explanation_.
+#
+# The narrator uses some internationalized random phrases, and it does provide
+# a seed as a construction argument to allow its testing.
+class Mumukit::Assistant::Narrator
+  def initialize(seed)
+    @seed = seed
+  end
+
+  # Generated a markdown explanation using the seeded phrases. Uses `I18n` to get
+  # the appropriate locale.
+  def compose_explanation(tips)
+    "#{explanation_introduction_phrase}\n\n#{explanation_paragraphs(tips).join("\n\n")}\n\n#{retry_phrase}\n"
+  end
+
+  # Generates an html explantion.
+  # See `compose_explanation`
+  def compose_explanation_html(tips)
+    Mumukit::ContentType::Markdown.to_html compose_explanation(tips)
+  end
+
+  def retry_phrase
+    t :retry
+  end
+
+  def explanation_introduction_phrase
+    t :introduction
+  end
+
+  def explanation_paragraphs(tips)
+    tips.take(3).zip([:opening, :middle, :ending]).map do |tip, selector|
+      send "explanation_#{selector}_paragraph", tip
+    end
+  end
+
+  def explanation_opening_paragraph(tip)
+    "#{tip.capitalize}."
+  end
+
+  def explanation_middle_paragraph(tip)
+    t :middle, tip: tip
+  end
+
+  def explanation_ending_paragraph(tip)
+    t :ending, tip: tip
+  end
+
+  def self.random
+    new seed(*5.times.map { random_index })
+  end
+
+  def self.seed(r, i, o, m, e)
+    { retry: r, introduction: i, opening: o, middle: m, ending: e }
+  end
+
+  private
+
+  def t(key, args={})
+    I18n.t "narrator.#{key}_#{@seed[key]}", args
+  end
+
+  def self.random_index
+    (0..2).to_a.sample
+  end
+end

data/lib/mumukit/assistant/rule.rb

@@ -0,0 +1,42 @@
+module Mumukit::Assistant::Rule
+  def self.parse(hash)
+    message = Mumukit::Assistant::Message.parse hash[:then]
+    w = hash[:when]
+    if w.is_a? Hash
+      parse_complex_when w.first, message
+    else
+      parse_simple_when w, message
+    end
+  end
+
+  def self.parse_simple_when(w, message)
+    case w
+      when :content_empty                    then Mumukit::Assistant::Rule::ContentEmpty.new(message)
+      when :submission_errored               then Mumukit::Assistant::Rule::SubmissionErrored.new(message)
+      when :submission_failed                then Mumukit::Assistant::Rule::SubmissionFailed.new(message)
+      when :submission_passed_with_warnings  then Mumukit::Assistant::Rule::SubmissionPassedWithWarnings.new(message)
+      else raise "Unsupported rule #{w}"
+    end
+  end
+
+  def self.parse_complex_when(w, message)
+    condition, value = *w
+    case condition
+      when :error_contains            then Mumukit::Assistant::Rule::ErrorContains.new(message, value)
+      when :these_tests_failed        then Mumukit::Assistant::Rule::TheseTestsFailed.new(message, value)
+      when :only_these_tests_failed   then Mumukit::Assistant::Rule::OnlyTheseTestsFailed.new(message, value)
+      when :these_expectations_failed then Mumukit::Assistant::Rule::TheseExpectationsFailed.new(message, value)
+      else raise "Unsupported rule #{condition}"
+    end
+  end
+end
+
+require_relative 'rule/base.rb'
+require_relative 'rule/content_empty.rb'
+require_relative 'rule/submission_failed.rb'
+require_relative 'rule/these_tests_failed.rb'
+require_relative 'rule/only_these_tests_failed.rb'
+require_relative 'rule/submission_passed_with_warnings.rb'
+require_relative 'rule/these_expectations_failed.rb'
+require_relative 'rule/submission_errored.rb'
+require_relative 'rule/error_contains.rb'

data/lib/mumukit/assistant/rule/base.rb

@@ -0,0 +1,10 @@
+class Mumukit::Assistant::Rule::Base
+  attr_accessor :message
+  def initialize(message)
+    @message = message
+  end
+
+  def message_for(retries)
+    message.call(retries)
+  end
+end

data/lib/mumukit/assistant/rule/content_empty.rb

@@ -0,0 +1,5 @@
+class Mumukit::Assistant::Rule::ContentEmpty < Mumukit::Assistant::Rule::Base
+  def matches?(submission)
+    submission.content.empty?
+  end
+end

data/lib/mumukit/assistant/rule/error_contains.rb

@@ -0,0 +1,10 @@
+class Mumukit::Assistant::Rule::ErrorContains < Mumukit::Assistant::Rule::SubmissionErrored
+  def initialize(message, text)
+    super(message)
+    @text = text
+  end
+
+  def matches?(submission)
+    super && submission.result.include?(@text)
+  end
+end

data/lib/mumukit/assistant/rule/only_these_tests_failed.rb

@@ -0,0 +1,5 @@
+class Mumukit::Assistant::Rule::OnlyTheseTestsFailed < Mumukit::Assistant::Rule::TheseTestsFailed
+  def matches_failing_tests?(submission)
+    super && failed_tests(submission).count == @tests.count
+  end
+end

data/lib/mumukit/assistant/rule/submission_errored.rb

@@ -0,0 +1,5 @@
+class Mumukit::Assistant::Rule::SubmissionErrored < Mumukit::Assistant::Rule::Base
+  def matches?(submission)
+    submission.status.errored?
+  end
+end

data/lib/mumukit/assistant/rule/submission_failed.rb

@@ -0,0 +1,5 @@
+class Mumukit::Assistant::Rule::SubmissionFailed < Mumukit::Assistant::Rule::Base
+  def matches?(submission)
+    submission.status.failed?
+  end
+end

data/lib/mumukit/assistant/rule/submission_passed_with_warnings.rb

@@ -0,0 +1,5 @@
+class Mumukit::Assistant::Rule::SubmissionPassedWithWarnings < Mumukit::Assistant::Rule::Base
+  def matches?(submission)
+    submission.status.passed_with_warnings?
+  end
+end

data/lib/mumukit/assistant/rule/these_expectations_failed.rb

@@ -0,0 +1,22 @@
+class Mumukit::Assistant::Rule::TheseExpectationsFailed < Mumukit::Assistant::Rule::SubmissionPassedWithWarnings
+  def initialize(message, expectations)
+    raise 'missing expectations' if expectations.blank?
+    super(message)
+    @expectations = expectations
+  end
+
+  def matches?(submission)
+    super && matches_failing_expectations?(submission)
+  end
+
+  def matches_failing_expectations?(submission)
+    @expectations.all? do |it|
+      includes_failing_expectation? it, submission.expectation_results
+    end
+  end
+
+  def includes_failing_expectation?(humanized_expectation, expectation_results)
+    binding, inspection = humanized_expectation.split(' ')
+    expectation_results.include? binding: binding, inspection: inspection, result: :failed
+  end
+end

data/lib/mumukit/assistant/rule/these_tests_failed.rb

@@ -0,0 +1,25 @@
+class Mumukit::Assistant::Rule::TheseTestsFailed < Mumukit::Assistant::Rule::SubmissionFailed
+  def initialize(message, tests)
+    raise 'missing tests' if tests.blank?
+    super(message)
+    @tests = tests
+  end
+
+  def matches?(submission)
+    super && matches_failing_tests?(submission)
+  end
+
+  def matches_failing_tests?(submission)
+    @tests.all? do |it|
+      includes_failing_test? it, submission
+    end
+  end
+
+  def includes_failing_test?(title, submission)
+    failed_tests(submission).map { |it| it[:title] }.include?(title)
+  end
+
+  def failed_tests(submission)
+    submission.test_results.select { |it| it[:status].failed? }
+  end
+end

data/lib/mumukit/assistant/version.rb

@@ -0,0 +1,5 @@
+module Mumukit
+  class Assistant
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mumukit-assistant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julián Berbel Alt
+- Franco Bulgarelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: mumukit-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- julian@mumuki.org
+- franco@mumuki.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/locales/narrator.en.yml
+- lib/locales/narrator.es.yml
+- lib/locales/narrator.pt.yml
+- lib/mumukit/assistant.rb
+- lib/mumukit/assistant/message.rb
+- lib/mumukit/assistant/narrator.rb
+- lib/mumukit/assistant/rule.rb
+- lib/mumukit/assistant/rule/base.rb
+- lib/mumukit/assistant/rule/content_empty.rb
+- lib/mumukit/assistant/rule/error_contains.rb
+- lib/mumukit/assistant/rule/only_these_tests_failed.rb
+- lib/mumukit/assistant/rule/submission_errored.rb
+- lib/mumukit/assistant/rule/submission_failed.rb
+- lib/mumukit/assistant/rule/submission_passed_with_warnings.rb
+- lib/mumukit/assistant/rule/these_expectations_failed.rb
+- lib/mumukit/assistant/rule/these_tests_failed.rb
+- lib/mumukit/assistant/version.rb
+homepage: http://github.com/mumuki/mumukit-assistant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Library for providing assistance with mumuki exercises
+test_files: []