mdlogbook 0.1.0

data/lib/mdlogbook/config.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Mdlogbook
+  # Loads per-project configuration from a YAML file.
+  #
+  # The config file location defaults to $XDG_CONFIG_HOME/mdlogbook/config.yml
+  # ($XDG_CONFIG_HOME defaults to ~/.config).
+  #
+  # Config file format:
+  #   project_name:
+  #     path: /path/to/logfiles
+  #     target_hours: 160
+  #     default_view: simple  # simple, calendar, line_chart, grid, or heatmap
+  #     anonymize:
+  #       format: "業務 {hash}"
+  #       passthrough:
+  #         - "定例ミーティング"
+  #         - "/^社内/"
+  #       preamble: |
+  #         以下は{range_begin}〜{range_end}の...
+  #       postamble: "---"
+  #     heatmap:
+  #       start_hour: 4  # X-axis start hour (default: 0)
+  class Config
+    DEFAULT_PROJECT = "mdlogbook"
+    DEFAULT_ANONYMIZE_FORMAT = "{hash}"
+    DEFAULT_HEATMAP_START_HOUR = 0
+    DEFAULT_VISUAL_SETTINGS = {
+      "today" => true,
+      "weekday" => false,
+      "linear" => true
+    }.freeze
+
+    # Immutable value object holding anonymize formatter settings.
+    #
+    # @!attribute [r] project
+    #   @return [String] Project name used as part of the anonymization hash input.
+    # @!attribute [r] format
+    #   @return [String] Template for anonymized headings. Use +{hash}+ as placeholder.
+    # @!attribute [r] salt
+    #   @return [String] Extra per-project salt mixed into anonymization hashes.
+    # @!attribute [r] passthrough
+    #   @return [Array<String>] Job names (or +/pattern/+ regexps) to output without anonymization.
+    # @!attribute [r] preamble
+    #   @return [String, nil] Text prepended before anonymized output. Supports +{range_begin}+/+{range_end}+.
+    # @!attribute [r] postamble
+    #   @return [String, nil] Text appended after anonymized output. Supports +{range_begin}+/+{range_end}+.
+    AnonymizeSettings = Data.define(:project, :format, :salt, :passthrough, :preamble, :postamble)
+
+    # Immutable value object holding visual formatter settings.
+    #
+    # @!attribute [r] show_today
+    #   @return [Boolean] Whether to draw a vertical line at today's position.
+    # @!attribute [r] show_weekday
+    #   @return [Boolean] Whether to draw the weekday-step target series.
+    # @!attribute [r] show_linear
+    #   @return [Boolean] Whether to draw the linear target series.
+    # @!attribute [r] colors
+    #   @return [Hash{String=>Symbol}] Series color overrides keyed by series name
+    #     (+actual+, +linear+, +weekday+, +today+). Values are color symbols
+    #     (+:red+, +:green+, +:blue+, +:cyan+, +:magenta+, +:yellow+, +:white+, +:normal+).
+    VisualSettings = Data.define(:show_today, :show_weekday, :show_linear, :colors) do
+      def initialize(show_today: true, show_weekday: false, show_linear: true, colors: {})
+        super
+      end
+    end
+
+    # Immutable value object holding heatmap formatter settings.
+    #
+    # @!attribute [r] start_hour
+    #   @return [Integer] Hour at which the X axis begins. Hours before this value
+    #     are wrapped to +hour + 24+ so the full 24-hour window is
+    #     +[start_hour, start_hour + 24)+.
+    HeatmapSettings = Data.define(:start_hour)
+
+    # Immutable value object holding extract formatter settings.
+    #
+    # @!attribute [r] preamble
+    #   @return [String, nil] Text prepended before extracted output. Supports +{range_begin}+/+{range_end}+.
+    # @!attribute [r] postamble
+    #   @return [String, nil] Text appended after extracted output. Supports +{range_begin}+/+{range_end}+.
+    ExtractSettings = Data.define(:preamble, :postamble)
+
+    # @return [String] Path to the config file in use.
+    attr_reader :config_path
+
+    # @param config_path [String, nil] Override path to config file (mainly for testing).
+    # @param project [String, nil] Override project name (takes precedence over MDLOGBOOK_PROJECT env var).
+    # @raise [Mdlogbook::Error] If the config file does not exist.
+    def initialize(config_path: nil, project: nil)
+      @config_path = config_path || default_config_path
+      @project_override = project
+      @data = load_yaml
+    end
+
+    # Returns the current project name.
+    # Priority: constructor override > MDLOGBOOK_PROJECT env var > default ("mdlogbook").
+    # @return [String]
+    def current_project
+      @project_override || ENV.fetch("MDLOGBOOK_PROJECT", DEFAULT_PROJECT)
+    end
+
+    # Returns all project names defined in the config file.
+    # @return [Array<String>]
+    def projects
+      @data.keys
+    end
+
+    # Returns the tilde-expanded basedir for the given project.
+    # @param project [String]
+    # @return [String]
+    # @raise [Mdlogbook::Error] If the project key is not found in the config.
+    def basedir(project = current_project)
+      path = project_data(project).fetch("path")
+      File.expand_path(path)
+    end
+
+    # Returns target_hours for the given project.
+    # @param project [String]
+    # @return [Numeric]
+    # @raise [Mdlogbook::Error] If the project key is not found in the config.
+    def target_hours(project = current_project)
+      project_data(project)["target_hours"]
+    end
+
+    # Returns the configured default view name, or +nil+ when not set.
+    # @param project [String]
+    # @return [String, nil] One of "simple", "calendar", "line_chart", "grid", or nil.
+    def default_view(project = current_project)
+      project_data(project)["default_view"]
+    end
+
+    # Returns extract formatter settings for the given project.
+    # @param project [String]
+    # @return [ExtractSettings]
+    # @raise [Mdlogbook::Error] If the project key is not found in the config.
+    def extract_settings(project = current_project)
+      ext = project_section(project, "extract")
+      ExtractSettings.new(
+        preamble: ext["preamble"],
+        postamble: ext["postamble"]
+      )
+    end
+
+    VALID_VISUAL_COLORS = %i[red green blue cyan magenta yellow white normal].freeze
+
+    # Returns visual formatter settings for the given project.
+    # @param project [String]
+    # @return [VisualSettings]
+    def visual_settings(project = current_project)
+      vis = DEFAULT_VISUAL_SETTINGS.merge(project_section(project, "visual"))
+      colors = normalized_visual_colors(vis["colors"])
+      VisualSettings.new(
+        show_today: vis["today"],
+        show_weekday: vis["weekday"],
+        show_linear: vis["linear"],
+        colors: colors
+      )
+    end
+
+    # Returns heatmap formatter settings for the given project.
+    # @param project [String]
+    # @return [HeatmapSettings]
+    def heatmap_settings(project = current_project)
+      hm = project_section(project, "heatmap")
+      HeatmapSettings.new(
+        start_hour: hm.fetch("start_hour", DEFAULT_HEATMAP_START_HOUR)
+      )
+    end
+
+    # Returns the editor_args template for the given project, or +nil+ if not set.
+    # @param project [String]
+    # @return [String, nil]
+    # @raise [Mdlogbook::Error] If the project key is not found in the config.
+    def editor_args(project = current_project)
+      project_setting(project, "editor_args")
+    end
+
+    # Returns anonymize formatter settings for the given project.
+    # @param project [String]
+    # @return [AnonymizeSettings]
+    # @raise [Mdlogbook::Error] If the project key is not found in the config.
+    def anonymize_settings(project = current_project)
+      anon = project_section(project, "anonymize")
+      AnonymizeSettings.new(
+        project: project,
+        format: anon.fetch("format", DEFAULT_ANONYMIZE_FORMAT),
+        salt: anon.fetch("salt", ""),
+        passthrough: anon.fetch("passthrough", []),
+        preamble: anon["preamble"],
+        postamble: anon["postamble"]
+      )
+    end
+
+    # Returns the default config file path.
+    #
+    # Priority: +MDLOGBOOK_CONFIG+ env var > +XDG_CONFIG_HOME+/mdlogbook/config.yml.
+    # @return [String]
+    def self.default_config_path
+      if (env_path = ENV["MDLOGBOOK_CONFIG"])
+        return File.expand_path(env_path)
+      end
+
+      xdg_config_home = ENV.fetch("XDG_CONFIG_HOME", "~/.config")
+      File.expand_path(File.join(xdg_config_home, "mdlogbook", "config.yml"))
+    end
+
+    private
+
+    def default_config_path
+      self.class.default_config_path
+    end
+
+    def project_setting(project, key, default = nil)
+      project_data(project).fetch(key, default)
+    end
+
+    def project_section(project, key)
+      project_setting(project, key, {}) || {}
+    end
+
+    def normalized_visual_colors(colors_config)
+      (colors_config || {}).filter_map do |key, val|
+        color = val&.to_sym
+        next unless VALID_VISUAL_COLORS.include?(color)
+
+        [key.to_s, color]
+      end.to_h
+    end
+
+    def project_data(project)
+      @data.fetch(project) do
+        raise Mdlogbook::Error, "project '#{project}' not found in #{@config_path}"
+      end
+    end
+
+    def load_yaml
+      unless File.exist?(@config_path)
+        raise Mdlogbook::Error, "config file not found: #{@config_path}\nRun `mlb --init` to create one."
+      end
+
+      YAML.safe_load_file(@config_path, aliases: true) || {}
+    end
+  end
+end

data/lib/mdlogbook/date_filter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mdlogbook
+  # Filters a {Parser::Result} to only include entries within a given {PeriodSpec}.
+  module DateFilter
+    # Returns a new {Parser::Result} containing only entries whose date falls within +spec+.
+    # @param result [Parser::Result]
+    # @param spec [PeriodSpec]
+    # @return [Parser::Result]
+    def self.filter(result, spec)
+      range = spec.start_date..spec.end_date
+      filtered = Parser::Result.new
+      result.each_date do |date|
+        next unless range.cover?(date)
+
+        result.entries_on(date).each { |entry| filtered.add_entry(date, entry) }
+      end
+      result.warnings.each { |w| filtered.add_warning(w) }
+      filtered
+    end
+  end
+end

data/lib/mdlogbook/editor_launcher.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module Mdlogbook
+  # Builds and runs an editor command for a logbook file.
+  #
+  # The editor is determined by the +VISUAL+ environment variable, falling back
+  # to +EDITOR+. Additional arguments and cursor positioning are controlled by
+  # the +args_template+ parameter (set via +editor_args+ in the config file),
+  # which may contain the following placeholders:
+  #
+  #   {file}   absolute path to the logbook file
+  #   {line}   line number of the target date's heading, or the nearest
+  #            insertion point when the exact date is not found
+  #   {date}   today's date in YYYY-MM-DD format
+  class EditorLauncher
+    # Raised when neither VISUAL nor EDITOR is set.
+    class NoEditorError < Mdlogbook::Error; end
+
+    # @param file [String] Path to the logbook file to open.
+    # @param today [Date] Reference date for {line} and {date} placeholders.
+    # @param args_template [String, nil] Argument template from config (e.g. "+{line} {file}").
+    def initialize(file:, today: Date.today, args_template: nil)
+      @file = file
+      @today = today
+      @args_template = args_template
+    end
+
+    # Builds the command array suitable for +Kernel.exec+ or +system+.
+    # @return [Array<String>]
+    # @raise [NoEditorError] when no editor is configured.
+    def build_command
+      editor = ENV.fetch("VISUAL", nil) || ENV.fetch("EDITOR", nil)
+      raise NoEditorError, "No editor configured. Set VISUAL or EDITOR." unless editor
+
+      return [editor, @file] unless @args_template
+
+      expanded = expand_template(@args_template)
+      [editor] + expanded.shellsplit
+    end
+
+    # Launches the editor and waits for it to finish.
+    # @return [Boolean] true when the editor exited successfully.
+    def launch
+      system(*build_command)
+    end
+
+    private
+
+    def expand_template(template)
+      template
+        .gsub("{file}", @file)
+        .gsub("{date}", @today.strftime("%Y-%m-%d"))
+        .gsub("{line}", find_line_number.to_s)
+    end
+
+    # Finds the best line number for the target date.
+    #
+    # Scans all +# YYYY-MM-DD+ headings in the file and returns:
+    # - the heading line on exact match
+    # - the line just before the next heading when the date falls between two headings
+    # - the last line when the date is after all headings
+    # - 1 when the date is before all headings, or no headings exist
+    #
+    # @return [Integer] 1-based line number
+    def find_line_number
+      lines = File.readlines(@file)
+      return 1 if lines.empty?
+
+      target = @today.strftime("%Y-%m-%d")
+      found_any = false
+
+      lines.each_with_index do |line, idx|
+        stripped = line.chomp
+        next unless stripped.match?(/\A# \d{4}-\d{2}-\d{2}\z/)
+
+        date_str = stripped.delete_prefix("# ")
+        found_any = true
+        return idx + 1 if date_str == target
+        return [idx, 1].max if target < date_str
+      end
+
+      # After all headings → last line; no headings → 1
+      found_any ? lines.length : 1
+    rescue Errno::ENOENT
+      1
+    end
+  end
+end

data/lib/mdlogbook/env.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Mdlogbook
+  # Immutable execution context shared by Runner and future Executor layers.
+  #
+  # Bundles the parsed options, remaining arguments, I/O streams, reference date,
+  # and loaded configuration into a single value object. Constructed by {CLI}
+  # after option parsing and config loading, then passed into {Runner}.
+  #
+  # @!attribute [r] opts
+  #   @return [CLI::Options] Parsed command-line options.
+  # @!attribute [r] argv
+  #   @return [Array<String>] Remaining non-option arguments (period specifiers).
+  # @!attribute [r] stdout
+  #   @return [IO] Standard output stream.
+  # @!attribute [r] stderr
+  #   @return [IO] Standard error stream.
+  # @!attribute [r] today
+  #   @return [Date] Reference date for resolving relative period specifiers.
+  # @!attribute [r] config
+  #   @return [Config] Loaded configuration.
+  Env = Data.define(:opts, :argv, :stdout, :stderr, :today, :config) do
+    # @!group Format query methods
+
+    # @return [Boolean] true when the output format is +:raw+.
+    def raw_format? = opts.format == :raw
+
+    # @return [Boolean] true when the output format is +:grep+.
+    def grep_format? = opts.format == :grep
+
+    # @return [Boolean] true when the output format is +:line_chart+.
+    def line_chart_format? = opts.format == :line_chart
+
+    # @return [Boolean] true when the output format is +:grid+.
+    def grid_format? = opts.format == :grid
+
+    # @return [Boolean] true when the output format is +:heatmap+.
+    def heatmap_format? = opts.format == :heatmap
+
+    # @return [Boolean] true when the output format supports overlap reporting.
+    def overlap_reporting_format? = %i[simple calendar].include?(opts.format)
+
+    # @return [Boolean] true when the output format supports parser warning reporting.
+    def warning_reporting_format? = %i[simple calendar].include?(opts.format)
+
+    # @return [Boolean] true when the output format is +:anonymize+ or +:anonymize_dict+.
+    def anonymize_format? = %i[anonymize anonymize_dict].include?(opts.format)
+
+    # @return [Boolean] true when the output format is +:raw+ or +:grep+.
+    def extract_format? = raw_format? || grep_format?
+
+    # @return [Boolean] true when the output format is +:line_chart+, +:grid+, or +:heatmap+.
+    def visual_format? = line_chart_format? || grid_format? || heatmap_format?
+
+    # @!endgroup
+
+    # Returns anonymize settings from config when an anonymize format is active.
+    # @return [Hash, nil] Anonymize settings hash, or nil for non-anonymize formats.
+    def anonymize_settings = anonymize_format? ? config.anonymize_settings : nil
+
+    # @return [Boolean] true when the +--edit+ flag is set.
+    def edit? = opts.edit
+
+    # @return [Boolean] true when the +--debug+ flag is set.
+    def debug? = opts.debug
+
+    # @return [Boolean] true when stdout is a TTY.
+    def tty? = stdout.respond_to?(:tty?) && stdout.tty?
+
+    # Writes to stdout.
+    # @param args [Array] Arguments forwarded to +IO#puts+.
+    # @return [void]
+    def puts(*args) = stdout.puts(*args)
+
+    # Writes to stderr.
+    # @param args [Array] Arguments forwarded to +IO#puts+.
+    # @return [void]
+    def warn(*args) = stderr.puts(*args)
+
+    # Writes to stderr, highlighted in red when the output is a TTY.
+    #
+    # Use for warnings that indicate a problem the user may need to fix
+    # (e.g. time mismatches, overlapping entries). For informational
+    # messages that require no action, use {#warn} instead.
+    # @param args [Array] Arguments forwarded to +IO#puts+, wrapped in red on TTY.
+    # @return [void]
+    def alert(*args)
+      if tty?
+        args.each { |msg| stderr.puts("\e[31m#{msg}\e[0m") }
+      else
+        stderr.puts(*args)
+      end
+    end
+  end
+end

data/lib/mdlogbook/file_resolver.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mdlogbook
+  # Resolves logbook file paths from config and a year/month pair.
+  #
+  # File paths follow the pattern:
+  #   $path/$project-YYYY-MM.md
+  #
+  # where $path comes from the project config and $project is the
+  # MDLOGBOOK_PROJECT environment variable (default: "mdlogbook").
+  class FileResolver
+    # @return [String] Resolved base directory path (tilde expanded).
+    attr_reader :basedir
+
+    # @return [String] Project name used as the filename prefix.
+    attr_reader :project
+
+    # @param config [Config] Configuration object.
+    # @param basedir [String, nil] Override base directory (takes precedence over config).
+    def initialize(config: Config.new, basedir: nil)
+      @basedir = basedir ? File.expand_path(basedir) : config.basedir
+      @project = config.current_project
+    end
+
+    # Returns the file path for the given year and month.
+    # @param year [Integer]
+    # @param month [Integer]
+    # @return [String]
+    def resolve(year, month)
+      filename = "#{@project}-#{year}-#{month.to_s.rjust(2, "0")}.md"
+      File.join(@basedir, filename)
+    end
+
+    # Returns all (year, month) pairs that have an existing logfile, sorted ascending.
+    # @return [Array<Array(Integer, Integer)>]
+    def list_available_months
+      re = /#{Regexp.escape(@project)}-(\d{4})-(\d{2})\.md\z/
+      Dir.glob(File.join(@basedir, "#{@project}-[0-9][0-9][0-9][0-9]-[0-9][0-9].md"))
+        .filter_map { |path| (m = re.match(path)) && [m[1].to_i, m[2].to_i] }
+        .sort
+    end
+  end
+end

data/lib/mdlogbook/formatter/anonymize.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Mdlogbook
+  module Formatter
+    # Formats logbook entries as anonymized markdown for AI analysis.
+    #
+    # Outputs only date headers, anonymized (or passthrough) job headers,
+    # and time entry lines. All other content is suppressed.
+    class Anonymize < Base
+      include PassthroughHelper
+
+      # Writes anonymized output for the given result.
+      #
+      # Job names are replaced with an 8-character SHA-256 hex prefix unless
+      # they match a passthrough rule. Preamble and postamble templates support
+      # +{range_begin}+ and +{range_end}+ placeholders.
+      #
+      # @param result [Parser::Result]
+      # @param settings [WorkThresholds]
+      # @param io [IO] Output stream (default: $stdout).
+      # @param anonymize_settings [Config::AnonymizeSettings, nil]
+      # @param range_begin [Date, nil] Start of the output period for template substitution.
+      # @param range_end [Date, nil] End of the output period for template substitution.
+      # @return [void]
+      def format_output(result, _settings, io = $stdout, anonymize_settings: nil, range_begin: nil, range_end: nil, **_options)
+        settings = anonymize_settings || Config::AnonymizeSettings.new(project: "", format: "{hash}", salt: "", passthrough: [], preamble: nil, postamble: nil)
+
+        if settings.preamble
+          io.print expand_range(settings.preamble, range_begin, range_end)
+        end
+
+        prev_date = nil
+        result.each_date do |date|
+          io.puts if prev_date
+          io.puts "# #{date}"
+          prev_date = date
+
+          emit_entries(io, result.entries_on(date).sort_by(&:range_str), settings)
+        end
+
+        if settings.postamble
+          io.puts
+          io.print expand_range(settings.postamble, range_begin, range_end)
+        end
+      end
+
+      private
+
+      def emit_entries(io, entries, settings)
+        prev_job = nil
+        entries.each do |entry|
+          if entry.job != prev_job
+            io.puts
+            io.puts "## #{heading_for(entry.job, settings)}"
+            prev_job = entry.job
+          end
+          io.puts "* #{entry.range_str} (#{format("%.2f", entry.time)})"
+        end
+      end
+
+      # Returns the heading text for a job: passthrough value or anonymized hash.
+      # @param job [String]
+      # @param settings [Config::AnonymizeSettings]
+      # @return [String]
+      def heading_for(job, settings)
+        return job if passthrough?(job, settings.passthrough)
+
+        hash = Digest::SHA256.hexdigest("#{settings.project}\0#{settings.salt}\0#{job}")[0, 8]
+        settings.format.gsub("{hash}", hash)
+      end
+    end
+  end
+end

data/lib/mdlogbook/formatter/anonymize_dict.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Mdlogbook
+  module Formatter
+    # Outputs a reverse-lookup dictionary for anonymized job names.
+    #
+    # Each line contains the 8-character SHA-256 hash and the original job name,
+    # separated by a space. Passthrough jobs are excluded. Entries are sorted
+    # by job name.
+    class AnonymizeDict < Base
+      include PassthroughHelper
+
+      # Writes the dictionary to +io+.
+      #
+      # @param result [Parser::Result]
+      # @param settings [WorkThresholds]
+      # @param io [IO] Output stream (default: $stdout).
+      # @param anonymize_settings [Config::AnonymizeSettings, nil]
+      # @return [void]
+      def format_output(result, _work_thresholds, io = $stdout, anonymize_settings: nil, **_options)
+        settings = anonymize_settings || Config::AnonymizeSettings.new(project: "", format: "{hash}", salt: "", passthrough: [], preamble: nil, postamble: nil)
+
+        jobs = result.each_date.flat_map { |date| result.entries_on(date).map(&:job) }.uniq.sort
+
+        jobs.each do |job|
+          next if passthrough?(job, settings.passthrough)
+
+          hash = Digest::SHA256.hexdigest("#{settings.project}\0#{settings.salt}\0#{job}")[0, 8]
+          io.puts "#{hash} #{job}"
+        end
+      end
+    end
+  end
+end