yaks-html 0.6.0.alpha → 0.6.0.alpha.1

data/yaks/lib/yaks/primitivize.rb

@@ -1,45 +0,0 @@
-module Yaks
-  class Primitivize
-
-    attr_reader :mappings
-
-    def initialize
-      @mappings = {}
-    end
-
-    def call(object)
-      mappings.each do |pattern, block|
-        return instance_exec(object, &block) if pattern === object
-      end
-      raise "don't know how to turn #{object.class} (#{object.inspect}) into a primitive"
-    end
-
-    def map(*types, &blk)
-      types.each do |type|
-        mappings[type] = blk
-      end
-    end
-
-    def self.create
-      new.tap do |p|
-        p.map String, Numeric, true, false, nil do |object|
-          object
-        end
-
-        p.map Symbol do |object|
-          object.to_s
-        end
-
-        p.map Hash do |object|
-          object.to_enum.with_object({}) do |(key, value), output|
-            output[call(key)] = call(value)
-          end
-        end
-
-        p.map Enumerable do |object|
-          object.map(&method(:call))
-        end
-      end
-    end
-  end
-end

data/yaks/lib/yaks/resource.rb

@@ -1,51 +0,0 @@
-module Yaks
-  class Resource
-    include Equalizer.new(:type, :links, :attributes, :subresources)
-    include FP::HashUpdatable.new(:type, :links, :attributes, :subresources)
-    include Enumerable
-
-    attr_reader :type, :attributes, :links, :subresources
-
-    def initialize(options = {})
-      @type         = options.fetch(:type, nil)
-      @attributes   = options.fetch(:attributes, {})
-      @links        = options.fetch(:links, [])
-      @subresources = options.fetch(:subresources, {})
-    end
-
-    def [](attr)
-      attributes[attr]
-    end
-
-    def each
-      return to_enum unless block_given?
-      yield self
-    end
-
-    def self_link
-      links.reverse.find do |link|
-        link.rel.equal? :self
-      end
-    end
-
-    def collection?
-      false
-    end
-
-    def null_resource?
-      false
-    end
-
-    def update_attributes(new_attrs)
-      update(attributes: @attributes.merge(new_attrs))
-    end
-
-    def add_link(link)
-      update(links: @links + [link])
-    end
-
-    def add_subresource(rel, subresource)
-      update(subresources: @subresources.merge(rel => subresource))
-    end
-  end
-end

data/yaks/lib/yaks/resource/link.rb

@@ -1,21 +0,0 @@
-module Yaks
-  class Resource
-    class Link
-      include Equalizer.new(:rel, :uri, :options)
-
-      attr_reader :rel, :uri, :options
-
-      def initialize(rel, uri, options)
-        @rel, @uri, @options = rel, uri, options
-      end
-
-      def title
-        options[:title]
-      end
-
-      def templated?
-        options.fetch(:templated) { false }
-      end
-    end
-  end
-end

data/yaks/lib/yaks/runner.rb

@@ -1,101 +0,0 @@
-module Yaks
-  class Runner
-    include Util
-    include Anima.new(:object, :config, :options)
-    include Adamantium::Flat
-    extend Forwardable
-
-    def_delegators :config, :policy, :default_format, :format_options, :primitivize, :serializers, :hooks
-
-    def call
-      steps.inject(object) {|memo, (_, step)| step.call(memo) }
-    end
-
-    def context
-      {
-        policy: policy,
-        env: env,
-        mapper_stack: []
-      }.merge(slice_hash(options, :item_mapper))
-    end
-    memoize :context, freezer: :flat
-
-    def env
-      options.fetch(:env, {})
-    end
-    memoize :env, freezer: :noop
-
-    # @return [Class]
-    def format_class
-      Format.by_accept_header(env['HTTP_ACCEPT']) {
-        Format.by_name(options.fetch(:format) { default_format })
-      }
-    end
-    memoize :format_class
-
-    def steps
-      insert_hooks(
-        [[ :map, mapper ],
-         [ :format, formatter ],
-         [ :primitivize, primitivizer],
-         [ :serialize, serializer ]])
-    end
-    memoize :steps
-
-    def mapper
-      options.fetch(:mapper) do
-        policy.derive_mapper_from_object(object)
-      end.new(context)
-    end
-    memoize :mapper, freezer: :noop
-
-    def formatter
-      format_class.new(format_options[format_name])
-    end
-    memoize :formatter
-
-    def primitivizer
-      ->(input) do
-        if format_class.serializer == :json
-          primitivize.call(input)
-        else
-          input
-        end
-      end
-    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) do
-        policy.serializer_for_format(format_class)
-      end
-    end
-    memoize :serializer
-
-    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
-            case type
-            when :before
-              [[name, hook], [step_name, callable]]
-            when :after
-              [[step_name, callable], [name, hook]]
-            when :around
-              [[step_name, ->(x) { hook.call(x, &callable) }]]
-            when :skip
-              []
-            end
-          end || [[step_name, callable]]
-        end
-      end
-    end
-  end
-end

data/yaks/lib/yaks/util.rb

@@ -1,56 +0,0 @@
-# -*- coding: utf-8 -*-
-module Yaks
-  module Util
-    extend self
-    extend Forwardable
-
-    def_delegators Inflection, :singular, :singularize, :pluralize
-
-    def underscore(str)
-      str.gsub(/::/, '/')
-        .gsub(/(?<!^|\/)([A-Z])(?=[a-z$])|(?<=[a-z])([A-Z])/, '_\1\2')
-        .tr("-", "_")
-        .downcase
-    end
-
-    def camelize(str)
-      str.gsub(/\/(.?)/)     { "::#{ $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) }
-    end
-
-    # Turn what is maybe a Proc into its result (or itself)
-    #
-    # When input can be either a value or a proc that returns a value,
-    # this conversion function can be used to resolve the thing to a
-    # value.
-    #
-    # The proc can be evaluated (instance_evaled) in a certain context,
-    # or evaluated as a closure.
-    #
-    # @param [Object|Proc] maybe_proc
-    #   A proc or a plain value
-    # @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 context
-          if maybe_proc.arity > 0
-            context.instance_eval(&maybe_proc)
-          else
-            # In case it's a lambda with zero arity instance_eval fails
-            context.instance_exec(&maybe_proc)
-          end
-        else
-          maybe_proc.()
-        end
-      else
-        maybe_proc
-      end
-    end
-
-  end
-end

data/yaks/lib/yaks/version.rb

@@ -1,3 +0,0 @@
-module Yaks
-  VERSION = '0.6.0.alpha'
-end

data/yaks/spec/acceptance/acceptance_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-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/{association_name}"
-    skip :serialize
-  end
-
-  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
-  end
-
-  include_examples 'JSON output format' , yaks_rel_template , :hal , 'confucius'
-  include_examples 'JSON output format' , yaks_policy_dsl   , :hal , 'confucius'
-end
-
-RSpec.describe Yaks::Format::JsonAPI do
-  config = Yaks.new do
-    default_format :json_api
-    skip :serialize
-  end
-
-  include_examples 'JSON output format' , config , :json_api , 'confucius'
-end
-
-RSpec.describe Yaks::Format::CollectionJson do
-  youtypeit_yaks = Yaks.new do
-    default_format :collection_json
-    namespace Youtypeitwepostit
-    skip :serialize
-  end
-
-  confucius_yaks = Yaks.new do
-    default_format :collection_json
-    skip :serialize
-  end
-
-  include_examples 'JSON output format', youtypeit_yaks, :collection, 'youtypeitwepostit'
-  include_examples 'JSON output format', confucius_yaks, :collection, 'confucius'
-end

data/yaks/spec/acceptance/json_shared_examples.rb

@@ -1,8 +0,0 @@
-RSpec.shared_examples_for 'JSON output format' do |yaks, format, name|
-  let(:input)  { load_yaml_fixture(name) }
-  let(:output) { load_json_fixture("#{name}.#{format}") }
-
-  subject { yaks.serialize(input) }
-
-  it { should deep_eql output }
-end

data/yaks/spec/acceptance/models.rb

@@ -1,48 +0,0 @@
-require 'anima'
-
-class Scholar
-  include Anima.new(:id, :name, :pinyin, :latinized, :works)
-end
-
-class Work
-  include Anima.new(:id, :chinese_name, :english_name, :quotes, :era)
-end
-
-class Quote
-  include Anima.new(:id, :chinese, :english, :sources)
-end
-
-class Era
-  include Anima.new(:id, :name)
-end
-
-class LiteratureBaseMapper < Yaks::Mapper
-  link :profile, 'http://literature.example.com/profiles/{mapper_name}', expand: true
-  link :self, 'http://literature.example.com/{mapper_name}/{id}'
-end
-
-class ScholarMapper < LiteratureBaseMapper
-  attributes :id, :name, :pinyin, :latinized
-  has_many :works
-
-  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}'
-
-  def downcased_pinyin
-    object.pinyin.downcase
-  end
-end
-
-class WorkMapper < LiteratureBaseMapper
-  attributes :id, :chinese_name, :english_name
-  has_many :quotes
-  has_one  :era
-end
-
-class QuoteMapper < Yaks::Mapper
-  attributes :id, :chinese
-end
-
-class EraMapper < Yaks::Mapper
-  attributes :id, :name
-end

data/yaks/spec/fixture_helpers.rb

@@ -1,14 +0,0 @@
-require 'yaml'
-require 'json'
-
-module FixtureHelpers
-  module_function
-
-  def load_json_fixture(name)
-    JSON.parse(Yaks::Root.join('spec/json', name + '.json').read)
-  end
-
-  def load_yaml_fixture(name)
-    YAML.load(Yaks::Root.join('spec/yaml', name + '.yaml').read)
-  end
-end

data/yaks/spec/integration/map_to_resource_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe 'Mapping domain models to Resource objects' do
-  include_context 'fixtures'
-  include_context 'yaks context'
-
-  subject { mapper.call(john) }
-  let(:mapper) { FriendMapper.new(yaks_context) }
-
-  it { should be_a Yaks::Resource }
-  its(:type)         { should eql 'friend' }
-  its(:attributes)   { should eql(id: 1, name: 'john') }
-  its(:links)        { should eql [ Yaks::Resource::Link.new(:copyright, '/api/copyright/2024', {}) ] }
-
-  its(:subresources) {
-    should eq(
-      "rel:pet_peeve" => Yaks::Resource.new(type:'pet_peeve', attributes: {id: 4, type: 'parsing with regexps'}),
-      "rel:pets" => Yaks::CollectionResource.new(
-        type: 'pet',
-        members: [
-          Yaks::Resource.new(type: 'pet', attributes: {:id => 2, :species => "dog", :name => "boingboing"}),
-          Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
-        ],
-        collection_rel: 'rel:pets'
-      )
-    )
-  }
-end

data/yaks/spec/json/confucius.collection.json

@@ -1,28 +0,0 @@
-{
-  "collection": {
-    "version": "1.0",
-    "href": "http://literature.example.com/authors/kongzi",
-    "items": [
-      {
-        "href": "http://literature.example.com/authors/kongzi",
-        "data": [
-          { "name": "id",         "value": 9           },
-          { "name": "name",       "value": "孔子"      },
-          { "name": "pinyin",     "value": "Kongzi"    },
-          { "name": "latinized",  "value": "Confucius" }
-        ],
-        "links": [
-          {
-            "rel": "profile",
-            "href": "http://literature.example.com/profiles/scholar"
-          },
-          {
-            "name": "Search for quotes",
-            "rel": "http://literature.example.com/rels/quotes",
-            "href": "http://literature.example.com/quotes/?author=kongzi&q={query}"
-          }
-        ]
-      }
-    ]
-  }
-}