yaframework 0.4.7 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aec9734b89fbd8a9c87fb63506f49f53df83c0f141efd612d5cdceb9d4d8c64
-  data.tar.gz: 8d43e4889c14798d20400ae36bfa9c6b76797bf7348eac539d85c690dcf250a3
+  metadata.gz: b01d1643e6921880fd3630c0b5898c502a0b3ff54c602f63ac54f9d32e263b36
+  data.tar.gz: 602742bc864f51d7151d946710d47583e2b3a7abfe257ffb74c2f2d48418ff89
 SHA512:
-  metadata.gz: 00af9a420fd2edffe78d77d6a2ecfc81973cbadb9543424153a6a5e689409a06d4c98a5ff54e7ddbda2a122cbe3bcd2d5b563968f8820738c6f21747269201d7
-  data.tar.gz: ba55916ef3b9776ab8711e82af51406b5d4e00b6991acf04418fc1526f6a0aa803757b9744296180843cf201534f4ed14292ac2f738a92d00bb8d5ad11bf6925
+  metadata.gz: 80d9262cc6a0206ecbd058c3bb6d65c78b4abe0192924dd27685d61fd91ec90c60e85d3a3f7792e8ce6f45d4c6d1b6e30309fa6d66f3988debd0a8fa450bd1b6
+  data.tar.gz: 9d95222a443494ca862a16499f42662053515765c3cd2dbb06050b469b333f852c7097c1de16904704bc731a18c653a3980cd199b2dfe8738e5a1424148ce6ce

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [0.5.1] - 2021-07-26
+
+- `helpers` and `configure` methods added
+
+## [0.5.0] - 2021-07-25
+
+- Templates rendering added
+
+## [0.4.9] - 2021-07-25
+
+- Some useful aliases added
+
+## [0.4.8] - 2021-07-25
+
+- Before/after hooks added
+
 ## [0.4.7] - 2021-07-25
 
 - Handling 404 error fixed

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    yaframework (0.4.7)
+    yaframework (0.5.1)
       rack (~> 2.2, >= 2.2.3)
+      tilt (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -29,6 +30,7 @@ GEM
     rubocop-ast (1.7.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    tilt (2.0.10)
     unicode-display_width (2.0.0)
 
 PLATFORMS

data/examples/README.md

@@ -2,21 +2,60 @@
 
 Here are some examples of applications created with Yaframework:
 
-1. [**Hello World**](https://github.com/maxbarsukov/yaframework/tree/master/examples/hello_world.rb)
+1. [**Hello World**](https://github.com/maxbarsukov/yaframework/blob/master/examples/hello_world.rb)
 
-   A simple application that displays "Hello world" to you. Go to `http://localhost:4567/` and see `Hello World`!
+   A simple application that displays "Hello world" to you.
 
 
-2. [**Params**](https://github.com/maxbarsukov/yaframework/tree/master/examples/params.rb)
+2. [**Params**](https://github.com/maxbarsukov/yaframework/blob/master/examples/params.rb)
 
    Shows how the application parameters can be used
 
 
-3. [**Halts and Redirects**](https://github.com/maxbarsukov/yaframework/tree/master/examples/halts_and_redirects.rb)
+3. [**Halts and Redirects**](https://github.com/maxbarsukov/yaframework/blob/master/examples/halts_and_redirects.rb)
 
    Shows how to use halts and redirects
 
 
+4. [**Headers**](https://github.com/maxbarsukov/yaframework/blob/master/examples/headers.rb)
+
+   How to add and view headers.
+
+
+5. [**Error handling**](https://github.com/maxbarsukov/yaframework/blob/master/examples/error_handling.rb)
+
+   How to handle errors
+
+
+6. [**Content Types**](https://github.com/maxbarsukov/yaframework/blob/master/examples/content_types.rb)
+
+   Using json, html, or plain text
+
+
+7. [**Cookies**](https://github.com/maxbarsukov/yaframework/blob/master/examples/cookies.rb)
+
+   Adding and deleting cookies
+
+
+8. [**Hooks**](https://github.com/maxbarsukov/yaframework/blob/master/examples/before_after_hooks.rb)
+
+   How to use `before` and `after` hooks
+
+
+9. [**Rendering**](https://github.com/maxbarsukov/yaframework/tree/master/examples/rendering)
+
+   Rendering your `.erb` (or any else) files and partials using tilt.
+
+
+10. [**Helpers**](https://github.com/maxbarsukov/yaframework/blob/master/examples/helpers.rb)
+
+    Example of using helpers
+
+
+11. [**Configure**](https://github.com/maxbarsukov/yaframework/blob/master/examples/configure.rb)
+
+    How to configure your application
+
 ## Installation
 
 Clone this repo and go to this folder.
@@ -25,4 +64,3 @@ Then, run `bundle install` to install this gem.
 ## Run
 
 Run with `ruby hello-world.rb` or any other file and view at http://localhost:4567
- 

data/examples/before_after_hooks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.before do
+  @page_updates ||= 0
+  @page_updates += 1
+end
+
+app.after do
+  puts "Some log info: #{response.body}"
+  response.write "<br>Refresh the page and your next number will be #{@page_updates + 1}!"
+end
+
+app.get "/" do
+  "Hello, your num is: #{@page_updates}"
+end
+
+app.listen(4567)

data/examples/configure.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.configure do
+  @app_name
+end
+
+app.get "/" do
+  "Hey, that's #{@app_name}"
+end
+
+app.listen(9292)

data/examples/error_handling.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../lib/yaframework"
+require "yaframework"
 app = Yaframework::Application
 
 app.get "/" do

data/examples/halts_and_redirects.rb

@@ -8,7 +8,7 @@ app.get "/" do
 end
 
 app.get "/hello" do
-  "Hello world!"
+  "Hi, you were redirected here from the root page. You can go <a href=\"/error\"></a> to get a 401 error"
 end
 
 app.get "/error" do

data/examples/helpers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.helpers do
+  def hello
+    "Hello"
+  end
+
+  def colon
+    ", "
+  end
+end
+
+app.helpers do
+  def world
+    "world!"
+  end
+end
+
+app.get "/" do
+  hello + colon + world
+end
+
+app.listen(9292)

data/examples/rendering/app.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.before do
+  @number = Random.rand
+  puts @number
+end
+
+app.get "/" do
+  render "index"
+end
+
+app.listen(4567)

data/examples/rendering/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "yaframework"
+require "./app"
+
+run app

data/examples/rendering/views/index.erb

@@ -0,0 +1,4 @@
+<h1>Look me in index.erb file</h1>
+
+<p>It works!</p>
+<%= partial "partial", number: @number %>

data/examples/rendering/views/layout.erb

@@ -0,0 +1,10 @@
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Example app</title>
+</head>
+
+<body>
+  <%= content %>
+</body>
+</html>

data/examples/rendering/views/partial.erb

@@ -0,0 +1 @@
+<p>Yout number was <b><%= number %></b></p>

data/lib/yaframework.rb

@@ -3,6 +3,7 @@
 require_relative "yaframework/base"
 require_relative "yaframework/request"
 require_relative "yaframework/response"
+require_relative "yaframework/render"
 
 module Yaframework
 end

data/lib/yaframework/base.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
 require "rack"
+require_relative "../yaframework/render"
 
 module Yaframework
   class Base
-    attr_reader :routes, :request, :response, :env
+    include Yaframework::Render
+
+    attr_reader :routes, :request, :response, :env, :settings
+    alias req request
+    alias res response
 
     def initialize
       @routes = Hash.new([])
+      @before_hooks = []
+      @after_hooks  = []
+      @settings = {}
       @inbox = {}
     end
 
@@ -17,6 +25,14 @@ module Yaframework
       end
     end
 
+    def helpers(&block)
+      exec(block) if block_given?
+    end
+
+    def configure(&block)
+      exec(block) if block_given?
+    end
+
     def call(env)
       @env = env
       @request  = Yaframework::Request.new @env
@@ -28,6 +44,18 @@ module Yaframework
       throw :halt, response
     end
 
+    def before(&block)
+      @before_hooks << block
+    end
+
+    def after(&block)
+      @after_hooks << block
+    end
+
+    def params
+      request.params
+    end
+
     def handle(status, &block)
       @inbox[status] = block
     end
@@ -59,11 +87,14 @@ module Yaframework
       response.status = 404 unless route
 
       if @inbox[response.status]
-        response.write instance_eval(&@inbox[response.status])
+        response.write exec(@inbox[response.status])
         return response.finish
       end
 
-      response.write instance_eval(&route[:handler]) if route
+      exec_before_hooks
+      response.write exec(route[:handler]) if route
+      exec_after_hooks
+
       response.finish
     end
 
@@ -80,7 +111,32 @@ module Yaframework
       end
       route
     end
+
+    def exec(action)
+      if action.respond_to? :to_sym
+        send(action)
+      else
+        instance_exec(&action)
+      end
+    end
+
+    def exec_before_hooks
+      exec_hooks @before_hooks
+    end
+
+    def exec_after_hooks
+      exec_hooks @after_hooks
+    end
+
+    def exec_hooks(hooks)
+      return true if hooks.nil?
+
+      hooks.each do |hook|
+        return false if exec(hook) == false
+      end
+    end
   end
 
   Application = Base.new
+  Application.setup
 end

data/lib/yaframework/render.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "tilt"
+
+module Yaframework
+  module Render
+    def setup(settings = {})
+      @settings = settings
+      @settings[:template_engine] ||= "erb"
+      @settings[:layout]  ||= "layout"
+      @settings[:views]   ||= File.expand_path("views", File.dirname($PROGRAM_NAME))
+      @settings[:options] ||= {
+        default_encoding: Encoding.default_external
+      }
+    end
+
+    def render(template, locals = {}, layout = @settings[:layout])
+      res.headers["Content-Type"] ||= "text/html; charset=utf-8"
+      res.write(view(template, locals, layout))
+    end
+
+    def view(template, locals = {}, layout = @settings[:layout])
+      partial(layout, locals.merge(content: partial(template, locals)))
+    end
+
+    def partial(template, locals = {})
+      _render(template_path(template), locals, @settings[:options])
+    end
+
+    def template_path(template)
+      dir = @settings[:views]
+      ext = @settings[:template_engine]
+      File.join(dir, "#{template}.#{ext}")
+    end
+
+    private
+
+    def _render(template, locals = {}, options = {}, &block)
+      _cache.fetch(template) { Tilt.new(template, 1, options.merge(outvar: "@_output")) }.render(self, locals, &block)
+    end
+
+    def _cache
+      Thread.current[:_cache] ||= Tilt::Cache.new
+    end
+  end
+end

data/lib/yaframework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yaframework
-  VERSION = "0.4.7"
+  VERSION = "0.5.1"
 end

data/yaframework.gemspec

@@ -33,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake",     "~> 13.0"
   spec.add_development_dependency "rubocop",  "~> 1.7"
 
-  spec.add_runtime_dependency "rack", "~> 2.2", ">= 2.2.3"
+  spec.add_dependency "rack", "~> 2.2", ">= 2.2.3"
+  spec.add_dependency "tilt", "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaframework
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.1
 platform: ruby
 authors:
 - maxbarsukov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-25 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: What could be better than one more Sinatra?
 email:
 - maximbarsukov@bk.ru
@@ -107,15 +121,24 @@ files:
 - bin/setup
 - examples/Gemfile
 - examples/README.md
+- examples/before_after_hooks.rb
+- examples/configure.rb
 - examples/content_types.rb
 - examples/cookies.rb
 - examples/error_handling.rb
 - examples/halts_and_redirects.rb
 - examples/headers.rb
 - examples/hello_world.rb
+- examples/helpers.rb
 - examples/params.rb
+- examples/rendering/app.rb
+- examples/rendering/config.ru
+- examples/rendering/views/index.erb
+- examples/rendering/views/layout.erb
+- examples/rendering/views/partial.erb
 - lib/yaframework.rb
 - lib/yaframework/base.rb
+- lib/yaframework/render.rb
 - lib/yaframework/request.rb
 - lib/yaframework/response.rb
 - lib/yaframework/version.rb