mumukit-sync 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0bdc140990239269aee542470c932aeabba4dc74da7fddb574fefd51e3a58c1
-  data.tar.gz: 75befb01b2eae5d5e75cf96175e7b67041b35ae87f22cc38838574f8800ba1bd
+  metadata.gz: dd82342ee5883d4acd712b66caa8bf5326cf5b5052df3b805f851410bed1cc00
+  data.tar.gz: 429feabd158b03a03bb8df9cb96f3656cc90f4facfe0b2a0893c97c2e2d8bd66
 SHA512:
-  metadata.gz: b7c3176f4f3b6bc05515c788da77463aea89ae7779939357821d5de0cdb0f6b4efebf0c0345a29f48cdbb793b0d8c175ee3209d1995803f816a29e30b613d7d7
-  data.tar.gz: 40f5ff3a7e9ed53fd9c8eedcdfb0bce89b103f52f17b174a81c09513e80f9c1d742ab6a640957eed42f7bf1d638f4b0c91f390e0c504352dbe428a5f4f89c909
+  metadata.gz: e111220b0c5f7d796c4ff3b09ddee8d22ff2659b8efc5b9714f864671d3e2e9e3f5341d913f23a218216d89c04eefc22a0dfcb2b19cee20bb038dd31a74dd155
+  data.tar.gz: 9e437aa0be1d83805a830c0e612f10dfe5bf4d651862da7c8e365bb38252a28a9c8203979ba61b12842e0e0882e5491a27be2e40f2e60112fa565a053bb2d93e

data/.ruby-version

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

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-- 2.3.1
+- 2.6.3
 before_install: gem install bundler -v 1.10.6
 deploy:
   provider: rubygems

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

@@ -53,6 +53,8 @@ class Mumukit::Sync::Store::Github
     def create!(slug, private)
       octokit.create_repository(slug.repository, organization: slug.organization)
       try_set_private!(slug) if private
+    rescue Octokit::Forbidden => e
+      raise raise Mumukit::Sync::SyncError, "Mumuki is not allowed to create repositories in organization #{slug.organization}"
     end
 
     def try_set_private!(slug)

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

@@ -1,5 +1,7 @@
 class Mumukit::Sync::Store::Github
   class ExerciseBuilder < OpenStruct
+    include Mumukit::Sync::Store::Github::WithSchema
+
     def locale
       meta['locale']
     end
@@ -9,11 +11,11 @@ class Mumukit::Sync::Store::Github
     end
 
     def build_simple_fields
-      Mumukit::Sync::Store::Github::Schema::Exercise.simple_fields.map { |field| [field.reverse_name, self.send(field.reverse_name)] }.to_h
+      build_fields_h(exercise_schema.simple_fields) { |field| self.send(field.reverse_name) }
     end
 
     def build_metadata
-      Mumukit::Sync::Store::Github::Schema::Exercise.metadata_fields.map { |field| [field.reverse_name, meta[field.name.to_s]] }.to_h
+      build_fields_h(exercise_schema.metadata_fields) { |field| meta[field.name.to_s] }
     end
   end
 end

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

@@ -1,5 +1,7 @@
 class Mumukit::Sync::Store::Github
   class GuideBuilder < OpenStruct
+    include Mumukit::Sync::Store::Github::WithSchema
+
     attr_writer :exercises
 
     def initialize(slug)
@@ -19,27 +21,24 @@ class Mumukit::Sync::Store::Github
       self.exercises << exercise
     end
 
+    def locale
+      meta['locale']
+    end
+
+    def language
+      meta['language']
+    end
+
     private
 
     def build_json
-      raise Mumukit::Sync::SyncError, "Missing guide language" if language[:name].blank?
-
-      {name: name,
-       description: description,
-       corollary: corollary,
-       language: language,
-       locale: locale,
-       type: type,
-       extra: extra,
-       beta: beta,
-       authors: authors,
-       collaborators: collaborators,
-       teacher_info: teacher_info,
-       id_format: id_format,
-       slug: slug,
-       expectations: expectations.to_a,
-       exercises: exercises.sort_by { |e| order.position_for(e[:id]) }}
+      raise Mumukit::Sync::SyncError, "Missing guide language" if language.blank?
+      file = build_fields_h(guide_schema.file_fields) { |field| self[field.reverse_name] }
+      metadata = build_fields_h(guide_schema.metadata_fields) { |field| self.meta[field.name.to_s] }
+      file.merge(metadata).merge(
+        expectations: expectations.to_a,
+        slug: slug,
+        exercises: exercises.sort_by { |e| order.position_for(e[:id]) }).compact
     end
-
   end
 end

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

@@ -1,5 +1,6 @@
 class Mumukit::Sync::Store::Github
   class GuideExport < Mumukit::Sync::Store::Github::Operation
+    include Mumukit::Sync::Store::Github::WithSchema
 
     attr_accessor :guide_resource_h, :bot, :author_email
 
@@ -39,7 +40,7 @@ class Mumukit::Sync::Store::Github
     end
 
     def clear_repo(local_repo)
-      local_repo.remove Mumukit::Sync::Store::Github::Schema::Guide.file_patterns
+      local_repo.remove guide_schema.file_patterns
     rescue Git::GitExecuteError => e
       puts 'Nothing to clean, repo seems to be empty'
     end

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

@@ -1,6 +1,7 @@
 class Mumukit::Sync::Store::Github
   class GuideReader
     include Mumukit::Sync::Store::Github::WithFileReading
+    include Mumukit::Sync::Store::Github::WithSchema
 
     attr_reader :dir
 
@@ -13,7 +14,7 @@ class Mumukit::Sync::Store::Github
       builder = GuideBuilder.new(@slug)
 
       read_guide_meta! builder
-      Mumukit::Sync::Store::Github::Schema::Guide.file_fields.each do |it|
+      guide_schema.file_fields.each do |it|
         value = it.read_field_file 'guide', dir
         builder[it.reverse_name] = value
       end
@@ -33,24 +34,18 @@ class Mumukit::Sync::Store::Github
 
     def read_guide_meta!(builder)
       meta = read_meta! 'guide', dir
+      meta['language'] &&= { name: meta['language'] }
+      read_legacy! meta
 
-      builder.language = { name: meta['language'] }
-      builder.locale = meta['locale']
+      builder.meta = meta
 
-      read! 'name', builder, meta
-      read! 'id_format', builder, meta
-      read! 'type', builder, meta
-      read! 'beta', builder, meta
-      read! 'teacher_info', builder, meta
-
-      read_legacy! builder, meta
 
       builder.order = Mumukit::Sync::Store::Github::Ordering.from meta['order']
     end
 
-    def read_legacy!(builder, meta)
-      builder.id_format ||= meta['original_id_format']
-      builder.type ||= meta['learning'] ? 'learning' : 'practice'
+    def read_legacy!(meta)
+      meta['id_format'] ||= meta['original_id_format']
+      meta['type'] ||= meta['learning'] ? 'learning' : 'practice'
     end
 
     def read!(key, builder, meta)
@@ -74,7 +69,7 @@ class Mumukit::Sync::Store::Github
         builder.id = id
         builder.name = meta['name'] || name
 
-        Mumukit::Sync::Store::Github::Schema::Exercise.file_fields.each do |it|
+        exercise_schema.file_fields.each do |it|
           value = it.read_field_file "exercise #{name}", root
           builder[it.reverse_name] = value
         end

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

@@ -1,5 +1,7 @@
 class Mumukit::Sync::Store::Github
   class GuideWriter
+    include Mumukit::Sync::Store::Github::WithSchema
+
     attr_accessor :dir
 
     def initialize(dir)
@@ -26,8 +28,8 @@ class Mumukit::Sync::Store::Github
       end
       write_licenses!(guide)
 
-      write_metadata_fields! dir, Mumukit::Sync::Store::Github::Schema::Guide, guide
-      write_file_fields! dir, Mumukit::Sync::Store::Github::Schema::Guide, guide, guide[:language]
+      write_metadata_fields! dir, guide_schema, guide
+      write_file_fields! dir, guide_schema, guide, guide[:language]
     end
 
     def format_id(guide, exercise)
@@ -39,8 +41,8 @@ class Mumukit::Sync::Store::Github
 
       FileUtils.mkdir_p dirname
 
-      write_metadata_fields! dirname, Mumukit::Sync::Store::Github::Schema::Exercise, e
-      write_file_fields! dirname, Mumukit::Sync::Store::Github::Schema::Exercise, e, (e[:language] || guide[:language])
+      write_metadata_fields! dirname, exercise_schema, e
+      write_file_fields! dirname, exercise_schema, e, (e[:language] || guide[:language])
     end
 
     def write_licenses!(guide)

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

@@ -129,6 +129,3 @@ class Mumukit::Sync::Store::Github
     end
   end
 end
-
-require_relative './schema/exercise'
-require_relative './schema/guide'

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

@@ -3,6 +3,8 @@ module Mumukit::Sync::Store
   ## This Store enables importing and exporting content
   ## from and to Github
   class Github
+    extend Mumukit::Core::Configurable
+
     def initialize(bot, author_email = nil, web_hook_base_url = nil)
       @bot = bot
       @author_email = author_email || bot.email
@@ -32,11 +34,16 @@ module Mumukit::Sync::Store
         web_hook_base_url: @web_hook_base_url,
         bot: @bot).run!
     end
+
+    def self.defaults
+      struct
+    end
   end
 end
 
 require 'mumukit/auth'
 
+require_relative './with_schema'
 require_relative './github/bot'
 require_relative './github/git_lib'
 require_relative './github/with_file_reading'

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

@@ -0,0 +1,14 @@
+module Mumukit::Sync::Store::Github::WithSchema
+  def exercise_schema
+    Mumukit::Sync::Store::Github.config.exercise_schema
+  end
+
+  def guide_schema
+    Mumukit::Sync::Store::Github.config.guide_schema
+  end
+
+  def build_fields_h(fields)
+    fields.map { |field| [field.reverse_name, yield(field)] }.to_h
+  end
+end
+

data/lib/mumukit/sync/store.rb

@@ -17,7 +17,5 @@ require_relative './store/base'
 require_relative './store/null'
 require_relative './store/github'
 require_relative './store/json'
-require_relative './store/thesaurus'
 require_relative './store/with_wrapped_language'
 require_relative './store/with_filtered_id'
-require_relative './store/bibliotheca'

data/lib/mumukit/sync/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Sync
-    VERSION = '0.4.1'
+    VERSION = '1.0.0'
   end
 end

data/mumukit-sync.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'git', '~> 1.5'
   spec.add_dependency 'octokit', '~> 4.1'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-sync
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Franco Bulgarelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit-core
@@ -84,14 +84,14 @@ dependencies:
   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
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -147,7 +148,6 @@ files:
 - lib/mumukit/sync/inflator/single_choice.rb
 - lib/mumukit/sync/store.rb
 - lib/mumukit/sync/store/base.rb
-- lib/mumukit/sync/store/bibliotheca.rb
 - lib/mumukit/sync/store/github.rb
 - lib/mumukit/sync/store/github/bot.rb
 - lib/mumukit/sync/store/github/exercise_builder.rb
@@ -163,13 +163,11 @@ files:
 - lib/mumukit/sync/store/github/operation.rb
 - lib/mumukit/sync/store/github/ordering.rb
 - lib/mumukit/sync/store/github/schema.rb
-- lib/mumukit/sync/store/github/schema/exercise.rb
-- lib/mumukit/sync/store/github/schema/guide.rb
 - lib/mumukit/sync/store/github/with_file_reading.rb
 - lib/mumukit/sync/store/json.rb
 - lib/mumukit/sync/store/null.rb
-- lib/mumukit/sync/store/thesaurus.rb
 - lib/mumukit/sync/store/with_filtered_id.rb
+- lib/mumukit/sync/store/with_schema.rb
 - lib/mumukit/sync/store/with_wrapped_language.rb
 - lib/mumukit/sync/syncer.rb
 - lib/mumukit/sync/version.rb
@@ -193,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Synchronization tool for resources

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

@@ -1,29 +0,0 @@
-module Mumukit::Sync::Store
-
-  ## This Store enables importing content
-  ## from Bibliotheca API
-  class Bibliotheca < Mumukit::Sync::Store::Base
-    include Mumukit::Sync::Store::WithWrappedLanguage
-    include Mumukit::Sync::Store::WithFilteredId
-
-    def initialize(bibliotheca_bridge)
-      @bibliotheca_bridge = bibliotheca_bridge
-    end
-
-    def sync_keys
-      %w(guide topic book).flat_map do |kind|
-        @bibliotheca_bridge
-          .send(kind.as_variable_name.pluralize)
-          .map { |it| Mumukit::Sync.key kind, it['slug']  }
-      end
-    end
-
-    def do_read(sync_key)
-      @bibliotheca_bridge.send(sync_key.kind.as_variable_name, sync_key.id)
-    end
-
-    def write_resource!(*)
-      Mumukit::Sync::Store.read_only!
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-module Mumukit::Sync::Store::Github::Schema::Exercise
-  extend Mumukit::Sync::Store::Github::Schema
-
-  def self.fields_schema
-    [
-      {name: :id, kind: :special},
-      {name: :name, kind: :special},
-
-      {name: :tags, kind: :metadata, reverse: :tag_list, transform: with { |it| it.to_a }},
-      {name: :layout, kind: :metadata},
-      {name: :editor, kind: :metadata},
-
-      {name: :type, kind: :metadata},
-      {name: :extra_visible, kind: :metadata},
-      {name: :language, kind: :metadata, transform: name },
-      {name: :teacher_info, kind: :metadata},
-      {name: :manual_evaluation, kind: :metadata},
-      {name: :choices, kind: :metadata},
-
-      {name: :expectations,     kind: :file, extension: 'yml', transform: yaml_list('expectations')},
-      {name: :assistance_rules, kind: :file, extension: 'yml', transform: yaml_list('rules')},
-      {name: :randomizations,   kind: :file, extension: 'yml', transform: yaml_hash},
-
-      {name: :goal, kind: :metadata},
-      {name: :test, kind: :file, extension: :test},
-      {name: :extra, kind: :file, extension: :code},
-      {name: :default, kind: :file, extension: :code, reverse: :default_content},
-
-      {name: :description, kind: :file, extension: 'md', required: true},
-      {name: :hint, kind: :file, extension: 'md'},
-      {name: :corollary, kind: :file, extension: 'md'},
-      {name: :initial_state, kind: :file, extension: 'md'},
-      {name: :final_state, kind: :file, extension: 'md'},
-      {name: :free_form_editor_source, kind: :file, extension: 'html'}
-    ]
-  end
-end

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

@@ -1,34 +0,0 @@
-module Mumukit::Sync::Store::Github::Schema::Guide
-  extend Mumukit::Sync::Store::Github::Schema
-
-  def self.fields_schema
-    [
-      {name: :exercises, kind: :special},
-      {name: :id, kind: :special},
-      {name: :slug, kind: :special},
-
-      {name: :name, kind: :metadata},
-      {name: :locale, kind: :metadata},
-      {name: :type, kind: :metadata},
-      {name: :beta, kind: :metadata},
-      {name: :teacher_info, kind: :metadata},
-      {name: :language, kind: :metadata, transform: name },
-      {name: :id_format, kind: :metadata},
-      {name: :order, kind: :metadata, transform: with { |it| it.map { |e| e[:id] } }, reverse: :exercises},
-      {name: :private, kind: :metadata},
-
-      {name: :expectations, kind: :file, extension: 'yml', transform: yaml_list('expectations')},
-      {name: :description, kind: :file, extension: 'md', required: true},
-      {name: :corollary, kind: :file, extension: 'md'},
-      {name: :sources, kind: :file, extension: 'md'},
-      {name: :learn_more, kind: :file, extension: 'md'},
-      {name: :extra, kind: :file, extension: :code},
-      {name: :AUTHORS, kind: :file, extension: 'txt', reverse: :authors},
-      {name: :COLLABORATORS, kind: :file, extension: 'txt', reverse: :collaborators}
-    ]
-  end
-
-  def self.fixed_file_patterns
-    %w(LICENSE.txt README.md COPYRIGHT.txt meta.yml *_*/*)
-  end
-end

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

@@ -1,27 +0,0 @@
-module Mumukit::Sync::Store
-
-  ## This Store enables importing languages
-  ## from Thesaurus API
-  class Thesaurus < Mumukit::Sync::Store::Base
-    def initialize(thesaurus_bridge)
-      @thesaurus_bridge = thesaurus_bridge
-    end
-
-    def sync_keys
-      @thesaurus_bridge.runners.map { |it| Mumukit::Sync.key(:language, it) }
-    end
-
-    def do_read(sync_key)
-      return unless sync_key.kind.like? :language
-      # the only difference between an `importable_info`
-      # and a `resource_h` is the way `runner_url` is named
-      Mumukit::Bridge::Runner.new(sync_key.id)
-        .importable_info
-        .replace_key(:test_runner_url, :runner_url)
-    end
-
-    def write_resource!(*)
-      Mumukit::Sync::Store.read_only!
-    end
-  end
-end