yaks 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eb709b078f05c15a877f6c3008df313d09e2bbe
-  data.tar.gz: cd8d14498bbf3c74b2362b66c30dee5ec00d3c53
+  metadata.gz: 207388cedc68055dcef4f732bd82ce81180871c8
+  data.tar.gz: 97c121f6e231e8a409d1b2bca7515d75f42d261a
 SHA512:
-  metadata.gz: 4cc2b5d05868b2869684481a6a9a37d513b66da63dfe995307b1c2c933ab349bf0bf200f5342e60ef485f756046e2308854227f895ec1b302ed4ec0b91f1d6c8
-  data.tar.gz: cde85afd3d63e33420ebe61e24638f1d00ceb26f93db91f48f19f42f7de531d4cd84e17dc7e74586a95afd5369d22293b4431f2208073a2ac48d84788bb67526
+  metadata.gz: fd61481333faaccde1120268996ab50462dcfd2c04f0b08e9340300ad6567a7bf47d59eae2b36471d9661cb9c020304566df8267c3c19f262a77346b7924504e
+  data.tar.gz: 3acfcdfa41752e295833ca61052fbad706e51bae6132eb7f72350bbfd5db1e0d6fa42d1338059d6fa758396d48d417f2c699a8fcfc40888074afde7189c03dfb

data/README.md

@@ -23,6 +23,23 @@ requested. These formats are presently supported:
 * HTML
 * HALO
 
+## State of Development
+
+This library came into existence because we at
+[Ticketsolve](https://www.ticketsolve.com) wanted to build a rich
+hypermedia API, and were dissatisfied with any of the existing Ruby
+solutions at the time (November 2013).
+
+We are still actively expanding our API, and with that Yaks continues
+to grow and improve. The aim is to create *the reference* for
+supporting hypermedia formats in Ruby.
+
+Yaks can be used in production today, as we do, but until 1.0 is
+released there will regularly be breaking changes, as we figure out
+the best way to do things. These are all documented clearly in the
+[changelog](CHANGLOG.md). At this point we recommend locking to an
+exact version number.
+
 ## Concepts
 
 Yaks is a processing pipeline, you create and configure the pipeline,

data/Rakefile

@@ -2,49 +2,69 @@ load '../rakelib/shared.rake'
 
 gem_tasks(:yaks)
 
-
 task :mutant_chunked do
+  # No subjects:
+  # Yaks,
+  # Yaks::Error,
+  # Yaks::IllegalStateError,
+  # Yaks::UnsupportedOperationError,
+  # Yaks::PrimitivizeError,
+  # Yaks::Undefined,
+  # Yaks::HTML5Forms,
+
+  # Hangs:
+  # Yaks::Changelog,
+
+  # 100% verified:
+  # Yaks::Util,
+  # Yaks::Util::Deprecated,
+  # Yaks::FP
+  # Yaks::FP::Callable,
+  # Yaks::DefaultPolicy,
+  # Yaks::Mapper::HasOne,
+  # Yaks::Mapper::HasMany,
+  # Yaks::Mapper::Attribute,
+  # Yaks::Mapper::Config,
+  # Yaks::Mapper::ClassMethods,
+  # Yaks::Mapper::AssociationMapper,
+  # Yaks::Format::CollectionJson,
+  # Yaks::Config,
+  # Yaks::Config::DSL,
+  # Yaks::Attributes::InstanceMethods,
+  # Yaks::Configurable,
+  # Yaks::NullResource,
+
   [
-    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::HasOne,
-    Yaks::Primitivize,
-    Yaks::Resource,
-    Yaks::Resource::Link,
-    Yaks::Util,
-    Yaks::Serializer,
-    Yaks::Runner,
-    Yaks::Mapper::Link,
-    Yaks::Mapper::HasMany,
-    Yaks::Mapper::ClassMethods,
-    Yaks::Mapper::Association,
-    Yaks::Mapper,
-    Yaks::Format::HTML,
-    Yaks::Mapper::Control,
-    Yaks::Mapper::Control::Field,
-#   Yaks::Resource::Control, #no subjects to mutate
-    Yaks::NullResource,
+    # 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%
+    Yaks::Mapper,                           # 15/482  # 96.89%
+    Yaks::Resource::Link,                   # 13/43   # 69.77%
+    Yaks::Mapper::Form::Field,              # 11/155  # 92.90%
+    Yaks::Mapper::Link,                     # 10/357  # 97.20%
+    Yaks::CollectionMapper,                 # 7/217   # 96.77%
+    Yaks::Primitivize,                      # 3/239   # 98.74%
+    Yaks::Mapper::Form,                     # 3/179   # 98.32%
+    Yaks::CollectionResource,               # 3/9     # 66.67%
+    Yaks::Format::JsonAPI,                  # 3/435   # 99.31%
+    Yaks::Format,                           # 2/29    # 93.10%
+    Yaks::Attributes,                       # 1/239   # 99.57%
+    Yaks::StatefulBuilder::StatefulMethods, # 1/66    # 98.49%
+    Yaks::Mapper::Association,              # 1/222   # 99.55%
+    Yaks::Serializer,                       # 1/74    # 98.65%
+    Yaks::Format::Hal,                      # 1/328   # 99.70%
+    # Yaks::Format::Transit,                  # no explicit coverage
+    # Yaks::Format::Transit::WriteHandler,    # no explicit coverage
+    # Yaks::Format::Transit::ReadHandler,     # no explicit coverage
   ].each do |space|
     puts space
     ENV['PATTERN'] = "#{space}"
     Rake::Task["mutant"].execute
+    break
   end
 end

data/lib/yaks.rb

@@ -36,10 +36,8 @@ module Yaks
       Yaks::Config.new(&blk)
     end
   end
-
 end
 
-
 require 'yaks/resource'
 require 'yaks/null_resource'
 require 'yaks/resource/link'
@@ -52,14 +50,15 @@ require 'yaks/mapper/has_one'
 require 'yaks/mapper/has_many'
 require 'yaks/mapper/attribute'
 require 'yaks/mapper/link'
-require 'yaks/mapper/control'
+require 'yaks/mapper/form'
+require 'yaks/mapper/form/field'
 require 'yaks/mapper/config'
 require 'yaks/mapper/class_methods'
 require 'yaks/mapper'
 require 'yaks/mapper/association_mapper'
 require 'yaks/collection_mapper'
 
-require 'yaks/resource/control'
+require 'yaks/resource/form'
 
 require 'yaks/serializer'
 

data/lib/yaks/attributes.rb

@@ -1,24 +1,24 @@
 module Yaks
   class Attributes < Module
-    attr_reader :defaults, :attributes
+    attr_reader :defaults, :names
 
     def initialize(*attrs)
       @defaults   = attrs.last.instance_of?(Hash) ? attrs.pop : {}
-      @attributes = (attrs + @defaults.keys).uniq
+      @names = (attrs + @defaults.keys).uniq
     end
 
     def add(*attrs)
       defaults = attrs.last.instance_of?(Hash) ? attrs.pop : {}
-      self.class.new(*[*(attributes+attrs), @defaults.merge(defaults)])
+      self.class.new(*[*(names+attrs), @defaults.merge(defaults)])
     end
 
     def included(descendant)
       descendant.module_exec(self) do |this|
         include InstanceMethods,
-                Anima.new(*this.attributes),
+                Anima.new(*this.names),
                 Anima::Update
 
-        this.attributes.each do |attr|
+        this.names.each do |attr|
           define_method attr do |value = Undefined|
             if value.equal? Undefined
               instance_variable_get("@#{attr}")
@@ -45,12 +45,16 @@ module Yaks
         indent = ->(str) { str.lines.map {|l| "  #{l}"}.join }
         format = ->(val) { val.respond_to?(:pp) ? val.pp : val.inspect }
 
-        fmt_attrs = self.class.attributes.attributes.map do |attr|
-          value   = public_send(attr)
+        defaults = self.class.attributes.defaults
+        values   = to_h.reject do |attr, value|
+          value.equal?(defaults[attr])
+        end
+
+        fmt_attrs = values.map do |attr, value|
           fmt_val = case value
                     when Array
                       if value.inspect.length < 50
-                        value.inspect
+                        "[#{value.map(&format).join(", ")}]"
                       else
                         "[\n#{indent[value.map(&format).join(",\n")]}\n]"
                       end
@@ -58,9 +62,18 @@ module Yaks
                       format[value]
                     end
           "#{attr}: #{fmt_val}"
-        end.join(",\n")
+        end
+
+        fmt_attrs_str = fmt_attrs.join(", ")
 
-        "#{self.class.name}.new(\n#{indent[fmt_attrs]}\n)"
+        if fmt_attrs_str.length > 50
+          fmt_attrs_str = fmt_attrs.join(",\n")
+        end
+
+        if fmt_attrs_str =~ /\n/
+          fmt_attrs_str = "\n#{indent[fmt_attrs_str]}\n"
+        end
+        "#{self.class.name}.new(#{fmt_attrs_str})"
       end
     end
   end

data/lib/yaks/config.rb

@@ -65,5 +65,9 @@ module Yaks
       runner(object, options).call
     end
     alias serialize call
+
+    def map(object, options = {})
+      runner(object, options).map(object)
+    end
   end
 end

data/lib/yaks/configurable.rb

@@ -1,27 +1,22 @@
 module Yaks
   module Configurable
-    def self.included(descendant)
-      descendant.instance_eval do
-        extend ClassMethods
-      end
-    end
+    def config_method(name, options)
+      define_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
 
-    module ClassMethods
-      def config_method(name, options)
-        define_method name do |*args, &block|
-          defaults = options[:defaults]
-          if defaults
-            if args.last.is_a? Hash
-              args[-1] = defaults.merge(args[-1])
-            else
-              args << defaults
-            end
-          end
-          append_to(
-            options.fetch(:append_to),
-            options.fetch(:create).create(*args, &block)
-          )
-        end
+        append_to(options.fetch(:append_to), instance)
       end
     end
   end

data/lib/yaks/format.rb

@@ -20,7 +20,7 @@ module Yaks
 
     # @param [Yaks::Resource] resource
     # @return [Hash]
-    def call(resource, env = {})
+    def call(resource, _env = {})
       serialize_resource(resource)
     end
     alias serialize call

data/lib/yaks/format/collection_json.rb

@@ -13,6 +13,7 @@ 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?
         {collection: result}
       end
 
@@ -37,6 +38,14 @@ module Yaks
           result
         end
       end
+
+      def serialize_links(resource)
+        result = []
+        resource.links.each do |link|
+          result << {href: link.uri, rel: link.rel}
+        end
+        result
+      end
     end
   end
 end

data/lib/yaks/format/halo.rb

@@ -8,28 +8,31 @@ module Yaks
       register :halo, :json, 'application/halo+json'
 
       def serialize_resource(resource)
-        if resource.controls.any?
-          super.merge(_controls: serialize_controls(resource.controls))
+        if resource.forms.any?
+          super.merge(_controls: serialize_forms(resource.forms))
         else
           super
         end
       end
 
-      def serialize_controls(controls)
-        controls.each_with_object({}) do |control, result|
-          result[control.name] = serialize_control(control)
+      def serialize_forms(forms)
+        forms.each_with_object({}) do |form, result|
+          result[form.name] = serialize_form(form)
         end
       end
 
-      def serialize_control(control)
-        raw = control.to_h
+      def serialize_form(form)
+        raw = form.to_h
         raw[:href]  = raw.delete(:action)
-        raw[:fields] = control.fields.map(&:to_h)
-        raw[:fields].each do |field|
-          if field[:options].empty?
-            field.delete(:options)
-          else
-            field[:options] || field[:options].map(&:to_h)
+        raw[:fields] = form.fields.map do |field|
+          field.to_h.each_with_object({}) do |(attr,value), hsh|
+            if attr == :options
+              if !value.empty?
+                hsh[:options] = value.map(&:to_h)
+              end
+            elsif HTML5Forms::FIELD_OPTIONS[attr] != value
+              hsh[attr] = value
+            end
           end
         end
         raw

data/lib/yaks/html5_forms.rb

@@ -28,8 +28,29 @@ module Yaks
       :url,
       :week,
 
-      :select
+      :select,
+      :textarea,
+      :datalist
     ]
 
+    FIELD_OPTIONS = {
+      required: false,
+      rows: nil,
+      type: nil,
+      value: nil,
+      pattern: nil,
+      maxlength: nil,
+      minlength: 0,
+      size: 20,
+      readonly: false,
+      multiple: false,
+      min: nil,
+      max: nil,
+      step: nil,
+      list: nil,
+      placeholder: nil,
+      checked: false
+    }
+
   end
 end

data/lib/yaks/mapper.rb

@@ -6,7 +6,7 @@ module Yaks
     include Util, FP, FP::Callable
 
     def_delegators 'self.class', :config
-    def_delegators :config, :attributes, :links, :associations, :controls
+    def_delegators :config, :attributes, :links, :associations, :forms
 
     config Config.new
 
@@ -44,7 +44,7 @@ module Yaks
       [ :map_attributes,
         :map_links,
         :map_subresources,
-        :map_controls
+        :map_forms
       ].inject(Resource.new(type: mapper_name)) do |resource, method|
         send(method, resource)
       end
@@ -100,9 +100,9 @@ module Yaks
       end
     end
 
-    def map_controls(resource)
-      controls.inject(resource) do |res, control|
-        control.add_to_resource(res, self, context)
+    def map_forms(resource)
+      forms.inject(resource) do |res, form|
+        form.add_to_resource(res, self, context)
       end
     end
   end

data/lib/yaks/mapper/attribute.rb

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