redwing 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c43721b5368bb64065451f424231f3af8962c514d09c577f4c82886409ec4b
-  data.tar.gz: 04b14110d7ac8d37fe544494b615c6849cc8a950036e4c7a31a9042cb876ae62
+  metadata.gz: c562d3c79811799adcb0a02faedd22a7ebd4b6f4fcba2b1a7fa0049400580e28
+  data.tar.gz: 0ab3fd11b2c75bb5b4391e6ee310b7193eeff2057c68e069d922fc7eb1a3b3e3
 SHA512:
-  metadata.gz: ffa1d019b6eaab8f24b0c5f9acc4ec4a68f9c747d033c9f398c37fff420925e175c9ce7ff9794331c80a7703af381ce249b105e8a1965f38a0941557cdf81e81
-  data.tar.gz: f106f414ab0ce5593daf65aa5399eb20b0a86e8abd6ccbe07319d4a0e2dbc9a88bc8e5ceed262107eab3c7b3fc24b2b329ba6a0d1839591e2350d119b24139d1
+  metadata.gz: a75d8e35db5f8fadc24321358144cd042b4e8dde6903e855730e2cf1e992ab28fb56bcba48be9fb9620555b9227e7b3dc2389000295cb024722ba74e1c72fd25
+  data.tar.gz: 7d0de17fc8e3adf55eda1e1551bd74c53adb213f9505440a0744a63f7205cd19db7cd32cb52f604f7e64a93b5dd4a785433c4f4c87586419b8564f9be6472e5f

data/README.md

@@ -1,3 +1,42 @@
 # redwing
 
 Sometimes, all you need is a little server. That´s `redwing` for you. What you make out of it, is up to you.
+
+## Quick Start
+
+```bash
+gem install redwing
+redwing new api my-api
+cd my-api
+redwing server
+```
+
+Then visit `http://localhost:3001/hello`.
+
+## What you get
+
+```
+my-api/
+  Gemfile
+  README.md
+  config/
+    redwing.yml
+    routes.rb
+```
+
+### Define routes
+
+```ruby
+# config/routes.rb
+Redwing.routes do
+  get '/hello' do
+    {message: 'Hello from my-api'}
+  end
+end
+```
+
+Hash returns are auto-serialized to JSON.
+
+## Requirements
+
+- Ruby 3.4+

data/bin/redwing

@@ -6,4 +6,4 @@ $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
 require 'redwing/command'
 
-Redwing::Command.invoke ARGV.dup
+Redwing::Command.execute ARGV.dup

data/lib/redwing/command/base_command.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'thor/actions'
+
+module Redwing
+  module Command
+    class BaseCommand < Thor
+      include Thor::Actions
+    end
+  end
+end

data/lib/redwing/command.rb

@@ -1,31 +1,114 @@
 # frozen_string_literal: true
 
+require_relative 'errors'
+require_relative 'command/base_command'
+
 require 'redwing/commands/console_command'
+require 'redwing/commands/new_command'
 require 'redwing/commands/server_command'
 
 module Redwing
   module Command
     COMMAND_WHITELIST = {
       console: %w[console c],
-      server: %w[server s]
+      server: %w[server s],
+      new: %w[new]
     }.freeze
 
     VERSION_MAPPINGS = %w[-v --version].to_set
 
-    def self.invoke(argv)
-      return puts Redwing::VERSION if VERSION_MAPPINGS.include?(argv.first)
+    class << self
+      attr_reader :argv, :args
+
+      def execute(argv)
+        return puts Redwing::VERSION if VERSION_MAPPINGS.include?(argv.first)
+
+        @argv = argv
+        @args = @argv.drop(1)
+
+        raise Error::UnknownCommand, "Unknown command: #{@argv.first}" if command_klass.nil?
+
+        exec_klass = command_klass.new(@args, command_options)
+        unless exec_klass.respond_to?(:perform)
+          raise Error::PerformNotImplemented, "#{exec_klass.class} does not implement #perform"
+        end
+
+        trap_interrupt!
+        exec_klass.perform
+
+        exit_ok!
+      rescue StandardError => e
+        shell.say(e.message)
+
+        exit_failed!
+      end
+
+      def reset!
+        @argv = nil
+        @args = nil
+        @command_name = nil
+        @command_klass = nil
+      end
+
+      def command_name
+        @command_name ||= COMMAND_WHITELIST.find { |_, aliases| aliases.include?(@argv.first) }&.first
+      end
+
+      def command_klass
+        @command_klass ||= {
+          console: Redwing::Commands::ConsoleCommand,
+          new: Redwing::Commands::NewCommand,
+          server: Redwing::Commands::ServerCommand
+        }[command_name]
+      end
+
+      private
 
-      command_name = COMMAND_WHITELIST.find { |_, aliases| aliases.include?(argv.first) }&.first
-      args = argv.drop(1)
+      def shell
+        @shell ||= Thor::Base.shell.new
+      end
+
+      def command_options
+        Thor::Options.new(
+          command_klass.class_options,
+          {},
+          stop_on_unknown_option?,
+          disable_required_check?,
+          command_options_relation
+        ).parse(@args)
+      end
+
+      def stop_on_unknown_option?
+        false
+      end
+
+      def disable_required_check?
+        return true if %w[-h --help].include?(@argv.first)
+
+        command_klass.disable_required_check? command_klass
+      end
+
+      def command_options_relation
+        {exclusive_option_names: [], at_least_one_option_names: []}
+      end
+
+      def exit_ok!
+        Kernel.exit(0)
+      end
+
+      def exit_failed!
+        Kernel.exit(1)
+      end
+
+      def exit_unable_to_finish!
+        Kernel.exit(2)
+      end
 
-      case command_name
-      when :console
-        Redwing::Commands::ConsoleCommand.start(args)
-      when :server
-        Redwing::Commands::ServerCommand.start(args)
-      else
-        warn "Unknown command: #{argv.first}"
-        exit(1)
+      def trap_interrupt!
+        Signal.trap('INT') do
+          shell.say("\nExiting... Interrupt again to exit immediately.")
+          exit_unable_to_finish!
+        end
       end
     end
   end

data/lib/redwing/commands/console_command.rb

@@ -1,30 +1,27 @@
 # frozen_string_literal: true
 
-require 'thor'
 require 'redwing/version'
+require 'redwing/command/base_command'
 
 module Redwing
   module Commands
-    class ConsoleCommand < Thor
-      desc 'console', 'Start an interactive Redwing console'
+    class ConsoleCommand < Command::BaseCommand
+      no_commands do
+        def perform
+          app_file = File.join(Dir.pwd, 'config', 'application.rb')
+          load app_file if File.exist?(app_file)
 
-      def console
-        app_root = Dir.pwd
-        app_file = File.join(app_root, 'config', 'application.rb')
-        load app_file if File.exist?(app_file)
+          puts "Redwing #{Redwing::VERSION} console (#{RUBY_ENGINE} #{RUBY_VERSION})"
 
-        puts "Redwing #{Redwing::VERSION} console (#{RUBY_ENGINE} #{RUBY_VERSION})"
-
-        begin
-          require 'pry'
-          Pry.start
-        rescue LoadError
-          require 'irb'
-          IRB.start(__FILE__)
+          begin
+            require 'pry'
+            Pry.start
+          rescue LoadError
+            require 'irb'
+            IRB.start(__FILE__)
+          end
         end
       end
-
-      default_task :console
     end
   end
 end

data/lib/redwing/commands/new_command.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+require 'redwing/command/base_command'
+require 'redwing/generator'
+
+module Redwing
+  module Commands
+    class NewCommand < Command::BaseCommand
+      VALID_APP_TYPES = %w[api web].freeze
+      TEMPLATES = %w[
+        README.md
+        Gemfile
+        config/redwing.yml
+        config/routes.rb
+      ].freeze
+
+      argument :type, required: true, values: %w[api web]
+      argument :name, required: true, type: :string
+
+      no_commands do
+        def perform
+          validate!
+
+          target_path = "#{Pathname.pwd}/#{app_name}"
+          data = {name: app_name, type: app_type}
+
+          TEMPLATES.each do |template_name|
+            template = "templates/#{template_name}"
+            destination = "#{target_path}/#{template_name}"
+            Generator.create_file_by_template(template, destination, data)
+          end
+        end
+
+        def app_type
+          @type
+        end
+
+        def app_name
+          @name
+        end
+
+        def validate!
+          raise ArgumentError, "Invalid app type '#{app_type}'. Valid types: #{valid_app_types}" unless valid_app_type?
+        end
+
+        def valid_app_type?
+          VALID_APP_TYPES.include?(app_type)
+        end
+
+        def valid_app_types
+          VALID_APP_TYPES.join(', ')
+        end
+      end
+    end
+  end
+end

data/lib/redwing/commands/server_command.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
-require 'thor'
 require 'redwing/server'
+require 'redwing/command/base_command'
 
 module Redwing
   module Commands
-    class ServerCommand < Thor
-      desc 'server', 'Start the Redwing server'
+    class ServerCommand < Command::BaseCommand
+      class_option :host, type: :string,  default: 'localhost', aliases: '-b', desc: 'Bind to host'
+      class_option :port, type: :numeric, default: 3001,        aliases: '-p', desc: 'Listen on port'
 
-      method_option :host, type: :string,  default: 'localhost', aliases: '-b', desc: 'Bind to host'
-      method_option :port, type: :numeric, default: 3001,        aliases: '-p', desc: 'Listen on port'
+      no_commands do
+        def perform
+          load_routes
+          Redwing::Server.start(host: options[:host], port: options[:port])
+        end
 
-      def server
-        Redwing::Server.start(host: options[:host], port: options[:port])
+        def load_routes
+          require File.expand_path('config/routes')
+        end
       end
-
-      default_task :server
     end
   end
 end

data/lib/redwing/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Redwing
+  class Config
+    attr_reader :type
+
+    def initialize(path = 'config/redwing.yml')
+      data = YAML.safe_load_file(path, symbolize_names: true)
+      @type = data[:type].to_sym
+    end
+  end
+end

data/lib/redwing/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Redwing
+  module Error
+    class Base < StandardError; end
+
+    class UnknownCommand < Base; end
+    class PerformNotImplemented < Base; end
+  end
+end

data/lib/redwing/generator/file_by_template.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'thor/group'
+require 'thor/actions'
+
+module Redwing
+  module Generator
+    class BaseGenerator < Thor::Group
+      include Thor::Actions
+    end
+
+    class FileByTemplate < BaseGenerator
+      argument :source, type: :string
+      argument :destination, type: :string
+      argument :data, type: :hash, default: {}
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      def create
+        data.each { |k, v| define_singleton_method(k) { v } }
+        template(source, destination)
+      end
+    end
+  end
+end

data/lib/redwing/generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'generator/file_by_template'
+
+module Redwing
+  module Generator
+    def create_file_by_template(template, destination, config = {})
+      FileByTemplate.start([template, destination, config])
+    end
+
+    module_function :create_file_by_template
+  end
+end

data/lib/redwing/router.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Redwing
+  class Router
+    attr_reader :routes
+
+    def initialize
+      @routes = []
+    end
+
+    def get(path, &block)
+      @routes << {method: 'GET', path: path, handler: block}
+    end
+
+    def match(method, path)
+      routes.find { |r| r[:method] == method && r[:path] == path }
+    end
+  end
+end

data/lib/redwing/server.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'rack'
 require 'rackup'
+require 'redwing'
 
 module Redwing
   module Server
     def self.start(host:, port:)
       app = proc do |env|
-        _request = Rack::Request.new(env)
-        [200, {}, ['hello world']]
+        request = Rack::Request.new(env)
+        route = Redwing.routes.match(request.request_method, request.path_info)
+
+        if route
+          body = route[:handler].call
+          [200, {'content-type' => 'application/json'}, [body.to_json]]
+        else
+          [404, {'content-type' => 'application/json'}, ['{"error":"Not Found"}']]
+        end
       end
 
       handler = Rackup::Handler.get('puma')

data/lib/redwing/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Redwing
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 
   def self.gem_version
     Gem::Version.new VERSION

data/lib/redwing.rb

@@ -5,4 +5,18 @@ require 'redwing/version'
 
 module Redwing
   extend ActiveSupport::Autoload
+
+  autoload :Config
+  autoload :Generator
+  autoload :Router
+
+  def self.routes(&block)
+    @router ||= Router.new
+    @router.instance_eval(&block) if block
+    @router
+  end
+
+  def self.reset_routes!
+    @router = nil
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redwing
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Marek Witkowski
@@ -167,6 +167,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.86.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +206,15 @@ files:
 - bin/redwing
 - lib/redwing.rb
 - lib/redwing/command.rb
+- lib/redwing/command/base_command.rb
 - lib/redwing/commands/console_command.rb
+- lib/redwing/commands/new_command.rb
 - lib/redwing/commands/server_command.rb
+- lib/redwing/config.rb
+- lib/redwing/errors.rb
+- lib/redwing/generator.rb
+- lib/redwing/generator/file_by_template.rb
+- lib/redwing/router.rb
 - lib/redwing/server.rb
 - lib/redwing/version.rb
 homepage: https://github.com/mrmarekwitkowski/redwing