alsemyonov/als_typograf

# -*- encoding: utf-8 -*-
require 'active_support/core_ext/hash/reverse_merge'
require 'als_typograf/version'

# Ruby client for ArtLebedevStudio.RemoteTypograf web-service
# @author Alexander Semyonov
module AlsTypograf
  autoload :Request, 'als_typograf/request'

  HTML_ENTITIES = 1
  XML_ENTITIES = 2
  NO_ENTITIES = 3
  MIXED_ENTITIES = 4

  DEFAULT_OPTIONS = {
    entity_type: NO_ENTITIES,
    use_br: true,
    use_p: true,
    max_nobr: 3,
    encoding: 'UTF-8',
    debug: false
  }
  VALID_OPTIONS = DEFAULT_OPTIONS.keys.join('|')

  class << self
    attr_accessor :options
  end
  self.options = DEFAULT_OPTIONS.dup

  # Get a global AlsTypograf option
  # @param [String, Symbol] param option name
  def self.[](param)
    options[param.to_sym]
  end

  # Set a global AlsTypograf option
  # @param [String, Symbol] param option name
  # @param [Numeric, String] value value for the option
  def self.[]=(param, value)
    options[param.to_sym] = value
  end

  # Reset default options
  def self.default_options!
    self.options = DEFAULT_OPTIONS.dup
  end

  # Set option #entity_type to HTML (e. g. &nbsp;, &mdash;)
  def self.html_entities!
    self[:entity_type] = HTML_ENTITIES
  end

  # Set option #entity_type to XML (e. g. &#169;, &#155;)
  def self.xml_entities!
    self[:entity_type] = XML_ENTITIES
  end

  # Set option #entity_type to nothing (e. g. —, ©, ×)
  def self.no_entities!
    self[:entity_type] = NO_ENTITIES
  end

  # Set option #entity_type to mixed (e. g. &#169;, &nbsp;)
  def self.mixed_entities!
    self[:entity_type] = MIXED_ENTITIES
  end

  # Option to replace \n with  +<br />+
  # @param [Boolean] value to use +<br />+ or not
  def self.use_br=(value)
    self[:use_br] = value
  end

  # Option to wrap paragraphs with  +<p></p>+
  # @param [Boolean] value to wrap para or not
  def self.use_p=(value)
    self[:use_p] = value
  end

  # How many symbols around dash to surround with +<nobr>+ tag
  # @param [Numeric, Boolean] value symbols count
  def self.max_nobr=(value)
    self[:max_nobr] = value ? value : 0
  end

  def self.debug?
    !!self[:debug]
  end

  def self.method_missing(method_name, *args)
    case method_name.to_s
    when /^(#{VALID_OPTIONS})=$/
      self[Regexp.last_match[1].to_sym] = args.first
    when /^(#{VALID_OPTIONS})$/
      self[method_name.to_sym]
    else
      super
    end
  end

  # Process text with Typograf web-service
  # @param [String] text text to process
  # @param [Hash] custom_options the options to process current text with
  # @option custom_options [String] :entity_type (NO_ENTITIES) Type of entities to use in processed text
  # @option custom_options [String] :use_br (1) Whether or not to use +<br />+
  # @option custom_options [String] :use_p (1) Whether or not to surround paras with +<p></p>+
  # @option custom_options [String] :max_nobr (3) How many symbols around dash to surround with +<nobr>+ tag
  # @option custom_options [String] :encoding ('UTF-8') Encoding of text
  def self.process(text, custom_options = {})
    Request.process_text(text, custom_options.reverse_merge(options))
  end

  # @param [Exception] exception
  def self.log_exception(exception)
    if debug?
      $stderr.puts exception.message
      $stderr.puts exception.backtrace.join("\n")
    end
  end
end

require 'active_model/typograf' if defined?(ActiveModel)