time_wise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a3307886b5b581361c56c78b1f1605be9cfb9199c2c500bc0122737f812e5b5
+  data.tar.gz: 159cb833e152cb36cac61b1657dbdfe263b0e4159a5310234f381fb05ce03720
+SHA512:
+  metadata.gz: b1f99257cc228406c08f5cefe47c900702efdd4aea32062a38603507d0be30cbfc541a589ba559d12587a006284f676c869862f3f5daa0579192c9d2e8731343
+  data.tar.gz: 0da26d623fc56ca743822ec34c95a322015727aea03fa72081957753b954f8e735440d2d911aabaeca68ac5f63490cfcf8d56f74dbb7a4386f7fd6baa03be921

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength:
+  Max: 12 # Default is 10; you can increase if needed
+  Enabled: false # Disables the check completely
+
+Metrics/ClassLength:
+  Max: 175 # Default is 100; increase as required
+  Enabled: false # Disables the check completely
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 8 # Default is 5; increase if needed
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 1 # Allows short names like 'q'
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 184 # Adjust based on your longest line
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in time_wise.gemspec
+gemspec
+
+gem "irb"
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    time_wise (0.1.0)
+      ascii_charts (~> 0.9.1)
+      numo-narray (~> 0.9.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ascii_charts (0.9.1)
+    ast (2.4.3)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    numo-narray (0.9.2.1)
+    parallel (1.26.3)
+    parser (3.3.7.2)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.74.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.41.0)
+      parser (>= 3.3.7.2)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.5)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  irb
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  time_wise!
+
+BUNDLED WITH
+   2.6.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,129 @@
+# TimeWise
+
+TimeWise is a Ruby gem for time series analysis and visualization. It offers intuitive tools for working with time-dependent data, perfect for e-commerce, healthcare, sports analytics, and more.
+
+## Features
+
+- **Core Statistical Functions**: Calculate mean, median, standard deviation, variance, skewness, kurtosis, etc.
+- **Moving Averages**: Simple, weighted, exponential, and advanced smoothing techniques
+- **Data Visualization**: Basic visualization capabilities for analyzing trends
+- **Time Series Operations**: Slicing, manipulating, and analyzing time-indexed data
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_wise'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install time_wise
+```
+
+## Usage
+
+### Creating a Time Series
+
+```ruby
+require 'time_wise'
+
+# Create a time series from an array of values
+data = [100, 110, 120, 115, 125, 130, 140]
+ts = TimeWise.create(data)
+
+# With dates
+dates = [
+  Date.new(2023, 1, 1),
+  Date.new(2023, 1, 2),
+  Date.new(2023, 1, 3),
+  Date.new(2023, 1, 4),
+  Date.new(2023, 1, 5),
+  Date.new(2023, 1, 6),
+  Date.new(2023, 1, 7)
+]
+ts_with_dates = TimeWise.create(data, dates)
+
+# Load from CSV
+ts_from_csv = TimeWise.load_csv('data.csv', 'value', 'date')
+```
+
+### Basic Statistics
+
+```ruby
+# Calculate basic statistics
+mean = ts.stats.mean
+median = ts.stats.median
+std_dev = ts.stats.std_dev
+
+# Get a summary of all statistics
+summary = ts.stats.summary
+puts summary[:mean]
+puts summary[:std_dev]
+
+# Calculate autocorrelation
+acf = ts.stats.autocorrelation(5)  # For lags 0-5
+
+# Calculate correlation between two time series
+correlation = ts1.stats.correlation(ts2)
+```
+
+### Moving Averages
+
+```ruby
+# Simple moving average with window size 3
+sma = ts.moving_average.simple(3)
+
+# Exponential moving average with alpha=0.2
+ema = ts.moving_average.exponential(0.2)
+
+# Weighted moving average with custom weights
+weights = [0.1, 0.2, 0.3, 0.4]
+wma = ts.moving_average.weighted(4, weights)
+
+# Double exponential smoothing (Holt's method)
+dema = ts.moving_average.double_exponential(0.2, 0.1)
+```
+
+### Visualization
+
+```ruby
+# Generate a line chart
+ts.plot.line_chart(title: "My Time Series")
+
+# Compare two time series
+ts.plot.comparison_chart(another_ts, title: "Comparison")
+
+# Export to CSV
+ts.plot.export_csv("output.csv")
+
+# Display data as a table
+puts ts.plot.data_table(10)  # Show first 10 rows
+```
+
+## Coming Soon (in Future Releases)
+
+- **ARIMA Models**: For advanced time series forecasting
+- **Seasonal Analysis**: Tools for detecting and working with seasonal patterns
+- **Advanced Visualization**: More chart types and interactive plotting
+- **Anomaly Detection**: Methods for identifying outliers and unusual patterns
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/time_wise.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

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/lib/time_wise/base.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require "numo/narray"
+require "date"
+
+module TimeWise
+  # The Base class is the foundation of all time series operations in TimeWise
+  class Base
+    attr_reader :data, :dates
+
+    # Initialize a new time series object
+    # @param data [Array] Array of numeric values representing the time series
+    # @param dates [Array] Optional array of dates corresponding to each data point
+    def initialize(data, dates = nil)
+      validate_inputs(data, dates)
+
+      @data = Numo::DFloat.cast(data)
+      @dates = dates
+
+      if dates&.length&.positive?
+        @has_dates = true
+        @frequency = detect_frequency
+      else
+        @has_dates = false
+        @frequency = nil
+      end
+    end
+
+    # Get the time series as a hash with date and value arrays
+    # @return [Hash] Hash with :dates and :values keys
+    def to_h
+      if @has_dates
+        { dates: @dates, values: @data.to_a }
+      else
+        { indices: (0...@data.size).to_a, values: @data.to_a }
+      end
+    end
+
+    # Get a section of the time series
+    # @param start_idx [Integer] Starting index
+    # @param end_idx [Integer] Ending index
+    # @return [TimeWise::Base] A new time series with the specified data range
+    def slice(start_idx, end_idx)
+      end_idx = @data.size - 1 if end_idx >= @data.size
+
+      new_data = @data[start_idx..end_idx]
+      new_dates = @has_dates ? @dates[start_idx..end_idx] : nil
+
+      TimeWise.create(new_data.to_a, new_dates)
+    end
+
+    # Get a section of the time series by date range
+    # @param start_date [Date, DateTime, String] Starting date
+    # @param end_date [Date, DateTime, String] Ending date
+    # @return [TimeWise::Base] A new time series with the specified date range
+    def slice_by_date(start_date, end_date)
+      raise TimeWise::Errors::MissingDatesError, "Time series has no date information" unless @has_dates
+
+      parsed_start = parse_date(start_date)
+      parsed_end = parse_date(end_date)
+
+      indices = find_indices_in_date_range(parsed_start, parsed_end)
+
+      new_data = indices.map { |idx| @data[idx] }
+      new_dates = indices.map { |idx| @dates[idx] }
+
+      TimeWise.create(new_data, new_dates)
+    end
+
+    # Convert to array
+    # @return [Array] The time series data as a standard Ruby array
+    def to_a
+      @data.to_a
+    end
+
+    # Length of the time series
+    # @return [Integer] Number of data points
+    def length
+      @data.size
+    end
+
+    # Apply basic statistical methods
+    def stats
+      TimeWise::Statistics.new(self)
+    end
+
+    # Access moving average methods
+    def moving_average
+      TimeWise::MovingAverage.new(self)
+    end
+
+    # Access visualization methods
+    def plot
+      TimeWise::Visualization.new(self)
+    end
+
+    private
+
+    def validate_inputs(data, dates)
+      validate_data(data)
+      validate_dates(data, dates) if dates
+    end
+
+    def validate_data(data)
+      raise ArgumentError, "Data cannot be empty" if data.nil? || data.empty?
+
+      return if data.all? { |v| v.is_a?(Numeric) || v.to_f.to_s != "NaN" }
+
+      raise ArgumentError, "All data points must be numeric"
+    end
+
+    def validate_dates(data, dates)
+      return unless dates.length != data.length
+
+      raise ArgumentError, "Dates array must match data array length"
+    end
+
+    def parse_date(date)
+      date.is_a?(String) ? DateTime.parse(date) : date
+    end
+
+    def find_indices_in_date_range(start_date, end_date)
+      @dates.each_with_index
+            .select { |date, _idx| date >= start_date && date <= end_date }
+            .map { |_, idx| idx }
+    end
+
+    def detect_frequency
+      return nil if @dates.length < 2
+
+      most_common_diff = find_most_common_diff
+
+      seconds_to_frequency(most_common_diff * 86_400) # Convert to seconds (from days)
+    end
+
+    def find_most_common_diff
+      # Calculate differences between consecutive timestamps
+      diffs = (1...@dates.length).map { |i| (@dates[i] - @dates[i - 1]).to_f }
+
+      # Find the most common difference (mode)
+      freq_counts = diffs.group_by(&:itself).transform_values(&:count)
+      freq_counts.max_by { |_, count| count }.first
+    end
+
+    def seconds_to_frequency(seconds)
+      case seconds.round
+      when 60
+        :minute
+      when 3600
+        :hour
+      when 86_400
+        :day
+      when 604_800
+        :week
+      else
+        longer_frequencies(seconds)
+      end
+    end
+
+    def longer_frequencies(seconds)
+      if seconds.round.between?(2.5 * 10**6, 2.7 * 10**6)
+        :month
+      elsif seconds.round.between?(3 * 10**7, 3.16 * 10**7)
+        :year
+      else
+        :custom
+      end
+    end
+  end
+end

data/lib/time_wise/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TimeWise
+  module Errors
+    # Base error class for TimeWise
+    class Error < StandardError; end
+
+    # Raised when attempting to access dates on a time series without date information
+    class MissingDatesError < Error
+      def initialize(msg = "This operation requires date information, but the time series has no dates")
+        super
+      end
+    end
+
+    class InvalidDataError < Error; end
+
+    # Raised when the window size for operations is invalid
+    class InvalidWindowError < Error; end
+  end
+end