yaks 0.9.0 → 0.10.0

data/find_missing_tests.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'mutant'
+require 'pry'
+
+# These are private methods that are tested by other methods in the same class
+SKIP = %w[
+  Yaks::CollectionMapper#collection_rel
+  Yaks::CollectionMapper#collection_type
+  Yaks::CollectionMapper#mapper_for_model
+  Yaks::Resource::Form::Field#select_options_for_value
+  Yaks::Mapper::AssociationMapper#add_link
+  Yaks::Mapper::AssociationMapper#add_subresource
+  Yaks::Mapper::Link#resource_link_options
+]
+
+args = ["-Ilib", "-ryaks", "--use", "rspec", "Yaks*"]
+env = Mutant::Env::Bootstrap.call(Mutant::CLI.call(args))
+
+integration = env.config.integration
+
+integration.setup
+binding.pry if integration.all_tests.empty?      # rubocop:disable Lint/Debugger
+
+env.subjects.each do |subject|
+  match_expression = subject.match_expressions.first
+  subject_tests = integration.all_tests.select do |test|
+    match_expression.prefix?(test.expression)
+  end
+  unless subject_tests.any? || SKIP.include?(subject.expression.syntax)
+    puts subject.identification
+    exit if ARGV.include?("-1")
+  end
+end

data/lib/yaks.rb

@@ -4,17 +4,15 @@ require 'pathname'
 require 'json'
 require 'csv'
 
-require 'anima'
 require 'concord'
+require 'attribs'
 require 'inflection'
 require 'uri_template'
 require 'rack/accept'
 
 require 'yaks/version'
 require 'yaks/util'
-require 'yaks/attributes'
 require 'yaks/configurable'
-require 'yaks/fp'
 require 'yaks/fp/callable'
 require 'yaks/primitivize'
 require 'yaks/builder'
@@ -24,7 +22,6 @@ require 'yaks/default_policy'
 require 'yaks/serializer'
 require 'yaks/config'
 
-
 module Yaks
   Undefined = Module.new.freeze
 
@@ -34,6 +31,7 @@ module Yaks
   DSL_METHODS = [
     :format_options,
     :rel_template,
+    :mapper_for,
     :before,
     :after,
     :around,
@@ -42,13 +40,13 @@ module Yaks
     :mapper_namespace,
     :serializer,
     :json_serializer,
-    :map_to_primitive,
+    :map_to_primitive
   ]
 
   ConfigBuilder = Builder.new(Yaks::Config) do
-    def_set *Yaks::Config.attributes.names
-    def_forward *DSL_METHODS
-    def_forward *Yaks::DefaultPolicy.public_instance_methods(false)
+    def_set(*Yaks::Config.attributes.names)
+    def_forward(*DSL_METHODS)
+    def_forward(*Yaks::DefaultPolicy.public_instance_methods(false))
   end
 
   class << self
@@ -61,14 +59,12 @@ module Yaks
   end
 end
 
-
 require 'yaks/resource'
 require 'yaks/null_resource'
 require 'yaks/resource/link'
 require 'yaks/collection_resource'
 
 require 'yaks/html5_forms'
-require 'yaks/identifier/link_relation'
 
 require 'yaks/mapper/association'
 require 'yaks/mapper/has_one'
@@ -78,6 +74,7 @@ require 'yaks/mapper/link'
 require 'yaks/mapper/form/field/option'
 require 'yaks/mapper/form/field'
 require 'yaks/mapper/form/fieldset'
+require 'yaks/mapper/form/legend'
 require 'yaks/mapper/form/dynamic_field'
 require 'yaks/mapper/form/config'
 require 'yaks/mapper/form'
@@ -91,6 +88,7 @@ require 'yaks/resource/form'
 require 'yaks/resource/form/field'
 require 'yaks/resource/form/field/option'
 require 'yaks/resource/form/fieldset'
+require 'yaks/resource/form/legend'
 
 require 'yaks/format'
 require 'yaks/format/hal'

data/lib/yaks/breaking_changes.rb

@@ -1,11 +1,10 @@
 module Yaks
-
 # These are displayed in a post-install message when installing the
 # gem to aid upgraiding
 
 BreakingChanges = {
 
-    '0.7.6' => %q~
+  '0.7.6' => %q~
 Breaking Changes in Yaks 0.7.6
 ==============================
 Breaking change: using a symbol instead of link template no longer
@@ -27,7 +26,7 @@ with the attribute name in HTML. An alias is available but will output
 a deprecation warning.
 ~,
 
-    '0.7.0' => %q~
+  '0.7.0' => %q~
 Breaking Changes in Yaks 0.7.0
 ==============================
 Yaks::Resource#subresources is now an array, not a hash. The rel is
@@ -40,7 +39,7 @@ have custom implementations of any of these, or hooks that are not
 specified as ruby blocks, you will need to take this into account
 ~,
 
-    '0.5.0' => %q~
+  '0.5.0' => %q~
 
 Breaking Changes in Yaks 0.5.0
 ==============================
@@ -61,7 +60,7 @@ for full documentation.
 
 ~,
 
-    '0.4.3' => %q~
+  '0.4.3' => %q~
 
 Breaking Changes in Yaks 0.4.3
 ==============================
@@ -81,5 +80,4 @@ documentation.
 
 BreakingChanges['0.4.4'] = BreakingChanges['0.4.3']
 BreakingChanges['0.7.1'] = BreakingChanges['0.7.0']
-
 end

data/lib/yaks/builder.rb

@@ -22,7 +22,7 @@ module Yaks
     def initialize(klass, methods = [], &block)
       @klass = klass
       @methods = methods
-      def_forward *methods if methods.any?
+      def_forward(*methods) if methods.any?
       instance_eval(&block) if block
     end
 

data/lib/yaks/changelog.rb

@@ -1,6 +1,6 @@
 module Yaks
   module Changelog
-    extend self
+    module_function
 
     def current
       versions[Yaks::VERSION]

data/lib/yaks/collection_mapper.rb

@@ -1,6 +1,6 @@
 module Yaks
   class CollectionMapper < Mapper
-    alias collection object
+    alias_method :collection, :object
 
     # @param [Array] collection
     # @return [Array]
@@ -14,9 +14,12 @@ module Yaks
         end
       }
 
-      if context[:mapper_stack].empty?
-        attrs[:rels] = [collection_rel]
-      end
+      # For collections from associations the rel will be based on the
+      # association. At the top level there's no association, so we
+      # use a generic rel. This matters especially for HAL, where a
+      # top-level collection is rendered as an object with the
+      # collection as a subresource.
+      attrs[:rels] = [collection_rel] if context[:mapper_stack].empty?
 
       map_attributes(
         map_links(
@@ -29,7 +32,7 @@ module Yaks
 
     def collection_rel
       if collection_type
-        policy.expand_rel( pluralize( collection_type ) )
+        policy.expand_rel(pluralize(collection_type))
       else
         'collection'
       end

data/lib/yaks/collection_resource.rb

@@ -19,6 +19,5 @@ module Yaks
     def seq
       self
     end
-
   end
 end

data/lib/yaks/config.rb

@@ -2,7 +2,7 @@ module Yaks
   class Config
     extend Yaks::Util::Deprecated
     include Yaks::FP::Callable,
-            Attributes.new(
+            Attribs.new(
               format_options_hash: Hash.new({}),
               default_format: :hal,
               policy_options: {},
@@ -13,12 +13,12 @@ module Yaks
             )
 
     class << self
-      alias create new
+      alias_method :create, :new
     end
 
     deprecated_alias :namespace, :mapper_namespace
 
-    def format_options(format, options = Undefined)
+    def format_options(format, options)
       with(format_options_hash: format_options_hash.merge(format => options))
     end
 
@@ -27,7 +27,7 @@ module Yaks
     end
 
     def json_serializer(&serializer)
-      with(serializer: :json, &serializer)
+      serializer(:json, &serializer)
     end
 
     %w[before after around skip].map(&:intern).each do |hook_type|
@@ -37,11 +37,17 @@ module Yaks
     end
 
     def rel_template(template)
-      with(policy_options: policy_options.merge(:rel_template => template))
+      with(policy_options: policy_options.merge(rel_template: template))
     end
 
     def mapper_namespace(namespace)
-      with(policy_options: policy_options.merge(:namespace => namespace))
+      with(policy_options: policy_options.merge(namespace: namespace))
+    end
+
+    def mapper_for(rule, mapper_class)
+      policy_options[:mapper_rules] ||= {}
+      mapper_rules = policy_options[:mapper_rules].merge(rule => mapper_class)
+      with(policy_options: policy_options.merge(mapper_rules: mapper_rules))
     end
 
     def map_to_primitive(*args, &block)
@@ -80,12 +86,16 @@ module Yaks
     def call(object, options = {})
       runner(object, options).call
     end
-    alias serialize call
+    alias_method :serialize, :call
 
     def map(object, options = {})
       runner(object, options).map
     end
 
+    def format(data, options = {})
+      runner(data, options).format
+    end
+
     def read(data, options = {})
       runner(data, options).read
     end

data/lib/yaks/configurable.rb

@@ -34,12 +34,16 @@ module Yaks
     def def_set(*method_names)
       method_names.each do |method_name|
         define_singleton_method method_name do |arg = Undefined, &block|
-          if arg == Undefined && block
-            self.config = config.update(method_name => block)
-          elsif arg == Undefined
-            raise ArgumentError, "wrong number of arguments (0 for 1)"
+          if arg.equal?(Undefined)
+            unless block
+              raise ArgumentError, "setting #{method_name}: no value and no block given"
+            end
+            self.config = config.with(method_name => block)
           else
-            self.config = config.update(method_name => arg)
+            if block
+              raise ArgumentError, "ambiguous invocation setting #{method_name}: give either a value or a block, not both."
+            end
+            self.config = config.with(method_name => arg)
           end
         end
       end
@@ -50,15 +54,15 @@ module Yaks
     #
     # Either takes a list of methods to forward, or a mapping (hash)
     # of source to destination method name.
-    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)
+    def def_forward(mappings, *names)
+      if mappings.instance_of? Hash
+        mappings.each do |method_name, target|
+          define_singleton_method method_name do |*args, &block|
+            self.config = config.public_send(target, *args, &block)
+          end
         end
+      else
+        def_forward([mappings, *names].map{|name| {name => name}}.inject(:merge))
       end
     end
 
@@ -70,6 +74,7 @@ module Yaks
     # This will generate a `fieldset` method, which will call
     # `Fieldset.create`, and append the result to `config.fields`
     def def_add(name, options)
+      old_verbose, $VERBOSE = $VERBOSE, false # skip method redefinition warning
       define_singleton_method name do |*args, &block|
         defaults = options.fetch(:defaults, {})
         klass    = options.fetch(:create)
@@ -85,7 +90,8 @@ module Yaks
           klass.create(*args, &block)
         )
       end
+    ensure
+      $VERBOSE = old_verbose
     end
-
   end
 end

data/lib/yaks/default_policy.rb

@@ -1,3 +1,4 @@
+
 module Yaks
   class DefaultPolicy
     include Util
@@ -5,7 +6,8 @@ module Yaks
     # Default policy options.
     DEFAULTS = {
       rel_template: "rel:{rel}",
-      namespace: Kernel
+      namespace: Object,
+      mapper_rules: {}
     }
 
     # @!attribute [r]
@@ -17,36 +19,57 @@ module Yaks
       @options = DEFAULTS.merge(options)
     end
 
+    # Main point of entry for mapper derivation. Calls
+    # derive_mapper_from_collection or derive_mapper_from_item
+    # depending on the model.
+    #
     # @param model [Object]
     # @return [Class] A mapper, typically a subclass of Yaks::Mapper
     #
-    # @raise [NameError] only occurs when the model is anything but a collection.
+    # @raise [RuntimeError] occurs when no mapper is found
     def derive_mapper_from_object(model)
-      if model.respond_to? :to_ary
-        if m = model.first
-          name = m.class.name.split('::').last + 'CollectionMapper'
-          begin
-            return @options[:namespace].const_get(name)
-          rescue NameError
-          end
-        end
-        begin
-          return @options[:namespace].const_get(:CollectionMapper)
-        rescue NameError
-        end
-        CollectionMapper
-      else
-        klass = model.class
+      mapper = detect_configured_mapper_for(model)
+      return mapper if mapper
+      return derive_mapper_from_collection(model) if model.respond_to? :to_ary
+      derive_mapper_from_item(model)
+    end
+
+    # Derives a mapper from the given collection.
+    #
+    # @param collection [Object]
+    # @return [Class] A mapper, typically a subclass of Yaks::Mapper
+    def derive_mapper_from_collection(collection)
+      if m = collection.first
+        name = "#{m.class.name.split('::').last}CollectionMapper"
         begin
-          name = klass.name.split('::').last
-          return @options[:namespace].const_get(name + 'Mapper')
-        rescue NameError
-          klass = klass.superclass
-          retry if klass
+          return @options[:namespace].const_get(name)
+        rescue NameError               # rubocop:disable Lint/HandleExceptions
         end
-        name = model.class.name.split('::').last
-        raise "Failed to find a mapper for #{model.inspect}. Did you mean to implement #{name}Mapper?"
       end
+      begin
+        return @options[:namespace].const_get(:CollectionMapper)
+      rescue NameError                 # rubocop:disable Lint/HandleExceptions
+      end
+      CollectionMapper
+    end
+
+    # Derives a mapper from the given item. This item should not
+    # be a collection.
+    #
+    # @param item [Object]
+    # @return [Class] A mapper, typically a subclass of Yaks::Mapper
+    #
+    # @raise [RuntimeError] only occurs when no mapper is found for the given item.
+    def derive_mapper_from_item(item)
+      klass = item.class
+      namespaces = klass.name.split("::")[0...-1]
+      begin
+        return build_mapper_class(namespaces, klass)
+      rescue NameError
+        klass = next_class_for_lookup(item, namespaces, klass)
+        retry if klass
+      end
+      raise_mapper_not_found(item)
     end
 
     # Derive the a mapper type name
@@ -63,9 +86,9 @@ module Yaks
 
     # Derive the mapper type name from a collection
     #
-    # This inspects the first element of the collection, so it
-    # requires a non-empty collection. Will return nil if the
-    # collection is empty.
+    # This inspects the first element of the collection, so
+    # it requires a collection with truthy elements. Will
+    # return `nil` if the collection has no truthy elements.
     #
     # @param [#first] collection
     #
@@ -73,11 +96,8 @@ module Yaks
     #
     # @raise [NameError]
     def derive_type_from_collection(collection)
-      if collection.any?
-        derive_type_from_mapper_class(
-          derive_mapper_from_object(collection.first)
-        )
-      end
+      return if collection.none?
+      derive_type_from_mapper_class(derive_mapper_from_object(collection.first))
     end
 
     def derive_mapper_from_association(association)
@@ -87,7 +107,7 @@ module Yaks
     # @param association [Yaks::Mapper::Association]
     # @return [String]
     def derive_rel_from_association(association)
-      expand_rel( association.name )
+      expand_rel(association.name)
     end
 
     # @param relname [String]
@@ -96,5 +116,34 @@ module Yaks
       URITemplate.new(@options[:rel_template]).expand(rel: relname)
     end
 
+    private
+
+    def build_mapper_class(namespaces, klass)
+      mapper_class = "#{klass.name.split('::').last}Mapper"
+      [*namespaces, mapper_class].inject(@options[:namespace]) do |namespace, module_or_class|
+        namespace.const_get(module_or_class, false)
+      end
+    end
+
+    def next_class_for_lookup(item, namespaces, klass)
+      superclass = klass.superclass
+      return superclass if superclass < Object
+      return nil if namespaces.empty?
+      namespaces.clear
+      item.class
+    end
+
+    def raise_mapper_not_found(item)
+      namespace = "#{@options[:namespace]}::" unless Object.equal?(@options[:namespace])
+      mapper_class = "#{namespace}#{item.class}Mapper"
+      raise "Failed to find a mapper for #{item.inspect}. Did you mean to implement #{mapper_class}?"
+    end
+
+    def detect_configured_mapper_for(object)
+      @options[:mapper_rules].each do |rule, mapper_class|
+        return mapper_class if rule === object # rubocop:disable Style/CaseEquality
+      end
+      nil
+    end
   end
 end