cron_config_parser 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: bf8cde4d225478b58bd0ca262720c1800bbf481badd4fd4297827440ae01fc80
4
+ data.tar.gz: 81c27cb9f9bafcd0f6c140f5d709acf2a22ad1659d4df914b4e0233561e41d85
5
+ SHA512:
6
+ metadata.gz: 91a272c9eedd125bf5160e0c9c79e0a13c9fd1daada02cdf2ce19b1c410f0cd59c6a647004f3792209e4e7e7b07d1487c4bc82cb71512a112d23358aaddd633e
7
+ data.tar.gz: 324653a9f72dca12c7964c4d826ebd4b94fadecc50d51d8c8eeeda89d052d51b2444dc136b23ff5f3558b9f28b2795352f2b9180469abba0e247197ec0f9ced7
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ /vendor/bundle
10
+ # rspec failure tracking
11
+ .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.1
7
+ before_install: gem install bundler -v 1.17.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 17684091+Madogiwa0124@users.noreply.github.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,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in cron_config_parser.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,35 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ cron_config_parser (0.1.1)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ rake (10.5.0)
11
+ rspec (3.8.0)
12
+ rspec-core (~> 3.8.0)
13
+ rspec-expectations (~> 3.8.0)
14
+ rspec-mocks (~> 3.8.0)
15
+ rspec-core (3.8.0)
16
+ rspec-support (~> 3.8.0)
17
+ rspec-expectations (3.8.3)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.8.0)
20
+ rspec-mocks (3.8.0)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.8.0)
23
+ rspec-support (3.8.0)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ bundler (~> 1.17)
30
+ cron_config_parser!
31
+ rake (~> 10.0)
32
+ rspec (~> 3.0)
33
+
34
+ BUNDLED WITH
35
+ 1.17.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Madogiwa
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,79 @@
1
+ # CronConfigParser
2
+ You can parse the cron configuration for readability.
3
+
4
+ ## Installation
5
+
6
+ Add this line to your application's Gemfile:
7
+
8
+ ```ruby
9
+ gem 'cron_config_parser'
10
+ ```
11
+
12
+ And then execute:
13
+
14
+ $ bundle
15
+
16
+ Or install it yourself as:
17
+
18
+ $ gem install cron_config_parser
19
+
20
+ ## Usage
21
+
22
+ You can parse the cron configuration for readability with `CronConfigParser::Parser.call`.
23
+
24
+ ``` ruby
25
+ CronConfigParser::Parser.call('00 5 * * * Asia/Tokyo')
26
+ => #<CronConfigParser::CronConfig:0x00007fa4f492e820
27
+ @days=["*"],
28
+ @hours=["5"],
29
+ @minutes=["00"],
30
+ @months=["*"],
31
+ @timezone="Asia/Tokyo",
32
+ @wdays=["*"]>
33
+ ```
34
+
35
+ enable check configured properties.
36
+
37
+ ``` ruby
38
+ # return false if configured nil or '*'
39
+ config = CronConfigParser::Parser.call('00 5 * * * Asia/Tokyo')
40
+ config.minutes_difined?
41
+ => true
42
+ config.days_difined?
43
+ => false
44
+ ```
45
+
46
+ This gem check simple validation when CronConfigParser::CronConfig object initialize.
47
+ If the config is invalid, Config::SyntaxError or Config::RequiredError is raised.
48
+
49
+ ``` ruby
50
+ # not configured require property.
51
+ CronConfigParser::Parser.call('00 5,13 * * ')
52
+ => CronConfigParser::ConfigRequiredError
53
+
54
+ # configured invalid property.
55
+ CronConfigParser::Parser.call('00 5,a * * * Asia/Tokyo')
56
+ => CronConfigParser::ConfigSyntaxError
57
+
58
+ # this check is Invalidationable.
59
+ CronConfigParser::Parser.call('00 5,a * * * Asia/Tokyo', validation: false)
60
+ => #<CronConfigParser::CronConfig:0x00007fcedf09cdf0
61
+ @days=["*"],
62
+ @hours=["5", "a"],
63
+ @minutes=["00"],
64
+ @months=["*"],
65
+ @timezone="Asia/Tokyo",
66
+ @wdays=["*"]>
67
+ ```
68
+
69
+ ## Contributing
70
+
71
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cron_config_parser. 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.
72
+
73
+ ## License
74
+
75
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
76
+
77
+ ## Code of Conduct
78
+
79
+ Everyone interacting in the CronConfigParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cron_config_parser/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "cron_config_parser"
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
@@ -0,0 +1,28 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "cron_config_parser/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "cron_config_parser"
8
+ spec.version = CronConfigParser::VERSION
9
+ spec.authors = ["Madogiwa"]
10
+ spec.email = ["madogiwa0124@gmail.com"]
11
+
12
+ spec.summary = %q{ You can parse the cron configuration for readability. }
13
+ spec.homepage = "https://github.com/Madogiwa0124/cron_config_parser.git"
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", "~> 1.17"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec", "~> 3.0"
28
+ end
@@ -0,0 +1,73 @@
1
+ require "cron_config_parser/version"
2
+
3
+ module CronConfigParser
4
+ class ConfigSyntaxError < StandardError; end
5
+ class ConfigRequiredError < StandardError; end
6
+
7
+ class Parser
8
+ def self.call(cron_config, validation: true)
9
+ new(cron_config, validation: validation).call
10
+ end
11
+
12
+ def initialize(cron_config, validation: true)
13
+ @cron_config = cron_config
14
+ @validation = validation
15
+ end
16
+
17
+ attr_reader :cron_config, :validation
18
+
19
+ def call
20
+ CronConfig.new(cron_config, validation: validation)
21
+ end
22
+ end
23
+
24
+ class CronConfig
25
+ NOT_CONFIGURED_MARK = '*'.freeze
26
+
27
+ def initialize(cron_config, validation: true)
28
+ cron_config = cron_config.split(' ').map { |item| item.split(',') }
29
+ @minutes, @hours, @days, @months, @wdays, @timezone = cron_config
30
+ # timezone is not multiple values.
31
+ @timezone = @timezone.to_a.first
32
+ validate! if validation
33
+ end
34
+
35
+ attr_reader :minutes, :hours, :days, :months, :wdays, :timezone
36
+
37
+ # difine properties configured check methods
38
+ [:minutes, :hours, :days, :months, :wdays, :timezone].each do |attr|
39
+ define_method("#{attr}_configured?") do
40
+ value = send(attr).class == Array ? send(attr)[0] : send(attr)
41
+ ![NOT_CONFIGURED_MARK, nil].include?(value)
42
+ end
43
+ end
44
+
45
+ private
46
+
47
+ def validate!
48
+ check_required_properties!
49
+ check_properties_syntax!
50
+ end
51
+
52
+ def check_required_properties!
53
+ if [minutes, hours, days, months, wdays].flatten.include?(nil)
54
+ raise ConfigRequiredError
55
+ end
56
+ end
57
+
58
+ def check_properties_syntax!
59
+ raise ConfigSyntaxError if minutes_configured? && !values_in_range?(range: 0..60, values: minutes)
60
+ raise ConfigSyntaxError if hours_configured? && !values_in_range?(range: 0..24, values: hours)
61
+ raise ConfigSyntaxError if days_configured? && !values_in_range?(range: 1..31, values: days)
62
+ raise ConfigSyntaxError if wdays_configured? && !values_in_range?(range: 0..6, values: wdays)
63
+ end
64
+
65
+ def values_in_range?(range: , values:)
66
+ values.count == values.count { |value| range.include?(to_i(value)) }
67
+ end
68
+
69
+ def to_i(string)
70
+ Integer(string) rescue nil
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,3 @@
1
+ module CronConfigParser
2
+ VERSION = "0.1.1"
3
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cron_config_parser
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Madogiwa
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-05-18 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: '1.17'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
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:
56
+ email:
57
+ - madogiwa0124@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
+ - Gemfile.lock
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - cron_config_parser.gemspec
74
+ - lib/cron_config_parser.rb
75
+ - lib/cron_config_parser/version.rb
76
+ homepage: https://github.com/Madogiwa0124/cron_config_parser.git
77
+ licenses:
78
+ - MIT
79
+ metadata: {}
80
+ post_install_message:
81
+ rdoc_options: []
82
+ require_paths:
83
+ - lib
84
+ required_ruby_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ required_rubygems_version: !ruby/object:Gem::Requirement
90
+ requirements:
91
+ - - ">="
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ requirements: []
95
+ rubygems_version: 3.0.1
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: You can parse the cron configuration for readability.
99
+ test_files: []