yaks 0.6.0.alpha.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1363b84d5c4a3fc9a834c05015bd3b1f0a00450b
-  data.tar.gz: 90f37a7f613072a718e95023fe5475481096b724
+  metadata.gz: 79d98824107ec7c700f39b7776dd1ce517f3283b
+  data.tar.gz: 10a45b5d3b2a73054232b63b4b2d70b5dd83c87e
 SHA512:
-  metadata.gz: 81db95d4be9d95499da0205e39085611521fdff084abff9902e2cceb8c9677ef24294d912bc537b4874e52008a9694f76f13478af5fcd959931a153a1f171480
-  data.tar.gz: 73897cc179e778e280ce92197df35084a78e737dee498b9579e6132c8fbdbcff2725dea25ae5394747df8866f2372677c18562c0e21c98f628d32fb72aca33b1
+  metadata.gz: 8766e6b07b209e32f739caaa1e965d88a1615501705f9b8e6f6d857d8d4149816aa34ab846b0e37f9605a2ee5fc5359faed766e92f6550efda42bc5d9b4f3ebb
+  data.tar.gz: a65eb2384e11a8d9379f558afbaadffc67fc72cfa71fdd19812c905de84884d2a91f57366475a4da636ba987052a58c6f6e4986d9feda24226b153ed108fc22a

data/Rakefile

@@ -1,3 +1,49 @@
 load '../rakelib/shared.rake'
 
 gem_tasks(:yaks)
+
+
+task :mutant_chunked do
+  [
+   Yaks::Attributes,
+   Yaks::Attributes::InstanceMethods,
+   Yaks::CollectionMapper,
+   Yaks::CollectionResource,
+   Yaks::Config,
+   Yaks::Config::DSL,
+   Yaks::Configurable,
+   Yaks::Configurable::ClassMethods,
+   Yaks::StatefulBuilder,
+   Yaks::DefaultPolicy,
+   Yaks::FP,
+   Yaks::FP::Callable,
+   Yaks::Format,
+   Yaks::Format::CollectionJson,
+   Yaks::Format::Hal,
+   Yaks::Format::Halo,
+   Yaks::Format::JsonAPI,
+   Yaks::Mapper::AssociationMapper,
+   Yaks::Mapper::Attribute,
+   Yaks::Mapper::Config,
+   Yaks::Mapper::Control,
+   Yaks::Mapper::Control::Field,
+   Yaks::Mapper::HasOne,
+   Yaks::NullResource,
+   Yaks::Primitivize,
+   Yaks::Resource::Link,
+   Yaks::Util,
+   Yaks::Serializer,
+   Yaks::Runner,
+   Yaks::Resource,
+   Yaks::Mapper::Link,
+   Yaks::Mapper::HasMany,
+   Yaks::Mapper::ClassMethods,
+   Yaks::Mapper::Association,
+    Yaks::Mapper,
+#    Yaks::Format::HTML,
+  ].each do |space|
+    puts space
+    ENV['PATTERN'] = "#{space}"
+    Rake::Task["mutant"].execute
+  end
+end

data/lib/yaks/attributes.rb

@@ -0,0 +1,45 @@
+module Yaks
+  class Attributes < Module
+    attr_reader :defaults, :attributes
+
+    def initialize(*attrs)
+      @defaults   = attrs.last.instance_of?(Hash) ? attrs.pop : {}
+      @attributes = attrs + @defaults.keys
+    end
+
+    def add(*attrs)
+      defaults = attrs.last.instance_of?(Hash) ? attrs.pop : {}
+      self.class.new(*[*(attributes+attrs), @defaults.merge(defaults)])
+    end
+
+    def included(descendant)
+      descendant.module_exec(self) do |this|
+        include InstanceMethods,
+                Anima.new(*this.attributes),
+                Anima::Update
+
+        this.attributes.each do |attr|
+          define_method attr do |value = Undefined|
+            if value.equal? Undefined
+              instance_variable_get("@#{attr}")
+            else
+              update(attr => value)
+            end
+          end
+        end
+
+        define_singleton_method(:attributes) { this }
+      end
+    end
+
+    module InstanceMethods
+      def initialize(attributes = {})
+        super(self.class.attributes.defaults.merge(attributes))
+      end
+
+      def append_to(type, *objects)
+        update(type => instance_variable_get("@#{type}") + objects)
+      end
+    end
+  end
+end

data/lib/yaks/collection_resource.rb

@@ -15,55 +15,11 @@ module Yaks
   # 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
+    include attributes.add(members: [], collection_rel: 'members')
 
     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

data/lib/yaks/config/dsl.rb

@@ -50,21 +50,30 @@ module Yaks
         config.default_format = format
       end
 
-      # Configure JSON serializer
+      # Configure serializer for specific output format, e.g. JSON
       #
-      # Defaults to JSON.pretty_generate
+      # This will override the default registered serializer. Note
+      # that extension gems can register their own serializers, see
+      # Yaks::Serializer.register
       #
       # @example
       #
       #   yaks = Yaks.new do
-      #     json_serializer &Oj.method(:dump)
+      #     serializer :json, &Oj.method(:dump)
       #   end
       #
-      # @param [Proc] block
+      # @type [Symbol] type
+      #   Output format
+      # @param [Proc] serializer
       #   Serialization procedure
       #
-      def json_serializer(&block)
-        config.serializers[:json] = block
+      def serializer(type, &serializer)
+        config.serializers[type] = serializer
+      end
+
+      # @deprecated
+      def json_serializer(&serializer)
+        serializer(:json, &serializer)
       end
 
       %w[before after around skip].map(&:intern).each do |hook_type|

data/lib/yaks/config.rb

@@ -36,7 +36,7 @@ module Yaks
       @default_format = :hal
       @policy_options = {}
       @primitivize    = Primitivize.create
-      @serializers    = {}
+      @serializers    = Serializer.all.dup
       @hooks          = []
 
       DSL.new(self, &blk)

data/lib/yaks/configurable.rb

@@ -0,0 +1,20 @@
+module Yaks
+  module Configurable
+    def self.included(descendant)
+      descendant.instance_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def config_method(name, options)
+        define_method name do |*args, &block|
+          append_to(
+            options.fetch(:append_to),
+            options.fetch(:create).create(*args, &block)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yaks/default_policy.rb

@@ -88,13 +88,5 @@ module Yaks
       URITemplate.new(@options[:rel_template]).expand(rel: relname)
     end
 
-    # @param format_class [Class]
-    # @return [#call] format_class
-    def serializer_for_format(format_class)
-      {
-        json: JSON.method(:pretty_generate),
-        html: :to_html.to_proc
-      }.fetch(format_class.serializer)
-    end
   end
 end

data/lib/yaks/errors.rb

@@ -0,0 +1,3 @@
+module Yaks
+  IllegalState = Class.new(StandardError)
+end

data/lib/yaks/format/hal.rb

@@ -33,8 +33,19 @@ module Yaks
         # resource.
         #
         result = resource.attributes
-        result = result.merge(:_links => serialize_links(resource.links)) unless resource.links.empty?
-        result = result.merge(:_embedded => serialize_embedded(resource.subresources)) unless resource.subresources.empty?
+
+        if resource.links.any?
+          result = result.merge(_links: serialize_links(resource.links))
+        end
+
+        if resource.collection?
+          result = result.merge(_embedded:
+                                  serialize_embedded(resource.collection_rel => resource))
+        elsif resource.subresources.any?
+          result = result.merge(_embedded:
+                                  serialize_embedded(resource.subresources))
+        end
+
         result
       end
 

data/lib/yaks/format/halo.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Format
+    # Extension of Hal loosely based on the example by Mike Kelly given at
+    # https://gist.github.com/mikekelly/893552
+    class Halo < Hal
+      register :halo, :json, 'application/halo+json'
+
+      def serialize_resource(resource)
+        if resource.controls.any?
+          super.merge(_controls: serialize_controls(resource.controls))
+        else
+          super
+        end
+      end
+
+      def serialize_controls(controls)
+        controls.each_with_object({}) do |control, result|
+          result[control.name] = serialize_control(control)
+        end
+      end
+
+      def serialize_control(control)
+        control.to_h.merge(fields: control.fields.map(&:to_h))
+      end
+    end
+  end
+end

data/lib/yaks/mapper/association.rb

@@ -1,18 +1,23 @@
 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)
+      include Attributes.new(
+                name:        Undefined,
+                item_mapper: Undefined,
+                rel:         Undefined,
+                href:        Undefined,
+                link_if:     Undefined
+              ),
+              Util
+
+      def self.create(name, options = {})
+        if options.key?(:mapper)
+          options = options.dup
+          mapper  = options.delete(:mapper)
+          options[:item_mapper] = mapper
+        end
+        options[:name] = name
+        new(options)
       end
 
       def add_to_resource(resource, parent_mapper, context)
@@ -34,7 +39,7 @@ module Yaks
 
       # support for HasOne and HasMany
       def resolve_association_mapper(policy)
-        return child_mapper unless child_mapper.equal?(Undefined)
+        return item_mapper unless item_mapper.equal?(Undefined)
         policy.derive_mapper_from_association(self)
       end
 

data/lib/yaks/mapper/association_mapper.rb

@@ -25,7 +25,7 @@ module Yaks
       end
 
       def add_link(resource)
-        Link.new(rel, association.href, {})
+        Link.create(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

data/lib/yaks/mapper/attribute.rb

@@ -1,9 +1,7 @@
 module Yaks
   class Mapper
     class Attribute
-      include Equalizer.new(:name)
-
-      attr_reader :name
+      include Concord::Public.new(:name)
 
       def initialize(name)
         @name = name

data/lib/yaks/mapper/class_methods.rb

@@ -3,9 +3,22 @@
 module Yaks
   class Mapper
     module ClassMethods
-      include Forwardable
-      include Util
-      include FP
+      include Forwardable,
+              Util,
+              FP
+
+      def config(value = Undefined)
+        if value.equal? Undefined
+          @config
+        else
+          raise if value.nil?
+          @config = value
+        end
+      end
+
+      def inherited(child)
+        child.config(config)
+      end
 
       CONFIG_METHODS = [
         :type,
@@ -13,22 +26,17 @@ module Yaks
         :link,
         :profile,
         :has_one,
-        :has_many
+        :has_many,
+        :control
       ]
 
-      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)
+        define_method method_name do |*args, &block|
+          if args.empty?
+            config.public_send(method_name, *args, &block)
+          else
+            config(config.public_send(method_name, *args, &block))
+          end
         end
       end
 

data/lib/yaks/mapper/config.rb

@@ -1,17 +1,10 @@
 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
+      include Attributes.new(
+                type: nil, attributes: [], links: [], associations: [], controls: []
+              ),
+              Configurable
 
       def type(type = Undefined)
         return @type if type.equal?(Undefined)
@@ -20,25 +13,17 @@ module Yaks
 
       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)
+        append_to(:attributes, *attrs.map(&Attribute.method(:new)))
       end
 
+      config_method :link,      create: Link,                    append_to: :links
+      config_method :has_one,   create: HasOne,                  append_to: :associations
+      config_method :has_many,  create: HasMany,                 append_to: :associations
+      config_method :attribute, create: Attribute,               append_to: :attributes
+      config_method :attribute, create: Attribute,               append_to: :attributes
+      config_method :control,
+                    create: StatefulBuilder.new(Control, Control.anima.attribute_names + [:field]),
+                    append_to: :controls
     end
   end
 end

data/lib/yaks/mapper/control.rb

@@ -0,0 +1,38 @@
+module Yaks
+  class Mapper
+    class Control
+      include Attributes.new(
+                name: nil, href: nil, title: nil, method: nil, media_type: nil, fields: []
+              ),
+              Configurable
+
+      def self.create(name = nil, options = {})
+        new({name: name}.merge(options))
+      end
+
+      def add_to_resource(resource, _parent_mapper, _context)
+        resource.add_control(
+          ::Yaks::Resource::Control.new(to_h.merge(fields: fields.map(&:to_resource_control_field)))
+        )
+      end
+
+      class Field
+        include Attributes.new(:name, label: nil, type: "text", value: nil)
+
+        def self.create(*args)
+          attrs = args.last.is_a?(Hash) ? args.pop : {}
+          if name = args.shift
+            attrs = attrs.merge(name: name)
+          end
+          new(attrs)
+        end
+
+        def to_resource_control_field
+          Yaks::Resource::Control::Field.new(to_h)
+        end
+      end
+
+      config_method :field, create: Field, append_to: :fields
+    end
+  end
+end

data/lib/yaks/mapper/has_many.rb

@@ -1,12 +1,8 @@
 module Yaks
   class Mapper
     class HasMany < Association
-      include Util
-
-      def initialize(options)
-        super
-        @collection_mapper = options.fetch(:collection_mapper, Undefined)
-      end
+      include Util,
+              attributes.add(collection_mapper: Undefined)
 
       def map_resource(collection, context)
         return NullResource.new(collection: true) if collection.nil?
@@ -16,9 +12,9 @@ module Yaks
         collection_mapper(collection, policy).new(context).call(collection)
       end
 
-      def collection_mapper(collection, policy)
+      def collection_mapper(collection = nil, policy = nil)
         return @collection_mapper unless @collection_mapper.equal? Undefined
-        policy.derive_mapper_from_object(collection)
+        policy.derive_mapper_from_object(collection) if policy && collection
       end
 
       def singular_name

data/lib/yaks/mapper/link.rb

@@ -25,11 +25,15 @@ module Yaks
     #   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 Attributes.new(:rel, :template, options: {})
       include Util
 
       def_delegators :uri_template, :expand_partial
 
+      def self.create(rel, template, options = {})
+        new(rel: rel, template: template, options: options)
+      end
+
       def add_to_resource(resource, mapper, _context)
         resource_link = map_to_resource_link(mapper)
         return resource unless resource_link
@@ -70,7 +74,11 @@ module Yaks
         uri = expand_with(mapper.method(:load_attribute))
         return if uri.nil?
 
-        Resource::Link.new(rel, uri, resource_link_options(mapper))
+        Resource::Link.new(
+          rel: rel,
+          uri: uri,
+          options: resource_link_options(mapper)
+        )
       end
 
       def expand_with(lookup)

data/lib/yaks/mapper.rb

@@ -6,7 +6,9 @@ module Yaks
     include Util, FP
 
     def_delegators 'self.class', :config
-    def_delegators :config, :attributes, :links, :associations
+    def_delegators :config, :attributes, :links, :associations, :controls
+
+    config Config.new
 
     attr_reader :object, :context
 
@@ -41,7 +43,8 @@ module Yaks
 
       [ :map_attributes,
         :map_links,
-        :map_subresources
+        :map_subresources,
+        :map_controls
       ].inject(Resource.new(type: mapper_name)) do |resource, method|
         send(method, resource)
       end
@@ -71,5 +74,11 @@ module Yaks
         association.add_to_resource(res, self, context)
       end
     end
+
+    def map_controls(resource)
+      controls.inject(resource) do |res, control|
+        control.add_to_resource(res, self, context)
+      end
+    end
   end
 end

data/lib/yaks/resource/control.rb

@@ -0,0 +1,11 @@
+module Yaks
+  class Resource
+    class Control
+      include Yaks::Mapper::Control.attributes
+
+      class Field
+        include Yaks::Mapper::Control::Field.attributes
+      end
+    end
+  end
+end

data/lib/yaks/resource/link.rb

@@ -1,13 +1,7 @@
 module Yaks
   class Resource
     class Link
-      include Equalizer.new(:rel, :uri, :options)
-
-      attr_reader :rel, :uri, :options
-
-      def initialize(rel, uri, options)
-        @rel, @uri, @options = rel, uri, options
-      end
+      include Attributes.new(:rel, :uri, options: {})
 
       def title
         options[:title]

data/lib/yaks/resource.rb

@@ -1,17 +1,9 @@
 module Yaks
   class Resource
-    include Equalizer.new(:type, :links, :attributes, :subresources)
-    include FP::HashUpdatable.new(:type, :links, :attributes, :subresources)
-    include Enumerable
-
-    attr_reader :type, :attributes, :links, :subresources
-
-    def initialize(options = {})
-      @type         = options.fetch(:type, nil)
-      @attributes   = options.fetch(:attributes, {})
-      @links        = options.fetch(:links, [])
-      @subresources = options.fetch(:subresources, {})
-    end
+    include Attributes.new(
+              type: nil, links: [], attributes: {}, subresources: {}, controls: []
+            ),
+            Enumerable
 
     def [](attr)
       attributes[attr]
@@ -41,7 +33,11 @@ module Yaks
     end
 
     def add_link(link)
-      update(links: @links + [link])
+      append_to(:links, link)
+    end
+
+    def add_control(control)
+      append_to(:controls, control)
     end
 
     def add_subresource(rel, subresource)