Skip to content

Commit 32caaeb

Browse files
kddnewtonkddnewton
committed
Add gem infrastructure
1 parent c34baa5 commit 32caaeb

13 files changed

+283
-6
lines changed

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1+
/.bundle/
2+
/.yardoc
3+
/_yardoc/
4+
/coverage/
5+
/doc/
6+
/pkg/
7+
/spec/reports/
8+
/tmp/
9+
110
test.xml

‎CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [0.1.0] - 2022-05-25
10+
11+
### Added
12+
13+
- 🎉 Initial release! 🎉
14+
15+
[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-xml/compare/v0.1.0...HEAD
16+
[0.1.0]: https://github.com/ruby-syntax-tree/syntax_tree-xml/compare/c34baa...v0.1.0

‎Gemfile

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22

33
source "https://rubygems.org"
44

5-
gem "prettier_print"
6-
gem "syntax_tree"
5+
gemspec

‎Gemfile.lock

+21-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1+
PATH
2+
remote: .
3+
specs:
4+
syntax_tree-xml (0.1.0)
5+
prettier_print
6+
syntax_tree (>= 2.0.1)
7+
18
GEM
29
remote: https://rubygems.org/
310
specs:
11+
docile (1.4.0)
12+
minitest (5.15.0)
413
prettier_print (0.1.0)
14+
rake (13.0.6)
15+
simplecov (0.21.2)
16+
docile (~> 1.1)
17+
simplecov-html (~> 0.11)
18+
simplecov_json_formatter (~> 0.1)
19+
simplecov-html (0.12.3)
20+
simplecov_json_formatter (0.1.4)
521
syntax_tree (2.7.1)
622
prettier_print
723

824
PLATFORMS
925
x86_64-darwin-21
1026

1127
DEPENDENCIES
12-
prettier_print
13-
syntax_tree
28+
bundler
29+
minitest
30+
rake
31+
simplecov
32+
syntax_tree-xml!
1433

1534
BUNDLED WITH
1635
2.4.0.dev

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022-present Kevin Newton
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.

‎Rakefile

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# frozen_string_literal: true
2+
3+
require "bundler/gem_tasks"
4+
require "rake/testtask"
5+
require "syntax_tree/rake_tasks"
6+
7+
Rake::TestTask.new(:test) do |t|
8+
t.libs << "test"
9+
t.libs << "lib"
10+
t.test_files = FileList["test/**/*_test.rb"]
11+
end
12+
13+
SyntaxTree::Rake::CheckTask.new
14+
SyntaxTree::Rake::WriteTask.new
15+
16+
task default: :test

‎lib/syntax_tree/xml/format.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ def visit_prolog(node)
4343

4444
if node.attributes.any?
4545
q.indent do
46-
q.breakable("")
46+
q.breakable
4747
q.seplist(node.attributes, -> { q.breakable }) do |child_node|
4848
visit(child_node)
4949
end
5050
end
5151
end
5252

53-
q.breakable
53+
q.breakable("")
5454
visit(node.closing)
5555
end
5656
end

‎lib/syntax_tree/xml/version.rb

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# frozen_string_literal: true
2+
3+
module SyntaxTree
4+
module XML
5+
VERSION = "0.1.0"
6+
end
7+
end

‎syntax_tree-xml.gemspec

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# frozen_string_literal: true
2+
3+
require_relative "lib/syntax_tree/xml/version"
4+
5+
Gem::Specification.new do |spec|
6+
spec.name = "syntax_tree-xml"
7+
spec.version = SyntaxTree::XML::VERSION
8+
spec.authors = ["Kevin Newton"]
9+
spec.email = ["[email protected]"]
10+
11+
spec.summary = "Syntax Tree support for XML"
12+
spec.homepage = "https://github.com/ruby-syntax-tree/syntax_tree-xml"
13+
spec.license = "MIT"
14+
spec.metadata = { "rubygems_mfa_required" => "true" }
15+
16+
spec.files = Dir.chdir(__dir__) do
17+
`git ls-files -z`.split("\x0").reject do |f|
18+
f.match(%r{^(test|spec|features)/})
19+
end
20+
end
21+
22+
spec.bindir = "exe"
23+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24+
spec.require_paths = %w[lib]
25+
26+
spec.add_dependency "prettier_print"
27+
spec.add_dependency "syntax_tree", ">= 2.0.1"
28+
29+
spec.add_development_dependency "bundler"
30+
spec.add_development_dependency "minitest"
31+
spec.add_development_dependency "rake"
32+
spec.add_development_dependency "simplecov"
33+
end

‎test/fixture/formatted.xml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
3+
"https://www.puppycrawl.com/dtds/configuration_1_3.dtd">
4+
<?xml-model href="project.rnc" type="application/relax-ng-compact-syntax"?>
5+
<!-- foo -->
6+
<svg
7+
xmlns="http://www.w3.org/2000/svg"
8+
xmlns:xlink="http://www.w3.org/1999/xlink"
9+
width="200"
10+
height="100"
11+
viewBox="0 0 200 100"
12+
>
13+
<title>Style inheritance and the use element</title>
14+
<desc _attr="attr">
15+
&amp;
16+
&#12345;
17+
<![CDATA[
18+
foo
19+
]]>
20+
bar
21+
</desc>
22+
<?pagebreak?>
23+
24+
<style />
25+
<style />
26+
<style type="text/css">
27+
circle { stroke-opacity: 0.7; }
28+
.special circle { stroke: green; }
29+
use { stroke: purple;
30+
fill: orange; }
31+
</style>
32+
33+
<yaml
34+
myveryveryveryverylongattributename="myveryveryveryverylongattributevalue"
35+
>
36+
- 1
37+
- 2
38+
- 3
39+
</yaml>
40+
41+
<!-- inner comment -->
42+
43+
<?pagebreak?>
44+
<g class="special" style="fill: blue">
45+
<circle id="c" cy="50" cx="50" r="40" stroke-width="20" />
46+
</g>
47+
<use xlink:href="#c" x="100" />
48+
<ignored>
49+
<!-- prettier-ignore-start -->
50+
<ignored />
51+
<!-- prettier-ignore-end -->
52+
</ignored>
53+
<p>
54+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at est eget
55+
enim consectetur accumsan. Aliquam pretium sodales ipsum quis dignissim. Sed
56+
id sem vel diam luctus fringilla. Aliquam quis egestas magna. Curabitur
57+
molestie lorem et odio porta, et molestie libero laoreet. Morbi rhoncus
58+
sagittis cursus. Nullam vehicula pretium consequat. Praesent porta ante at
59+
posuere sollicitudin. Nullam commodo tempor arcu, at condimentum neque
60+
elementum ut.
61+
</p>
62+
<span>content</span>
63+
64+
<div>
65+
even more
66+
<content />
67+
</div>
68+
</svg>
69+
<!-- bar -->

‎test/fixture/unformatted.xml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
3+
"https://www.puppycrawl.com/dtds/configuration_1_3.dtd">
4+
<?xml-model href="project.rnc" type="application/relax-ng-compact-syntax"?>
5+
<!-- foo -->
6+
<svg
7+
xmlns="http://www.w3.org/2000/svg"
8+
xmlns:xlink="http://www.w3.org/1999/xlink"
9+
width="200"
10+
height="100"
11+
viewBox="0 0 200 100"
12+
>
13+
<title>Style inheritance and the use element</title>
14+
<desc _attr="attr">
15+
&amp; &#12345;
16+
<![CDATA[
17+
foo
18+
]]>
19+
bar
20+
</desc>
21+
<?pagebreak?>
22+
23+
<style></style>
24+
<style> </style>
25+
<style type="text/css">
26+
circle { stroke-opacity: 0.7; }
27+
.special circle { stroke: green; }
28+
use { stroke: purple;
29+
fill: orange; }
30+
</style>
31+
32+
<yaml myveryveryveryverylongattributename="myveryveryveryverylongattributevalue">
33+
- 1
34+
- 2
35+
- 3
36+
</yaml>
37+
38+
<!-- inner comment -->
39+
40+
<?pagebreak?>
41+
<g class="special" style="fill: blue">
42+
<circle id="c" cy="50" cx="50" r="40" stroke-width="20" />
43+
</g>
44+
<use xlink:href="#c" x="100" />
45+
<ignored>
46+
<!-- prettier-ignore-start -->
47+
< ignored />
48+
<!-- prettier-ignore-end -->
49+
</ignored>
50+
<p>
51+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at est eget enim consectetur accumsan. Aliquam pretium sodales ipsum quis dignissim. Sed id sem vel diam luctus fringilla. Aliquam quis egestas magna. Curabitur molestie lorem et odio porta, et molestie libero laoreet. Morbi rhoncus sagittis cursus. Nullam vehicula pretium consequat. Praesent porta ante at posuere sollicitudin. Nullam commodo tempor arcu, at condimentum neque elementum ut.
52+
</p>
53+
<span>
54+
content
55+
</span>
56+
57+
58+
<div>
59+
even more
60+
<content />
61+
</div>
62+
</svg>
63+
<!-- bar -->

‎test/test_helper.rb

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# frozen_string_literal: true
2+
3+
require "simplecov"
4+
SimpleCov.start
5+
6+
$:.unshift File.expand_path("../lib", __dir__)
7+
require "syntax_tree/xml"
8+
9+
require "minitest/autorun"

‎test/xml_test.rb

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# frozen_string_literal: true
2+
3+
require "test_helper"
4+
5+
module SyntaxTree
6+
class XMLTest < Minitest::Test
7+
def test_formatting
8+
directory = File.expand_path("fixture", __dir__)
9+
10+
expected = XML.read(File.join(directory, "formatted.xml"))
11+
actual = XML.format(XML.read(File.join(directory, "unformatted.xml")))
12+
13+
assert_equal(expected, actual)
14+
end
15+
end
16+
end

0 commit comments

Comments
 (0)