yaks-html 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00098aaad249008d6a0748ed5d94483be2eb6694
-  data.tar.gz: e870922d4a96e4bd90ca12c31c4b5be8e71e0428
+  metadata.gz: af536b85c5b8ec153e5c803ddb0051a84bb0b284
+  data.tar.gz: e9de84047d31aecab97ed462262e972d10da57b3
 SHA512:
-  metadata.gz: 73a42d1ca3639992a8ac660d15e5359d8e9647e67e0a5cc75aaa78eedad9cac63b01b0cf611bfc8e0fc9deb1a02d9636c6611e8bfb5ac787740580fb8e129766
-  data.tar.gz: 625d9f5d71a110d4c07383e6cca9a69fb27a89dbe1595591931c305e76804f5e1aad00134da11ad4bc720e1ae24b99646aade45aec92485268bee34ea623a550
+  metadata.gz: 610b56a2df54cf21201f8c6627a05a9ccecd9439515512f85146753267ddf2003d91712f304b3c080bcdcfea80abe4e51058a9c8aaec1ae535983bcc02547cb3
+  data.tar.gz: fdad369fdf7116bf6da5551643c7d97f1fb08e1f42b0bb181d716021c23ad76311a4c71f8939cd72546d6ceb23000d6aa7e6f2fc27be947c63b390a215062d65

data/README.md

@@ -1,3 +1,44 @@
 A HTML output format for Yaks.
 
 Browse your hypermedia API like a good old fashioned web site.
+
+You can see an example output at
+[https://myticketsireland.ticketsolve.com/api/](https://myticketsireland.ticketsolve.com/api/)
+(visit the [front page](https://myticketsireland.ticketsolve.com/)
+first to make sure you have some necessary cookies).
+
+For APIs that make good use of links and forms this provides a great
+help during development. It also makes it possible to write
+integration tests against the HTML output using Capybara.
+
+We currently provide a small DSL and RSpec integration to make this easy. For example:
+
+```
+require 'yaks-html/rspec'
+
+RSpec.describe Yaks::Format::HTML, type: :yaks_integration do
+  before do
+    Capybara.app = YourRackApp
+  end
+
+  let(:rel_prefix) { 'http://myapi.example.com/rel/' }
+
+  it 'should allow browsing the api' do
+    visit '/'
+
+    click_rel('friends') # => clicks http://myapi.example.com/rel/friends
+
+    expect(current_path).to eql '/friends'
+
+    expect(page).to have_content 'Matt'
+
+    submit_form(:poke) do
+      fill_in :message, with: 'Would you fancy some tea?'
+    end
+
+    expect(current_path).to eql '/poke/Matt'
+
+    expect(page).to have_content 'You poked Matt: Would you fancy some tea?'
+  end
+end
+```

data/Rakefile

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

data/lib/yaks-html/rspec.rb

@@ -0,0 +1,73 @@
+require 'yaks-html'
+require 'capybara/rspec'
+
+module YaksHTML
+  # This is a bit of a hack. The only way to add custom rack env
+  # entries to Capybara/Rack::Test is through the driver options (see
+  # Capybara.register_driver below). However this is only executed
+  # once, so throughout the whole test suite the same instance of the
+  # hash we pass will be used. To make it a bit easier to set/reset
+  # this we add this layer of indirection. Now what we pass the driver
+  # looks like a hash, but we can point it to a new hash with
+  # RACK_ENV.__setobj__({})
+
+  RACK_ENV = SimpleDelegator.new({})
+
+  module CapybaraDSL
+    def self.included(base)
+      base.class_eval do
+        let(:rel_prefix) { '' }
+      end
+    end
+
+    def click_rel(rel)
+      rel = [rel_prefix, rel].join unless rel.is_a? Symbol
+      find("a[rel=\"#{rel}\"]").click
+    end
+
+    def click_first_rel(rel)
+      rel = [rel_prefix, rel].join unless rel.is_a? Symbol
+      all("a[rel=\"#{rel}\"]").first.click
+    end
+
+    def submit!
+      find('input[type="submit"]').click
+    end
+
+    def within_form(name, &block)
+      within(all("form[@name=\"#{name}\"]").first, &block)
+    end
+
+    def submit_form(name, &block)
+      within(all("form[@name=\"#{name}\"]").first) do
+        yield block
+        submit!
+      end
+    end
+
+    def refresh
+      visit current_path
+    end
+
+    def env
+      YaksHTML::RACK_ENV
+    end
+  end
+end
+
+RSpec.configure do |config|
+  select = {type: :yaks_integration}
+
+  config.include Capybara::DSL, select
+  config.include Capybara::RSpecMatchers, select
+
+  config.include YaksHTML::CapybaraDSL, select
+
+  config.before(select) do
+    YaksHTML::RACK_ENV.__setobj__('HTTP_ACCEPT' => 'text/html')
+  end
+end
+
+Capybara.register_driver :rack_test do |app|
+  Capybara::RackTest::Driver.new(app, headers: YaksHTML::RACK_ENV)
+end

data/lib/yaks/format/html.rb

@@ -12,7 +12,7 @@ module Yaks
       end
 
       def section(name)
-        template.select(".#{name}").first   # rubocop:disable Performance/Detect
+        template.select(".#{name}").first
       end
 
       def serialize_resource(resource)
@@ -120,22 +120,32 @@ module Yaks
       end
 
       def render_field(field)
-        extra_info = reject_keys(field.to_h_compact, :type, :name, :value, :label, :options)
+        attrs = field.to_h_compact
+
+        if attrs.key? :checked
+          if attrs[:checked]
+            attrs[:checked] = 'checked'
+          else
+            attrs.delete(:checked)
+          end
+        end
+
+        extra_info = reject_keys(attrs, :type, :name, :value, :label, :options)
         H[:tr,
           H[:td,
             H[:label, {for: field.name}, [field.label || field.name.to_s, field.required ? '*' : ''].join]],
           H[:td,
             case field.type
             when /select/
-              H[:select, reject_keys(field.to_h_compact, :options), render_select_options(field.options)]
+              H[:select, reject_keys(attrs, :options), render_select_options(field.options)]
             when /textarea/
-              H[:textarea, reject_keys(field.to_h_compact, :value), field.value || '']
+              H[:textarea, reject_keys(attrs, :value), field.value || '']
             when /hidden/
               [ field.value.inspect,
-                H[:input, field.to_h_compact]
+                H[:input, attrs]
               ]
             else
-              H[:input, field.to_h_compact]
+              H[:input, attrs]
             end],
           H[:td, extra_info.empty? ? '' : extra_info.inspect]
          ]

data/spec/smoke_test_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require_relative 'support/test_app'
+
+RSpec.describe Yaks::Format::HTML, type: :yaks_integration do
+  before do
+    Capybara.app = TestApp
+  end
+
+  let(:rel_prefix) { 'http://myapi.example.com/rel/' }
+
+  it 'should allow browsing the api' do
+    visit '/'
+
+    expect(page).to have_content 'GET /'
+    expect(page).to have_content 'generated with Yaks'
+
+    click_rel('friends')
+
+    expect(current_path).to eql '/friends'
+
+    expect(page).to have_content 'GET /friends'
+    expect(page).to have_content 'Matt'
+
+    submit_form(:poke) do
+      fill_in :message, with: 'Free the means of production'
+    end
+
+    expect(current_path).to eql '/poke/Matt'
+
+    expect(page).to have_content 'You poked Matt: Free the means of production'
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
-RSpec.configure do |rspec|
-  rspec.include FixtureHelpers
-  rspec.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
-  rspec.disable_monkey_patching!
-  rspec.raise_errors_for_deprecations!
-end
+require 'yaks'
+require 'yaks-html/rspec'
+require 'yaks-sinatra'
+
+require_relative '../../shared/rspec_config'

data/spec/support/test_app.rb

@@ -0,0 +1,44 @@
+class TestApp < Sinatra::Base
+  register Yaks::Sinatra
+
+  class HomeMapper < Yaks::Mapper
+    link 'http://myapi.example.com/rel/friends', '/friends'
+  end
+
+  class FriendMapper < Yaks::Mapper
+    attribute :name
+
+    def name
+      object[:name]
+    end
+
+    form :poke do
+      action '/poke/{name}'
+      method 'POST'
+      text :message
+    end
+  end
+
+  class MessageMapper < Yaks::Mapper
+    attribute :message do
+      object[:message]
+    end
+  end
+
+  configure_yaks do
+    mapper_for :home, HomeMapper
+    rel_template 'http://myapi.example.com/rel/{rel}'
+  end
+
+  get '/' do
+    yaks :home
+  end
+
+  get '/friends' do
+    yaks [{name: 'Matt'}, {name: 'Yohan'}, {name: 'Janko'}], item_mapper: FriendMapper
+  end
+
+  post '/poke/:name' do
+    yaks({message: "You poked #{params[:name]}: #{params[:message]}"}, mapper: MessageMapper)
+  end
+end

data/yaks-html.gemspec

@@ -22,4 +22,9 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'yaks', Yaks::VERSION
   gem.add_runtime_dependency 'hexp', '>= 0.4'
+
+  gem.add_development_dependency 'yaks-sinatra'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'capybara'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks-html
 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: hexp
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yaks-sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: HTML output format for Yaks
 email:
 - arne@arnebrasseur.net
@@ -49,9 +105,12 @@ files:
 - README.md
 - Rakefile
 - lib/yaks-html.rb
+- lib/yaks-html/rspec.rb
 - lib/yaks/format/html.rb
 - lib/yaks/format/template.html
+- spec/smoke_test_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_app.rb
 - yaks-html.gemspec
 homepage: https://github.com/plexus/yaks
 licenses:
@@ -73,9 +132,11 @@ 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: HTML output format for Yaks
 test_files:
+- spec/smoke_test_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_app.rb