goldman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94e9f4694277445b718dc5efec92c4b621540ac8800802980c795e6fb2998060
+  data.tar.gz: cf7dc5372d1f68547e08ebe11dd3216e304e933a29e3e84d4ef338c40bfbbca5
+SHA512:
+  metadata.gz: f1a511821fe32070639b8213704db0d5c1f515b9b65f88bfbfa1086a79a92ec0fb88254b83575a4f6383784677f8c4d401ca5ceb63307d94e0c9e493b02da429
+  data.tar.gz: 5e4bc508cb884737b0c87322513c53c16ebeee262da65050d1c36afe8e1baddcb3651511a10502343c785b99e3886d6880d0dc9fb29c9461874e13e48c0b6f0b

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  DisabledByDefault: true
+  SuggestExtensions: false
+  Exclude:
+    - goldman.gemspec
+    - bin/*
+    - vendor/**/*
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/MultilineIfThen:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/IndentationStyle:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable

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 smile.v.chen@gmail.com. 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/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in goldman.gemspec
+gemspec
+
+gem "minitest"
+gem "rake"
+gem "rubocop"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Wei Chen
+
+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,82 @@
+# Goldman
+
+Goldman is a tool for [g]enerating [o]ption [l]ist of sche[d]ule. And goldman-rb is its ruby
+implementation.
+
+## Installation
+
+Goldman's installation is standard for a Ruby gem:
+
+```sh
+gem install goldman
+```
+
+## Setup and configuration
+Please create a configuration file `config.yml` in the path `~/.goldman`. If you want to change the config path, please use the environment variable `GOLDMANPATH.`
+
+Please define the data of schedule options are described in `config.yml` as follows.
+The available data keys are `everyday`, `weekday`, `weekend`, and the day of the week.
+
+```yml:config.yml
+data:
+  everyday:
+    - "10:00~11:00"
+  weekday:
+    - "12:00~13:00"
+  weekend:
+    - "20:00~21:00"
+  monday: 
+    - "16:00~17:00"
+  wednesday:
+    - "16:00~17:00"
+  thursday:
+    - "16:00~17:00"
+```
+
+You can customize the format to display each schedule option by setting them up in `config.yml`. If it is not customized, the tool uses the default one.
+
+```yml:config.yml
+format:
+  schedule: "%{date}(%{wday}) %{time}"
+  date: "%Y/%m/%d"
+  wday:
+    monday: "月"
+    tuesday: "火"
+    wednesday: "水"
+    thursday: "木"
+    friday: "金"
+    saturday: "土"
+    sunday: "日"
+```
+
+## Usage
+The start date will always be today if it is not specified.
+
+```sh
+# Generate schedule options in a week
+goldman -g
+
+# Generate schedule options starting from today (assume 2023-04-25) and ending to 2023-04-30
+goldman -g -e 2023-04-30
+
+# Generate schedule options starting from 2023-05-08 and ending to 2023-04-30
+goldman -g -s 2023-05-08 -e 2023-05-12
+
+# Generate schedule options in three weeks
+goldman -g -w 3
+
+# Generate schedule options in eight days
+goldman -g -d 8
+```
+
+The example of generated schedule options is as follows.
+
+```sh
+❯ goldman -g -d 5
+2023/04/25(Tue) 12:00~13:00
+2023/04/26(Wed) 12:00~13:00
+2023/04/26(Wed) 16:00~17:00
+2023/04/27(Thu) 12:00~13:00
+2023/04/27(Thu) 16:00~17:00
+2023/04/28(Fri) 12:00~13:00
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/goldman

@@ -0,0 +1,57 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# (C) Wei Chen (willsmile)
+# MIT license
+
+require "goldman"
+require "optparse"
+
+GOLDMANPATH = ENV["GOLDMANPATH"] || File.expand_path("~/.goldman")
+CONFIG_FILENAME = "config.yml"
+NON_OPERATIONAL_OPTS = [:config]
+
+# default value
+@options = {
+  config: GOLDMANPATH + "/" + CONFIG_FILENAME
+}
+
+opts = OptionParser.new do |opts|
+  opts.on("-c", "--config FILE", "Use a config file") { |v| @options[:config] = v }
+  opts.on("-g", "--generate", "Generate list of schedule options") { |v| @options[:generate] = v }
+  opts.on("-s", "--start [DATE]", "Set start date") { |v| @options[:start_date] = v }
+  opts.on("-e", "--end [DATE]", "Set end date") { |v| @options[:end_date] = v }
+  opts.on("-d", "--day [INTEGER]", "Set day interval from start date") { |v| @options[:day] = v }
+  opts.on("-w", "--week [INTEGER]", "Set week interval  from start date") { |v| @options[:week] = v }
+  opts.on("-v", "--version", "Show tool version") { |v| @options[:version] = v }
+
+  opts.parse!(ARGV)
+end
+
+def error(message)
+  warn "ERROR: #{message}"
+  exit 1
+end
+
+begin
+  date_form = Goldman::DateForm.new(@options)
+  config = Goldman::Config.new(@options[:config])
+  formatter = Goldman::Formatter.new(config)
+  data = Goldman::DataLoader.new(config).data
+  generator = Goldman::Generator.new(data, formatter, date_form)
+  
+  @options.each do |k, v|
+    case k
+    when :generate
+      generator.exec
+    when *NON_OPERATIONAL_OPTS
+      # Do nothing here
+    when :version
+      Goldman.version
+    end
+  end
+rescue Goldman::Error => ex
+  error ex.message
+rescue Errno::ENOENT
+  error "Config file (#{@options[:config]}) dose not exist."
+end

data/goldman.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/goldman/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "goldman"
+  spec.version = Goldman::VERSION
+  spec.authors = ["Wei Chen (willsmile)"]
+  spec.email = ["willsmile.me@gmail.com"]
+
+  spec.summary = %q{goldman}
+  spec.description = %q{goldman for generating option list of schedule}
+  spec.homepage = "https://github.com/willsmile/goldman-rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # 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])
+    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"
+
+  # 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/goldman/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "psych"
+
+module Goldman
+  class Config
+    attr_reader :raw_data, :customized_format
+
+    def initialize(path)
+      @path = path
+      @config = load_file
+      @raw_data = load_data
+      @customized_format = load_customized_format
+    end
+
+    private
+
+    def load_file
+      Psych.safe_load_file(@path, symbolize_names: true)
+    end
+
+    def load_data
+      return {} unless @config.has_key?(:data)
+
+      @config[:data]
+    end
+
+    def load_customized_format
+      return {} unless @config.has_key?(:format)
+
+      @config[:format]
+    end
+  end
+end

data/lib/goldman/data_loader.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Goldman
+  class DataLoader
+    def initialize(config)
+      @raw_data = config.raw_data
+    end
+
+    def data
+      result = {}
+      Goldman::Wday.members.each do |w|
+        periods = []
+        periods += wday(w) unless wday(w).nil?
+        periods += everyday unless everyday.nil?
+        periods += weekday if Goldman::Wday.weekday?(w) && !weekday.nil?
+        periods += weekend if Goldman::Wday.weekend?(w) && !weekend.nil?
+        result[Goldman::Wday.to_num(w)] = sort(periods) unless periods.empty?
+      end
+
+      result
+    end
+
+    private
+
+    def sort(periods)
+      periods.sort_by { _1.split(":").first.to_i }
+    end
+
+    def wday(name)
+      @raw_data[name]
+    end
+
+    def weekday
+      @raw_data[:weekday]
+    end
+
+    def weekend
+      @raw_data[:weekend]
+    end
+
+    def everyday
+      @raw_data[:everyday]
+    end
+  end
+end

data/lib/goldman/date_form.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Goldman
+  class DateForm
+    def initialize(options)
+      @week_num = parse_num!(options[:week], "week")
+      @day_num = parse_num!(options[:day], "day") || default_day_num
+      @start_date = parse_date!(options[:start_date], "start_date") || today
+      @end_date = parse_date!(options[:end_date], "end_date")
+      validate_end_date!
+    end
+
+    def range
+      return @start_date..@end_date if @end_date
+
+      @start_date..(@start_date + interval_day)
+    end
+
+    def interval_day
+      return @week_num * 7 - 1 if @week_num
+
+      @day_num - 1
+    end
+
+    private
+
+    def validate_end_date!
+      return if @end_date.nil?
+
+      err_msg = "The date in start_date (#{@start_date}) should be before the date in end_date (#{@end_date})."
+      raise Goldman::ParameterError.new(err_msg) if @start_date > @end_date
+    end
+
+    def parse_date!(str, source)
+      return if str.nil?
+
+      begin
+        Date.parse(str)
+      rescue Date::Error, TypeError
+        raise Goldman::ParameterError.new("The parameter of #{source} (#{str}) is invalid.")
+      end
+    end
+
+    def parse_num!(str, source)
+      return if str.nil?
+
+      begin
+        Integer(str)
+      rescue ArgumentError, TypeError
+        raise Goldman::ParameterError.new("The parameter of #{source} (#{str}) is invalid.")
+      end
+    end
+
+    def today
+      Date.today
+    end
+
+    def default_day_num
+      7
+    end
+  end
+end

data/lib/goldman/formatter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Goldman
+  class Formatter
+    attr_reader :customized_format, :default_format
+
+    def initialize(config)
+      @customized_format = config.customized_format
+      @default_format = DEFAULT_FORMAT
+    end
+
+    def schedule(date, time_str)
+      puts format(:schedule) % { date: formatted_date(date), wday: formatted_wday(date.cwday), time: time_str }
+    end
+
+    def format(target)
+      return @customized_format[target] if @customized_format&.has_key?(target)
+
+      @default_format[target]
+    end
+
+    private
+
+    def formatted_wday(wday_num)
+      wday_name = Goldman::Wday.to_name(wday_num)
+      format(:wday)[wday_name]
+    end
+
+    def formatted_date(date)
+      format = format(:date)
+      date.strftime(format)
+    end
+  end
+end

data/lib/goldman/generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Goldman
+  class Generator
+    def initialize(data, formatter, date_form)
+      @data = data
+      @formatter = formatter
+      @date_form = date_form
+    end
+
+    def exec
+      raise Goldman::OperationError.new("No data for schedule. Please define them in the config file.") if @data.empty?
+
+      @date_form.range.each do |date|
+        @data[date.cwday]&.each do |time|
+          @formatter.schedule(date, time)
+        end
+      end
+    end
+  end
+end

data/lib/goldman/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Goldman
+  VERSION = "0.1.0"
+
+  def self.version
+    puts "Goldman version #{VERSION}"
+  end
+end

data/lib/goldman/wday.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Goldman
+  module Wday
+    DATA = {
+      monday: 1,
+      tuesday: 2,
+      wednesday: 3,
+      thursday: 4,
+      friday: 5,
+      saturday: 6,
+      sunday: 7
+    }
+
+    class << self
+      def members
+        DATA.keys
+      end
+
+      def to_name(num)
+        DATA.key(num)
+      end
+
+      def to_num(name)
+        DATA[name]
+      end
+
+      def weekday?(name)
+        DATA[name] < 6
+      end
+
+      def weekend?(name)
+        DATA[name] > 5
+      end
+    end
+  end
+end

data/lib/goldman.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "goldman/config"
+require_relative "goldman/data_loader"
+require_relative "goldman/date_form"
+require_relative "goldman/formatter"
+require_relative "goldman/generator"
+require_relative "goldman/version"
+require_relative "goldman/wday"
+
+module Goldman
+  DEFAULT_FORMAT = {
+    schedule: "%{date}(%{wday}) %{time}",
+    date: "%Y/%m/%d",
+    wday: {
+      monday: "Mon",
+      tuesday: "Tue",
+      wednesday: "Wed",
+      thursday: "Thu",
+      friday: "Fri",
+      saturday: "Sat",
+      sunday: "Sun"
+    }
+  }
+
+  class Error < StandardError; end
+  class ParameterError < Error; end
+  class ConfigurationError < Error; end
+  class OperationError < Error; end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: goldman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wei Chen (willsmile)
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-25 00:00:00.000000000 Z
+dependencies: []
+description: goldman for generating option list of schedule
+email:
+- willsmile.me@gmail.com
+executables:
+- goldman
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/goldman
+- goldman.gemspec
+- lib/goldman.rb
+- lib/goldman/config.rb
+- lib/goldman/data_loader.rb
+- lib/goldman/date_form.rb
+- lib/goldman/formatter.rb
+- lib/goldman/generator.rb
+- lib/goldman/version.rb
+- lib/goldman/wday.rb
+homepage: https://github.com/willsmile/goldman-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: goldman
+test_files: []