yaks 0.7.7 → 0.8.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 207388cedc68055dcef4f732bd82ce81180871c8
-  data.tar.gz: 97c121f6e231e8a409d1b2bca7515d75f42d261a
+  metadata.gz: ae9407b2b6c0f2f15c86276063e02ea2d7f9a4f7
+  data.tar.gz: 776d6202349cbf8854506a3d89f06134f2bee12f
 SHA512:
-  metadata.gz: fd61481333faaccde1120268996ab50462dcfd2c04f0b08e9340300ad6567a7bf47d59eae2b36471d9661cb9c020304566df8267c3c19f262a77346b7924504e
-  data.tar.gz: 3acfcdfa41752e295833ca61052fbad706e51bae6132eb7f72350bbfd5db1e0d6fa42d1338059d6fa758396d48d417f2c699a8fcfc40888074afde7189c03dfb
+  metadata.gz: 23ec9ff975f4a4da763720f8ce5d11d8346c1e23f592070e9517dc340605d5221adad9e9a9c64db38158fc88af4b03d21717fc478137dbf4a2f85836a99dd417
+  data.tar.gz: 64f8c4e3078416d4ccffdd572c8eadd0606d5e11c950085f16d5fede07aea162e3338c038284d92c2bbc1974c0a32e98fda97aa4a8d17d1a0d40755c17ba49ad

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/Rakefile

@@ -33,13 +33,13 @@ task :mutant_chunked do
   # Yaks::Attributes::InstanceMethods,
   # Yaks::Configurable,
   # Yaks::NullResource,
+  # Yaks::Runner,
 
   [
     # Yaks::Resource::Form,                   # no explicit coverage
     # Yaks::Resource::Form::Field,            # no explicit coverage
     # Yaks::Mapper::Form::Field::Option,      # no explicit coverage
     # Yaks::Format::HTML,                     # no explicit coverage
-    Yaks::Runner,                           # 56/509  # 89.55%
     Yaks::Resource,                         # 35/206  # 83.01%
     Yaks::StatefulBuilder,                  # 25/192  # 86.98%
     Yaks::Format::Halo,                     # 24/232  # 89.66%

data/lib/yaks/attributes.rb

@@ -12,19 +12,21 @@ module Yaks
       self.class.new(*[*(names+attrs), @defaults.merge(defaults)])
     end
 
+    def remove(*attrs)
+      self.class.new(*[*(names-attrs), @defaults.reject {|k,v| attrs.include?(k) }])
+    end
+
     def included(descendant)
       descendant.module_exec(self) do |this|
         include InstanceMethods,
                 Anima.new(*this.names),
                 Anima::Update
 
+        alias with update
+
         this.names.each do |attr|
-          define_method attr do |value = Undefined|
-            if value.equal? Undefined
-              instance_variable_get("@#{attr}")
-            else
-              update(attr => value)
-            end
+          define_method "with_#{attr}" do |value|
+            with(attr => value)
           end
         end
 
@@ -38,17 +40,21 @@ module Yaks
       end
 
       def append_to(type, *objects)
-        update(type => instance_variable_get("@#{type}") + objects)
+        with(type => instance_variable_get("@#{type}") + objects)
+      end
+
+      def to_h_compact
+        defaults = self.class.attributes.defaults
+        to_h.reject do |attr, value|
+          value.equal?(defaults[attr])
+        end
       end
 
       def pp
         indent = ->(str) { str.lines.map {|l| "  #{l}"}.join }
         format = ->(val) { val.respond_to?(:pp) ? val.pp : val.inspect }
 
-        defaults = self.class.attributes.defaults
-        values   = to_h.reject do |attr, value|
-          value.equal?(defaults[attr])
-        end
+        values   = to_h_compact
 
         fmt_attrs = values.map do |attr, value|
           fmt_val = case value

data/lib/yaks/builder.rb

@@ -0,0 +1,43 @@
+module Yaks
+  # State monad-ish thing.
+  #
+  # Generate a DSL syntax for immutable classes.
+  #
+  # @example
+  #
+  #   # This code
+  #   Form.create(:search)
+  #          .method("POST")
+  #          .action("/search")
+  #
+  #   # Can be written as
+  #   Builder.new(Form, [:method, :action]).create(:search) do
+  #     method "POST"
+  #     action "/search"
+  #   end
+  #
+  class Builder
+    include Configurable
+
+    def create(*args, &block)
+      build(@klass.create(*args), &block)
+    end
+
+    def build(init_state, *extra_args, &block)
+      @config = init_state
+      instance_exec(*extra_args, &block) if block
+      @config
+    end
+
+    def initialize(klass, methods = [], &block)
+      @klass = klass
+      @methods = methods
+      def_forward *methods if methods.any?
+      instance_eval(&block) if block
+    end
+
+    def inspect
+      "#<Builder #{@klass} #{@methods.inspect}>"
+    end
+  end
+end

data/lib/yaks/changelog.rb

@@ -7,8 +7,8 @@ module Yaks
     end
 
     def versions
-      markdown.split(/(?=###\s*[\d\.]+\n)/).each_with_object({}) do |section, hsh|
-        version = section.each_line.first[/[\d\.]+/]
+      markdown.split(/(?=###\s*[\d\w\.]+\n)/).each_with_object({}) do |section, hsh|
+        version = section.each_line.first[/[\d\w\.]+/]
         log     = section.each_line.drop(1).join.strip
         hsh[version] = log
       end

data/lib/yaks/collection_mapper.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 module Yaks
   class CollectionMapper < Mapper
     alias collection object

data/lib/yaks/config.rb

@@ -1,45 +1,61 @@
 module Yaks
   class Config
-    include Yaks::FP::Callable
+    extend Yaks::Util::Deprecated
+    include Yaks::FP::Callable,
+            Attributes.new(
+              format_options_hash: Hash.new({}),
+              default_format: :hal,
+              policy_options: {},
+              policy_class: DefaultPolicy,
+              primitivize: Primitivize.create,
+              serializers: Serializer.all,
+              hooks: []
+            )
 
-    # @!attribute [r] format_options
-    #   @return [Hash<Symbol,Hash>]
-    attr_reader :format_options
+    class << self
+      alias create new
+    end
 
-    # @!attribute [rw] default_format
-    #   @return [Symbol]
-    attr_accessor :default_format
+    deprecated_alias :namespace, :mapper_namespace
 
-    # @!attribute [rw] policy_class
-    #   @return [Class]
-    attr_accessor :policy_class
+    def format_options(format = Undefined, options = Undefined)
+      with(format_options_hash: format_options_hash.merge(format => options))
+    end
 
-    # @!attribute [r] policy_options
-    #   @return [Hash]
-    attr_reader :policy_options
+    def serializer(type, &serializer)
+      with(serializers: serializers.merge(type => serializer))
+    end
 
-    # @!attribute [rw] primitivize
-    #   @return [Primitivize]
-    attr_accessor :primitivize
+    def json_serializer(&serializer)
+      with(serializer: :json, &serializer)
+    end
 
-    # @!attribute [r] serializers
-    #   @return [Hash<Symbol,#call>]
-    attr_reader :serializers
+    %w[before after around skip].map(&:intern).each do |hook_type|
+      define_method hook_type do |step, name = :"#{hook_type}_#{step}", &block|
+        append_to(:hooks, [hook_type, step, name, block])
+      end
+    end
 
-    # @!attribute [r] hooks
-    #   @return [Array]
-    attr_reader :hooks
+    def rel_template(template)
+      with(policy_options: policy_options.merge(:rel_template => template))
+    end
 
-    # @param blk [Proc] Configuration block
-    def initialize(&blk)
-      @format_options = Hash.new({})
-      @default_format = :hal
-      @policy_options = {}
-      @primitivize    = Primitivize.create
-      @serializers    = Serializer.all.dup
-      @hooks          = []
+    def mapper_namespace(namespace)
+      with(policy_options: policy_options.merge(:namespace => namespace))
+    end
+
+    def map_to_primitive(*args, &block)
+      with(primitivize: primitivize.dup.tap { |prim| prim.map(*args, &block) })
+    end
 
-      DSL.new(self, &blk)
+    DefaultPolicy.public_instance_methods(false).each do |method|
+      define_method method do |&block|
+        with(
+          policy_class: Class.new(policy_class) do
+            define_method method, &block
+          end
+        )
+      end
     end
 
     # @return [Yaks::DefaultPolicy]
@@ -67,7 +83,11 @@ module Yaks
     alias serialize call
 
     def map(object, options = {})
-      runner(object, options).map(object)
+      runner(object, options).map
+    end
+
+    def read(data, options = {})
+      runner(data, options).read
     end
   end
 end

data/lib/yaks/configurable.rb

@@ -1,23 +1,52 @@
 module Yaks
   module Configurable
-    def config_method(name, options)
-      define_method name do |*args, &block|
+    attr_accessor :config
+
+    def self.extended(child)
+      child.config = child::Config.new
+    end
+
+    def inherited(child)
+      child.config = config
+    end
+
+    def def_set(*method_names)
+      method_names.each do |method_name|
+        define_singleton_method method_name do |arg|
+          self.config = config.update(method_name => arg)
+        end
+      end
+    end
+
+    def def_forward(method_names, *args)
+      unless method_names.is_a? Hash
+        def_forward([method_names, *args].map{|name| {name => name}}.inject(:merge))
+        return
+      end
+      method_names.each do |method_name, target|
+        define_singleton_method method_name do |*args, &block|
+          self.config = config.public_send(target, *args, &block)
+        end
+      end
+    end
+
+    def def_add(name, options)
+      define_singleton_method name do |*args, &block|
         defaults = options.fetch(:defaults, {})
         klass    = options.fetch(:create)
 
-        instance = if args.length.equal?(1) && args.first.instance_of?(klass)
-                     args.first
-                   else
-                     if args.last.instance_of?(Hash)
-                       args[-1] = defaults.merge(args[-1])
-                     else
-                       args << defaults
-                     end
-                     klass.create(*args, &block)
-                   end
-
-        append_to(options.fetch(:append_to), instance)
+        if args.last.instance_of?(Hash)
+          args[-1] = defaults.merge(args[-1])
+        else
+          args << defaults
+        end
+
+        self.config = config.append_to(
+          options.fetch(:append_to),
+          klass.create(*args, &block)
+        )
       end
     end
+
   end
 end

data/lib/yaks/errors.rb

@@ -2,6 +2,7 @@ module Yaks
   Error = Class.new(StandardError)
 
   IllegalStateError         = Class.new(Error)
+  RuntimeError              = Class.new(Error)
   UnsupportedOperationError = Class.new(Error)
   PrimitivizeError          = Class.new(Error)
 end

data/lib/yaks/format/collection_json.rb

@@ -13,7 +13,8 @@ module Yaks
           items: serialize_items(resource)
         }
         result[:href] = resource.self_link.uri if resource.self_link
-        result[:links] = serialize_links(resource) if resource.collection? && resource.links.any?
+        result[:links] = serialize_links(resource) if links? resource
+        result[:queries] = serialize_queries(resource) if queries? resource
         {collection: result}
       end
 
@@ -40,11 +41,42 @@ module Yaks
       end
 
       def serialize_links(resource)
-        result = []
-        resource.links.each do |link|
-          result << {href: link.uri, rel: link.rel}
+        resource.links.each_with_object([]) do |link, result|
+          result << { href: link.uri, rel: link.rel }
         end
-        result
+      end
+
+      def serialize_queries(resource)
+        resource.forms.each_with_object([]) do |form, result|
+          next unless form_is_query? form
+
+          result << { rel: form.name, href: form.action }
+          result.last[:prompt] = form.title if form.title
+
+          form.fields_flat.each do |field|
+            result.last[:data] = [] unless result.last.key? :data
+            result.last[:data] << { name: field.name, value: nil.to_s }
+            result.last[:data].last[:prompt] = field.label if field.label
+          end
+        end
+      end
+
+      def queries?(resource)
+        resource.forms.any? { |f| form_is_query? f }
+      end
+
+      def links?(resource)
+        resource.collection? && resource.links.any?
+      end
+
+      protected
+
+      def form_is_query?(form)
+        method_is_get?(form.method) && !form.action.nil?
+      end
+
+      def method_is_get?(method)
+        method.downcase.to_sym === :get
       end
     end
   end

data/lib/yaks/format/hal.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 module Yaks
   class Format
     # Hypertext Application Language (http://stateless.co/hal_specification.html)
@@ -23,6 +21,14 @@ module Yaks
     class Hal < self
       register :hal, :json, 'application/hal+json'
 
+      def transitive?
+        true
+      end
+
+      def inverse
+        Yaks::Reader::Hal.new
+      end
+
       protected
 
       # @param [Yaks::Resource] resource

data/lib/yaks/format/halo.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 module Yaks
   class Format
     # Extension of Hal loosely based on the example by Mike Kelly given at
@@ -22,20 +20,29 @@ module Yaks
       end
 
       def serialize_form(form)
-        raw = form.to_h
-        raw[:href]  = raw.delete(:action)
-        raw[:fields] = form.fields.map do |field|
-          field.to_h.each_with_object({}) do |(attr,value), hsh|
-            if attr == :options
+        raw = form.to_h_compact
+        raw[:href]  = raw.delete(:action) if raw[:action]
+        raw[:fields] = form.fields.map(&method(:serialize_form_field))
+        raw
+      end
+
+      def serialize_form_field(field)
+        if field.type == :fieldset
+          {
+            type: :fieldset,
+            fields: field.fields.map(&method(:serialize_form_field))
+          }
+        else
+          field.to_h_compact.each_with_object({}) do |(attr,value), hsh|
+            if attr == :options # <option>s of a <select>
               if !value.empty?
                 hsh[:options] = value.map(&:to_h)
               end
-            elsif HTML5Forms::FIELD_OPTIONS[attr] != value
+            else
               hsh[attr] = value
             end
           end
         end
-        raw
       end
     end
   end

data/lib/yaks/format/json_api.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 module Yaks
   class Format
     class JsonAPI < self
@@ -81,6 +79,27 @@ module Yaks
         linked[key] = (set << serialize_resource(resource))
         serialize_linked_subresources(resource.subresources, linked)
       end
+
+      def inverse
+        JsonApi::Reader.new
+      end
+    end
+
+    class Reader
+      def call(data, env)
+        type = data.detect do |key, value|
+          key unless key == "links"
+        end
+
+        CollectionResource.new(
+          type: type,
+          members: map_to_resource(data[type], )
+        )
+      end
+
+      def inverse
+        JsonApi.new
+      end
     end
   end
 end

data/lib/yaks/format.rb

@@ -1,8 +1,8 @@
 module Yaks
   class Format
     extend Forwardable
-    include Util
-    include FP::Callable
+    include Util,
+            FP::Callable
 
     # @!attribute [r] options
     #   @return [Hash]
@@ -26,7 +26,11 @@ module Yaks
     alias serialize call
 
     class << self
-      attr_reader :format_name, :serializer, :mime_type
+      extend Util::Deprecated
+
+      attr_reader :format_name, :serializer, :media_type
+
+      deprecated_alias :mime_type, :media_type
 
       def all
         @formats ||= []
@@ -34,12 +38,12 @@ module Yaks
 
       # @param [Constant] klass
       # @param [Symbol] format_name
-      # @param [String] mime_type
+      # @param [String] media_type
       # @return [Array]
-      def register(format_name, serializer, mime_type)
+      def register(format_name, serializer, media_type)
         @format_name = format_name
         @serializer = serializer
-        @mime_type = mime_type
+        @media_type = media_type
 
         Format.all << self
       end
@@ -51,30 +55,32 @@ module Yaks
         find(:format_name, format_name)
       end
 
-      # @param [Symbol] mime_type
+      # @param [Symbol] media_type
       # @return [Constant]
       # @raise [KeyError]
-      def by_mime_type(mime_type)
-        find(:mime_type, mime_type)
+      def by_media_type(media_type)
+        find(:media_type, media_type)
       end
+      deprecated_alias :by_mime_type, :by_media_type
 
       def by_accept_header(accept_header)
-        mime_type = Rack::Accept::Charset.new(accept_header).best_of(mime_types.values)
-        if mime_type
-          by_mime_type(mime_type)
+        media_type = Rack::Accept::Charset.new(accept_header).best_of(media_types.values)
+        if media_type
+          by_media_type(media_type)
         else
           yield if block_given?
         end
       end
 
-      def mime_types
+      def media_types
         Format.all.each_with_object({}) do
-          |format, memo| memo[format.format_name] = format.mime_type
+          |format, memo| memo[format.format_name] = format.media_type
         end
       end
+      deprecated_alias :mime_types, :media_types
 
       def names
-        mime_types.keys
+        media_types.keys
       end
 
       private

data/lib/yaks/html5_forms.rb

@@ -30,13 +30,14 @@ module Yaks
 
       :select,
       :textarea,
-      :datalist
+      :datalist,
+      :legend
     ]
 
     FIELD_OPTIONS = {
+      type: nil,
       required: false,
       rows: nil,
-      type: nil,
       value: nil,
       pattern: nil,
       maxlength: nil,

data/lib/yaks/identifier/link_relation.rb

@@ -0,0 +1,17 @@
+module Yaks
+  module Identifier
+    module LinkRelation
+      def self.iana_registry
+        @iana_registry ||= CSV.read(Yaks::Root.join('resources/iana-link-relations.csv'))
+      end
+
+      def self.registered_names
+        @registered_names = iana_registry.drop(1).map(&:first)
+      end
+
+      def self.iana?(name)
+        registered_names.include?(name.to_s)
+      end
+    end
+  end
+end

data/lib/yaks/mapper/attribute.rb

@@ -4,11 +4,11 @@ module Yaks
       include Attributes.new(:name)
 
       def initialize(name)
-        @name = name
+        super(name: name)
       end
 
       def add_to_resource(resource, mapper, _context)
-        resource.update_attributes(name => mapper.load_attribute(name))
+        resource.merge_attributes(name => mapper.load_attribute(name))
       end
     end
   end

data/lib/yaks/mapper/config.rb

@@ -1,27 +1,13 @@
 module Yaks
   class Mapper
     class Config
-      extend Configurable
-
       include Attributes.new(
                 type: nil, attributes: [], links: [], associations: [], forms: []
               )
 
-      def type(type = Undefined)
-        return @type if type.equal?(Undefined)
-        update(type: type)
-      end
-
-      def attributes(*attrs)
-        return @attributes if attrs.empty?
+      def add_attributes(*attrs)
         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 :form,      create: Form,      append_to: :forms
     end
   end
 end

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

@@ -0,0 +1,21 @@
+module Yaks
+  class Mapper
+    class Form
+      class Config
+        include Attributes.new(
+                  name: nil,
+                  action: nil,
+                  title: nil,
+                  method: nil,
+                  media_type: nil,
+                  fields: [],
+                  dynamic_blocks: []
+                )
+
+        def dynamic(&blk)
+          append_to(:dynamic_blocks, blk)
+        end
+      end
+    end
+  end
+end