Changed readme and comments for sanboxing and wrappers

Author: tshemsedinov

interfaceWrapper/en/README.md

@@ -1,12 +1,16 @@
 ## Description
 
+## Files
+
 * `framework.js` - small piece of the framework, just to demonstrate wrapper
 * `application.js` - small piece of the application for wrapper demonstration
 
 ## How to execute
 
 From the command line, type: `node application` then `node framework`, compare
 output, read code in `framework.js` and `application.js`, try to understand
-how wrapper works for setTimeout
+how wrapper works for `setTimeout`
 
 ## Tasks
+
+## Additional tasks

interfaceWrapper/en/application.js

@@ -1,10 +1,17 @@
-// Print from the global context of application module
+// Print something
 console.log('From application global context');
 
 // Declare function for timer event
 function timerEvent() {
   console.log('From application timer event');
 }
 
-// Set function to timer event for 1sec
+// Create timer
 setTimeout(timerEvent, 1000);
+
+// Example for fs API
+var fileName = './README.md';
+console.log('Application going to read ' + fileName);
+fs.readFile(fileName, function(err, src) {
+  console.log('File ' + fileName + ' size ' + src.length);
+});

interfaceWrapper/en/framework.js

@@ -1,31 +1,33 @@
-// Example: function wrapper in sandboxed context
+// Wrapping function and interface example
 
 var fs = require('fs'),
     vm = require('vm');
 
-// Declare dictionary to convert it into sandboxed context
+// Create a hash for application sandbox
 var context = {
   module: {},
   console: console,
-  // Declare wrapper function for setTimeout
+  // Forward link to fs API into sandbox
+  fs: fs,
+  // Wrapper for setTimeout in sandbox
   setTimeout: function(callback, timeout) {
-    // Add some behaviour for setTimeout
+    // Logging all setTimeout calls
     console.log(
       'Call: setTimeout, ' +
       'callback function: ' + callback.name + ', ' +
       'timeout: ' + timeout
     );
     setTimeout(function() {
-      // Add some behaviour on event
+      // Logging timer events before application event
       console.log('Event: setTimeout, before callback');
-      // Call of orignal user-defined callback, passed to wrapper
+      // Calling user-defined timer event
       callback();
       console.log('Event: setTimeout, after callback');
     }, timeout);
   }
 };
 
-// Convert collection into sandboxed context
+// Turn hash into context
 context.global = context;
 var sandbox = vm.createContext(context);
 

interfaceWrapper/ru/README.md

@@ -1,13 +1,20 @@
 ## Описание
 
+Цель работы: научиться оборачивать интерфейсы и добиться такой универсальности
+обертки, чтобы не зависеть от того, какой именно интерфейс она оборачивает.
+В качестве примера обернута одна функция `setTimeout`, а в качестве задания мы
+обернем целый интерфейс работы с файловой системой - библиотеку `fs`.
+
+## Файлы
+
 * `framework.js` - кусочек фреймворка, демонстрирующий обертку (wrapper)
 * `application.js` - часть приложения для демонстрации обертки
 
 ## Запуск
 
 Из командной строки пишем `node application`, а потом `node framework`,
 сравниваем вывод, смотрим код `framework.js` и `application.js`, понимаем
-как работает обертка вокруг setTimeout
+как работает обертка вокруг `setTimeout`
 
 ## Задание
 
@@ -66,13 +73,13 @@
   ```
 5. Определяем, есть ли среди аргументов `callback`, он всегда последний в
 массиве аргументов и его тип `function`. Если `callback` есть, то вместо него
-передаем свою функцию, которая логирует все аргументы и вызывает настояций
+передаем свою функцию, которая логирует все аргументы и вызывает настоящий
 `callback`.
 6. Теперь можно из `application.js` использовать другие функции `fs` и
 убедиться, что все они обернуты.
 7. Добавляем таймеры в `application.js` и на таймерах работаем с файлами, а из
 `framework.js` собираем статистику работы с файлами и выводим ее каждые 30
-секунд. Например, можно соирать несколько из этих параметров
+секунд. Например, можно собирать несколько из этих параметров
   - количество обращений к функциям,
   - количество колбэков,
   - среднюю скорость завершения функций,
@@ -85,3 +92,26 @@
 Сохраните наработки этой лабораторной работы, они понадобятся для выполнения
 следующих работ, в частности, работы по передаче вызовов в другой процесс и
 другой сервер. Это позволит распределить исполнение приложения.
+
+## Дополнительные задания
+
+8. Попробуйте подставить в качестве файловой системы свою структуру из памяти,
+и прочитать из нее при помощи `fs.readFile`, потом записать файл, создать и
+удалить. Пример структуры:
+
+  ```JavaScript
+  var virtualFs = {
+    folder: {
+      subfolder: {
+        file1: 'File content',
+        file2: 'Another file content'
+      },
+    },
+    notes: {
+      myToDos: 'Refactor projects, Prepare tests',
+      meetings: 'Meet thoughts at 10:00 walking along garden'
+    }
+  };
+  ```
+9. Реализуйте кеширование файловых операций в памяти.
+10. Напишите аналогичный пример на другом языке программирования.

interfaceWrapper/ru/framework.js

@@ -7,6 +7,7 @@ var fs = require('fs'),
 var context = {
   module: {},
   console: console,
+  // Помещаем ссылку на fs API в песочницу
   fs: fs,
   // Оборачиваем функцию setTimeout в песочнице
   setTimeout: function(callback, timeout) {

sandboxedModule/en/README.md

@@ -1,5 +1,12 @@
 ## Description
 
+Putpose: learn how to create sandboxed context for modues to separate them and
+minimize cross-modules code coupling, extracting at least two abstraction layers
+(applied and system) and how to execute applied code in virtual environment,
+changing its behavior using IoC from system layer.
+
+## Files
+
 * `framework.js` - small piece of the framework, just to demonstrate IoC
 * `application.js` - small piece of the application, also for IoC demonstration
 

sandboxedModule/ru/README.md

@@ -1,5 +1,12 @@
 ## Описание
 
+Цель: научиться создавать защищенные (экранированные) друг от друга контексты
+для библиотек, разделять код на два слоя абстракци (прикладной и системный) и
+запускать прикладной код в искуственной среде, меняя его поведение по принципу
+IoC из системного кода.
+
+## Файлы
+
 * `framework.js` - небольшая часть фреймворка, необходимая для демонстрации IoC
 * `application.js` - часть приложения для демонстрации IoC