yaks 0.9.0 → 0.10.0

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

@@ -2,8 +2,9 @@ module Yaks
   class Resource
     class Form
       class Field
-        include Yaks::Mapper::Form::Field.attributes.add(:error => nil)
+        include Yaks::Mapper::Form::Field.attributes.add(error: nil)
 
+        undef value
         def value
           if type.equal? :select
             selected = options.find(&:selected)
@@ -30,9 +31,9 @@ module Yaks
           options.each_with_object([]) do |option, new_opts|
             new_opts << case option
                         when unset
-                          option.update selected: false
+                          option.with selected: false
                         when set
-                          option.update selected: true
+                          option.with selected: true
                         else
                           option
                         end

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

@@ -3,7 +3,7 @@ module Yaks
     class Form
       class Field
         class Option
-          include Yaks::Mapper::Form::Field::Option.attributes
+          include Attribs.new(:value, :label, selected: false, disabled: false)
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Yaks
   class Resource
     class Form
       class Fieldset
-        include Attributes.new(:fields)
+        include Attribs.new(:fields)
         include Yaks::Resource::HasFields
 
         def type

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

@@ -0,0 +1,18 @@
+module Yaks
+  class Resource
+    class Form
+      class Legend
+        include Attribs.new(:label, :type)
+
+        def initialize(opts)
+          super(opts.merge(type: :legend))
+        end
+
+        # Up to 0.9.0 legends were represented as Form::Field
+        # instances with the label stored as name, hence this alias
+        # for compatibility
+        alias_method :name, :label
+      end
+    end
+  end
+end

data/lib/yaks/resource/has_fields.rb

@@ -3,15 +3,21 @@ module Yaks
     module HasFields
       def map_fields(&block)
         with(
-          fields: fields.map do |field|
-            if field.type.equal? :fieldset
-              field.map_fields(&block)
-            else
-              block.call(field)
-            end
-          end
+          fields: fields_flat(&block)
         )
       end
+
+      def fields_flat(&block)
+        return to_enum(__method__) unless block_given?
+        fields.map do |field|
+          next field if field.type.equal? :legend
+          if field.respond_to?(:map_fields)
+            field.map_fields(&block)
+          else
+            block.call(field)
+          end
+        end
+      end
     end
   end
 end

data/lib/yaks/resource/link.rb

@@ -1,7 +1,7 @@
 module Yaks
   class Resource
     class Link
-      include Attributes.new(:rel, :uri, options: {})
+      include Attribs.new(:rel, :uri, options: {})
 
       def title
         options[:title]

data/lib/yaks/runner.rb

@@ -14,7 +14,11 @@ module Yaks
     end
 
     def read
-      Pipeline.new([[:parse, serializer.inverse], [:format, formatter.inverse]]).insert_hooks(hooks).call(object, env)
+      Pipeline.new([[:parse, serializer.inverse], [:read, formatter.inverse]]).insert_hooks(hooks).call(object, env)
+    end
+
+    def format
+      Pipeline.new([[:format, formatter], [:primitivize, primitivizer]]).insert_hooks(hooks).call(object, env)
     end
 
     def map
@@ -82,6 +86,5 @@ module Yaks
     def hooks
       config.hooks + options.fetch(:hooks, [])
     end
-
   end
 end

data/lib/yaks/serializer.rb

@@ -12,7 +12,7 @@ module Yaks
     module JSONWriter
       extend Yaks::FP::Callable
 
-      def self.call(data, env)
+      def self.call(data, _env)
         JSON.pretty_generate(data)
       end
 
@@ -28,7 +28,7 @@ module Yaks
     module JSONReader
       extend Yaks::FP::Callable
 
-      def self.call(data, env)
+      def self.call(data, _env)
         JSON.parse(data)
       end
 
@@ -40,6 +40,5 @@ module Yaks
         JSONWriter
       end
     end
-
   end
 end

data/lib/yaks/util.rb

@@ -7,30 +7,30 @@ module Yaks
 
     def underscore(str)
       str.gsub(/::/, '/')
-        .gsub(/(?<!^|\/)([A-Z])(?=[a-z$])|(?<=[a-z])([A-Z])/, '_\1\2')
+        .gsub(%r{(?<!^|/)([A-Z])(?=[a-z$])|(?<=[a-z])([A-Z])}, '_\1\2')
         .tr("-", "_")
         .downcase
     end
 
     def camelize(str)
-      str.gsub(/\/(.?)/)     { "::#{ $1.upcase }" }
+      str.gsub(%r{/(.?)})    { "::#{ $1.upcase }" }
         .gsub!(/(?:^|_)(.)/) { $1.upcase          }
     end
 
     def slice_hash(hash, *keys)
-      keys.each_with_object({}) {|k,dest| dest[k] = hash[k] if hash.key?(k) }
+      keys.each_with_object({}) {|k, dest| dest[k] = hash[k] if hash.key?(k) }
     end
 
     def reject_keys(hash, *keys)
-      hash.keys.each_with_object({}) {|k,dest| dest[k] = hash[k] unless keys.include?(k) }
+      hash.keys.each_with_object({}) {|k, dest| dest[k] = hash[k] unless keys.include?(k) }
     end
 
     def symbolize_keys(hash)
-      hash.each_with_object({}) {|(k,v), hsh| hsh[k.to_sym] = v}
+      hash.each_with_object({}) {|(k, v), hsh| hsh[k.to_sym] = v}
     end
 
     def extract_options(args)
-      args.last.is_a?(Hash) ? [args[0..-2], args.last] : [args, {}]
+      args.last.instance_of?(Hash) ? [args[0..-2], args.last] : [args, {}]
     end
 
     # Turn what is maybe a Proc into its result (or itself)
@@ -46,7 +46,7 @@ module Yaks
     #   A proc or a plain value
     # @param [Object] context
     #   (optional) A context used to instance_eval the proc
-    def Resolve(maybe_proc, context = nil)
+    def Resolve(maybe_proc, context = nil)    # rubocop:disable Style/MethodName
       if maybe_proc.respond_to?(:to_proc) && !maybe_proc.instance_of?(Symbol)
         if context
           if maybe_proc.arity > 0
@@ -71,6 +71,5 @@ module Yaks
         end
       end
     end
-
   end
 end

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/spec/acceptance/acceptance_spec.rb

@@ -2,59 +2,74 @@ require 'acceptance/models'
 require 'acceptance/json_shared_examples'
 
 RSpec.describe Yaks::Format::Hal do
-  yaks_rel_template = Yaks.new do
-    format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
-    rel_template "http://literature.example.com/rel/{rel}"
-    skip :serialize
-  end
+  let(:format_name) { :hal }
 
-  yaks_policy_dsl = Yaks.new do
-    format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
-    derive_rel_from_association do |association|
-      "http://literature.example.com/rel/#{association.name}"
-    end
-    skip :serialize
+  context 'with a configured rel template' do
+    let(:yaks_config) {
+      Yaks.new do
+        format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
+        rel_template "http://literature.example.com/rel/{rel}"
+      end
+    }
+
+    include_examples 'JSON Writer',     'confucius'
+    include_examples 'JSON round trip', 'confucius'
   end
 
-  include_examples 'JSON output format', yaks_rel_template, :hal, 'confucius'
-  include_examples 'JSON output format', yaks_policy_dsl,   :hal, 'confucius'
+  context 'with a rel computed by a policy override' do
+    let(:yaks_config) {
+      Yaks.new do
+        format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
+        derive_rel_from_association do |association|
+          "http://literature.example.com/rel/#{association.name}"
+        end
+      end
+    }
 
-  include_examples 'JSON round trip',    yaks_rel_template, :hal, 'confucius'
-  include_examples 'JSON round trip',    yaks_policy_dsl,   :hal, 'confucius'
+    include_examples 'JSON Writer',     'confucius'
+    include_examples 'JSON round trip', 'confucius'
+    include_examples 'JSON Writer',     'list_of_quotes'
+    include_examples 'JSON round trip', 'list_of_quotes'
+  end
 end
 
 RSpec.describe Yaks::Format::Halo do
-  yaks = Yaks.new do
-    default_format :halo
-    rel_template "http://literature.example.com/rel/{rel}"
-    skip :serialize
-  end
+  let(:format_name) { :halo }
+  let(:yaks_config) {
+    Yaks.new do
+      default_format :halo
+      rel_template "http://literature.example.com/rel/{rel}"
+    end
+  }
 
-  include_examples 'JSON output format', yaks, :halo, 'confucius'
+  include_examples 'JSON Writer', 'confucius'
 end
 
 RSpec.describe Yaks::Format::JsonAPI do
-  config = Yaks.new do
-    default_format :json_api
-    skip :serialize
-  end
+  let(:format_name) { :json_api }
+  let(:yaks_config) { Yaks.new }
 
-  include_examples 'JSON output format', config, :json_api, 'confucius'
-  include_examples 'JSON round trip',    config, :json_api, 'confucius'
+  include_examples 'JSON Writer', 'confucius'
+  # include_examples 'JSON Reader', 'confucius'
+  include_examples 'JSON round trip', 'confucius'
+  include_examples 'JSON Writer', 'list_of_quotes'
+  # include_examples 'JSON round trip', 'list_of_quotes'
 end
 
 RSpec.describe Yaks::Format::CollectionJson do
-  youtypeit_yaks = Yaks.new do
-    default_format :collection_json
-    mapper_namespace Youtypeitwepostit
-    skip :serialize
-  end
+  let(:format_name) { :collection_json }
+  let(:yaks_config) { Yaks.new }
 
-  confucius_yaks = Yaks.new do
-    default_format :collection_json
-    skip :serialize
-  end
+  include_examples 'JSON Writer', 'confucius'
+  include_examples 'JSON Writer', 'list_of_quotes'
 
-  include_examples 'JSON output format', youtypeit_yaks, :collection, 'youtypeitwepostit'
-  include_examples 'JSON output format', confucius_yaks, :collection, 'confucius'
+  context 'with a namespace' do
+    let(:yaks_config) {
+      Yaks.new do
+        mapper_namespace Youtypeitwepostit
+      end
+    }
+
+    include_examples 'JSON Writer',  'youtypeitwepostit'
+  end
 end

data/spec/acceptance/json_shared_examples.rb

@@ -1,19 +1,52 @@
-RSpec.shared_examples_for 'JSON output format' do |yaks, format, name|
-  let(:input)  { load_yaml_fixture(name) }
-  let(:output) { load_json_fixture("#{name}.#{format}") }
+RSpec.shared_examples_for 'JSON Writer' do |fixture_name|
+  describe 'Yaks::Resource => JSON' do
+    let(:object)  { load_yaml_fixture(fixture_name) }
+    let(:json_fixture) { load_json_fixture("#{fixture_name}.#{format_name}") }
+    let(:serialized) {
+      yaks_config.call(object, hooks: [[:skip, :serialize]], format: format_name)
+    }
 
-  subject { yaks.call(input) }
+    # before do
+    #   puts "============================expected========================================="
+    #   puts JSON.pretty_generate(expected)
+    #   puts "=================yaks.call(object, format: #{format.inspect})================"
+    #   puts JSON.pretty_generate(serialized)
+    # end
 
-  it { should deep_eql output }
+    it 'should match the JSON fixture' do
+      expect(serialized).to deep_eql json_fixture
+    end
+  end
 end
 
-RSpec.shared_examples_for 'JSON round trip' do |yaks, format, name|
-  let(:json) { load_json_fixture("#{name}.#{format}") }
+RSpec.shared_examples_for 'JSON Reader' do |fixture_name|
+  describe 'JSON => Yaks::Resource' do
+    let(:object) { load_yaml_fixture(fixture_name) }
+    let(:json_fixture) { load_json_fixture("#{fixture_name}.#{format_name}") }
+    let(:resource) {
+      yaks_config.read(json_fixture, hooks: [[:skip, :parse]], format: format_name)
+    }
 
-  subject {
-    resource = yaks.read(json, hooks: [[:skip, :parse]])
-    yaks.call(resource, hooks: [[:skip, :map]], mapper: Struct.new(:context))
-  }
+    it 'should equal the corresponding Yaks::Resource' do
+      # Comparing type+to_h to get better RSpec output upon failure
+      expect(resource).to be_a Yaks::Resource
+      expect(resource.to_h).to eql yaks.map(object).to_h
+    end
+  end
+end
+
+RSpec.shared_examples_for 'JSON round trip' do |fixture_name|
+  describe 'JSON => Yaks::Resource => JSON' do
+    let(:json_fixture) { load_json_fixture("#{fixture_name}.#{format_name}") }
+    let(:read_and_written) {
+      config = yaks_config.with(default_format: format_name)
+      config.format(
+        config.read(json_fixture, hooks: [[:skip, :parse]])
+      )
+    }
 
-  it { should deep_eql json }
+    specify 'it should be identical' do
+      expect(read_and_written).to deep_eql json_fixture
+    end
+  end
 end

data/spec/acceptance/models.rb

@@ -45,7 +45,7 @@ end
 class WorkMapper < LiteratureBaseMapper
   attributes :id, :chinese_name, :english_name
   has_many :quotes
-  has_one  :era
+  has_one :era
 end
 
 class QuoteMapper < Yaks::Mapper

data/spec/integration/dynamic_form_fields_spec.rb

@@ -17,7 +17,6 @@ RSpec.describe 'dynamic form fields' do
   let(:object) { [:a, :b, :c] }
 
   it 'should create dynamic form fields' do
-
     expect(yaks.map(object, mapper: mapper)).to eql Yaks::Resource.new(
       type: :awesome,
       forms: [

data/spec/integration/fieldset_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe 'dynamic form fields' do
           fields: [
             Yaks::Resource::Form::Fieldset.new(
               fields: [
-                Yaks::Resource::Form::Field.new(name: "I am legend", type: :legend),
+                Yaks::Resource::Form::Legend.new(label: "I am legend", type: :legend),
                 Yaks::Resource::Form::Field.new(name: :bar, type: :text)
               ]
             )
@@ -36,25 +36,23 @@ RSpec.describe 'dynamic form fields' do
     expect(
       yaks.with(default_format: :halo, hooks: [[:skip, :serialize]]).call(:foo, mapper: mapper)
     ).to eql(
-      {
-        "_controls" => {
-          "foo" => {
-            "name" =>"foo",
-            "fields" => [
-              {
-                "type" => "fieldset",
-                "fields" => [
-                  {
-                    "name" => "I am legend",
-                    "type" => "legend"
-                  }, {
-                    "name" => "bar",
-                    "type" => "text"
-                  }
-                ]
-              }
-            ]
-          }
+      "_controls" => {
+        "foo" => {
+          "name" => "foo",
+          "fields" => [
+            {
+              "type" => "fieldset",
+              "fields" => [
+                {
+                  "label" => "I am legend",
+                  "type" => "legend"
+                }, {
+                  "name" => "bar",
+                  "type" => "text"
+                }
+              ]
+            }
+          ]
         }
       }
     )