astro-subframe-organizer 0.0.2

data/exe/astro-subframe-organizer

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'astro_subframe_organizer'
+require 'astro_subframe_organizer/commands'
+
+Dry::CLI.new(AstroSubframeOrganizer::Commands).call

data/lib/astro_subframe_organizer/astrophoto.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module AstroSubframeOrganizer
+  # Class describing the properties of the file that we can determine from the filename generated
+  # by the ASIAir. Depending on your camera and your filter setup, the file structure may be different.
+  # This script was written for use with the ASIAir Plus version 1.9, using a Canon EOS 1500 (T7) DSLR
+  # camera with all the filename metadata turned on. You may have more metadata, or a different order of
+  # metadata depending on which camera setup you have, or if you have an EFW (electronic filter wheel).
+  # In that case, you will need to change the order or add more properties in the initialize method so
+  # that your data is properly parsed. You will also likely want to change your `target_dir` for each
+  # type so that it organizes your data properly.
+  class Astrophoto
+    include Logging
+    extend Forwardable
+
+    def_delegators :file_metadata,
+                   :bin,
+                   :camera,
+                   :ccd_temp,
+                   :created_at,
+                   :dark_flat,
+                   :dark_flat?,
+                   :dark_flat=,
+                   :exposure,
+                   :file_format,
+                   :filename,
+                   :filter,
+                   :flatset_id,
+                   :gain,
+                   :image_index,
+                   :iso,
+                   :maybe_flat_dark?,
+                   :month,
+                   :mosaic_pane,
+                   :path,
+                   :path=,
+                   :rounded_ccd_temp,
+                   :target,
+                   :target=,
+                   :telescope,
+                   :type,
+                   :type=
+
+    TYPES = [
+      DARK = 'Dark',
+      FLAT = 'Flat',
+      LIGHT = 'Light',
+      BIAS = 'Bias',
+    ].freeze
+
+    def initialize(path)
+      @file_parser = FilenameParser.for_file(path)
+    end
+
+    def file_metadata
+      @file_metadata ||= @file_parser.parse
+    end
+
+    def telescope=(value)
+      @target_dir = nil
+      @target_path = nil
+      file_metadata.telescope = value
+    end
+
+    def camera=(value)
+      @target_dir = nil
+      @target_path = nil
+      file_metadata.camera = value
+    end
+
+    def filter=(value)
+      @target_dir = nil
+      @target_path = nil
+      file_metadata.filter = value
+    end
+
+    # The directory structure used to group and categorize the files, which will include useful
+    # grouping keywords for PixInsight's WeightedBatchPreProcessing script.
+    def target_dir
+      @target_dir ||= File.join(current_dir, PathBuilder.build_for(file_metadata))
+    end
+
+    # The full path where this file will be moved.
+    def target_path
+      @target_path ||= File.join(target_dir, filename)
+    end
+
+    # The current directory of the file. If this is different from the target directory,
+    # you will be asked whether you want to move it or not.
+    def current_dir
+      File.dirname(path)
+    end
+
+    # True if the path is already at the target destination. We don't need to move or ask
+    # anything about these files.
+    def already_moved?
+      file_metadata.already_moved?(target_path)
+    end
+
+    # Performs the move. If `is_dry_run` is true, it will not move the files, but will output
+    # the file's current location and target location so you can verify it is correct before
+    # performing the actual move.
+    def move(is_dry_run, bar = nil)
+      destination = target_path
+      dest_dir    = target_dir
+
+      # Logic to create directory
+      FileUtils.mkdir_p(dest_dir) unless is_dry_run || File.exist?(dest_dir)
+
+      if File.exist?(destination)
+        # NOTE: Frequent logging can cause the progress bar to flicker or move
+        msg = "File already exists #{destination}. Skipping..."
+        bar ? bar.log(msg) : logger.warn(msg)
+      else
+        FileUtils.move(path, destination, verbose: is_dry_run, noop: is_dry_run)
+        self.path = destination unless is_dry_run
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/cleanup/empty_directories.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module Cleanup
+      class EmptyDirectories < Dry::CLI::Command
+        include SharedOptions
+
+        desc 'Remove empty directories and subdirectories'
+
+        example [
+          '          # Default, deletes silently',
+          '--verbose # Print the directories that are being deleted',
+          '--dry-run # Print empty directories without deleting them',
+        ]
+
+        def call(dry_run: false, path: Dir.pwd, **options)
+          setup(**options.slice(:config, :verbose, :skip_confirm))
+          AstroSubframeOrganizer::Utils::EmptyDirectoryCleaner.new(path).cleanup(
+            dry_run: dry_run,
+            verbose: options[:verbose],
+          )
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/cleanup/thumbnails.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'astro_subframe_organizer/utils/thumbnail_cleaner'
+
+module AstroSubframeOrganizer
+  module Commands
+    module Cleanup
+      class Thumbnails < Dry::CLI::Command
+        include SharedOptions
+
+        THUMBNAIL_PATTERN = AstroSubframeOrganizer::Utils::ThumbnailCleaner::ASIAIR_THUMBNAIL_PATTERN
+
+        desc "Delete all thumbnail images. Default matches #{THUMBNAIL_PATTERN}."
+
+        example [
+          "                           # Default, matches #{THUMBNAIL_PATTERN}",
+          "--pattern '**/*_thumb.png' # Use a custom pattern to match thumbnails",
+        ]
+
+        option :pattern,
+               type: :string,
+               default: THUMBNAIL_PATTERN,
+               required: false,
+               desc: 'A glob pattern to match thumbnail files.'
+
+        def call(dry_run: false, path: Dir.pwd, pattern: THUMBNAIL_PATTERN, **options)
+          setup(**options.slice(:config, :verbose, :skip_confirm))
+          AstroSubframeOrganizer::Utils::ThumbnailCleaner.new(path).cleanup(
+            pattern: pattern,
+            dry_run: dry_run,
+            verbose: options[:verbose],
+          )
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/cleanup/unorganize.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module Cleanup
+      class Unorganize < Dry::CLI::Command
+        include SharedOptions
+
+        desc 'Move all FITS and CR2 files from subdirectories back into the target directory'
+
+        # rubocop:disable Layout/LineLength
+        example [
+          '# Default, move all .fit and .cr2 files to the current directory and delete empty subdirectories',
+          '--path ~/astrophotography/organized # Move organized files into ~/astrophotography/organized and clean up empty directories',
+        ]
+        # rubocop:enable Layout/LineLength
+
+        def call(config: nil, verbose: false, dry_run: false, path: Dir.pwd, **)
+          setup(config: config, verbose: verbose)
+          AstroSubframeOrganizer::Utils::Unorganizer.new(path).unorganize(dry_run: dry_run, verbose: verbose)
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/equipment_options.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module EquipmentOptions
+      def self.included(base)
+        base.option :telescope, type: :string, required: false, desc: 'Name of telescope used to create subframes'
+        base.option :camera, type: :string, required: false, desc: 'Name of camera used to create subframes'
+        base.option :filter, type: :string, required: false, desc: 'Name of filter used to create subframes'
+      end
+
+      attr_reader :equipment_selector
+
+      # Set the equipment on an equipment selector during organizing. If a value is not provided
+      # via command line option, the organizer will follow default rules for determing equipment
+      # selection:
+      #   - If available in filename or FITS headers, and it matches equipment in Config, auto-selected.
+      #   - If not determined, will prompt the user to select an option from Config equipment.
+      #
+      # Only use this if the command uses equipment selector. Otherwise, use +options+ directly.
+      def set_equipment(telescope: nil, camera: nil, filter: nil)
+        @equipment_selector = EquipmentSelector.new.tap do |eq|
+          eq.telescope = telescope
+          eq.camera = camera
+          eq.filter = filter
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/init.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+module AstroSubframeOrganizer
+  module Commands
+    # Create default config file at ~/astro-subframe-organizer-config.yml
+    class Init < Dry::CLI::Command
+      include SharedOptions
+      include EquipmentOptions
+
+      desc 'Create default config file at ~/astro-subframe-organizer-config.yml'
+      # rubocop:disable Layout/LineLength
+      example [
+        '# Basic usage, creates default file with sample equipment',
+        '--config ~/custom_config.yml # Creates a config file with sample equipment in custom file',
+        '--config ~/galaxy-season.yml --telescope CarbonStar200 --filter BaaderMoon --camera 183MC # Creates a config file with sample equipment in custom file',
+      ]
+      # rubocop:enable Layout/LineLength
+
+      option :force, type: :boolean, default: false, required: false, desc: 'Overwrite existing file'
+
+      def call(force: false, **options)
+        setup(**options.slice(:config, :verbose, :skip_confirm))
+
+        config_file = options[:config] || File.join(Dir.home, 'astro-subframe-organizer-config.yml')
+
+        if File.exist?(config_file) && !force
+          puts "Config file #{config_file} already exists. Use --force to overwrite anyway."
+        else
+          require 'yaml'
+          File.write(config_file, default_config(**options.slice(:telescope, :filter, :camera)).to_yaml)
+
+          if options[:config]
+            puts "Created config file at #{config_file}"
+          else
+            puts 'Created default config file at ~/astro-subframe-organizer-config.yml'
+          end
+        end
+
+        puts 'Edit this file to customize your telescopes, filters, and cameras.'
+      end
+
+      def default_config(telescope: nil, filter: nil, camera: nil)
+        {
+          'telescopes' => telescope ? [telescope] : Config::DEFAULT_CONFIG.fetch('telescopes'),
+          'filters' => filter ? [filter] : Config::DEFAULT_CONFIG.fetch('filters'),
+          'cameras' => camera ? [camera] : Config::DEFAULT_CONFIG.fetch('cameras'),
+          'temperature_tolerance' => 5.0,
+        }
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/inspect.rb

@@ -0,0 +1,101 @@
+# lib/astro_subframe_organizer/commands/inspect.rb
+# frozen_string_literal: true
+
+require 'fits_parser'
+require 'exiftool_vendored'
+
+module AstroSubframeOrganizer
+  module Commands
+    class Inspect < Dry::CLI::Command
+      include Logging
+
+      desc 'Inspect FITS or RAW file headers'
+
+      example [
+        'path/to/file.fit       # inspect FITS headers',
+        'path/to/file.cr2       # inspect CR2 EXIF data',
+        'path/to/file.fit --raw # force EXIF output for a .fit file',
+      ]
+
+      argument :path, required: true, desc: 'Path to the .fit or .cr2 file to inspect'
+
+      option :raw, type: :boolean, default: false, desc: 'Force EXIF output even for .fit files'
+
+      def call(path:, raw: false, **)
+        unless File.exist?(path)
+          logger.error "File not found: #{path}"
+          exit 1
+        end
+
+        ext = File.extname(path).downcase
+
+        if ext == '.fit' && !raw
+          print_fits_headers(path)
+        elsif %w[.cr2 .cr3 .nef .arw .orf .raf].include?(ext) || raw
+          print_exif_data(path)
+        else
+          logger.error "Unsupported file type: #{ext}"
+          exit 1
+        end
+      end
+
+      private
+
+      def print_fits_headers(path)
+        puts "FITS Headers: #{File.basename(path)}"
+        puts '─' * 60
+
+        hdus = FitsParser.new(path).parse_hdus
+        hdu  = hdus.find { |h| h[:header] }
+
+        unless hdu
+          logger.error 'No HDU with headers found.'
+          exit 1
+        end
+
+        hdu[:header].each do |key, value|
+          next if value.nil?
+
+          formatted_key   = key.ljust(10)
+          formatted_value = format_fits_value(value)
+          puts "#{formatted_key}  #{formatted_value.strip}"
+        end
+      end
+
+      def print_exif_data(path)
+        Exiftool.command = 'exiftool.exe' if Gem.win_platform?
+
+        puts "EXIF Data: #{File.basename(path)}"
+        puts '─' * 60
+
+        exif = Exiftool.new(path).to_display_hash
+        exif.compact
+            .sort_by { |k, _| k }
+            .each do |key, value|
+              formatted_key   = key.ljust(30)
+              formatted_value = format_exif_value(value)
+              puts "#{formatted_key}  #{formatted_value.strip}"
+            end
+      end
+
+      def format_fits_value(value)
+        case value
+        when true    then 'T'
+        when false   then 'F'
+        when Float   then format('%-20.10G', value)
+        when String  then value
+        else              value.to_s
+        end
+      end
+
+      def format_exif_value(value)
+        case value
+        when Time, DateTime then value.strftime('%Y-%m-%d %H:%M:%S')
+        when Float          then format('%.6G', value)
+        when Array          then value.join(', ')
+        else                     value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/organize/base.rb

@@ -0,0 +1,43 @@
+# lib/astro_subframe_organizer/commands/organize/base.rb
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module Organize
+      class Base < Dry::CLI::Command
+        include SharedOptions
+        include EquipmentOptions
+
+        def self.inherited(subclass)
+          super
+          # rubocop:disable Layout/LineLength
+          subclass.example [
+            '# Default - interactive menu using default configuration file in the current directory',
+            '--path /Volumes/Sirius/staging/ # organize files under specified directory',
+            '--config ~/galaxy-season-config.yml # interactive menu using specified configuration',
+            '--telescope RedCat51 --camera 183MC --filter BaaderMoon --skip-confirm # organize using the specified equipment, no confirmation prompts',
+            "--telescope 'William Optics RedCat51' --camera 'ZWO ASI183MC Pro' --filter 'Baader Moon & Skyglow' --skip-confirm # equipment with spaces or special characters require quotes",
+          ]
+          # rubocop:enable Layout/LineLength
+        end
+
+        def call(dry_run: false, path: Dir.pwd, **options)
+          setup(**options.slice(:config, :verbose, :skip_confirm))
+          set_equipment(**options.slice(:telescope, :camera, :filter))
+
+          Organizer.new(
+            type: frame_type,
+            path: path,
+            equipment_selector: equipment_selector,
+          ).organize(dry_run: dry_run)
+        end
+
+        private
+
+        def frame_type
+          raise NotImplementedError, "#{self.class} must implement frame_type"
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/organize/bias.rb

@@ -0,0 +1,13 @@
+# lib/astro_subframe_organizer/commands/organize/lights.rb
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module Organize
+      class Bias < Base
+        desc 'Run the subframe organizer for bias subframes'
+        def frame_type = Astrophoto::BIAS
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/organize/darks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module Organize
+      class Darks < Base
+        desc 'Run the subframe organizer for dark subframes'
+        def frame_type = Astrophoto::DARK
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/organize/flats.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+module AstroSubframeOrganizer
+  module Commands
+    module Organize
+      class Flats < Base
+        desc 'Run the subframe organizer for flat subframes'
+        def frame_type = Astrophoto::FLAT
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/organize/lights.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+module AstroSubframeOrganizer
+  module Commands
+    module Organize
+      class Lights < Base
+        desc 'Run the subframe organizer for light subframes'
+        def frame_type = Astrophoto::LIGHT
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/raw/rename_from_exif.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'astro_subframe_organizer/astrophoto'
+
+module AstroSubframeOrganizer
+  module Commands
+    module Raw
+      class RenameFromExif < Dry::CLI::Command
+        include Logging
+        include SharedOptions
+
+        desc 'Rename CR2 files using EXIF metadata. Use on generically named RAW (CR2) files prior to organization.'
+
+        option :type,
+               type: :string,
+               required: true,
+               values: AstroSubframeOrganizer::Astrophoto::TYPES,
+               desc: "Frame type (#{Astrophoto::TYPES.join(', ')})"
+
+        option :target,
+               type: :string,
+               required: false,
+               desc: 'Target name (required for light frames)'
+
+        def call(type:, dry_run: false, path: Dir.pwd, target: nil, **options)
+          setup(**options.slice(:config, :verbose, :skip_confirm))
+
+          if type == Astrophoto::LIGHT && target.nil?
+            logger.error 'A --target is required for light frames.'
+            exit 1
+          end
+
+          renamer = AstroSubframeOrganizer::Utils::ExifRenamer.new(path)
+
+          if renamer.already_named?(renamer.find_cr2_files)
+            logger.warn 'Files appear to already be renamed. Use --force to rename anyway.'
+            exit 0
+          end
+
+          renamer.rename(type: type, target: target, dry_run: dry_run)
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/raw/revert_name.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'astro_subframe_organizer/utils/exif_renamer'
+
+module AstroSubframeOrganizer
+  module Commands
+    module Raw
+      class RevertToRaw < Dry::CLI::Command
+        include SharedOptions
+
+        desc 'Revert previously renamed CR2 files to their original names (IMG_XXXX.CR2)'
+
+        def call(dry_run: false, path: Dir.pwd, **options)
+          setup(**options.slice(:config, :verbose, :skip_confirm))
+
+          renamer = AstroSubframeOrganizer::Utils::ExifRenamer.new(path)
+
+          unless renamer.already_named?(renamer.find_cr2_files)
+            logger.warn 'Files appear to already be renamed. Use --force to rename anyway.'
+            exit 0
+          end
+
+          renamer.revert(dry_run: dry_run)
+        end
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/run.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+module AstroSubframeOrganizer
+  module Commands
+    class Run < Dry::CLI::Command
+      include SharedOptions
+
+      desc 'Run the subframe organizer interactively'
+
+      # rubocop:disable Layout/LineLength
+      example [
+        '                             # Basic usage, using default values or values from default config file at ~/astro-subframe-organizer-config.yml',
+        '--config ~/.custom-setup.yml # Uses alternative setup with specific equipment',
+        '--verbose                    # Log more details while running',
+        '--skip-confirm               # Skip confirmation step before moving files',
+        '--dry-run                    # Run interactively, dry-run only',
+      ]
+      # rubocop:enable Layout/LineLength
+
+      def call(**options)
+        setup(**options.slice(:config, :verbose, :skip_confirm))
+        AstroSubframeOrganizer.run(dry_run: options[:dry_run])
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/shared_options.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AstroSubframeOrganizer
+  module Commands
+    module SharedOptions
+      def self.included(base)
+        base.option :config, desc: 'Use custom config file'
+        base.option :verbose, type: :boolean, default: false, desc: 'Enable verbose output'
+        base.option :path,
+                    type: :string,
+                    default: Dir.pwd,
+                    required: false,
+                    desc: 'The path containing files to be organized'
+        base.option :dry_run,
+                    type: :boolean,
+                    default: false,
+                    required: false,
+                    desc: 'Perform a dry-run showing the changes that would be made'
+        base.option :skip_confirm, type: :boolean, required: false, default: false, desc: 'Skip confirmation prompts'
+      end
+
+      def setup(config: nil, verbose: false, skip_confirm: false)
+        ENV['ASTRO_SUBFRAME_ORGANIZER_CONFIG'] = config
+        ENV['ASTRO_SUBFRAME_SKIP_CONFIRM'] = 'true' if skip_confirm
+        AstroSubframeOrganizer.logger.level = Logger::DEBUG if verbose
+      end
+    end
+  end
+end

data/lib/astro_subframe_organizer/commands/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+
+module AstroSubframeOrganizer
+  module Commands
+    class Version < Dry::CLI::Command
+      desc 'Print version'
+
+      def call(*)
+        puts AstroSubframeOrganizer::VERSION
+      end
+    end
+  end
+end