date_holidays-reader 0.9.9

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+CLOBBER.include(%w[pkg node_bin])
+
+desc 'Compile the Node dependencies'
+task :node_compile do
+  sh 'yarn run pkg bin/holidays-to-json.js --out-path=node_bin --targets=macos-x64,linux-x64'
+end
+
+# Add node_compile as a dependency to the existing build task defined by bundler:
+task build: :node_compile

data/bin/add-copyright-header.pl

@@ -0,0 +1,16 @@
+#!/usr/bin/env perl -i -p
+
+# Adds copyright headers to files passed in.
+# Example:
+# find . -name '*.rb' -exec bin/add-copyright-header.pl {} \;
+
+$header = <<'END_HEADER';
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+END_HEADER
+
+s/(# frozen_string_literal: true\n)/$1\n$header/

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require "bundler/setup"
+require "date_holidays/reader"
+
+# 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/date-holidays-version.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+/*
+ Copyright(c) 2019 - present, Blue Marble Payroll, LLC
+
+ This source code is licensed under the MIT license found in the
+ LICENSE file in the root directory of this source tree.
+*/
+
+'use strict'
+
+const path = require('path');
+const fs = require('fs');
+
+const dateHolidaysIndexJsPath = require.resolve('date-holidays');
+
+const dateHolidaysPackageJsonPath = path.join(
+  path.dirname(dateHolidaysIndexJsPath), '..', 'package.json'
+);
+
+console.log(JSON.parse(fs.readFileSync(dateHolidaysPackageJsonPath)).version);

data/bin/holidays-to-json.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+/*
+ Copyright(c) 2019 - present, Blue Marble Payroll, LLC
+
+ This source code is licensed under the MIT license found in the
+ LICENSE file in the root directory of this source tree.
+*/
+
+'use strict'
+
+/**
+ * Adapted from sample.js (https://github.com/commenthol/date-holidays/blob/master/test/sample.js).
+ * holidays-to-json.js sub_command [country.state.region] [year] [--lang en] [--state ca]
+ * e.g.
+ * holidays-to-json.js holidays at.b 2015
+ */
+var Holidays = require('date-holidays');
+
+const COMMANDS = Object.freeze({
+  holidays: (hd, opts) => hd.getHolidays(opts.year),
+  countries: (hd, _) => hd.getCountries(),
+  // Note that the language isn't working here. This appears to be a bug in the node module.
+  states: (hd, opts) => hd.getStates(opts.country, opts.languages.first),
+  regions: (hd, opts) => hd.getRegions(opts.country, opts.state, opts.languages.first),
+  languages: (hd, _) => hd.getLanguages(),
+  time_zones: (hd, _) => hd.getTimezones(),
+});
+const DEFAULT_LANGUAGE = 'en';
+
+function extractData(cmd, hd, opts) {
+  const extractor = COMMANDS[cmd]
+  let result = {};
+
+  if (extractor) {
+    result = extractor(hd, opts);
+  } else {
+    console.error("Uknown sub-command: " + cmd);
+    console.error("Valid sub-commands are: " + Object.keys(COMMANDS).join(', '));
+    process.exit(1);
+  }
+
+  // Always return the empty object so that it converts nicely to JSON.
+  return result || {};
+}
+
+if (module === require.main) {
+  const opts = {};
+  const args = process.argv.slice(2);
+  const cmd = args.shift();
+  var arg;
+
+  while ((arg = args.shift())) {
+    if (arg === '--lang') {
+      opts.languages = args.shift();
+    } else if (arg === '--state') {
+      opts.state = args.shift();
+    } else if (/^\d{4}$/.test(arg)) {
+      opts.year = arg;
+    } else if (/^[a-zA-Z]{2}/.test(arg)) {
+      opts.country = arg;
+    }
+  }
+
+  opts.year = opts.year || (new Date()).getFullYear();
+  opts.languages = opts.languages || [DEFAULT_LANGUAGE];
+
+  var hd = new Holidays(opts.country, { languages: opts.languages, state: opts.state } );
+  console.log(JSON.stringify(extractData(cmd, hd, opts)));
+}

data/bin/setup

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+yarn
+rake build
+
+# Do any other automated setup that you need to do here

data/date-holiday-reader.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_holidays/reader/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'date_holidays-reader'
+  spec.version       = DateHolidays::Reader::VERSION
+  spec.authors       = ['Ryan Gerry']
+  spec.email         = ['rgerry@bluemarblepayroll.com']
+
+  spec.summary       = 'A read only Ruby wrapper for the date-holidays Node module'
+  spec.description   = <<~DESCRIPTION
+    This provides a read only interace over the data provided by the
+    date-holidays Node module available at https://github.com/commenthol/date-holidays .'
+  DESCRIPTION
+  spec.homepage = 'http://www.github.com/bluemarblepayroll/date_holidays-reader/'
+  spec.metadata['source_code_uri'] = 'https://github.com/bluemarblepayroll/date_holidays-reader'
+  spec.metadata['changelog_uri'] = 'https://github.com/bluemarblepayroll/date_holidays-reader/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) do
+    git_files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    node_bin  = Dir.glob('node_bin/*')
+
+    git_files + node_bin
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'acts_as_hashable', '~> 1'
+  spec.add_dependency 'caution'
+  spec.add_dependency 'os', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'terminal-notifier-guard'
+end
+# rubocop:enable Metrics/BlockLength

data/lib/date_holidays/reader.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'acts_as_hashable'
+require 'caution'
+require 'json'
+require 'os'
+
+require 'date_holidays/reader/config'
+require 'date_holidays/reader/holiday'
+require 'date_holidays/reader/js_bridge'
+require 'date_holidays/reader/locale'
+require 'date_holidays/reader/version'
+
+module DateHolidays
+  # Defines the outermost module for the gem.
+  module Reader
+    # Your code goes here...
+  end
+end

data/lib/date_holidays/reader/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module DateHolidays
+  module Reader
+    # Tells the gem how to interact with Node and provides a list of countries.
+    # See the configuration section of the Readme for more inforamtion.
+    class Config
+      SUPPORTED_CPU_BITS = 64
+      private_constant :SUPPORTED_CPU_BITS
+
+      class << self
+        attr_reader :node_path
+        attr_writer :default
+
+        def node_path=(path)
+          # Clear out the cached config when the node path changes:
+          @default = nil
+          @node_path = path
+        end
+
+        def default
+          @default ||= new(node_path: node_path)
+        end
+
+        def countries
+          JsBridge.new.extract(:countries)
+        end
+      end
+
+      attr_reader :node_path
+
+      def initialize(node_path: nil)
+        @node_path = node_path
+
+        freeze
+      end
+
+      def native_mac?
+        OS.osx? && OS.bits == SUPPORTED_CPU_BITS
+      end
+
+      def native_linux?
+        OS.linux? && OS.bits == SUPPORTED_CPU_BITS
+      end
+    end
+  end
+end

data/lib/date_holidays/reader/holiday.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+# Use time from the standard library (instead of core) which has .strptime:
+require 'time'
+
+module DateHolidays
+  module Reader
+    # A holiday which includes a date, start and end times, name, and type.
+    # Based on https://github.com/commenthol/date-holidays#holiday-object .
+    #
+    # The date is represented as a Ruby Date instance as it is the
+    # holiday start date in the local time zone.
+    #
+    # Start and end times are represented as Time instances in UTC. Note that
+    # New Year's day in the US has a start time of January 1st at 5 AM UTC as
+    # Eastern Standard Time is five hours after UTC.
+    class Holiday
+      acts_as_hashable
+
+      attr_reader :date, :start_time, :end_time, :name, :type, :note
+
+      # rubocop:disable Metrics/ParameterLists
+      # This cop defaults to five parameters which seems a little low for
+      # keyword arguments. This is a value object which gets frozen after
+      # initialization so I'd rather pass in everything as needed right away.
+      def initialize(date:, start_time:, end_time:, name:, type:, substitute: false, note: nil)
+        # rubocop:enable Metrics/ParameterLists
+        @date = date.is_a?(Date) ? date : Date.strptime(date, '%Y-%m-%d')
+        @start_time = parse_time(start_time)
+        @end_time = parse_time(end_time)
+        @name = name
+        @type = type.to_sym
+        @substitute = substitute
+        @note = note
+
+        freeze
+      end
+
+      def substitute?
+        @substitute
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # I could cut down on those cops by iterating over instance variable and
+      # using meta programming. However, that would obscure intent.
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.date == date &&
+          other.start_time == start_time &&
+          other.end_time == end_time &&
+          other.name == name &&
+          other.type == type &&
+          other.substitute? == substitute? &&
+          other.note == note
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      private
+
+      def parse_time(time)
+        # Example time string: "2018-01-01T05:00:00.000Z"
+        time.is_a?(Time) ? time : Time.xmlschema(time)
+      end
+    end
+  end
+end
+
+# For reference:
+# Core Time: https://ruby-doc.org/core-2.3.6/Time.html
+# Stdlib Time: https://ruby-doc.org/stdlib-2.3.8/libdoc/time/rdoc/Time.html
+# Stdlib Date: http://ruby-doc.org/stdlib-2.3.8/libdoc/date/rdoc/Date.html

data/lib/date_holidays/reader/js_bridge.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module DateHolidays
+  module Reader
+    # A communication bridge to the JavaScript process which houses the date-holidays node module.
+    class JsBridge
+      BIN_PATH = File.expand_path('../../../bin', __dir__).freeze
+
+      JS_PROGRAM_PATH = File.expand_path(File.join(BIN_PATH, '/holidays-to-json.js')).freeze
+      NODE_BIN_PATH = File.expand_path('../../../node_bin', __dir__).freeze
+      private_constant :JS_PROGRAM_PATH, :NODE_BIN_PATH
+
+      attr_reader :config, :debug
+
+      # TODO: initialize with a configuration object for how to run the command
+      def initialize(config = Config.default, debug: false)
+        @config = config
+        @debug = debug
+
+        freeze
+      end
+
+      def extract(sub_cmd, *args)
+        JSON.parse(get_output(holidays_to_json_command + [sub_cmd, *args]))
+      end
+
+      def get_output(args)
+        args = Array(args)
+        cmd_tokens_as_strings = args.map(&:to_s)
+        output = nil
+
+        print_command(cmd_tokens_as_strings) if debug
+
+        IO.popen(cmd_tokens_as_strings, err: %i[child out]) { |cmd_io| output = cmd_io.read }
+        output
+      end
+
+      private
+
+      # Returns an array of strings containing the tokens to execute the
+      # date-holidays wrapper depending on configuration.
+      def holidays_to_json_command
+        if config.node_path
+          [config.node_path, JS_PROGRAM_PATH]
+        elsif pre_compiled_program
+          [File.join(NODE_BIN_PATH, pre_compiled_program)]
+        else
+          # Fallback: a node path has not been configured and there is no
+          # pre-compiled program for this OS so fallback to the shebang line in
+          # the JS file.
+          [JS_PROGRAM_PATH]
+        end
+      end
+
+      def pre_compiled_program
+        if config.native_mac?
+          'holidays-to-json-macos'
+        elsif config.native_linux?
+          'holidays-to-json-linux'
+        end
+      end
+
+      def output_command(cmd_args)
+        puts "#{self.class}: about to invoke: '#{cmd_args.join(' ')}'"
+      end
+    end
+  end
+end