precedent 0.0.2

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.
@@ -0,0 +1,307 @@
1
+ require_relative '../spec_helper'
2
+ require_relative '../../lib/precedent'
3
+ require 'faker'
4
+
5
+ describe Precedent do
6
+ let(:first) { Faker::Lorem.sentence }
7
+ let(:second) { Faker::Lorem.sentence }
8
+ let(:third) { Faker::Lorem.sentence }
9
+ let(:word) { Faker::Lorem.word }
10
+ let(:another_word) { Faker::Lorem.word }
11
+
12
+ it 'ignores comment lines' do
13
+ Precedent.new("%#{first}").to_hashes[:body].should == [ ]
14
+ end
15
+
16
+ it 'recognizes flush and indented paragraphs' do
17
+ Precedent.new(
18
+ " #{first}\n\n#{second}"
19
+ ).to_hashes[:body].should == [
20
+ { :type => :indented, :content => first },
21
+ { :type => :flush, :content => second }
22
+ ]
23
+ end
24
+
25
+ it 'recognizes ragged left paragraphs' do
26
+ Precedent.new(
27
+ "#{first}\n\n #{second}"
28
+ ).to_hashes[:body].should == [
29
+ { :type => :flush, :content => first },
30
+ { :type => :ragged_left, :content => second }
31
+ ]
32
+ end
33
+
34
+ it 'recognizes flush and indented quote paragraphs' do
35
+ Precedent.new(
36
+ " #{first}\n\n #{second}"
37
+ ).to_hashes[:body].should == [
38
+ { :type => :flush_quote, :content => first },
39
+ { :type => :indented_quote, :content => second }
40
+ ]
41
+ end
42
+
43
+ it 'recognizes mixed quote and body paragraphs' do
44
+ Precedent.new(
45
+ " #{first}\n\n #{second}"
46
+ ).to_hashes[:body].should == [
47
+ { :type => :indented, :content => first },
48
+ { :type => :flush_quote, :content => second }
49
+ ]
50
+ end
51
+
52
+ it "combines paragraph lines" do
53
+ Precedent.new(
54
+ " #{first}\n#{second}"
55
+ ).to_hashes[:body].should == [{
56
+ :type => :indented,
57
+ :content => "#{first} #{second}"
58
+ }]
59
+ end
60
+
61
+ it "recognizes headings" do
62
+ hashes = '#' * (1 + rand(3))
63
+ Precedent.new(
64
+ "#{hashes} #{first}"
65
+ ).to_hashes[:body].should == [{
66
+ :type => :heading,
67
+ :level => hashes.length,
68
+ :content => first
69
+ }]
70
+ end
71
+
72
+ it "recognizes horizontal rules" do
73
+ Precedent.new(<<-eos
74
+ #{first}
75
+
76
+ * * *
77
+
78
+ #{second}
79
+ eos
80
+ ).to_hashes[:body].should == [
81
+ { :type => :flush,
82
+ :content => first },
83
+ { :type => :rule },
84
+ { :type => :flush,
85
+ :content => second }
86
+ ]
87
+ end
88
+
89
+ it "recognizes horizontal rules within blockquotes" do
90
+ Precedent.new(<<-eos
91
+ #{first}
92
+
93
+ * * *
94
+
95
+ #{second}
96
+ eos
97
+ ).to_hashes[:body].should == [
98
+ { :type => :flush_quote, :content => first },
99
+ { :type => :rule_quote },
100
+ { :type => :flush_quote, :content => second }
101
+ ]
102
+ end
103
+
104
+ it "recognizes metadata" do
105
+ returned = Precedent.new(<<-eos
106
+ #{word.capitalize}: #{first}
107
+ #{another_word.capitalize}: #{second}
108
+
109
+ #{third}
110
+ eos
111
+ ).to_hashes
112
+ returned[:body].should == [
113
+ {:type => :flush, :content => third }
114
+ ]
115
+ returned[:meta].should == {
116
+ word.to_sym => first,
117
+ another_word.to_sym => second
118
+ }
119
+ end
120
+
121
+ it "interprets numeric metadata values" do
122
+ num = (1 + rand(1000)).to_s
123
+ date = (Date.today - (1 + rand(1000)))
124
+ ['yes','true','True','Yes'].each do |truth|
125
+ ['no', 'false', 'False', 'No'].each do |falsity|
126
+ Precedent.new(<<-eos
127
+ #{word.capitalize}: #{num}
128
+ #{another_word.capitalize}: #{date.strftime('%Y-%m-%d')}
129
+ #{word.capitalize + another_word}: #{truth}
130
+ #{another_word.capitalize + word}: #{falsity}
131
+
132
+ #{third}
133
+ eos
134
+ ).to_hashes[:meta].should == {
135
+ word.to_sym => num.to_i,
136
+ another_word.to_sym => date,
137
+ (word + another_word).to_sym => true,
138
+ (another_word + word).to_sym => false
139
+ }
140
+ end
141
+ end
142
+ end
143
+
144
+ it "recognizes footnotes" do
145
+ [
146
+ (1 + rand(100)).to_s,
147
+ '*', "\u2020\u2020", "\u2020", "\u2021"
148
+ ].each do |marker|
149
+ returned = Precedent.new(<<-eos
150
+ #{first}
151
+
152
+ ^#{marker} #{second}
153
+
154
+ ^ #{third}
155
+ eos
156
+ ).to_hashes
157
+ returned[:body].should == [
158
+ { :type => :flush, :content => first }
159
+ ]
160
+ returned[:footnotes].should == [
161
+ { :type => :footnote,
162
+ :marker => marker,
163
+ :content => second },
164
+ { :type => :footnote, :content => third }
165
+ ]
166
+ end
167
+ end
168
+
169
+ it 'recognizes smallcaps' do
170
+ Precedent.new(
171
+ " #{first} <<#{second}>> #{third}"
172
+ ).to_hashes[:body].should == [
173
+ { :type => :indented,
174
+ :content => [
175
+ first + ' ',
176
+ { :type => :smallcaps,
177
+ :content => second },
178
+ ' ' + third
179
+ ]
180
+ }
181
+ ]
182
+ end
183
+
184
+ it 'recognizes emphasis' do
185
+ Precedent.new(
186
+ " #{first} \\\\#{second}\\\\ #{third}"
187
+ ).to_hashes[:body].should == [
188
+ { :type => :indented,
189
+ :content => [
190
+ first + ' ',
191
+ { :type => :emphasis,
192
+ :content => second },
193
+ ' ' + third
194
+ ]
195
+ }
196
+ ]
197
+ end
198
+
199
+ it 'recognizes citations' do
200
+ Precedent.new(
201
+ "#{first}{{#{second}}}#{third}"
202
+ ).to_hashes[:body].should == [
203
+ { :type => :flush,
204
+ :content => [
205
+ first,
206
+ { :type => :citation,
207
+ :content => second },
208
+ third
209
+ ]
210
+ }
211
+ ]
212
+ end
213
+
214
+ it 'preserves space around citations' do
215
+ Precedent.new(
216
+ " #{first} {{#{second}}} #{third}"
217
+ ).to_hashes[:body].should == [
218
+ { :type => :indented,
219
+ :content => [
220
+ first + ' ',
221
+ { :type => :citation,
222
+ :content => second },
223
+ ' ' + third
224
+ ]
225
+ }
226
+ ]
227
+ end
228
+
229
+ it 'recognizes page breaks' do
230
+ number = (1 + rand(1000)).to_s
231
+ Precedent.new(
232
+ " #{first}@@#{number}@@#{second}"
233
+ ).to_hashes[:body].should == [
234
+ { :type => :indented,
235
+ :content => [
236
+ first, { :type => :break, :page => number.to_i }, second
237
+ ]
238
+ }
239
+ ]
240
+ end
241
+
242
+ it 'recognizes footnote references' do
243
+ [
244
+ (1 + rand(100)).to_s,
245
+ '*', "\u2020\u2020", "\u2020", "\u2021"
246
+ ].each do |marker|
247
+ Precedent.new(
248
+ "#{first}[[#{marker}]]#{second}"
249
+ ).to_hashes[:body].should == [
250
+ { :type => :flush,
251
+ :content => [
252
+ first,
253
+ { :type => :reference,
254
+ :marker => marker },
255
+ second
256
+ ]
257
+ }
258
+ ]
259
+ end
260
+ end
261
+
262
+ it 'recognizes inlines across line boundaries' do
263
+ Precedent.new(
264
+ "#{first} <<#{word}\n#{another_word}>> #{second}"
265
+ ).to_hashes[:body].should == [
266
+ { :type => :flush,
267
+ :content => [
268
+ first + ' ',
269
+ { :type => :smallcaps,
270
+ :content => "#{word} #{another_word}"
271
+ },
272
+ ' ' + second
273
+ ]
274
+ }
275
+ ]
276
+ end
277
+
278
+ it 'interprets URLs as text' do
279
+ Precedent.new(
280
+ "A URL http://www.google.com inline."
281
+ ).to_hashes[:body].should == [
282
+ { :type => :flush,
283
+ :content => 'A URL http://www.google.com inline.' }
284
+ ]
285
+ end
286
+
287
+ it 'recognizes formatting within citations' do
288
+ page = (1 + rand(1000)).to_s
289
+ Precedent.new(
290
+ "{{\\\\#{word}\\\\ @@#{page}@@<<#{another_word}>>}}"
291
+ ).to_hashes[:body].should == [
292
+ { :type => :flush,
293
+ :content => {
294
+ :type => :citation,
295
+ :content => [
296
+ { :type => :emphasis,
297
+ :content => word },
298
+ ' ',
299
+ { :type => :break, :page => page.to_i },
300
+ { :type => :smallcaps,
301
+ :content => another_word }
302
+ ]
303
+ }
304
+ }
305
+ ]
306
+ end
307
+ end
@@ -0,0 +1,13 @@
1
+ if ENV['COVERAGE']
2
+ require 'simplecov'
3
+
4
+ SimpleCov.adapters.define('precedent') do
5
+ add_filter '/spec/'
6
+ add_filter '/grammar/'
7
+
8
+ add_group 'Binaries', '/bin/'
9
+ add_group 'Libraries', '/lib/'
10
+ end
11
+
12
+ SimpleCov.start('precedent')
13
+ end
metadata ADDED
@@ -0,0 +1,251 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: precedent
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.2
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Kyle Mitchell
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-02-14 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: activesupport
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '3.2'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '3.2'
30
+ - !ruby/object:Gem::Dependency
31
+ name: nokogiri
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: '1.5'
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: '1.5'
46
+ - !ruby/object:Gem::Dependency
47
+ name: thor
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ~>
52
+ - !ruby/object:Gem::Version
53
+ version: '0.16'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: '0.16'
62
+ - !ruby/object:Gem::Dependency
63
+ name: treetop
64
+ requirement: !ruby/object:Gem::Requirement
65
+ none: false
66
+ requirements:
67
+ - - ~>
68
+ - !ruby/object:Gem::Version
69
+ version: '1.4'
70
+ type: :runtime
71
+ prerelease: false
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ~>
76
+ - !ruby/object:Gem::Version
77
+ version: '1.4'
78
+ - !ruby/object:Gem::Dependency
79
+ name: faker
80
+ requirement: !ruby/object:Gem::Requirement
81
+ none: false
82
+ requirements:
83
+ - - ! '>='
84
+ - !ruby/object:Gem::Version
85
+ version: '0'
86
+ type: :development
87
+ prerelease: false
88
+ version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - ! '>='
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ - !ruby/object:Gem::Dependency
95
+ name: guard-bundler
96
+ requirement: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - ! '>='
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ type: :development
103
+ prerelease: false
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ - !ruby/object:Gem::Dependency
111
+ name: guard-rspec
112
+ requirement: !ruby/object:Gem::Requirement
113
+ none: false
114
+ requirements:
115
+ - - ! '>='
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ none: false
122
+ requirements:
123
+ - - ! '>='
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ - !ruby/object:Gem::Dependency
127
+ name: guard-treetop
128
+ requirement: !ruby/object:Gem::Requirement
129
+ none: false
130
+ requirements:
131
+ - - ! '>='
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ type: :development
135
+ prerelease: false
136
+ version_requirements: !ruby/object:Gem::Requirement
137
+ none: false
138
+ requirements:
139
+ - - ! '>='
140
+ - !ruby/object:Gem::Version
141
+ version: '0'
142
+ - !ruby/object:Gem::Dependency
143
+ name: rspec
144
+ requirement: !ruby/object:Gem::Requirement
145
+ none: false
146
+ requirements:
147
+ - - ~>
148
+ - !ruby/object:Gem::Version
149
+ version: '2.12'
150
+ type: :development
151
+ prerelease: false
152
+ version_requirements: !ruby/object:Gem::Requirement
153
+ none: false
154
+ requirements:
155
+ - - ~>
156
+ - !ruby/object:Gem::Version
157
+ version: '2.12'
158
+ - !ruby/object:Gem::Dependency
159
+ name: ruby-prof
160
+ requirement: !ruby/object:Gem::Requirement
161
+ none: false
162
+ requirements:
163
+ - - ! '>='
164
+ - !ruby/object:Gem::Version
165
+ version: '0'
166
+ type: :development
167
+ prerelease: false
168
+ version_requirements: !ruby/object:Gem::Requirement
169
+ none: false
170
+ requirements:
171
+ - - ! '>='
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ - !ruby/object:Gem::Dependency
175
+ name: simplecov
176
+ requirement: !ruby/object:Gem::Requirement
177
+ none: false
178
+ requirements:
179
+ - - ! '>='
180
+ - !ruby/object:Gem::Version
181
+ version: '0'
182
+ type: :development
183
+ prerelease: false
184
+ version_requirements: !ruby/object:Gem::Requirement
185
+ none: false
186
+ requirements:
187
+ - - ! '>='
188
+ - !ruby/object:Gem::Version
189
+ version: '0'
190
+ description: ! " Precedent is a lightweight markup language for legal documents\n
191
+ \ heavily inspired by Markdown, LaTeX, and the print style of the\n United
192
+ States Reports, the official reports of decisions of the\n United States Supreme
193
+ Court.\n"
194
+ email:
195
+ - kyle@blackacrelabs.org
196
+ executables:
197
+ - precedent
198
+ extensions: []
199
+ extra_rdoc_files: []
200
+ files:
201
+ - .gitignore
202
+ - CONTRIBUTING.md
203
+ - Gemfile
204
+ - Guardfile
205
+ - LICENSE.md
206
+ - README.md
207
+ - Rakefile
208
+ - SYNTAX.md
209
+ - bin/precedent
210
+ - lib/precedent.rb
211
+ - lib/precedent/cli.rb
212
+ - lib/precedent/grammar/inline.rb
213
+ - lib/precedent/grammar/inline.treetop
214
+ - lib/precedent/grammar/node_patch.rb
215
+ - lib/precedent/parser.rb
216
+ - lib/precedent/translator.rb
217
+ - lib/precedent/treetop_patch.rb
218
+ - lib/precedent/version.rb
219
+ - precedent.gemspec
220
+ - spec/fixtures/long_opinion.pre
221
+ - spec/lib/precedent_spec.rb
222
+ - spec/spec_helper.rb
223
+ homepage: https://github.com/BlackacreLabs/precedent
224
+ licenses:
225
+ - MIT
226
+ post_install_message:
227
+ rdoc_options: []
228
+ require_paths:
229
+ - lib
230
+ required_ruby_version: !ruby/object:Gem::Requirement
231
+ none: false
232
+ requirements:
233
+ - - ~>
234
+ - !ruby/object:Gem::Version
235
+ version: 1.9.3
236
+ required_rubygems_version: !ruby/object:Gem::Requirement
237
+ none: false
238
+ requirements:
239
+ - - ! '>='
240
+ - !ruby/object:Gem::Version
241
+ version: '0'
242
+ requirements: []
243
+ rubyforge_project:
244
+ rubygems_version: 1.8.25
245
+ signing_key:
246
+ specification_version: 3
247
+ summary: Markdown-esque markup for legal documents
248
+ test_files:
249
+ - spec/fixtures/long_opinion.pre
250
+ - spec/lib/precedent_spec.rb
251
+ - spec/spec_helper.rb