conlang 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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +13 -0
- data/LANG_FILES_DOC.md +75 -0
- data/LICENSE.txt +202 -0
- data/NOTICE.txt +5 -0
- data/README.md +49 -0
- data/TODO.md +12 -0
- data/lib/conlang/operators.rb +137 -0
- data/lib/conlang/symbolset.rb +51 -0
- data/lib/conlang/version.rb +3 -0
- data/lib/conlang/wordgenerator.rb +107 -0
- data/lib/conlang.rb +7 -0
- data/test/test_file_maybe.lang +14 -0
- data/test/test_file_or.lang +14 -0
- data/test/test_wordgenerator.rb +18 -0
- metadata +62 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f9c221e8eefb643ff2b4ff6808d7758df343a1f0
|
4
|
+
data.tar.gz: 61d9f3daab090cfbb598a66a19750ac10a5d805a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1a9337ab8f9e2ed17cd1fb83adc6886668ac9b0e7b01e9e439829531a8c1f195b29a22a54f788863fdb89bafc421e7d047a13f0f60cede08822cc498348b8b73
|
7
|
+
data.tar.gz: fa2f8cc35e30f01dc2db36cab0958e13e8448ae21d73fb1a3b38e8f2d3b363da89de5052d48a85fe736ed6bc13bdf8ca228cf29fce87cf62f95c2b19bf9be20f
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
TODO
|
2
|
+
====
|
3
|
+
* Support of UTF-8 symbols
|
4
|
+
* Grammatical exceptions, or replacements
|
5
|
+
* More operators
|
6
|
+
|
7
|
+
Implemented features
|
8
|
+
====================
|
9
|
+
* Maybe(A) operator (no weight is requiered,
|
10
|
+
default probability is 50)
|
11
|
+
* Or(A, b) operator (no wight is requiered,
|
12
|
+
default probability is 50)
|
13
|
+
* Published as a Ruby gem
|
data/LANG_FILES_DOC.md
ADDED
@@ -0,0 +1,75 @@
|
|
1
|
+
LANG files documentation
|
2
|
+
========================
|
3
|
+
LANG files are written in a little lightweight
|
4
|
+
markup language for statistical linguistics.
|
5
|
+
|
6
|
+
Any basic LANG file can be divided in two parts:
|
7
|
+
* Groups of phonemes (each phoneme has a weight).
|
8
|
+
* A grammatical expression.
|
9
|
+
|
10
|
+
These files can be interpreted to generate
|
11
|
+
random words.
|
12
|
+
|
13
|
+
Phonetical groups (symbolsets)
|
14
|
+
------------------------------
|
15
|
+
All phonemes must be grouped into logical units.
|
16
|
+
Each phoneme has its own statistical weight.
|
17
|
+
|
18
|
+
For example, here's a group of vowels:
|
19
|
+
|
20
|
+
symbols for a vowel:
|
21
|
+
a: 50
|
22
|
+
e: 60
|
23
|
+
i: 40
|
24
|
+
o: 45
|
25
|
+
u: 40
|
26
|
+
|
27
|
+
Anything between the keyword "for" and
|
28
|
+
the last word is ignored, so these forms
|
29
|
+
are all allowed:
|
30
|
+
|
31
|
+
symbols for vowel:
|
32
|
+
|
33
|
+
symbols for each vowel:
|
34
|
+
|
35
|
+
symbols for any vowel:
|
36
|
+
|
37
|
+
You can also use "=" instead ":" when
|
38
|
+
defining a phoneme.
|
39
|
+
|
40
|
+
A phoneme's statistical weight gives
|
41
|
+
a priority to the symbol. It must be an
|
42
|
+
integer greater than 0 and less than 100.
|
43
|
+
|
44
|
+
Expression and operators
|
45
|
+
------------------------
|
46
|
+
Each LANG file has an expression at the end.
|
47
|
+
|
48
|
+
The expression most be at the end, starting in
|
49
|
+
the next line, after:
|
50
|
+
|
51
|
+
expression:
|
52
|
+
|
53
|
+
An expression is composed of operators that
|
54
|
+
may be nested.
|
55
|
+
|
56
|
+
* **Maybe(weight, A)**: A symbol from the **A**
|
57
|
+
SymbolSet may appear or not (empty string).
|
58
|
+
The weight states the possibility of **A**
|
59
|
+
to appear.
|
60
|
+
|
61
|
+
* **Maybe(A)**: Same previous operator, but with default
|
62
|
+
50 weight.
|
63
|
+
|
64
|
+
* **Or(weight, A, B)**: A symbol from SymbolSet
|
65
|
+
A or B may appear. The weight specifies the
|
66
|
+
possibility of a symbol from **A** for
|
67
|
+
appearing, and the complement (100 - A) must
|
68
|
+
be the possibility of a symbol from **B**
|
69
|
+
to appear.
|
70
|
+
|
71
|
+
* **Or(A, B)**: Same previous operator, but with default
|
72
|
+
50 weight.
|
73
|
+
|
74
|
+
* A **+** B: The plus sign to append A and
|
75
|
+
B results.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE.txt
ADDED
data/README.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
ConlangWordGenerator, 0.2.0 beta.
|
2
|
+
=================================
|
3
|
+
**Now it's a gem!**
|
4
|
+
|
5
|
+
Description
|
6
|
+
-----------
|
7
|
+
This gem allows the user to generate words for
|
8
|
+
constructed languages, given a LANG file that
|
9
|
+
describes the language. It can also be useful
|
10
|
+
for linguistics to study and generate words from
|
11
|
+
a given language.
|
12
|
+
|
13
|
+
The `*.lang` file must include sets of phonemes with
|
14
|
+
their individual probability weight, and a grammatical
|
15
|
+
expression, to describe how to generate words for the
|
16
|
+
described language.
|
17
|
+
|
18
|
+
Instructions
|
19
|
+
------------
|
20
|
+
Usage:
|
21
|
+
|
22
|
+
require 'conlang'
|
23
|
+
|
24
|
+
# Path to LANG file, as constructor.
|
25
|
+
x = WordGenerator.new("tokipona.lang")
|
26
|
+
|
27
|
+
# Print ten generated words as
|
28
|
+
# an array of strings.
|
29
|
+
p x.get_words(10)
|
30
|
+
|
31
|
+
|
32
|
+
There are `*.lang` files as examples at `lang-examples`
|
33
|
+
directory of this [project's source](https://github.com/fluorine/ConlangWordGenerator).
|
34
|
+
|
35
|
+
Custom .lang files
|
36
|
+
------------------
|
37
|
+
You must create your own .lang files to generate random
|
38
|
+
words for your constructed languages.
|
39
|
+
|
40
|
+
There files include a simple lightweight markup language
|
41
|
+
to describe sets of phonemes, their probability, and a
|
42
|
+
simple regular grammatical expression.
|
43
|
+
|
44
|
+
You can learn how to create LANG files [**here**](LANG_FILES_DOC.md).
|
45
|
+
Again, examples at `lang-examples` directory can help you a lot.
|
46
|
+
|
47
|
+
The class `WordGenerator` takes a path to a valid `*.lang`
|
48
|
+
file to produce a generator of words, as described previously
|
49
|
+
in the **Instructions** section.
|
data/TODO.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
TODO
|
2
|
+
====
|
3
|
+
* Support of UTF-8 symbols
|
4
|
+
* Grammatical exceptions, or replacements
|
5
|
+
* More operators
|
6
|
+
|
7
|
+
Implemented features
|
8
|
+
====================
|
9
|
+
* Maybe(A) operator (no weight is requiered,
|
10
|
+
default probability is 50)
|
11
|
+
* Or(A, b) operator (no wight is requiered,
|
12
|
+
default probability is 50)
|
@@ -0,0 +1,137 @@
|
|
1
|
+
# Operators for .lang grammatical expressions.
|
2
|
+
# - maybe(weight, symbolset)
|
3
|
+
# The symbolset may appear or not (empty string),
|
4
|
+
# given its probability (weight: 0 - 100) to appear.
|
5
|
+
# - or(weight, symbolsetA, symbolsetB)
|
6
|
+
# A symbol from symbolsetA or symbolsetB may appear.
|
7
|
+
# The probability weight for symbolsetA is specificed
|
8
|
+
# and the complement (of 100) favors symbolsetB.
|
9
|
+
# - a + b + ...
|
10
|
+
# Append all symbols.
|
11
|
+
#
|
12
|
+
|
13
|
+
#
|
14
|
+
# Base classes for operators.
|
15
|
+
#
|
16
|
+
module ConlangWordGenerator
|
17
|
+
#
|
18
|
+
# Classes for operators
|
19
|
+
# and operands.
|
20
|
+
#
|
21
|
+
class Or
|
22
|
+
def initialize(weight, setA, setB)
|
23
|
+
unless weight > 0 and weight < 100
|
24
|
+
raise "Error: Weight for an or() operator " +
|
25
|
+
"must be between 1 and 100 (exclusive)."
|
26
|
+
end
|
27
|
+
|
28
|
+
@weight = weight
|
29
|
+
@setA = setA
|
30
|
+
@setB = setB
|
31
|
+
end
|
32
|
+
|
33
|
+
def sample
|
34
|
+
if rand(100) < @weight
|
35
|
+
@setA.sample
|
36
|
+
else
|
37
|
+
@setB.sample
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def +(other)
|
42
|
+
Append.new(self, other)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
class Append
|
47
|
+
def initialize(*sets)
|
48
|
+
@sets = sets
|
49
|
+
end
|
50
|
+
|
51
|
+
def sample
|
52
|
+
result = ""
|
53
|
+
|
54
|
+
@sets.each { |item| result += item.sample }
|
55
|
+
|
56
|
+
result
|
57
|
+
end
|
58
|
+
|
59
|
+
def +(other)
|
60
|
+
Append.new(self, other)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
class Maybe
|
65
|
+
def initialize(weight, set)
|
66
|
+
unless weight > 0 and weight < 100
|
67
|
+
raise "Error: Weight for an maybe() operator " +
|
68
|
+
"must be between 1 and 100 (exclusive)."
|
69
|
+
end
|
70
|
+
|
71
|
+
@weight = weight
|
72
|
+
@set = set
|
73
|
+
end
|
74
|
+
|
75
|
+
def sample
|
76
|
+
if rand(100) < @weight
|
77
|
+
@set.sample
|
78
|
+
else
|
79
|
+
""
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
def +(other)
|
84
|
+
Append.new(self, other)
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
#
|
89
|
+
# Functions for operators
|
90
|
+
#
|
91
|
+
|
92
|
+
def self.orOp(*args)
|
93
|
+
if args.length == 2
|
94
|
+
Or.new(50, args[0], args[1])
|
95
|
+
elsif args.length == 3
|
96
|
+
Or.new(args[0].to_i, args[1], args[2])
|
97
|
+
else
|
98
|
+
raise "Error evaluating an Or() expression."
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
def self.maybeOp(*args)
|
103
|
+
if args.length == 1
|
104
|
+
Maybe.new(50, args[0])
|
105
|
+
elsif args.length == 2
|
106
|
+
Maybe.new(args[0].to_i, args[1])
|
107
|
+
else
|
108
|
+
raise "Error evaluating Maybe() expression."
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
#
|
113
|
+
# Interpreter
|
114
|
+
#
|
115
|
+
def self.load_definitions(bindings)
|
116
|
+
statements = ""
|
117
|
+
|
118
|
+
bindings.each_key do |k|
|
119
|
+
statements += "#{k} = bindings['#{k}']\n"
|
120
|
+
end
|
121
|
+
|
122
|
+
statements
|
123
|
+
end
|
124
|
+
|
125
|
+
def self.run_expression(expr, bindings)
|
126
|
+
# Modify method's names to avoid
|
127
|
+
# errors on Ruby syntax.
|
128
|
+
expr.gsub!(/\b[Oo]r\b/, 'orOp')
|
129
|
+
expr.gsub!(/\b[Mm]aybe\b/, 'maybeOp')
|
130
|
+
|
131
|
+
expr = load_definitions(bindings) + expr
|
132
|
+
|
133
|
+
# Evaluate all generated assigments
|
134
|
+
# and then the grammatical expression.
|
135
|
+
eval(expr)
|
136
|
+
end
|
137
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
# Class for a set of primitive symbols
|
4
|
+
# and their weights.
|
5
|
+
module ConlangWordGenerator
|
6
|
+
class SymbolSet
|
7
|
+
def initialize
|
8
|
+
@pairs = []
|
9
|
+
@weight_accum = 0
|
10
|
+
end
|
11
|
+
|
12
|
+
# Add new symbol with its probability into the set
|
13
|
+
def add_pair(symbol, weight)
|
14
|
+
unless weight > 0 and weight < 100
|
15
|
+
raise "Weight of symbol '#{symbol}' must be a value between 1 and 99."
|
16
|
+
end
|
17
|
+
|
18
|
+
# Insert new pair in the sorted array of pairs
|
19
|
+
inserted = false
|
20
|
+
@pairs.each_index do |index|
|
21
|
+
if @pairs[index][1] > weight
|
22
|
+
@pairs.insert(index, [symbol, weight])
|
23
|
+
inserted = true
|
24
|
+
break
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
# Insert at the end, if requiered
|
29
|
+
@pairs += [[symbol, weight]] unless inserted
|
30
|
+
|
31
|
+
# Sum weights
|
32
|
+
@weight_accum += weight
|
33
|
+
end
|
34
|
+
|
35
|
+
# Get a random symbol from the set
|
36
|
+
def sample
|
37
|
+
random = rand(@weight_accum)
|
38
|
+
|
39
|
+
accum = 0
|
40
|
+
@pairs.each_index do |index|
|
41
|
+
accum += @pairs[index][1]
|
42
|
+
return @pairs[index][0] if accum > random
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# Make Symbolset class appendable
|
47
|
+
def +(other)
|
48
|
+
Append.new(self, other)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,107 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
#require 'lib/symbolset.rb'
|
4
|
+
|
5
|
+
#
|
6
|
+
# This Ruby class generates random words using
|
7
|
+
# prabability-weighted symbols, and grammar rules
|
8
|
+
# from a given .lang file as input.
|
9
|
+
#
|
10
|
+
|
11
|
+
class WordGenerator
|
12
|
+
# Constructor
|
13
|
+
def initialize(file)
|
14
|
+
# Check file extension.
|
15
|
+
unless file.match(/.*\.lang/)
|
16
|
+
raise "Given file, \"#{file}\", is not a .lang file."
|
17
|
+
end
|
18
|
+
|
19
|
+
# Check if files exist
|
20
|
+
unless File.exist?(file)
|
21
|
+
raise "File \"#{file}\" was not found."
|
22
|
+
end
|
23
|
+
|
24
|
+
# # # # # # # # #
|
25
|
+
|
26
|
+
# Input filename
|
27
|
+
@lang_file = file
|
28
|
+
|
29
|
+
# Bindings for SymbolSets and a variable
|
30
|
+
# to save the grammatical expression string.
|
31
|
+
@bindings = {}
|
32
|
+
@full_expression = ""
|
33
|
+
|
34
|
+
# Parse .lang file
|
35
|
+
parse_lang_file
|
36
|
+
|
37
|
+
# Parse and evaluate grammatical expression
|
38
|
+
eval_expression
|
39
|
+
end
|
40
|
+
|
41
|
+
# This method reads a .lang file to parse it.
|
42
|
+
# It parses the symbols and then copies the full
|
43
|
+
# grammatical expression to evaluate it later.
|
44
|
+
def parse_lang_file
|
45
|
+
# Open .lang file and parse it, then copy
|
46
|
+
# its full grammatical expression.
|
47
|
+
File.open(@lang_file, "r:UTF-8") do |file|
|
48
|
+
lines_count = 1
|
49
|
+
on_expression = false
|
50
|
+
|
51
|
+
# Evaluating lines
|
52
|
+
while (line = file.gets)
|
53
|
+
# Parsing .lang file
|
54
|
+
case line
|
55
|
+
when /(^\s*$)|(^\s*#.*$)/
|
56
|
+
# Ignore blank lines or comments
|
57
|
+
|
58
|
+
when /^\s*symbols\s*for\s*(\w*)?\s*(\w+)\s*:\s*(#.*)?$/
|
59
|
+
# Create new symbol set
|
60
|
+
captured = line.scan(/\s*(\w+)\s*:/)
|
61
|
+
current_binding = captured[0][0]
|
62
|
+
@bindings[current_binding] = ConlangWordGenerator::SymbolSet.new
|
63
|
+
|
64
|
+
when /^\s*expression\s*:\s*(#.*)?$/
|
65
|
+
# Start of grammatical expression
|
66
|
+
#puts "Evaluating expression:"
|
67
|
+
on_expression = true
|
68
|
+
|
69
|
+
when /^\s*(\S+)\s*[:=]\s*(\d*)\s*(#.*)?$/
|
70
|
+
# Add a symbol to the current SymbolSet's binding
|
71
|
+
@bindings[current_binding].add_pair($1, $2.to_i)
|
72
|
+
|
73
|
+
else
|
74
|
+
if on_expression
|
75
|
+
# Copying expression
|
76
|
+
@full_expression += line.strip
|
77
|
+
else
|
78
|
+
raise "Runtime error when evaluating " +
|
79
|
+
"\"#{@lang_file}\" at line #{lines_count}."
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
#Counting lines
|
84
|
+
lines_count += 1
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
# This method evaluates the grammatical expression
|
90
|
+
# and then generate random words.
|
91
|
+
def eval_expression
|
92
|
+
@evaluated_expression = ConlangWordGenerator::run_expression(@full_expression, @bindings)
|
93
|
+
end
|
94
|
+
|
95
|
+
# This method generates words
|
96
|
+
def get_words(qty = 30)
|
97
|
+
raise "Error on quantity of words." if qty < 1
|
98
|
+
|
99
|
+
words = []
|
100
|
+
|
101
|
+
qty.times do
|
102
|
+
words += [@evaluated_expression.sample]
|
103
|
+
end
|
104
|
+
|
105
|
+
words
|
106
|
+
end
|
107
|
+
end
|
data/lib/conlang.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require 'conlang'
|
2
|
+
require 'test/unit'
|
3
|
+
|
4
|
+
class TestWordGenerator < Test::Unit::TestCase
|
5
|
+
def test_or_operators
|
6
|
+
words = WordGenerator.new("test_file_or.lang").get_words(10)
|
7
|
+
words.each do |word|
|
8
|
+
assert_match(/^[aoptk][ao]$/, word)
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
def test_maybe_operators
|
13
|
+
words = WordGenerator.new("test_file_maybe.lang").get_words(10)
|
14
|
+
words.each do |word|
|
15
|
+
assert_match(/^[ptk]*[ao]*$/, word)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
metadata
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: conlang
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Joseph
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-06-06 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: 'This gem takes constructed grammar and phonemes from a LANG file to
|
14
|
+
generate random words. You can learn how to create LANG files, or explore some sample
|
15
|
+
files, at this project''s source repository on Github: https://github.com/fluorine/ConlangWordGenerator'
|
16
|
+
email: fluorine@github.com
|
17
|
+
executables: []
|
18
|
+
extensions: []
|
19
|
+
extra_rdoc_files: []
|
20
|
+
files:
|
21
|
+
- lib/conlang.rb
|
22
|
+
- lib/conlang/operators.rb
|
23
|
+
- lib/conlang/symbolset.rb
|
24
|
+
- lib/conlang/version.rb
|
25
|
+
- lib/conlang/wordgenerator.rb
|
26
|
+
- CHANGELOG.md
|
27
|
+
- LANG_FILES_DOC.md
|
28
|
+
- README.md
|
29
|
+
- TODO.md
|
30
|
+
- LICENSE.txt
|
31
|
+
- NOTICE.txt
|
32
|
+
- test/test_file_maybe.lang
|
33
|
+
- test/test_file_or.lang
|
34
|
+
- test/test_wordgenerator.rb
|
35
|
+
homepage: https://github.com/fluorine/ConlangWordGenerator
|
36
|
+
licenses:
|
37
|
+
- Apache
|
38
|
+
metadata: {}
|
39
|
+
post_install_message: |2-
|
40
|
+
Go to https://github.com/fluorine/ConlangWordGenerator to learn
|
41
|
+
how to create LANG files to generate words for constructed languages.
|
42
|
+
rdoc_options: []
|
43
|
+
require_paths:
|
44
|
+
- lib
|
45
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
46
|
+
requirements:
|
47
|
+
- - '>='
|
48
|
+
- !ruby/object:Gem::Version
|
49
|
+
version: '0'
|
50
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
requirements: []
|
56
|
+
rubyforge_project:
|
57
|
+
rubygems_version: 2.0.3
|
58
|
+
signing_key:
|
59
|
+
specification_version: 4
|
60
|
+
summary: 'Full name: ConlangWordGenerator. A statistical random words generator for
|
61
|
+
constructed languages.'
|
62
|
+
test_files: []
|