yaks 0.7.6 → 0.7.7

data/lib/yaks/mapper/class_methods.rb

@@ -3,6 +3,7 @@
 module Yaks
   class Mapper
     module ClassMethods
+      extend Util::Deprecated
       include Forwardable,
               Util,
               FP
@@ -27,7 +28,7 @@ module Yaks
         :profile,
         :has_one,
         :has_many,
-        :control
+        :form
       ]
 
       CONFIG_METHODS.each do |method_name|
@@ -40,6 +41,7 @@ module Yaks
         end
       end
 
+      deprecated_alias :control, :form
     end
   end
 end

data/lib/yaks/mapper/config.rb

@@ -1,10 +1,11 @@
 module Yaks
   class Mapper
     class Config
+      extend Configurable
+
       include Attributes.new(
-                type: nil, attributes: [], links: [], associations: [], controls: []
-              ),
-              Configurable
+                type: nil, attributes: [], links: [], associations: [], forms: []
+              )
 
       def type(type = Undefined)
         return @type if type.equal?(Undefined)
@@ -16,19 +17,11 @@ module Yaks
         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 :attribute, create: Attribute,               append_to: :attributes
-      config_method :control,
-                    append_to: :controls,
-                    create: StatefulBuilder.new(
-                      Control,
-                      Control.anima.attribute_names +
-                        HTML5Forms::INPUT_TYPES +
-                        [:field]
-                    )
+      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.rb

@@ -0,0 +1,41 @@
+module Yaks
+  class Mapper
+    class Form
+      extend Util::Deprecated, Configurable
+      include Attributes.new(
+        name: nil, action: nil, title: nil, method: nil, media_type: nil, fields: []
+      )
+
+      deprecated_alias :href, :action
+
+      Builder = StatefulBuilder.new(
+        self,
+        self.attributes.names + HTML5Forms::INPUT_TYPES + [:field]
+      )
+
+      def self.create(name = nil, options = {}, &block)
+        Builder.build(new({name: name}.merge(options)), &block)
+      end
+
+      def add_to_resource(resource, mapper, _context)
+        resource.add_form(to_resource(mapper))
+      end
+
+      def to_resource(mapper)
+        attrs = {
+          fields: resource_fields(mapper),
+          action: mapper.expand_uri(action, true)
+        }
+        [:name, :title, :method, :media_type].each do |attr|
+          attrs[attr] = mapper.expand_value(public_send(attr))
+        end
+        Resource::Form.new(attrs)
+      end
+
+      def resource_fields(mapper)
+        fields.map { |field| field.to_resource(mapper) }
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Yaks
+  class Mapper
+    class Form
+      class Field
+        extend Configurable
+        include Attributes.new(
+                  :name,
+                  label: nil,
+                  options: []
+                ).add(HTML5Forms::FIELD_OPTIONS)
+
+        Builder = StatefulBuilder.new(self, attributes.names)
+
+        def self.create(*args)
+          attrs = args.last.instance_of?(Hash) ? args.pop : {}
+          if name = args.shift
+            attrs = attrs.merge(name: name)
+          end
+          new(attrs)
+        end
+
+        # Convert to a Resource::Form::Field, expanding any dynamic
+        # values
+        def to_resource(mapper)
+          Resource::Form::Field.new(
+            resource_attributes.each_with_object({}) do |attr, attrs|
+              attrs[attr] = mapper.expand_value(public_send(attr))
+            end.merge(options: options.map(&:to_resource))
+          )
+        end
+
+        # All attributes that can be converted 1-to-1 to
+        # Resource::Form::Field
+        def resource_attributes
+          self.class.attributes.names - [:options]
+        end
+
+        # <option>, as used in a <select>
+        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, create: Option, append_to: :options
+      end #Field
+
+      config_method :field, create: Field::Builder, append_to: :fields
+
+      HTML5Forms::INPUT_TYPES.each do |type|
+        config_method type, create: Field::Builder, append_to: :fields, defaults: { type: type }
+      end
+
+    end # Form
+  end # Mapper
+end # Yaks

data/lib/yaks/null_resource.rb

@@ -39,7 +39,7 @@ module Yaks
       raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
     end
 
-    def add_control(_control)
+    def add_form(_form)
       raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
     end
 

data/lib/yaks/resource.rb

@@ -6,7 +6,7 @@ module Yaks
               links: [],
               attributes: {},
               subresources: [],
-              controls: []
+              forms: []
             )
 
     def initialize(attrs = {})
@@ -18,6 +18,10 @@ module Yaks
       attributes[attr]
     end
 
+    def find_form(name)
+      forms.find { |form| form.name == name }
+    end
+
     def seq
       [self]
     end
@@ -56,8 +60,8 @@ module Yaks
       append_to(:links, link)
     end
 
-    def add_control(control)
-      append_to(:controls, control)
+    def add_form(form)
+      append_to(:forms, form)
     end
 
     def add_subresource(subresource)

data/lib/yaks/resource/form.rb

@@ -0,0 +1,31 @@
+module Yaks
+  class Resource
+    class Form
+      include Yaks::Mapper::Form.attributes
+
+      def [](name)
+        fields.find {|field| field.name == name}.value
+      end
+
+      def values
+        fields.each_with_object({}) do |field, values|
+          values[field.name] = field.value
+        end
+      end
+
+      class Field
+        include Yaks::Mapper::Form::Field.attributes.add(:error => nil)
+
+        def value(arg = Undefined)
+          return @value if arg.eql?(Undefined)
+          if type == :select
+            selected = options.find { |option| option.selected }
+            selected.value if selected
+          else
+            update(value: arg)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yaks/runner.rb

@@ -8,9 +8,16 @@ module Yaks
     def_delegators :config, :policy, :default_format, :format_options, :primitivize, :serializers
 
     def call
-      steps.inject(object) {|memo, (_, step)| step.call(memo, env) }
+      process(steps, object)
+    end
+
+    def map(object)
+      process(insert_hooks([[:map, mapper]]), object)
+    end
+
+    def process(operations, input)
+      operations.inject(input) {|memo, (_, step)| step.call(memo, env) }
     end
-    alias result call
 
     def context
       {
@@ -38,7 +45,7 @@ module Yaks
       format_class.media_type
     end
 
-    def format
+    def format_name
       format_class.format_name
     end
 
@@ -74,13 +81,6 @@ module Yaks
     end
     memoize :primitivizer
 
-    # @param [Hash] opts
-    # @return [String]
-    def format_name
-      options.fetch(:format) { default_format }
-    end
-    memoize :format_name
-
     def serializer
       serializers.fetch(format_class.serializer)
     end
@@ -93,7 +93,7 @@ module Yaks
     def insert_hooks(steps)
       hooks.inject(steps) do |steps, (type, target_step, name, hook)|
         steps.flat_map do |step_name, callable|
-          if step_name.eql? target_step
+          if step_name.equal? target_step
             case type
             when :before
               [[name, hook], [step_name, callable]]

data/lib/yaks/stateful_builder.rb

@@ -6,27 +6,31 @@ module Yaks
   # @example
   #
   #   # This code
-  #   Control.create(:search)
+  #   Form.create(:search)
   #          .method("POST")
   #          .action("/search")
   #
   #   # Can be written as
-  #   StatefulBuilder.new(Control, [:method, :action]).create(:search) do
+  #   StatefulBuilder.new(Form, [:method, :action]).create(:search) do
   #     method "POST"
   #     action "/search"
   #   end
   #
   class StatefulBuilder < BasicObject
     def create(*args, &block)
-      @state = @klass.create(*args)
+      build(@klass.create(*args), &block)
+    end
+
+    def build(init_state, &block)
+      @state = init_state
       instance_eval(&block) if block
       @state
     end
 
-    def initialize(klass, methods)
+    def initialize(klass, methods = nil)
       @klass = klass
-      @methods = methods
-      StatefulMethods.new(methods).send(:extend_object, self)
+      @methods = methods || klass.attributes.names
+      StatefulMethods.new(@methods).send(:extend_object, self)
     end
 
     def validate_state(method_name, args)
@@ -40,7 +44,7 @@ module Yaks
     end
 
     def inspect
-      "#<#{self.class} #{@klass} #{@methods.inspect}>"
+      "#<StatefulBuilder #{@klass} #{@methods.inspect}>"
     end
 
     class StatefulMethods < ::Module

data/lib/yaks/util.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module Yaks
   module Util
     extend self
@@ -45,7 +46,7 @@ module Yaks
             context.instance_exec(&maybe_proc)
           end
         else
-          maybe_proc.to_proc.()
+          maybe_proc.to_proc.call()
         end
       else
         maybe_proc
@@ -56,7 +57,7 @@ module Yaks
       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)
+          public_send(actual, *args, &block)
         end
       end
     end

data/lib/yaks/version.rb

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

data/spec/acceptance/models.rb

@@ -28,7 +28,7 @@ class ScholarMapper < LiteratureBaseMapper
   link 'http://literature.example.com/rels/quotes', 'http://literature.example.com/quotes/?author={downcased_pinyin}&q={query}', expand: [:downcased_pinyin], title: 'Search for quotes'
   link :self, 'http://literature.example.com/authors/{downcased_pinyin}'
 
-  control :search do
+  form :search do
     title 'Find a Scholar'
     method 'POST'
     media_type 'application/x-www-form-urlencoded'

data/spec/json/confucius.halo.json

@@ -65,14 +65,12 @@
         {
           "name": "name",
           "label": "Scholar Name",
-          "type": "text",
-          "value": null
+          "type": "text"
         },
         {
           "name": "pinyin",
           "label": "Hanyu Pinyin",
-          "type": "text",
-          "value": null
+          "type": "text"
         }
       ]
     }

data/spec/json/plant_collection.collection.json

@@ -27,6 +27,10 @@
           { "rel": "profile", "href": "http://api.example.com/doc/plant" }
         ]
       }
+    ],
+    "links": [
+      { "href": "http://api.example.com/plants", "rel": "self" },
+      { "href": "http://api.example.com/doc/plant_collection", "rel": "profile" }
     ]
   }
 }

data/spec/unit/yaks/attributes_spec.rb

@@ -63,3 +63,82 @@ RSpec.describe Yaks::Attributes do
     end
   end
 end
+
+RSpec.describe Yaks::Attributes::InstanceMethods do
+  let(:widget) do
+    Class.new do
+      include Yaks::Attributes.new(:color, :size, options: {})
+      def self.name ; 'Widget' ; end
+    end
+  end
+
+  let(:widget_container) do
+    Class.new do
+      include Yaks::Attributes.new(widgets: [])
+      def self.name ; 'WidgetContainer' ; end
+    end
+  end
+
+  let(:fixed_width) do
+    Class.new do
+      def initialize(width)
+        @width = width
+      end
+
+      def inspect
+        "#" * @width
+      end
+    end
+  end
+
+  describe '#pp' do
+    it 'should render correctly' do
+      expect(widget_container.new(widgets: [
+                                    widget.new(color: :green, size: 7),
+                                    widget.new(color: :blue, size: 9, options: {foo: :bar})
+                                  ]).pp).to eql "
+WidgetContainer.new(
+  widgets: [
+    Widget.new(color: :green, size: 7),
+    Widget.new(color: :blue, size: 9, options: {:foo=>:bar})
+  ]
+)
+".strip
+    end
+
+    it 'should inline short arrays' do
+      expect(widget_container.new(widgets: [
+                                    fixed_width.new(23),
+                                    fixed_width.new(22)
+                                  ]).pp).to eql "WidgetContainer.new(widgets: [#######################, ######################])"
+    end
+
+    it 'should put longer arrays on multiple lines' do
+      expect(widget_container.new(widgets: [
+                                    fixed_width.new(23),
+                                    fixed_width.new(23)
+                                  ]).pp).to eql "WidgetContainer.new(\n  widgets: [\n    #######################,\n    #######################\n  ]\n)"
+    end
+
+    it 'should puts attributes on multiple lines if total length exceeds 50 chars' do
+      expect(widget.new(color: fixed_width.new(18), size: fixed_width.new(18)).pp).to match /\n/
+      expect(widget.new(color: fixed_width.new(18), size: fixed_width.new(17)).pp).to_not match /\n/
+    end
+  end
+
+  describe '#append_to' do
+    it 'should append to a named collection' do
+      expect(widget_container.new(widgets: [:bar]).append_to(:widgets, :foo)).to eql widget_container.new(widgets: [:bar, :foo])
+    end
+  end
+
+  describe '#initialize' do
+    it 'should take hash-based args' do
+      expect(widget_container.new(widgets: [:bar])).to eql widget_container.new.widgets([:bar])
+    end
+
+    it 'should use defaults when available' do
+      expect(widget.new(color: :blue, size: 3).options).to eql({})
+    end
+  end
+end