Paths

Table of Contentst

Differential D9993

Rename `PhutilRemarkupRule` subclasses
ClosedPublic
Actions

Authored by joshuaspence on Jul 21 2014, 9:39 AM.

Details

Reviewers

epriestley

Group Reviewers

Blessed Reviewers

Maniphest Tasks

T5655: Standardize naming conventions

Commits

rPHU51472fd62263: Rename `PhutilRemarkupRule` subclasses

Summary

Ref T5655. Some discussion in D9839. Generally speaking, Phutil{$name}RemarkupRule is clearer than PhutilRemarkupRule{$name}.

Test Plan

Not yet tested... this is likely to break external code, so I'm not sure whether or not we want to pursue this.

Diff Detail

Repository

rPHU libphutil

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

joshuaspence updated this revision to Diff 24017.Jul 21 2014, 9:39 AM

joshuaspence retitled this revision from to Rename `PhutilRemarkupRule` subclasses.

joshuaspence updated this object.

joshuaspence edited the test plan for this revision. (Show Details)

joshuaspence added a reviewer: epriestley.

joshuaspence added a task: T5655: Standardize naming conventions.

Herald added a reviewer: Blessed Reviewers. · View Herald TranscriptJul 21 2014, 9:39 AM

Herald added subscribers: Korvin, epriestley. · View Herald Transcript

Harbormaster completed remote builds in B1800: Diff 24017.Jul 21 2014, 9:40 AM

I'm not really sure about how PhutilRemarkupEngineBlockRule subclasses should be named.

In D9993#7, @joshuaspence wrote:

I'm not really sure about how PhutilRemarkupEngineBlockRule subclasses should be named.

I think perhaps PhutilRemarkupEngineRemarkupLiteralBlockRule should really be PhutilLiteralRemarkupRemarkupBlockRule.

Maybe these should be PhutilRemarkupBoldRule, not PhutilBoldRemarkupRule? That makes the custom rules in D9994 a little easier too.

I think you're right on the literal rule.

In D9993#9, @epriestley wrote:

Maybe these should be PhutilRemarkupBoldRule, not PhutilBoldRemarkupRule? That makes the custom rules in D9994 a little easier too.

Yeah, I did it this way originally but changed my mind... hmm...

Rename classes
Rename block rules too

Harbormaster completed remote builds in B1809: Diff 24032.Jul 21 2014, 3:04 PM

epriestley accepted this revision.Jul 21 2014, 3:24 PM

epriestley edited edge metadata.

This revision is now accepted and ready to land.Jul 21 2014, 3:24 PM

joshuaspence added inline comments.Jul 21 2014, 10:11 PM

src/markup/engine/remarkup/markuprule/PhutilRemarkupHyperlinkRule.php
3	Oh, this probably isn't okay... Should I provide a migration path or is this an outdated TODO?

Rename classes
Rename block rules too
Remove duplicated PhutilRemarkupEngineRemarkupTestInterpreterRule class

epriestley added inline comments.Jul 21 2014, 10:22 PM

src/markup/engine/remarkup/markuprule/PhutilRemarkupHyperlinkRule.php
3	I think it's OK to break Facebook, there is a reasonable pathway for them to stop subclassing this. I'll loop them in on the task.

Harbormaster completed remote builds in B1820: Diff 24050.Jul 21 2014, 10:22 PM

Closed by commit rPHU51472fd62263 (authored by @joshuaspence).

Revision Contents
Changeset List

Path

Size

src/

__phutil_library_map__.php

94 lines

markup/

engine/

PhutilRemarkupEngine.php

4 lines

__tests__/

PhutilRemarkupEngineTestCase.php

47 lines

remarkup/

blockrule/

	PhutilRemarkupBlockRule.php
	PhutilRemarkupEngineBlockRule.php

2 lines

	PhutilRemarkupCodeBlockRule.php
	PhutilRemarkupEngineRemarkupCodeBlockRule.php

3 lines

	PhutilRemarkupDefaultBlockRule.php
	PhutilRemarkupEngineRemarkupDefaultBlockRule.php

3 lines

PhutilRemarkupEngineBlockRule.php

PhutilRemarkupEngineRemarkupCodeBlockRule.php

PhutilRemarkupEngineRemarkupDefaultBlockRule.php

PhutilRemarkupEngineRemarkupHeaderBlockRule.php

PhutilRemarkupEngineRemarkupHorizontalRuleBlockRule.php

PhutilRemarkupEngineRemarkupInlineBlockRule.php

PhutilRemarkupEngineRemarkupInterpreterRule.php

PhutilRemarkupEngineRemarkupListBlockRule.php

PhutilRemarkupEngineRemarkupLiteralBlockRule.php

PhutilRemarkupEngineRemarkupNoteBlockRule.php

PhutilRemarkupEngineRemarkupQuotesBlockRule.php

PhutilRemarkupEngineRemarkupReplyBlockRule.php

PhutilRemarkupEngineRemarkupSimpleTableBlockRule.php

PhutilRemarkupEngineRemarkupTableBlockRule.php

PhutilRemarkupEngineRemarkupTestInterpreterRule.php

	PhutilRemarkupHeaderBlockRule.php
	PhutilRemarkupEngineRemarkupHeaderBlockRule.php

3 lines

	PhutilRemarkupHorizontalRuleBlockRule.php
	PhutilRemarkupEngineRemarkupHorizontalRuleBlockRule.php

4 lines

	PhutilRemarkupInlineBlockRule.php
	PhutilRemarkupEngineRemarkupInlineBlockRule.php

3 lines

	PhutilRemarkupInterpreterBlockRule.php
	PhutilRemarkupEngineRemarkupInterpreterRule.php

5 lines

	PhutilRemarkupListBlockRule.php
	PhutilRemarkupEngineRemarkupListBlockRule.php

3 lines

	PhutilRemarkupLiteralBlockRule.php
	PhutilRemarkupEngineRemarkupLiteralBlockRule.php

3 lines

	PhutilRemarkupNoteBlockRule.php
	PhutilRemarkupEngineRemarkupNoteBlockRule.php

3 lines

	PhutilRemarkupQuotesBlockRule.php
	PhutilRemarkupEngineRemarkupQuotesBlockRule.php

3 lines

	PhutilRemarkupReplyBlockRule.php
	PhutilRemarkupEngineRemarkupReplyBlockRule.php

3 lines

	PhutilRemarkupSimpleTableBlockRule.php
	PhutilRemarkupEngineRemarkupSimpleTableBlockRule.php

3 lines

	PhutilRemarkupTableBlockRule.php
	PhutilRemarkupEngineRemarkupTableBlockRule.php

3 lines

	PhutilRemarkupTestInterpreterRule.php
	PhutilRemarkupEngineRemarkupTestInterpreterRule.php

2 lines

markuprule/

	PhutilRemarkupBoldRule.php
	PhutilRemarkupRuleBold.php

2 lines

	PhutilRemarkupDelRule.php
	PhutilRemarkupRuleDel.php

2 lines

	PhutilRemarkupDocumentLinkRule.php
	PhutilRemarkupRuleDocumentLink.php

2 lines

	PhutilRemarkupEscapeRemarkupRule.php
	PhutilRemarkupRuleEscapeRemarkup.php

2 lines

	PhutilRemarkupHyperlinkRule.php
	PhutilRemarkupRuleHyperlink.php

5 lines

	PhutilRemarkupItalicRule.php
	PhutilRemarkupRuleItalic.php

2 lines

	PhutilRemarkupLinebreaksRule.php
	PhutilRemarkupRuleLinebreaks.php

2 lines

	PhutilRemarkupMonospaceRule.php
	PhutilRemarkupRuleMonospace.php

2 lines

PhutilRemarkupRuleBold.php

PhutilRemarkupRuleDel.php

PhutilRemarkupRuleDocumentLink.php

PhutilRemarkupRuleEscapeRemarkup.php

PhutilRemarkupRuleHyperlink.php

PhutilRemarkupRuleItalic.php

PhutilRemarkupRuleLinebreaks.php

PhutilRemarkupRuleMonospace.php

PhutilRemarkupRuleUnderline.php

	PhutilRemarkupUnderlineRule.php
	PhutilRemarkupRuleUnderline.php

3 lines

Diff 24382

View Options

src/__phutil_library_map__.php

View Options

src/markup/engine/PhutilRemarkupEngine.php

View Options

src/markup/engine/tests/PhutilRemarkupEngineTestCase.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupCodeBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupDefaultBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupCodeBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupDefaultBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupHeaderBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupHorizontalRuleBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupInlineBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupInterpreterRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupListBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupLiteralBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupNoteBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupQuotesBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupReplyBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupSimpleTableBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupTableBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupTestInterpreterRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupHeaderBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupHorizontalRuleBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupInlineBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupInterpreterBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupListBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupLiteralBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupNoteBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupQuotesBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupReplyBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupSimpleTableBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupTableBlockRule.php

View Options

src/markup/engine/remarkup/blockrule/PhutilRemarkupTestInterpreterRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupBoldRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupDelRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupDocumentLinkRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupEscapeRemarkupRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupHyperlinkRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupItalicRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupLinebreaksRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupMonospaceRule.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleBold.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleDel.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleDocumentLink.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleEscapeRemarkup.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleHyperlink.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleItalic.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleLinebreaks.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleMonospace.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleUnderline.php

View Options

src/markup/engine/remarkup/markuprule/PhutilRemarkupUnderlineRule.php

Rename `PhutilRemarkupRule` subclassesClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 24382

src/__phutil_library_map__.php

src/markup/engine/PhutilRemarkupEngine.php

src/markup/engine/__tests__/PhutilRemarkupEngineTestCase.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupCodeBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupDefaultBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupCodeBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupDefaultBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupHeaderBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupHorizontalRuleBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupInlineBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupInterpreterRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupListBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupLiteralBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupNoteBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupQuotesBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupReplyBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupSimpleTableBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupTableBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupEngineRemarkupTestInterpreterRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupHeaderBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupHorizontalRuleBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupInlineBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupInterpreterBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupListBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupLiteralBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupNoteBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupQuotesBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupReplyBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupSimpleTableBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupTableBlockRule.php

src/markup/engine/remarkup/blockrule/PhutilRemarkupTestInterpreterRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupBoldRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupDelRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupDocumentLinkRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupEscapeRemarkupRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupHyperlinkRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupItalicRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupLinebreaksRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupMonospaceRule.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleBold.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleDel.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleDocumentLink.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleEscapeRemarkup.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleHyperlink.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleItalic.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleLinebreaks.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleMonospace.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupRuleUnderline.php

src/markup/engine/remarkup/markuprule/PhutilRemarkupUnderlineRule.php

Rename `PhutilRemarkupRule` subclasses
ClosedPublic
Actions

Revision Contents
Changeset List

src/markup/engine/tests/PhutilRemarkupEngineTestCase.php