cron_config_parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf8cde4d225478b58bd0ca262720c1800bbf481badd4fd4297827440ae01fc80
+  data.tar.gz: 81c27cb9f9bafcd0f6c140f5d709acf2a22ad1659d4df914b4e0233561e41d85
+SHA512:
+  metadata.gz: 91a272c9eedd125bf5160e0c9c79e0a13c9fd1daada02cdf2ce19b1c410f0cd59c6a647004f3792209e4e7e7b07d1487c4bc82cb71512a112d23358aaddd633e
+  data.tar.gz: 324653a9f72dca12c7964c4d826ebd4b94fadecc50d51d8c8eeeda89d052d51b2444dc136b23ff5f3558b9f28b2795352f2b9180469abba0e247197ec0f9ced7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 17684091+Madogiwa0124@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cron_config_parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    cron_config_parser (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  cron_config_parser!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Madogiwa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# CronConfigParser
+You can parse the cron configuration for readability.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cron_config_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cron_config_parser
+
+## Usage
+
+You can parse the cron configuration for readability with `CronConfigParser::Parser.call`.
+
+``` ruby
+CronConfigParser::Parser.call('00 5 * * * Asia/Tokyo')
+=> #<CronConfigParser::CronConfig:0x00007fa4f492e820
+ @days=["*"],
+ @hours=["5"],
+ @minutes=["00"],
+ @months=["*"],
+ @timezone="Asia/Tokyo",
+ @wdays=["*"]>
+```
+
+enable check configured properties.
+
+``` ruby
+# return false if configured nil or '*'
+config = CronConfigParser::Parser.call('00 5 * * * Asia/Tokyo')
+config.minutes_difined?
+=> true
+config.days_difined?
+=> false
+```
+
+This gem check simple validation when CronConfigParser::CronConfig object initialize.
+If the config is invalid, Config::SyntaxError or Config::RequiredError is raised.
+
+``` ruby
+# not configured require property.
+CronConfigParser::Parser.call('00 5,13 * * ')
+=> CronConfigParser::ConfigRequiredError
+
+# configured invalid property.
+CronConfigParser::Parser.call('00 5,a * * * Asia/Tokyo')
+=> CronConfigParser::ConfigSyntaxError
+
+# this check is Invalidationable.
+CronConfigParser::Parser.call('00 5,a * * * Asia/Tokyo', validation: false)
+=> #<CronConfigParser::CronConfig:0x00007fcedf09cdf0
+ @days=["*"],
+ @hours=["5", "a"],
+ @minutes=["00"],
+ @months=["*"],
+ @timezone="Asia/Tokyo",
+ @wdays=["*"]>
+```
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cron_config_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cron_config_parser.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cron_config_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cron_config_parser"
+  spec.version       = CronConfigParser::VERSION
+  spec.authors       = ["Madogiwa"]
+  spec.email         = ["madogiwa0124@gmail.com"]
+
+  spec.summary       = %q{ You can parse the cron configuration for readability. }
+  spec.homepage      = "https://github.com/Madogiwa0124/cron_config_parser.git"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cron_config_parser.rb

@@ -0,0 +1,73 @@
+require "cron_config_parser/version"
+
+module CronConfigParser
+  class ConfigSyntaxError < StandardError; end
+  class ConfigRequiredError < StandardError; end
+
+  class Parser
+    def self.call(cron_config, validation: true)
+      new(cron_config, validation: validation).call
+    end
+
+    def initialize(cron_config, validation: true)
+      @cron_config = cron_config
+      @validation = validation
+    end
+
+    attr_reader :cron_config, :validation
+
+    def call
+      CronConfig.new(cron_config, validation: validation)
+    end
+  end
+
+  class CronConfig
+    NOT_CONFIGURED_MARK = '*'.freeze
+
+    def initialize(cron_config, validation: true)
+      cron_config = cron_config.split(' ').map { |item| item.split(',') }
+      @minutes, @hours, @days, @months, @wdays, @timezone = cron_config
+      # timezone is not multiple values.
+      @timezone = @timezone.to_a.first
+      validate! if validation
+    end
+
+    attr_reader :minutes, :hours, :days, :months, :wdays, :timezone
+
+    # difine properties configured check methods
+    [:minutes, :hours, :days, :months, :wdays, :timezone].each do |attr|
+      define_method("#{attr}_configured?") do
+        value = send(attr).class == Array ? send(attr)[0] : send(attr)
+        ![NOT_CONFIGURED_MARK, nil].include?(value)
+      end
+    end
+
+    private
+
+    def validate!
+      check_required_properties!
+      check_properties_syntax!
+    end
+
+    def check_required_properties!
+      if [minutes, hours, days, months, wdays].flatten.include?(nil)
+        raise ConfigRequiredError
+      end
+    end
+
+    def check_properties_syntax!
+      raise ConfigSyntaxError if minutes_configured? && !values_in_range?(range: 0..60, values: minutes)
+      raise ConfigSyntaxError if hours_configured? && !values_in_range?(range: 0..24, values: hours)
+      raise ConfigSyntaxError if days_configured? && !values_in_range?(range: 1..31, values: days)
+      raise ConfigSyntaxError if wdays_configured? && !values_in_range?(range: 0..6, values: wdays)
+    end
+
+    def values_in_range?(range: , values:)
+      values.count == values.count { |value| range.include?(to_i(value)) }
+    end
+
+    def to_i(string)
+      Integer(string) rescue nil
+    end
+  end
+end

data/lib/cron_config_parser/version.rb

@@ -0,0 +1,3 @@
+module CronConfigParser
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cron_config_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Madogiwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- madogiwa0124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cron_config_parser.gemspec
+- lib/cron_config_parser.rb
+- lib/cron_config_parser/version.rb
+homepage: https://github.com/Madogiwa0124/cron_config_parser.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: You can parse the cron configuration for readability.
+test_files: []