yamcha 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b9ad5a453ebb74d7c9983321bb8da0ca7fe1853220c52c5e03b5c857ba931eaa
4
+ data.tar.gz: 8050d5f958de053677af8f1bdf2079817a1e9a516b78f647f58b727246661e06
5
+ SHA512:
6
+ metadata.gz: aa28b85522b1711a7835ca9daa1a395e69f55dc03399c6d0ee9c5a40dfb5796c52a6875aa187c57a7513ae85130025b4c4b3e367d370deea42f4c6d8892d8710
7
+ data.tar.gz: 0eab586615255ae74bbc3e288e0970e08912a5d963dfc482f2e0371183c369c1e24543775baa70e292760a7ac09ba8174a0bcf199c1765e6e4930b1281894140
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ /Gemfile.lock
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 2.0.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at yuya.mitsuboshi@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in yamcha.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 mitsubosh
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,63 @@
1
+ # Yamcha
2
+
3
+ Yamcha is a Yaml Validator.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'yamcha'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install yamcha
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ yaml = {a: 1}.to_yaml
25
+ Yamcha::Validator.new(yaml).validate!
26
+ #=> {":a"=>"1"}
27
+ ```
28
+
29
+ If there is a duplicated mapping key in the yaml, it occures raise `Yamcha::Validator::DuplicatedMappingKey::Error`.
30
+
31
+ ```ruby
32
+ yaml = <<~YAML
33
+ ---
34
+ a: 1
35
+ a: 2
36
+ YAML
37
+ Yamcha::Validator.new(yaml).validate!
38
+ #=> Yamcha::Validator::DuplicatedMappingKey::Error (duplicated key `a` exists)
39
+ ```
40
+
41
+ If you would like to validate `*.yml` file itself, please try like the following example.
42
+
43
+ ```ruby
44
+ Yamcha::Validator.new(File.read('./sample.yml')).validate!
45
+ ```
46
+
47
+ ## Development
48
+
49
+ 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.
50
+
51
+ 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
52
+
53
+ ## Contributing
54
+
55
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yamcha. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
56
+
57
+ ## License
58
+
59
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
60
+
61
+ ## Code of Conduct
62
+
63
+ Everyone interacting in the Yamcha project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yamcha/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "yamcha"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/yamcha.rb ADDED
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'psych'
4
+ require 'yaml'
5
+
6
+ require "yamcha/version"
7
+ require "yamcha/composer"
8
+ require "yamcha/node_resolver"
9
+ require "yamcha/validator"
10
+
11
+ module Yamcha
12
+ class Error < StandardError; end
13
+ # Your code goes here...
14
+ end
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class Composer
5
+ def initialize(node:, enable_validator: true)
6
+ @node = node
7
+ @enable_validator = enable_validator
8
+ @hash = {}
9
+ end
10
+
11
+ def compose
12
+ resolved_node = ::Yamcha::NodeResolver.resolve(@node)
13
+
14
+ recursively_compose(resolved_node, @hash)
15
+ end
16
+
17
+ private
18
+
19
+ def recursively_compose(resolved_node, hash)
20
+ return resolved_node unless resolved_node.is_a? Array
21
+
22
+ resolved_node.each_slice(2) do |node1, node2|
23
+ resolved_node1 = ::Yamcha::NodeResolver.resolve(node1)
24
+ resolved_node2 = ::Yamcha::NodeResolver.resolve(node2)
25
+
26
+ if scalar_and_sequence?(node1, node2)
27
+ hash = compose_hash(key: resolved_node1, value: resolved_node2, hash: hash)
28
+ elsif scalar_and_mapping?(node1, node2)
29
+ tmp_hash = {}
30
+ result = recursively_compose(resolved_node2, tmp_hash)
31
+ hash = compose_hash(key: resolved_node1, value: result, hash: hash)
32
+ elsif scalar_and_saclar?(node1, node2)
33
+ hash = compose_hash(key: resolved_node1, value: resolved_node2, hash: hash)
34
+ else
35
+ # noop
36
+ end
37
+ end
38
+ hash
39
+ end
40
+
41
+ def compose_hash(key:, value:, hash:)
42
+ ::Yamcha::Validator::DuplicatedMappingKey.validate!(key_name: key, hash: hash) if @enable_validator
43
+ hash[key] = value
44
+ hash
45
+ end
46
+
47
+ def scalar_and_sequence?(node1, node2)
48
+ node1.is_a?(Psych::Nodes::Scalar) && node2.is_a?(Psych::Nodes::Sequence)
49
+ end
50
+
51
+ def scalar_and_mapping?(node1, node2)
52
+ node1.is_a?(Psych::Nodes::Scalar) && node2.is_a?(Psych::Nodes::Mapping)
53
+ end
54
+
55
+ def scalar_and_saclar?(node1, node2)
56
+ node1.is_a?(Psych::Nodes::Scalar) && node2.is_a?(Psych::Nodes::Scalar)
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "yamcha/node_resolver/base"
4
+ require "yamcha/node_resolver/document"
5
+ require "yamcha/node_resolver/mapping"
6
+ require "yamcha/node_resolver/scalar"
7
+ require "yamcha/node_resolver/sequence"
8
+
9
+ module Yamcha
10
+ class NodeResolver
11
+ class << self
12
+ def resolve(node)
13
+ new(node: node).resolve
14
+ end
15
+ end
16
+
17
+ def initialize(node:)
18
+ @node = node
19
+ end
20
+
21
+ def resolve
22
+ resolver.resolve
23
+ end
24
+
25
+ def resolver
26
+ case @node
27
+ when Psych::Nodes::Document
28
+ ::Yamcha::NodeResolver::Document.new(node: @node)
29
+ when Psych::Nodes::Mapping
30
+ ::Yamcha::NodeResolver::Mapping.new(node: @node)
31
+ when Psych::Nodes::Sequence
32
+ ::Yamcha::NodeResolver::Sequence.new(node: @node)
33
+ when Psych::Nodes::Scalar
34
+ ::Yamcha::NodeResolver::Scalar.new(node: @node)
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class NodeResolver
5
+ class Base
6
+ attr_reader :node
7
+
8
+ def initialize(node:)
9
+ @node = node
10
+ end
11
+
12
+ def resolve
13
+ raise NotImplementedError
14
+ end
15
+ end
16
+ private_constant :Base
17
+ end
18
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class NodeResolver
5
+ class Document < Base
6
+ def resolve
7
+ node.root.children
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class NodeResolver
5
+ class Mapping < Base
6
+ def resolve
7
+ node.children
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class NodeResolver
5
+ class Scalar < Base
6
+ def resolve
7
+ node.value
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class NodeResolver
5
+ class Sequence < Base
6
+ def resolve
7
+ node.children.map(&:value)
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "yamcha/validator/duplicated_mapping_key"
4
+
5
+ module Yamcha
6
+ class Validator
7
+ attr_reader :original_yaml
8
+
9
+ def initialize(yaml_data)
10
+ @original_yaml = yaml_data
11
+ end
12
+
13
+ def validate!(enable_validator: true)
14
+ ::Yamcha::Composer.new(node: parsed_nodes, enable_validator: enable_validator).compose
15
+ end
16
+
17
+ private
18
+
19
+ def parsed_nodes
20
+ @parsed_nodes ||= YAML.parse(original_yaml)
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ class Validator
5
+ class DuplicatedMappingKey
6
+ class Error < StandardError; end
7
+
8
+ class << self
9
+ def validate!(key_name:, hash:)
10
+ raise Error.new("duplicated key `#{key_name}` exists") if hash.has_key?(key_name)
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Yamcha
4
+ VERSION = "0.1.1"
5
+ end
data/yamcha.gemspec ADDED
@@ -0,0 +1,28 @@
1
+ lib = File.expand_path("lib", __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "yamcha/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "yamcha"
7
+ spec.version = Yamcha::VERSION
8
+ spec.authors = ["mitsubosh"]
9
+ spec.email = ["yuya.mitsuboshi@gmail.com"]
10
+
11
+ spec.summary = "yaml validator"
12
+ spec.description = "yaml validator"
13
+ spec.homepage = "https://github.com/MITSUBOSHI/yamcha"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency "bundler", "~> 2.0"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec", "~> 3.0"
28
+ end
metadata ADDED
@@ -0,0 +1,107 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: yamcha
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - mitsubosh
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-12-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: yaml validator
56
+ email:
57
+ - yuya.mitsuboshi@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/yamcha.rb
73
+ - lib/yamcha/composer.rb
74
+ - lib/yamcha/node_resolver.rb
75
+ - lib/yamcha/node_resolver/base.rb
76
+ - lib/yamcha/node_resolver/document.rb
77
+ - lib/yamcha/node_resolver/mapping.rb
78
+ - lib/yamcha/node_resolver/scalar.rb
79
+ - lib/yamcha/node_resolver/sequence.rb
80
+ - lib/yamcha/validator.rb
81
+ - lib/yamcha/validator/duplicated_mapping_key.rb
82
+ - lib/yamcha/version.rb
83
+ - yamcha.gemspec
84
+ homepage: https://github.com/MITSUBOSHI/yamcha
85
+ licenses:
86
+ - MIT
87
+ metadata: {}
88
+ post_install_message:
89
+ rdoc_options: []
90
+ require_paths:
91
+ - lib
92
+ required_ruby_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ required_rubygems_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ requirements: []
103
+ rubygems_version: 3.0.3
104
+ signing_key:
105
+ specification_version: 4
106
+ summary: yaml validator
107
+ test_files: []