wouter-views 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94b3cf7bfeda14996d0ce25902ae19b84d1725024ce8a2102301506f604f16e7
+  data.tar.gz: f66c1a22ef7a29404d2fd1638a450afc2a3e0c91062c5de7f5135eea3fafc753
+SHA512:
+  metadata.gz: c21209a777a3e10c13eb89aea1eda11509c399fd31b964f752962366afd14f6ad65151a91ad0e31aff0339db7d439aa79b2010d87415de8cc79032b30dfe365d
+  data.tar.gz: f57188ad1839a905358fcd791c54c3a84157425f6850c07865efa5ecc747ed0924d3a144ab58df5fbbfabb2d072c97e5649b1eedd164d0f47bc3687d5ae92045

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# Wouter Views
+
+Adds view template support to the Wouter web framework.
+
+`wouter-views` uses [Tilt](https://github.com/rtomayko/tilt) to load Ruby template engines.
+
+## Usage
+
+Require the gem after your `wouter` require.
+
+```ruby
+require 'wouter'
+require 'wouter/views'
+```
+
+Render a view directly in your route definition:
+
+```ruby
+class Routes < Wouter
+  get '/', render_view(:index)
+end
+```
+
+Render a view in your endpoint:
+
+```ruby
+class Index < Wouter::Endpoint
+  def respond
+    render_view :index
+  end
+end
+```
+
+## Configuration
+
+### View Directory
+
+By default, the view folder is set to `./views`. You can set the view directory using `view_dir`:
+
+```ruby
+class Routes < Wouter
+  view_dir './template/views'
+
+  get '/', render_view(:index)
+end
+```
+
+### Template Engine
+
+By default, `wouter-views` will look for `.html` files. You can specify which templating engine to use and it will try to find the file:
+
+```ruby
+get '/', render_view(:index, engine: :slim)
+```
+
+You can also change the engine globally:
+
+```ruby
+class Routes < Wouter
+  view_engine :slim
+
+  get '/', render_view(:index)
+end
+```
+
+If you provide a string with a file extension, `wouter-views` will first try to find the file with the given engine extension. If it does not find it, it will try to find the file given the literal string value. This allows you to load any file:
+
+```ruby
+class Routes < Wouter
+  get '/', render_view('randomfile.extension')
+end
+```
+
+[Tilt](https://github.com/rtomayko/tilt) will try to auto-load the appropriate templating engine. It is recommended you load the template engine library yourself. Example:
+
+```ruby
+require 'wouter'
+require 'wouter/views'
+require 'slim'
+
+class Routes < Wouter
+  get '/', render_view(:index, engine: :slim)
+end
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup(:default, :test)
+
+desc 'Run tests'
+task :test do
+  require_relative './test/helper'
+
+  Dir['test/**/*_test.rb'].each do |file|
+    load file
+  end
+end

data/lib/wouter/views.rb

@@ -0,0 +1,62 @@
+require 'wouter'
+require 'rack'
+require 'tilt'
+
+class Wouter
+  class Views
+    class FileNotFound < StandardError; end
+
+    def self.file_finder(dir, template, engine, bind)
+      file_name = template.to_s + '.' + engine.to_s
+      full_path = dir + '/' + file_name
+
+      return Tilt.new(full_path).render(bind) if File.exists?(full_path)
+
+      full_path = dir + '/' + template
+
+      if Tilt.template_for('./test/fixtures/views/fallback.txt')
+        Tilt.new(full_path).render(bind)
+      else
+        if File.exists?(full_path)
+          File.read(full_path)
+        else
+          raise FileNotFound, "could not find file: #{full_path}"
+        end
+      end
+    end
+  end
+end
+
+class Wouter
+  class <<self
+    def render_template(template, bind = self, engine = nil)
+      dir = @view_dir || File.expand_path('./views')
+      engine = engine || @view_engine || :html
+      Wouter::Views.file_finder(dir, template, engine, bind)
+    end
+
+    def render_view(template, engine: nil)
+      lambda { |env|
+        response = Rack::Response.new
+        response.write render_template(template, self, engine)
+        response.finish
+      }
+    end
+
+    def view_dir(dir = nil)
+      @view_dir = dir unless dir.nil?
+      @view_dir
+    end
+
+    def view_engine(engine = nil)
+      @view_engine = engine unless engine.nil?
+      @view_engine
+    end
+  end
+
+  class Endpoint
+    def render_view(template, engine: nil)
+      Wouter.render_template(template, self, engine)
+    end
+  end
+end

data/wouter-views.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'wouter-views'
+  s.platform    = Gem::Platform::RUBY
+  s.version     = '0.0.1'
+  s.summary     = 'View template support for Wouter web framework.'
+  s.description = 'Adds view template support to the Wouter web framework.'
+  s.authors     = ['Robert Peterson']
+  s.email       = 'robertpeterson@gmail.com'
+  s.files       = Dir['lib/**/*'] + ['README.md', 'Gemfile', 'Rakefile', 'wouter-views.gemspec']
+  s.test_files  = s.files.select { |p| p =~ /^test\/.*_test.rb/ }
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/rawburt/wouter-views'
+
+  s.add_dependency 'wouter', '~> 0.0.8'
+  s.add_dependency 'rack', '~> 2.0', '>= 2.0.6'
+  s.add_dependency 'tilt', '~> 2.0', '>= 2.0.8'
+  s.add_development_dependency 'm', '~> 1.5'
+  s.add_development_dependency 'minitest', '~> 5.11'
+  s.add_development_dependency 'minitest-rg', '~> 5.2'
+  s.add_development_dependency 'rack-test', '~> 1.1'
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'slim', '~> 4.0', '>= 4.0.1'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: wouter-views
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wouter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: Adds view template support to the Wouter web framework.
+email: robertpeterson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/wouter/views.rb
+- wouter-views.gemspec
+homepage: https://github.com/rawburt/wouter-views
+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.7.3
+signing_key: 
+specification_version: 4
+summary: View template support for Wouter web framework.
+test_files: []