astro-subframe-organizer 0.0.2

data/lib/astro_subframe_organizer.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'astro_subframe_organizer/version'
+require 'astro_subframe_organizer/utils/file_utils'
+require 'astro_subframe_organizer/logging'
+require 'astro_subframe_organizer/utils/exposure_format'
+
+require 'astro_subframe_organizer/commands'
+
+require 'astro_subframe_organizer/config'
+require 'astro_subframe_organizer/equipment/camera'
+require 'astro_subframe_organizer/equipment/filter'
+require 'astro_subframe_organizer/equipment/telescope'
+
+require 'astro_subframe_organizer/filename_parser'
+require 'astro_subframe_organizer/filename_parsers/cr2_filename_parser'
+require 'astro_subframe_organizer/filename_parsers/fits_filename_parser'
+require 'astro_subframe_organizer/filename_parsers/fits_header_parser'
+
+require 'astro_subframe_organizer/path_builders/base_path_builder'
+require 'astro_subframe_organizer/path_builders/bias_path_builder'
+require 'astro_subframe_organizer/path_builders/dark_path_builder'
+require 'astro_subframe_organizer/path_builders/flat_path_builder'
+require 'astro_subframe_organizer/path_builders/light_path_builder'
+require 'astro_subframe_organizer/path_builder'
+
+require 'astro_subframe_organizer/astrophoto'
+require 'astro_subframe_organizer/file_metadata'
+require 'astro_subframe_organizer/file_set'
+
+require 'astro_subframe_organizer/equipment_selector'
+require 'astro_subframe_organizer/organizer'
+require 'astro_subframe_organizer/fits_organizer'
+
+require 'astro_subframe_organizer/utils/thumbnail_cleaner'
+require 'astro_subframe_organizer/utils/empty_directory_cleaner'
+require 'astro_subframe_organizer/utils/unorganizer'
+
+require 'logger'
+require 'fileutils'
+require 'date'
+require 'tty-progressbar'
+require 'tty-prompt'
+require 'yaml'
+
+FILENAME_DT_FORMAT = '%Y%m%d-%H%M%S'
+
+# The main module for the AstroSubframeOrganizer gem, which provides functionality to organize astrophotography
+# FITS and RAW files based on their metadata.
+#
+# This module includes:
+# - Configuration management for user preferences and settings.
+# - Equipment classes representing cameras, filters, and telescopes.
+# - Filename parsers for extracting metadata from FITS headers and RAW filenames.
+# - Path builders that construct folder paths based on image metadata for use with PixInsight's WBPP script.
+# - The main Organizer class that orchestrates the file organization process.
+# - Utility classes for tasks like renaming files based on EXIF data, cleaning thumbnails, and reverting organization.
+#
+# The gem is designed to be used as a command-line tool, but its components can also be used programmatically in
+# other Ruby applications.
+module AstroSubframeOrganizer
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= default_logger
+    end
+
+    def prompt
+      @prompt ||= default_prompt
+    end
+
+    def default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger.formatter = proc do |severity, _datetime, _progname, msg|
+        case severity
+        when 'ERROR', 'FATAL' then "✗ #{msg}\n"
+        when 'WARN'           then "⚠ #{msg}\n"
+        when 'DEBUG'          then "[debug] #{msg}\n"
+        else                       "#{msg}\n" # INFO → plain output
+        end
+      end
+      logger
+    end
+
+    private
+
+    def default_prompt
+      TTY::Prompt.new(
+        active_color: :bright_cyan,
+        help_color: :bright_white,
+        error_color: :bright_red,
+      )
+    end
+  end
+
+  def self.run(dry_run: nil)
+    logger.info "Using config file at #{Config.config_file}" if Config.config_file
+    organizer = FitsOrganizer.new(dry_run: dry_run)
+    organizer.organize
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: astro-subframe-organizer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joshua Kovach
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: exiftool_vendored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.58'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.58'
+- !ruby/object:Gem::Dependency
+  name: fits_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  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'
+description: A command-line tool to sort and rename astrophotography data based on
+  metadata, facilitating use with PixInsight's WeightedBatchPreProcessing.
+email:
+- kovach.jc@gmail.com
+executables:
+- astro-subframe-organizer
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/astro-subframe-organizer
+- lib/astro_subframe_organizer.rb
+- lib/astro_subframe_organizer/astrophoto.rb
+- lib/astro_subframe_organizer/commands.rb
+- lib/astro_subframe_organizer/commands/cleanup/empty_directories.rb
+- lib/astro_subframe_organizer/commands/cleanup/thumbnails.rb
+- lib/astro_subframe_organizer/commands/cleanup/unorganize.rb
+- lib/astro_subframe_organizer/commands/equipment_options.rb
+- lib/astro_subframe_organizer/commands/init.rb
+- lib/astro_subframe_organizer/commands/inspect.rb
+- lib/astro_subframe_organizer/commands/organize/base.rb
+- lib/astro_subframe_organizer/commands/organize/bias.rb
+- lib/astro_subframe_organizer/commands/organize/darks.rb
+- lib/astro_subframe_organizer/commands/organize/flats.rb
+- lib/astro_subframe_organizer/commands/organize/lights.rb
+- lib/astro_subframe_organizer/commands/raw/rename_from_exif.rb
+- lib/astro_subframe_organizer/commands/raw/revert_name.rb
+- lib/astro_subframe_organizer/commands/run.rb
+- lib/astro_subframe_organizer/commands/shared_options.rb
+- lib/astro_subframe_organizer/commands/version.rb
+- lib/astro_subframe_organizer/config.rb
+- lib/astro_subframe_organizer/equipment/camera.rb
+- lib/astro_subframe_organizer/equipment/filter.rb
+- lib/astro_subframe_organizer/equipment/telescope.rb
+- lib/astro_subframe_organizer/equipment_selector.rb
+- lib/astro_subframe_organizer/file_metadata.rb
+- lib/astro_subframe_organizer/file_set.rb
+- lib/astro_subframe_organizer/filename_parser.rb
+- lib/astro_subframe_organizer/filename_parsers/cr2_filename_parser.rb
+- lib/astro_subframe_organizer/filename_parsers/fits_filename_parser.rb
+- lib/astro_subframe_organizer/filename_parsers/fits_header_parser.rb
+- lib/astro_subframe_organizer/fits_organizer.rb
+- lib/astro_subframe_organizer/logging.rb
+- lib/astro_subframe_organizer/organizer.rb
+- lib/astro_subframe_organizer/path_builder.rb
+- lib/astro_subframe_organizer/path_builders/base_path_builder.rb
+- lib/astro_subframe_organizer/path_builders/bias_path_builder.rb
+- lib/astro_subframe_organizer/path_builders/dark_path_builder.rb
+- lib/astro_subframe_organizer/path_builders/flat_path_builder.rb
+- lib/astro_subframe_organizer/path_builders/light_path_builder.rb
+- lib/astro_subframe_organizer/utils/empty_directory_cleaner.rb
+- lib/astro_subframe_organizer/utils/exif_renamer.rb
+- lib/astro_subframe_organizer/utils/exposure_format.rb
+- lib/astro_subframe_organizer/utils/file_utils.rb
+- lib/astro_subframe_organizer/utils/fits_stripper.rb
+- lib/astro_subframe_organizer/utils/raw_stripper.rb
+- lib/astro_subframe_organizer/utils/thumbnail_cleaner.rb
+- lib/astro_subframe_organizer/utils/unorganizer.rb
+- lib/astro_subframe_organizer/version.rb
+homepage: https://github.com/shekibobo/astro-subframe-organizer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/shekibobo/astro-subframe-organizer
+  source_code_uri: https://github.com/shekibobo/astro-subframe-organizer
+  changelog_uri: https://github.com/shekibobo/astro-subframe-organizer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.11
+specification_version: 4
+summary: Organize astrophotography FITS and CR2 files for PixInsight WBPP
+test_files: []