Contents

require 'active_support/time_with_zone'

require 'betterdocs/dsl/representer'
require 'betterdocs/dsl/common'
require 'betterdocs/dsl/naming'
require 'betterdocs/dsl/json_type_mapper'

class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
  extend Tins::DSLAccessor
  include Betterdocs::Dsl::Common
  include Betterdocs::Dsl::Naming

  dsl_accessor :represent_with

  dsl_accessor :description, 'TODO'

  dsl_accessor :example, 'TODO'

  dsl_accessor :types

  dsl_accessor :optional

  dsl_accessor :sanitize do Betterdocs::Global.default_sanitize end

  def initialize(representer, name, options, &block)
    super
    types Betterdocs::Dsl::JsonTypeMapper.map_types(types)
    if sr = sub_representer?
      sr < Betterdocs::ResultRepresenter or
        raise TypeError, "#{sr.inspect} is not a Betterdocs::Result subclass"
    end
  end

  def sub_representer?
    represent_with
  end

  def actual_property_name
    (options[:as] || name).to_s
  end

  def assign(result, object)
    assign?(object) or return
    result[actual_property_name] = compute_value(object)
    self
  end

  def compute_value(object)
    value = object.__send__(name)
    value.nil? and return
    if represent_with
      represent_with.hashify(value)
    elsif value.respond_to?(:iso8601)
      value.extend Betterdocs::JsonTimeWithZone
    else
      sanitizer.sanitize(value)
    end
  end

  def sanitizer
    Betterdocs::Sanitizer.new(&sanitize)
  end

  def add_to_collector(collector)
    collector.properties[name] = self
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
betterdocs-0.12.5	lib/betterdocs/dsl/result/property.rb
betterdocs-0.12.4	lib/betterdocs/dsl/result/property.rb
betterdocs-0.12.3	lib/betterdocs/dsl/result/property.rb
betterdocs-0.12.2	lib/betterdocs/dsl/result/property.rb
betterdocs-0.12.1	lib/betterdocs/dsl/result/property.rb
betterdocs-0.12.0	lib/betterdocs/dsl/result/property.rb
betterdocs-0.11.0	lib/betterdocs/dsl/result/property.rb
betterdocs-0.10.0	lib/betterdocs/dsl/result/property.rb
betterdocs-0.9.2	lib/betterdocs/dsl/result/property.rb
betterdocs-0.9.1	lib/betterdocs/dsl/result/property.rb
betterdocs-0.9.0	lib/betterdocs/dsl/result/property.rb
betterdocs-0.8.1	lib/betterdocs/dsl/result/property.rb