mumukit-sync 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5a273da509a30c17365db8f990425f7116dc5ab6884ff21a75fd84c6d05f7a3
-  data.tar.gz: b1d81c933d5896316a560539126164926a0577dcf2970ea87f2dbd82f75df6ba
+  metadata.gz: 7feb07d1901e4d169f61f50b7d9d5e5b002ef659d7315fd78f06ca5506886e0a
+  data.tar.gz: dc32e9012638c59634d1e509ae95259e03353fc3301feaf94f3adc9effd29dd8
 SHA512:
-  metadata.gz: e08e6107f11396be371a1c049b4b3593e1c8e87d3e2dd2a51725734d2d35b8d993b7a66a92c55ea8b7cb4f9a46d2744efcdf8fae57866bf4f94478d2056b97ee
-  data.tar.gz: 4602d21980a71ed33b2d550f470af08fe8bfabcb0c1a6011c0317bdc525a59a7e4f4595fd03e0b5452b786e819fd79f34bd41a313127e2614c7e013333a8750f
+  metadata.gz: 7e12bc3c131aaa6f6aa623613daa615490b56d93b52c6a952eee900a91f6f30f65736e0c0d62a05e1da6d0169b40f6c6d8f2cf2fd368eec9fad6760029b4e9d8
+  data.tar.gz: 1bd94411302041cb9fa4c303a7ed7adfa58e67a7c5ef4d0d9d6a706c21b2e4c94112e8d94891c9606c4b5a1555bd3c617cafd677506362e8d7212582c315cbf5

data/lib/mumukit/sync.rb

@@ -26,6 +26,9 @@ module Mumukit
     def self.classify(kind)
       kind.as_module_name
     end
+
+    class SyncError < StandardError
+    end
   end
 end
 

data/lib/mumukit/sync/store.rb

@@ -2,6 +2,13 @@ require 'mumukit/bridge'
 
 module Mumukit::Sync
   module Store
+    def self.non_discoverable!
+      raise Mumukit::Sync::SyncError, 'Non-discoverable store'
+    end
+
+    def self.read_only!
+      raise Mumukit::Sync::SyncError, 'Read-only store'
+    end
   end
 end
 

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

@@ -23,7 +23,7 @@ module Mumukit::Sync::Store
     end
 
     def write_resource!(*)
-      raise 'Read-only store'
+      Mumukit::Sync::Store.read_only!
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Mumukit::Sync::Store
     end
 
     def sync_keys
-      raise 'Non-discoverable store'
+      Mumukit::Sync::Store.non_discoverable!
     end
 
     def read_resource(sync_key)

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

@@ -19,8 +19,8 @@ class Mumukit::Sync::Store::Github
       local_repo.config('user.email', email)
       yield dir, local_repo
     rescue Git::GitExecuteError => e
-      raise 'Repository is private or does not exist' if private_repo_error(e.message)
-      raise e
+      raise Mumukit::Sync::SyncError, 'Repository is private or does not exist' if private_repo_error(e.message)
+      raise Mumukit::Sync::SyncError, e
     end
 
     def register_post_commit_hook!(slug, web_hook_base_url)

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

@@ -22,6 +22,8 @@ class Mumukit::Sync::Store::Github
     private
 
     def build_json
+      raise Mumukit::Sync::SyncError, "Missing guide language" if language[:name].blank?
+
       {name: name,
        description: description,
        corollary: corollary,

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

@@ -39,7 +39,7 @@ class Mumukit::Sync::Store::Github
     end
 
     def clear_repo(local_repo)
-      local_repo.remove %w(LICENSE.txt README.md COPYRIGHT.txt AUTHORS.txt COLLABORATORS.txt description.md corollary.md meta.yml extra.yml expectations.* *_*/*)
+      local_repo.remove Mumukit::Sync::Store::Github::Schema::Guide.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

@@ -12,9 +12,9 @@ class Mumukit::Sync::Store::Github
     def read_guide!
       builder = GuideBuilder.new(@slug)
 
-      read_meta! builder
+      read_guide_meta! builder
       Mumukit::Sync::Store::Github::Schema::Guide.file_fields.each do |it|
-        value = it.read_field_file(dir)
+        value = it.read_field_file 'guide', dir
         builder[it.reverse_name] = value
       end
       read_exercises! builder
@@ -22,10 +22,17 @@ class Mumukit::Sync::Store::Github
       builder.build
     end
 
-    def read_meta!(builder)
+    def read_meta!(description, dir)
       meta = read_yaml_file(File.join(dir, 'meta.yml'))
+      raise Mumukit::Sync::SyncError, "Missing #{description} meta.yml" unless meta
 
-      raise 'Missing meta.yml' unless meta
+      meta
+    rescue Psych::SyntaxError
+      raise Mumukit::Sync::SyncError, "Bad #{description} metadata syntax"
+    end
+
+    def read_guide_meta!(builder)
+      meta = read_meta! 'guide', dir
 
       builder.language = { name: meta['language'] }
       builder.locale = meta['locale']
@@ -60,7 +67,7 @@ class Mumukit::Sync::Store::Github
       each_exercise_file do |root, position, id, name|
         builder = ExerciseBuilder.new
 
-        meta = read_yaml_file(File.join(root, 'meta.yml'))
+        meta = read_meta! "exercise #{name}", root
         meta['language'] &&= { name: meta['language'] }
 
         builder.meta = meta
@@ -68,7 +75,7 @@ class Mumukit::Sync::Store::Github
         builder.name = meta['name'] || name
 
         Mumukit::Sync::Store::Github::Schema::Exercise.file_fields.each do |it|
-          value = it.read_field_file(root)
+          value = it.read_field_file "exercise #{name}", root
           builder[it.reverse_name] = value
         end
         yield builder

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

@@ -32,6 +32,14 @@ class Mumukit::Sync::Store::Github
       fields.select { |it| it.kind == :file }
     end
 
+    def file_patterns
+      file_fields.map(&:get_file_pattern) + fixed_file_patterns
+    end
+
+    def fixed_file_patterns
+      []
+    end
+
     def fields
       @field ||= fields_schema.map { |it| new_field(it) }
     end
@@ -74,6 +82,9 @@ class Mumukit::Sync::Store::Github
       end
 
       ## Writing fields to Github
+      def get_file_pattern
+        get_file_name extension: '*', test_extension: '*'
+      end
 
       def get_file_name(language)
         "#{name}.#{get_file_extension(language)}"
@@ -100,19 +111,19 @@ class Mumukit::Sync::Store::Github
 
       ## Reading fields from Github
 
-      def find_file_name(root)
+      def find_file_name(description, root)
         files = Dir.glob("#{root}/#{name}.*")
         if files.length == 1
           files[0]
         elsif files.empty? && required
-          raise "Missing #{name} file"
+          raise Mumukit::Sync::SyncError, "Missing #{description} #{name} file"
         else
           nil
         end
       end
 
-      def read_field_file(root)
-        find_file_name(root).try { |it| safe_transform.from.call it }
+      def read_field_file(description, root)
+        find_file_name(description, root).try { |it| safe_transform.from.call it }
       end
 
     end

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

@@ -16,13 +16,19 @@ module Mumukit::Sync::Store::Github::Schema::Guide
       {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},
 
+      {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/json.rb

@@ -5,7 +5,7 @@ module Mumukit::Sync::Store
     end
 
     def sync_keys
-      raise 'Non-discoverable store'
+      Mumukit::Sync::Store.non_discoverable!
     end
 
     def do_read(_sync_key)
@@ -13,7 +13,7 @@ module Mumukit::Sync::Store
     end
 
     def write_resource!(*)
-      raise 'Read-only store'
+      Mumukit::Sync::Store.read_only!
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Mumukit::Sync::Store
     end
 
     def read_resource(key)
-      raise "#{key.kind} #{key.id} not found"
+      raise Mumukit::Sync::SyncError, "Non-readable store"
     end
   end
 end

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

@@ -21,7 +21,7 @@ module Mumukit::Sync::Store
     end
 
     def write_resource!(*)
-      raise 'Read-only store'
+      Mumukit::Sync::Store.read_only!
     end
   end
 end

data/lib/mumukit/sync/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Sync
-    VERSION = '0.3.5'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-sync
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Franco Bulgarelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit-core