RubyGems - hmote-render - Versions diffs - 1.0.0 - Mend

hmote-render 1.0.0

Files changed (12) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81f2808f5ce2776937ffa5469f230cae0d9cfe40
+  data.tar.gz: 550d47748f0a4b79d94fd4f009f4d09ab372b6ba
+SHA512:
+  metadata.gz: a61ac7fbe6c69414ae179623b41a470144de85e5dda8bc204125be3aba5e9e3342916df08edb0dfe19f0a174ae561ac42451690e8d550652816c48d55aafaf40
+  data.tar.gz: c8fdc7797699a6d1daa7dd2113f57c330dd51802514cd7a65f1c3a5adb0ac63dcef658b9f7fddaca4b4511a1e81a6a4c0f0efa51495bd058d11e73c044b08ebd

data/.gems ADDED

@@ -0,0 +1,4 @@
+cuba -v 3.4.0
+cutest -v 1.2.2
+hmote -v 1.3.0
+rack-test -v 0.6.3

data/LICENSE ADDED

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2015 Francesco Rodríguez
+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 ADDED

@@ -0,0 +1,101 @@
+hmote-render
+============
+HMote plugin for Cuba.
+Usage
+-----
+To use HMote in [Cuba][cuba], you need to load the `HMote::Render`
+plugin as shown below:
+```ruby
+require "hmote"
+require "hmote/render"
+Cuba.plugin(HMote::Render)
+```
+`HMote::Render` provides three helper methods for rendering templates:
+`partial`, `view` and `render`.
+```ruby
+Cuba.define do
+  on "about" do
+    # `partial` renders a template without a layout.
+    res.write partial("about")
+  end
+  on "home" do
+    # `view` renders a template within a layout.
+    res.write view("about")
+  end
+  on "contact" do
+    # `render` is a shortcut to `res.write view(...)`
+    render("contact")
+  end
+end
+```
+By default, `HMote::Render` assumes that all view templates are placed
+in a folder named `views` and that they use the `.mote` extension. Also
+for `view` and `render` methods, it assumes that the layout template is
+called `layout.mote`.
+The defaults can be changed through the `layout` and `view_path` class
+methods:
+```ruby
+class App < Cuba
+  layout("admin")
+  view_path("views/admin")
+end
+```
+Layouts
+-------
+To render inner content into a layout, use the `{{! content }}` tag.
+```html
+<html>
+  <head>
+    <title>Mote Layout</title>
+  </head>
+  <body>
+    <h1>Hello, world!</h1>
+    {{! content }}
+  </body>
+</html>
+```
+Helpers
+-------
+You can use the `app` variable to access the application helpers.
+```ruby
+Cuba.define do
+  def h(unsafe)
+    ...
+  end
+end
+```
+```html
+<h1>{{! app.h("unsafe") }}</h1>
+{{ app.partial("list") }}
+```
+Installation
+------------
+```
+$ gem install hmote-render
+```
+[cuba]: http://cuba.is
+[mote]: https://github.com/soveran/mote

data/hmote-render.gemspec ADDED

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = "hmote-render"
+  s.version     = "1.0.0"
+  s.summary     = "HMote plugin for Cuba"
+  s.description = s.summary
+  s.authors     = ["Francesco Rodríguez"]
+  s.email       = ["frodsan@protonmail.ch"]
+  s.homepage    = "https://github.com/harmoni/hmote-render"
+  s.license     = "MIT"
+  s.files = `git ls-files`.split("\n")
+  s.add_dependency "hmote", "~> 1.3"
+  s.add_development_dependency "cuba", "3.4.0"
+  s.add_development_dependency "cutest", "1.2.2"
+  s.add_development_dependency "rack-test", "0.6.3"
+end

data/lib/hmote/render.rb ADDED

@@ -0,0 +1,42 @@
+require "hmote"
+module HMote::Render
+  include HMote::Helpers
+  CONTENT_TYPE = "Content-Type".freeze
+  DEFAULT_CONTENT_TYPE = "text/html; charset=utf-8".freeze
+  def self.setup(app)
+    app.settings[:hmote] ||= {}
+    app.layout("layout")
+    app.view_path("views")
+  end
+  def render(template, params = {}, layout = settings[:hmote][:layout])
+    res.headers[CONTENT_TYPE] ||= DEFAULT_CONTENT_TYPE
+    res.write(view(template, params, layout))
+  end
+  def view(template, params = {}, layout = settings[:hmote][:layout])
+    return partial(layout, params.merge(content: partial(template, params)))
+  end
+  def partial(template, params = {})
+    return hmote(template_path(template), params.merge(app: self), TOPLEVEL_BINDING)
+  end
+  def template_path(template)
+    return File.join(settings[:hmote][:views], "#{template}.mote")
+  end
+  module ClassMethods
+    def layout(name)
+      settings[:hmote][:layout] = name
+    end
+    def view_path(path)
+      settings[:hmote][:views] = File.expand_path(path, Dir.pwd)
+    end
+  end
+end

data/makefile ADDED

	@@ -0,0 +1,2 @@
1	+ default:
2	+ cutest test/*.rb

data/test/render.rb ADDED

@@ -0,0 +1,56 @@
+require "cutest"
+require "cuba/test"
+require_relative "../lib/hmote/render"
+Cuba.plugin(HMote::Render)
+Cuba.settings[:hmote][:views] = "./test/views"
+Cuba.define do
+  def name
+    "App"
+  end
+  on "partial" do
+    res.write partial("home")
+  end
+  on "view" do
+    res.write view("home", title: "Hello")
+  end
+  on "render" do
+    render("home", title: "Hola")
+  end
+  on "context" do
+    res.write partial("context")
+  end
+end
+scope do
+  test "view renders view with layout" do
+    expected = "<title>Hello</title>\n<h1>Home</h1>"
+    get "/view"
+    assert last_response.body[expected]
+  end
+  test "partial renders view without layout" do
+    get "/partial"
+    assert last_response.body["<h1>Home</h1>"]
+  end
+  test "render renders view with layout" do
+    get "/render"
+    assert last_response.body["<title>Hola</title>\n<h1>Home</h1>"]
+  end
+  test "access to application context" do
+    get "/context"
+    assert last_response.body["App"]
+  end
+end

data/test/views/context.mote ADDED

	@@ -0,0 +1 @@
1	+ {{ app.name }}

data/test/views/home.mote ADDED

	@@ -0,0 +1 @@
1	+ <h1>Home</h1>

data/test/views/layout.mote ADDED

	@@ -0,0 +1,2 @@
1	+ <title>{{ title }}</title>
2	+ {{! content }}

metadata ADDED

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: hmote-render
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hmote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: HMote plugin for Cuba
+email:
+- frodsan@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- LICENSE
+- README.md
+- hmote-render.gemspec
+- lib/hmote/render.rb
+- makefile
+- test/render.rb
+- test/views/context.mote
+- test/views/home.mote
+- test/views/layout.mote
+homepage: https://github.com/harmoni/hmote-render
+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.4.8
+signing_key:
+specification_version: 4
+summary: HMote plugin for Cuba
+test_files: []