grape-erb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61c271263ad70c27a490f61a1b66a8f3dbaa92ae
+  data.tar.gz: 0679c58edfcadfbe1b977ad4901a8f26cdc48b80
+SHA512:
+  metadata.gz: ccf0a0e9c335105d927b977803f018012d524b0a6e94b223c5a42827f221583473e11f44bf0a549f21075b2ac898bfe722807edbf34084a1dd17e770ddfca585
+  data.tar.gz: d9074b3abbd5fe1a5135ec194beaf9da02c3be632ac0d0313146a087146d3829840b20fad750d0b66ba6ab7678861fec5d413a35a9cf939ccd18be6237bbea84

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+#### Next
+
+* Your contribution here.
+
+#### v0.0.1
+
+* Initial public release. [@Howl](https://github.com/mimosa)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Howl Wong
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# Grape::Erb
+
+Use [Erb](https://github.com/mimosa/erb) templates in [Grape](https://github.com/intridea/grape)!
+
+## Installation
+
+Add the `grape` and `grape-erb` gems to Gemfile.
+
+```ruby
+gem 'grape'
+gem 'grape-erb'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Setup view root directory
+```ruby
+# config.ru
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+```
+
+### Tell your API to use Grape::Formatter::Erb
+
+```ruby
+class API < Grape::API
+  content_type :json, 'application/json'
+  content_type :html, 'text/html'
+  formatter :html, Grape::Formatter::Erb
+  format :html
+end
+```
+
+### Use erb templates conditionally
+
+Add the template name to the API options.
+
+```ruby
+get "/user/:id", erb: "users/show" do
+  @user = User.find(params[:id])
+end
+```
+
+You can use instance variables in the Erb template.
+
+```ruby
+<% unless @user.nil? %>
+  <h2><%= @user.name %></h2>
+  <p><%= @user.bio %></p>
+<% end %>
+```
+
+### Use erb layout
+
+Gape-erb first looks for a layout file in `#{env['api.tilt.root']}/layouts/application.html.erb`.
+
+You can override the default layout conventions:
+
+```ruby
+# config.ru
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+  env['api.tilt.layout'] = 'layouts/another'
+end
+```
+
+### Enable template caching
+
+Grape-erb allows for template caching after templates are loaded initially.
+
+You can enable template caching:
+
+```ruby
+# config.ru
+Grape::Erb.configure do |c|
+  c.cache_template_loading = true # default: false
+end
+```
+
+## You can omit .erb
+
+The following are identical.
+
+```ruby
+get "/home", erb: "view"
+get "/home", erb: "view.html.erb"
+```
+
+## Usage with rails
+
+Create grape application
+
+```ruby
+# app/api/user.rb
+class MyAPI < Grape::API
+  content_type :json, 'application/json'
+  content_type :js,   'text/javascript'
+  content_type :html, 'text/html'
+  
+  formatter :html, Grape::Formatter::Erb
+  formatter :js,   Grape::Formatter::Erb
+
+  format :json # Default format
+
+  get '/user/:id' do
+    env['api.format'] = :html
+    content_type 'text/html'
+
+    @user = User.find(params[:id])
+
+    render erb: 'users/show'
+  end
+end
+```
+
+```ruby
+# app/views/api/user.html.erb
+<% unless @user.nil? %>
+  <h2><%= @user.name %></h2>
+  <p><%= @user.bio %></p>
+<% end %>
+```
+
+Edit your **config/application.rb** and add view path
+
+```ruby
+# application.rb
+class Application < Rails::Application
+  config.middleware.use(Rack::Config) do |env|
+    env['api.tilt.root'] = Rails.root.join "app", "views", "api"
+  end
+end
+```
+
+## Specs
+
+See ["Writing Tests"](https://github.com/intridea/grape#writing-tests) in [https://github.com/intridea/grape](grape) README.
+
+Enjoy :)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/grape-erb.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape-erb/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Howl王"]
+  gem.email         = ["howl.wong@gmail.com"]
+  gem.description   = %q{Use erb in grape}
+  gem.summary       = %q{Use erb in grape}
+  gem.homepage      = "https://github.com/mimosa/grape-erb"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.name          = "grape-erb"
+  gem.require_paths = ["lib"]
+  gem.version       = Grape::Erb::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_dependency "grape"
+  gem.add_dependency "erubis"
+  gem.add_dependency "tilt"
+  gem.add_dependency "i18n"
+end

data/lib/grape-erb.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+require 'grape'
+require 'grape/erb'
+require 'grape-erb/version'
+require 'grape-erb/formatter'
+require 'grape-erb/renderer'

data/lib/grape-erb/formatter.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+module Grape
+  module Erb
+    class Formatter
+      attr_reader :env, :endpoint, :object, :options
+
+      def initialize(object, env)
+        @env      = env
+        @endpoint = env['api.endpoint']
+        @object   = object
+
+        @options  = {
+          erb: env['api.tilt.erb'],
+          format: env['api.format'],
+          locals: env['api.tilt.erb.locals'],
+          view_path: env['api.tilt.root']
+        }
+      end
+
+      def call(opts={})
+        @options.merge!(opts)
+        if template?
+          output = erb_template(template).render(endpoint, locals)
+          layout = layout_name
+          return layout.nil? ? output : erb_template(layout).render(endpoint, locals) { output }
+        else
+          fail 'missing erb template'
+        end 
+      end
+
+      private
+
+      def view_path(view_name)
+        view_name += ".#{@options[:format]}.erb" unless view_name =~ /.erb$/
+        File.join(@options[:view_path], view_name)
+      end
+
+      def template?
+        !!template
+      end
+
+      def locals
+        @options[:locals] || endpoint.options[:route_options][:locals] || {}
+      end
+
+      def template
+        @options[:erb] || endpoint.options[:route_options][:erb]
+      end
+
+      def erb_template(view_name)
+        _path = view_path(view_name)
+        ::Tilt::ErubisTemplate.new(_path, @options)
+      end
+
+      def layout_name
+        view_name = (env['api.tilt.layout'] || 'layouts/application')
+        view_name if File.exist?( view_path(view_name) )
+      end
+    end
+  end
+end

data/lib/grape-erb/renderer.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+module Grape
+  module Erb
+    module Renderer
+      # 
+      JS_ESCAPE_MAP = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'" }
+      # 
+      def render(opts = {})
+        Grape::Erb::Formatter.new(nil, env).call(opts)
+      end
+      # 
+      def escape_javascript(javascript)
+        result = ''
+        if javascript
+          result += javascript.gsub(/(\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] }
+        end
+        result
+      end
+    end
+  end
+end
+
+Grape::Endpoint.send(:include, Grape::Erb::Renderer)

data/lib/grape-erb/version.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+module Grape
+  module Erb
+    VERSION = '0.0.1'
+  end
+end

data/lib/grape/erb.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+require 'grape-erb'
+
+module Grape
+  module Formatter
+    module Erb
+      class << self
+        def call(object, env)
+          fail "Use Rack::Config to set 'api.tilt.root' in config.ru" unless env['api.tilt.root']
+          Grape::Erb::Formatter.new(object, env).call
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: grape-erb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Howl王
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use erb in grape
+email:
+- howl.wong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- grape-erb.gemspec
+- lib/grape-erb.rb
+- lib/grape-erb/formatter.rb
+- lib/grape-erb/renderer.rb
+- lib/grape-erb/version.rb
+- lib/grape/erb.rb
+homepage: https://github.com/mimosa/grape-erb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Use erb in grape
+test_files: []