yaframework 0.2.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2788a5ff60e8e0bc920bdc79f77a7b72173ea9e931796eca9c6133f052e94128
-  data.tar.gz: c407ba38d42abb056bef8adb8e237e46f6b536f93153646bf65f45aa4665c38d
+  metadata.gz: e8009597e2e41965f0ad078918d629c4b88eaf2536d9c001053079cdfd24705a
+  data.tar.gz: 44386071847fd8a44299d967a8d8605b615a3fc865afd21a4f555410c10b3cba
 SHA512:
-  metadata.gz: d8279ffce672f404395f175dc98a41caab4658e44b7eb6feb80b208d217cf923f35eed7fcde3910620465ee1cb0b1d0c4e8e0d44f4cee8339551ea5932d8e762
-  data.tar.gz: 48fcd44ddaa1db8dbda9da2817241627ab44264c946e9c9dfac68ab409f6b31d708bfea4ab39d50031531cca8548ba9a8836da7c7bbd85ffa69e6998ade94767
+  metadata.gz: 505e79eee033484f4ecd2eb08daca91521e2d93f5b780051fe82968d9a5510b0ac5152d4cc61aee77827e85d1e40d053451881e623e9f0f713fc1e0f0e03b1fa
+  data.tar.gz: 842210c79e38f9c984018c38377f704d235bd4f795ce3753cd89fdcddceb9c2d93db654c94d68dec23a4de818ade9719a08d382f5b6abb4fed5d29b5259cf8a1

data/.gitignore

@@ -12,3 +12,4 @@
 /tmp/
 *.gem
 *.rbc
+/examples/**/Gemfile.lock

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.5
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +10,17 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
 Layout/LineLength:
   Max: 120
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,30 @@
-## [Unreleased]
+## [0.4.2] - 2021-07-24
+
+- DB module removed
+
+## [0.4.1] - 2021-07-24
+
+- A little fix. Fixed an error with the wrong order of declaring variables (lol)
+
+## [0.4.0] - 2021-07-24
+
+- Global routing update and large-scale code base changes
+
+## [0.3.0] - 2021-07-24
+
+- Added tools for interacting with the database
+
+## [0.2.2] - 2021-07-23
+
+- Params fixed
+
+## [0.2.1] - 2021-07-23
+
+- Response/env/params variables added
+
+## [0.2.0] - 2021-07-23
+
+- Main functionality implemented
 
 ## [0.1.0] - 2021-07-23
 

data/Gemfile

@@ -5,4 +5,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "minitest", "~> 5.0"
+gem "pg", "~> 1.2", ">= 1.2.3"
 gem "rack", "~> 2.2", ">= 2.2.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yaframework (0.2.1)
+    yaframework (0.4.1)
       rack (~> 2.2)
 
 GEM
@@ -12,6 +12,7 @@ GEM
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pg (1.2.3)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.6)
@@ -37,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1.4)
   minitest (~> 5.0)
+  pg (~> 1.2, >= 1.2.3)
   rack (~> 2.2, >= 2.2.3)
   rake (~> 13.0)
   rubocop (~> 1.7)

data/README.md

@@ -1,8 +1,41 @@
 # Yaframework
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yaframework`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/yaframework.svg)](https://badge.fury.io/rb/sinatra)
+[![Build Status](https://app.travis-ci.com/maxbarsukov/yaframework.svg?token=T4CL2EqKG6FY816F3W3F&branch=master)](https://app.travis-ci.com/maxbarsukov/yaframework)
 
-TODO: Delete this and the text above, and describe your gem
+Yaframework is a [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) for
+quickly creating web applications in Ruby with minimal effort:
+
+> _Wait, I've seen this somewhere..._
+
+```ruby
+# app.rb
+require 'yaframework'
+app = Yaframework::Application
+
+app.get "/" do
+  "Hello world!"
+end
+
+app.listen(4567)
+```
+
+Install the gem:
+
+```shell
+gem install yaframework
+```
+
+And run with:
+
+```shell
+ruby app.rb
+```
+
+View at [http://localhost:4567](http://localhost:4567)
+
+The code you changed will not take effect until you restart the server.
+Please restart the server every time you change.
 
 ## Installation
 
@@ -22,7 +55,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can see usage examples in the [**examples**](https://github.com/maxbarsukov/yaframework/tree/master/examples) folder
 
 ## Development
 

data/examples/README.md

@@ -2,9 +2,16 @@
 
 Here are some examples of applications created with Yaframework:
 
-1. [**Hello World**](https://github.com/maxbarsukov/yaframework/tree/master/examples/hello-world)
+1. ###[Hello World](https://github.com/maxbarsukov/yaframework/tree/master/examples/hello-world)
 
    A simple application that displays "Hello world" to you.
 
 
-2. Be soon...
+2. ###[Params](https://github.com/maxbarsukov/yaframework/tree/master/examples/params)
+
+   Shows how the application parameters can be used
+
+
+3. ###[Halts and Redirects](https://github.com/maxbarsukov/yaframework/tree/master/examples/halts-and-redirects)
+
+   Shows how to use halts and redirects

data/examples/halts-and-redirects/Gemfile

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

data/examples/halts-and-redirects/README.md

@@ -0,0 +1,12 @@
+# Params
+
+Shows how to use halts and redirects
+
+## Installation
+
+Clone this repo and go to this folder.
+Then, run `bundle install` to install this gem.
+
+## Run
+
+Run with `ruby app.rb` or `rackup` and view at http://localhost:4567

data/examples/halts-and-redirects/app.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.get "/" do
+  response.redirect "/hello"
+end
+
+app.get "/hello" do
+  "Hello world!"
+end
+
+app.get "/error" do
+  response.status = 401
+  halt response.finish
+end
+
+app.listen(4567)

data/examples/halts-and-redirects/config.ru

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

data/examples/params/Gemfile

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

data/examples/params/README.md

@@ -0,0 +1,12 @@
+# Params
+
+Shows how the application parameters can be used
+
+## Installation
+
+Clone this repo and go to this folder.
+Then, run `bundle install` to install this gem.
+
+## Run
+
+Run with `ruby app.rb` or `rackup` and view at http://localhost:4567

data/examples/params/app.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "yaframework"
+app = Yaframework::Application
+
+app.get "/:name" do
+  "Hello #{request.params[:name]}!"
+end
+
+app.get "/:name/foo/:bar" do
+  "Hello #{request.params[:name]} from #{request.params[:bar]}!"
+end
+
+app.listen(4567)

data/examples/params/config.ru

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

data/lib/yaframework.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "yaframework/base"
+require_relative "yaframework/request"
+require_relative "yaframework/response"
 
 module Yaframework
 end

data/lib/yaframework/base.rb

@@ -7,35 +7,24 @@ module Yaframework
     attr_reader :routes, :request, :response, :env
 
     def initialize
-      @routes = {}
+      @routes = Hash.new([])
     end
 
     %w[GET POST PATCH PUT DELETE HEAD OPTIONS].each do |verb|
       define_method :"#{verb.downcase}" do |path, &handler|
-        route(verb, path, &handler)
+        add_route(verb, path, &handler)
       end
     end
 
     def call(env)
-      @request = Rack::Request.new(env)
-      @response = Rack::Response.new
-      @params = request.params
       @env = env
-
-      verb  = @request.request_method
-      path  = @request.path_info
-
-      handler = @routes.fetch(verb, {}).fetch(path, nil)
-
-      if handler
-        result = instance_eval(&handler)
-        return result.instance_of?(String) ? [200, {}, [result]] : result
-      end
-      [404, {}, ["Route for #{verb} #{path} not found"]]
+      @request  = Yaframework::Request.new @env
+      @response = Yaframework::Response.new
+      catch(:halt) { route_eval }
     end
 
-    def params
-      @request.params
+    def halt(response)
+      throw :halt, response
     end
 
     def listen(port = 5000)
@@ -44,11 +33,44 @@ module Yaframework
 
     private
 
-    def route(verb, path, &handler)
+    def add_route(verb, path, &handler)
       path = "/#{path}" unless path[0] == "/"
+      @routes[verb] << compile(path, &handler)
+    end
+
+    def compile(path, &handler)
+      route = { handler: handler, compiled_path: nil, extra_params: [], path: path }
 
-      @routes[verb] ||= {}
-      @routes[verb][path] = handler
+      compiled_path = path.gsub(/:\w+/) do |match|
+        route[:extra_params] << match.gsub(":", "").to_sym
+        "([^/?#]+)"
+      end
+      route[:compiled_path] = /^#{compiled_path}$/
+      route
+    end
+
+    def route_eval
+      route = find_route
+      if route
+        response.write instance_eval(&route[:handler])
+      else
+        response.status = 404
+      end
+      response.finish
+    end
+
+    def find_route
+      route = routes[request.request_method].detect do |r|
+        r[:compiled_path] =~ request.path_info
+      end
+
+      if route
+        $~.captures.each_with_index do |value, index|
+          param = route[:extra_params][index]
+          request.params[param] = value
+        end
+      end
+      route
     end
   end
 

data/lib/yaframework/request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rack/request"
+
+module Yaframework
+  class Request < Rack::Request
+    def initialize(env)
+      env["PATH_INFO"] = "/" if env["PATH_INFO"].empty?
+      super
+    end
+  end
+end

data/lib/yaframework/response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Yaframework
+  class Response
+    attr_accessor :status
+    attr_reader :headers, :body
+
+    def initialize(body = [], status = 200, headers = { "Content-Type" => "text/html; charset=utf-8" })
+      @body = []
+      @headers = headers
+      @status = status
+      @length = 0
+
+      if body.respond_to? :to_str
+        write body.to_str
+      elsif body.respond_to? :each
+        body.each { |i| write i.to_s }
+      else
+        raise TypeError, "Body must #respond_to? #to_str or #each"
+      end
+    end
+
+    def finish
+      headers["Content-Length"] = @length.to_s unless (100..199).include?(status) || status == 204
+      [status, headers, body]
+    end
+
+    def redirect(target, status = 302)
+      self.status = status
+      headers["Location"] = target
+    end
+
+    def write(string)
+      s = string.to_s
+      @length += s.bytesize
+      body << s
+    end
+  end
+end

data/lib/yaframework/version.rb

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

data/yaframework.gemspec

@@ -27,9 +27,8 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",  "~> 2.1.4"
+  spec.add_development_dependency "bundler",  ">= 2.2.10"
   spec.add_development_dependency "rake",     "~> 13.0"
   spec.add_development_dependency "rubocop",  "~> 1.7"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yaframework
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.2
 platform: ruby
 authors:
 - maxbarsukov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,13 +86,22 @@ files:
 - bin/console
 - bin/setup
 - examples/README.md
+- examples/halts-and-redirects/Gemfile
+- examples/halts-and-redirects/README.md
+- examples/halts-and-redirects/app.rb
+- examples/halts-and-redirects/config.ru
 - examples/hello-world/Gemfile
-- examples/hello-world/Gemfile.lock
 - examples/hello-world/README.md
 - examples/hello-world/app.rb
 - examples/hello-world/config.ru
+- examples/params/Gemfile
+- examples/params/README.md
+- examples/params/app.rb
+- examples/params/config.ru
 - lib/yaframework.rb
 - lib/yaframework/base.rb
+- lib/yaframework/request.rb
+- lib/yaframework/response.rb
 - lib/yaframework/version.rb
 - test/test_helper.rb
 - test/yaframework_test.rb

data/examples/hello-world/Gemfile.lock

@@ -1,15 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rack (2.2.3)
-    yaframework (0.2.0)
-      rack (~> 2.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  yaframework
-
-BUNDLED WITH
-   2.1.4