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

data/yaks/lib/yaks.rb

@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'forwardable'
-require 'set'
-require 'pathname'
-
-require 'anima'
-require 'concord'
-require 'inflection'
-require 'uri_template'
-require 'rack/accept'
-
-require 'yaks/util'
-require 'yaks/fp'
-require 'yaks/fp/updatable'
-require 'yaks/fp/hash_updatable'
-require 'yaks/fp/callable'
-require 'yaks/primitivize'
-
-require 'yaks/default_policy'
-
-module Yaks
-  # A PORO
-  Undefined = Object.new
-  # Set the Root constant as the gems root path
-  Root = Pathname(__FILE__).join('../..')
-
-  class << self
-    # @param [Proc] blk
-    # @return [Yaks::Config]
-    def new(&blk)
-      Yaks::Config.new(&blk)
-    end
-  end
-
-end
-
-
-require 'yaks/resource'
-require 'yaks/null_resource'
-require 'yaks/resource/link'
-require 'yaks/collection_resource'
-
-require 'yaks/mapper/class_methods'
-require 'yaks/mapper'
-require 'yaks/mapper/attribute'
-require 'yaks/mapper/link'
-require 'yaks/mapper/association'
-require 'yaks/mapper/association_mapper'
-require 'yaks/mapper/has_one'
-require 'yaks/mapper/has_many'
-require 'yaks/mapper/config'
-require 'yaks/collection_mapper'
-
-require 'yaks/format'
-require 'yaks/format/hal'
-require 'yaks/format/json_api'
-require 'yaks/format/collection_json'
-
-require 'yaks/config/dsl'
-require 'yaks/config'
-require 'yaks/runner'

data/yaks/lib/yaks/breaking_changes.rb

@@ -1,49 +0,0 @@
-module Yaks
-
-# These are displayed in a post-install message when installing the
-# gem to aid upgraiding
-
-BreakingChanges = {
-
-'0.5.0' => %q~
-
-Breaking Changes in Yaks 0.5.0
-==============================
-
-Yaks now serializes its output, you no longer have to convert to JSON
-yourself. Use `skip :serialize' to get the old behavior, or
-`json_serializer` to use a different JSON implementation.
-
-The single `after' hook has been replaced with a set of `before',
-`after', `around' and `skip' hooks.
-
-If you've created your own subclass of `Yaks::Format' (previously:
-`Yaks::Serializer'), then you need to update the call to
-`Format.register'.
-
-These are potentially breaking changes. See the CHANGELOG and README
-for full documentation.
-
-~,
-
-'0.4.3' => %q~
-
-Breaking Changes in Yaks 0.4.3
-==============================
-
-Yaks::Mapper#filter was removed, if you override this method in your
-mappers to conditionally filter attributes or associations, you will
-have to override #attributes or #associations instead.
-
-When specifying a rel_template, now a single {rel} placeholder is
-expected instead of {src} and {dest}.
-
-There are other internal changes. See the CHANGELOG and README for full
-documentation.
-
-~
-}
-
-BreakingChanges['0.4.4'] = BreakingChanges['0.4.3']
-
-end

data/yaks/lib/yaks/collection_mapper.rb

@@ -1,52 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Yaks
-  class CollectionMapper < Mapper
-    alias collection object
-
-    # @param [Array] collection
-    # @return [Array]
-    def call(collection)
-      @object = collection
-
-      attrs = {
-        type: collection_type,
-        members: collection().map do |obj|
-          mapper_for_model(obj).new(context).call(obj)
-        end
-      }
-
-      attrs[ :collection_rel ] = collection_rel
-
-      map_attributes(
-        map_links(
-          CollectionResource.new(attrs)
-        )
-      )
-    end
-
-    private
-
-    def collection_rel
-      if collection_type
-        policy.expand_rel( pluralize( collection_type ) )
-      else
-        'collection'
-      end
-    end
-
-    def collection_type
-      if item_mapper = context[:item_mapper]
-        item_mapper.config.type || policy.derive_type_from_mapper_class(item_mapper)
-      else
-        policy.derive_type_from_collection(collection)
-      end
-    end
-
-    def mapper_for_model(model)
-      context.fetch(:item_mapper) do
-        policy.derive_mapper_from_object(model)
-      end
-    end
-  end
-end

data/yaks/lib/yaks/collection_resource.rb

@@ -1,73 +0,0 @@
-module Yaks
-  # A collection of Resource objects, it has members, and its own set of link
-  # relations like self and profile describing the collection.
-  #
-  # A collection can be the top-level result of an API call, like all posts to
-  # a blog, or a subresource collection, like the comments on a post result.
-  #
-  # Some formats treat everything like a collection, and a single resource as a
-  # collection of one. Others treat every top level response as singular, e.g.
-  # a single "collection of orders". Because of this Resource and
-  # CollectionResource can both be iterated with #each, for the "everything is
-  # a collection crowd", and they both respond to `links`, `attributes` and
-  # `subresources`, so they can both be approached like a singular resource.
-  #
-  # In the second case a collection has a single "subresource", being its
-  # members.
-  class CollectionResource < Resource
-    include Equalizer.new(:type, :links, :attributes, :members, :collection_rel)
-    include FP::HashUpdatable.new(:type, :links, :attributes, :members, :collection_rel)
-    include Enumerable
-
-    extend Forwardable
-
-    # @!attribute [r] type
-    #   @return [String]
-    # @!attribute [r] links
-    #   @return [Array]
-    # @!attribute [r] members
-    #   @return [Array]
-    # @!attribute [r] collection_rel
-    #   @return [String]
-    attr_reader :type, :links, :members, :collection_rel
-
-    def_delegators :members, :each
-
-    # @param [Hash] options
-    # @return [CollectionResource]
-    def initialize(options)
-      super
-      @members     = options.fetch(:members, [])
-      @collection_rel = options.fetch(:collection_rel, 'members')
-    end
-
-    # Make a CollectionResource quack like a resource.
-    #
-    # At the moment this is only for HAL, which always assumes
-    # a singular resource at the top level, this way it can treat
-    # whatever it gets as a single resource with links and subresources,
-    # we just push the collection down one level.
-    #
-    # Once inside subresources the HAL format does check if a resource
-    # is a collection, since there it does make a distinction, and because
-    # in that case it will iterate with each/map rather than calling subresources,
-    # this doesn't cause infinite recursion. Not very pretty, needs looking at.
-    #
-    # :(
-    #
-    # @return [Hash]
-    def subresources
-      if any?
-        { collection_rel => self }
-      else
-        {}
-      end
-    end
-
-    # @return [Boolean]
-    def collection?
-      true
-    end
-
-  end
-end

data/yaks/lib/yaks/config.rb

@@ -1,65 +0,0 @@
-module Yaks
-  class Config
-    include Yaks::FP::Callable
-
-    # @!attribute [r] format_options
-    #   @return [Hash<Symbol,Hash>]
-    attr_reader :format_options
-
-    # @!attribute [rw] default_format
-    #   @return [Symbol]
-    attr_accessor :default_format
-
-    # @!attribute [rw] policy_class
-    #   @return [Class]
-    attr_accessor :policy_class
-
-    # @!attribute [r] policy_options
-    #   @return [Hash]
-    attr_reader :policy_options
-
-    # @!attribute [rw] primitivize
-    #   @return [Primitivize]
-    attr_accessor :primitivize
-
-    # @!attribute [r] serializers
-    #   @return [Hash<Symbol,#call>]
-    attr_reader :serializers
-
-    # @!attribute [r] hooks
-    #   @return [Array]
-    attr_reader :hooks
-
-    # @param blk [Proc] Configuration block
-    def initialize(&blk)
-      @format_options = Hash.new({})
-      @default_format = :hal
-      @policy_options = {}
-      @primitivize    = Primitivize.create
-      @serializers    = {}
-      @hooks          = []
-
-      DSL.new(self, &blk)
-    end
-
-    # @return [Yaks::DefaultPolicy]
-    def policy
-      @policy ||= @policy_class.new(@policy_options)
-    end
-
-    # Main entry point into yaks
-    #
-    # @param object [Object] The object to serialize
-    # @param options [Hash<Symbol,Object>] Serialization options
-    #
-    # @option env [Hash] The rack environment
-    # @option format [Symbol] The target format, default :hal
-    # @option mapper [Class] Mapper class to use
-    # @option item_mapper [Class] Mapper class to use for items in a top-level collection
-    #
-    def call(object, options = {})
-      Runner.new(config: self, object: object, options: options).call
-    end
-    alias serialize call
-  end
-end

data/yaks/lib/yaks/config/dsl.rb

@@ -1,165 +0,0 @@
-module Yaks
-  class Config
-    class DSL
-      # @!attribute [r] config
-      #   @return [Yaks::Config]
-      attr_reader :config
-
-      # @param [Yaks::Config] config
-      # @param [Proc] block
-      def initialize(config, &block)
-        @config       = config
-        @policy_class = Class.new(DefaultPolicy)
-        @policies     = []
-        instance_eval(&block) if block
-        @policies.each do |policy_block|
-          @policy_class.class_eval &policy_block
-        end
-        config.policy_class = @policy_class
-      end
-
-      # Set the options for a format
-      #
-      # @param [Symbol] format
-      # @param [Hash] options
-      #
-      # @example
-      #
-      #   yaks = Yaks.new do
-      #     format_options :hal, {plural_links: [:related_content]}
-      #   end
-      #
-      def format_options(format, options)
-        config.format_options[format] = options
-      end
-
-      # Set the default format
-      #
-      # Defaults to +:hal+
-      #
-      # @param [Symbol] format
-      #   Format identifier, one of +Yaks::Format.names+
-      #
-      # @example
-      #
-      #    yaks = Yaks.new do
-      #      default_fomat :json_api
-      #    end
-      #
-      def default_format(format)
-        config.default_format = format
-      end
-
-      # Configure JSON serializer
-      #
-      # Defaults to JSON.pretty_generate
-      #
-      # @example
-      #
-      #   yaks = Yaks.new do
-      #     json_serializer &Oj.method(:dump)
-      #   end
-      #
-      # @param [Proc] block
-      #   Serialization procedure
-      #
-      def json_serializer(&block)
-        config.serializers[:json] = block
-      end
-
-      %w[before after around skip].map(&:intern).each do |hook_type|
-        define_method hook_type do |step, name = :"#{hook_type}_#{step}", &block|
-          config.hooks << [hook_type, step, name, block]
-        end
-      end
-
-      # Set a different policy implementation
-      #
-      # By default Yaks uses +Yaks::DefaultPolicy+ to derive missing
-      # information. You can swap in a class with a compatible
-      # interface to change the default behavior
-      #
-      # To override a single policy method, simply call a method with
-      # the same name as part of your Yaks configuration, passing a
-      # block to define the new behavior.
-      #
-      # @example
-      #
-      #    yaks = Yaks.new do
-      #      derive_type_from_mapper_class do |mapper_class|
-      #        mapper_class.name.sub(/Mapper^/,'')
-      #      end
-      #    end
-      #
-      # @param [Class] klass
-      #   Policy class
-      #
-      def policy(klass)
-        @policy_class = klass
-      end
-
-      # Set the template for deriving rels
-      #
-      # Used to derive rels for links and subresources.
-      #
-      # @example
-      #
-      #   yaks = Yaks.new do
-      #     rel_template 'http://api.example.com/rels/{rel}'
-      #   end
-      #
-      # @param [String] template
-      #   A valid URI template containing +{rel}+
-      #
-      def rel_template(template)
-        config.policy_options[:rel_template] = template
-      end
-
-      # Set the namespace (Ruby module) that contains your mappers
-      #
-      # When your mappers don't live at the top-level, then set this
-      # so Yaks can correctly infer the mapper class from the model
-      # class.
-      #
-      # @example
-      #
-      #   yaks = Yaks.new do
-      #     mapper_namespace API::Mappers
-      #   end
-      #
-      #   module API::Mappers
-      #     class FruitMapper < Yaks::Mapper
-      #        ...
-      #     end
-      #   end
-      #
-      #   class Fruit < BaseModel
-      #     ...
-      #   end
-      #
-      # @param [Module] namespace
-      #
-      def mapper_namespace(namespace)
-        config.policy_options[:namespace] = namespace
-      end
-      alias namespace mapper_namespace
-
-      # @param [Array] args
-      # @param [Proc] block
-      def map_to_primitive(*args, &block)
-        config.primitivize.map(*args, &block)
-      end
-
-      # Will define each method available in the DefaultPolicy upon the DSL
-      # and then make it available to apply to any Class taking on the
-      # `@policies` Array.
-      DefaultPolicy.public_instance_methods(false).each do |method|
-        define_method method do |&block|
-          @policies << proc {
-            define_method method, &block
-          }
-        end
-      end
-    end
-  end
-end