layer8x/youtube-dl.rb

module YoutubeDL
  # Option and configuration getting, setting, and storage, and all that
  class Options
    # @return [Hash] key value storage object
    attr_accessor :store

    # @return [Array] array of keys that won't be saved to the options store
    attr_accessor :banned_keys

    # Options initializer
    #
    # @param options [Hash] a hash of options
    def initialize(options = {})
      if options.is_a? Hash
        @store = options
      else
        @store = options.to_h
      end

      @banned_keys = []
    end

    # Returns options as a hash
    #
    # @return [Hash] hash of options
    def to_hash
      remove_banned
      @store
    end
    alias_method :to_h, :to_hash

    # Iterate through the paramized keys and values.
    #
    # @yield [paramized_key, value]
    # @return [Object] @store
    #
    # TODO: Enumerable?
    def each_paramized
      @store.each do |key, value|
        yield(paramize(key), value)
      end
    end

    # Iterate through the keys and their paramized counterparts.
    #
    # @yield [key, paramized_key]
    # @return [Object] @store
    def each_paramized_key
      @store.each_key do |key|
        yield(key, paramize(key))
      end
    end

    # Set options using a block
    #
    # @yield [config] self
    def configure
      yield(self) if block_given?
      remove_banned
      self
    end

    # Get option with brackets syntax
    #
    # @param key [Object] key
    # @return [Object] value
    def [](key)
      remove_banned
      return nil if banned? key
      @store[key.to_sym]
    end

    # Set option with brackets syntax
    #
    # @param key [Object] key
    # @param value [Object] value
    # @return [Object] whatever Hash#= returns
    def []=(key, value)
      remove_banned
      return nil if banned? key
      @store[key.to_sym] = value
    end

    # Merge options with given hash, removing banned keys, and returning a
    # new instance of Options.
    #
    # @param hash [Hash] Hash to merge options with
    # @return [YoutubeDL::Options] Merged Options instance
    def with(hash)
      merged = Options.new(@store.merge(hash.to_h))
      merged.banned_keys = @banned_keys
      merged.send(:remove_banned)
      merged
    end

    # Option getting and setting using ghost methods
    #
    # @param method [Symbol] method name
    # @param args [Array] list of arguments passed
    # @param block [Proc] implicit block given
    # @return [Object] the value of method in the options store
    def method_missing(method, *args, &_block)
      remove_banned
      if method.to_s.include? '='
        method = method.to_s.tr('=', '').to_sym
        return nil if banned? method
        @store[method] = args.first
      else
        return nil if banned? method
        @store[method]
      end
    end

    # Calls a block to do operations on keys
    # See sanitize_keys! for examples
    #
    # @param block [Proc] Block with operations on keys
    # @yieldparam key [Object] Original key
    # @yieldreturn [Object] Manipulated key
    def manipulate_keys!(&block)
      @store.keys.each do |old_name|
        new_name = block.call(old_name)
        unless new_name == old_name
          @store[new_name] = @store[old_name]
          @store.delete(old_name)
        end
      end
    end

    # Symbolizes and sanitizes keys in the option store
    #
    # @return [Object] @store
    def sanitize_keys!
      # Symbolize
      manipulate_keys! { |key_name| key_name.is_a?(Symbol) ? key_name : key_name.to_sym }

      # Underscoreize (because Cocaine doesn't like hyphens)
      manipulate_keys! { |key_name| key_name.to_s.tr('-', '_').to_sym }
    end

    # Symbolizes and sanitizes keys and returns a copy of self
    #
    # @return [YoutubeDL::Options] Options with sanitized keys.
    def sanitize_keys
      safe_copy = dup
      safe_copy.sanitize_keys!
      safe_copy
    end

    # Check if key is a banned key
    #
    # @param key [Object] key to check
    # @return [Boolean] true if key is banned, false if not.
    def banned?(key)
      @banned_keys.include? key
    end

  private

    # Helper function to convert option keys into command-line-friendly parameters
    #
    # @param key [Symbol, String] key to paramize
    # @return [String] paramized key
    def paramize(key)
      key.to_s.tr('_', '-')
    end

    # Helper to remove banned keys from store
    def remove_banned
      @store.delete_if { |key, value| banned? key }
    end
  end
end