Как улучшить шаблон разработчика?

Это взяло меня некоторое время, и это также взяло меня берущий маленькие отрывки из многих других источников и расплавляющий их вместе, но я думаю, что у меня есть небольшой рабочий пример, который достаточно демонстрирует новичку Perl процесс сборки Perl включая поблочное тестирование и анализ покрытия кода & создание отчетов. (Я использую ActiveState ActivePerl v5.10.0 на Windows XP Pro ПК, Модуль:: Сборка , Тест:: Больше , Devel:: Покрытие )

Начинаются с каталогом для Вашего проекта Perl и затем создают каталог "lib" и "t" каталог под Вашим каталогом проекта:

HelloPerlBuildWorld
        |
        |----------> lib
        |
        |----------> t

В каталоге "lib", создайте текстовый файл под названием "HelloPerlBuildWorld.pm". Этот файл является Вашим модулем Perl, который Вы будете создавать и тестировать. Вставьте следующее содержание в этот файл:

use strict;
use warnings;
package HelloPerlBuildWorld;

$HelloPerlBuildWorld::VERSION = '0.1';

sub hello {
   return "Hello, Perl Build World!";
}

sub bye {
   return "Goodbye, cruel world!";
}

sub repeat {
   return 1;
}

sub argumentTest {
    my ($booleanArg) = @_;

    if (!defined($booleanArg)) {
        return "null";
    }
    elsif ($booleanArg eq "false") {
        return "false";
    }
    elsif ($booleanArg eq "true") {
        return "true";
    }
    else {
        return "unknown";
    }

   return "Unreachable code: cannot be covered";
}

1;

В "t" каталоге, создайте текстовый файл под названием "HelloPerlBuildWorld.t". Этот файл является Вашим сценарием модульного теста, который попытается полностью протестировать Ваш модуль Perl выше. Вставьте следующее содержание в этот файл:

use strict;
use warnings;
use Test::More qw(no_plan);

# Verify module can be included via "use" pragma
BEGIN { use_ok('HelloPerlBuildWorld') };

# Verify module can be included via "require" pragma
require_ok( 'HelloPerlBuildWorld' );

# Test hello() routine using a regular expression
my $helloCall = HelloPerlBuildWorld::hello();
like($helloCall, qr/Hello, .*World/, "hello() RE test");

# Test hello_message() routine using a got/expected routine
is($helloCall, "Hello, Perl Build World!", "hello() IS test");

# Do not test bye() routine

# Test repeat() routine using a got/expected routine
for (my $ctr=1; $ctr<=10; $ctr++) {
    my $repeatCall = HelloPerlBuildWorld::repeat();
    is($repeatCall, 1, "repeat() IS test");
}

# Test argumentTest() 
my $argumentTestCall1 = HelloPerlBuildWorld::argumentTest();
is($argumentTestCall1, "null", "argumentTest() IS null test");

# Test argumentTest("true") 
my $argumentTestCall2 = HelloPerlBuildWorld::argumentTest("true");
is($argumentTestCall2, "true", "argumentTest() IS true test");

# Test argumentTest("false") 
my $argumentTestCall3 = HelloPerlBuildWorld::argumentTest("false");
is($argumentTestCall3, "false", "argumentTest() IS false test");

# Test argumentTest(123) 
my $argumentTestCall4 = HelloPerlBuildWorld::argumentTest(123);
is($argumentTestCall4, "unknown", "argumentTest() IS unknown test");

Теперь создают резервную копию в Вашем высокоуровневом каталоге проекта, создают текстовый файл, названный "Сборка. МН". Этот файл создаст Ваши сценарии сборки, которые Вы будете использовать позже. Вставьте следующее содержание в этот файл:

use strict;
use warnings;
use Module::Build;

my $builder = Module::Build->new(
    module_name         => 'HelloPerlBuildWorld',
    license             => 'perl',
    dist_abstract       => 'HelloPerlBuildWorld short description',
    dist_author         => 'Author Name ',
    build_requires => {
        'Test::More' => '0.10',
    },
);

$builder->create_build_script();

Это - все файлы, в которых Вы нуждаетесь. Теперь из командной строки в высокоуровневом каталоге проекта, введите следующую команду:

perl Build.PL

Вы будете видеть что-то подобное следующему:

Checking prerequisites...
Looks good

Creating new 'Build' script for 'HelloPerlBuildWorld' version '0.1'

Теперь необходимо смочь выполнить модульные тесты со следующей командой:

Build test

И см. что-то подобное этому:

Copying lib\HelloPerlBuildWorld.pm -> blib\lib\HelloPerlBuildWorld.pm
t\HelloPerlBuildWorld....ok
All tests successful.
Files=1, Tests=18,  0 wallclock secs ( 0.00 cusr +  0.00 csys =  0.00 CPU)

Для выполнения модульных тестов с анализом покрытия кода попробуйте это:

Build testcover

И Вы будете видеть что-то на порядке этого:

t\HelloPerlBuildWorld....ok
All tests successful.
Files=1, Tests=18, 12 wallclock secs ( 0.00 cusr +  0.00 csys =  0.00 CPU)
cover
Reading database from D:/Documents and Settings/LeuchKW/workspace/HelloPerlBuildWorld/cover_db


----------------------------------- ------ ------ ------ ------ ------ ------
File                                  stmt   bran   cond    sub   time  total
----------------------------------- ------ ------ ------ ------ ------ ------
D:/Perl/lib/ActivePerl/Config.pm       0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/ActiveState/Path.pm        0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/AutoLoader.pm              0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/B.pm                      18.6   16.7   13.3   19.2   96.4   17.6
 ...
[SNIP]
 ...
D:/Perl/lib/re.pm                      0.0    0.0    0.0    0.0    n/a    0.0
D:/Perl/lib/strict.pm                 84.6   50.0   50.0  100.0    0.0   73.1
D:/Perl/lib/vars.pm                   44.4   36.4    0.0  100.0    0.0   36.2
D:/Perl/lib/warnings.pm               15.3   12.1    0.0   11.1    0.0   12.0
D:/Perl/lib/warnings/register.pm       0.0    0.0    n/a    0.0    n/a    0.0
blib/lib/HelloPerlBuildWorld.pm       87.5  100.0    n/a   83.3    0.0   89.3
Total                                  9.9    4.6    2.8   11.3  100.0    7.6
----------------------------------- ------ ------ ------ ------ ------ ------


Writing HTML output to D:/Documents and Settings/LeuchKW/workspace/HelloPerlBuildWorld/cover_db/coverage.html ...
done.

(Кто-то скажите мне, как настроить Покрытие, чтобы проигнорировать все библиотеки Perl кроме и просто сообщить мне на моем единственном файле, который я записал. Я не мог заставить фильтрацию Покрытия работать согласно документации CPAN!)

Теперь при обновлении высокоуровневого каталога Вы видите новый подкаталог, названный "cover_db". Войдите в тот каталог и двойной щелчок по файлу "coverage.html" для открытия отчета о покрытии кода в любимом веб-браузере. Это дает Вам, хороший цвет кодировал отчет гипертекста, где можно нажать имя файла и видеть подробный оператор, ответвление, условие, статистику покрытия подпрограммы для модуля Perl тут же в отчете рядом с фактическим исходным кодом. Вы видите в этом отчете, что мы не покрывали "до свидания ()" стандартная программа вообще и также существует строка кода, которая недостижима, который не был покрыт, как мы ожидали.

snapshot of code coverage report
(источник: leucht.com )

Еще одна вещь можно сделать, чтобы помочь автоматизировать этот процесс в IDE, должен сделать еще некоторую "Сборку. МН" файлы типа, которые явно выполняют некоторые цели сборки, которые мы сделали выше вручную из командной строки. Например, я использую "BuildTest. МН" файл со следующим содержанием:

use strict;
use warnings;
use Module::Build;

my $build = Module::Build->resume (
  properties => {
    config_dir => '_build',
  },
);

$build->dispatch('build');
$build->dispatch('test');

Затем я настроил свой IDE для выполнения этого файла (через "perl BuiltTest. МН") единственным щелчком мышью и это автоматически выполняет мой код модульного теста от IDE вместо меня делающий его вручную из командной строки. Замените "отправку ('тест')" "отправкой ('testcover')" для автоматизированного выполнения покрытия кода. Введите "Справку сборки" для полного списка целей сборки, которые доступны от Модуля:: Сборка.

39
задан shmosel 25 August 2017 в 01:16
поделиться

6 ответов

No, it's not new. What you're actually doing there is creating a sort of a DSL by extending the standard builder pattern to support branches which is among other things an excellent way to make sure the builder doesn't produce a set of conflicting settings to the actual object.

Personally I think this is a great extension to builder pattern and you can do all sorts of interesting things with it, for example at work we have DSL builders for some of our data integrity tests which allow us to do things like assertMachine().usesElectricity().and().makesGrindingNoises().whenTurnedOn();. OK, maybe not the best possible example but I think you get the point.

15
ответ дан 27 November 2019 в 02:26
поделиться

IMHO, this seems bloated. If you have to have all the parameters, pass them in the constructor.

5
ответ дан 27 November 2019 в 02:26
поделиться

I've seen/used this:

new ComplexBuilder(requiredvarA, requiedVarB).optional(foo).optional(bar).build();

Then pass these to your object that requires them.

5
ответ дан 27 November 2019 в 02:26
поделиться

The traditional builder pattern already handles this: simply take the mandatory parameters in the constructor. Of course, nothing prevents a caller from passing null, but neither does your method.

The big problem I see with your method is that you either have a combinatorical explosion of classes with the number of mandatory parameters, or force the user to set the parameters in one particular sqeuence, which is annoying.

Also, it is a lot of additional work.

23
ответ дан 27 November 2019 в 02:26
поделиться

Почему бы вам не указать «необходимые» параметры в конструкторе построителей?

public class Complex
{
....
  public static class ComplexBuilder
  {
     // Required parameters
     private final int required;

     // Optional parameters
     private int optional = 0;

     public ComplexBuilder( int required )
     {
        this.required = required;
     } 

     public Builder setOptional(int optional)
     {
        this.optional = optional;
     }
  }
...
}

Этот шаблон описан в Эффективная Java .

12
ответ дан 27 November 2019 в 02:26
поделиться

Для получения более подробной информации о , когда использовать модель строителя и ее преимуществах, вам следует ознакомиться с моим сообщением по другому похожему вопросу здесь

1
ответ дан 27 November 2019 в 02:26
поделиться
Другие вопросы по тегам:

Похожие вопросы: