day_offs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ad83ba16e97952c923bf7ace9c5f8d4e32d7778305fd1e4232c1a3f02a52bb0
+  data.tar.gz: 8cc866eade67a07e6b4948cdd7bda73dbc004c4cda7e030cdf03d84439330417
+SHA512:
+  metadata.gz: ca75a686f2e85833565ddd15edc3e0285b518be498d8d91f30a2ec8dac0c01a44a9730dbd500ed5173442eba36708a2f42df35f94e636010b700531795c46223
+  data.tar.gz: 9f541d4cd5034e014606dbe81edf82f324a2507417209e7c2c933c2c675a99fefaa959e97ccce0e141493395c12f1a003142c02d5da6b68eb99b68fa83f4f9b7

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Nekitonich4@yandex.ru. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kroched
+
+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,70 @@
+<div align="center">
+  <h1>DayOffs</h1>
+<div><a href='https://coveralls.io/github/Kroch4ka/day_offs?branch=main'><img src='https://coveralls.io/repos/github/Kroch4ka/day_offs/badge.svg?branch=main' alt='Coverage Status' /></a>
+<a href="https://codeclimate.com/github/Kroch4ka/day_offs/maintainability"><img src="https://api.codeclimate.com/v1/badges/119af1d7fc0a499d9388/maintainability" /></a></div>
+  Add day offs sources for different countries in a standardized manner
+  <br /><br />
+</div>
+
+DayOffs is a plugin system that allows you to easy create and register various sources about days off and use them in a standardized manner
+
+---
+
+## Add own sources
+
+When you subclass ```DayOffs::Sources::Base```, you get helpful methods defined and all you need to do is to override the call method
+
+```ruby
+module DayOffs::Sources
+  class MySource < Base
+    with_countries :RU, :BY # define supported countries
+    with_years 2023, 2024 # define supported years
+    with_name :super_source # define source name
+    
+    def call
+      [
+        DayOffs::DayOff.new(country, Date.civil(year))
+      ] # you can access to target instance variables
+    end
+  end
+  
+  class MyAnotherSource < Base
+    with_countries :BY
+    with_years 2023, 2024
+    with_name :another_source
+    
+    def call
+      [
+        DayOffs::DayOff.new(country, Date.civil(year))
+      ]
+    end
+  end
+end
+```
+
+Sources should return an array of objects ``DayOffs::DayOff`` it`s simple struct ``Struct.new(:country, :date)``
+
+## Configuration
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'day_offs'
+```
+
+Add source:
+
+```ruby
+DayOffs.configure do |c|
+  c.use_sources :super_source
+end
+```
+
+## Usage
+
+Adding a class and inheriting from `DayOffs::Sources::Base` will allow you to interact with the chosen sources:
+
+```ruby
+DayOffs::RU.fetch(2023)
+DayOffs::BY.fetch(2023, :another_source)
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/day_offs.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/day_offs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "day_offs"
+  spec.version = DayOffs::VERSION
+  spec.authors = ["Kroched"]
+  spec.email = ["Nekitonich4@yandex.ru"]
+
+  spec.summary = "Plugin system for support day offs sources"
+  spec.description = "Add day offs sources for different countries in a standardized manner"
+  spec.homepage = "https://github.com/Kroch4ka/day_offs"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Kroch4ka/day_offs"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/day_offs/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class DayOffs::Configuration
+  class UndefinedSourceError < StandardError; end
+
+  def use_sources(*sources)
+    sources.each { |source| use_source(source) }
+  end
+
+  private
+
+  def use_source(source)
+    source_klass = DayOffs.registered_sources.find { |src| src.source_name == source } if source.is_a?(Symbol)
+    source_klass ||= source if source.respond_to?(:ancestors) && source.ancestors.include?(DayOffs::Sources::Base)
+
+    raise UndefinedSourceError unless source_klass
+
+    add_source_klass(source_klass)
+  end
+
+  def add_source_klass(source_klass)
+    source_klass.countries.each do |country|
+      source_klass.years.each do |year|
+        DayOffs.used_sources[country] ||= {}
+        DayOffs.used_sources[country][year] ||= []
+        DayOffs.used_sources[country][year] << source_klass
+      end
+    end
+  end
+end

data/lib/day_offs/core.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DayOffs::Core
+  class << self
+    def objectize_sources
+      DayOffs.used_sources.each do |country, year_sources_hash|
+        DayOffs.const_set(country, Class.new).instance_eval do
+          @sources = year_sources_hash
+          @country = country
+
+          def fetch(year, source = nil)
+            raise DayOffs::Errors::UnsupportedYearError unless @sources[year]
+
+            source = @sources[year].find { |s| s.source_name == source } || @sources[year].first
+            source.call(year, @country)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/day_offs/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DayOffs::Errors
+  class UnsupportedYearError < StandardError; end
+end

data/lib/day_offs/sources/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class DayOffs::Sources::Base
+  attr_reader :country, :year
+
+  def initialize(year, country)
+    @year = year
+    @country = country
+  end
+
+  def call
+    raise DayOffs::Sources::Errors::UnimplementedMethodError
+  end
+
+  class << self
+    def call(year, country)
+      new(year, country).call
+    end
+
+    private
+
+    def inherited(subclass)
+      super
+      DayOffs.registered_sources << subclass
+      subclass.instance_exec do
+        extend DayOffs::Sources::DSL
+      end
+    end
+  end
+end

data/lib/day_offs/sources/dsl.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DayOffs::Sources::DSL
+
+  def self.extended(klass)
+    super
+    klass.instance_exec do
+      @countries = []
+      @years = []
+    end
+    klass.singleton_class.instance_exec do
+      attr_accessor :countries, :years, :source_name
+    end
+  end
+
+  def with_countries(*countries_alpha2)
+    verified_countries = countries_alpha2.map do |country|
+      DayOffs::Sources::Validator.validate_country(country.upcase)
+      country.upcase
+    end
+
+    self.countries = countries + verified_countries
+  end
+
+  def with_name(source_name)
+    self.source_name = source_name
+  end
+
+  def with_years(*years)
+    years.each { |year| DayOffs::Sources::Validator.validate_year(year.to_s) }
+    self.years = self.years + years
+  end
+end

data/lib/day_offs/sources/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DayOffs::Sources::Errors
+  class IncorrectAlpha2CountryError < StandardError; end
+  class IncorrectYearError < StandardError; end
+  class UnimplementedMethodError < StandardError; end
+end

data/lib/day_offs/sources/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DayOffs::Sources::Utils
+  class << self
+    def valid_country_alpha2_code?(country_code)
+      !!(country_code =~ /^[A-Z]{2}$/)
+    end
+
+    def valid_year?(year)
+      !!(year.to_s =~ /^[0-9]{4}$/)
+    end
+  end
+end

data/lib/day_offs/sources/validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DayOffs::Sources::Validator
+  class << self
+    def validate_country(country)
+      unless DayOffs::Sources::Utils.valid_country_alpha2_code?(country)
+        raise DayOffs::Sources::Errors::IncorrectAlpha2CountryError
+      end
+    end
+
+    def validate_year(year)
+      unless DayOffs::Sources::Utils.valid_year?(year)
+        raise DayOffs::Sources::Errors::IncorrectYearError
+      end
+    end
+  end
+end

data/lib/day_offs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DayOffs
+  VERSION = "0.1.0"
+end

data/lib/day_offs.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "day_offs/version"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "dsl" => "DSL"
+)
+loader.setup
+
+module DayOffs
+  @registered_sources = []
+  @used_sources = {}
+
+  DayOff = Struct.new(:country, :date) do
+    def ==(other)
+      country == other.country && date == other.date
+    end
+  end
+
+  class << self
+    attr_reader :configuration
+    attr_accessor :registered_sources, :used_sources
+
+    def configure
+      @configuration = yield(Configuration.new)
+      DayOffs::Core.objectize_sources
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: day_offs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kroched
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Add day offs sources for different countries in a standardized manner
+email:
+- Nekitonich4@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- day_offs.gemspec
+- lib/day_offs.rb
+- lib/day_offs/configuration.rb
+- lib/day_offs/core.rb
+- lib/day_offs/errors.rb
+- lib/day_offs/sources/base.rb
+- lib/day_offs/sources/dsl.rb
+- lib/day_offs/sources/errors.rb
+- lib/day_offs/sources/utils.rb
+- lib/day_offs/sources/validator.rb
+- lib/day_offs/version.rb
+homepage: https://github.com/Kroch4ka/day_offs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Kroch4ka/day_offs
+  source_code_uri: https://github.com/Kroch4ka/day_offs
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Plugin system for support day offs sources
+test_files: []