rack-component 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb150ff5c8b988370259759086c1775d851c5d7b302c223bbd1a1ecf03eaf62
-  data.tar.gz: 2d298170408b3ff3893353ba62becbfa88212168cd7f3e212aad4011d2c39e2c
+  metadata.gz: c5f073b2ec6adad102c5fb898e7071c7531663960f6188c678a1b46c7f564e2f
+  data.tar.gz: f0bbc1b2c7cee8fca01ec2f7e0d75b0ca260428e24a50ec6f28a9a70e714b6f7
 SHA512:
-  metadata.gz: debdc05c3a309c2ed25334124f3bcfc726c4d92e15fe517d7946f48944ecd78239fb32bb4305f64ee7632bbc7235d6b065f08aefb88bd2b050a01bd9998cc03f
-  data.tar.gz: f365e4454d2189123524f86cf3f845f06f974beb6d0f4993aaf921523464469b2a1041d10d0db6889fcd493c0a3740a1d9755361d996d886eb79c39f9b85e05b
+  metadata.gz: bdfd59e87eccbc6cc0be4a92579813d76195d14e0cfb3620f6ec3a3204730cb8ba35f528d59e260db268bb2a697acb1bb6ccf3c8615fbb52979aa67e15e91858
+  data.tar.gz: 76ab042215b76839bab82c36ac19682da07050ed0da54d714ffc6e609160ef360962e445b4ef9f71ade86e35ff2dc65668ace167880c92203c4da565f4d09036

data/.reek.yml

@@ -6,6 +6,10 @@ detectors:
   NestedIterators:
     ignore_iterators:
       - each_object
+  UtilityFunction:
+    enabled: false
+  UncommunicativeMethodName:
+    enabled: false
 exclude_paths:
   - bin
   - client

data/.travis.yml

@@ -1,5 +1,4 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-component (0.4.1)
+    rack-component (0.4.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,8 @@
 # Rack::Component
 
 Like a React.js component, a `Rack::Component` implements a `render` method that
-takes input data and returns what to display.
+takes input data and returns what to display. You can use Components instead of
+Controllers, Views, Templates, and Helpers, in any Rack app.
 
 ## Install
 
@@ -11,6 +12,32 @@ Add `rack-component` to your Gemfile and run `bundle install`:
 gem 'rack-component'
 ```
 
+## Quickstart with Sinatra
+```ruby
+# config.ru
+require 'sinatra'
+require 'rack/component'
+
+class Hello < Rack::Component
+  render do |env|
+    "<h1>Hello, #{h(env[:name])}</h1>"
+  end
+end
+
+get '/hello/:name' do
+  Hello.call(name: params[:name])
+end
+
+run Sinatra::Application
+```
+
+**Note that Rack::Component currently does not escape strings by default**. To
+escape strings, you must use the `#h` helper, as in the example above.
+
+There is an [issue open](https://github.com/chrisfrank/rack-component/issues/4)
+to discuss how to enable escaping by default. If you have ideas or opinions, I'd
+love to hear about them there.
+
 ## Table of Contents
 
 * [Getting Started](#getting-started)

data/lib/rack/component.rb

@@ -1,5 +1,6 @@
 require_relative 'component/version'
 require_relative 'component/memory_cache'
+require 'cgi'
 
 module Rack
   # Subclass Rack::Component to compose functional, declarative responses to
@@ -117,5 +118,14 @@ module Rack
     end
 
     attr_reader :env
+
+    # @example Strip HTML entities from a string
+    #   class SafeComponent < Rack::Component
+    #     render { |env| h(env[:name]) }
+    #   end
+    #   SafeComponent.call(name: '<h1>hi</h1>') #=> &lt;h1&gt;hi&lt;/h1&gt;
+    def h(obj)
+      CGI.escapeHTML(obj.to_s)
+    end
   end
 end

data/lib/rack/component/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Component
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-component
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Chris Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips