mumukit-flow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 329de3a3bc7cb5e1ab5bc068c194f6b87579dc833ffa2d9e22b29bd2aa099bb9
+  data.tar.gz: ab4812c18939b9b232bee5146934cac8616e2e21422bed847fa8d4ca8327c157
+SHA512:
+  metadata.gz: 5f513eb4881d239e6b63d417b8c7c31f6b13112308afc15eef3bc4b76f6a8869a2ab913e9a50d33847b3de3c0fcc481ae26c5461fd66abcf08c3fe87a09242ca
+  data.tar.gz: c7ca33e45a160a6aa1808e43a148b9f96b08cdab965202c5a16811ef0e54444d255548cab502d8e9d34be96ba76c6c3771a33bff0ef328c8353947ada5996685

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+- 2.6.3
+before_install: gem install bundler -v 2.0.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: QJGxN+Nm6yYh/5463NgdOYye/MKNDnsxYRkczdt9I0UCF33hhyn4i8tS5m7IbhPkQJLJqRQTMHy0rLM7CXJZ0KrI33F+meDin36GerWBFGXjBv3UatzaoM2BQpDQzPbrLKNB52HouchVoXY56Y2elf4Od6qLmhqoXa2RXsA0AA2t9e4GN4/iTHE4aGePPKUVTWLNMTMMPe2TlXADSdw03DgLiSk/K8ZTUYpK4T+cxn/SjmpXNrBMIktrznOVTcNpG0FyBMxpW2dVLqa4sVMeKt+cT4aiQfvJXkbxEXHm0ZM95rpiNpAiyD2Yno9+AC2kO3A32PTMSbHS6Taq2z3A6quTYaxrVbv/N7ZXZIlNKyG1ukj3H6CXdC9pkBF80c8bEy7yGVy0b2Wwx5LEuGiv6wwEZNsqoccJyP1Jgw+3qaP5TW+HCGgJxgIngX019MTZzGHEC443imJuhuB5ZOM/jtqRvE1XGWcFNarg+Id+0KTkDLRAt8QeIesBOfo1ziSUIZS9tn2LbYm701PIuK63KwkVMsnMKHNoOAybJd0zc64EvEjOGSV5+bmDPFDPbhiRviNm5YRtQCuKq3OUlYU1J8HpQk56UEGjBwcoDFv+IAqDCZnVvw1xor/6hVNJnVlS/k+4EUf9Bnt+BGd2rnpzyJIXadmcTHnZOuSi8rEkiSM=
+  gem: mumukit-flow
+  on:
+    tags: true
+    repo: mumuki/mumukit-flow
+  skip_cleanup: 'true'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at franco@mumuki.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Franco Bulgarelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Mumukit::Flow
+
+> An adaptive flow implementation for the Mumuki Platform
+
+This gem implements an adaptive flow - it considers a student's performance to respond to the question _what exercise should come next?_. It does not address other aspects of the platform like code evaluation, submission flow UI or feedback provision, but it does implement some navigation-related aspects.
+
+The initial work on this gem is based on Marco Moresi's Computer Science Thesis from the Faculty of Mathematics, Algebra and Physics, University of Córdoba, Argentina, which can be found in [this repository](https://github.com/mrcmoresi/msc-thesis).
+
+At a glance, it supports five types of suggestions:
+
+ * `continue`: go to the next exercise
+ * `revisit`: try again an exercise the student manually skipped
+ * `skip`: go faster to more advanced exercises by skipping practice exercises when performing very well
+ * `reinforce`: go to an easier exercise, to better grasp the concepts that prove difficult for the student
+ * `none`: nothing to suggest
+ 
+They are implemented as `Mumukit::Flow::Suggestion`s: `Mumukit::Flow::Suggestion::Continue`, `Mumukit::Flow::Suggestion::Revisit`, `Mumukit::Flow::Suggestion::Skip`, `Mumukit::Flow::Suggestion::Reinforce` and `Mumukit::Flow::Suggestion::None`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mumuki/mumukit-flow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mumukit::Flow project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mumuki/mumukit-flow/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mumukit/flow"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mumukit/flow.rb

@@ -0,0 +1,13 @@
+require 'mumukit/flow/version'
+require 'mumukit/core'
+
+module Mumukit
+  module Flow
+  end
+end
+
+require_relative 'flow/navigation'
+require_relative 'flow/suggesting'
+require_relative 'flow/suggestion'
+require_relative 'flow/adaptive_assignment'
+require_relative 'flow/adaptive_item'

data/lib/mumukit/flow/adaptive_assignment.rb

@@ -0,0 +1,22 @@
+module Mumukit::Flow
+  module AdaptiveAssignment
+
+    required :solved?
+
+    def easy?
+      solved? && submissions_count <= max_submissions_for_easy
+    end
+
+    def hard?
+      submissions_count >= min_submissions_for_hard
+    end
+
+    def max_submissions_for_easy
+      3
+    end
+
+    def min_submissions_for_hard
+      10
+    end
+  end
+end

data/lib/mumukit/flow/adaptive_item.rb

@@ -0,0 +1,84 @@
+module Mumukit::Flow
+  module AdaptiveItem
+    include Mumukit::Flow::Suggesting
+
+    required :assignment
+    required :structural_children
+    required :structural_parent
+    required :tags
+
+    delegate :solved?, :submitter, to: :@assignment
+
+    def tagged_as?(tag)
+      tags.include? tag
+    end
+
+    def no_tags?
+      tags.empty?
+    end
+
+    def should_skip_next_item?
+      similar_easy_siblings_for_every_tag? if next_item&.skippable?
+    end
+
+    def skippable?
+      practice?
+    end
+
+    def end_reached?
+      next_item.nil?
+    end
+
+    private
+
+    def set_adaptive_assignment!(submitter)
+      @assignment = assignment_for submitter
+      @assignment.skip_if_pending!
+    end
+
+    def next_item
+      @next_item ||= next_items.first
+    end
+
+    def next_items
+      sorted_pending_siblings.select { |it| it.number > number }
+    end
+
+    def sorted_pending_siblings
+      pending_siblings.sort_by(&:number)
+    end
+
+    def pending_siblings
+      solved_items = solved_siblings_by(submitter).map(&:item)
+      structural_parent.structural_children - solved_items
+    end
+
+    def first_pending_sibling
+      sorted_pending_siblings.first
+    end
+
+    def pending_siblings?
+      pending_siblings.present?
+    end
+
+    def solved_siblings_by(submitter)
+      structural_parent.exercise_assignments_for(submitter).compact.select(&:solved?)
+    end
+
+    def similar_easy_siblings_for_every_tag?
+      next_item.tags.all? { |tag| easy_tag?(tag) } unless next_item.no_tags?
+    end
+
+    def easy_tag?(tag)
+      easy_siblings_with(tag).count >= min_easy_siblings_for_skipping
+    end
+
+    def easy_siblings_with(tag)
+      solved_siblings_by(submitter).select { |sibling| sibling.easy? && sibling.item.tagged_as?(tag) }
+    end
+
+    def min_easy_siblings_for_skipping
+      2
+    end
+  end
+end

data/lib/mumukit/flow/navigation.rb

@@ -0,0 +1,3 @@
+require_relative 'navigation/parent_navigation'
+require_relative 'navigation/siblings_navigation'
+require_relative 'navigation/terminal_navigation'

data/lib/mumukit/flow/navigation/parent_navigation.rb

@@ -0,0 +1,24 @@
+module Mumukit::Flow::ParentNavigation
+  def leave(user)
+    navigable_parent.next_for(user)
+  end
+
+  def navigation_end?
+    false
+  end
+
+  def navigable_name
+    defaulting_name { super }
+  end
+
+  def navigable_parent
+    structural_parent.usage_in_organization
+  end
+
+  private
+
+  def defaulting_name(&block)
+    navigable_parent.defaulting(name, &block)
+  end
+end
+

data/lib/mumukit/flow/navigation/siblings_navigation.rb

@@ -0,0 +1,22 @@
+module Mumukit::Flow::SiblingsNavigation
+  def next_for(user)
+    pending_siblings_for(user).select { |it| it.number > number }.sort_by(&:number).first
+  end
+
+  def restart(user)
+    pending_siblings_for(user).sort_by(&:number).first
+  end
+
+  def siblings
+    structural_parent.structural_children
+  end
+
+  #TODO reestablish this after indicators reliably linked to assignments
+  # def pending_siblings_for(user, organization=Organization.current)
+  #   siblings.reject { |it| it.progress_for(user, organization).completed? }
+  # end
+
+  def navigable_name
+    "#{number}. #{name}"
+  end
+end

data/lib/mumukit/flow/navigation/terminal_navigation.rb

@@ -0,0 +1,21 @@
+module Mumukit::Flow::TerminalNavigation
+  def navigation_end?
+    true
+  end
+
+  def friendly
+    name
+  end
+
+  def navigable_name
+    name
+  end
+
+  def structural_parent
+    nil
+  end
+
+  def siblings
+    []
+  end
+end

data/lib/mumukit/flow/suggesting.rb

@@ -0,0 +1,24 @@
+module Mumukit::Flow
+  module Suggesting
+    def next_suggested_item_for(submitter)
+      set_adaptive_assignment!(submitter)
+      next_item_suggestion(submitter).item
+    end
+
+    private
+
+    def next_item_suggestion(submitter)
+      if end_reached?
+        if pending_siblings?
+          Mumukit::Flow::Suggestion::Revisit.new(first_pending_sibling)
+        else
+          Mumukit::Flow::Suggestion::None
+        end
+      elsif should_skip_next_item?
+        Mumukit::Flow::Suggestion::Skip.new(next_item.next_suggested_item_for(submitter))
+      else
+        Mumukit::Flow::Suggestion::Continue.new(next_item)
+      end
+    end
+  end
+end

data/lib/mumukit/flow/suggestion.rb

@@ -0,0 +1,28 @@
+module Mumukit::Flow
+  module Suggestion
+    module None
+      def self.item
+        nil
+      end
+    end
+
+    class Some
+      attr_reader :item
+      def initialize(item)
+        @item = item
+      end
+    end
+
+    class Continue < Some
+    end
+
+    class Skip < Some
+    end
+
+    class Reinforce < Some
+    end
+
+    class Revisit < Some
+    end
+  end
+end

data/lib/mumukit/flow/version.rb

@@ -0,0 +1,5 @@
+module Mumukit
+  module Flow
+    VERSION = "1.0.0"
+  end
+end

data/mumukit-flow.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mumukit/flow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mumukit-flow"
+  spec.version       = Mumukit::Flow::VERSION
+  spec.authors       = ["Franco Bulgarelli"]
+  spec.email         = ["franco@mumuki.org"]
+
+  spec.summary       = %q{Adaptive flow implementation for the mumukit-platform}
+  spec.homepage      = "https://mumuki.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mumukit-core", "~> 1.17"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mumukit-flow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Franco Bulgarelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mumukit-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- franco@mumuki.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mumukit/flow.rb
+- lib/mumukit/flow/adaptive_assignment.rb
+- lib/mumukit/flow/adaptive_item.rb
+- lib/mumukit/flow/navigation.rb
+- lib/mumukit/flow/navigation/parent_navigation.rb
+- lib/mumukit/flow/navigation/siblings_navigation.rb
+- lib/mumukit/flow/navigation/terminal_navigation.rb
+- lib/mumukit/flow/suggesting.rb
+- lib/mumukit/flow/suggestion.rb
+- lib/mumukit/flow/version.rb
+- mumukit-flow.gemspec
+homepage: https://mumuki.io
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Adaptive flow implementation for the mumukit-platform
+test_files: []