yaframework 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1023ffdf696fe0cca466c59e707504d1087fd4433d1cfaf44d17a0e7056d4196
-  data.tar.gz: 93dd4318d8a209a8dd40fc5a1b2d9dc8e3d233a1fa92f4e3883f0ca74067e71e
+  metadata.gz: 23a8af14273443627664b65feb652bc03336d5fbe829f672cae4ef9c8ca4604e
+  data.tar.gz: 848d0e46585695fe4756bf91b6c286b9cacb4ec684a535491e7a348f4a2c081a
 SHA512:
-  metadata.gz: d3eab3431ab7170cfe6367a258b33b32404abcb97ac8f8853bf9a4959cd6528b92edfbe014ee9a8e14afe6b7a445fe76dd198787ff7b927162dc6217a4192886
-  data.tar.gz: 0b5701763d06e37cb4f71ec494e38280998110ca698dd00ce9c1ea31373204a561028f9ee14dcdb6e7f604c28dbe76b17447c3306f025eeb2c56ee1e8d61e29c
+  metadata.gz: 35fa5d015af06f258f7b7fff290a14a3f60329aeb2e713b4cad172f86b55bde28a01d371a114ed89b77a48862146d78c53721fa21bcd86beaa155c0cec7a13f8
+  data.tar.gz: 47a8a7be5c253fb3a1bf788c6256613f85c9132725a328e456b8e7e27f82da322f5f2ff5691e8267dd3fce9139d0db13fcab6ca71e424436bdf1a1b165a88b3b

data/.gitignore

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

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  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,26 @@
-## [Unreleased]
+## [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,5 +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"
-gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    yaframework (0.4.0)
+      rack (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    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)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+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)
+  yaframework!
+
+BUNDLED WITH
+   2.1.4

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

@@ -0,0 +1,17 @@
+# Examples
+
+Here are some examples of applications created with Yaframework:
+
+1. ###[Hello World](https://github.com/maxbarsukov/yaframework/tree/master/examples/hello-world)
+
+   A simple application that displays "Hello world" to you.
+
+
+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/hello-world/Gemfile

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

data/examples/hello-world/README.md

@@ -0,0 +1,12 @@
+# Hello world
+
+A simple application that displays "Hello world" to you.
+
+## 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/hello-world/app.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/yaframework"
+app = Yaframework::Application
+
+app.get "/" do
+  "Hello world!"
+end
+
+app.listen(4567)

data/examples/hello-world/config.ru

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

data/lib/yaframework.rb

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

data/lib/yaframework/base.rb

@@ -4,38 +4,27 @@ require "rack"
 
 module Yaframework
   class Base
-    attr_reader :routes, :request, :response, :params, :env
+    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/database.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "pg"
+
+class Database
+  def self.connect(db_name)
+    pg_conn = PG.connect(dbname: db_name)
+    new(pg_conn)
+  end
+
+  def initialize(pg_conn)
+    @pg_conn = pg_conn
+  end
+
+  def exec(sql)
+    @pg_conn.exec(sql).to_a
+  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.1"
+  VERSION = "0.4.1"
 end

data/test/yaframework_test.rb

@@ -6,8 +6,4 @@ class YaframeworkTest < Minitest::Test
   def test_that_it_has_a_version_number
     refute_nil ::Yaframework::VERSION
   end
-
-  def test_it_does_something_useful
-    assert false
-  end
 end

data/yaframework.gemspec

@@ -13,25 +13,24 @@ Gem::Specification.new do |spec|
 
   spec.homepage      = "https://rubygems.org/gems/yaframework"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"]     = spec.homepage
   spec.metadata["source_code_uri"]  = "https://github.com/maxbarsukov/yaframework"
   spec.metadata["changelog_uri"]    = "https://github.com/maxbarsukov/yaframework/blob/master/CHANGELOG.md"
 
-  spec.test_files       = Dir['test/**/*.rb']
-  spec.require_paths    = ['lib']
+  spec.test_files       = Dir["test/**/*.rb"]
+  spec.require_paths    = ["lib"]
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   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 "rake",     "~> 13.0"
   spec.add_development_dependency "rubocop",  "~> 1.7"
 
-  spec.add_runtime_dependency "rack",  "~> 2.2"
+  spec.add_runtime_dependency "rack", "~> 2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaframework
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 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
@@ -79,13 +79,22 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- examples/README.md
+- examples/hello-world/Gemfile
+- examples/hello-world/README.md
+- examples/hello-world/app.rb
+- examples/hello-world/config.ru
 - lib/yaframework.rb
 - lib/yaframework/base.rb
+- lib/yaframework/database.rb
+- lib/yaframework/request.rb
+- lib/yaframework/response.rb
 - lib/yaframework/version.rb
 - test/test_helper.rb
 - test/yaframework_test.rb
@@ -105,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="