yaks-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0b188779102f23074095a7df3fa7dcb7f0aea31
+  data.tar.gz: 19baa136f08468ebd6507600f5256ef512e36ea0
+SHA512:
+  metadata.gz: a0fbece8dd84ef53d94f86c350c5a79390a1b4a49d4a86d1da5a130d9c6aebb2efdd9192a1b16a41f43a7925c3f1603853eccc792eb1d5e149794a6f4ed2ddf5
+  data.tar.gz: 5b3fdf254c3937593641be50673561d15629d911589220489db65d1fd986556a287fb5aaed70f3a1c37e52dfa4bd2eedc4e076a683a1d1de1708a181518626a7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaks-simple.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hobofan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Yaks::Simple
+
+This gem adds the `:simple_json` format to yaks.
+`:simple_json` completely ignores the purpose of yaks to build a hypermedia API
+and currently doesn't render any links, just resource attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaks-simple'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaks-simple
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yaks-simple/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/yaks/format/simple_json.rb

@@ -0,0 +1,71 @@
+module Yaks
+  class Format
+    class SimpleJson < self
+      register :simple_json, :json, 'application/json'
+
+      include FP
+
+      # @param [yaks::resource] resource
+      # @return [hash]
+      def serialize_resource(resource)
+        result = {}
+        items = if resource.is_a?(Yaks::CollectionResource)
+                  resource.members.map {|r| serialize_item(r)}
+                else
+                  serialize_item(resource.attributes)
+                end
+        result[pluralize(resource.type)] = items
+
+        result
+      end
+
+      # @param [yaks::resource] resource
+      # @return [hash]
+      def serialize_item(resource)
+        resource.attributes
+      end
+
+      # @param [Yaks::Resource] subresource
+      # @return [Hash]
+      def serialize_links(subresources)
+        {}
+      end
+
+      # @param [Yaks::Resource] resource
+      # @return [Array, String]
+      def serialize_link(resource)
+        {}
+      end
+
+      # @param [Hash] subresources
+      # @param [Array] array
+      # @return [Array]
+      def serialize_linked_subresources(subresources, array)
+        []
+      end
+
+      # @param [Array] resources
+      # @param [Array] linked
+      # @return [Array]
+      def serialize_linked_resources(subresource, linked)
+        []
+      end
+
+      # {shows => [{id: 3, name: 'foo'}]}
+      #
+      # @param [Yaks::Resource] resource
+      # @param [Hash] linked
+      # @return [Hash]
+      def serialize_subresource(resource, linked)
+        serialize_resource(resource)
+      end
+
+      def inverse
+        Yaks::Reader::SimpleJson.new
+      end
+    end
+
+    class Reader
+    end
+  end
+end

data/lib/yaks/reader/simple_json.rb

@@ -0,0 +1,21 @@
+module Yaks
+  module Reader
+    class SimpleJson
+      def call(parsed_json, env = {})
+        type = env[:type] || parsed_json.first.first
+        attributes = env[:attributes] || parsed_json[type]
+
+        if attributes.is_a? Array
+          attributes = attributes.dup
+          members = attributes.map { |r| call(r, type: type, attributes: r) }
+          CollectionResource.new(members: members, type: Util.singularize(type))
+        else
+          Resource.new(
+            type: Util.singularize(type),
+            attributes: Util.symbolize_keys(attributes)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yaks/simple.rb

@@ -0,0 +1,11 @@
+require "yaks/simple/version"
+
+require 'yaks/format/simple_json'
+require 'yaks/reader/simple_json'
+
+module Yaks
+  module Simple
+    # Set the Root constant as the gems root path
+    Root = Pathname(__FILE__).join('../../..')
+  end
+end

data/lib/yaks/simple/version.rb

@@ -0,0 +1,5 @@
+module Yaks
+  module Simple
+    VERSION = "0.0.1"
+  end
+end

data/spec/acceptance/json_shared_examples.rb

@@ -0,0 +1,19 @@
+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.call(input) }
+
+  it { should deep_eql output }
+end
+
+RSpec.shared_examples_for 'JSON round trip' do |yaks, format, name|
+  let(:json) { load_json_fixture("#{name}.#{format}") }
+
+  subject {
+    resource = yaks.read(json, hooks: [[:skip, :parse]])
+    yaks.call(resource, hooks: [[:skip, :map]], mapper: Struct.new(:context))
+  }
+
+  it { should deep_eql json }
+end

data/spec/acceptance/simple_json_spec.rb

@@ -0,0 +1,11 @@
+require 'acceptance/json_shared_examples'
+
+describe Yaks::Format::SimpleJson do
+  config = Yaks.new do
+    default_format :simple_json
+    skip :serialize
+  end
+
+  include_examples 'JSON output format', config, :simple_json, 'confucius'
+  include_examples 'JSON round trip',    config, :simple_json, 'confucius'
+end

data/spec/fixture_helpers.rb

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

data/spec/json/confucius.simple_json.json

@@ -0,0 +1,10 @@
+{
+  "scholars": [
+    {
+      "id": 9,
+      "name": "孔子",
+      "pinyin": "Kongzi",
+      "latinized": "Confucius"
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+require 'yaks'
+require 'yaks/simple'
+
+require 'fixture_helpers'
+
+require_relative 'support/deep_eql'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include FixtureHelpers
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/deep_eql.rb

@@ -0,0 +1,123 @@
+# When comparing deep nested structures, it can be really hard to figure out what
+# the actual differences are looking at the RSpec output. This custom matcher
+# traverses nested hashes and arrays recursively, and reports each difference
+# separately, with a JSONPath string of where the difference was found
+#
+# e.g.
+#
+# at $.shows[0].venues[0].name, got Foo, expected Bar
+
+module Matchers
+  class DeepEql
+    extend Forwardable
+    attr_reader :expectation, :stack, :target, :diffs, :result
+    def_delegators :stack, :push, :pop
+
+    def initialize(expectation, stack = [], diffs = [])
+      @expectation = expectation
+      @stack       = stack
+      @diffs       = diffs
+      @result      = true
+    end
+
+    def description
+      'be deeply equal'
+    end
+
+    def recurse(target, expectation)
+      @result &&= DeepEql.new(expectation, stack, diffs).matches?(target)
+    end
+
+    def stack_as_jsonpath
+      '$' + stack.map do |item|
+        case item
+        when Integer, /\W/
+          "[#{item.inspect}]"
+        else
+          ".#{item}"
+        end
+      end.join
+    end
+
+    def add_failure_message(message)
+      diffs << "at %s, %s" % [stack_as_jsonpath, message]
+      @result = false
+    end
+
+    def compare(key)
+      push key
+      if target[key] != expectation[key]
+        if [Hash, Array].any?{|klz| target[key].is_a? klz }
+          recurse(target[key], expectation[key])
+        else
+          add_failure_message begin
+                            if expectation[key].class == target[key].class
+                              "expected #{expectation[key].inspect}, got #{target[key].inspect}"
+                            else
+                              "expected #{expectation[key].class}: #{expectation[key].inspect}, got #{target[key].class}: #{target[key].inspect}"
+                            end
+                          rescue Encoding::CompatibilityError
+                            "expected #{expectation[key].encoding}, got #{target[key].encoding}"
+                          end
+        end
+      end
+      pop
+    end
+
+    def matches?(target)
+      @target = target
+
+      case expectation
+      when Hash
+        if target.is_a?(Hash)
+          if target.class != expectation.class # e.g. HashWithIndifferentAccess
+            add_failure_message("expected #{expectation.class}, got #{target.class}")
+          end
+          (expectation.keys - target.keys).each do |key|
+            add_failure_message "Expected key #{key}"
+          end
+          (target.keys - expectation.keys).each do |key|
+            add_failure_message "Unexpected key #{key}"
+          end
+          (target.keys | expectation.keys).each do |key|
+            compare key
+          end
+        else
+          add_failure_message("expected Hash got #{@target.inspect}")
+        end
+
+      when Array
+        if target.is_a?(Array)
+          0.upto([target.count, expectation.count].max) do |idx|
+            compare idx
+          end
+        else
+          add_failure_message("expected Array got #{@target.inspect}")
+        end
+
+      else
+        if target != expectation
+          add_failure_message("expected #{expectation.inspect}, got #{@target.inspect}")
+        end
+      end
+
+      result
+    end
+
+    def failure_message_for_should
+      diffs.join("\n")
+    end
+    alias failure_message failure_message_for_should
+
+    def failure_message_for_should_not
+      "expected #{@target.inspect} not to be in deep_eql with #{@expectation.inspect}"
+    end
+    alias failure_message_when_negated failure_message_for_should_not
+  end
+end
+
+module RSpec::Matchers
+  def deep_eql(exp)
+    Matchers::DeepEql.new(exp)
+  end
+end

data/yaks-simple.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaks/simple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaks-simple"
+  spec.version       = Yaks::Simple::VERSION
+  spec.authors       = ["Maximilian Goisser"]
+  spec.email         = ["goisser94@gmail.com"]
+  spec.summary       = %q{Simple JSON Format that ignores most of yaks features.}
+  spec.description   = %q{Simple JSON Format that ignores most of yaks features.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yaks", "~> 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: yaks-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maximilian Goisser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Simple JSON Format that ignores most of yaks features.
+email:
+- goisser94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yaks/format/simple_json.rb
+- lib/yaks/reader/simple_json.rb
+- lib/yaks/simple.rb
+- lib/yaks/simple/version.rb
+- spec/acceptance/json_shared_examples.rb
+- spec/acceptance/simple_json_spec.rb
+- spec/fixture_helpers.rb
+- spec/json/confucius.simple_json.json
+- spec/spec_helper.rb
+- spec/support/deep_eql.rb
+- yaks-simple.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple JSON Format that ignores most of yaks features.
+test_files:
+- spec/acceptance/json_shared_examples.rb
+- spec/acceptance/simple_json_spec.rb
+- spec/fixture_helpers.rb
+- spec/json/confucius.simple_json.json
+- spec/spec_helper.rb
+- spec/support/deep_eql.rb