yaks 0.0.0 → 0.1.0

data/lib/yaks/json_api_serializer.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class JsonApiSerializer < Serializer
+    def serialize
+      serialized = Yaks::Hash(
+        pluralize(profile_name.to_s) => resource.map(&method(:serialize_resource))
+      )
+
+      if options[:embed] == :resources
+        linked = resource.reduce(Yaks::Hash()) do |memo, res|
+          serialize_linked_subresources(res.subresources, memo)
+        end
+        serialized = serialized.put('linked', linked)
+      end
+
+      Primitivize.( serialized )
+    end
+    alias to_json_api serialize
+
+    def serialize_resource(resource)
+      result = resource.attributes
+      result = result.merge(Yaks::Hash(:links => serialize_links(resource.subresources))) unless resource.subresources.empty?
+      result
+    end
+
+    def serialize_links(subresources)
+      Yaks::Hash(subresources.map &method(:serialize_link))
+    end
+
+    def serialize_link(name, resource)
+      if options[:embed] == :links
+        [ name, resource.uri ]
+      else
+        [ name, resource.collection? ? resource.map(&curry_symbol(:[], :id)) : resource[:id] ]
+      end
+    end
+
+    def serialize_linked_subresources(subresources, linked)
+      subresources.reduce(linked) do |memo, name, resources|
+        serialize_linked_resources(resources, memo)
+      end
+    end
+
+    def serialize_linked_resources(resources, linked)
+      resources.reduce(linked) do |memo, resource|
+        serialize_subresource(resource, memo)
+      end
+    end
+
+    # {shows => [{id: 3, name: 'foo'}]}
+    def serialize_subresource(resource, linked)
+      key = pluralize(profile_registry.find_by_uri(resource.profile).to_s)
+      set = linked.fetch(key) { Hamster.set }
+      linked = linked.put(key, set << serialize_resource(resource))
+      serialize_linked_subresources(resource.subresources, linked)
+    end
+  end
+end

data/lib/yaks/link_lookup.rb

@@ -0,0 +1,23 @@
+module Yaks
+  module LinkLookup
+
+    def uri
+      self_link = links_by_rel(:self).first
+      self_link.uri if self_link
+    end
+
+    def profile
+      link = links_by_rel(:profile).first
+      link.uri if link
+    end
+
+    def profile_type
+      profile_registry.find_by_uri(profile)
+    end
+
+    def links_by_rel(rel)
+      links.select {|link| link.rel == rel}
+    end
+
+  end
+end

data/lib/yaks/mapper.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Mapper
+    extend ClassMethods, Forwardable
+    include Util, MapLinks, SharedOptions
+
+    def_delegators 'self.class', :config
+    def_delegators :config, :attributes, :links, :associations
+
+    attr_reader :subject, :options
+    private :subject, :options
+    alias object subject
+
+    def initialize(subject, options = {})
+      @subject = subject
+      @options = YAKS_DEFAULT_OPTIONS.merge(options)
+    end
+
+    def to_resource
+      return NullResource.new if subject.nil?
+
+      Resource.new(
+        map_attributes,
+        map_links,
+        map_subresources
+      )
+    end
+
+    def profile_type
+      config.profile || policy.derive_profile_from_mapper(self)
+    end
+
+    def map_attributes
+      filter(attributes).map &juxt(identity_function, method(:load_attribute))
+    end
+
+    def map_subresources
+      filtered = filter(associations.map(&:name))
+      associations.select{|assoc| filtered.include? assoc.name}.map do |association|
+        association.map_to_resource_pair(profile_type, method(:load_association), options)
+      end
+    end
+
+    def load_attribute(name)
+      respond_to?(name) ? send(name) : subject.send(name)
+    end
+    alias load_association load_attribute
+
+    def profile
+      config.profile || policy.derive_missing_profile_from_mapper(self)
+    end
+
+    def filter(attrs)
+      attrs
+    end
+
+  end
+end

data/lib/yaks/mapper/association.rb

@@ -0,0 +1,43 @@
+module Yaks
+  class Mapper
+    class Association
+      include Equalizer.new(:name, :_mapper, :links)
+      include SharedOptions
+
+      attr_reader :name, :key, :links, :options
+      private :links, :options
+
+      def initialize(name, key, mapper, links, options)
+        @name    = name
+        @key     = key
+        @mapper  = mapper
+        @links   = links
+        @options = options
+      end
+
+      def self_link
+        links.detect {|link| link.rel? :self }
+      end
+
+      # @param [Symbol] src_type
+      #   The profile type of the resource that contains the association
+      # @param [Proc] loader
+      #   A lambda that can retrieve an association by its name
+      # @param [Hash] options
+      def map_to_resource_pair(src_type, loader, options)
+        [ options[:rel_registry].lookup(src_type, key), map_resource(loader.(name), options) ]
+      end
+
+      private
+
+      def mapper(opts = nil)
+        return _mapper unless _mapper == Undefined
+        opts[:policy].derive_missing_mapper_for_association(self)
+      end
+
+      def _mapper
+        @mapper
+      end
+    end
+  end
+end

data/lib/yaks/mapper/class_methods.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Mapper
+    module ClassMethods
+      include Forwardable
+      include Util
+
+      CONFIG_METHODS = [
+        :attributes,
+        :link,
+        :profile,
+        # :embed,
+        :has_one,
+        :has_many
+      ]
+
+      def config
+        @config ||= Config.new
+        @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 &σ(method_name, *args)
+        end
+      end
+
+    end
+  end
+end

data/lib/yaks/mapper/config.rb

@@ -0,0 +1,79 @@
+module Yaks
+  class Mapper
+    class Config
+      include Equalizer.new(:attributes)
+
+      def initialize(attributes = Hamster.list, links = Hamster.list, associations = Hamster.list, profile = nil)
+        @attributes   = attributes
+        @links        = links
+        @associations = associations
+        @profile      = profile
+        freeze
+      end
+
+      def new(updates)
+        self.class.new(
+          updates.fetch(:attributes)   { attributes   },
+          updates.fetch(:links)        { links        },
+          updates.fetch(:associations) { associations },
+          updates.fetch(:profile)      { profile      },
+        )
+      end
+
+      def attributes(*attrs)
+        return @attributes if attrs.empty?
+        new(
+          attributes: @attributes + attrs.to_list
+        )
+      end
+
+      def link(rel, template, options = {})
+        new(
+          links: @links.cons(Link.new(rel, template, options))
+        )
+      end
+
+      def profile(type = Undefined)
+        return @profile if type == Undefined
+        new(
+          profile: type
+        )
+      end
+
+      # key
+      # embed_style
+      # rel
+      # (profile)
+
+      def has_one(name, options = {})
+        add_association(HasOne, name, options)
+      end
+
+      def has_many(name, options = {})
+        add_association(HasMany, name, options)
+      end
+
+      def add_association(type, name, options = {})
+        new(
+          associations: @associations.cons(
+            type.new(
+              name,
+              options.fetch(:as)     { name },
+              options.fetch(:mapper) { Undefined },
+              options.fetch(:links)  { Yaks::List() },
+              options.reject         {|k,v| [:as, :mapper, :links].include?(k) }
+            )
+          )
+        )
+      end
+
+      def links
+        @links
+      end
+
+      def associations
+        @associations
+      end
+    end
+  end
+end

data/lib/yaks/mapper/has_many.rb

@@ -0,0 +1,15 @@
+module Yaks
+  class Mapper
+    class HasMany < Association
+      def map_resource(collection, opts)
+        opts = opts.merge(options)
+        collection_mapper(opts).new(collection, mapper(opts), opts).to_resource
+      end
+
+      def collection_mapper(opts)
+        opts = opts.merge(options)
+        opts.fetch(:collection_mapper) { CollectionMapper }
+      end
+    end
+  end
+end

data/lib/yaks/mapper/has_one.rb

@@ -0,0 +1,10 @@
+module Yaks
+  class Mapper
+    class HasOne < Association
+      def map_resource(instance, opts)
+        opts = opts.merge(options)
+        mapper(opts).new(instance, opts).to_resource
+      end
+    end
+  end
+end

data/lib/yaks/mapper/link.rb

@@ -0,0 +1,74 @@
+module Yaks
+  class Mapper
+    class Link
+      include Concord.new(:rel, :template, :options)
+      include Util
+
+      def initialize(rel, template, options = {})
+        @rel, @template, @options = rel, template, options
+      end
+
+      def rel?(rel)
+        self.rel == rel
+      end
+
+      def expand?
+        options.fetch(:expand) {true}
+      end
+
+      def expand_with(callable)
+        return template unless expand?
+        expand(
+          variables.map.with_object({}) do |var, hsh|
+            hsh[var] = callable.(var)
+          end
+        )
+      end
+
+      def map_to_resource_link(mapper)
+        make_resource_link(
+          rel,
+          expand_with(mapper.method(:load_attribute)),
+          resource_link_options(mapper)
+        )
+      end
+
+      def expand(variables)
+        uri_template.expand(variables)
+      end
+
+      def uri_template
+        @uri_template ||= URITemplate.new(template)
+      end
+
+      def variables
+        uri_template.variables
+      end
+
+      # Link properties defined in HAL
+      # href
+      # templated
+      # typed
+      # deprecation
+      # name
+      # profile
+      # title
+      # hreflang
+
+      def resource_link_options(mapper)
+        options = self.options
+        options = options.merge(title: resolve_title(options[:title], mapper)) if options.has_key?(:title)
+        options = options.merge( templated: true ) unless expand?
+        options.reject{|k,v| [:expand].include? k}
+      end
+
+      def resolve_title(title_proc, mapper)
+        Resolve(title_proc, mapper)
+      end
+
+      def make_resource_link(rel, uri, options)
+        Resource::Link.new(rel, uri, options)
+      end
+    end
+  end
+end

data/lib/yaks/mapper/lookup.rb

@@ -0,0 +1,19 @@
+module Yaks
+  class Mapper
+    module Lookup
+
+      def serializer_for(object_or_key)
+        serializer_class_for(object_or_key).new(object_or_key, options)
+      end
+
+      def serializer_class_for(object_or_key)
+        if object_or_key.respond_to?(:to_str) || object_or_key.is_a?(Symbol)
+          serializer_lookup.(Object.const_get(Util.singular(Util.camelize(obj.to_s))))
+        else
+          serializer_lookup.(object_or_key)
+        end
+      end
+
+    end
+  end
+end

data/lib/yaks/mapper/map_links.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Mapper
+    module MapLinks
+
+      def map_links
+        mapped = links.map &send_with_args(:map_to_resource_link, self)
+        unless links.any? {|link| link.rel? :profile }
+          mapped = mapped.cons(Resource::Link.new(:profile, profile_registry.find_by_type(profile_type), {}))
+        end
+        mapped
+      end
+
+    end
+  end
+end