toycol 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102026f42040d677807fb5fe1cd08797f564951096c15ac2c0150a757cc82926
-  data.tar.gz: d7b4312381d610821b197f688c871acbe26a6d70146c67441d23cbd52a0ed697
+  metadata.gz: a9cd0de8dd5ec5a48e22a49c8198492a96162c9ff922a07c897e3af7cdfe779a
+  data.tar.gz: 938b7f68fef82731d61c1937c2ed53753c1bbb301c49434cc6d538edb6f862f9
 SHA512:
-  metadata.gz: 11eb3611d926c804f1f0d632f40daf2a37b7f663bdb449c69c2353d608dba87161723f4380d5dedfa78a46f1d264dde625b9bdd30ba6dda6e64eed12964f83cf
-  data.tar.gz: 9c38815ef3861ad35ac635f713fb2f6b459ee6cbc64cbe9da56ec355381a5f21c30189e28ebe92f961406b99d9349631b52571729fd8c290d94cd61c0eefd4ea
+  metadata.gz: 53e62c64e3f418da9e0f7068482531bab41466e6d73d560e8bf74ae900cf2587a61d810365eea15f01f194592c70b563320ffe93f170810e4fa6f443f3a73837
+  data.tar.gz: 112910c06cdb28e5f8690fd18373a2d418a466b075cc0ff793816aed2475acb1ccf5657ae8cfb7b3c321cefc1bde44e5a34fd9b9024f3c20d14047938adf6121

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

data/examples/anonymous/Gemfile

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

data/examples/anonymous/Protocolfile

@@ -0,0 +1,13 @@
+Toycol::Protocol.define do
+  request.path do |message|
+    %r{(?<path>\/\w*)}.match(message)[:path]
+  end
+
+  request.query do |message|
+    %r{\?(?<query>.+)}.match(message) { |m| m[:query] }
+  end
+
+  request.http_method do |message|
+    "GET"
+  end
+end

data/examples/anonymous/config.ru

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rack"
+require "toycol"
+
+Toycol::Protocol.use
+
+class App
+  def call(env)
+    case env["REQUEST_METHOD"]
+    when "GET"
+      [
+        200,
+        { "Content-Type" => "text/html" },
+        ["This app has no protocol name\n"]
+      ]
+    end
+  end
+end
+
+run App.new

data/examples/duck/Protocolfile.duck

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 Toycol::Protocol.define(:duck) do
   custom_status_codes(
     600 => "I'm afraid you are not a duck..."
@@ -7,11 +5,11 @@ Toycol::Protocol.define(:duck) do
   additional_request_methods "OTHER"
 
   request.path do |message|
-    %r{(?<path>/\w*)}.match(message)[:path]
+    %r{(?<path>\/\w*)}.match(message)[:path]
   end
 
   request.query do |message|
-    /\?(?<query>.+)/.match(message) { |m| m[:query] }
+    %r{\<3(?<query>.+)}.match(message) { |m| m[:query] }
   end
 
   request.http_method do |message|

data/lib/toycol/command.rb

@@ -2,26 +2,29 @@
 
 require "optparse"
 require_relative "./client"
+require_relative "./template_generator"
 
 module Toycol
   class Command
     class Options
+      @options = {}
+
       class << self
         def parse!(argv)
-          options       = {}
           option_parser = create_option_parser
           sub_command_option_parser = create_sub_command_option_parser
 
           begin
             option_parser.order!(argv)
-            options[:command]         = argv.shift
-            options[:request_message] = argv.shift if %w[client c].include?(options[:command]) && argv.first != "-h"
-            sub_command_option_parser[options[:command]].parse!(argv)
+            @options[:command]         = argv.shift
+            @options[:request_message] = argv.shift if request_message?(argv.first)
+            @options[:protocol_name]   = argv.shift if protocol_name?(argv.first)
+            sub_command_option_parser[@options[:command]].parse!(argv)
           rescue OptionParser::MissingArgument, OptionParser::InvalidOption, ArgumentError => e
             abort e.message
           end
 
-          options
+          @options
         end
 
         def create_option_parser
@@ -45,19 +48,34 @@ module Toycol
 
         def create_sub_command_option_parser
           sub_command_parser = Hash.new { |_k, v| raise ArgumentError, "'#{v}' is not sub command" }
-          sub_command_parser["client"] = client_option_parser
-          sub_command_parser["c"]      = client_option_parser
-          sub_command_parser["server"] = server_option_parser
-          sub_command_parser["s"]      = server_option_parser
+          sub_command_parser["client"]   = client_option_parser
+          sub_command_parser["c"]        = client_option_parser
+          sub_command_parser["server"]   = server_option_parser
+          sub_command_parser["s"]        = server_option_parser
+          sub_command_parser["generate"] = generator_option_parser
+          sub_command_parser["g"]        = generator_option_parser
           sub_command_parser
         end
 
         private
 
+        def request_message?(arg)
+          %w[client c].include?(@options[:command]) \
+            && arg != "-p" \
+            && arg != "-h"
+        end
+
+        def protocol_name?(arg)
+          %w[geberate g].include?(@options[:command]) \
+            && arg != "-t" \
+            && arg != "-h"
+        end
+
         def sub_command_summaries
           [
             { name: "client REQUEST_MESSAGE -p PORT",  summary: "Send request message to server"    },
-            { name: "server -u SERVER_NAME",           summary: "Start proxy and background server" }
+            { name: "server -u SERVER_NAME",           summary: "Start proxy and background server" },
+            { name: "generate NAME -t TYPE",           summary: "Generate new protocol or Rack app" }
           ]
         end
 
@@ -89,16 +107,14 @@ module Toycol
           end
         end
 
-        def client_command_help_messages
-          [
-            { name: "client -p=PORT_NUMBER", summary: "Send request to server" }
-          ]
-        end
+        def generator_option_parser
+          OptionParser.new do |opt|
+            opt.on("-t TYPE", "--type TYPE", "generate TYPE of template (default: :all)") do |type|
+              @options[:template_type] = type
+            end
 
-        def server_command_help_messages
-          [
-            { name: "server -u=SERVER_NAME", summary: "Start proxy & background server" }
-          ]
+            opt.on_head("-h", "--help", "Show this message") { help_command(opt) }
+          end
         end
 
         def help_command(parser)
@@ -126,6 +142,9 @@ module Toycol
       when "server", "s"
         ARGV.push("-q", "-s", "toycol")
         Rack::Server.start
+      when "generate", "g"
+        type = options[:template_type] || "all"
+        ::Toycol::TemplateGenerator.generate!(type: type, name: options[:protocol_name])
       end
     end
   end

data/lib/toycol/protocol.rb

@@ -17,7 +17,7 @@ module Toycol
       end
 
       # For application which use the protocol
-      def use(protocol_name)
+      def use(protocol_name = nil)
         @protocol_name = protocol_name
       end
 

data/lib/toycol/template_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Toycol
+  class TemplateGenerator
+    class << self
+      def generate!(type:, name:)
+        raise StandardError, "Unknown Type: This type of template can't be generated" unless valid? type
+
+        if type == "all"
+          new(name, "protocol").generate!
+          new(name, "app").generate!
+        else
+          new(name, type).generate!
+        end
+      end
+
+      private
+
+      def valid?(type)
+        %w[all app protocol].include? type
+      end
+    end
+
+    def initialize(name, type)
+      @name = name
+      @type = type
+    end
+
+    def generate!
+      raise StandardError, "#{filename} already exists" unless Dir.glob(filename).empty?
+
+      File.open(filename, "w") { |f| f.print template_text_for_new }
+      puts "Generate #{filename} in #{FileUtils.pwd}"
+    end
+
+    private
+
+    def filename
+      @filename ||= case @type
+                    when "protocol" then "Protocolfile#{@name ? ".#{@name}" : nil}"
+                    when "app"      then "config#{@name ? "_#{@name}" : nil}.ru"
+                    end
+    end
+
+    def template_text_for_new
+      if @name
+        template_text.sub(":PROTOCOL_NAME", ":#{@name}")
+      else
+        template_text.sub("\(:PROTOCOL_NAME\)", "")
+      end
+    end
+
+    def template_text
+      case @type
+      when "protocol" then File.open("lib/toycol/templates/protocol.txt",    "r", &:read)
+      when "app"      then File.open("lib/toycol/templates/application.txt", "r", &:read)
+      end
+    end
+  end
+end

data/lib/toycol/templates/application.txt

@@ -0,0 +1,22 @@
+require "rack"
+require "toycol"
+
+# Specify which protocol to use
+Toycol::Protocol.use(:PROTOCOL_NAME)
+
+class App
+  def call(env)
+    # Define your app on request method, request path, request query etc
+    # For example:
+    # case env['REQUEST_METHOD']
+    # when 'GET'
+    #   [
+    #     200,
+    #     { 'Content-Type' => 'text/html' },
+    #     ["Hello, This app is running by :#{name} protocol."]
+    #   ]
+    # end
+  end
+end
+
+run App.new

data/lib/toycol/templates/protocol.txt

@@ -0,0 +1,39 @@
+Toycol::Protocol.define(:PROTOCOL_NAME) do
+  # For example
+  #   client would send:
+  #     quack, quack /posts<3user_id=1
+  #   server would interpret client message:
+  #     GET /posts?user_id=1
+
+
+  # [OPTIONAL] You can define your additional request methods:
+  # For example:
+  # additional_request_methods OTHER
+
+  # [OPTIONAL] You can define your own response status code:
+  # For example:
+  # define_status_codes(
+  #   600 => "I'm afraid you are not a duck..."
+  # )
+
+  # [REQUIRED] Define how you parse request path from request message
+  request.path do |message|
+    # For example:
+    # %r{(?<path>\/\w*)}.match(message)[:path]
+  end
+
+  # [REQUIRED] Define how you parse query from request message
+  request.query do |message|
+    # For example:
+    # %r{\<3(?<query>.+)}.match(message) { |m| m[:query] }
+  end
+
+  # [REQUIRED] Define how you parse query from request message
+  request.http_method do |message|
+    # For example:
+    # case message.scan(/quack/).size
+    # when 2 then "GET"
+    # else "OTHER"
+    # end
+  end
+end

data/lib/toycol/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toycol
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Misaki Shioi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/dependabot.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -45,6 +46,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/anonymous/Gemfile
+- examples/anonymous/Protocolfile
+- examples/anonymous/config.ru
 - examples/duck/Gemfile
 - examples/duck/Protocolfile.duck
 - examples/duck/config_duck.ru
@@ -72,6 +76,9 @@ files:
 - lib/toycol/protocol.rb
 - lib/toycol/proxy.rb
 - lib/toycol/server.rb
+- lib/toycol/template_generator.rb
+- lib/toycol/templates/application.txt
+- lib/toycol/templates/protocol.txt
 - lib/toycol/version.rb
 - toycol.gemspec
 homepage: https://github.com/shioimm/toycol