stock_market_days 1.0.1

data/lib/stock_market_days.rb

@@ -0,0 +1,26 @@
+require 'date'
+require 'stock_market_days/calculator'
+
+module StockMarketDays
+  module_function
+  MARKET_DAYS_FILE=File.join(File.dirname(__FILE__), 'market_open_days', 'nyse_market_days.csv')
+
+  @@default_calculator = StockMarketDays::Calculator.new(MARKET_DAYS_FILE)
+
+  def is_market_day?(date = Date.today)
+    @@default_calculator.is_market_day?(date)
+  end
+
+  def market_days_between(begin_date, end_date)
+    @@default_calculator.market_days_between(begin_date, end_date)
+  end
+
+  def market_days_from(begin_date, days)
+    @@default_calculator.market_days_from(begin_date, days)
+  end
+
+  def next_market_day(from_date=Date.today)
+    @@default_calculator.market_days_from(from_date, 1)
+  end
+
+end

data/lib/stock_market_days/calculator.rb

@@ -0,0 +1,49 @@
+require 'stock_market_days/utility_methods'
+
+module StockMarketDays
+  class Calculator
+    include UtilityMethods
+
+    attr_reader :market_days_list
+
+    def initialize(market_days_file)
+      file_contents = File.open(market_days_file).read
+      @market_days_list = file_contents.split("\n").map { |date_s| Date.parse(date_s) }
+    end
+
+    def is_market_day?(date=Date.today)
+      market_days_list.include?(date)
+    end
+
+    # gets number of market days between begin_day (excluding) and end_day (including)
+    def market_days_between(begin_date, end_date)
+      unless (begin_date < end_date) &&  (end_date <= market_days_list.max)
+        raise "Please enter a begin date before the end date, prior to #{market_days_list.max}"
+      end
+
+      days_between=0
+      market_days_list.any? do |date|
+        if date > begin_date && date <= end_date
+          days_between += 1
+        end
+        return days_between if date > end_date
+      end
+      days_between
+    end
+
+    def market_days_from(begin_day, days)
+      begin_index = market_days_list.index(
+        market_days_list.find { |md| md >= begin_day }
+      )
+      if market_days_list[begin_index] == begin_day
+        market_days_list[begin_index + days]
+      elsif market_days_list[begin_index] > begin_day
+        market_days_list[begin_index - 1 + days]
+      else
+        raise "Calculator Error - This shouldn't happen in StockMarketDays#market_days_from"
+      end
+    end
+
+
+  end
+end

data/lib/stock_market_days/utility_methods.rb

@@ -0,0 +1,16 @@
+module StockMarketDays
+  module UtilityMethods
+
+    def time_strip_date(time)
+      time.to_r / 86400 % 1
+    end
+
+    def time_strip_time_zone(time)
+      Time.parse(time.strftime('%a, %d %b %Y %H:%M:%S'))
+    end
+
+    def compare_time(time1, time2)
+      (time1.to_r / 86400) % 1 <=> (time2.to_r / 86400) % 1
+    end
+  end
+end

data/lib/stock_market_days/version.rb

@@ -0,0 +1,3 @@
+module StockMarketDays
+  VERSION = '1.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,107 @@
+require 'pry'
+
+Dir[File.join(File.dirname(__FILE__), 'support', '/**/*.rb')].each { |f| require(f) }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/stock_market_days/stock_market_days_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+require 'stock_market_days'
+
+describe StockMarketDays do
+
+  context 'included in a class' do
+    let(:dummy_class) do
+      class Dummy
+        include StockMarketDays
+
+        def is_market_day_delegator(date)
+          is_market_day?(date)
+        end
+      end
+
+      Dummy.new
+    end
+
+    context '#is_market_day?' do
+      subject { dummy_class.is_market_day_delegator(date) }
+      let(:date) { Date.new(2019,12,30) }
+
+      it { is_expected.to be_truthy }
+    end
+  end
+
+  context '#is_market_day?' do
+    subject { described_class.is_market_day?(date) }
+
+    context 'is a market day' do
+      let(:date) { Date.new(2022,1,5) }
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'is Martin Luther King Day' do
+      let(:date) { Date.new(2022,1,17) }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'is Presidents Day' do
+      let(:date) { Date.new(2023,2,20) }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'is Thanksgiving' do
+      let(:date) { Date.new(2023,11,23) }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'is Christmas (observed)' do
+      let(:date) { Date.new(2027,12,24) }
+
+      it { is_expected.to be_falsey }
+    end
+  end
+
+  context '#market_days_between' do
+    subject { described_class.market_days_between(begin_date, end_date) }
+
+    context 'pure trading days' do
+      let(:begin_date) { Date.new(2020,4,20) }
+      let(:end_date) { Date.new(2020,5,27) }
+
+      it { is_expected.to eql(26) }
+    end
+
+    context 'end date on a weekend' do
+      let(:begin_date) { Date.new(2020,4,20) }
+      let(:end_date) { Date.new(2020,5,31) }
+
+      it { is_expected.to eql(28) }
+    end
+
+    context 'end date is less than begin date' do
+      let(:begin_date) { Date.new(2020,5,31) }
+      let(:end_date) { Date.new(2020,4,20) }
+
+      it { expect { subject }.to raise_error(RuntimeError) }
+    end
+  end
+
+  context '#market_days_from' do
+    subject { described_class.market_days_from(begin_date, count_days) }
+
+    context 'on a holiday weekend' do
+      context '0 days' do
+        let(:begin_date) { Date.new(2019,9,1) }
+        let(:count_days) { 0 }
+
+        it { is_expected.to eql(Date.new(2019,8,30)) } # returns most recent trading day
+      end
+
+      context '1 day' do
+        let(:begin_date) { Date.new(2019,9,1) }
+        let(:count_days) { 1 }
+
+        it { is_expected.to eql(Date.new(2019,9,3)) } # returns next trading day
+      end
+
+      context '2 days' do
+        let(:begin_date) { Date.new(2019,9,1) }
+        let(:count_days) { 2 }
+
+        it { is_expected.to eql(Date.new(2019,9,4)) }
+      end
+    end
+
+    context 'over a weekend' do
+      context '0 days' do
+        let(:begin_date) { Date.new(2019,8,30) }
+        let(:count_days) { 0 }
+
+        it { is_expected.to eql(Date.new(2019,8,30)) }
+      end
+
+      context '1 day' do
+        let(:begin_date) { Date.new(2019,8,30) }
+        let(:count_days) { 1 }
+
+        it { is_expected.to eql(Date.new(2019,9,3)) }
+      end
+
+      context '2 days' do
+        let(:begin_date) { Date.new(2019,8,30) }
+        let(:count_days) { 2 }
+
+        it { is_expected.to eql(Date.new(2019,9,4)) }
+      end
+    end
+
+    context 'midweek' do
+      let(:begin_date) { Date.new(2019,9,3) }
+      let(:count_days) { 2 }
+
+      it { is_expected.to eql(Date.new(2019,9,5)) }
+    end
+  end
+
+  context '#next_market_day' do
+    subject { described_class.next_market_day(from_date) }
+
+    context 'on a holiday weekend' do
+      let(:from_date) { Date.new(2019,9,1) }
+
+      it { is_expected.to eql(Date.new(2019,9,3)) }
+    end
+
+    context 'on a regular trading day' do
+      let(:from_date) { Date.new(2019,9,5) }
+
+      it { is_expected.to eql(Date.new(2019,9,6)) }
+    end
+
+    context 'on a Friday' do
+      let(:from_date) { Date.new(2019,8,30) }
+
+      it { is_expected.to eql(Date.new(2019,9,3)) }
+    end
+  end
+
+end

data/stock_market_days.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stock_market_days/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stock_market_days"
+  spec.version       = StockMarketDays::VERSION
+  spec.authors       = ["Winston Kotzan"]
+  spec.email         = ["wak@wakproductions.com"]
+  spec.summary       = %q{A gem for determining the days that the stock market is open}
+  spec.description   = "Tells you whether the US stock market is open on a given day, up to 2059"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = [`git ls-files`.split($/)] + Dir["lib/**/*"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", ">= 1.7"
+  spec.add_dependency "rake"
+
+  spec.add_development_dependency "clipboard"
+  spec.add_development_dependency "rspec", ">= 3.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: stock_market_days
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Winston Kotzan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tells you whether the US stock market is open on a given day, up to 2059
+email:
+- wak@wakproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/manually_invoked_build/holiday_calculator.rb
+- lib/market_open_days/easter_dates.csv
+- lib/market_open_days/nyse_market_days.csv
+- lib/stock_market_days.rb
+- lib/stock_market_days/calculator.rb
+- lib/stock_market_days/utility_methods.rb
+- lib/stock_market_days/version.rb
+- spec/spec_helper.rb
+- spec/stock_market_days/stock_market_days_spec.rb
+- spec/support/.keep
+- stock_market_days.gemspec
+homepage: ''
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A gem for determining the days that the stock market is open
+test_files:
+- spec/spec_helper.rb
+- spec/stock_market_days/stock_market_days_spec.rb
+- spec/support/.keep