mdlogbook 0.1.0

data/sig/mdlogbook/overlap_checker.rbs

@@ -0,0 +1,13 @@
+# Detects overlapping time entries within a Parser::Result.
+class Mdlogbook::OverlapChecker
+  class Overlap < Data
+    attr_reader date: Date
+    attr_reader entry_a: Mdlogbook::Parser::Entry
+    attr_reader entry_b: Mdlogbook::Parser::Entry
+
+    def initialize: (date: Date, entry_a: Mdlogbook::Parser::Entry, entry_b: Mdlogbook::Parser::Entry) -> void
+  end
+
+  def check: (Mdlogbook::Parser::Result) -> Array[OverlapChecker::Overlap]
+  def format_message: (OverlapChecker::Overlap) -> String
+end

data/sig/mdlogbook/parser.rbs

@@ -0,0 +1,32 @@
+# Parses markdown logbook files into structured Result objects.
+class Mdlogbook::Parser
+  # Immutable value object representing a single time entry.
+  class Entry < Data
+    attr_reader range_str: String
+    attr_reader time: Float
+    attr_reader job: String
+    attr_reader line_number: Integer?
+
+    def initialize: (range_str: String, time: Float, job: String, ?line_number: Integer?) -> void
+
+    def start_minutes: () -> Integer
+    def end_minutes: () -> Integer
+  end
+
+  # Accumulates parsed entries and warnings for a set of log files.
+  class Result
+    attr_reader warnings: Array[String]
+
+    def initialize: () -> void
+    def add_entry: (Date, Parser::Entry) -> void
+    def add_warning: (String) -> void
+    def dates: () -> Array[Date]
+    def entries_on: (Date) -> Array[Parser::Entry]
+    def each_date: () { (Date) -> void } -> void
+    def merge!: (Parser::Result) -> self
+  end
+
+  def initialize: (?regexp: Regexp?) -> void
+  def parse_file: (String) -> Parser::Result
+  def parse: (IO) -> Parser::Result
+end

data/sig/mdlogbook/period_spec.rbs

@@ -0,0 +1,11 @@
+# Represents a contiguous date range to be processed.
+class Mdlogbook::PeriodSpec
+  attr_reader start_date: Date
+  attr_reader end_date: Date
+
+  def initialize: (Date, Date, ?month_unit: bool, ?relative: bool) -> void
+  def self.month: (Integer, Integer, ?relative: bool) -> PeriodSpec
+  def month_unit?: () -> bool
+  def relative?: () -> bool
+  def months_covered: () -> Array[[Integer, Integer]]
+end

data/sig/mdlogbook/raw_extractor.rbs

@@ -0,0 +1,15 @@
+# Extracts raw markdown lines from logbook files, grouped by date section.
+class Mdlogbook::RawExtractor
+  class Result
+    def initialize: () -> void
+    def dates: () -> Array[Date]
+    def lines_on: (Date) -> Array[String]
+    def each_date: () { (Date, Array[String]) -> void } -> void
+    def empty?: () -> bool
+    def merge!: (RawExtractor::Result) -> self
+    def add_section: (Date, Array[String]) -> void
+  end
+
+  def extract_file: (String, Range[Date]) -> RawExtractor::Result
+  def extract: (IO, Range[Date]) -> RawExtractor::Result
+end

data/sig/mdlogbook/runner/base.rbs

@@ -0,0 +1,4 @@
+# Base class for all Runner subclasses, providing shared spec parsing and file loading.
+class Mdlogbook::Runner::Base
+  def initialize: (env: Mdlogbook::Env, file_resolver: Mdlogbook::FileResolver) -> void
+end

data/sig/mdlogbook/runner/editor_runner.rbs

@@ -0,0 +1,5 @@
+# Launches the user's editor for the target log file.
+# After the editor exits successfully, validates the file for warnings and overlaps.
+class Mdlogbook::Runner::EditorRunner < Mdlogbook::Runner::Base
+  def run: () -> void
+end

data/sig/mdlogbook/runner/extract_format_runner.rbs

@@ -0,0 +1,4 @@
+# Runs extraction modes (raw, grep).
+class Mdlogbook::Runner::ExtractFormatRunner < Mdlogbook::Runner::Base
+  def run: () -> void
+end

data/sig/mdlogbook/runner/standard_format_runner.rbs

@@ -0,0 +1,4 @@
+# Runs standard summary views (simple, calendar, anonymize, anonymize_dict).
+class Mdlogbook::Runner::StandardFormatRunner < Mdlogbook::Runner::Base
+  def run: () -> void
+end

data/sig/mdlogbook/runner/visual_format_runner.rbs

@@ -0,0 +1,4 @@
+# Runs visual output modes (line_chart, grid, heatmap).
+class Mdlogbook::Runner::VisualFormatRunner < Mdlogbook::Runner::Base
+  def run: () -> void
+end

data/sig/mdlogbook/runner.rbs

@@ -0,0 +1,4 @@
+# Dispatches to the appropriate Runner subclass based on the output format.
+module Mdlogbook::Runner
+  def self.dispatch: (env: Mdlogbook::Env) -> void
+end

data/sig/mdlogbook/section_extractor.rbs

@@ -0,0 +1,24 @@
+# Extracts markdown sections whose level-2 or level-3 headings match a regexp.
+class Mdlogbook::SectionExtractor
+  class Section < Data
+    attr_reader date: Date
+    attr_reader heading_level: Integer
+    attr_reader heading: String
+    attr_reader lines: Array[String]
+
+    def initialize: (date: Date, heading_level: Integer, heading: String, lines: Array[String]) -> void
+  end
+
+  class Result
+    attr_reader sections: Array[SectionExtractor::Section]
+
+    def initialize: () -> void
+    def add_section: (SectionExtractor::Section) -> void
+    def each_section: () { (SectionExtractor::Section) -> void } -> void
+    def empty?: () -> bool
+    def merge!: (SectionExtractor::Result) -> self
+  end
+
+  def extract_file: (String, Range[Date], regexp: Regexp) -> SectionExtractor::Result
+  def extract: (IO, Range[Date], regexp: Regexp) -> SectionExtractor::Result
+end

data/sig/mdlogbook/work_thresholds.rbs

@@ -0,0 +1,11 @@
+# Holds working-time thresholds derived from monthly targets.
+class Mdlogbook::WorkThresholds
+  attr_reader target_hours: Numeric?
+  attr_reader working_days_per_month: Numeric
+  attr_reader daily_target: Float?
+  attr_reader high_threshold: Float?
+  attr_reader low_threshold: Float?
+
+  def initialize: (target_hours: Numeric?, ?working_days_per_month: Numeric) -> void
+  def target_hours?: () -> bool
+end

data/sig/mdlogbook.rbs

@@ -0,0 +1,8 @@
+# Top-level namespace for the mdlogbook gem.
+module Mdlogbook
+  VERSION: String
+
+  # Base error class for mdlogbook-specific exceptions.
+  class Error < StandardError
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: mdlogbook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- akira yamada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode_plot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: mdlogbook (mlb) parses Markdown-formatted work logs and displays aggregated
+  work hours as a list or calendar view. Supports flexible period specifiers for month,
+  week, and day ranges.
+email:
+- akira@arika.org
+executables:
+- mlb
+extensions: []
+extra_rdoc_files: []
+files:
+- AGENTS.md
+- CHANGELOG.md
+- CLAUDE.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/sample-logs/sample-2025-01.md
+- docs/sample-logs/sample-2025-02.md
+- docs/sample-logs/sample-2025-03.md
+- docs/sample-logs/sample-2025-04.md
+- docs/sample-logs/sample-2025-05.md
+- docs/sample-logs/sample-2025-06.md
+- docs/sample-logs/sample-2025-07.md
+- docs/sample-logs/sample-2025-08.md
+- docs/sample-logs/sample-2025-09.md
+- docs/sample-logs/sample-2025-10.md
+- docs/sample-logs/sample-2025-11.md
+- docs/sample-logs/sample-2025-12.md
+- docs/usage.md
+- exe/mlb
+- lib/mdlogbook.rb
+- lib/mdlogbook/arg_parser.rb
+- lib/mdlogbook/brace_expander.rb
+- lib/mdlogbook/cli.rb
+- lib/mdlogbook/config.rb
+- lib/mdlogbook/date_filter.rb
+- lib/mdlogbook/editor_launcher.rb
+- lib/mdlogbook/env.rb
+- lib/mdlogbook/file_resolver.rb
+- lib/mdlogbook/formatter/anonymize.rb
+- lib/mdlogbook/formatter/anonymize_dict.rb
+- lib/mdlogbook/formatter/base.rb
+- lib/mdlogbook/formatter/calendar.rb
+- lib/mdlogbook/formatter/chart_series_builder.rb
+- lib/mdlogbook/formatter/extract.rb
+- lib/mdlogbook/formatter/grid.rb
+- lib/mdlogbook/formatter/heatmap.rb
+- lib/mdlogbook/formatter/line_chart.rb
+- lib/mdlogbook/formatter/simple.rb
+- lib/mdlogbook/option_def.rb
+- lib/mdlogbook/option_registry.rb
+- lib/mdlogbook/overlap_checker.rb
+- lib/mdlogbook/parser.rb
+- lib/mdlogbook/period_spec.rb
+- lib/mdlogbook/raw_extractor.rb
+- lib/mdlogbook/runner.rb
+- lib/mdlogbook/runner/base.rb
+- lib/mdlogbook/runner/editor_runner.rb
+- lib/mdlogbook/runner/extract_format_runner.rb
+- lib/mdlogbook/runner/standard_format_runner.rb
+- lib/mdlogbook/runner/visual_format_runner.rb
+- lib/mdlogbook/section_extractor.rb
+- lib/mdlogbook/version.rb
+- lib/mdlogbook/work_thresholds.rb
+- sig/mdlogbook.rbs
+- sig/mdlogbook/arg_parser.rbs
+- sig/mdlogbook/brace_expander.rbs
+- sig/mdlogbook/cli.rbs
+- sig/mdlogbook/config.rbs
+- sig/mdlogbook/date_filter.rbs
+- sig/mdlogbook/editor_launcher.rbs
+- sig/mdlogbook/env.rbs
+- sig/mdlogbook/file_resolver.rbs
+- sig/mdlogbook/formatter/anonymize.rbs
+- sig/mdlogbook/formatter/anonymize_dict.rbs
+- sig/mdlogbook/formatter/base.rbs
+- sig/mdlogbook/formatter/calendar.rbs
+- sig/mdlogbook/formatter/chart_series_builder.rbs
+- sig/mdlogbook/formatter/extract.rbs
+- sig/mdlogbook/formatter/grid.rbs
+- sig/mdlogbook/formatter/heatmap.rbs
+- sig/mdlogbook/formatter/line_chart.rbs
+- sig/mdlogbook/formatter/simple.rbs
+- sig/mdlogbook/option_def.rbs
+- sig/mdlogbook/option_registry.rbs
+- sig/mdlogbook/overlap_checker.rbs
+- sig/mdlogbook/parser.rbs
+- sig/mdlogbook/period_spec.rbs
+- sig/mdlogbook/raw_extractor.rbs
+- sig/mdlogbook/runner.rbs
+- sig/mdlogbook/runner/base.rbs
+- sig/mdlogbook/runner/editor_runner.rbs
+- sig/mdlogbook/runner/extract_format_runner.rbs
+- sig/mdlogbook/runner/standard_format_runner.rbs
+- sig/mdlogbook/runner/visual_format_runner.rbs
+- sig/mdlogbook/section_extractor.rbs
+- sig/mdlogbook/work_thresholds.rbs
+homepage: https://github.com/arika/mdlogbook
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/arika/mdlogbook
+  source_code_uri: https://github.com/arika/mdlogbook
+  changelog_uri: https://github.com/arika/mdlogbook/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: CLI tool to aggregate work hours from Markdown logbooks
+test_files: []