После многих лет (буквально) мучительного выбора, где же мне публиковаться, я остановился на варианте с собственным статическим веб-сайтом, где статьи я буду писать на своём компьютере в своём текстовом редакторе, в Markdown.
Новый адрес моего блога https://hijarian.info. На блоггере я больше писать не буду.
Сайт собирается из материалов в разметке Markdown силами утилиты Hugo. Публикуется на Netlify.
Okay, today's the task: pushing all of 1892 files of Yii framework to the Git repository is a burden, and upgrading it to new version pollutes the git log with changes to files you don't care about. Let's package it into a PHAR!
Rasmus Schultz made a special script to package the Yii framework into a PHAR archive. I forked it to save for a future (at least my GitHub account will live as long as this blog).
You need just to put this script to the root of Yii codebase (cloned github repo, for example), and run it as usual:
php yii-phar.php
This will create the PHAR archive in the same directory.
Hovewer, beware the catch 1: PHP can refuse to create packed archive, emitting the following error:
PHP Fatal error: Uncaught exception 'BadMethodCallException'
with message 'unable to create temporary file'
in /path/to/your/yii/root/yii-phar.php:142
Stack trace:
#0 /path/to/your/yii/root/yii-phar.php(142): Phar->compressFiles(4096)
#1 {main}
thrown in /parh/to/your/yii/root/yii-phar.php on line 142
I decided to just remove lines 140 and 142 from the script:
echo "Compressing files ...\n\n"; $phar->compressFiles($mode);
And that's all. I can bear with 20 MB file in repo, and don't really care about compression.
To connect the resulting PHAR to your Yii application, replace your usual:
require_once('/path/to/your/yii/framework/yii.php');
With the following:
new Phar('/path/to/yii.phar');
require_once('phar://yii/yii.php');
Note that in new Phar() invocation you should use real path to your phar archive file, but second line should be written verbatim, as the PHAR which becomes created is being made with alias 'yii', using feature described in the documentation for Phar::__construct.
However, of course, there's a catch 2: Yii built-in asset manager (CAssetManager) has too specific `publish` method, unable to cope with custom PHP streams. So, we need the fixed version.
I decided to create a descendant of `CAssetManager` descriptively called `PharCompatibleAssetManager` with the following definition exactly:
/**
* Class PharCompatibleAssetManager
*
* As we use Yii packaged into .phar archive, we need to make changes into the Asset Manager,
* according to the https://code.google.com/p/yii/issues/detail?id=3104
*
* Details about packaging Yii into .phar archive can be found at
* https://gist.github.com/mindplay-dk/1607318
*/
class PharCompatibleAssetManager extends CAssetManager
{
protected $_published = array();
public function publish($path,$hashByName=false,$level=-1,$forceCopy=null)
{
if($forceCopy===null)
$forceCopy=$this->forceCopy;
if($forceCopy && $this->linkAssets)
throw new CException(Yii::t('yii','The "forceCopy" and "linkAssets" cannot be both true.'));
if(isset($this->_published[$path]))
return $this->_published[$path];
$isPhar = strncmp('phar://', $path, 7) === 0;
$src = $isPhar ? $path : realpath($path);
if ($isPhar && $this->linkAssets)
{
throw new CException(
Yii::t(
'yii',
'The asset "{asset}" cannot be published using symlink, because the file resides in a phar.',
array('{asset}' => $path)
)
);
}
if ($src !== false || $isPhar)
{
$dir=$this->generatePath($src,$hashByName);
$dstDir=$this->getBasePath().DIRECTORY_SEPARATOR.$dir;
if(is_file($src))
{
$fileName=basename($src);
$dstFile=$dstDir.DIRECTORY_SEPARATOR.$fileName;
if(!is_dir($dstDir))
{
mkdir($dstDir,$this->newDirMode,true);
@chmod($dstDir,$this->newDirMode);
}
if($this->linkAssets && !is_file($dstFile)) symlink($src,$dstFile);
elseif(@filemtime($dstFile)<@filemtime($src))
{
copy($src,$dstFile);
@chmod($dstFile,$this->newFileMode);
}
return $this->_published[$path]=$this->getBaseUrl()."/$dir/$fileName";
}
elseif(is_dir($src))
{
if($this->linkAssets && !is_dir($dstDir))
{
symlink($src,$dstDir);
}
elseif(!is_dir($dstDir) || $forceCopy)
{
CFileHelper::copyDirectory($src,$dstDir,array(
'exclude'=>$this->excludeFiles,
'level'=>$level,
'newDirMode'=>$this->newDirMode,
'newFileMode'=>$this->newFileMode,
));
}
return $this->_published[$path]=$this->getBaseUrl().'/'.$dir;
}
}
throw new CException(Yii::t('yii','The asset "{asset}" to be published does not exist.',
array('{asset}'=>$path)));
}
}
I'm really, really sorry that you had to read this traditionally horrible Yii code, but that was inevitable... :(
Main change was starting from the $isPhar = strncmp('phar://', $path, 7) === 0; part.
Now just link this asset manager instead of built-in one:
config/main.php:
'components' => array(
'assetManager' => array(
'class' => 'your.alias.path.to.PharCompatibleAssetManager',
),
)
Now your Yii web application uses phar archive instead of huge pile of separate files. They say that this increases performance, but my personal reasons was just to reduce the number of files inside the repository.
Today's guess is this: you have a test harness which utilizes the database, and it has enough test cases in it for full test run to be so slow you cringe at the very thought of launching it.
We discuss a lifehack-style solution to this problem: putting the DBMS which will be used by our test harness completely on a RAM disk, so it'll operate from much faster memory than the hard drive (even faster than from SSD).
Main issue is this: as you probably need only a test datasets at ramdisk, and only for a period of running test suite, you will need separate DBMS instances to work on ramdisk, not the ones already installed on your system.
Here we'll look at how to prepare MySQL and MongoDB instances to work on ramdisk.
In the end you'll get the special preparation script which you should launch before your tests. After this, your test suite will run with the isolated MySQL and MongoDB instances on top of ramdisk.
If your test suite has large quantities of integration tests using databases, this will greatly increase the speed of test run. It is reported in one particular case that the drop in run time was from 1:30 to 18 seconds, 5 times faster.
You should have a *nix system as a MySQL Sandbox (see below) works only there. OSX probably will do, too.
This system should have some bash-like shell (obviously) and Perl installed.
Kernel should have tmpfs support.
Your nonprivileged user should be able to mount filesystems, or you'll need to hack the script to introduce sudo at mount step (assuming your user can sudo).
For isolated MySQL instance you need the MySQL distirbutive downloaded from the website. For isolated MongoDB instance you need the MongoDB distirbutive downloaded from the website. Note, however, that the whole MongoDB server is contained in just a single binary file ~8MB in size.
Of course as we will work completely in memory you have to be sure that you have enough RAM to store your (presumably test) datasets.
Making ramdisk is very simple with latest Linux:
mount -t tmpfs $RAMDISK_NAME $RAMDISK_DIR
as root.
RAMDISK_NAME is some identifier for mountpoints table.
RAMDISK_DIR is the directory which will be turned into RAM-based filesystem.
After this mount action, anything you put into RAMDISK_DIR will be placed into memory, without interaction with the physical hard drive.
Of course, it means that after unmounting the ramdisk everything which was in it will be lost.
Just unmount the created mount point:
umount $RAMDISK_NAME
as root.
Note that you probably should stop all running services which still use the ramdisk prior to unmounting!
We'll use the MySQL Sandbox project to launch isolated MySQL instances.
For it to work you need the MySQL distirbutive downloaded from the website.
MySQL Sandbox is installed with the following command:
# cpan MySQL::Sandbox
as root, and you'll need to run it as follows:
SANDBOX_HOME="$RAMDISK_DIR" make_sandbox "$MYSQL_PACKAGE" -- \
--sandbox_port="$MYSQL_PORT_DESIRED" --sandbox_directory="$MYSQL_DIRNAME"
It's a one-liner split to two lines for readability.
Note that you need root privileges only to install the MySQL Sandbox application itself, all further communication with it will be done from unprivileged account, most possibly the same under which you launch the test suite.
We need to set the SANDBOX_HOME variable prior to launching the sandbox factory because that's how we control where it'll put the sandboxed MySQL instance. By default it'll use $HOME/sandboxes, which is probably not what you need.
Note that RAMDISK_DIR is the same directory that the one we prepared in previous step.
MYSQL_PACKAGE is a full path to the MySQL distirbutive package downloaded from website.
Please note that MySQL Sandbox will unpack it to the same directory and will essentially use this unpacked contents to launch the sandboxed MySQL.
So, probably, you'll need to move the package to ramdisk, too, to increase performance of actually launching and running the MySQL server itself, however, note that unpacked 5.6.0 contents are 1GB in size.
Remember the MYSQL_PORT_DESIRED value you use here, because you'll need to use it to configure your test suite to point at correct MySQL instance.
MYSQL_DIRNAME is of least importance here, because it's just a name of a subfolder under the SANDBOX_HOME in which this particular sandbox will be put.
After make_sandbox ended it's routine you can check that your sandbox is indeed working by running:
"$RAMDISK_DIR/$MYSQL_DIRNAME/use"
You should use the following credentials to connect to sandboxed MySQL:
* host : '127.0.0.1'
* port : $MYSQL_PORT_DESIRED
* username : 'msandbox'
* password : 'msandbox'
Please note that you must use 127.0.0.1 value for host and not a localhost as usual, because of sandbox internal security configuration.
To shutdown the sandboxed MySQL, issue the following command:
"$RAMDISK_DIR/$MYSQL_DIRNAME/stop"
or more forceful
"$RAMDISK_DIR/$MYSQL_DIRNAME/send_kill"
This commands are needed mostly to stop the working daemon; after the unmounting of ramdisk all of sandbox data will be purged out of existence.
MongoDB server is contained in just a single binary file so it'll be a lot more easier compared to MySQL.
You'll need the MongoDB distirbutive downloaded from the website, too. This time unpack it to some directory.
After that, you can launch a separate instance of MongoDB with the following command:
"$MONGODB_BIN" --dbpath="$MONGODB_DIR" \
--pidfilepath="$MONGODB_DIR/mongodb.pid \
--port $MONGODB_PORT_DESIRED \
--fork --logpath="$MONGODB_DIR/mongodb.log"
MONGODB_BIN is a /bin/mongod path preceded by the full path to the unpacked MongoDB distributive.
Here you can even use your system MongoDB package, in case you have it installed.
As a full example, MONGODB_BIN can have a value of ~/systems/mongodb-linux-x86_64-2.4.4/bin/mongod
MONGODB_DIR is a path to directory under RAMDISK_DIR to which this MongoDB instance should put it's files.
For example, it can be just a $RAMDISK_DIR/mongo.
As with MySQL, MONGODB_PORT_DESIRED is a crucial parameter to specify the correct MongoDB instance to connect to.
Remember it as you will need to set it up in your test suite.
By default MongoDB do not enforce any usernames or passwords so you need to just use the hostname and port parameters.
* host : 'localhost'
* port : $MONGODB_PORT_DESIRED
For example, for PHP Mongo extension, you get a connection to this instance as follows:
$connection = new MongoClient("mongodb://localhost:$MONGODB_PORT_DESIRED");
As you provided the --pidfilepath commandline argument when launching the MongoDB server, the following command should do the trick:
cat "$MONGODB_DIR/mongodb.pid" | xargs kill ; rm "$MONGODB_DIR/mongob.pid"
Essentially we are feeding the kill command with the contents of pidfile and removing it afterwards.
There is a GitHub repository with the example scripts nicely laid out along with the comments.
There are three scripts:
db_sandbox_properties.sh: this is the all variable parameters you need to properly setup the sandboxes.db_sandbox_start.sh: this script you run before your test suite.
It was updated with the command to copy the tables schema from source MySQL instance to sandbox MySQL instance, so, if you have an accessible up-to-date MySQL instance with the schema for your tests, this script will copy schema to sandbox so you will have a DB ready to accept test cases.
NOTE that you will need the sudo rights for your unprivileged user to successfully mount the ramdisk.
If you do not have them, you can hack the mount command in any way you see sufficient to successfully mount the ramdisk.
db_sandbox_stop.sh: this script you run when you don't need the sandbox anymore. It'll stop both MySQL and MongoDB and unmount the ramdisk (note that you'll need the sudo rights for this, too).
Допустим, хочется что-то запускать прямо при старте Debian. Вот необходимые действия для этого:
# vim /etc/init.d/myscript # chmod +x /etc/init.d/myscript # insserv myscript
В файле /etc/init.d/myscript должно быть по минимуму следующее:
#!/bin/sh
### BEGIN INIT INFO
# Provides: myscript
# Required-Start: $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Run some stuff
# Description: Some descriptions
### END INIT INFO
Подробности об этой шапке можно прочитать в вики Debian. Название скрипта myscript должно быть в точности повторено в названии файла скрипта, в поле Provides и при вызове insserv.
Ранлевелы можно посмотреть здесь: http://wiki.debian.org/RunLevel.
Когда-то написал небольшую программку для сообщества игры Prime World. Она парсит таблицу рейтингов и составляет по ней линейные графики, плюс вычислят средний рейтинг (в рейтинге указываются первые 25 мест) по каждому персонажу. Персонажей 62, соответственно, линий на графике тоже 62. :)
Здесь напишу, как и из чего сделал и как оно работает.
Полный исходный код выложил к себе на GitHub.
План был такой: приложение представляет собой одну HTML страницу, с одним файлом CSS и одним Javascript.
При загрузке страницы яваскрипт сразу делает AJAX-запрос на бэкэнд за данными.
Бэкэнд грабит исходную HTML-страницу, при помощи XPath выбирает значения рейтингов, имена игроков, места и имена персонажей. Затем кодирует это всё в JSON и отправляет скрипту обратно.
Скрипт отрисовывает полученные от бэкэнда рейтинги в виде графика при помощи библиотеки Highcharts. Дополнительно бэкэнд возвращает вычисленные средние значения рейтинга; они отображаются в виде таблицы, которая обрабатывается javascript библиотекой DataTables, чтобы добавить сортировку.
Между таблицей и графиком переключаемся кнопками.
Как я уже сказал, приложение достаточно маленькое.
В качестве недостатка можно упомянуть то, что каждый раз, когда приложение открывается, делается запрос на исходный сайт Нивала. Делать так, конечно, дурной тон, и стоит прикрутить какое-нибудь кэширование на стороне сервера. Хотя у них всё равно топ-25 не так часто обновляется, да и посещаемость никакая, так что для начала сойдёт.
Серверная часть основана на Hunchentoot, то есть, мы сами себе веб-сервер.
Вот все необходимые URL:
/, по которому возвращается HTML страница приложения./data, который AJAX endpoint, возвращающий JSON объект с данными/assets/scripts.js, клиентский скрипт, который раскладывает данные из JSON в график и таблицу/assets/styles.css, бумажка со стилями (с украшениями я не парился, в стилях только сокрытие некоторых элементов для инициализации интерфейса)./assets/loading.gif, показываем эту картинку пока /data грузится./favicon.ico, иконка до кучи, честно стырил из пакета Html5 Boilerplate.Хостимся на Heroku.
Сам парсинг исходной веб-страницы полностью заключён в одном файле под названием dno.lisp, и единственная функция, которая оттуда нужна публично, это send-data-from-origin-as-json, которая генерирует строку в JSON формате, содержащую данные, нужные в scripts.js для того, чтобы построить графики и таблицу.
Сам файл dno.lisp можно посмотреть в репозитарии на гитхабе, я здесь его приводить не буду, слишком большой.
В итоге мы можем делать (load "dno.lisp") и получать с этого функцию, которая даст нам JSON, который мы можем возвращать как результат AJAX запроса, то есть, то, что нужно для пункта 2.
В идеологии hunchentoot'а (если не углубляться в детали), инициализация приложения выглядит так:
Настраиваем все пути в приложении, вызывая hunchentoot:create-folder-dispatcher-and-handler, hunchentoot-create-static-file-dispatcher-and-handler, hunchentoot:define-easy-handler и т. п.
Это как раз было упрощено при помощи хелперов в предыдущем пункте.
Создаём экземпляр приложения заклинанием:
(hunchentoot:start (make-instance 'hunchentoot:easy-acceptor
:port 4242)))
Для начала делаем три хелпера в отдельном файле, для того, чтобы добавление путей в Hunchentoot не было пыткой:
helpers.lisp
(defun publish-directory (uri dirname)
(push (hunchentoot:create-folder-dispatcher-and-handler uri dirname)
hunchentoot:*dispatch-table*))
(defun publish-file (uri filename)
(push (hunchentoot:create-static-file-dispatcher-and-handler uri filename)
hunchentoot:*dispatch-table*))
(defmacro publish-ajax-endpoint (uri name params &body body)
`(hunchentoot:define-easy-handler (,name :uri ,uri) ,params
(setf (hunchentoot:content-type*) "application/json")
,@body))
Имея эти три хелпера, файл инициализации, фактически, будет иметь следующий вид:
init.lisp
;; Webroot
(publish-file "/" "webroot/index.html")
;; Favicon, just because
(publish-file "/favicon.ico" "webroot/favicon.ico")
;; Images, CSS and JS files referenced from index.html
(publish-directory "/assets/" "assets/")
;; AJAX endpoint to grab data to display in chart
(publish-ajax-endpoint "/data" data () (send-data-from-origin-as-json))
(defun run ()
"Launch Hunchentoot web server instance on default port"
(hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port 4242)))
Само содержимое файлов index.html, scripts.js и styles.css можно посмотреть на гитхабе, здесь я описываю только то, как приложение собрано, а не как оно работает.
Мы не можем сделать (publish-directory "/" "webroot/"), потому что мы хотим дефолтный хэндлер для пути /.
Я завернул старт приложения в отдельную функцию (и не вызываю её сразу же), потому что так будет удобнее в дальнейшём.
Теперь мы можем делать так:
(load "dno.lisp")
(load "helpers.lisp")
(load "init.lisp")
(run)
После чего открываем браузер по адресу http://localhost:4242/ и наблюдаем готовое приложение, при условии, что в том же каталоге, что и эти два скрипта, находятся папки webroot и assets с соответствующими файлами в них.
Теперь запакуем всё в ASD. Вот моё определение приложения:
dno.asd
(asdf:defsystem #:dno
:serial t
:description "Presents ratings of players of Prime World as charts."
:author "Mark Safronov <hijarian@gmail.com>"
:license "Public Domain"
:depends-on (#:drakma
#:cl-ppcre
#:cl-libxml2
#:iterate
#:cl-json
#:hunchentoot)
:components ((:file "package")
(:module :src
:serial t
:components ((:file "helpers")
(:file "dno")
(:file "init")))))
package.lisp
(defpackage #:dno
(:export :run)
(:use #:cl
#:cl-user
#:hunchentoot))
Как видно, все три исходника на Common Lisp, описанные выше, были переложены в отдельный подкаталог src.
Понятное дело, во всех файлах теперь первой строчкой идёт вызов (in-package :dno).
Заметьте, что в ASD прописаны библиотеки, от которых зависит приложение (cl-ppcre, cl-libxml2, iterate и cl-json используются только в dno.lisp, на самом деле), однако сам пакет (package.lisp) не подключает эти библиотеки.
Это просто дело вкуса: я предпочитаю использовать символы из чужих пакетов по их полному имени, не сокращая.
Так сразу понятно, в какую документацию лезть.
Теперь у нас такая структура файлов:
assets/
scripts.js
styles.css
webroot/
index.html
favicon.ico
src/
dno.lisp
init.lisp
helpers.lisp
dno.asd
package.lisp
Так как у нас теперь определён ASD пакет, мы можем воспользоваться механизмами Quicklisp для того, чтобы максимально просто загружать приложение на локальной машине.
Если в рабочем каталоге Quicklisp в подкаталоге local-projects сделать символическую ссылку на каталог приложения, то можно будет подключать пакет приложения простым вызовом (ql:quickload :dno).
Таким образом, кладём в корневой каталог приложения следующий скрипт запуска:
runner.lisp
(in-package :cl-user)
(ql:quickload :dno)
(dno:run)
Теперь видно, зачем нужна отдельная функция run, определённая в init.lisp: для того, чтобы разделить загрузку самого приложения в рантайм и запуск приложения как веб-сервера.
Всё, готовое веб-приложение можно запустить из консоли, например, так:
$ cd path/to/dno/app
$ sbcl
* (load "runner.lisp")
Понятное дело, вместо SBCL может быть любой Лисп на ваш выбор.
Консоль становится неюзабельной после этого. Когда понадобится загасить приложение — нажатие Ctrl+D убивает приложение вместе с рантаймом лиспа.
Благодаря специальному buildpack'у для CL появилась возможность хостить SBCL + Hunchentoot приложения на Heroku.
Для этого нужно подготовить приложение следующим образом:
heroku create -s cedar --buildpack http://github.com/jsmpereira/heroku-buildpack-cl.git. Запоминаем название проги, которое Heroku нам сгенерировало.heroku labs:enable user-env-compile -a myapp, вместо myapp пишем название проги из п.2.heroku config:add CL_IMPL=sbclheroku config:add CL_WEBSERVER=hunchentootheroku config:add LANG=en_US.UTF-8Теперь в корневом каталоге приложения нужно добавить следующий скрипт, который ожидает buildpack:
heroku-setup.lisp
(in-package :cl-user)
(load (merge-pathnames *build-dir* "dno.asd"))
(ql:quickload :dno)
Крайне важно то, что этот скрипт не выполняет (dno:run), как это делает runner.lisp, потому что buildpack сам запустит Hunchentoot, так что от init.lisp требуется только настроить пути.
После того, как этот скрипт добавлен в репозитарий (имя heroku-setup.lisp имеет значение), можно пушить: git push heroku master, при условии, что п. 1 выполнен полностью.
Всё, теперь прога готова, есть как возможность запустить на локальной машине, так и деплой сразу в Сеть (доменное имя тоже вполне приличное получается).
По тому же принципу можно строить любые другие простые веб-приложения, добавляя в init.lisp определения для путей в приложении.
Конечно же, если прога сложная, то придётся делать какой-то кустарный роутер, а также скорее всего, не отдавать статичные HTML файлы, а генерировать страницы при помощи какого-нибудь шаблонизатора типа CL-WHO, CL-EMB или чего-то подобного. Яваскрипт и CSS тоже можно генерировать прямо из Common Lisp, для этого есть проекты Parenscript и css-lite соответственно.
Мне всё это не понадобилось, приложение достаточно простое чтобы сразу отдавать статичные ассеты и HTML.
Допустим, у вас верстается книга достаточно большого объёма и вы структурировали её двумя уровнями иерархии. Главный файл лежит в корневом каталоге и называется videogamebook2.tex. Он вызывает глобальные макросы типа \documentclass и затем подключает главы следующим образом:
...
\input{preface}
\input{moo2/chapter}
\input{planescape/chapter}
...
То есть, каждая отдельная "глава" книги лежит в отдельной папке, и её главный файл называется chapter.tex.
Эти файлы глав содержат вызовы макросов, локальные для главы, и затем подключают разделы. Разделы в таком случае нужно подключать так:
...
\input{moo2/section-01/section}
\input{moo2/section-02/section}
...
Видно, что разделы также лежат каждый в своей подпапке и файлы называются просто section.tex.
Заметьте, что пути всё ещё начинаются от корневого каталога проекта (!).
Довольно очевидно, что если вы хотите разбивать разделы более низкого уровня так же по отдельным файлам, вам придётся сохранять такой стиль указания путей.
Усложним задачу: допустим, мы хотим иллюстрировать наш текст, используя стандартный пакет graphicx. Иллюстрации, соответствующие разделу, у нас лежат в подкаталоге этого раздела, рядом с файлом section.tex.
Тогда в заголовке section.tex можно написать, что:
\graphicspath{{./moo2/section-01/}}а в тексте писать просто
\includegraphics{start-galaxy.jpg}То есть, путь надо писать опять-таки от корня, и обязательно завершать слешем, иначе LaTeX вас не поймёт.
Вот как выглядит совершенно минимальный шаблон для книги, использующий только стандартные классы, ничего сверхъестественного:
\documentclass{book}
% Кодировка XXI века
\usepackage[utf8]{inputenc}
% Если книга на русском, то включаем эти три строчки
\usepackage[russian]{babel}
\usepackage{indentfirst}
\usepackage{misccorr}
% Включаем какой-нибудь другой шрифт, а не стандартный
\usepackage{dejavu}
% Колонтитулы с названием главы и нумерация
\usepackage{fancyhdr}
\pagestyle{fancy}
% Если хочется, чтобы в оглавлении были только главы, и ничего ниже
\setcounter{secnumdepth}{-1}
% Если есть картинки
\usepackage{graphicx}
\DeclareGraphicsExtensions{.jpg,.png,.gif}
% Если хочется гиперссылок в книге
% (в макете для печатного издания они бессмысленны, конечно).
\usepackage{hyperref}
\begin{document}
\title{A Book Title}
\maketitle
\tableofcontents
\include{preface}
\include{chapter-1}
\include{chapter-2}
% ...
\include{chapter-n}
\end{document}
Пример конечного результата можно посмотреть в моей сборке A Video Game Book.
На обложке будет только title, по центру, и дата сборки, тоже по центру. Если надо другую обложку, то придётся настроить дополнительную страницу.
Иногда одной веб-страницы мало. Надо скачать все остальные объекты, доступные из этой веб-страницы. Для этого понадобится один только wget.
Вот заклинание, которое нужно прочитать (предполагается, что мы находимся в каталоге, куда нужно скачать сайт):
wget -m -k -np -w 1 --random-wait -U "Mozilla" -e robots=off <URL>
Значения параметров:
-m Скачать всё, начиная с заданного URL (собственно то, что нужно).-k Исправлять ссылки в скачанных HTML документах, чтобы ссылались не на Сеть, а друг на друга.-np Качать только то, что ниже заданного URL или на его уровне (в частности, не качать ничего с других доменов).-w 1 --random-wait Прикидываться обычным пользователем, делая паузы случайной длины минимум в 1 секунду между каждым скачиваемым файлом.-U "Mozilla" Прикидываться Фаерфоксом (не очень настойчиво: никакой фаерфокс не использует такой User-Agent).-e robots=off Вообще-то, не используйте этот параметр. Он заставляет wget игнорировать правила, описанные в robots.txt.За инфу спасибо HydTechBlog.
Here's how to fix the default too wide and too "round" fonts rendered in EMACS under KDE (and maybe other DE, too).
Write this into the ~/.Xdefault file:
Xft.antialias: 1
Xft.hinting: 1
Xft.hintstyle: hintfull
Xft.rgba: rgb
After that, run the following:
$ xrdb -merge ~/.XdefaultsAnd after that EMACS will really get the same-looking fonts as the other system around it. Thank you Atragor for your answer at archlinux.org
Okay. Today's XXI century already. You have colored commandlines everywhere and you have basically single-user *nix OSes. Now it's time to shift from default commandline prompt strings to something more useful (and fancy, of course).
This is how my prompt looks like now:
This is four-line prompt.
$ symbol (which bears no meaning here, really). If we currently are in the Git repo, then between this tokens the current branch name is being shown in square brackets.Emoticon at the last line behaves like this:
Big thanks to Make Tech Easier for inspiration.
Here how it was done...
That's how you get the name of last tag applied to current branch in Git repo:
git describe | grep -Eo '^[^-]+'
We need to meddle with grep because git describe gives us additional info in the form of
LAST_TAG-COMMITS_SINCE_LAST_TAG-gLAST_COMMIT_HASH
Note the funny literal 'g' before the LAST_COMMIT_HASH.
And that's how you get the list of changes since some COMMIT till the current state of the working copy, in really pretty format "ISO Date (Author) Commit text":
git log --no-merges --pretty=format:'%ai: (%an) %s' COMMIT..HEAD
HEAD is literal "HEAD" there. You can substitute COMMIT token with either commit hash or tag.
Now you write the following script and place it in the root of the codebase of your project:
#!/bin/sh
# Get the list of changes made since the last tag
LAST_TAG=`git describe | grep -Eo '^[^-]+'`
git log --no-merges --pretty=format:'%ai: (%an) %s' $LAST_TAG..HEAD
Name it as changelog and then you can do just:
./changelog
And get something like this:
2012-09-14 23:50:43 +0400: (E. T.) Some stuff for ticket 1584. re #1584 2012-09-14 23:45:05 +0400: (A. Y.) Some stuff for ticket 1584. test #1584 2012-09-14 15:44:49 -0400: (A. Y.) Refactored some old stuff 2012-09-14 22:24:04 +0300: (D. M.) Improved tests
And this will be changes only since last tag applied. Excellent for quick reports about current upstream.
It should be noted that true Common Lisp somewhat lacks in several important parts of string-processing, and it shows sometime. Today I needed to heavily process large body of regular text and will write here some functions which are AFAIK considered "standard" in modern languages and which not so easily accessible and/or amazingly intuitive in CL.
In all following code snippets token input stands for input string.
Trimming string from spaces, tabs and newlines
(string-trim '(#\Space #\Newline #\Return #\Linefeed #\Tab) input))All named characters are listed in Hyperspec, 13.1.7 Character Names.
Replacing by regular expressions
Provided by CL-PPCRE package.
In next snippet I remove all tokens enclosed in square brackets from the input string:
(ql:quickload :cl-ppcre)
(cl-ppcre:regex-replace-all "\\[[^]]+\\]" input "")Honestly, I don't know when you can need simple regex-replace and not regex-replace-all. Also, note the double-escaping of special symbols (\\[ instead of \[).
Splitting string by separator symbol
Provided by CL-UTILITIES package.
In next snippet I split the input string by commas:
(ql:quickload :cl-utilities)
(cl-utilities:split-sequence #\, input)Making same modification on every string in given list
In next snippet I trim spaces around all strings in list input-list:
(map 'list
(lambda (input) (string-trim " " input))
input-list)However, way better is to wrap the transformation for the string in separate function and call the mapping referencing just the name of transformation:
(defun trim-spaces (input)
"Remove trailing and leading spaces from input string"
(string-trim '(#\Space) input))
(map 'list #'trim-spaces input)Do not forget that string is just a sequence of a characters, and all sequence-operating functions can work on strings in either "abcd" form or '(#\a #\b #\c #\d) form. This applies only to sequence-operating functions, however.
Removing the characters from string by condition
In the next snippet I leave only the alphanumeric characters in the input string:
(remove-if-not #'alphanumericp input)There are remove-if also.
As with map, you can make arbitrary complex predicates either with lambdas or wrapping them in separate functions.
Во время учёбы в универе мне регулярно приходилось ездить на различные конференции и делать там доклады. Каждый раз написание короткого содержательного доклада было настоящим испытанием, потому что нужно было рассказать о своём проекте в течение 5 минут, причём за это время нужно было вроде как рассказать о нём всё.
Мучился я почти до самого до пятого курса, когда перед одной из конференций меня не осенило и я не составил для себя короткий простой план текста доклада на проект любого типа. С этим планом доклад обычно получался даже короче, чем на 5 минут. Он успешно опробован на четырёх конференциях, так что я уверен в его полезности, почему и делюсь им с Сетью. :)
Если кому-то план покажется очевидным, рад за вас. Если нет — то вот он, пожалуйста.
С чем связана работа + что было выполнено. (2 предложения)
«Моя работа связана с...»
«В её рамках было разработано...»
Во введении достаточно лишь назвать ключевые слова, по которым потенциальный слушатель поймёт а) разбирается ли он в теме вообще и б) интересна ли ему эта тема.
Предметная область. (2 предложение)
Скорее всего, в одно предложение уложиться не удастся, поэтому выделяется два.
В начале нужно описать контекст работы, потому что доклад очень сжатый, и если сразу начать рассказывать про постановку задачи или методы решения, то слушатель не успеет разобрать вашу мысль.
Скажем, если написали «Моя работа связана с разбором s-выражений при помощи многопоточных компиляторов на языке Haskell», значит, в одном предложении рассказываем, что такое s-выражения, в другом — что такое многопоточные компиляторы (раскрываем только самые сложные/конкретные концепции, на всё времени нет)
Задача. (1 предложение)
«Решалась задача...» или «Была поставлена задача...»
Одним предложением описываем поставленную задачу, так как контекст уже установлен.
Постановка задачи в идеале должна включать в себя описание конечного результата, потому что когда придёт время говорить о том, что получилось в итоге, крайне важно, чтобы результаты соответствовали задаче.
Я многократно видел примеры того, как единственным вопросом из зала было: «А как полученные вами результаты соответствуют вашей задаче?».
Актуальность. (1 предложение)
«Данная задача имеет ценность, потому что...»
Актуальность означает одно из двух: а) какую пользу принесёт решение вашей задачи или б) какие трудности существуют из-за того, что данная задача до сих пор не была решена.
Методы. (3 предложения)
«Для решения задачи было использовано...»
Ни в коем случае нельзя углубляться в подробности, потому что аудитория гарантированно уснёт. Они не занимались этой работой, им априори не так интересны детали.
Если кому-то станет действительно интересно, он спросит после доклада.
Результаты + тесты. (2 предложения)
«В качестве конечного результата было получено...»
«Работа оттестирована на...» или «В качестве тестовых данных были использованы...»
В качестве конечного результата всегда должен получиться некий артефакт: компьютерная программа, формальная спецификация, механизм/агрегат, какая-то ещё вещь.
Очень большой интерес всегда вызывает то, на каких данных/экспериментах была опробована работа. Также тот факт, что в процессе работы автор озаботился тем, как он будет проверять её корректность, повышает её ценность.
К тому же, так как студенческая конференция предназначена для того, чтобы показать своё старание и навыки, очень глупо будет не указать, что для решения поставленной задачи было необходимо что-нибудь вроде анализа динамики статистики рождаемости альбиносов в мире начиная с Рождества Христова.
Выводы. (1 предложение)
«Полученные результаты позволяют сделать вывод о том, что...»
Всегда спрашивают о выводе, если сам об этом не сказал.
Если вывод не сформировался сам собой в процессе работы, то ничего из пальца высасывать не нужно: достаточно просто сказать, что обнаружено, что выбранные методы успешно решают поставленную задачу / непригодны для решения поставленной задачи.
Где может использоваться. (1 предложение)
«Эта работа может быть использована для...»
Если ответ на этот вопрос не очевиден из вышесказанного, то его обязательно зададут из зала.
Увы, если результаты работы или использованные методы решения не могут использоваться нигде, то это автоматически означает, что работа не нужна, а, следовательно, зачем она вообще была выполнена? И потом, если есть актуальность, то почему работу негде использовать?.. В любом случае, вскрывается серьёзная логическая ошибка в постановке задачи.
В итоге получается 13 предложений (возможно, длинных, это неважно), которые очень легко выучить наизусть (и не читать по бумажке вообще) и содержат совершенно всё, что интересует аудиторию.
Preamble is this: we have the PHP-based website, and we are testing it with the Behat+Mink+MinkExtension combo.
Suppose we want to write the following test scenario:
When I am in the Friends section … (something there) … Then I should see “My Friend” in search results
Let's define this steps in our FeatureContext. First step we can define with the following regexp: /^I am in the Friends section$/ because we really don’t need the method of FeatureContext class containing long switch enumerating every possible section of the site.
/**
* @Given /^I am in the "Friends" section$/
*/
public function iAmInTheFriendsSection() {
return new Given('I am on "/friends"');
}
Second step we can define with the following regexp: /^I(?: should)? see "([^"]*)" in the search results$/.
/**
* @Then /^I should see "([^"]*)" in the search results$/
*/
public function iShouldSeeInTheSearchResults($search_term) {
// separate helper function to search the "search results" HTML element
$search_results = $this->getSearchResultsElement();
// separate helper function to search the $search_term text in $search_results element
$this->trySearchTextOnDomElement($search_term, $search_results);
}
It should be obvious why we use the custom test step instead of using the predefined test steps and writing something like 'I should see "My Friend" in ".search-wrapper form input[role="search"]" element'.
Then, someday, sure thing, we will want to write the following scenario:
When I am in the Shop section … (something there) … Then I should see “Interesting product” in search results
And in here, we have another “search results”, which should be found by completely different selector and which is located on different page.
So, this is the context-dependent statement: term “search results” depends on what “section” we mentioned previously. This is right from the linguistics. To be able to use this natural-language feature we need to implement it somehow.
I'll use the abbrev CDTS instead of longer "context-dependent test step".
Fortunately, Behat has a feature with exactly the same purpose: subcontexts. Unfortunately, it's not working in the way we need to use the CDTS properly.
In an ideal world, we can do this:
/**
* @Given /^I am in the Friends section$/
*/
public function iAmInTheFriendsSection() {
$this->useContext('friends_section', new FriendsSectionContext())
return new Given('I am on "/friends"');
}
and this would load the FriendsSectionContext and all CDTS definitions in it, like the following:
// in FriendsSectionContext class
/**
* @Then /^I should see "([^"]*)" in the search results$/
*/
public function iShouldSeeInTheSearchResults($search_term) {
// This selector is valid only in the context of "Friends" section.
$search_results_selector = '#PeopleFinder #pf_all .results';
// Logic to check if the given $search_term is the present in anything called "search results" in the context of "Friends" section.
$search_results = $this->getSession()->getPage()->find('css', $search_results_selector);
$search_term_present = strpos($search_results->getHtml(), $search_term);
if ($search_term_present === false) {
throw new Exception(...);
}
}
We useContext different context class, we get different definition for the /^I should see "([^"]*)" in the search results$/ test step.
Unfortunately, Behat cannot load the test step definitions from subcontexts at runtime. Apparently, it’s because it should parse the regexps in docblocks corresponding to definitions or something like that. So, are forced to load all our subcontexts right in our constructor.
Apart from being horribly ineffective, this prevents us from defining the test steps having same regexp across several different separate subcontexts.
Workaround for this problem is this:
FeatureContext which will hold the reference to current subcontext, name it like "location_context" or so,setting ('I am in the "..." section') test step set the "location_context" to the subcontext needed (you can get the subcontext with the call to getSubcontext('alias')),useContext under meaningful aliases like "friends_section", "shop_section", etc,FeatureContext class,So, we need our context-setting test steps to be like this:
/**
* @Given /^I am in the "Friends" section$/
*/
public function iAmInTheFriendsSection() {
$this->location_context = $this->getSubcontext('friends_section');
return new Given('I am on "/people"');
}
Assuming 'friends_section' is an alias of the FriendsSectionContext, and it was set in the constructor, after this test step, our "location_context" will be FriendsSectionContext, and, say, it's getSearchResultsElement() will do exactly what we need in the "Friends" section.
Then, the context-depentent test step will be like this, getting the location-dependent logic from the "location_context" set previously:
/**
* @Then /^I should see "([^"]*)" in the search results$/
*/
public function iShouldSeeInTheSearchResults($search_term) {
// getSearchResultsElement() is defined in subcontext which was set before in $this->location_context
$search_results = $this->location_context->getSearchResultsElement();
$search_term_present = strpos($search_results->getHtml(), $search_term);
if ($search_term_present === false) {
throw new Exception(...);
}
}
Main point is this: we want to check if something should appear in the "search results" entity in some different page → we can use the same test step in our .feature files, just explicitly name the section needed beforehand somewhere above in the text. This will make the .feature files a lot more human-readable.
This concludes the explanation about how to use this linguistic technique in Behat tests.