mumukit-sync 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f7baaa8e76bf058e052f2780556fb3d65117180
+  data.tar.gz: 600774b772fc093e84e65725772886b952b21bf7
+SHA512:
+  metadata.gz: 39ea6d27c387074ab92beac6e6af8d2c3bc6e07f8be9426afc7fbd26fa2161c3f3657ada11e1cd334696d0469fc7dc04f4dfb433e09527b854c87c4dfbc647d3
+  data.tar.gz: 717401eaf93664c692023bc31a0975e1c4bf3fd98ea3b70ad343401a1dca77c64e3bb8b7da29e8d3ba271ec8cde0574b452a733554839bbda4f5be795f14b17e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.10.6
+deploy:
+  provider: rubygems
+  api_key:
+    secure: f0boGHzgJp2bzHbxBEZAEgJ7hO8Iv5Ays6HHfm5nOphg+SMKkmqGpEPPCwbCiiw4ZQ5KyAbxjLvclMzDknpku3v13fXtVlVWyGMH+vpHZnKmgsPWzJ29XTEEzC1FNc1WYEtxhXaCQ9W8xB00j4ahukmVRJOTt+TD0hRsaRXtY0T7HC9JQQkT1x52qf3rhxRM1dgfRJdorB545xAxpyHx1Psy0kCSx+mVRlF0pETRvAy84X6Igjyvc2ovgGKbpRVeA1e5TsWrKjNoBbeKXDBzdND4hDpa9dyshgO33edo4qN4RWh+WPdQTeu8opv8sBOA7sH/Dzx20nII8DDeSPon9jYa7B8DBb1m/DnjjhTmka96n3WBbSeXSCEWGs+KgQO6OBNIR0gghOl3P380ocMLN9nWCNFwTBc/zUY6AsoQyV2hQI5rivTldJOAClEvDGDzZFl2bTRyic4jcn8U/USS7M3Rp3/s4si8km6s0Oy8FLtfnOINznM6quQiDjaXgI5acxx18AncQeqV4nmWxnEALI1i96McJvj3ONZOpzRlp2t1A3Qx5AdbypP9IKgHuBHGSq9W+oifuSN7xRh6Q/yuoWRgo39pdw075LhnUQgX8MVevVU4kGVwGPslirMQb5prf3lvLEQrZhAcGGgrq/vST1ZGesViFwV53LvM3nZGnRs=
+  gem: mumukit-sync
+  on:
+    tags: true
+    repo: mumuki/mumukit-sync

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,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+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,49 @@
+[![Stories in Ready](https://badge.waffle.io/mumuki/mumukit-sync.png?label=ready&title=Ready)](https://waffle.io/mumuki/mumukit-sync)
+[![Build Status](https://travis-ci.org/mumuki/mumukit-sync.svg?branch=master)](https://travis-ci.org/mumuki/mumukit-sync)
+[![Code Climate](https://codeclimate.com/github/mumuki/mumukit-sync/badges/gpa.svg)](https://codeclimate.com/github/mumuki/mumukit-sync)
+[![Test Coverage](https://codeclimate.com/github/mumuki/mumukit-sync/badges/coverage.svg)](https://codeclimate.com/github/mumuki/mumukit-sync)
+
+
+# Mumukit::Sync
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mumukit/sync`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mumukit-sync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mumukit-sync
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/mumukit-sync. 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::Sync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mumukit-sync/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/sync"
+
+# 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/sync.rb

@@ -0,0 +1,28 @@
+require 'git'
+require 'octokit'
+
+
+require "mumukit/sync/version"
+
+module Mumukit
+  module Sync
+    ## Creates a sync key, composed of a `kind` and `id`
+    def self.key(kind, id)
+      struct kind: kind, id: id
+    end
+
+    def self.constantize(kind)
+      classify(kind).constantize
+    end
+
+    def self.classify(kind)
+      kind.to_s.classify
+    end
+  end
+end
+
+require 'mumukit/core'
+
+require_relative './sync/syncer'
+require_relative './sync/store'
+require_relative './sync/inflator'

data/lib/mumukit/sync/inflator.rb

@@ -0,0 +1,14 @@
+module Mumukit::Sync
+  module Inflator
+    def self.inflate_with!(sync_key, resource_h, inflators)
+      inflators.each { |it| it.inflate! sync_key, resource_h }
+    end
+  end
+end
+
+require_relative './inflator/exercise'
+require_relative './inflator/choice'
+require_relative './inflator/single_choice'
+require_relative './inflator/multiple_choice'
+require_relative './inflator/gobstones_kids_boards'
+

data/lib/mumukit/sync/inflator/choice.rb

@@ -0,0 +1,11 @@
+module Mumukit::Sync::Inflator
+  class Choice < Exercise
+    def inflate_exercise!(exercise_h, language_name, guide_h)
+      return unless language_name == 'text'
+      return unless exercise_h[:editor] == editor_type
+      return if exercise_h[:test]
+
+      exercise_h[:test] = choices_to_test(exercise_h[:choices])
+    end
+  end
+end

data/lib/mumukit/sync/inflator/exercise.rb

@@ -0,0 +1,11 @@
+module Mumukit::Sync::Inflator
+  class Exercise
+    def inflate!(key, resource_h)
+      return unless key.kind == :guide
+      resource_h[:exercises]&.each do |it|
+        language = it.dig(:language, :name) || resource_h.dig(:language, :name)
+        inflate_exercise! it, language, resource_h
+      end
+    end
+  end
+end

data/lib/mumukit/sync/inflator/gobstones_kids_boards.rb

@@ -0,0 +1,35 @@
+module Mumukit::Sync::Inflator
+  class GobstonesKidsBoards < Exercise
+    def inflate_exercise!(exercise_h, language_name, guide_h)
+      return unless language_name == 'gobstones'
+      return unless exercise_h[:layout] == 'input_kids'
+      return unless exercise_h[:test]
+
+      spec = YAML.load(exercise_h[:test])
+      example = spec&.dig('examples')&.first
+      with_head = spec&.dig('check_head_position')
+
+      return unless example
+
+      exercise_h[:initial_state] = initial_board example
+      exercise_h[:final_state] = final_board example, with_head
+    end
+
+    def to_gs_board(board, with_head)
+      "<gs-board#{with_head ? "" : " without-header"}> #{board} </gs-board>" if board
+    end
+
+
+    def initial_board(example)
+      to_gs_board(example['initial_board'], true)
+    end
+
+    def final_board(example, with_head)
+      to_gs_board(example['final_board'], with_head) || self.class.boom_board
+    end
+
+    def self.boom_board
+      "<img src='https://user-images.githubusercontent.com/1631752/37945593-54b482c0-3157-11e8-9f32-bd25d7bf901b.png'>"
+    end
+  end
+end

data/lib/mumukit/sync/inflator/multiple_choice.rb

@@ -0,0 +1,15 @@
+module Mumukit::Sync::Inflator
+  class MultipleChoice < Choice
+    def editor_type
+      'multiple_choice'
+    end
+
+    def choices_to_test(choices)
+      value = choices.each_with_index
+                .map { |choice, index| choice.merge(:index => index.to_s) }
+                .select { |choice| choice[:checked] }
+                .map { |choice| choice[:index] }.join(':')
+      {'equal' => value}.to_yaml
+    end
+  end
+end

data/lib/mumukit/sync/inflator/single_choice.rb

@@ -0,0 +1,12 @@
+module Mumukit::Sync::Inflator
+  class SingleChoice < Choice
+    def editor_type
+      'single_choice'
+    end
+
+    def choices_to_test(choices)
+      choice = choices.find { |choice| choice[:checked] }
+      {'equal' => choice[:value]}.to_yaml
+    end
+  end
+end

data/lib/mumukit/sync/store.rb

@@ -0,0 +1,12 @@
+require 'mumukit/bridge'
+
+module Mumukit::Sync
+  module Store
+  end
+end
+
+
+require_relative './store/github'
+require_relative './store/json'
+require_relative './store/thesaurus'
+require_relative './store/bibliotheca'

data/lib/mumukit/sync/store/bibliotheca.rb

@@ -0,0 +1,23 @@
+module Mumukit::Sync::Store
+  class Bibliotheca
+    def initialize(bibliotheca_bridge)
+      @bibliotheca_bridge = bibliotheca_bridge
+    end
+
+    def sync_keys
+      %w(guide topic book).flat_map do |kind|
+        @bibliotheca_bridge
+          .send(kind.to_s.pluralize)
+          .map { |it| Mumukit::Sync.key kind, it['slug']  }
+      end
+    end
+
+    def read_resource(sync_key)
+      @bibliotheca_bridge.send(sync_key.kind, sync_key.id)
+    end
+
+    def write_resource!(*)
+      raise 'Read-only store'
+    end
+  end
+end

data/lib/mumukit/sync/store/github.rb

@@ -0,0 +1,59 @@
+module Mumukit::Sync::Store
+  class Github
+    def initialize(bot, author_email = nil, web_hook_base_url = nil)
+      @bot = bot
+      @author_email = author_email || bot.email
+      @web_hook_base_url = web_hook_base_url
+    end
+
+    def sync_keys
+      raise 'Non-discoverable store'
+    end
+
+    def read_resource(sync_key)
+      return unless sync_key.kind == :guide
+
+      Mumukit::Sync::Store::Github::GuideImport.new(
+        bot: @bot,
+        repo: sync_key.id,
+        web_hook_base_url: @web_hook_base_url).run!
+    end
+
+    def write_resource!(sync_key, resource_h)
+      return unless sync_key.kind == :guide
+
+      Mumukit::Sync::Store::Github::GuideExport.new(
+        slug: sync_key.id,
+        document: resource_h,
+        author_email: @author_email,
+        web_hook_base_url: @web_hook_base_url,
+        bot: @bot).run!
+    end
+  end
+
+  ## FIXME REMOVE
+  class Github::Bot
+    def upload_asset!(slug, filename, content)
+      path = "assets/#{filename.gsub(/\.(.*){2,4}/) { |it| "_#{(Time.now.to_f * 1000).to_i}#{it}" }}"
+      octokit.create_contents(slug.to_s,
+                              path,
+                              'Uploading new asset',
+                              content).content.to_h
+    end
+  end
+end
+
+require 'mumukit/auth'
+
+require_relative './github/bot'
+require_relative './github/git_lib'
+require_relative './github/with_file_reading'
+require_relative './github/guide_reader'
+require_relative './github/guide_builder'
+require_relative './github/exercise_builder'
+require_relative './github/guide_writer'
+require_relative './github/operation'
+require_relative './github/guide_export'
+require_relative './github/guide_import'
+require_relative './github/ordering'
+require_relative './github/schema'