yaks 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45ba297e354c237fe7dac7c3570c9405b1235c03
-  data.tar.gz: b8d1873f4e2bb1b4103608a48660a13a970babf0
+  metadata.gz: 3eb709b078f05c15a877f6c3008df313d09e2bbe
+  data.tar.gz: cd8d14498bbf3c74b2362b66c30dee5ec00d3c53
 SHA512:
-  metadata.gz: 44d29bbb7d61bb15939d6b8d14ee7267d95c6c52003fdd560d3046a7484d344b3e1c7b0fb0ba4bb220bb06475b78305033506e9192da7c4f3df0f74a7665e654
-  data.tar.gz: 9b5c263fa66d6c519087164de7b1c0d6d626dc99b221efcc83ca103361e983b474e1116472ebc5af620fb7471d2d294a892754f775948a9549e0ebbaafe55a19
+  metadata.gz: 4cc2b5d05868b2869684481a6a9a37d513b66da63dfe995307b1c2c933ab349bf0bf200f5342e60ef485f756046e2308854227f895ec1b302ed4ec0b91f1d6c8
+  data.tar.gz: cde85afd3d63e33420ebe61e24638f1d00ceb26f93db91f48f19f42f7de531d4cd84e17dc7e74586a95afd5369d22293b4431f2208073a2ac48d84788bb67526

data/lib/yaks/attributes.rb

@@ -40,6 +40,28 @@ module Yaks
       def append_to(type, *objects)
         update(type => instance_variable_get("@#{type}") + objects)
       end
+
+      def pp
+        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)
+          fmt_val = case value
+                    when Array
+                      if value.inspect.length < 50
+                        value.inspect
+                      else
+                        "[\n#{indent[value.map(&format).join(",\n")]}\n]"
+                      end
+                    else
+                      format[value]
+                    end
+          "#{attr}: #{fmt_val}"
+        end.join(",\n")
+
+        "#{self.class.name}.new(\n#{indent[fmt_attrs]}\n)"
+      end
     end
   end
 end

data/lib/yaks/breaking_changes.rb

@@ -5,6 +5,28 @@ module Yaks
 
 BreakingChanges = {
 
+    '0.7.6' => %q~
+Breaking Changes in Yaks 0.7.6
+==============================
+Breaking change: using a symbol instead of link template no longer
+works, use a lambda.
+
+    link :foo, :bar
+
+Becomes
+
+    link :foo, ->{ bar }
+
+Strictly speaking the equivalent version would be `link :foo, ->{
+load_attribute(:bar) }`. Depending on if `bar` is implemented on the
+mapper or is an attribute of the object, this would simplify to `link
+:foo, ->{ bar }` or `link :foo, ->{ object.bar }` respectively.
+
+The `href` attribute of a control has been renamed `action`, in line
+with the attribute name in HTML. An alias is available but will output
+a deprecation warning.
+~,
+
     '0.7.0' => %q~
 Breaking Changes in Yaks 0.7.0
 ==============================

data/lib/yaks/changelog.rb

@@ -0,0 +1,21 @@
+module Yaks
+  module Changelog
+    extend self
+
+    def current
+      versions[Yaks::VERSION]
+    end
+
+    def versions
+      markdown.split(/(?=###\s*[\d\.]+\n)/).each_with_object({}) do |section, hsh|
+        version = section.each_line.first[/[\d\.]+/]
+        log     = section.each_line.drop(1).join.strip
+        hsh[version] = log
+      end
+    end
+
+    def markdown
+      Pathname(__FILE__).join('../../../../CHANGELOG.md').read
+    end
+  end
+end

data/lib/yaks/configurable.rb

@@ -9,6 +9,14 @@ module Yaks
     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)

data/lib/yaks/format/halo.rb

@@ -22,7 +22,17 @@ module Yaks
       end
 
       def serialize_control(control)
-        control.to_h.merge(fields: control.fields.map(&:to_h))
+        raw = control.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)
+          end
+        end
+        raw
       end
     end
   end

data/lib/yaks/html5_forms.rb

@@ -0,0 +1,35 @@
+module Yaks
+  # Based on the HTML living standard over at WHATWG
+  # https://html.spec.whatwg.org/multipage/forms.html
+  #
+  # Does not aim to be complete, does aim to be a strict subset.
+  module HTML5Forms
+
+    INPUT_TYPES = [
+      :checkbox,
+      :color,
+      :date,
+      :datetime,
+      :datetime_local, # :datetime-local in the spec
+      :email,
+      :file,
+      :hidden,
+      :image,
+      :month,
+      :number,
+      :password,
+      :radio,
+      :range,
+      :reset,
+      :search,
+      :tel,
+      :text,
+      :time,
+      :url,
+      :week,
+
+      :select
+    ]
+
+  end
+end

data/lib/yaks/mapper/config.rb

@@ -22,8 +22,13 @@ module Yaks
       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
+                    append_to: :controls,
+                    create: StatefulBuilder.new(
+                      Control,
+                      Control.anima.attribute_names +
+                        HTML5Forms::INPUT_TYPES +
+                        [:field]
+                    )
     end
   end
 end

data/lib/yaks/mapper/control.rb

@@ -1,35 +1,43 @@
 module Yaks
   class Mapper
     class Control
+      extend Util::Deprecated
       include Attributes.new(
-                name: nil, href: nil, title: nil, method: nil, media_type: nil, fields: []
+                name: nil, action: nil, title: nil, method: nil, media_type: nil, fields: []
               ),
               Configurable
 
+      alias enctype media_type
+      deprecated_alias :href, :action
+
       def self.create(name = nil, options = {})
         new({name: name}.merge(options))
       end
 
-      def add_to_resource(resource, parent_mapper, _context)
-        resource.add_control(map_to_resource_control(resource, parent_mapper))
+      def add_to_resource(resource, mapper, _context)
+        resource.add_control(to_resource(mapper))
       end
 
-      def map_to_resource_control(resource, parent_mapper)
+      def to_resource(mapper)
         attrs = {
-          fields: resource_fields,
-          href: parent_mapper.expand_uri(href, true)
+          fields: resource_fields(mapper),
+          action: mapper.expand_uri(action, true)
         }
-        Resource::Control.new(to_h.merge(attrs))
+        [:name, :title, :method, :media_type].each do |attr|
+          attrs[attr] = mapper.expand_value(public_send(attr))
+        end
+        Resource::Control.new(attrs)
       end
 
-      def resource_fields
-        fields.map(&:to_resource_field)
+      def resource_fields(mapper)
+        fields.map { |field| field.to_resource(mapper) }
       end
 
       class Field
-        include Attributes.new(:name, label: nil, type: "text", value: nil)
+        include Attributes.new(:name, label: nil, type: "text", value: nil, options: []),
+                Configurable
 
-        def self.create(*args)
+        def self.create(*args, &block)
           attrs = args.last.instance_of?(Hash) ? args.pop : {}
           if name = args.shift
             attrs = attrs.merge(name: name)
@@ -37,12 +45,38 @@ module Yaks
           new(attrs)
         end
 
-        def to_resource_field
-          Resource::Control::Field.new(to_h)
+        def to_resource(mapper)
+          Resource::Control::Field.new(
+            [:name, :label, :type, :value].each_with_object({}) do |attr, attrs|
+              attrs[attr] = mapper.expand_value(public_send(attr))
+            end.merge(options: options.map(&:to_resource))
+          )
+        end
+
+        class Option
+          include Attributes.new(:value, :label, selected: false)
+
+          def self.create(value, opts = {})
+            new(opts.merge(value: value))
+          end
+
+          def to_resource
+            to_h #placeholder
+          end
         end
+
+        config_method :option,
+                      append_to: :options,
+                      create: Option
       end
 
-      config_method :field, create: Field, append_to: :fields
+      FieldBuilder = StatefulBuilder.new(Field, [:name, :label, :type, :value, :option])
+
+      config_method :field, create: FieldBuilder, append_to: :fields
+
+      HTML5Forms::INPUT_TYPES.each do |type|
+        config_method type, create: FieldBuilder, append_to: :fields, defaults: { type: type }
+      end
     end
   end
 end

data/lib/yaks/mapper.rb

@@ -55,15 +55,13 @@ module Yaks
     end
     alias load_association load_attribute
 
+    def expand_value(value)
+      Resolve(value, self)
+    end
+
     def expand_uri(uri, expand)
-      case uri
-      when nil
-        return
-      when Symbol
-        return load_attribute(uri)
-      when Method, Proc
-        return Resolve(uri, self)
-      end
+      return if uri.nil?
+      return Resolve(uri, self) if uri.respond_to?(:to_proc)
 
       template = URITemplate.new(uri)
       expand_vars = case expand

data/lib/yaks/resource.rb

@@ -64,26 +64,5 @@ module Yaks
       append_to(:subresources, subresource)
     end
 
-    def pp
-      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)
-        fmt_val = case value
-                  when Array
-                    if value.inspect.length < 50
-                      value.inspect
-                    else
-                      "[\n#{indent[value.map(&format).join(",\n")]}\n]"
-                    end
-                  else
-                    format[value]
-                  end
-        "#{attr}=#{fmt_val}"
-      end.join("\n")
-
-      "#<#{self.class.name}\n#{indent[fmt_attrs]}\n>"
-    end
   end
 end

data/lib/yaks/stateful_builder.rb

@@ -8,23 +8,24 @@ module Yaks
   #   # This code
   #   Control.create(:search)
   #          .method("POST")
-  #          .href("/search")
+  #          .action("/search")
   #
   #   # Can be written as
-  #   StatefulBuilder.new(Control, [:method, :href]).create(:search) do
+  #   StatefulBuilder.new(Control, [:method, :action]).create(:search) do
   #     method "POST"
-  #     href "/search"
+  #     action "/search"
   #   end
   #
   class StatefulBuilder < BasicObject
     def create(*args, &block)
       @state = @klass.create(*args)
-      instance_eval(&block)
+      instance_eval(&block) if block
       @state
     end
 
     def initialize(klass, methods)
       @klass = klass
+      @methods = methods
       StatefulMethods.new(methods).send(:extend_object, self)
     end
 
@@ -38,6 +39,10 @@ module Yaks
       end
     end
 
+    def inspect
+      "#<#{self.class} #{@klass} #{@methods.inspect}>"
+    end
+
     class StatefulMethods < ::Module
       def initialize(methods)
         methods.each { |name| define_stateful_method(name) }

data/lib/yaks/util.rb

@@ -36,7 +36,7 @@ module Yaks
     # @param [Object] context
     #   (optional) A context used to instance_eval the proc
     def Resolve(maybe_proc, context = nil)
-      if maybe_proc.is_a? Proc or maybe_proc.is_a? Method
+      if maybe_proc.respond_to?(:to_proc) && !maybe_proc.instance_of?(Symbol)
         if context
           if maybe_proc.arity > 0
             context.instance_eval(&maybe_proc)
@@ -45,12 +45,21 @@ module Yaks
             context.instance_exec(&maybe_proc)
           end
         else
-          maybe_proc.()
+          maybe_proc.to_proc.()
         end
       else
         maybe_proc
       end
     end
 
+    module Deprecated
+      def deprecated_alias(name, actual)
+        define_method name do |*args, &block|
+          $stderr.puts "WARNING: #{self.class}##{name} is deprecated, use `#{actual}'. at #{caller.first}"
+          send(actual, *args, &block)
+        end
+      end
+    end
+
   end
 end

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.7.5'
+  VERSION = '0.7.6'
 end

data/lib/yaks.rb

@@ -11,6 +11,7 @@ require 'inflection'
 require 'uri_template'
 require 'rack/accept'
 
+require 'yaks/version'
 require 'yaks/util'
 require 'yaks/configurable'
 require 'yaks/fp'
@@ -44,6 +45,8 @@ require 'yaks/null_resource'
 require 'yaks/resource/link'
 require 'yaks/collection_resource'
 
+require 'yaks/html5_forms'
+
 require 'yaks/mapper/association'
 require 'yaks/mapper/has_one'
 require 'yaks/mapper/has_many'

data/spec/unit/yaks/format/json_api_spec.rb

@@ -15,8 +15,8 @@ RSpec.describe Yaks::Format::JsonAPI do
   end
 
   context 'with both a "href" attribute and a self link' do
-      let(:resource) {
-        Yaks::Resource.new(
+    let(:resource) {
+      Yaks::Resource.new(
         type: 'wizard',
         attributes: {
           href: '/the/href'
@@ -27,6 +27,7 @@ RSpec.describe Yaks::Format::JsonAPI do
       )
     }
 
+    # TODO should it really behave this way? better to give preference to self link.
     it 'should give preference to the href attribute' do
       expect(format.call(resource)).to eql(
         {'wizards' => [

data/spec/unit/yaks/mapper/control/field_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 RSpec.describe Yaks::Mapper::Control::Field do
+  include_context 'yaks context'
+
   let(:field)   { described_class.new( full_args ) }
   let(:name)      { :the_field }
   let(:full_args) { {name: name}.merge(args) }
@@ -12,6 +14,8 @@ RSpec.describe Yaks::Mapper::Control::Field do
     }
   }
 
+  let(:mapper) { Yaks::Mapper.new(yaks_context) }
+
   describe '.create' do
     it 'can take all args as a hash' do
       expect(described_class.create(full_args)).to eql described_class.new(full_args)
@@ -28,7 +32,7 @@ RSpec.describe Yaks::Mapper::Control::Field do
 
   describe '#to_resource_field' do
     it 'creates a Yaks::Resource::Control::Field with the same attributes' do
-      expect(field.to_resource_field).to eql Yaks::Resource::Control::Field.new(full_args)
+      expect(field.to_resource(mapper)).to eql Yaks::Resource::Control::Field.new(full_args)
     end
   end
 end

data/spec/unit/yaks/mapper/control_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Yaks::Mapper::Control do
   let(:full_args) { {name: name}.merge(args) }
   let(:args) {
     {
-      href: '/foo',
+      action: '/foo',
       title: 'a title',
       method: 'PATCH',
       media_type: 'application/hal+json',

data/spec/unit/yaks/mapper/link_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a link function returning nothing' do
-      let(:template) { :link_computer }
+      let(:template) { ->{ link_computer } }
       before do
         mapper_class.class_eval do
           def link_computer ; end
@@ -157,7 +157,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a link generation method that returns nil' do
-      let(:template) { :returns_nil }
+      let(:template) { ->{ object.returns_nil } }
 
       it 'should return nil' do
         expect(resource_link).to be_nil

data/spec/unit/yaks/mapper_spec.rb

@@ -187,7 +187,7 @@ RSpec.describe Yaks::Mapper do
       before do
         mapper_class.class_eval do
           attributes :id
-          link :bar_link, :link_generating_method
+          link :bar_link, -> { link_generating_method }
 
           def link_generating_method
           end
@@ -365,7 +365,7 @@ RSpec.describe Yaks::Mapper do
     end
 
     context 'with a symbol for a template' do
-      let(:template) { :foo }
+      let(:template) { -> { object.foo } }
 
       it 'should use the lookup mechanism for finding the link' do
         expect(expanded).to eq '/foo/foo'

data/yaks.gemspec

@@ -2,6 +2,7 @@
 
 require File.expand_path('../lib/yaks/version', __FILE__)
 require File.expand_path('../lib/yaks/breaking_changes', __FILE__)
+require File.expand_path('../lib/yaks/changelog', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = 'yaks'
@@ -18,6 +19,8 @@ Gem::Specification.new do |gem|
   gem.test_files       = gem.files.grep(/^spec/)
   gem.extra_rdoc_files = %w[README.md]
 
+  gem.metadata = {'changelog' => Yaks::Changelog.current[0...1000]}
+
   if Yaks::BreakingChanges.key? Yaks::VERSION
     gem.post_install_message = Yaks::BreakingChanges[Yaks::VERSION]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -247,6 +247,7 @@ files:
 - lib/yaks.rb
 - lib/yaks/attributes.rb
 - lib/yaks/breaking_changes.rb
+- lib/yaks/changelog.rb
 - lib/yaks/collection_mapper.rb
 - lib/yaks/collection_resource.rb
 - lib/yaks/config.rb
@@ -261,6 +262,7 @@ files:
 - lib/yaks/format/json_api.rb
 - lib/yaks/fp.rb
 - lib/yaks/fp/callable.rb
+- lib/yaks/html5_forms.rb
 - lib/yaks/mapper.rb
 - lib/yaks/mapper/association.rb
 - lib/yaks/mapper/association_mapper.rb
@@ -345,8 +347,62 @@ files:
 homepage: https://github.com/plexus/yaks
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog: |-
+    Much expanded form support, simplified link DSL, pretty-print objects
+    to Ruby code.
+
+    Breaking change: using a symbol instead of link template no longer
+    works, use a lambda.
+
+        link :foo, :bar
+
+    Becomes
+
+        link :foo, ->{ bar }
+
+    Strictly speaking the equivalent version would be `link :foo, ->{
+    load_attribute(:bar) }`. Depending on if `bar` is implemented on the
+    mapper or is an attribute of the object, this would simplify to `link
+    :foo, ->{ bar }` or `link :foo, ->{ object.bar }` respectively.
+
+    The form control DSL has been expanded, instead of `field type:
+    'text'` and similar there are now aliases, e.g. `text :name, value:
+    'foo'`.
+
+    All attributes on the form control itself, and on fields, now
+    optionally take a lambda (any `#to_proc`-able) for dynamic
+    content. e.g.
+
+        control :add_product do
+          method 'POST'
+          action ->{ '/cart/#{cart.id}/line_items' }
+          hidden :product_id, value: -> { product.id }
+          number :quantity, value: 0
+        end
+
+    As with lambdas used for links, i
+post_install_message: |2
+
+  Breaking Changes in Yaks 0.7.6
+  ==============================
+  Breaking change: using a symbol instead of link template no longer
+  works, use a lambda.
+
+      link :foo, :bar
+
+  Becomes
+
+      link :foo, ->{ bar }
+
+  Strictly speaking the equivalent version would be `link :foo, ->{
+  load_attribute(:bar) }`. Depending on if `bar` is implemented on the
+  mapper or is an attribute of the object, this would simplify to `link
+  :foo, ->{ bar }` or `link :foo, ->{ object.bar }` respectively.
+
+  The `href` attribute of a control has been renamed `action`, in line
+  with the attribute name in HTML. An alias is available but will output
+  a deprecation warning.
 rdoc_options: []
 require_paths:
 - lib