yaks-sinatra 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b8d0cab9f9d94ee17327cd7820ba568a47c8b0f
-  data.tar.gz: 77136f4984461ec883d62667579fd80a75e43b1d
+  metadata.gz: 4dc7bd3869510736d87c46e96be148a9ca257968
+  data.tar.gz: ea5bf1fd71db1dbfaa0332b4154087b0b4e606ac
 SHA512:
-  metadata.gz: 8e25bd3e7beca062da86c6422c66fe4fd128b6542e94063050304b4a9fe086747735c12ca78b8af7bead0c280944df630e774c4a78da64d3c90f777b02324714
-  data.tar.gz: 6dea67ec3c24dd0a3bbcf019d8cb6f1935419de50d1ecb80511ff59dca213edbad7fc192dc6f448d0a2fad90ef973dcbb36c4d5f0a680b76f564433a05dfcb09
+  metadata.gz: 752a4c4f33aaf9117c1fd08f6724584f74100fd09e0d1fe1ad0a8507ed65cfb532f50e32e963ad6cf13107df56be4c4813bcc4cd8b7dc1050f9d9c8db3fd1869
+  data.tar.gz: 1fce79637a67ac4d2006c663bbcc2b7b2ed9e4547bca7052fd4edf5490320ccd83c3c55880728a4238675f3ef130f469f312e1d6412034d26ff20e0c9739451e

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/README.md

@@ -3,7 +3,10 @@ Provide basic integration for using Yaks in sinatra. It gives you a top level `c
 This will register all media types known to Yaks, make sure the right one is picked based on the `Accept` header, and it will put the correct `Content-Type` header on the response.
 
 
-``` ruby
+In a classic Sinatra app, you use it like so:
+
+```ruby
+require 'sinatra'
 require 'yaks-sinatra'
 
 configure_yaks do
@@ -28,3 +31,20 @@ get '/posts' do
   yaks Post.all
 end
 ```
+
+In a modular Sinatra app, you need to register the extension explicitly:
+
+```ruby
+require 'sinatra/base'
+require 'yaks-sinatra'
+
+class MyApp < Sinatra::Base
+  register Yaks::Sinatra
+
+  configure_yaks do
+    # ...
+  end
+
+  # ...
+end
+```

data/Rakefile

@@ -1,3 +1,3 @@
-load '../rakelib/shared.rake'
+load '../shared/rake_tasks.rb'
 
 gem_tasks(:"yaks-sinatra")

data/lib/yaks-sinatra.rb

@@ -1,14 +1,22 @@
 require 'sinatra/base'
 require 'yaks'
 
-module Sinatra
-  module Yaks
+module Yaks
+  module Sinatra
     class << self
       attr_accessor :yaks_config
     end
 
+    module Helpers
+      def yaks(object, opts = {})
+        runner = Yaks::Sinatra.yaks_config.runner(object, {env: env}.merge(opts))
+        content_type runner.format_name
+        runner.call
+      end
+    end
+
     def configure_yaks(&block)
-      Yaks.yaks_config = ::Yaks.new(&block)
+      Yaks::Sinatra.yaks_config = ::Yaks.new(&block)
 
       configure do
         ::Yaks::Format.all.each do |format|
@@ -16,16 +24,20 @@ module Sinatra
         end
       end
     end
-  end
 
-  module YaksHelpers
-    def yaks(object, opts = {})
-      runner = Yaks.yaks_config.runner(object, {env: env}.merge(opts))
-      content_type runner.format_name
-      runner.call
+    def self.registered(app)
+      app.helpers(Yaks::Sinatra::Helpers)
+
+      ::Yaks::Format.all.each do |format|
+        app.settings.add_charset << format.media_type
+      end
+
+      # app.configure_yaks
     end
   end
+end
 
-  register Yaks
-  helpers YaksHelpers
+# For classic apps
+module Sinatra
+  register Yaks::Sinatra
 end

data/spec/integration/classic_app.rb

@@ -0,0 +1,16 @@
+require 'sinatra'
+require 'yaks-sinatra'
+
+Root = Class.new(Struct.new(:name))
+
+class RootMapper < Yaks::Mapper
+  link :self, '/'
+end
+
+set :default_charset, 'utf-8'
+
+configure_yaks
+
+get '/' do
+  yaks Root.new('root'), mapper: RootMapper
+end

data/spec/integration/classic_spec.rb

@@ -0,0 +1,25 @@
+require 'integration_helper'
+require_relative 'classic_app.rb'
+
+RSpec.describe 'Sinatra Classic app integration', type: :integration do
+  include Yaks::Sinatra::Test::ClassicApp::Helpers
+
+  ::Yaks::Format.all.each do |format|
+    context "For #{format.format_name}" do
+      it "returns 200" do
+        make_req(format.media_type)
+        expect(last_response).to be_ok
+      end
+
+      it "respects the Accept header" do
+        make_req(format.media_type)
+        expect(last_content_type.type).to eq(format.media_type)
+      end
+
+      it "returns an explicit charset" do
+        make_req(format.media_type)
+        expect(last_content_type.charset).to eq('utf-8')
+      end
+    end
+  end
+end

data/spec/integration/modular_spec.rb

@@ -0,0 +1,24 @@
+require 'integration_helper'
+
+RSpec.describe 'Sinatra Modular app integration', type: :integration do
+  include Yaks::Sinatra::Test::ModularApp::Helpers
+
+  ::Yaks::Format.all.each do |format|
+    context "For #{format.format_name}" do
+      it "returns 200" do
+        make_req(format.media_type)
+        expect(last_response).to be_ok
+      end
+
+      it "respects the Accept header" do
+        make_req(format.media_type)
+        expect(last_content_type.type).to eq(format.media_type)
+      end
+
+      it "returns an explicit charset" do
+        make_req(format.media_type)
+        expect(last_content_type.charset).to eq('utf-8')
+      end
+    end
+  end
+end

data/spec/integration_helper.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'yaks-sinatra'
+require 'rack/test'
+
+ENV['RACK_ENV'] = 'test'
+
+class MediaType
+  QUOTED_STRING = '[\w!#$%&\'()*+,-./:;<=>?@\[\]\\\\^`{|}~ \t\r\n]+'
+  TOKEN = '[\w!\#$%&\'*+-.^`|~]+'
+  TYPE_AND_SUBTYPE = "(?<maintype>#{TOKEN})/(?<subtype>#{TOKEN})"
+  PARAMETER_VALUE = "(?:(?<value>#{TOKEN})|\"(?<q_value>#{QUOTED_STRING})\")"
+  PARAMETER_RE = /\s*;\s*(?<name>#{TOKEN})\s*=\s*#{PARAMETER_VALUE}/m
+  MEDIA_TYPE_RE = /^#{TYPE_AND_SUBTYPE}/
+
+  def initialize(header_string)
+    @header_string = header_string
+  end
+
+  def type_and_rest
+    @type_and_rest ||= begin
+      type_match = MEDIA_TYPE_RE.match(@header_string)
+      return ["", ""] if type_match.nil?
+      @main_type = type_match['maintype']
+      @sub_type = type_match['subtype']
+      type = type_match.to_s
+      rest = @header_string[type.length..-1]
+      [type, rest]
+    end
+  end
+
+  def parameters
+    @parameters ||= begin
+      _, rest = type_and_rest
+      parameters = {}
+      rest.scan(PARAMETER_RE) do |name, value, q_value|
+        parameters[name] = value || q_value
+      end
+      parameters
+    end
+  end
+
+  def type
+    @type ||= type_and_rest[0]
+  end
+
+  def main_type
+    @main_type || type_and_rest && @main_type
+  end
+
+  def sub_type
+    @sub_type || type_and_rest && @sub_type
+  end
+
+  def charset
+    parameters['charset']
+  end
+end
+
+module Yaks
+  module Sinatra
+    module Test
+      module Helpers
+        def make_req(mime_type = 'application/hal+json')
+          header 'Accept', mime_type
+          get '/'
+        end
+
+        def last_content_type
+          MediaType.new(last_response.content_type)
+        end
+      end
+
+      class ModularApp < ::Sinatra::Base
+        module Helpers
+          include Yaks::Sinatra::Test::Helpers
+
+          def app
+            Yaks::Sinatra::Test::ModularApp
+          end
+        end
+
+        Root = Class.new(Struct.new(:name))
+
+        class RootMapper < Yaks::Mapper
+          link :self, '/'
+        end
+
+        register Yaks::Sinatra
+
+        set :default_charset, 'utf-8'
+
+        configure_yaks
+
+        get '/' do
+          yaks Root.new('root'), mapper: RootMapper
+        end
+      end
+
+      module ClassicApp
+        module Helpers
+          include Yaks::Sinatra::Test::Helpers
+
+          def app
+            ::Sinatra::Application
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods, type: :integration
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../../shared/rspec_config'

data/yaks-sinatra.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'yaks', Yaks::VERSION
   gem.add_runtime_dependency 'sinatra', '~> 1.4'
+  gem.add_development_dependency 'rack-test', '~> 0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks-sinatra
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaks
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Sinatra integration for Yaks
 email:
 - arne@arnebrasseur.net
@@ -46,9 +60,15 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".rspec"
 - README.md
 - Rakefile
 - lib/yaks-sinatra.rb
+- spec/integration/classic_app.rb
+- spec/integration/classic_spec.rb
+- spec/integration/modular_spec.rb
+- spec/integration_helper.rb
+- spec/spec_helper.rb
 - yaks-sinatra.gemspec
 homepage: https://github.com/plexus/yaks
 licenses:
@@ -70,8 +90,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Sinatra integration for Yaks
-test_files: []
+test_files:
+- spec/integration/classic_app.rb
+- spec/integration/classic_spec.rb
+- spec/integration/modular_spec.rb
+- spec/integration_helper.rb
+- spec/spec_helper.rb