brief 1.9.2 → 1.9.3

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 (8) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +15 -18
  3. data/brief.gemspec +13 -15
  4. data/lib/brief/cli/all.rb +0 -33
  5. data/lib/brief/cli/browse.rb +92 -0
  6. data/lib/brief/cli/parse.rb +0 -2
  7. data/lib/brief/version.rb +1 -1
  8. metadata +40 -53
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3986559b2d00c997b91f9fef8d1adda8830b5907
4
- data.tar.gz: b959ef3fe431b2da4e4a3acf857dc174e82b9337
3
+ metadata.gz: e9353dc2ff984b652d2f5ef9625af31c0dea60ca
4
+ data.tar.gz: 0b7ad9487a03ae4788813b72c7f421c4664af67c
5
5
  SHA512:
6
- metadata.gz: a7bb4ff6a9bc110c6e2c69277d748ecc955fb47586c0556ff3f812236de266ee3077d4f2efc33b675427711e93dd8ef677432e5b1145bf8f7764f62b4d3a05c1
7
- data.tar.gz: 66121eaf98cfe7bf55123c294477ba39e8c705edd14b25dea821d6e378dc11f58cfcbb7276f91c17e08a579ff41c7c6bf971233f75a97ecbffdc27c21bd4a90b
6
+ metadata.gz: 4c9c44d76097901368cbd8fc99a115248d2e6bf546dff1cbeb4e5932eec4cfafb77b9ad3a59d93c18d21b6008b8fedfd225dd8c5b4b4c29c5871c5c69df0684a
7
+ data.tar.gz: b5e027082b31f8b32d751add31cc2bea6e51c580297b259aa9a271675e8fa840e0d4eec9c0d8d0f9efbd4a4fd4e0d922a30017fe4ee15d709c0d19caf8fea417
data/Gemfile.lock CHANGED
@@ -1,15 +1,15 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- brief (1.9.2)
5
- activesupport (>= 4.0)
6
- commander (>= 4.2.1)
7
- github-fs
8
- github-markdown (~> 0.6.8)
9
- hashie (< 3.0)
10
- inflecto
4
+ brief (1.9.3)
5
+ activesupport (~> 4.0)
6
+ commander (~> 4.3)
7
+ github-fs (~> 0)
8
+ github-markdown (= 0.6.8)
9
+ hashie (~> 3.0)
10
+ inflecto (~> 0)
11
11
  nokogiri (= 1.6.5)
12
- virtus (>= 1.0.3)
12
+ virtus (~> 1.0)
13
13
 
14
14
  GEM
15
15
  remote: https://rubygems.org/
@@ -41,7 +41,7 @@ GEM
41
41
  octokit
42
42
  rack
43
43
  github-markdown (0.6.8)
44
- hashie (2.0.5)
44
+ hashie (3.4.0)
45
45
  highline (1.7.1)
46
46
  i18n (0.7.0)
47
47
  ice_nine (0.11.1)
@@ -59,12 +59,10 @@ GEM
59
59
  coderay (~> 1.1.0)
60
60
  method_source (~> 0.8.1)
61
61
  slop (~> 3.4)
62
- pry-nav (0.2.4)
63
- pry (>= 0.9.10, < 0.11.0)
64
62
  rack (1.6.0)
65
63
  rack-test (0.6.3)
66
64
  rack (>= 1.0)
67
- rake (10.4.2)
65
+ rake (0.9.6)
68
66
  rspec (3.1.0)
69
67
  rspec-core (~> 3.1.0)
70
68
  rspec-expectations (~> 3.1.0)
@@ -96,9 +94,8 @@ PLATFORMS
96
94
  DEPENDENCIES
97
95
  brief!
98
96
  bundler (~> 1.3)
99
- octokit
100
- pry
101
- pry-nav
102
- rack-test
103
- rake
104
- rspec
97
+ octokit (~> 3.0)
98
+ pry (~> 0.10)
99
+ rack-test (~> 0.6)
100
+ rake (~> 0)
101
+ rspec (~> 3.0)
data/brief.gemspec CHANGED
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["jonathan.soeder@gmail.com"]
11
11
  spec.summary = %q{Brief makes writing more powerful}
12
12
  spec.description = %q{Brief is a library for developing applications whose primary interface is the text editor}
13
- spec.homepage = ""
13
+ spec.homepage = "https://architects.io/brief"
14
14
  spec.license = "MIT"
15
15
 
16
16
  spec.files = `git ls-files -z`.split("\x0")
@@ -18,29 +18,27 @@ Gem::Specification.new do |spec|
18
18
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
19
  spec.require_paths = ["lib"]
20
20
 
21
- spec.add_dependency 'hashie', '< 3.0'
22
- spec.add_dependency 'commander', '>= 4.2.1'
23
- spec.add_dependency 'github-fs'
24
- spec.add_dependency 'virtus', '>= 1.0.3'
25
- spec.add_dependency 'inflecto'
26
- #spec.add_dependency 'activemodel'
27
- spec.add_dependency 'activesupport', '>= 4.0'
21
+ spec.add_dependency 'hashie', '~> 3.0'
22
+ spec.add_dependency 'commander', '~> 4.3'
23
+ spec.add_dependency 'github-fs', '~> 0'
24
+ spec.add_dependency 'virtus', '~> 1.0'
25
+ spec.add_dependency 'inflecto', '~> 0'
26
+ spec.add_dependency 'activesupport', '~> 4.0'
28
27
  spec.add_dependency 'nokogiri', '1.6.5'
29
28
 
30
29
  #spec.add_dependency 'github-markup', '~> 1.3.1'
31
30
  #spec.add_dependency 'github-linguist', '~> 4.2.5'
32
31
  #spec.add_dependency 'html-pipeline', '~> 1.11.0'
33
32
  #spec.add_dependency 'sanitize', '~> 3.1.0'
34
- spec.add_dependency 'github-markdown', '~> 0.6.8'
33
+ spec.add_dependency 'github-markdown', '0.6.8'
35
34
 
36
35
 
37
36
  spec.add_development_dependency "bundler", "~> 1.3"
38
- spec.add_development_dependency "rake"
39
- spec.add_development_dependency "pry"
40
- spec.add_development_dependency "pry-nav"
41
- spec.add_development_dependency "rspec"
42
- spec.add_development_dependency "rack-test"
43
- spec.add_development_dependency 'octokit'
37
+ spec.add_development_dependency "rake", "~> 0"
38
+ spec.add_development_dependency "pry", "~> 0.10"
39
+ spec.add_development_dependency "rspec", "~> 3.0"
40
+ spec.add_development_dependency "rack-test", "~> 0.6"
41
+ spec.add_development_dependency 'octokit', "~> 3.0"
44
42
  end
45
43
 
46
44
 
data/lib/brief/cli/all.rb CHANGED
@@ -56,36 +56,3 @@ command 'init' do |c|
56
56
  false
57
57
  end
58
58
  end
59
-
60
- command "browse" do |c|
61
- c.syntax = "brief browse FOLDER"
62
- c.description = "Lists information about each of the briefcases in FOLDER"
63
-
64
- c.option '--config-filename FILENAME', String, 'Which filename has the briefcase config? default(brief.rb)'
65
- c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
66
- c.option '--include-schema', 'Include schema information'
67
- c.option '--include-models', 'Include individual models as well'
68
- c.option '--include-content', 'Gets passed to the model renderers if present'
69
- c.option '--include-rendered', 'Gets passed to the model renderers if present'
70
- c.option '--include-urls', 'Gets passed to the model renderers if present'
71
-
72
- c.action do |args, options|
73
- folder = Pathname(args.first)
74
-
75
- options.default(config_filename:'brief.rb', presenter_format: 'default')
76
-
77
- roots = folder.children.select do |root|
78
- root.join(options.config_filename).exist?
79
- end
80
-
81
- briefcases = roots.map {|root| Brief::Briefcase.new(root: Pathname(root).realpath) }
82
-
83
- briefcases.map do |b|
84
- b.present(options.presenter_format, rendered: options.include_rendered,
85
- content: options.include_content,
86
- urls: options.include_urls,
87
- schema: options.include_schema,
88
- models: options.include_models)
89
- end
90
- end
91
- end
data/lib/brief/cli/browse.rb ADDED
@@ -0,0 +1,92 @@
1
+ command 'browse documents' do |c|
2
+ c.syntax = 'brief browse documents PATHS [OPTIONS]'
3
+ c.description = 'browse documents in the briefcase path'
4
+
5
+ c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
6
+ c.option '--include-urls', 'Gets passed to the model renderers if present'
7
+
8
+ c.example "Browsing an arbitrary selection of documents", "brief parse ./blueprint/docs/epics ./blueprint/docs/user_stories --root=./blueprint --format json --include-rendered --include-content"
9
+
10
+ c.action do |args, options|
11
+ options.default(root: Pathname(Brief.pwd), output_type: "array")
12
+
13
+ o = {
14
+ root: options.root
15
+ }
16
+
17
+ o[:config_path] = options.config_path if options.config_path
18
+
19
+ briefcase = Brief::Briefcase.new(o)
20
+
21
+ args.map! do |arg|
22
+ arg = Pathname(arg)
23
+
24
+ if arg.directory?
25
+ Dir[arg.join('**/*')].map {|f| Pathname(f) }
26
+ else
27
+ arg
28
+ end
29
+ end
30
+
31
+ args.flatten!
32
+
33
+ args.select! {|arg| Brief::Util.ensure_child_path(briefcase.docs_path, arg) }
34
+
35
+ model_params = {
36
+ urls: !!options.include_urls,
37
+ content: false,
38
+ rendered: false,
39
+ schema: false,
40
+ models: false
41
+ }
42
+
43
+ parsed = args.map do |path|
44
+ Brief::Document.new(path)
45
+ .in_briefcase(briefcase)
46
+ .to_model
47
+ .as_json(model_params)
48
+ end
49
+
50
+ if options.output_type == "hash"
51
+ parsed = parsed.inject({}) do |memo, obj|
52
+ path = obj[:path]
53
+ memo[path] = obj
54
+ memo
55
+ end
56
+ end
57
+
58
+ parsed
59
+ end
60
+ end
61
+ command "browse projects" do |c|
62
+ c.syntax = "brief browse projects FOLDER"
63
+ c.description = "Lists information about each of the briefcases in FOLDER"
64
+
65
+ c.option '--config-filename FILENAME', String, 'Which filename has the briefcase config? default(brief.rb)'
66
+ c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
67
+ c.option '--include-schema', 'Include schema information'
68
+ c.option '--include-models', 'Include individual models as well'
69
+ c.option '--include-content', 'Gets passed to the model renderers if present'
70
+ c.option '--include-rendered', 'Gets passed to the model renderers if present'
71
+ c.option '--include-urls', 'Gets passed to the model renderers if present'
72
+
73
+ c.action do |args, options|
74
+ folder = Pathname(args.first)
75
+
76
+ options.default(config_filename:'brief.rb', presenter_format: 'default')
77
+
78
+ roots = folder.children.select do |root|
79
+ root.join(options.config_filename).exist?
80
+ end
81
+
82
+ briefcases = roots.map {|root| Brief::Briefcase.new(root: Pathname(root).realpath) }
83
+
84
+ briefcases.map do |b|
85
+ b.present(options.presenter_format, rendered: options.include_rendered,
86
+ content: options.include_content,
87
+ urls: options.include_urls,
88
+ schema: options.include_schema,
89
+ models: options.include_models)
90
+ end
91
+ end
92
+ end
data/lib/brief/cli/parse.rb CHANGED
@@ -3,8 +3,6 @@ command 'parse' do |c|
3
3
  c.description = 'parse the briefcase path'
4
4
 
5
5
  c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
6
- c.option '--include-schema', 'Include schema information'
7
- c.option '--include-models', 'Include individual models as well'
8
6
  c.option '--include-content', 'Gets passed to the model renderers if present'
9
7
  c.option '--include-rendered', 'Gets passed to the model renderers if present'
10
8
  c.option '--include-urls', 'Gets passed to the model renderers if present'
data/lib/brief/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Brief
2
- VERSION = '1.9.2'
2
+ VERSION = '1.9.3'
3
3
  end
metadata CHANGED
@@ -1,97 +1,97 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: brief
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.9.2
4
+ version: 1.9.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonathan Soeder
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-03-30 00:00:00.000000000 Z
11
+ date: 2015-03-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: hashie
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "<"
17
+ - - "~>"
18
18
  - !ruby/object:Gem::Version
19
19
  version: '3.0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "<"
24
+ - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '3.0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: commander
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - ">="
31
+ - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 4.2.1
33
+ version: '4.3'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - ">="
38
+ - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 4.2.1
40
+ version: '4.3'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: github-fs
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - ">="
45
+ - - "~>"
46
46
  - !ruby/object:Gem::Version
47
47
  version: '0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - ">="
52
+ - - "~>"
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: virtus
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ">="
59
+ - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 1.0.3
61
+ version: '1.0'
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 1.0.3
68
+ version: '1.0'
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: inflecto
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - ">="
73
+ - - "~>"
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - ">="
80
+ - - "~>"
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: activesupport
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - ">="
87
+ - - "~>"
88
88
  - !ruby/object:Gem::Version
89
89
  version: '4.0'
90
90
  type: :runtime
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
- - - ">="
94
+ - - "~>"
95
95
  - !ruby/object:Gem::Version
96
96
  version: '4.0'
97
97
  - !ruby/object:Gem::Dependency
@@ -112,14 +112,14 @@ dependencies:
112
112
  name: github-markdown
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
- - - "~>"
115
+ - - '='
116
116
  - !ruby/object:Gem::Version
117
117
  version: 0.6.8
118
118
  type: :runtime
119
119
  prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
- - - "~>"
122
+ - - '='
123
123
  - !ruby/object:Gem::Version
124
124
  version: 0.6.8
125
125
  - !ruby/object:Gem::Dependency
@@ -140,86 +140,72 @@ dependencies:
140
140
  name: rake
141
141
  requirement: !ruby/object:Gem::Requirement
142
142
  requirements:
143
- - - ">="
143
+ - - "~>"
144
144
  - !ruby/object:Gem::Version
145
145
  version: '0'
146
146
  type: :development
147
147
  prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
- - - ">="
150
+ - - "~>"
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0'
153
153
  - !ruby/object:Gem::Dependency
154
154
  name: pry
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
- - - ">="
158
- - !ruby/object:Gem::Version
159
- version: '0'
160
- type: :development
161
- prerelease: false
162
- version_requirements: !ruby/object:Gem::Requirement
163
- requirements:
164
- - - ">="
165
- - !ruby/object:Gem::Version
166
- version: '0'
167
- - !ruby/object:Gem::Dependency
168
- name: pry-nav
169
- requirement: !ruby/object:Gem::Requirement
170
- requirements:
171
- - - ">="
157
+ - - "~>"
172
158
  - !ruby/object:Gem::Version
173
- version: '0'
159
+ version: '0.10'
174
160
  type: :development
175
161
  prerelease: false
176
162
  version_requirements: !ruby/object:Gem::Requirement
177
163
  requirements:
178
- - - ">="
164
+ - - "~>"
179
165
  - !ruby/object:Gem::Version
180
- version: '0'
166
+ version: '0.10'
181
167
  - !ruby/object:Gem::Dependency
182
168
  name: rspec
183
169
  requirement: !ruby/object:Gem::Requirement
184
170
  requirements:
185
- - - ">="
171
+ - - "~>"
186
172
  - !ruby/object:Gem::Version
187
- version: '0'
173
+ version: '3.0'
188
174
  type: :development
189
175
  prerelease: false
190
176
  version_requirements: !ruby/object:Gem::Requirement
191
177
  requirements:
192
- - - ">="
178
+ - - "~>"
193
179
  - !ruby/object:Gem::Version
194
- version: '0'
180
+ version: '3.0'
195
181
  - !ruby/object:Gem::Dependency
196
182
  name: rack-test
197
183
  requirement: !ruby/object:Gem::Requirement
198
184
  requirements:
199
- - - ">="
185
+ - - "~>"
200
186
  - !ruby/object:Gem::Version
201
- version: '0'
187
+ version: '0.6'
202
188
  type: :development
203
189
  prerelease: false
204
190
  version_requirements: !ruby/object:Gem::Requirement
205
191
  requirements:
206
- - - ">="
192
+ - - "~>"
207
193
  - !ruby/object:Gem::Version
208
- version: '0'
194
+ version: '0.6'
209
195
  - !ruby/object:Gem::Dependency
210
196
  name: octokit
211
197
  requirement: !ruby/object:Gem::Requirement
212
198
  requirements:
213
- - - ">="
199
+ - - "~>"
214
200
  - !ruby/object:Gem::Version
215
- version: '0'
201
+ version: '3.0'
216
202
  type: :development
217
203
  prerelease: false
218
204
  version_requirements: !ruby/object:Gem::Requirement
219
205
  requirements:
220
- - - ">="
206
+ - - "~>"
221
207
  - !ruby/object:Gem::Version
222
- version: '0'
208
+ version: '3.0'
223
209
  description: Brief is a library for developing applications whose primary interface
224
210
  is the text editor
225
211
  email:
@@ -267,6 +253,7 @@ files:
267
253
  - lib/brief/briefcase/initializer.rb
268
254
  - lib/brief/cli/01_extensions.rb
269
255
  - lib/brief/cli/all.rb
256
+ - lib/brief/cli/browse.rb
270
257
  - lib/brief/cli/export.rb
271
258
  - lib/brief/cli/parse.rb
272
259
  - lib/brief/cli/render.rb
@@ -372,7 +359,7 @@ files:
372
359
  - tests/middleman/documents/pages/two.md
373
360
  - tests/middleman/source/index.html.erb
374
361
  - tests/middleman/source/layouts/layout.erb
375
- homepage: ''
362
+ homepage: https://architects.io/brief
376
363
  licenses:
377
364
  - MIT
378
365
  metadata: {}