yaks-html 0.6.0.alpha → 0.6.0.alpha.1

data/yaks/lib/yaks/fp/updatable.rb

@@ -1,17 +0,0 @@
-module Yaks
-  module FP
-
-    class Updatable < Module
-      # @param [Array] attributes
-      # @return [Symbol]
-      def initialize(*attributes)
-        define_method :update do |updates|
-          self.class.new(
-            *attributes.map {|attr| updates.fetch(attr) { send(attr) }}
-          )
-        end
-      end
-    end
-
-  end
-end

data/yaks/lib/yaks/mapper.rb

@@ -1,75 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Yaks
-  class Mapper
-    extend ClassMethods, Forwardable
-    include Util, FP
-
-    def_delegators 'self.class', :config
-    def_delegators :config, :attributes, :links, :associations
-
-    attr_reader :object, :context
-
-    def initialize(context)
-      @context = context
-    end
-
-    def policy
-      context.fetch(:policy)
-    end
-
-    def env
-      context.fetch(:env)
-    end
-
-    def mapper_stack
-      context.fetch(:mapper_stack)
-    end
-
-    def self.mapper_name(policy)
-      config.type || policy.derive_type_from_mapper_class(self)
-    end
-
-    def mapper_name
-      self.class.mapper_name(policy)
-    end
-
-    def call(object)
-      @object = object
-
-      return NullResource.new if object.nil?
-
-      [ :map_attributes,
-        :map_links,
-        :map_subresources
-      ].inject(Resource.new(type: mapper_name)) do |resource, method|
-        send(method, resource)
-      end
-    end
-
-    def load_attribute(name)
-      respond_to?(name) ? public_send(name) : object.public_send(name)
-    end
-    alias load_association load_attribute
-
-    private
-
-    def map_attributes(resource)
-      attributes.inject(resource) do |res, attribute|
-        attribute.add_to_resource(res, self, context)
-      end
-    end
-
-    def map_links(resource)
-      links.inject(resource) do |res, mapper_link|
-        mapper_link.add_to_resource(res, self, context)
-      end
-    end
-
-    def map_subresources(resource)
-      associations.inject(resource) do |res, association|
-        association.add_to_resource(res, self, context)
-      end
-    end
-  end
-end

data/yaks/lib/yaks/mapper/association.rb

@@ -1,43 +0,0 @@
-module Yaks
-  class Mapper
-    class Association
-      include Equalizer.new(:name, :child_mapper, :rel, :href, :link_if)
-      include Util
-
-      attr_reader :name, :child_mapper, :rel, :href, :link_if
-
-      def initialize(options)
-        @name          = options.fetch(:name)
-        @child_mapper  = options.fetch(:mapper, Undefined)
-        @rel           = options.fetch(:rel, Undefined)
-
-        @href          = options.fetch(:href, Undefined)
-        @link_if       = options.fetch(:link_if, Undefined)
-      end
-
-      def add_to_resource(resource, parent_mapper, context)
-        AssociationMapper.new(parent_mapper, self, context).call(resource)
-      end
-
-      def render_as_link?(parent_mapper)
-        href != Undefined && link_if != Undefined && Resolve(link_if, parent_mapper)
-      end
-
-      def map_rel(policy)
-        return rel unless rel.equal?(Undefined)
-        policy.derive_rel_from_association(self)
-      end
-
-      # @abstract
-      def map_resource(_object, _context)
-      end
-
-      # support for HasOne and HasMany
-      def resolve_association_mapper(policy)
-        return child_mapper unless child_mapper.equal?(Undefined)
-        policy.derive_mapper_from_association(self)
-      end
-
-    end
-  end
-end

data/yaks/lib/yaks/mapper/association_mapper.rb

@@ -1,42 +0,0 @@
-module Yaks
-  class Mapper
-    class AssociationMapper
-      attr_reader :parent_mapper, :context, :rel, :association
-
-      def initialize(parent_mapper, association, context)
-        @parent_mapper = parent_mapper
-        @association   = association
-        @context       = context.merge(
-          mapper_stack: context[:mapper_stack] + [parent_mapper]
-        )
-        @rel           = association.map_rel(policy)
-      end
-
-      def policy
-        context.fetch(:policy)
-      end
-
-      def call(resource)
-        if association.render_as_link?(parent_mapper)
-          add_link(resource)
-        else
-          add_subresource(resource)
-        end
-      end
-
-      def add_link(resource)
-        Link.new(rel, association.href, {})
-          .add_to_resource(resource, parent_mapper, nil)
-        # Yaks::Mapper::Link doesn't do anything with the context, making it
-        # hard to test that we pass it a context. Passing nil for now, until
-        # this is actually needed and can be tested.
-      end
-
-      def add_subresource(resource)
-        object      = parent_mapper.load_association(association.name)
-        subresource = association.map_resource(object, context)
-        resource.add_subresource(rel, subresource)
-      end
-    end
-  end
-end

data/yaks/lib/yaks/mapper/attribute.rb

@@ -1,17 +0,0 @@
-module Yaks
-  class Mapper
-    class Attribute
-      include Equalizer.new(:name)
-
-      attr_reader :name
-
-      def initialize(name)
-        @name = name
-      end
-
-      def add_to_resource(resource, mapper, _context)
-        resource.update_attributes(name => mapper.load_attribute(name))
-      end
-    end
-  end
-end

data/yaks/lib/yaks/mapper/class_methods.rb

@@ -1,37 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Yaks
-  class Mapper
-    module ClassMethods
-      include Forwardable
-      include Util
-      include FP
-
-      CONFIG_METHODS = [
-        :type,
-        :attributes,
-        :link,
-        :profile,
-        :has_one,
-        :has_many
-      ]
-
-      def config
-        @config ||= Config.new nil, [], [], []
-        @config = yield(@config) if block_given?
-        @config
-      end
-
-      def inherited(child)
-        child.config { @config }
-      end
-
-      CONFIG_METHODS.each do |method_name|
-        define_method method_name do |*args|
-          config &send_with_args(method_name, *args)
-        end
-      end
-
-    end
-  end
-end

data/yaks/lib/yaks/mapper/config.rb

@@ -1,44 +0,0 @@
-module Yaks
-  class Mapper
-    class Config
-      include Equalizer.new(:type, :attributes, :links, :associations)
-      include FP::Updatable.new(:type, :attributes, :links, :associations)
-
-      attr_reader :links, :associations
-
-      def initialize(type, attributes, links, associations)
-        @type         = type
-        @attributes   = attributes
-        @links        = links
-        @associations = associations
-      end
-
-      def type(type = Undefined)
-        return @type if type.equal?(Undefined)
-        update(type: type)
-      end
-
-      def attributes(*attrs)
-        return @attributes if attrs.empty?
-        update(attributes: @attributes + attrs.map(&Attribute.method(:new)))
-      end
-
-      def link(rel, template, options = {})
-        update(links: @links + [Link.new(rel, template, options)])
-      end
-
-      def add_association(type, name, options)
-        update(associations: @associations + [type.new(options.merge(name: name))])
-      end
-
-      def has_one(name, options = {})
-        add_association(HasOne, name, options)
-      end
-
-      def has_many(name, options = {})
-        add_association(HasMany, name, options)
-      end
-
-    end
-  end
-end

data/yaks/lib/yaks/mapper/has_many.rb

@@ -1,29 +0,0 @@
-module Yaks
-  class Mapper
-    class HasMany < Association
-      include Util
-
-      def initialize(options)
-        super
-        @collection_mapper = options.fetch(:collection_mapper, Undefined)
-      end
-
-      def map_resource(collection, context)
-        return NullResource.new(collection: true) if collection.nil?
-        policy      = context.fetch(:policy)
-        item_mapper = resolve_association_mapper(policy)
-        context     = context.merge(item_mapper: item_mapper)
-        collection_mapper(collection, policy).new(context).call(collection)
-      end
-
-      def collection_mapper(collection, policy)
-        return @collection_mapper unless @collection_mapper.equal? Undefined
-        policy.derive_mapper_from_object(collection)
-      end
-
-      def singular_name
-        singularize(name.to_s)
-      end
-    end
-  end
-end

data/yaks/lib/yaks/mapper/has_one.rb

@@ -1,15 +0,0 @@
-module Yaks
-  class Mapper
-    class HasOne < Association
-      def map_resource(object, context)
-        resolve_association_mapper(context.fetch(:policy))
-          .new(context)
-          .call(object)
-      end
-
-      def singular_name
-        name.to_s
-      end
-    end
-  end
-end

data/yaks/lib/yaks/mapper/link.rb

@@ -1,91 +0,0 @@
-module Yaks
-  class Mapper
-    # A Yaks::Mapper::Link is part of a mapper's configuration. It captures
-    # what is set through the mapper's class level `#link` function, and is
-    # capable of generating a `Yaks::Resource::Link` for a given mapper
-    # instance (and hence subject).
-    #
-    # @example
-    #   link :self, 'http://api.foo.org/users/{id}', title: ->{ "User #{object.name}" }
-    #   link :profile, 'http://apidocs.foo.org/profiles/users'
-    #   link 'http://apidocs.foo.org/rels/friends', 'http://api.foo.org/users/{id}/friends?page={page}', expand: [:id]
-    #
-    # It takes a relationship identifier, a URI template and an options hash.
-    #
-    # @param rel [Symbol|String] Either a registered relationship type (Symbol)
-    #   or a relationship URI. See [RFC5988 Web Linking](http://tools.ietf.org/html/rfc5988)
-    # @param template [String] A [RFC6570](http://tools.ietf.org/html/rfc6570) URI template
-    # @param template [Symbol] A method name that generates the link. No more expansion is done afterwards
-    # @option expand [Boolean] pass false to pass on the URI template in the response,
-    #   instead of expanding the variables
-    # @option expand [Array[Symbol]] pass a list of variable names to only expand those,
-    #   and return a partially expanded URI template in the response
-    # @option title [String] Give the link a title
-    # @option title [#to_proc] Block that returns the title. If it takes an argument,
-    #   it will receive the mapper instance as argument. Otherwise it is evaluated in the mapper context
-    class Link
-      extend Forwardable
-      include Concord.new(:rel, :template, :options)
-      include Util
-
-      def_delegators :uri_template, :expand_partial
-
-      def add_to_resource(resource, mapper, _context)
-        resource_link = map_to_resource_link(mapper)
-        return resource unless resource_link
-        resource.add_link(resource_link)
-      end
-
-      def rel?(rel)
-        rel().eql? rel
-      end
-
-      # A link is templated if it does not expand, or only partially
-      def templated?
-        !options.fetch(:expand) { true }.equal? true
-      end
-
-      def template_variables
-        case options.fetch(:expand) { true }
-        when true
-          uri_template.variables
-        when false
-          []
-        else
-          options[:expand]
-        end.map(&:to_sym)
-      end
-
-      def expansion_mapping(lookup)
-        template_variables.each_with_object({}) do |name, hsh|
-          hsh[name] = lookup[name]
-        end
-      end
-
-      def uri_template
-        URITemplate.new(template)
-      end
-
-      def map_to_resource_link(mapper)
-        uri = expand_with(mapper.method(:load_attribute))
-        return if uri.nil?
-
-        Resource::Link.new(rel, uri, resource_link_options(mapper))
-      end
-
-      def expand_with(lookup)
-        return lookup[template] if template.instance_of? Symbol
-
-        expand_partial(expansion_mapping(lookup)).to_s
-      end
-
-      def resource_link_options(mapper)
-        options = options()
-        options = options.merge(title: Resolve(options[:title], mapper)) if options.key?(:title)
-        options = options.merge(templated: true) if templated?
-        options.reject{|key| key.equal? :expand }
-      end
-
-    end
-  end
-end

data/yaks/lib/yaks/null_resource.rb

@@ -1,40 +0,0 @@
-module Yaks
-  class NullResource
-    include Equalizer.new(:collection?)
-    include Enumerable
-
-    def initialize(opts = {})
-      @collection = opts.fetch(:collection) { false }
-    end
-
-    def each
-      to_enum
-    end
-
-    def attributes
-      {}
-    end
-
-    def links
-      []
-    end
-
-    def subresources
-      {}
-    end
-
-    def [](*)
-    end
-
-    def type
-    end
-
-    def collection?
-      @collection
-    end
-
-    def null_resource?
-      true
-    end
-  end
-end