simple_inline_text_annotation 0.1.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/.rspec +3 -0
- data/.rubocop.yml +15 -0
- data/CHANGELOG.md +5 -0
- data/CODE_OF_CONDUCT.md +132 -0
- data/LICENSE.txt +21 -0
- data/README.md +43 -0
- data/Rakefile +12 -0
- data/lib/simple_inline_text_annotation/denotation.rb +51 -0
- data/lib/simple_inline_text_annotation/denotation_validator.rb +55 -0
- data/lib/simple_inline_text_annotation/entity_type_collection.rb +68 -0
- data/lib/simple_inline_text_annotation/generator.rb +68 -0
- data/lib/simple_inline_text_annotation/generator_error.rb +9 -0
- data/lib/simple_inline_text_annotation/parser.rb +64 -0
- data/lib/simple_inline_text_annotation/version.rb +5 -0
- data/lib/simple_inline_text_annotation.rb +71 -0
- data/sig/simple_inline_text_annotation.rbs +4 -0
- metadata +59 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 725fe23d9066db1aa1846efc6699a8973991cef8a613c8d89b82c5794202fd60
|
4
|
+
data.tar.gz: c2a8671106444d868a1100bd9c07d4ce88c0693d5fb458e8589cbc8a46e1c4af
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0c2a831a71afa277bc4703b0c3c7f2f5580750003fb9dd9b7997af76b0761e19fc31f05b643578c7298f281930e6253af5bc1c87c911932bd673cd003591d2b9
|
7
|
+
data.tar.gz: db3c7bf4f78a34e314a173a7eece62aa43222c7f103197e2519dfe27dca4da067afcfc4541756f3655289e4fa64764d117a4e3eaff615b58e6931766bd24842c
|
data/.rspec
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
AllCops:
|
2
|
+
TargetRubyVersion: 3.1
|
3
|
+
|
4
|
+
Style/StringLiterals:
|
5
|
+
EnforcedStyle: double_quotes
|
6
|
+
|
7
|
+
Style/StringLiteralsInInterpolation:
|
8
|
+
EnforcedStyle: double_quotes
|
9
|
+
|
10
|
+
Style/Documentation:
|
11
|
+
Enabled: false
|
12
|
+
|
13
|
+
Metrics/BlockLength:
|
14
|
+
Exclude:
|
15
|
+
- 'spec/**/*'
|
data/CHANGELOG.md
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,132 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
10
|
+
identity and orientation.
|
11
|
+
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
13
|
+
diverse, inclusive, and healthy community.
|
14
|
+
|
15
|
+
## Our Standards
|
16
|
+
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
18
|
+
community include:
|
19
|
+
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
24
|
+
and learning from the experience
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
26
|
+
community
|
27
|
+
|
28
|
+
Examples of unacceptable behavior include:
|
29
|
+
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
31
|
+
any kind
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
33
|
+
* Public or private harassment
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
35
|
+
without their explicit permission
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
37
|
+
professional setting
|
38
|
+
|
39
|
+
## Enforcement Responsibilities
|
40
|
+
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
44
|
+
or harmful.
|
45
|
+
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
49
|
+
decisions when appropriate.
|
50
|
+
|
51
|
+
## Scope
|
52
|
+
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
54
|
+
an individual is officially representing the community in public spaces.
|
55
|
+
Examples of representing our community include using an official email address,
|
56
|
+
posting via an official social media account, or acting as an appointed
|
57
|
+
representative at an online or offline event.
|
58
|
+
|
59
|
+
## Enforcement
|
60
|
+
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
62
|
+
reported to the community leaders responsible for enforcement at
|
63
|
+
[INSERT CONTACT METHOD].
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
65
|
+
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
67
|
+
reporter of any incident.
|
68
|
+
|
69
|
+
## Enforcement Guidelines
|
70
|
+
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
73
|
+
|
74
|
+
### 1. Correction
|
75
|
+
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
77
|
+
unprofessional or unwelcome in the community.
|
78
|
+
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
82
|
+
|
83
|
+
### 2. Warning
|
84
|
+
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
86
|
+
actions.
|
87
|
+
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
93
|
+
ban.
|
94
|
+
|
95
|
+
### 3. Temporary Ban
|
96
|
+
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
98
|
+
sustained inappropriate behavior.
|
99
|
+
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
101
|
+
communication with the community for a specified period of time. No public or
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
104
|
+
Violating these terms may lead to a permanent ban.
|
105
|
+
|
106
|
+
### 4. Permanent Ban
|
107
|
+
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
111
|
+
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
113
|
+
community.
|
114
|
+
|
115
|
+
## Attribution
|
116
|
+
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
118
|
+
version 2.1, available at
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
120
|
+
|
121
|
+
Community Impact Guidelines were inspired by
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
123
|
+
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
127
|
+
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2025 xaiBUh29wX
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
# SimpleInlineTextAnnotation
|
2
|
+
|
3
|
+
TODO: Delete this and the text below, and describe your gem
|
4
|
+
|
5
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_inline_text_annotation`. To experiment with that code, run `bin/console` for an interactive prompt.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
|
10
|
+
|
11
|
+
Install the gem and add to the application's Gemfile by executing:
|
12
|
+
|
13
|
+
```bash
|
14
|
+
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
|
15
|
+
```
|
16
|
+
|
17
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
18
|
+
|
19
|
+
```bash
|
20
|
+
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
|
21
|
+
```
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_inline_text_annotation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/simple_inline_text_annotation/blob/main/CODE_OF_CONDUCT.md).
|
36
|
+
|
37
|
+
## License
|
38
|
+
|
39
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
40
|
+
|
41
|
+
## Code of Conduct
|
42
|
+
|
43
|
+
Everyone interacting in the SimpleInlineTextAnnotation project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_inline_text_annotation/blob/main/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "denotation_validator"
|
4
|
+
require_relative "generator_error"
|
5
|
+
|
6
|
+
class SimpleInlineTextAnnotation
|
7
|
+
class Denotation
|
8
|
+
attr_reader :begin_pos, :end_pos, :obj
|
9
|
+
|
10
|
+
def initialize(begin_pos, end_pos, obj)
|
11
|
+
@begin_pos = begin_pos
|
12
|
+
@end_pos = end_pos
|
13
|
+
@obj = obj
|
14
|
+
end
|
15
|
+
|
16
|
+
def span
|
17
|
+
{ begin: @begin_pos, end: @end_pos }
|
18
|
+
end
|
19
|
+
|
20
|
+
def to_h
|
21
|
+
{ span: span, obj: @obj }
|
22
|
+
end
|
23
|
+
|
24
|
+
def nested_within?(other)
|
25
|
+
other.begin_pos <= @begin_pos && @end_pos <= other.end_pos
|
26
|
+
end
|
27
|
+
|
28
|
+
def position_not_integer?
|
29
|
+
!(@begin_pos.is_a?(Integer) && @end_pos.is_a?(Integer))
|
30
|
+
end
|
31
|
+
|
32
|
+
def position_negative?
|
33
|
+
@begin_pos.negative? || @end_pos.negative?
|
34
|
+
end
|
35
|
+
|
36
|
+
def position_invalid?
|
37
|
+
@begin_pos > @end_pos
|
38
|
+
end
|
39
|
+
|
40
|
+
def out_of_bounds?(text_length)
|
41
|
+
@begin_pos >= text_length || @end_pos > text_length
|
42
|
+
end
|
43
|
+
|
44
|
+
def boundary_crossing?(other)
|
45
|
+
starts_inside_other = @begin_pos > other.begin_pos && @begin_pos < other.end_pos
|
46
|
+
ends_inside_other = @end_pos > other.begin_pos && @end_pos < other.end_pos
|
47
|
+
|
48
|
+
starts_inside_other || ends_inside_other
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class SimpleInlineTextAnnotation
|
4
|
+
module DenotationValidator
|
5
|
+
def validate(denotations, text_length)
|
6
|
+
result = remove_duplicates_from(denotations)
|
7
|
+
result = remove_non_integer_positions_from(result)
|
8
|
+
result = remove_negative_positions_from(result)
|
9
|
+
result = remove_invalid_positions_from(result)
|
10
|
+
result = remove_out_of_bound_positions_from(result, text_length)
|
11
|
+
result = remove_nests_from(result)
|
12
|
+
remove_boundary_crosses_from(result)
|
13
|
+
end
|
14
|
+
|
15
|
+
private
|
16
|
+
|
17
|
+
def remove_duplicates_from(denotations)
|
18
|
+
denotations.uniq(&:span)
|
19
|
+
end
|
20
|
+
|
21
|
+
def remove_non_integer_positions_from(denotations)
|
22
|
+
denotations.reject(&:position_not_integer?)
|
23
|
+
end
|
24
|
+
|
25
|
+
def remove_negative_positions_from(denotations)
|
26
|
+
denotations.reject(&:position_negative?)
|
27
|
+
end
|
28
|
+
|
29
|
+
def remove_invalid_positions_from(denotations)
|
30
|
+
denotations.reject(&:position_invalid?)
|
31
|
+
end
|
32
|
+
|
33
|
+
def remove_out_of_bound_positions_from(denotations, text_length)
|
34
|
+
denotations.reject { |denotation| denotation.out_of_bounds?(text_length) }
|
35
|
+
end
|
36
|
+
|
37
|
+
def remove_nests_from(denotations)
|
38
|
+
# Sort by begin_pos in ascending order. If begin_pos is the same, sort by end_pos in descending order.
|
39
|
+
sorted_denotations = denotations.sort_by { |d| [d.begin_pos, -d.end_pos] }
|
40
|
+
result = []
|
41
|
+
|
42
|
+
sorted_denotations.each do |denotation|
|
43
|
+
result << denotation unless result.any? { |outer| denotation.nested_within?(outer) }
|
44
|
+
end
|
45
|
+
|
46
|
+
result
|
47
|
+
end
|
48
|
+
|
49
|
+
def remove_boundary_crosses_from(denotations)
|
50
|
+
denotations.reject do |denotation|
|
51
|
+
denotations.any? { |existing| denotation.boundary_crossing?(existing) }
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class SimpleInlineTextAnnotation
|
4
|
+
class EntityTypeCollection
|
5
|
+
def initialize(source)
|
6
|
+
@source = source
|
7
|
+
end
|
8
|
+
|
9
|
+
def get(label)
|
10
|
+
entity_types[label]
|
11
|
+
end
|
12
|
+
|
13
|
+
# to_config returns a Array of hashes of each entity type.
|
14
|
+
# Example:
|
15
|
+
# [
|
16
|
+
# {id: "https://example.com/Person", label: "Person"},
|
17
|
+
# {id: "https://example.com/Organization", label: "Organization"}
|
18
|
+
# ]
|
19
|
+
def to_config
|
20
|
+
entity_types.map do |label, id|
|
21
|
+
{ id: id, label: label }
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def any?
|
26
|
+
entity_types.any?
|
27
|
+
end
|
28
|
+
|
29
|
+
private
|
30
|
+
|
31
|
+
# entity_types returns a Hash structured with label as key and id as value.
|
32
|
+
# Example:
|
33
|
+
# {
|
34
|
+
# "Person": "https://example.com/Person",
|
35
|
+
# "Organization": "https://example.com/Organization"
|
36
|
+
# }
|
37
|
+
def entity_types
|
38
|
+
@entity_types ||= read_entities_from_source
|
39
|
+
end
|
40
|
+
|
41
|
+
def read_entities_from_source
|
42
|
+
entity_types = {}
|
43
|
+
|
44
|
+
@source.scan(ENTITY_TYPE_BLOCK_PATTERN).each do |entity_block|
|
45
|
+
process_entity_block(entity_block, entity_types)
|
46
|
+
end
|
47
|
+
|
48
|
+
entity_types
|
49
|
+
end
|
50
|
+
|
51
|
+
def process_entity_block(entity_block, entity_types)
|
52
|
+
entity_block[0].each_line do |line|
|
53
|
+
process_entity_line(line, entity_types)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def process_entity_line(line, entity_types)
|
58
|
+
match = line.strip.match(ENTITY_TYPE_PATTERN)
|
59
|
+
return unless match
|
60
|
+
|
61
|
+
label = match[1]
|
62
|
+
id = match[2]
|
63
|
+
return if label == id # Do not create entity_type if label and id is same.
|
64
|
+
|
65
|
+
entity_types[label] ||= id
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "denotation"
|
4
|
+
|
5
|
+
class SimpleInlineTextAnnotation
|
6
|
+
class Generator
|
7
|
+
include DenotationValidator
|
8
|
+
|
9
|
+
def initialize(source)
|
10
|
+
@source = source.dup.freeze
|
11
|
+
@denotations = build_denotations(source["denotations"] || [])
|
12
|
+
@config = @source["config"]
|
13
|
+
end
|
14
|
+
|
15
|
+
def generate
|
16
|
+
text = @source["text"]
|
17
|
+
raise SimpleInlineTextAnnotation::GeneratorError, 'The "text" key is missing.' if text.nil?
|
18
|
+
|
19
|
+
denotations = validate(@denotations, text.length)
|
20
|
+
|
21
|
+
annotated_text = annotate_text(text, denotations)
|
22
|
+
label_definitions = build_label_definitions
|
23
|
+
|
24
|
+
[annotated_text, label_definitions].compact.join("\n\n")
|
25
|
+
end
|
26
|
+
|
27
|
+
private
|
28
|
+
|
29
|
+
def build_denotations(denotations)
|
30
|
+
denotations.map { |d| Denotation.new(d["span"]["begin"], d["span"]["end"], d["obj"]) }
|
31
|
+
end
|
32
|
+
|
33
|
+
def annotate_text(text, denotations)
|
34
|
+
# Annotate text from the end to ensure position calculation.
|
35
|
+
denotations.sort_by(&:begin_pos).reverse_each do |denotation|
|
36
|
+
begin_pos = denotation.begin_pos
|
37
|
+
end_pos = denotation.end_pos
|
38
|
+
obj = get_obj(denotation.obj)
|
39
|
+
|
40
|
+
annotated_text = "[#{text[begin_pos...end_pos]}][#{obj}]"
|
41
|
+
text = text[0...begin_pos] + annotated_text + text[end_pos..]
|
42
|
+
end
|
43
|
+
|
44
|
+
text
|
45
|
+
end
|
46
|
+
|
47
|
+
def labeled_entity_types
|
48
|
+
return nil unless @config
|
49
|
+
|
50
|
+
@config["entity types"]&.select { |entity_type| entity_type.key?("label") }
|
51
|
+
end
|
52
|
+
|
53
|
+
def get_obj(obj)
|
54
|
+
return obj unless labeled_entity_types
|
55
|
+
|
56
|
+
entity = labeled_entity_types.find { |entity_type| entity_type["id"] == obj }
|
57
|
+
entity ? entity["label"] : obj
|
58
|
+
end
|
59
|
+
|
60
|
+
def build_label_definitions
|
61
|
+
return nil if labeled_entity_types.nil? || labeled_entity_types.empty?
|
62
|
+
|
63
|
+
labeled_entity_types.map do |entity|
|
64
|
+
"[#{entity["label"]}]: #{entity["id"]}"
|
65
|
+
end.join("\n")
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "entity_type_collection"
|
4
|
+
require_relative "denotation"
|
5
|
+
|
6
|
+
class SimpleInlineTextAnnotation
|
7
|
+
class Parser
|
8
|
+
# DENOTATION_PATTERN matches two consecutive pairs of square brackets.
|
9
|
+
# Example: [Annotated Text][Label]
|
10
|
+
DENOTATION_PATTERN = /(?<!\\)\[([^\[]+?)\]\[([^\]]+?)\]/
|
11
|
+
|
12
|
+
def initialize(source)
|
13
|
+
@source = source.dup.freeze
|
14
|
+
@denotations = []
|
15
|
+
@entity_type_collection = EntityTypeCollection.new(source)
|
16
|
+
end
|
17
|
+
|
18
|
+
def parse
|
19
|
+
full_text = source_without_references
|
20
|
+
|
21
|
+
process_denotations(full_text)
|
22
|
+
|
23
|
+
SimpleInlineTextAnnotation.new(
|
24
|
+
full_text,
|
25
|
+
@denotations,
|
26
|
+
@entity_type_collection
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
30
|
+
private
|
31
|
+
|
32
|
+
# Remove references from the source.
|
33
|
+
def source_without_references
|
34
|
+
@source.gsub(ENTITY_TYPE_BLOCK_PATTERN) do |block|
|
35
|
+
block.start_with?("\n\n") ? "\n\n" : ""
|
36
|
+
end.strip
|
37
|
+
end
|
38
|
+
|
39
|
+
def get_obj_for(label)
|
40
|
+
@entity_type_collection.get(label) || label
|
41
|
+
end
|
42
|
+
|
43
|
+
def process_denotations(full_text)
|
44
|
+
while full_text =~ DENOTATION_PATTERN
|
45
|
+
match = Regexp.last_match
|
46
|
+
process_single_denotation(match, full_text)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
def process_single_denotation(match, full_text)
|
51
|
+
target_text = match[1]
|
52
|
+
label = match[2]
|
53
|
+
|
54
|
+
begin_pos = match.begin(0)
|
55
|
+
end_pos = begin_pos + target_text.length
|
56
|
+
obj = get_obj_for(label)
|
57
|
+
|
58
|
+
@denotations << Denotation.new(begin_pos, end_pos, obj)
|
59
|
+
|
60
|
+
# Replace the processed annotation with its text content
|
61
|
+
full_text[match.begin(0)...match.end(0)] = target_text
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "simple_inline_text_annotation/version"
|
4
|
+
require_relative "simple_inline_text_annotation/generator"
|
5
|
+
require_relative "simple_inline_text_annotation/parser"
|
6
|
+
|
7
|
+
class SimpleInlineTextAnnotation
|
8
|
+
# ENTITY_TYPE_PATTERN matches a pair of square brackets which is followed by a colon and URL.
|
9
|
+
# Similar to Markdown, this also matches when there is text enclosed in "" or '' after the URL.
|
10
|
+
# Match example:
|
11
|
+
# - [Label]: URL
|
12
|
+
# - [Label]: URL "text"
|
13
|
+
ENTITY_TYPE_PATTERN = /^\s*\[([^\]]+)\]:\s+(\S+)(?:\s+(?:"[^"]*"|'[^']*'))?\s*$/
|
14
|
+
|
15
|
+
# ENTITY_TYPE_BLOCK_PATTERN matches a block of the entity type definitions.
|
16
|
+
# Requires a blank line above the block definition.
|
17
|
+
ENTITY_TYPE_BLOCK_PATTERN = /(?:\A|\n\s*\n)((?:#{ENTITY_TYPE_PATTERN}(?:\n|$))+)/
|
18
|
+
|
19
|
+
# ESCAPE_PATTERN matches a backslash (\) preceding two consecutive pairs of square brackets.
|
20
|
+
# Example: \[This is a part of][original text]
|
21
|
+
ESCAPE_PATTERN = /\\(?=\[[^\]]+\]\[[^\]]+\])/
|
22
|
+
|
23
|
+
def initialize(text, denotations, entity_type_collection)
|
24
|
+
@text = text
|
25
|
+
@denotations = denotations
|
26
|
+
@entity_type_collection = entity_type_collection
|
27
|
+
end
|
28
|
+
|
29
|
+
def self.parse(source)
|
30
|
+
result = SimpleInlineTextAnnotation::Parser.new(source).parse
|
31
|
+
result.to_h
|
32
|
+
end
|
33
|
+
|
34
|
+
def self.generate(source)
|
35
|
+
SimpleInlineTextAnnotation::Generator.new(source).generate
|
36
|
+
end
|
37
|
+
|
38
|
+
def to_h
|
39
|
+
{
|
40
|
+
text: format_text(@text),
|
41
|
+
denotations: @denotations.map(&:to_h),
|
42
|
+
config: config
|
43
|
+
}.compact
|
44
|
+
end
|
45
|
+
|
46
|
+
private
|
47
|
+
|
48
|
+
def format_text(text)
|
49
|
+
result = remove_escape_backslash_from(text)
|
50
|
+
reduce_consecutive_newlines_from(result)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Remove backslashes used to escape inline annotation format.
|
54
|
+
# For example, `\[Elon Musk][Person]` is treated as plain text
|
55
|
+
# rather than an annotation. This method removes the leading
|
56
|
+
# backslash and keeps the text as `[Elon Musk][Person]`.
|
57
|
+
def remove_escape_backslash_from(text)
|
58
|
+
text.gsub(ESCAPE_PATTERN, "")
|
59
|
+
end
|
60
|
+
|
61
|
+
# Reduce consecutive newlines to a single newline.
|
62
|
+
def reduce_consecutive_newlines_from(text)
|
63
|
+
text.gsub(/\n{2,}/, "\n\n")
|
64
|
+
end
|
65
|
+
|
66
|
+
def config
|
67
|
+
return nil unless @entity_type_collection.any?
|
68
|
+
|
69
|
+
{ "entity types": @entity_type_collection.to_config }
|
70
|
+
end
|
71
|
+
end
|
metadata
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: simple_inline_text_annotation
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- xaiBUh29wX
|
8
|
+
bindir: exe
|
9
|
+
cert_chain: []
|
10
|
+
date: 2025-04-03 00:00:00.000000000 Z
|
11
|
+
dependencies: []
|
12
|
+
description: This gem provides inline text annotation functionality, extracted from
|
13
|
+
PubAnnotation, with support for denotations, entity types, and nested spans.
|
14
|
+
email:
|
15
|
+
- arino.tamada@luxiar.com
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- ".rspec"
|
21
|
+
- ".rubocop.yml"
|
22
|
+
- CHANGELOG.md
|
23
|
+
- CODE_OF_CONDUCT.md
|
24
|
+
- LICENSE.txt
|
25
|
+
- README.md
|
26
|
+
- Rakefile
|
27
|
+
- lib/simple_inline_text_annotation.rb
|
28
|
+
- lib/simple_inline_text_annotation/denotation.rb
|
29
|
+
- lib/simple_inline_text_annotation/denotation_validator.rb
|
30
|
+
- lib/simple_inline_text_annotation/entity_type_collection.rb
|
31
|
+
- lib/simple_inline_text_annotation/generator.rb
|
32
|
+
- lib/simple_inline_text_annotation/generator_error.rb
|
33
|
+
- lib/simple_inline_text_annotation/parser.rb
|
34
|
+
- lib/simple_inline_text_annotation/version.rb
|
35
|
+
- sig/simple_inline_text_annotation.rbs
|
36
|
+
homepage: https://github.com/Tamada-Arino/simple-inline-text-annotation
|
37
|
+
licenses:
|
38
|
+
- MIT
|
39
|
+
metadata:
|
40
|
+
homepage_uri: https://github.com/Tamada-Arino/simple-inline-text-annotation
|
41
|
+
changelog_uri: https://github.com/Tamada-Arino/simple-inline-text-annotation/blob/master/CHANGELOG.md
|
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: 3.1.0
|
50
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
requirements: []
|
56
|
+
rubygems_version: 3.6.2
|
57
|
+
specification_version: 4
|
58
|
+
summary: A Ruby gem for inline text annotation with denotations and entity types.
|
59
|
+
test_files: []
|