roda-unpoly 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 750f490bc31f40dedde2a2494094561c8b865d07
-  data.tar.gz: 6fcaf19eaa0dd9aaf62e2a39e982cdbfaea8b3fb
+  metadata.gz: 2851514cb992b5c57576513afac1309557eb6127
+  data.tar.gz: 7c25677023ad826e5d3ee7263d162429c10c211d
 SHA512:
-  metadata.gz: 3bca31e586e66f5351528d0c11289e72e474ec0204f97b56a3103759c71376338682e691eaa50508ade5ae8b31932918ebec7ac3d206041e09a4e9d4554ee4a4
-  data.tar.gz: 2702023eba6cd543c20ddb40532e282a6fd8675228f1563d9c87ce22938aa052555a46b184a8c4caec234a8afdb4c499a1ccc8e18b30757a7f03d66d1ff7f477
+  metadata.gz: 7a07c1bfba4d348e9126cc5e4e967ce3209af6ba685d1b0a99e0e7737085f7224d7db6163495271245f9ff8bcf7b3663d4e2215ae19b306f693f63cf17e58ecc
+  data.tar.gz: 294899218a907c5f7d7c422302917d13da65162fd1442eebdbf3126b384e6b6b4fa1f9e56a72c5375d4dd91b6721435d0e348ecd5e780a09f3b9ab6d990133b1

data/README.md

@@ -1,6 +1,6 @@
 # Unpoly for Roda
 
-Easily add support for the server protocol expected by Unpoly.
+Easily add support for the server protocol expected by [Unpoly](http://unpoly.com).
 
 ## Installation
 
@@ -20,7 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Fill me in
+In order for roda-unpoly to satisfy the server protocol expected by Unpoly, the
+`r.unpoly` method will need to be called once during your routing tree. Preferably
+near the top.
+
+```ruby
+class App < Roda
+  plugin :unpoly
+
+  route do |r|
+    r.unpoly
+
+    # Rest of routing tree
+  end
+end
+```
+
+Inside the routing tree, some convenience methods are made available to work with
+the Unpoly request.
+
+### Testing for Unpoly request
+
+Use the methods `r.up?`, `r.unpoly?`, `r.up.up?`, or `r.up.unpoly?` (they are
+all aliases of the same method).
+
+### Testing the Unpoly target
+
+Use the method `r.up.target?(your_target)`.
+
+### Testing for Unpoly validate request
+
+Use the method `r.up.validate?`.
+
+### Setting page title
+
+Use the method `r.up.title=`.
 
 ## Where are the Javascript and CSS assets?
 

data/Rakefile

@@ -1,3 +1,18 @@
+require "rake/testtask"
+require "rdoc/task"
 require "rubygems/tasks"
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+  t.verbose = true
+end
+
 Gem::Tasks.new
+
+task default: :test

data/lib/roda/plugins/unpoly.rb

@@ -1,11 +1,72 @@
+# frozen-string-literal: true
+
+require "forwardable"
+
 class Roda
   module RodaPlugins
+    # The unpoly plugin provides the necessary sugar to make Unpoly work seamlessly
+    # with Roda.
+    #
+    #   plugin :unpoly
     module Unpoly
-      module RequestMethods
+      class Inspector
+        extend Forwardable
+
+        def_delegators :@context, :get_header, :response
+
+        def initialize(context) # :nodoc:
+          @context = context
+        end
+
+        # Determine if this is an Unpoly request.
         def unpoly?
           get_header("X-Up-Target").to_s.strip != ""
         end
+        alias up? unpoly?
+
+        # Identify if the +tested_target+ will match the actual target requested.
+        def target?(tested_target)
+          if up?
+            actual_target = target
+
+            if actual_target == tested_target
+              true
+            elsif actual_target == "html"
+              true
+            elsif actual_target == "body"
+              !%w(head title meta).include?(tested_target)
+            else
+              false
+            end
+          else
+            true
+          end
+        end
 
+        # The actual target as requested by Unpoly.
+        def target
+          get_header("X-Up-Target")
+        end
+
+        # Set the page title.
+        def title=(new_title)
+          response.headers["X-Up-Title"] = new_title
+        end
+
+        # Determine if this is a validate request.
+        def validate?
+          get_header("X-Up-Validate").to_s.strip != ""
+        end
+      end
+
+      module RequestMethods
+        extend Forwardable
+
+        def_delegators :up, :unpoly?, :up?
+
+        # Send the appropriate headers and cookies back to the client in order
+        # to satisfy the contract of the Unpoly library. Called early in your
+        # routing tree.
         def unpoly
           response.headers["X-Up-Location"] = path
           response.headers["X-Up-Method"] = request_method
@@ -16,6 +77,11 @@ class Roda
             Rack::Utils.delete_cookie_header!(response.headers, "_up_method")
           end
         end
+
+        # An instance of the +Inspector+.
+        def up
+          Inspector.new(self)
+        end
       end
     end
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: roda-unpoly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Daniels
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !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: 
 email: adam@mediadrive.ca
 executables: []