yaks 0.9.0 → 0.10.0

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

@@ -2,7 +2,7 @@ module Yaks
   class Mapper
     class Form
       class DynamicField
-        include Attributes.new(:block)
+        include Attribs.new(:block)
 
         def self.create(_opts = nil, &block)
           new(block: block)

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

@@ -2,16 +2,21 @@ module Yaks
   class Mapper
     class Form
       class Field
-        include Attributes.new(
+        include Attribs.new(
                   :name,
                   label: nil,
                   options: [].freeze,
                   if: nil
                 ).add(HTML5Forms::FIELD_OPTIONS)
 
-        Builder = Builder.new(self) do
+        Builder = Yaks::Builder.new(self) do
           def_set :name, :label
           def_add :option, create: Option, append_to: :options
+
+          def condition(blk1 = nil, &blk2)
+            @config = @config.with(if: blk1 || blk2)
+          end
+
           HTML5Forms::FIELD_OPTIONS.each do |option, _|
             def_set option
           end
@@ -28,9 +33,9 @@ module Yaks
         # Convert to a Resource::Form::Field, expanding any dynamic
         # values
         def to_resource_fields(mapper)
-          return [] if self.if && !mapper.expand_value(self.if)
+          return [] unless self.if.nil? || mapper.expand_value(self.if)
           [ Resource::Form::Field.new(
-              (resource_attributes - [:if]).each_with_object({}) do |attr, attrs|
+              resource_attributes.each_with_object({}) do |attr, attrs|
                 attrs[attr] = mapper.expand_value(public_send(attr))
               end.merge(options: resource_options(mapper))) ]
         end
@@ -38,15 +43,19 @@ module Yaks
         def resource_options(mapper)
           # make sure all empty options arrays are the same instance,
           # makes for prettier #pp
-          options.empty? ? options : options.map {|opt| opt.to_resource_field_option(mapper) }.compact
+          if options.empty?
+            options
+          else
+            options.map {|opt| opt.to_resource_field_option(mapper) }.compact
+          end
         end
 
         # All attributes that can be converted 1-to-1 to
         # Resource::Form::Field
         def resource_attributes
-          self.class.attributes.names - [:options]
+          self.class.attributes.names - [:options, :if]
         end
-      end #Field
+      end # Field
     end # Form
   end # Mapper
 end # Yaks

data/lib/yaks/mapper/form/field/option.rb

@@ -4,19 +4,20 @@ module Yaks
       class Field
         # <option>, as used in a <select>
         class Option
-          include Attributes.new(:value, :label, selected: false, disabled: false, if: nil)
+          include Attribs.new(:value, :label, selected: false, disabled: false, if: nil)
 
-          def self.create(value, opts = {})
+          def self.create(value, opts)
             new(opts.merge(value: value))
           end
 
           def to_resource_field_option(mapper)
-            return if self.if && !mapper.expand_value(self.if)
+            return unless self.if.nil? || mapper.expand_value(self.if)
+
             Resource::Form::Field::Option.new(
               value: mapper.expand_value(value),
               label: mapper.expand_value(label),
               selected: mapper.expand_value(selected),
-              disabled: mapper.expand_value(disabled),
+              disabled: mapper.expand_value(disabled)
             )
           end
         end

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

@@ -3,7 +3,7 @@ module Yaks
     class Form
       class Fieldset
         extend Forwardable
-        include Attributes.new(:config)
+        include Attribs.new(:config)
 
         def_delegators :config, :fields
 

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

@@ -0,0 +1,18 @@
+module Yaks
+  class Mapper
+    class Form
+      class Legend
+        include Attribs.new(:type, :label, if: nil)
+
+        def self.create(label, opts = {})
+          new(opts.merge(type: :legend, label: label))
+        end
+
+        def to_resource_fields(mapper)
+          return [] unless self.if.nil? || mapper.expand_value(self.if)
+          [ Resource::Form::Legend.new(label: mapper.expand_value(label)) ]
+        end
+      end
+    end
+  end
+end

data/lib/yaks/mapper/has_many.rb

@@ -12,6 +12,7 @@ module Yaks
         collection_mapper(collection, policy).new(context).call(collection)
       end
 
+      undef collection_mapper
       def collection_mapper(collection = nil, policy = nil)
         return @collection_mapper unless @collection_mapper.equal? Undefined
         policy.derive_mapper_from_object(collection) if policy && collection

data/lib/yaks/mapper/link.rb

@@ -25,15 +25,17 @@ module Yaks
     #   it will receive the mapper instance as argument. Otherwise it is evaluated in the mapper context
     class Link
       extend Forwardable, Util
-      include Attributes.new(:rel, :template, options: {}), Util
+      include Attribs.new(:rel, :template, options: {}), Util
 
       def self.create(*args)
         args, options = extract_options(args)
-        new(rel: args[0], template: args[1], options: options)
+        new(rel: args.first, template: args.last, options: options)
       end
 
       def add_to_resource(resource, mapper, _context)
-        return resource.with(links: resource.links.reject {|link| link.rel?(rel)}) if options[:remove]
+        if options[:remove]
+          return resource.with(links: resource.links.reject {|link| link.rel?(rel)})
+        end
 
         resource_link = map_to_resource_link(mapper)
         return resource unless resource_link
@@ -67,13 +69,14 @@ module Yaks
         )
       end
 
+      private
+
       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| [:expand, :replace, :if].include? key }
       end
-
     end
   end
 end

data/lib/yaks/null_resource.rb

@@ -4,10 +4,10 @@ module Yaks
             Equalizer.new(:rels, :collection)
 
     def initialize(opts = {})
-      _opts = {}
-      _opts[:rels]       = opts[:rels]       if opts.key?(:rels)
-      _opts[:collection] = opts[:collection] if opts.key?(:collection)
-      super(_opts)
+      local_opts = {}
+      local_opts[:rels]       = opts[:rels]       if opts.key?(:rels)
+      local_opts[:collection] = opts[:collection] if opts.key?(:collection)
+      super(local_opts)
     end
 
     def each
@@ -18,7 +18,6 @@ module Yaks
       @collection
     end
 
-
     def null_resource?
       true
     end

data/lib/yaks/pipeline.rb

@@ -28,12 +28,12 @@ module Yaks
     end
 
     def transitive?
-      steps.all? {|name, step| step.respond_to?(:transitive?) && step.transitive?}
+      steps.all? {|_name, step| step.respond_to?(:transitive?) && step.transitive?}
     end
 
     def inverse
       unless transitive?
-        raise RuntimeError, "Unable to get inverse pipeline, not all pipeline steps are transitive."
+        raise "Unable to get inverse pipeline, not all pipeline steps are transitive."
       end
 
       self.class.new(steps.map {|name, step| [name, step.inverse]}.reverse)

data/lib/yaks/primitivize.rb

@@ -8,14 +8,15 @@ module Yaks
 
     def call(object)
       mappings.each do |pattern, block|
+        # rubocop:disable Style/CaseEquality
         return instance_exec(object, &block) if pattern === object
       end
       raise PrimitivizeError, "don't know how to turn #{object.class} (#{object.inspect}) into a primitive"
     end
 
-    def map(*types, &blk)
+    def map(*types, &block)
       types.each do |type|
-        mappings[type] = blk
+        @mappings = mappings.merge(type => block)
       end
     end
 

data/lib/yaks/reader/hal.rb

@@ -1,8 +1,9 @@
 module Yaks
   module Reader
     class Hal
+      include Util
 
-      def call(parsed_json, env = {})
+      def call(parsed_json, _env = {})
         attributes = parsed_json.dup
         links      = convert_links(attributes.delete('_links') || {})
         embedded   = convert_embedded(attributes.delete('_embedded') || {})
@@ -21,22 +22,20 @@ module Yaks
       end
 
       def convert_links(links)
-        Set[*
-            links.flat_map do |rel, link|
-              array(link).map do |l|
-                options = Util.symbolize_keys(Util.slice_hash(l, 'title', 'templated'))
-                rel = rel.to_sym if Yaks::Identifier::LinkRelation.iana?(rel)
-                Resource::Link.new(rel: rel, uri: l['href'], options: options)
-              end
-            end
-           ]
+        links.flat_map do |rel, link|
+          array(link).map do |l|
+            options = symbolize_keys(slice_hash(l, 'title', 'templated'))
+            # if it looks like a keyword we'll assume it's a registered rel type
+            rel = rel.to_sym if rel =~ /\A\w+\z/
+            Resource::Link.new(rel: rel, uri: l['href'], options: options)
+          end
+        end
       end
 
       def array(x)
         x.instance_of?(Array) ? x : [x]
       end
 
-
       def convert_embedded(embedded)
         embedded.flat_map do |rel, resource|
           case resource
@@ -48,7 +47,8 @@ module Yaks
             else
               CollectionResource.new(
                 members: resource.map { |r|
-                  call(r).with(type: Util.singularize(rel[/\w+$/])) }
+                  call(r).with(type: Util.singularize(rel[/\w+$/]))
+                }
               )
             end
           else
@@ -56,7 +56,6 @@ module Yaks
           end.with(rels: [rel])
         end
       end
-
     end
   end
 end

data/lib/yaks/reader/json_api.rb

@@ -1,49 +1,66 @@
 module Yaks
   module Reader
     class JsonAPI
-      def call(parsed_json, env = {})
-        attributes = parsed_json['data'].first.dup
-        links = attributes.delete('links') || {}
-        linked = parsed_json['linked'].nil? ? {} : parsed_json['linked'].dup
-        embedded   = convert_embedded(links, linked)
-        Resource.new(
-            type: Util.singularize(attributes.delete('type')[/\w+$/]),
+      def call(parsed_json, _env = {})
+        included = parsed_json['included'].nil? ? {} : parsed_json['included'].dup
+
+        if parsed_json['data'].is_a?(Array)
+          CollectionResource.new(
+            attributes: parsed_json['meta'].nil? ? nil : {meta: parsed_json['meta']},
+            members: parsed_json['data'].map { |data| call('data'  => data, 'included' => included) }
+          )
+        else
+          attributes = parsed_json['data'].dup
+          links = attributes.delete('links') || {}
+          type  = attributes.delete('type')
+          attributes.merge!(attributes.delete('attributes') || {})
+
+          association_links, resource_links = links.partition { |_k, v| v.is_a?(Hash) }
+          embedded   = convert_embedded(Hash[association_links], included)
+          links      = convert_links(Hash[resource_links])
+
+          Resource.new(
+            type: Util.singularize(type),
             attributes: Util.symbolize_keys(attributes),
             subresources: embedded,
-            links: []
-        )
+            links: links
+          )
+        end
       end
 
-      def convert_embedded(links, linked)
+      def convert_embedded(links, included)
         links.flat_map do |rel, link_data|
-          # If this is a compound link, the link_data will contain either
-          # * 'type' and 'id' for a one to one
-          # * 'type' and 'ids' for a homogeneous to-many relationship
-          # * 'data' being an array where each member has 'type' and 'id' for heterogeneous
-          if !link_data['type'].nil? && !link_data['id'].nil?
-            resource = linked.find{ |item| (item['id'] == link_data['id']) && (item['type'] == link_data['type']) }
-            call({'data'  => [resource], 'linked' => linked}).with(rels: [rel])
-          elsif !link_data['type'].nil? && !link_data['ids'].nil?
-            resources = linked.select{ |item| (link_data['ids'].include? item['id']) && (item['type'] == link_data['type']) }
-            members = resources.map { |r|
-              call({'data'  => [r], 'linked' => linked})
-            }
+          # A Link doesn't have to contain a `linkage` member.
+          # It can contain URLs instead, or as well, but we are only worried about *embedded* links here.
+          linkage = link_data['linkage']
+          # Resource linkage MUST be represented as one of the following:
+          #
+          # * `null` for empty to-one relationships.
+          # * a "linkage object" for non-empty to-one relationships.
+          # * an empty array ([]) for empty to-many relationships.
+          # * an array of linkage objects for non-empty to-many relationships.
+          if linkage.nil?
+            nil
+          elsif linkage.is_a? Array
             CollectionResource.new(
-                members: members,
-                type: link_data['type'],
-                rels: [rel]
-            )
-          elsif link_data['data'].present?
-            CollectionResource.new(
-                members: link_data['data'].map { |link|
-                  resource = linked.find{ |item| (item['id'] == link['id']) && (item['type'] == link['type']) }
-                  call({'data'  => [resource], 'linked' => linked})
-                },
-                rels: [rel]
+              members: linkage.map { |link|
+                data = included.find{ |item| (item['id'] == link['id']) && (item['type'] == link['type']) }
+                call('data'  => data, 'included' => included)
+              },
+              rels: [rel]
             )
+          else
+            data = included.find{ |item| (item['id'] == linkage['id']) && (item['type'] == linkage['type']) }
+            call('data'  => data, 'included' => included).with(rels: [rel])
           end
         end.compact
       end
+
+      def convert_links(links)
+        links.map do |rel, link|
+          Resource::Link.new(rel: rel.to_sym, uri: link)
+        end
+      end
     end
   end
 end

data/lib/yaks/resource.rb

@@ -1,6 +1,6 @@
 module Yaks
   class Resource
-    include Attributes.new(
+    include Attribs.new(
               type: nil,
               rels: [],
               links: [],
@@ -46,7 +46,7 @@ module Yaks
     def collection?
       false
     end
-    alias collection collection?
+    alias_method :collection, :collection?
 
     def with_collection(*)
       self
@@ -59,10 +59,10 @@ module Yaks
     def members
       raise UnsupportedOperationError, "Only Yaks::CollectionResource has members"
     end
-    alias each members
-    alias map members
-    alias each_with_object members
-    alias with_members members
+    alias_method :each, :members
+    alias_method :map, :members
+    alias_method :each_with_object, :members
+    alias_method :with_members, :members
 
     def merge_attributes(new_attrs)
       with(attributes: @attributes.merge(new_attrs))
@@ -84,6 +84,5 @@ module Yaks
     def add_subresource(subresource)
       append_to(:subresources, subresource)
     end
-
   end
 end

data/lib/yaks/resource/form.rb

@@ -14,21 +14,11 @@ module Yaks
         end
       end
 
-      def fields_flat(fs = fields)
-        fs.each_with_object([]) do |field, acc|
-          if field.type.equal? :fieldset
-            acc.concat(fields_flat field.fields)
-          else
-            acc << field
-          end
-        end
-      end
-
       def method?(meth)
-        !method.nil? && method.downcase.to_sym === meth.downcase.to_sym
+        !method.nil? && method.downcase.to_sym == meth.downcase.to_sym
       end
 
-      def has_action?
+      def has_action?                      # rubocop:disable Style/PredicateName
         !action.nil?
       end
     end