doublesing 0.1.0 → 0.2.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 (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -6
  3. data/lib/doublesing.rb +16 -5
  4. data/lib/doublesing/parser.rb +2 -2
  5. data/lib/doublesing/version.rb +1 -1
  6. metadata +26 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ad13d9d3deeaf901709a596512ff350e6e97a0ec
4
- data.tar.gz: 5303605eead6d34bdabc2f3a2e47fd0b032ea7cb
3
+ metadata.gz: 958aec5de4df324b7bca01d28f562e9a1c88dce2
4
+ data.tar.gz: 87d24aea6cb44712bd68a48b12dfb7cdb340782a
5
5
  SHA512:
6
- metadata.gz: ed9c583d855e0fae38fff938c948b1e898caeaa3391f2a2b3f486cf72bd7832c9c8e30d817e61f47d9be960053fb6b19e00efbeab4c5d8b2dc596fcdea8d7ee0
7
- data.tar.gz: 1cb9ba4adcf2f8c423108105c6011b8c97b8a0e95523cfa0fe7606bfb872d0e6fea25fd60bab8bf480b92181fef8aa6809ce54dc2621a7b70f4afb36fee81462
6
+ metadata.gz: fa45616d076fcc684c15c11c628d8e357b4aac8f90eed12b91a58d0025a3817241045b54742097fdb70ae584188a339074f3038960d5479c35cfd4bff595b89c
7
+ data.tar.gz: dbb67fb392440b7e972da6c3d1f7c624576518b3e456570e7dbac59e916577632d990faa194ec80423e4e95ee167edb6a0a790f2c6a1f482b15eaf97dafb501f
data/README.md CHANGED
@@ -4,8 +4,8 @@
4
4
  [![Test Coverage](https://codeclimate.com/github/AnthonySuper/Doublesing/badges/coverage.svg)](https://codeclimate.com/github/AnthonySuper/Doublesing)
5
5
  [![Code Climate](https://codeclimate.com/github/AnthonySuper/Doublesing/badges/gpa.svg)](https://codeclimate.com/github/AnthonySuper/Doublesing)
6
6
 
7
- Doublesing is a wiki markup language based on TeX.
8
- It's very simple and extremely flexible.
7
+ Doublesing is a wiki markup language based on TeX.
8
+ It's very simple and extremely flexible.
9
9
  You can register your own tags (including over-riding builtin ones) to suit your needs, effectively allowing a custom dialect to be built with just ruby objects.
10
10
 
11
11
 
@@ -30,12 +30,12 @@ Or install it yourself as:
30
30
  Doublesing is a TeX-like language designed to be used for online markup.
31
31
  It takes the relatively simple form of:
32
32
  ```
33
- \BLOCK_ID{ARGUMENT}{ARGUMENT}{ARGUMENT}
33
+ \BLOCK_ID[ARGUMENT][ARGUMENT][ARGUMENT]
34
34
  ```
35
35
  Here, maybe a use case will help:
36
36
 
37
37
  ```
38
- \bold{This text becomes bold!}
38
+ \bold[This text becomes bold!]
39
39
  ```
40
40
  Becomes:
41
41
  ```
@@ -43,7 +43,7 @@ Becomes:
43
43
  ```
44
44
  You can have blocks that take multiple arguments:
45
45
  ```
46
- \header{1}{This is a header}
46
+ \header[1][This is a header]
47
47
  ```
48
48
 
49
49
  ```
@@ -87,7 +87,7 @@ Doublesing.register("dog", DogFinder)
87
87
 
88
88
  Now, assuming you're using Doublesing to parse comments, a user can say:
89
89
  ```
90
- \dog{Rowlf}{My favorite musical dog!}
90
+ \dog[Rowlf][My favorite musical dog!]
91
91
  ```
92
92
 
93
93
  To easily get a link to the page on the piano player of the Muppets.
data/lib/doublesing.rb CHANGED
@@ -4,8 +4,12 @@ require "doublesing/transformer"
4
4
  require "doublesing/builtins"
5
5
  require "sanitize"
6
6
 
7
- require "pp"
7
+ ##
8
+ # The Doublesing module is the main interface for interacting with Doublesing
8
9
  module Doublesing
10
+ ##
11
+ # This method takes a string of source in the Doublesing language, and returns the resulting HTML
12
+ # It will sanitize any HTML fragments out of the source first, for safety's sake.
9
13
  def self.parse(str)
10
14
  sanitized = Sanitize.fragment(str)
11
15
  tree = Parser.new.parse(sanitized)
@@ -20,7 +24,17 @@ module Doublesing
20
24
  def self.assign(name, klass)
21
25
  @@handlers[name] = klass
22
26
  end
27
+ ##
28
+ # Load default block handlers
29
+ # YOU MUST CALL THIS BEFORE ANYTHING ELSE
30
+ def self.setup!
31
+ @@handlers = {}
32
+ @@handlers.merge! Builtins.handlers
33
+ end
23
34
 
35
+ protected
36
+ ##
37
+ # Take the id of a block and its arguments and process it, returning html.
24
38
  def self.process(id, args)
25
39
  if handler = @@handlers[id.to_s]
26
40
  handler.new(args).to_s
@@ -28,8 +42,5 @@ module Doublesing
28
42
  ""
29
43
  end
30
44
  end
31
- def self.setup!
32
- @@handlers = {}
33
- @@handlers.merge! Builtins.handlers
34
- end
45
+
35
46
  end
data/lib/doublesing/parser.rb CHANGED
@@ -1,8 +1,8 @@
1
1
  require 'parslet'
2
2
  module Doublesing
3
3
  class Parser < Parslet::Parser
4
- rule(:argument_begin){ str("{") }
5
- rule(:argument_end){ str("\\}").absent? >> str("}")}
4
+ rule(:argument_begin){ str("[") }
5
+ rule(:argument_end){ str("\\]").absent? >> str("]")}
6
6
  rule(:block_begin){ str("\\\\").absent? >> str("\\")}
7
7
  rule(:block_id){ match["\\w"].repeat(1)}
8
8
  rule(:block_header){ block_begin >> block_id.as(:id)}
data/lib/doublesing/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Doublesing
2
- VERSION = "0.1.0"
2
+ VERSION = "0.2.0"
3
3
  end
metadata CHANGED
@@ -1,139 +1,139 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: doublesing
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Anthony Super
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2015-02-28 00:00:00.000000000 Z
11
+ date: 2015-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ">="
17
+ - - '>='
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.7'
20
20
  type: :development
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: '1.7'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rake
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ~>
32
32
  - !ruby/object:Gem::Version
33
33
  version: '10.0'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ~>
39
39
  - !ruby/object:Gem::Version
40
40
  version: '10.0'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rspec
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: :development
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: pry
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ">="
59
+ - - '>='
60
60
  - !ruby/object:Gem::Version
61
61
  version: '0'
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - '>='
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: simplecov
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: :development
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: codeclimate-test-reporter
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - ">="
87
+ - - '>='
88
88
  - !ruby/object:Gem::Version
89
89
  version: '0'
90
90
  type: :development
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: '0'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: sanitize-url
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - ">="
101
+ - - '>='
102
102
  - !ruby/object:Gem::Version
103
103
  version: '0'
104
104
  type: :runtime
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - ">="
108
+ - - '>='
109
109
  - !ruby/object:Gem::Version
110
110
  version: '0'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: sanitize
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
- - - ">="
115
+ - - '>='
116
116
  - !ruby/object:Gem::Version
117
117
  version: '0'
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'
125
125
  - !ruby/object:Gem::Dependency
126
126
  name: parslet
127
127
  requirement: !ruby/object:Gem::Requirement
128
128
  requirements:
129
- - - ">="
129
+ - - '>='
130
130
  - !ruby/object:Gem::Version
131
131
  version: '0'
132
132
  type: :runtime
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
- - - ">="
136
+ - - '>='
137
137
  - !ruby/object:Gem::Version
138
138
  version: '0'
139
139
  description:
@@ -143,9 +143,9 @@ executables: []
143
143
  extensions: []
144
144
  extra_rdoc_files: []
145
145
  files:
146
- - ".gitignore"
147
- - ".rspec"
148
- - ".travis.yml"
146
+ - .gitignore
147
+ - .rspec
148
+ - .travis.yml
149
149
  - CODE_OF_CONDUCT.md
150
150
  - Gemfile
151
151
  - LICENSE.txt
@@ -180,19 +180,18 @@ require_paths:
180
180
  - lib
181
181
  required_ruby_version: !ruby/object:Gem::Requirement
182
182
  requirements:
183
- - - ">="
183
+ - - '>='
184
184
  - !ruby/object:Gem::Version
185
185
  version: '0'
186
186
  required_rubygems_version: !ruby/object:Gem::Requirement
187
187
  requirements:
188
- - - ">="
188
+ - - '>='
189
189
  - !ruby/object:Gem::Version
190
190
  version: '0'
191
191
  requirements: []
192
192
  rubyforge_project:
193
- rubygems_version: 2.2.2
193
+ rubygems_version: 2.0.3
194
194
  signing_key:
195
195
  specification_version: 4
196
196
  summary: An extensible markup language
197
197
  test_files: []
198
- has_rdoc: