brief 0.0.5 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Gemfile.lock +71 -55
  4. data/README.md +149 -48
  5. data/Rakefile +15 -5
  6. data/bin/brief +15 -28
  7. data/brief.gemspec +17 -11
  8. data/examples/blog/brief.rb +54 -0
  9. data/examples/blog/docs/an-intro-to-brief.html.md +9 -0
  10. data/lib/.DS_Store +0 -0
  11. data/lib/brief/briefcase.rb +78 -0
  12. data/lib/brief/cli/change.rb +14 -0
  13. data/lib/brief/cli/init.rb +66 -0
  14. data/{spec/fixtures/generated/project_overview.json → lib/brief/cli/publish.rb} +0 -0
  15. data/lib/brief/cli/write.rb +0 -0
  16. data/lib/brief/configuration.rb +19 -115
  17. data/lib/brief/core_ext.rb +11 -0
  18. data/lib/brief/document/content_extractor.rb +33 -0
  19. data/lib/brief/document/front_matter.rb +20 -0
  20. data/lib/brief/document/rendering.rb +37 -0
  21. data/lib/brief/document.rb +43 -38
  22. data/lib/brief/document_mapper.rb +158 -0
  23. data/lib/brief/dsl.rb +42 -0
  24. data/lib/brief/model/definition.rb +117 -0
  25. data/lib/brief/model.rb +177 -0
  26. data/lib/brief/repository.rb +57 -0
  27. data/lib/brief/version.rb +1 -7
  28. data/lib/brief.rb +35 -40
  29. data/spec/fixtures/example/brief.rb +27 -0
  30. data/spec/fixtures/example/docs/concept.html.md +5 -0
  31. data/spec/fixtures/example/docs/epic.html.md +19 -0
  32. data/spec/fixtures/example/docs/persona.html.md +5 -0
  33. data/spec/fixtures/example/docs/release.html.md +7 -0
  34. data/spec/fixtures/example/docs/resource.html.md +5 -0
  35. data/spec/fixtures/example/docs/user_story.html.md +24 -0
  36. data/spec/fixtures/example/docs/wireframe.html.md +5 -0
  37. data/spec/fixtures/example/models/epic.rb +16 -0
  38. data/spec/lib/brief/briefcase_spec.rb +27 -0
  39. data/spec/lib/brief/document_spec.rb +14 -22
  40. data/spec/lib/brief/dsl_spec.rb +4 -15
  41. data/spec/lib/brief/model_spec.rb +84 -0
  42. data/spec/lib/brief/repository_spec.rb +60 -0
  43. data/spec/spec_helper.rb +12 -14
  44. data/spec/support/test_helpers.rb +0 -0
  45. data/tasks/brief/release.rake +0 -0
  46. metadata +120 -110
  47. data/.gitignore +0 -1
  48. data/Guardfile +0 -5
  49. data/examples/project_overview.md +0 -23
  50. data/lib/brief/cli/commands/config.rb +0 -40
  51. data/lib/brief/cli/commands/publish.rb +0 -27
  52. data/lib/brief/cli/commands/write.rb +0 -27
  53. data/lib/brief/formatters/base.rb +0 -12
  54. data/lib/brief/formatters/github_milestone_rollup.rb +0 -52
  55. data/lib/brief/git.rb +0 -19
  56. data/lib/brief/github/wiki.rb +0 -9
  57. data/lib/brief/github.rb +0 -141
  58. data/lib/brief/github_client/authentication.rb +0 -32
  59. data/lib/brief/github_client/client.rb +0 -86
  60. data/lib/brief/github_client/commands.rb +0 -5
  61. data/lib/brief/github_client/issue_labels.rb +0 -65
  62. data/lib/brief/github_client/issues.rb +0 -22
  63. data/lib/brief/github_client/milestone_issues.rb +0 -13
  64. data/lib/brief/github_client/organization_activity.rb +0 -9
  65. data/lib/brief/github_client/organization_issues.rb +0 -13
  66. data/lib/brief/github_client/organization_repositories.rb +0 -20
  67. data/lib/brief/github_client/organization_users.rb +0 -9
  68. data/lib/brief/github_client/repository_events.rb +0 -8
  69. data/lib/brief/github_client/repository_issue_events.rb +0 -9
  70. data/lib/brief/github_client/repository_issues.rb +0 -8
  71. data/lib/brief/github_client/repository_labels.rb +0 -18
  72. data/lib/brief/github_client/repository_milestones.rb +0 -9
  73. data/lib/brief/github_client/request.rb +0 -181
  74. data/lib/brief/github_client/request_wrapper.rb +0 -121
  75. data/lib/brief/github_client/response_object.rb +0 -50
  76. data/lib/brief/github_client/single_repository.rb +0 -9
  77. data/lib/brief/github_client/user_activity.rb +0 -16
  78. data/lib/brief/github_client/user_gists.rb +0 -9
  79. data/lib/brief/github_client/user_info.rb +0 -9
  80. data/lib/brief/github_client/user_issues.rb +0 -13
  81. data/lib/brief/github_client/user_organizations.rb +0 -9
  82. data/lib/brief/github_client/user_repositories.rb +0 -9
  83. data/lib/brief/github_client.rb +0 -43
  84. data/lib/brief/handlers/base.rb +0 -62
  85. data/lib/brief/handlers/github_issue.rb +0 -41
  86. data/lib/brief/handlers/github_milestone.rb +0 -37
  87. data/lib/brief/handlers/github_wiki.rb +0 -11
  88. data/lib/brief/line.rb +0 -69
  89. data/lib/brief/parser.rb +0 -354
  90. data/lib/brief/publisher/handler_manager.rb +0 -47
  91. data/lib/brief/publisher.rb +0 -142
  92. data/lib/brief/tree.rb +0 -43
  93. data/lib/core_ext.rb +0 -37
  94. data/spec/fixtures/front_end_tutorial.md +0 -33
  95. data/spec/fixtures/generator_dsl_example.rb +0 -22
  96. data/spec/fixtures/project_overview.md +0 -48
  97. data/spec/fixtures/sample.md +0 -19
  98. data/spec/lib/brief/line_spec.rb +0 -11
  99. data/spec/lib/brief/parser_spec.rb +0 -12
data/spec/fixtures/project_overview.md DELETED
@@ -1,48 +0,0 @@
1
- # Wiki Page Heading
2
-
3
- Content. Will go on a wiki page. The content below here, and the subheadings, will be replaced with a roll-up / summary of the elements.
4
-
5
- ## Milestone Heading
6
-
7
- This content will go in the milestone body. The wiki page that this belongs to, will include a different kind of view of this content.
8
-
9
- ### An issue title
10
-
11
- This goes in the issue's body. The wiki page this belongs to will possibly have a link to the issue and a label for its status.
12
-
13
- ### Another issue title
14
-
15
- This goes in this issue's body. Same thing. It obviously belongs to the milestone.
16
-
17
- ## Milestone Heading Two
18
-
19
- Additional content for the milestone heading.
20
-
21
- ### Another nested issue
22
-
23
- This one has some content, as well as a code block.
24
-
25
- ```ruby
26
- class MyClass
27
- def sup
28
- puts "Sup?"
29
- end
30
- end
31
- ```
32
-
33
- Some more content for safety's sake.
34
-
35
- ### Another nested issue my man
36
-
37
- Some plain old content with a list:
38
-
39
- - item one
40
- - item two
41
- - item three
42
- - item four
43
-
44
- #### What about this deep heading? It should be meaningless.
45
-
46
- ## A Third milestone
47
-
48
- No content exists.
data/spec/fixtures/sample.md DELETED
@@ -1,19 +0,0 @@
1
- # Heading One
2
-
3
- Content under heading one.
4
-
5
- ## Subheading One
6
-
7
- Subheading One is my parent. Heading One is my grandparent.
8
-
9
- ## Subheading Two
10
-
11
- Subheading Two is my parent. Heading one is my grandparent.
12
-
13
- # Heading Two
14
-
15
- Heading two content.
16
-
17
- ## Subheading Three
18
-
19
- Subheading Three is my parent. Heading Two is my grandparent.
data/spec/lib/brief/line_spec.rb DELETED
@@ -1,11 +0,0 @@
1
- require "spec_helper"
2
-
3
- describe Brief::Line do
4
- let(:heading1) { Brief::Line.new("# sup?", 1, false) }
5
- let(:heading2) { Brief::Line.new("##sup?", 2, false) }
6
-
7
- it "should set the level" do
8
- expect(heading1.level).to eq(1)
9
- expect(heading2.level).to eq(2)
10
- end
11
- end
data/spec/lib/brief/parser_spec.rb DELETED
@@ -1,12 +0,0 @@
1
- require "spec_helper"
2
-
3
- describe Brief::Parser do
4
- let(:sample) do
5
- Brief::Document.new(Brief.fixtures.join("sample.md")).parser
6
- end
7
-
8
- it "should give me information about the headings" do
9
- expect(sample.headings_at_level(1)).to eq(["Heading One", "Heading Two"])
10
- expect(sample.headings_at_level(2)).to eq(["Subheading One", "Subheading Two", "Subheading Three"])
11
- end
12
- end