toycol 0.0.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e39fd4d4d223eef7eb8e86059fd061ebbb24259a1259b7f5b8bef228d6d9836
-  data.tar.gz: 8d90ae7ed408d76a46da7726a280560d245e1372bca9d2a0857efe7bc22d6a3d
+  metadata.gz: 102026f42040d677807fb5fe1cd08797f564951096c15ac2c0150a757cc82926
+  data.tar.gz: d7b4312381d610821b197f688c871acbe26a6d70146c67441d23cbd52a0ed697
 SHA512:
-  metadata.gz: 10d74fd171b7eec5618b1aeca4035a3f9bff05c12864285fb43fa83d1d53a97523276a19ac3a6185929e82854ce3701dd0f7d5963a55c38536cbe71828327809
-  data.tar.gz: a73c3c5c7992ba1bebb34f8db9bfc8061a066a6c2b30ead33c8dfdc79a8b540092f540b793dd67c164dc277766dd7e6ce030b00b17d30148c28f5993fab4157e
+  metadata.gz: 11eb3611d926c804f1f0d632f40daf2a37b7f663bdb449c69c2353d608dba87161723f4380d5dedfa78a46f1d264dde625b9bdd30ba6dda6e64eed12964f83cf
+  data.tar.gz: 9c38815ef3861ad35ac635f713fb2f6b459ee6cbc64cbe9da56ec355381a5f21c30189e28ebe92f961406b99d9349631b52571729fd8c290d94cd61c0eefd4ea

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Environment
+- Ruby Version:
+- Rack Version:
+- Puma Version:
+
+## Additional context
+Add any other context about the problem here.

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "06:00"
+  open-pull-requests-limit: 10
+  rebase-strategy: "disabled"

data/.github/workflows/main.yml

@@ -5,12 +5,15 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0, head]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.gitignore

@@ -7,4 +7,5 @@
 /spec/reports/
 /tmp/
 
+.ruby-version
 Gemfile.lock

data/.rubocop.yml

@@ -9,7 +9,14 @@ AllCops:
     - 'Rakefile'
     - 'toycol.gemspec'
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 2.6
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - lib/toycol/server.rb
 
 Style/StringLiterals:
   Enabled: true
@@ -21,3 +28,21 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Layout/HashAlignment:
+  Exclude:
+    - lib/toycol/server.rb
+
+Metrics:
+  Exclude:
+    - lib/toycol/proxy.rb
+    - lib/toycol/server.rb
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 400
+
+Metrics/MethodLength:
+  Max: 15

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-07-12
+## [0.0.1] - 2021-07-12
 
 - Initial release

data/README.md

@@ -1,8 +1,6 @@
 # Toycol
 
-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/toycol`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Toy Application Protocol framework
 
 ## Installation
 
@@ -22,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+WIP
 
 ## Development
 

data/examples/duck/Gemfile

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

data/examples/duck/Protocolfile.duck

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Toycol::Protocol.define(:duck) do
+  custom_status_codes(
+    600 => "I'm afraid you are not a duck..."
+  )
+  additional_request_methods "OTHER"
+
+  request.path do |message|
+    %r{(?<path>/\w*)}.match(message)[:path]
+  end
+
+  request.query do |message|
+    /\?(?<query>.+)/.match(message) { |m| m[:query] }
+  end
+
+  request.http_method do |message|
+    case message.scan(/quack/).size
+    when 2 then "GET"
+    else "OTHER"
+    end
+  end
+end

data/examples/duck/config_duck.ru

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rack"
+require "toycol"
+
+Toycol::Protocol.use(:duck)
+
+# Duck protocol application
+class App
+  def call(env)
+    case env["REQUEST_METHOD"]
+    when "GET"
+      case env["PATH_INFO"]
+      when "/posts"
+        return app_for_get_with_query if env["QUERY_STRING"] == "user_id=1"
+
+        app_for_get
+      when "/" then app_for_get_to_root
+      end
+    when "OTHER" then app_for_other
+    end
+  end
+
+  private
+
+  def app_for_get_with_query
+    [
+      200,
+      { "Content-Type" => "text/html" },
+      ["quack quack, I am the No.1 duck\n"]
+    ]
+  end
+
+  def app_for_get
+    [
+      200,
+      { "Content-Type" => "text/html" },
+      ["quack quack, quack quack, quack, quack\n", "quack quack, I am the No.1 duck\n"]
+    ]
+  end
+
+  def app_for_get_to_root
+    [
+      200,
+      { "Content-Type" => "text/html" },
+      ["Hello, This app is running on Sample duck protocol.\n"]
+    ]
+  end
+
+  def app_for_other
+    [
+      600,
+      { "Content-Type" => "text/html" },
+      ["Sorry, this application is only for ducks...\n"]
+    ]
+  end
+end
+
+run App.new

data/examples/rubylike/Gemfile

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

data/examples/rubylike/Protocolfile.rubylike

@@ -0,0 +1,18 @@
+Toycol::Protocol.define(:rubylike) do
+  custom_status_codes(
+    700 => "Hmm...",
+  )
+
+  additional_request_methods "OTHER"
+
+  request.path do |message|
+    /['"](?<path>.+)['"]/.match(message)[:path]
+  end
+
+  request.http_method do |message|
+    case /\.(?<method>[A-z]+)/.match(message)&.captures&.first
+    when "get" then "GET"
+    else "OTHER"
+    end
+  end
+end

data/examples/rubylike/config_rubylike.ru

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rack"
+require "toycol"
+
+Toycol::Protocol.use(:rubylike)
+
+class App
+  def call(env)
+    case env["REQUEST_METHOD"]
+    when "GET"
+      [
+        200,
+        { "Content-Type" => "text/html" },
+        ["I love ruby!\n", "I love RubyKaigi!\n"]
+      ]
+    when "OTHER"
+      [
+        700,
+        { "Content-Type" => "text/html" },
+        ["Sorry, but I'd like you to speak more like a Ruby programmer...\n"]
+      ]
+    end
+  end
+end
+
+run App.new

data/examples/safe_ruby/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "toycol", path: "../../"

data/examples/safe_ruby/Protocolfile.safe_ruby

@@ -0,0 +1,47 @@
+module SafeRuby
+  PARSER_REGEX = /["'](?<path>\/.*)["']\.(?<method>[A-z]+)/
+  QUERY_REGEX  = /query?.*\{(?<query>.*)\}/
+  INPUT_REGEX  = /input?.*\{(?<input>.*)\}/
+end
+
+Toycol::Protocol.define(:safe_ruby) do |message|
+  using Module.new {
+    refine String do
+      # Ex. '/posts'.get
+      # Ex. (with query string) '/posts'.get(query: { user_id: 2 })
+      def get(options = {})
+        Toycol::Protocol.request.query { options[:query] } if options[:query]
+        Toycol::Protocol.request.http_method { "GET" }
+      end
+
+      # Ex. '/posts'.post(input: { user_id: 1, body: 'This is a post request' })
+      def post(options = {})
+        Toycol::Protocol.request.input { options[:input] } if options[:input]
+        Toycol::Protocol.request.http_method { "POST" }
+      end
+
+      def parse_as_queries
+        split(",").map { |str| str.scan(/\w+/).join("=") }
+      end
+
+      def parse_as_inputs
+        split(",").map { |str| str.split(":").map { |s| s.strip! && s.gsub(/['"]/, "") }.join("=") }
+      end
+    end
+  }
+
+  path, method = SafeRuby::PARSER_REGEX.match(message) { |m| [m[:path], m[:method]] }
+  query = SafeRuby::QUERY_REGEX.match(message) { |m| m[:query].parse_as_queries }&.join("&")
+  input = SafeRuby::INPUT_REGEX.match(message) { |m| m[:input].parse_as_inputs }&.join("&")
+  args  = {}
+
+  request.path { path }
+
+  %i[query input].each do |k|
+    if v = binding.local_variable_get(k)
+      args[*k] = v
+    end
+  end
+
+  request_path.public_send(method, args)
+end

data/examples/safe_ruby/config_safe_ruby.ru

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "rack"
+require "toycol"
+
+Toycol::Protocol.use(:safe_ruby)
+
+class App
+  def call(env)
+    case env["REQUEST_METHOD"]
+    when "GET"
+      case env["PATH_INFO"]
+      when "/posts"
+        return app_for_get_with_query if env["QUERY_STRING"] == "user_id=2"
+
+        app_for_get
+      end
+    when "POST"
+      input   = env["rack.input"].gets
+      created = input.split("&").map { |str| str.split("=") }.to_h
+
+      app_for_post(user_id: created["user_id"], body: created["body"])
+    end
+  end
+
+  private
+
+  def app_for_get_with_query
+    [
+      200,
+      { "Content-Type" => "text/html" },
+      ["User<2> I love RubyKaigi!\n"]
+    ]
+  end
+
+  def app_for_get
+    [
+      200,
+      { "Content-Type" => "text/html" },
+      ["User<1> I love Ruby!\n", "User<2> I love RubyKaigi!\n"]
+    ]
+  end
+
+  def app_for_post(user_id:, body:)
+    [
+      201,
+      { "Content-Type" => "text/html", "Location" => "/posts" },
+      ["User<1> I love Ruby!\n",
+       "User<2> I love RubyKaigi!\n",
+       "User<#{user_id}> #{body}\n"]
+    ]
+  end
+end
+
+run App.new

data/examples/safe_ruby_with_sinatra/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "puma"
+gem "sinatra"
+gem "sinatra-contrib"
+gem "toycol", path: "../../"

data/examples/safe_ruby_with_sinatra/Protocolfile.safe_ruby_with_sinatra

@@ -0,0 +1,44 @@
+module SafeRubyWithSinatra
+  PARSER_REGEX = /["'](?<path>\/.*)["']\.(?<method>[A-z]+)/
+  QUERY_REGEX  = /query?.*\{(?<query>.*)\}/
+  INPUT_REGEX  = /input?.*\{(?<input>.*)\}/
+end
+
+Toycol::Protocol.define(:safe_ruby_with_sinatra) do |message|
+  using Module.new {
+    refine String do
+      def get(options = {})
+        Toycol::Protocol.request.query { options[:query] } if options[:query]
+        Toycol::Protocol.request.http_method { "GET" }
+      end
+
+      def post(options = {})
+        Toycol::Protocol.request.input { options[:input] } if options[:input]
+        Toycol::Protocol.request.http_method { "POST" }
+      end
+
+      def parse_as_queries
+        split(",").map { |str| str.scan(/\w+/).join("=") }
+      end
+
+      def parse_as_inputs
+        split(",").map { |str| str.split(":").map { |s| s.strip! && s.gsub(/['"]/, "") }.join("=") }
+      end
+    end
+  }
+
+  path, method = SafeRubyWithSinatra::PARSER_REGEX.match(message) { |m| [m[:path], m[:method]] }
+  query = SafeRubyWithSinatra::QUERY_REGEX.match(message) { |m| m[:query].parse_as_queries }&.join("&")
+  input = SafeRubyWithSinatra::INPUT_REGEX.match(message) { |m| m[:input].parse_as_inputs }&.join("&")
+  args  = {}
+
+  request.path { path }
+
+  %i[query input].each do |k|
+    if v = binding.local_variable_get(k)
+      args[*k] = v
+    end
+  end
+
+  request_path.public_send(method, args)
+end