Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for multiple fragments with the same ticket and type #119

Merged
merged 9 commits into from
Sep 6, 2018
Merged

Allow for multiple fragments with the same ticket and type #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0a202af
Allow for multiple fragments with the same ticket and type
Cadair May 30, 2018
7196fab
use ordereddict for predictable output
Cadair May 30, 2018
517b79b
Merge branch 'master' into multiple_fragments
hawkowl Jun 12, 2018
31f87f7
run black on this too
hawkowl Jun 12, 2018
c9a6b55
fix for a test I added after
hawkowl Jun 12, 2018
4ea1ea7
Add a changelog entry for multiple fragments
Cadair Jun 12, 2018
e997350
Merge branch 'master' into multiple_fragments
Cadair Jul 19, 2018
2706cc4
Merge branch 'master' into multiple_fragments
Cadair Sep 6, 2018
009c5b4
Merge branch 'master' into multiple_fragments
hawkowl Sep 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions src/towncrier/_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,37 @@ def find_fragments(base_directory, sections, fragment_directory, definitions):
for basename in files:
parts = basename.split(u".")

counter = 0
if len(parts) == 1:
continue
else:
ticket, category = parts[:2]

# If there is a number after the category then use it as a counter,
# otherwise ignore it.
# This means 1.feature.1 and 1.feature do not conflict but
# 1.feature.rst and 1.feature do.
if len(parts) > 2:
try:
counter = int(parts[2])
except ValueError:
pass

if category not in definitions:
continue

full_filename = os.path.join(section_dir, basename)
fragment_filenames.append(full_filename)
with open(full_filename, "rb") as f:
data = f.read().decode("utf8", "replace")
if (ticket, category) in file_content:

if (ticket, category, counter) in file_content:
raise ValueError(
"multiple files for {}.{} in {}".format(
ticket, category, section_dir
)
)
file_content[ticket, category] = data
file_content[ticket, category, counter] = data

content[key] = file_content

Expand Down Expand Up @@ -93,14 +105,14 @@ def split_fragments(fragments, definitions):
for section_name, section_fragments in fragments.items():
section = {}

for (ticket, category), content in section_fragments.items():
for (ticket, category, counter), content in section_fragments.items():

content = indent(content.strip(), u" ")[2:]

if definitions[category]["showcontent"] is False:
content = u""

texts = section.get(category, {})
texts = section.get(category, OrderedDict())

if texts.get(content):
texts[content] = sorted(texts[content] + [ticket])
Expand Down
3 changes: 3 additions & 0 deletions src/towncrier/newsfragments/119.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Add support for multiple fragements per issue/type pair. This extends the
naming pattern of the fragments to `issuenumber.type(.counter)` where counter
is an optional integer.
52 changes: 27 additions & 25 deletions src/towncrier/test/test_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ def test_split(self):

fragments = {
"": {
("1", "misc"): u"",
("baz", "misc"): u"",
("2", "feature"): u"Foo added.",
("5", "feature"): u"Foo added. \n",
("6", "bugfix"): u"Foo added.",
("1", "misc", 0): u"",
("baz", "misc", 0): u"",
("2", "feature", 0): u"Foo added.",
("5", "feature", 0): u"Foo added. \n",
("6", "bugfix", 0): u"Foo added.",
},
"Web": {
("3", "bugfix"): u"Web fixed. ",
("4", "feature"): u"Foo added.",
("3", "bugfix", 0): u"Web fixed. ",
("4", "feature", 0): u"Foo added.",
},
}

Expand Down Expand Up @@ -65,19 +65,19 @@ def test_basic(self):
{
# asciibetical sorting will do 1, 142, 9
# we want 1, 9, 142 instead
("142", "misc"): u"",
("1", "misc"): u"",
("9", "misc"): u"",
("bar", "misc"): u"",
("4", "feature"): u"Stuff!",
("2", "feature"): u"Foo added.",
("72", "feature"): u"Foo added.",
("9", "feature"): u"Foo added.",
("baz", "feature"): u"Fun!",
("142", "misc", 0): u"",
("1", "misc", 0): u"",
("9", "misc", 0): u"",
("bar", "misc", 0): u"",
("4", "feature", 0): u"Stuff!",
("2", "feature", 0): u"Foo added.",
("72", "feature", 0): u"Foo added.",
("9", "feature", 0): u"Foo added.",
("baz", "feature", 0): u"Fun!",
},
),
("Names", {}),
("Web", {("3", "bugfix"): u"Web fixed."}),
("Web", {("3", "bugfix", 0): u"Web fixed."}),
]
)

Expand Down Expand Up @@ -180,10 +180,10 @@ def test_issue_format(self):
"": {
# asciibetical sorting will do 1, 142, 9
# we want 1, 9, 142 instead
("142", "misc"): u"",
("1", "misc"): u"",
("9", "misc"): u"",
("bar", "misc"): u"",
("142", "misc", 0): u"",
("1", "misc", 0): u"",
("9", "misc", 0): u"",
("bar", "misc", 0): u"",
}
}

Expand Down Expand Up @@ -220,11 +220,12 @@ def test_line_wrapping(self):
(
"1",
"feature",
0,
): u"""
asdf asdf asdf asdf looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong newsfragment.
""", # NOQA
("2", "feature"): u"https://google.com/q=?" + u"-" * 100,
("3", "feature"): u"a " * 80,
("2", "feature", 0): u"https://google.com/q=?" + u"-" * 100,
("3", "feature", 0): u"a " * 80,
}
}

Expand Down Expand Up @@ -270,11 +271,12 @@ def test_line_wrapping_disabled(self):
(
"1",
"feature",
0
): u"""
asdf asdf asdf asdf looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong newsfragment.
""", # NOQA
("2", "feature"): u"https://google.com/q=?" + u"-" * 100,
("3", "feature"): u"a " * 80,
("2", "feature", 0): u"https://google.com/q=?" + u"-" * 100,
("3", "feature", 0): u"a " * 80,
}
}

Expand Down
34 changes: 19 additions & 15 deletions src/towncrier/test/test_write.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@ def test_append_at_top(self):
[
(
"",
{
("142", "misc"): u"",
("1", "misc"): u"",
("4", "feature"): u"Stuff!",
("2", "feature"): u"Foo added.",
("72", "feature"): u"Foo added.",
},
OrderedDict(
[
(("142", "misc", 0), u""),
(("1", "misc", 0), u""),
(("4", "feature", 0), u"Stuff!"),
(("4", "feature", 1), u"Second Stuff!"),
(("2", "feature", 0), u"Foo added."),
(("72", "feature", 0), u"Foo added."),
]
),
),
("Names", {}),
("Web", {("3", "bugfix"): u"Web fixed."}),
("Web", {("3", "bugfix", 0): u"Web fixed."}),
]
)

Expand All @@ -48,6 +51,7 @@ def test_append_at_top(self):

- Foo added. (#2, #72)
- Stuff! (#4)
- Second Stuff! (#4)


Misc
Expand Down Expand Up @@ -111,16 +115,16 @@ def test_append_at_top_with_hint(self):
(
"",
{
("142", "misc"): u"",
("1", "misc"): u"",
("4", "feature"): u"Stuff!",
("2", "feature"): u"Foo added.",
("72", "feature"): u"Foo added.",
("99", "feature"): u"Foo! " * 100,
("142", "misc", 0): u"",
("1", "misc", 0): u"",
("4", "feature", 0): u"Stuff!",
("2", "feature", 0): u"Foo added.",
("72", "feature", 0): u"Foo added.",
("99", "feature", 0): u"Foo! " * 100,
},
),
("Names", {}),
("Web", {("3", "bugfix"): u"Web fixed."}),
("Web", {("3", "bugfix", 0): u"Web fixed."}),
]
)

Expand Down