rack-unpoly 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '098a6137f012df7a85d6e681805d1051c39cd929'
+  data.tar.gz: 0d89558009d7382033b662c29b7db77888116d01
+SHA512:
+  metadata.gz: 74e384be3125a6c1261d82af9e14f600a4f7622d3a2e36d960f3b27a82b326c342abe87c3c183d78acc522245632a29517c3ef2e062ccab67b1ad9a274796deb
+  data.tar.gz: 66aad412ab1a9cef65fdfb356df68f851efb3a1477433ce65945fd5e2caa80a51f24bac5adb01fd675e90f1b4a4666981d3447d0f4c6f1081cbf11257bf6ca02

data/README.md

@@ -0,0 +1,77 @@
+# Unpoly for Rack & Sinatra
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rack-unpoly"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-unpoly
+
+## Usage in a Rails application
+
+Use the official [Unpoly](https://rubygems.org/gems/unpoly-rails) gem from Makandra.
+
+## Usage in a Sinatra application
+
+```ruby
+require "sinatra/base"
+require "sinatra/unpoly"
+
+class App < Sinatra::Base
+  register Sinatra::Unpoly
+
+  get "/" do
+    if up?
+      "Unpoly request!"
+    else
+      "Not Unpoly :("
+    end
+  end
+end
+```
+
+## Usage in a Roda application
+
+Use the [roda-unpoly](https://rubygems.org/gems/roda-unpoly) gem.
+
+## Usage in a Rack application (that's not Rails, Sinatra, or Roda)
+
+```ruby
+require "rack"
+require "rack/unpoly/middleware"
+
+use Rack::Unpoly::Middleware
+
+run ->(env) { [200, {}, ["Hello World"]] }
+```
+
+## Where are the Javascript and CSS assets?
+
+I've chosen not to bundle those assets with the gem as they might be updated more
+frequently then this library. Most Ruby web libraries outside of Rails are asset-agnostic
+(for the most part), so it's easier if you bring in your assets as you see fit for your
+specific needs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/rack-unpoly.
+
+I love pull requests! If you fork this project and modify it, please ping me to see
+if your changes can be incorporated back into this project.
+
+That said, if your feature idea is nontrivial, you should probably open an issue to
+[discuss it](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)
+before attempting a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/rack/unpoly.rb

@@ -0,0 +1,8 @@
+# frozen-string-literal: true
+require_relative "unpoly/middleware"
+require_relative "unpoly/inspector"
+
+module Rack # :nodoc:
+  module Unpoly # :nodoc:
+  end
+end

data/lib/rack/unpoly/inspector.rb

@@ -0,0 +1,87 @@
+# frozen-string-literal: true
+require "forwardable"
+
+module Rack # :nodoc:
+  module Unpoly # :nodoc:
+    # Easily inspect the Unpoly environment of the current request.
+    # Inspectors are not normally instantiated by users, but accessed
+    # through +env["rack.unpoly"]+ or one of the convenience wrappers
+    # for Roda and Sinatra.
+    class Inspector
+      extend Forwardable
+
+      def_delegators :request, :get_header # :nodoc:
+
+      attr_reader :request # :nodoc:
+
+      def initialize(request) # :nodoc:
+        @request = request
+      end
+
+      # Determine if this is an Unpoly request.
+      def unpoly?
+        target.to_s.strip != ""
+      end
+      alias up? unpoly?
+
+      # Identify if the +tested_target+ will match the actual target requested.
+      def target?(tested_target)
+        query_target(target, tested_target)
+      end
+
+      # The actual target as requested by Unpoly.
+      def target
+        get_header("HTTP_X_UP_TARGET")
+      end
+
+      # The CSS selector for the fragment Unpoly will update if the request fails.
+      # Requires Unpoly >= 0.50
+      def fail_target
+        get_header("HTTP_X_UP_FAIL_TARGET")
+      end
+
+      # Determine if the provided target is the current target for a failed request.
+      # Requires Unpoly >= 0.50
+      def fail_target?(tested_target)
+        query_target(fail_target, tested_target)
+      end
+
+      # Determine if the provided target is the current target for a successful or failed request.
+      def any_target?(tested_target)
+        target?(tested_target) || fail_target?(tested_target)
+      end
+
+      # Set the page title.
+      def set_title(response, new_title)
+        response.headers["X-Up-Title"] = new_title
+      end
+
+      # Determine if this is a validate request.
+      def validate?
+        validate_name.to_s.strip != ""
+      end
+
+      # The name attribute of the form field that triggered
+      # the validation.
+      def validate_name
+        get_header("HTTP_X_UP_VALIDATE")
+      end
+
+      def query_target(actual_target, tested_target) # :nodoc:
+        if up?
+          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
+    end
+  end
+end

data/lib/rack/unpoly/middleware.rb

@@ -0,0 +1,57 @@
+# frozen-string-literal: true
+require_relative "inspector"
+
+module Rack # :nodoc:
+  module Unpoly
+    # Rack Middleware that implements the server protocol expected by Unpoly,
+    # and provides an entry point into the Rack::Unpoly::Inspector for the current
+    # request.
+    #
+    # = Accessing the Rack::Unpoly::Inspector
+    #
+    # An inspector for the current request is available inside +env["rack.unpoly"]+.
+    # You can access any of the inspector methods through this env variable.
+    #
+    #   env["rack.unpoly"].up?
+    #
+    # = Middleware Usage Example
+    #
+    #   require "rack"
+    #   require "rack/unpoly/middleware"
+    #
+    #   use Rack::Unpoly::Middleware
+    #
+    #   run ->(env) { [200, {}, ["Hello World"]] }
+    class Middleware
+      def initialize(app) # :nodoc:
+        @app = app
+      end
+
+      def call(env) # :nodoc:
+        request = Rack::Request.new(env)
+        env["rack.unpoly"] = Inspector.new(request)
+
+        status, headers, response = @app.call(env)
+        setup_protocol(request, headers)
+
+        [status, headers, response]
+      end
+
+      private
+
+      # Implement the *Unpoly* server protocol.
+      # Used internally by the middleware. Not required for normal use.
+      def setup_protocol(request, headers)
+        headers["X-Up-Location"] = request.url
+        headers["X-Up-Method"] = request.request_method
+
+        if !request.get? && !request.env["rack.unpoly"].unpoly?
+          Rack::Utils.set_cookie_header!(headers, "_up_method",
+                                         { value: request.request_method, path: "/" })
+        else
+          Rack::Utils.delete_cookie_header!(headers, "_up_method", { path: "/" })
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/unpoly.rb

@@ -0,0 +1,61 @@
+# frozen-string-literal: true
+require "rack/unpoly/middleware"
+require "delegate"
+
+module Sinatra # :nodoc:
+  # The Unpoly extension for Sinatra provides a little bit of sugar to make
+  # Unpoly work seamlessly with Roda.
+  #
+  #
+  # = Example
+  #
+  #   require "sinatra/base"
+  #   require "sinatra/unpoly"
+  #
+  #   class App < Sinatra::Base
+  #     register Sinatra::Unpoly
+  #
+  #     get "/" do
+  #       if up?
+  #         "Unpoly request!"
+  #       else
+  #         "Not Unpoly :("
+  #       end
+  #     end
+  #   end
+  #
+  module Unpoly
+    class SinatraInspector < DelegateClass(Rack::Unpoly::Inspector)
+      attr_accessor :response # :nodoc:
+
+      def initialize(obj, response) # :nodoc:
+        super(obj)
+        @response = response
+      end
+
+      # Set the page title.
+      def title=(value)
+        set_title(response, value)
+      end
+    end
+
+    module Helpers
+      # The ::Rack::Unpoly inspector for this request.
+      def unpoly
+        SinatraInspector.new(env["rack.unpoly"], response)
+      end
+      alias up unpoly
+
+      # Determine if this is an Unpoly request.
+      def unpoly?
+        unpoly.unpoly?
+      end
+      alias up? unpoly?
+    end
+
+    def self.registered(app) # :nodoc:
+      app.use Rack::Unpoly::Middleware
+      app.helpers Unpoly::Helpers
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: rack-unpoly
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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
+    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: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: adam@mediadrive.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rack/unpoly.rb
+- lib/rack/unpoly/inspector.rb
+- lib/rack/unpoly/middleware.rb
+- lib/sinatra/unpoly.rb
+homepage: https://github.com/adam12/rack-unpoly
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Integrate Unpoly with any Rack or Sinatra application
+test_files: []