rusrails.github.io/plugins.html at master · rusrails/rusrails.github.io

History

644 lines (562 loc) · 46 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

<!DOCTYPE html>

<head>

<title>

Rusrails: Основы создания плагинов Rails

</title>

</head>

<body>

<li>

<a href="/">Главная</a>

</li>

Содержание

</a> <div class="index-popover-content hide">

<ul><li>С чего начать?<ul><li><a href="/getting-started">Rails для начинающих</a>

</li></ul></li><li>Модели<ul><li><a href="/active-record-basics">Основы Active Record</a>

</li><li><a href="/active-record-migrations">Миграции Active Record</a>

</li><li><a href="/active-record-validations">Валидации Active Record</a>

</li><li><a href="/active-record-callbacks">Колбэки Active Record</a>

</li><li><a href="/active-record-associations">Связи (ассоциации) Active Record</a>

</li><li><a href="/active-record-querying">Интерфейс запросов Active Record</a>

</li><li><a href="/active-model-basics">Основы Active Model</a>

</li></ul></li><li>Вью<ul><li><a href="/action-view-overview">Обзор Action View</a>

</li><li><a href="/layouts-and-rendering">Макеты и рендеринг в Rails</a>

</li><li><a href="/action-view-helpers">Хелперы Action View</a>

</li><li><a href="/form-helpers">Хелперы форм в Action View</a>

</li></ul></li><li>Контроллеры<ul><li><a href="/action-controller-overview">Обзор Action Controller</a>

</li><li><a href="/routing">Роутинг в Rails</a>

</li></ul></li><li>Другие компоненты<ul><li><a href="/active-support-core-extensions">Расширения ядра Active Support</a>

</li><li><a href="/action-mailer-basics">Основы Action Mailer</a>

</li><li><a href="/action-mailbox-basics">Основы Action Mailbox</a>

</li><li><a href="/action-text-overview">Обзор Action Text</a>

</li><li><a href="/active_job_basics">Основы Active Job</a>

</li><li><a href="/active_storage_overview">Обзор Active Storage</a>

</li><li><a href="/action-cable-overview">Обзор Action Cable</a>

</li></ul></li><li>Копаем глубже<ul><li><a href="/i18n">API интернационализации Rails (I18n)</a>

</li><li><a href="/testing">Тестирование приложений на Rails</a>

</li><li><a href="/security">Безопасность приложений на Rails</a>

</li><li><a href="/error-reporting">Отчет об ошибках в приложениях Rails</a>

</li><li><a href="/debugging-rails-applications">Отладка приложений на Rails</a>

</li></ul></li></ul>next_column<ul><li>Копаем глубже<ul><li><a href="/configuring">Конфигурирование приложений на Rails</a>

</li><li><a href="/command-line">Командная строка Rails</a>

</li><li><a href="/asset-pipeline">Asset Pipeline</a>

</li><li><a href="/working-with-javascript-in-rails">Работа с JavaScript в Rails</a>

</li><li><a href="/initialization">Процесс инициализации в Rails</a>

</li><li><a href="/autoloading-and-reloading-constants">Автозагрузка и перезагрузка констант</a>

</li><li><a href="/caching-with-rails">Кэширование с Rails: Обзор</a>

</li><li><a href="/active-support-instrumentation">Инструментарий Active Support</a>

</li><li><a href="/api-app">Использование Rails для API-приложений</a>

</li><li><a href="/active-record-postgresql">Active Record для PostgreSQL</a>

</li><li><a href="/active-record-multiple-databases">Несколько баз данных с Active Record</a>

</li><li><a href="/active-record-encryption">Шифрование Active Record</a>

</li></ul></li><li>Расширяем Rails<ul><li><a href="/plugins">Основы создания плагинов Rails</a>

</li><li><a href="/rails-on-rack">Rails on Rack</a>

</li><li><a href="/generators">Создание и настройка генераторов и шаблонов Rails</a>

</li><li><a href="/engines">Engine для начинающих</a>

</li><li><a href="/threading_and_code_execution">Треды и выполнение кода в Rails</a>

</li><li><a href="/rails-application-templates">Шаблоны приложения Rails</a>

</li></ul></li><li>Вносим вклад в Ruby on Rails<ul><li><a href="/contributing_to_ruby_on_rails">Вносим вклад в Ruby on Rails</a>

</li><li><a href="/api_documentation_guidelines">Рекомендации по документированию API</a>

</li><li><a href="/ruby_on_rails_guides_guidelines">Рекомендации для руководств по Ruby on Rails</a>

</li><li><a href="/development_dependencies_install">Установка зависимостей для разработки</a>

</li><li><a href="/maintenance-policy">Политика поддержки (версий)</a>

</li></ul></li><li>Заметки о релизах<ul><li><a href="/upgrading-ruby-on-rails">Апгрейд Ruby on Rails</a>

</li><li><a href="/7_2_release_notes">Версия 7.2 - ?</a>

</li><li><a href="/7_1_release_notes">Версия 7.1 - Октябрь 2023</a>

</li><li><a href="/7_0_release_notes">Версия 7.0 - Декабрь 2021</a>

</li><li><a href="/6_1_release_notes">Версия 6.1 - Декабрь 2020</a>

</li><li><a href="/6_0_release_notes">Версия 6.0 - Август 2019</a>

</li></ul></li></ul>

</div>

</li>

<li>

<a href="/search">Поиск</a>

</li>

<li>

<a target="blank" href="http://api.rusrails.ru">Ruby & Rails API</a>

</li>

</ul>

</div>

<h4>Принимаем пожелания и пул-реквесты!</h4>

</div>

<li>

<h4>

<a href="#nastroyka">1. Настройка</a>

</h4> </li>

<li>

<h5>

<a href="#sozdanie-gema">1.1. Создание гема.</a>

</h5> </li>

<li>

<h4>

<a href="#testirovanie-svoego-novogo-plagina">2. Тестирование своего нового плагина</a>

</h4> </li>

<li>

<h4>

<a href="#rasshirenie-klassov-yadra">3. Расширение классов ядра</a>

</h4> </li>

<li>

<h4>

<a href="#dobavlenie-metoda-acts_as-v-active-record">4. Добавление метода "acts_as" в Active Record</a>

</h4> </li>

<li>

<h5>

<a href="#dobavlenie-metoda-klassa">4.1. Добавление метода класса</a>

</h5> </li>

<li>

<h5>

<a href="#dobavlenie-metoda-ekzemplyara">4.2. Добавление метода экземпляра</a>

</h5> </li>

<li>

<h4>

<a href="#generatory">5. Генераторы</a>

</h4> </li>

<li>

<h4>

<a href="#publikatsiya-vashego-gema">6. Публикация вашего гема</a>

</h4> </li>

<li>

<h4>

<a href="#dokumentatsiya-rdoc">7. Документация RDoc</a>

</h4> </li>

<li>

<h5>

<a href="#ssylki">7.1. Ссылки</a>

</h5> </li>

</ul>

</div>

<ins class="adsbygoogle"

style="display:inline-block;width:300px;height:600px"

data-ad-client="ca-pub-7764391801669990"

data-ad-slot="6089520660"></ins>

(adsbygoogle = window.adsbygoogle || []).push({});

</script>

</div>

<ins class="adsbygoogle"

style="display:inline-block;width:980px;height:120px"

data-ad-client="ca-pub-7764391801669990"

data-ad-slot="4891989065"></ins>

(adsbygoogle = window.adsbygoogle || []).push({});

</script>

</div>

<h2 id='osnovy-sozdaniya-plaginov-rails' class='inside_page_header'> Основы создания плагинов Rails</h2>Плагин Rails - это либо расширение, либо модификация основного фреймворка. Плагины представляют:<ul><li>Способ для разработчиков делиться новыми идеями без затрагивания стабильной кодовой базы.

</li><li>Сегментную архитектуру, такую, что часть кода может быть исправлена или изменена по своему собственному графику.

</li><li>Решение для разработчиков ядра приложения, чтобы не включать каждую новую особенность в свой код.

</li></ul>После прочтения этого руководства, вы узнаете:<ul><li>Как создать плагин с нуля.

</li><li>Как написать и запустить тесты для плагина.

</li></ul>Это руководство описывает, как создать плагин, движимый тестами (TDD), который будет:<ul><li>Расширять классы ядра Ruby, такие как Hash и String.

</li><li>Добавлять методы в <code>ApplicationRecord</code> в традициях плагинов <code>acts_as</code>.

</li><li>Представлять информацию о том, где разместить генераторы в вашем плагине.

</li></ul>Для целей этого руководства представьте на момент, что вы заядлый любитель птиц. Вашей любимой птицей является дятел (Yaffle), и вы хотите создать плагин, позволяющий другим разработчикам пользоваться особенностями дятлов.<h3 id='nastroyka' class='inside_page_header'><a href="#nastroyka">1.</a> Настройка</h3>В настоящее время плагины Rails создаются как гемы (gemified plugins). Они могут использоваться сразу несколькими приложениями Rails с помощью RubyGems и Bundler.<h4 id='sozdanie-gema' class='inside_page_header'><a href="#sozdanie-gema">1.1.</a> Создание гема.</h4>Rails поставляется с командой <code>rails plugin new</code>, создающей скелет для разработки любого типа расширения Rails со способностью запуска интеграционных тестов с помощью приложения-заглушки Rails. Создайте свой плагин с помощью команды:<div class="code_container">

<pre><code class="highlight console">$ rails plugin new yaffle

</code></pre>

</div>

Как ее использовать и ее опции смотрите:<div class="code_container">

<pre><code class="highlight console">$ rails plugin new --help

</code></pre>

</div>

<h3 id='testirovanie-svoego-novogo-plagina' class='inside_page_header'><a href="#testirovanie-svoego-novogo-plagina">2.</a> Тестирование своего нового плагина</h3>Можете перейти в директорию, содержащую плагин, изменить следующие строчки в <code>yaffle.gemspec</code><div class="code_container">

<pre><code class="highlight ruby"> spec.summary = "Summary of Yaffle."

spec.description = "Description of Yaffle."

...

spec.homepage = "http://example.com"

spec.metadata["source_code_uri"] = "http://example.com"

spec.metadata["changelog_uri"] = "http://example.com"

</code></pre>

</div>

запустить команду <code>bundle install</code>, и запустить сгенерированный тест с использованием команды <code>bin/test</code>.Вы должны увидеть:<div class="code_container">

<pre><code class="highlight plaintext"> 1 runs, 1 assertions, 0 failures, 0 errors, 0 skips

</code></pre>

</div>

Это сообщает, что все сгенерировалось правильно, и можно начать добавлять функциональность.<h3 id='rasshirenie-klassov-yadra' class='inside_page_header'><a href="#rasshirenie-klassov-yadra">3.</a> Расширение классов ядра</h3>Этот раздел объясняет, как добавить метод в String, который будет доступен везде в вашем приложении Rails.В следующем примере мы добавим метод в String с именем <code>to_squawk</code>. Для начала создайте новый файл теста с несколькими утверждениями:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/test/core_ext_test.rb

require "test_helper"

class CoreExtTest < ActiveSupport::TestCase

def test_to_squawk_prepends_the_word_squawk

assert_equal "squawk! Hello World", "Hello World".to_squawk

end

</code></pre>

</div>

Запустите <code>bin/test</code> для запуска теста. Этот тест должен провалиться, так как мы еще не реализовали метод <code>to_squawk</code>:<div class="code_container">

<pre><code class="highlight plaintext">E

Error:

CoreExtTest#test_to_squawk_prepends_the_word_squawk:

NoMethodError: undefined method `to_squawk' for "Hello World":String

bin/test /path/to/yaffle/test/core_ext_test.rb:4

Finished in 0.003358s, 595.6483 runs/s, 297.8242 assertions/s.

2 runs, 1 assertions, 0 failures, 1 errors, 0 skips

</code></pre>

</div>

Отлично - теперь мы готовы начать разработку.В <code>lib/yaffle.rb</code> добавьте <code>require "yaffle/core_ext"</code>:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/lib/yaffle.rb

require "yaffle/version"

require "yaffle/railtie"

require "yaffle/core_ext"

module Yaffle

# Тут какой-нибудь код...

end

</code></pre>

</div>

Наконец, создайте файл <code>core_ext.rb</code> и добавьте метод <code>to_squawk</code>:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/lib/yaffle/core_ext.rb

class String

def to_squawk

"squawk! #{self}".strip

end

</code></pre>

</div>

Чтобы проверить, что этот метод делает то, что нужно, запустите юнит-тесты с помощью <code>bin/test</code> из директории плагина.<div class="code_container">

<pre><code class="highlight plaintext"> 2 runs, 2 assertions, 0 failures, 0 errors, 0 skips

</code></pre>

</div>

Чтобы увидеть его в действии, измените директорию на <code>test/dummy</code>, запустите <code>bin/rails console</code> и начните squawking:<div class="code_container">

<pre><code class="highlight irb">irb> "Hello World".to_squawk

=> "squawk! Hello World"

</code></pre>

</div>

<h3 id='dobavlenie-metoda-acts_as-v-active-record' class='inside_page_header'><a href="#dobavlenie-metoda-acts_as-v-active-record">4.</a> Добавление метода "acts_as" в Active Record</h3>Обычным паттерном для плагинов является добавление в модель метода с именем <code>acts_as_something</code>. В нашем случае мы хотим написать метод с именем <code>acts_as_yaffle</code>, добавляющий метод <code>squawk</code> в модель Active Record.Для начала настройте свои файлы, вам нужны:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/test/acts_as_yaffle_test.rb

require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase

end

</code></pre>

</div>

<pre><code class="highlight ruby"># yaffle/lib/yaffle.rb

require "yaffle/version"

require "yaffle/railtie"

require "yaffle/core_ext"

require "yaffle/acts_as_yaffle"

module Yaffle

# Тут какой-нибудь код...

end

</code></pre>

</div>

<pre><code class="highlight ruby"># yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle

module ActsAsYaffle

end

</code></pre>

</div>

<h4 id='dobavlenie-metoda-klassa' class='inside_page_header'><a href="#dobavlenie-metoda-klassa">4.1.</a> Добавление метода класса</h4>Этот плагин ожидает, что мы добавим в модель метод с именем <code>last_squawk</code>. Однако, у пользователей плагина уже может быть определен метод в модели <code>last_squawk</code>, который они используют для чего-то иного. Этот плагин позволит имени быть измененным, добавив метод класса <code>yaffle_text_field</code>.Для начала напишем падающий тест, показывающий нужное нам поведение:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/test/acts_as_yaffle_test.rb

require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase

def test_a_hickwalls_yaffle_text_field_should_be_last_squawk

assert_equal "last_squawk", Hickwall.yaffle_text_field

end

def test_a_wickwalls_yaffle_text_field_should_be_last_tweet

assert_equal "last_tweet", Wickwall.yaffle_text_field

end

</code></pre>

</div>

При запуске <code>bin/test</code> вы увидите следующее:<div class="code_container">

<pre><code class="highlight plaintext"># Running:

..E

Error:

ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:

NameError: uninitialized constant ActsAsYaffleTest::Wickwall

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8

Error:

ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:

NameError: uninitialized constant ActsAsYaffleTest::Hickwall

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4

Finished in 0.004812s, 831.2949 runs/s, 415.6475 assertions/s.

4 runs, 2 assertions, 0 failures, 2 errors, 0 skips

</code></pre>

</div>

Это сообщает нам об отсутствии необходимых моделей (Hickwall и Wickwall), которые мы пытаемся протестировать. Эти модели можно с легкостью создать в нашем "dummy" приложении Rails, запустив следующие команды в директории <code>test/dummy</code>:<div class="code_container">

<pre><code class="highlight console">$ cd test/dummy

$ bin/rails generate model Hickwall last_squawk:string

$ bin/rails generate model Wickwall last_squawk:string last_tweet:string

</code></pre>

</div>

Теперь можно создать необходимые таблицы в вашей тестовой базе данных, перейдя в приложение-заглушку и мигрировав базу данных. Сначала запустите:<div class="code_container">

<pre><code class="highlight console">$ cd test/dummy

$ bin/rails db:migrate

</code></pre>

</div>

Пока вы тут, измените модели Hickwall и Wickwall так, чтобы они знали, что они должны действовать как дятлы.<div class="code_container">

<pre><code class="highlight ruby"># test/dummy/app/models/hickwall.rb

class Hickwall < ApplicationRecord

acts_as_yaffle

end

</code></pre>

</div>

<pre><code class="highlight ruby"># test/dummy/app/models/wickwall.rb

class Wickwall < ApplicationRecord

acts_as_yaffle yaffle_text_field: :last_tweet

end

</code></pre>

</div>

Также добавим код, определяющий метод <code>acts_as_yaffle</code>.<div class="code_container">

<pre><code class="highlight ruby"># yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle

module ActsAsYaffle

extend ActiveSupport::Concern

class_methods do

def acts_as_yaffle(options = {})

end

</code></pre>

</div>

<pre><code class="highlight ruby"># test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base

include Yaffle::ActsAsYaffle

self.abstract_class = true

end

</code></pre>

</div>

Затем можно вернуться в корневую директорию плагина (<code>cd ../..</code>) и перезапустить тесты с помощью <code>bin/test</code>.<div class="code_container">

<pre><code class="highlight plaintext"># Running:

Error:

ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:

NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974ebbe9d8>

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:4

Error:

ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:

NoMethodError: undefined method `yaffle_text_field' for #<Class:0x0055974eb8cfc8>

bin/test /path/to/yaffle/test/acts_as_yaffle_test.rb:8

Finished in 0.008263s, 484.0999 runs/s, 242.0500 assertions/s.

4 runs, 2 assertions, 0 failures, 2 errors, 0 skips

</code></pre>

</div>

Подбираемся ближе... Теперь мы реализуем код метода <code>acts_as_yaffle</code>, чтобы тесты проходили.<div class="code_container">

<pre><code class="highlight ruby"># yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle

module ActsAsYaffle

extend ActiveSupport::Concern

class_methods do

def acts_as_yaffle(options = {})

cattr_accessor :yaffle_text_field, default: (options[:yaffle_text_field] || :last_squawk).to_s

end

</code></pre>

</div>

<pre><code class="highlight ruby"># test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base

include Yaffle::ActsAsYaffle

self.abstract_class = true

end

</code></pre>

</div>

Когда запустите <code>bin/test</code>, все тесты должны пройти:<div class="code_container">

<pre><code class="highlight plaintext"> 4 runs, 4 assertions, 0 failures, 0 errors, 0 skips

</code></pre>

</div>

<h4 id='dobavlenie-metoda-ekzemplyara' class='inside_page_header'><a href="#dobavlenie-metoda-ekzemplyara">4.2.</a> Добавление метода экземпляра</h4>Этот плагин добавит метод 'squawk' в любой объект Active Record, который вызовет <code>acts_as_yaffle</code>. Метод 'squawk' просто установит значение одному из полей в базе данных.Для начала напишем падающий тест, показывающий желаемое поведение:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/test/acts_as_yaffle_test.rb

require "test_helper"

class ActsAsYaffleTest < ActiveSupport::TestCase

def test_a_hickwalls_yaffle_text_field_should_be_last_squawk

assert_equal "last_squawk", Hickwall.yaffle_text_field

end

def test_a_wickwalls_yaffle_text_field_should_be_last_tweet

assert_equal "last_tweet", Wickwall.yaffle_text_field

end

def test_hickwalls_squawk_should_populate_last_squawk

hickwall = Hickwall.new

hickwall.squawk("Hello World")

assert_equal "squawk! Hello World", hickwall.last_squawk

end

def test_wickwalls_squawk_should_populate_last_tweet

wickwall = Wickwall.new

wickwall.squawk("Hello World")

assert_equal "squawk! Hello World", wickwall.last_tweet

end

</code></pre>

</div>

Запустите тест, чтобы убедиться, что последние два теста упадут с ошибкой, содержащей "NoMethodError: undefined method `squawk'", затем обновите <code>acts_as_yaffle.rb</code>, чтобы он выглядел так:<div class="code_container">

<pre><code class="highlight ruby"># yaffle/lib/yaffle/acts_as_yaffle.rb

module Yaffle

module ActsAsYaffle

extend ActiveSupport::Concern

included do

def squawk(string)

write_attribute(self.class.yaffle_text_field, string.to_squawk)

end

class_methods do

def acts_as_yaffle(options = {})

end

</code></pre>

</div>

<pre><code class="highlight ruby"># test/dummy/app/models/application_record.rb

class ApplicationRecord < ActiveRecord::Base

include Yaffle::ActsAsYaffle

self.abstract_class = true

end

</code></pre>

</div>

Запустите <code>bin/test</code> в последний раз, вы должны увидеть:<div class="code_container">

<pre><code class="highlight plaintext"> 6 runs, 6 assertions, 0 failures, 0 errors, 0 skips

</code></pre>

</div>

<div class="note">Использование <code>write_attribute</code> для записи в поле модели - это всего лишь пример того, как плагин может взаимодействовать с моделью, но не всегда правильный метод для использования. Например, также можно использовать:</div><div class="code_container">

<pre><code class="highlight ruby">send("#{self.class.yaffle_text_field}=", string.to_squawk)

</code></pre>

</div>

<h3 id='generatory' class='inside_page_header'><a href="#generatory">5.</a> Генераторы</h3>Генераторы могут быть включены в гем простым добавлением в директорию <code>lib/generators</code> плагина. Подробнее о создании генераторов смотрите в руководстве <a href="/generators">Создание и настройка генераторов и шаблонов Rails</a>.<h3 id='publikatsiya-vashego-gema' class='inside_page_header'><a href="#publikatsiya-vashego-gema">6.</a> Публикация вашего гема</h3>Плагины в виде гемов, которые в текущий момент в разработке, могут с легкостью быть доступны из любого репозитория Git. Чтобы поделиться гемом Yaffle с другими, просто передайте код в репозиторий Git (такой как GitHub) и добавьте строчку в <code>Gemfile</code> требуемого приложения:<div class="code_container">

<pre><code class="highlight ruby">gem "yaffle", git: "https://github.com/rails/yaffle.git"

</code></pre>

</div>

После запуска <code>bundle install</code> функциональность гема будет доступна в приложении.Когда гем готов к официальному релизу, он может быть опубликован на <a href="https://rubygems.org">RubyGems</a>.Альтернативно можно воспользоваться задачами Rake от Bundler. Полный список можно увидеть ниже:<div class="code_container">

<pre><code class="highlight console">$ bundle exec rake -T

$ bundle exec rake build

# Build yaffle-0.1.0.gem into the pkg directory

$ bundle exec rake install

# Build and install yaffle-0.1.0.gem into system gems

$ bundle exec rake release

# Create tag v0.1.0 and build and push yaffle-0.1.0.gem to Rubygems

</code></pre>

</div>

Подробнее о публикации гемов на RubyGems смотрите: <a href="https://guides.rubygems.org/publishing">Publishing your gem</a><h3 id='dokumentatsiya-rdoc' class='inside_page_header'><a href="#dokumentatsiya-rdoc">7.</a> Документация RDoc</h3>Как только ваш плагин станет стабильным, и вы будете готовы его разместить, сделайте хорошее дело, документировав его! К счастью, написание документации для вашего плагина - это очень просто.Первым шагом является обновление файла README детальной информацией о том, как использовать ваш плагин. Ключевые вещи, которые следует включить, следующие:<ul><li>Ваше имя

</li><li>Как установить

</li><li>Как добавить функциональность в приложение (несколько примеров обычных ситуаций использования)

</li><li>Предупреждения, хитрости или подсказки, которые могут помочь пользователям и сохранить их время

</li></ul>Как только README готов, пройдитесь и добавьте комментарии rdoc ко всем методам, которые будут использовать разработчики. Также принято добавить комментарии <code># :nodoc:</code> к тем частям кода, которые не включены в публичный API.Как только ваши комментарии закончены, перейдите в директорию плагины и запустите:<div class="code_container">

<pre><code class="highlight console">$ bundle exec rake rdoc

</code></pre>

</div>

<h4 id='ssylki' class='inside_page_header'><a href="#ssylki">7.1.</a> Ссылки</h4><ul><li><a href="https://github.com/radar/guides/blob/master/gem-development.md">Developing a RubyGem using Bundler</a>

</li><li><a href="https://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/">Using .gemspecs as Intended</a>

</li><li><a href="https://guides.rubygems.org/specification-reference/">Gemspec Reference</a>

</li></ul>

<ins class="adsbygoogle"

style="display:inline-block;width:580px;height:400px"

data-ad-client="ca-pub-7764391801669990"

data-ad-slot="7566253867"></ins>

(adsbygoogle = window.adsbygoogle || []).push({});

</script>

</div>

<a href="https://creativecommons.org/licenses/by-sa/4.0/">Лицензия CC BY-SA 4.0</a>

"Rails", "Ruby on Rails" и логотип Rails - торговые марки DHH

(function (d, w, c) {

(w[c] = w[c] || []).push(function() {

try {

w.yaCounter1006929 = new Ya.Metrika({id:1006929,

webvisor:true,

clickmap:true,

trackLinks:true,

accurateTrackBounce:true});

} catch(e) { }

});

var n = d.getElementsByTagName("script")[0],

s = d.createElement("script"),

f = function () { n.parentNode.insertBefore(s, n); };

s.type = "text/javascript";

s.async = true;

s.src = (d.location.protocol == "https:" ? "https:" : "http:") + "//mc.yandex.ru/metrika/watch.js";

if (w.opera == "[object Opera]") {

d.addEventListener("DOMContentLoaded", f, false);

} else { f(); }

})(document, window, "yandex_metrika_callbacks");

</script>

<div>

</div>

</noscript>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-64955373-1', 'auto');

ga('send', 'pageview');

var trackOutboundLink = function(url) {

ga('send', 'event', 'outbound', 'click', url, {

'transport': 'beacon',

'hitCallback': function(){ }

});

}

</script>

</div>

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plugins.html

Latest commit

History

plugins.html

File metadata and controls