yescode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 179d3590c5376a70115b2e0287a90e786bd38efd7360a95dc7d3d5dd4a871ee6
+  data.tar.gz: 78994d192bcd5459c6029b1e5bb716a205a6b022011707133713095f8502cfe9
+SHA512:
+  metadata.gz: de7bff8cb3e6d2f82a24c8daaaa78c96c7f0df0da54e18391c5852bd025ab9a1e1d04170a00a8a6e00beb48b2b7ec56af9fa00be077fce44c9a2b4de814c5523
+  data.tar.gz: 83669e3e586ab2d131ddcd1739c90085873d5546d5e88b9fc305db9292052f6a2d789d0b932670be76b8e48a3cb8da3bee952e4b067604f2e3a7a0e489d8e23e

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+# [1.0.0]
+
+- MVC
+- Plain sql migrations
+- Rack support
+- Routing
+- Vanilla js yes frame
+- Ajax support
+- Models are sql with a PORO on top
+- Views are emote (a fork of mote) with a PORO on top
+- Controllers are... you guessed it a PORO
+- No tests yet
+- Two examples showing hello world / crud
+- Simple CLI generators
+- No autoload, no zeitwerk
+- No activesupport
+- No ORM

data/Dockerfile

@@ -0,0 +1,46 @@
+FROM docker.io/library/ruby:slim
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends build-essential libjemalloc2 fonts-liberation wget gnupg2 libc6
+RUN rm -rf /var/lib/apt/lists/*
+
+# Use sqlite >= 3.38 for returns keyword
+RUN wget https://www.sqlite.org/2022/sqlite-autoconf-3380200.tar.gz && \
+    tar xvfz sqlite-autoconf-3380200.tar.gz && \
+    cd sqlite-autoconf-3380200 && \
+    ./configure && \
+    make && \
+    make install && \
+    rm -rf sqlite-autoconf-3380200
+
+RUN wget https://github.com/watchexec/watchexec/releases/download/cli-v1.18.11/watchexec-1.18.11-x86_64-unknown-linux-gnu.tar.xz && \
+    tar xf watchexec-1.18.11-x86_64-unknown-linux-gnu.tar.xz && \
+    mv watchexec-1.18.11-x86_64-unknown-linux-gnu/watchexec /usr/local/bin/ && \
+    rm -rf watchexec-1.18.11-x86_64-unknown-linux-gnu
+
+RUN wget https://github.com/DarthSim/hivemind/releases/download/v1.1.0/hivemind-v1.1.0-linux-amd64.gz && \
+    gunzip hivemind-v1.1.0-linux-amd64.gz && \
+    mv hivemind-v1.1.0-linux-amd64 /usr/local/bin/hivemind && \
+    chmod +x /usr/local/bin/hivemind
+
+ENV LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
+
+ARG USER=app
+ARG GROUP=app
+ARG UID=1101
+ARG GID=1101
+ARG DIR=/home/app
+
+RUN groupadd --gid $GID $GROUP
+RUN useradd --uid $UID --gid $GID --groups $GROUP -ms /bin/bash $USER
+
+RUN chown -R $USER:$GROUP $DIR
+
+USER $USER
+WORKDIR $DIR
+
+COPY --chown=$USER Gemfile Gemfile.lock $DIR
+
+RUN bundle install
+
+COPY --chown=$USER . $DIR

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sean Walker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# yescode
+
+A ruby full stack mvc web framework
+
+# Learning
+
+Check out the `examples/` folder for some ideas on how to get started
+
+# Quickstart without docker
+
+Install the gem
+
+```sh
+gem install yescode
+```
+
+Generate a new app and get in there
+
+```sh
+yescode g app todos
+cd todos
+```
+
+Install the dependencies
+
+```sh
+bundle install
+```
+
+Set the environment from the .env file
+
+```sh
+export $(cat .env | xargs)
+```
+
+Start the server
+
+```sh
+bundle exec tipi --listen localhost:9292 config.ru
+```
+
+Test it out with curl or you can just visit `http://localhost:9292` in your browser
+
+```sh
+curl localhost:9292
+```
+
+# Quickstart with docker
+
+Install the gem
+
+```sh
+gem install yescode
+```
+
+Generate a new app and get in there
+
+```sh
+yescode g app todos
+cd todos
+```
+
+Build a docker image. The Dockerfile installs [hivemind](https://github.com/DarthSim/hivemind) and [watchexec](https://github.com/watchexec/watchexec) and will restart the server on file changes using Procfile.dev
+
+```sh
+docker build -t todos .
+```
+
+Run the container
+
+```sh
+docker run --rm -it -v $(pwd):/home/app --env-file=.env -p 9292:9292 --name "todos" todos hivemind Procfile.dev
+```

data/exe/yescode

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "yescode"
+
+command, *args = ARGV
+
+case command
+when "g", "gen", "generate"
+  Yescode::Generator.generate(*args)
+when "migrate"
+  Yescode::Database.migrate
+when "rollback"
+  Yescode::Database.rollback(*args)
+else
+  puts Yescode::Generator::INVALID_COMMAND_MESSAGE
+end

data/lib/yes_app.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class YesApp
+  class << self
+    attr_accessor :middleware, :assets, :route_class
+    attr_writer :routes
+
+    def use(middleware, *args)
+      @middleware ||= []
+      @middleware << [middleware, args]
+    end
+
+    def app
+      @app || build_rack_app
+    end
+
+    def build_rack_app
+      builder = Rack::Builder.new
+
+      middleware&.each do |m, args|
+        m.logger = @logger if m.respond_to?(:logger=)
+        builder.use(m, *args)
+      end
+
+      builder.use Yescode::RequestCache::Middleware
+
+      builder.run Yescode::Router.new(self, @routes)
+
+      @app = builder.to_app
+    end
+
+    def freeze
+      build_rack_app
+      @app.freeze
+      @middleware.freeze
+      @assets.freeze
+
+      super
+    end
+
+    def call(env)
+      app.call(env)
+    end
+
+    def logger(logger_class, params: true, database: true)
+      @logger = logger_class
+      Yescode::Database.logger = logger_class if database
+      Yescode::Router.logger = logger_class if params
+    end
+
+    def css(arr)
+      @assets ||= Yescode::Assets.new
+      @assets.css(arr)
+    end
+
+    def js(arr)
+      @assets ||= Yescode::Assets.new
+      @assets.js(arr)
+    end
+
+    def bundle_static_files
+      @assets ||= Yescode::Assets.new
+      @assets.compile_assets
+    end
+
+    def migrations(dir = "db/migrations")
+      @migrations ||= Dir[dir]
+    end
+
+    def migrate
+      Yescode::Database.migrate(migrations)
+    end
+
+    def rollback(step = 1)
+      Yescode::Database.rollback_schema(migrations, step:)
+    end
+
+    def development?
+      Yescode::Env.development?
+    end
+
+    def test?
+      Yescode::Env.test?
+    end
+
+    def production?
+      Yescode::Env.production?
+    end
+
+    def default_session_cookie
+      {
+        path: "/",
+        expire_after: 2_592_000,
+        secret: ENV["SECRET"],
+        http_only: true,
+        same_site: :strict,
+        secure: production?
+      }
+    end
+
+    def routes(class_name = :Routes)
+      @route_class = Object.const_get(class_name)
+      @routes ||= @route_class.routes
+    end
+
+    def paths
+      @paths ||= @route_class.paths
+    end
+
+    def path(class_name, method_name, params = {})
+      @route_class.path(class_name, method_name, params)
+    end
+  end
+end

data/lib/yes_controller.rb

@@ -0,0 +1,85 @@
+class YesController
+  class << self
+    attr_accessor :before_actions
+    attr_writer :layout
+
+    def layout
+      @layout || Object.const_get(:Layout).new
+    rescue NameError => _e
+      nil
+    end
+
+    def before_action(*symbols)
+      @before_actions = symbols
+    end
+
+    def inherited(subclass)
+      subclass.before_actions = @before_actions
+      super
+    end
+  end
+
+  def initialize(env)
+    @env = env
+  end
+
+  def flash
+    @flash ||= @env['rack.session']['__FLASH__']
+  end
+
+  def session
+    @session ||= @env['rack.session']
+  end
+
+  def response(status, body = nil, headers = { "content-type" => "text/html; charset=utf-8" })
+    [status, headers, [body].compact]
+  end
+
+  def ok(body = nil, headers = { "content-type" => "text/html; charset=utf-8" })
+    response(200, body, headers)
+  end
+
+  def xml(body = nil)
+    ok body, { "content-type" => "text/xml; charset=utf-8" }
+  end
+
+  def redirect(controller_or_url, method_name = nil, params = {})
+    if method_name
+      response 302, nil, { "Location" => path(controller_or_url, method_name, params) }
+    else
+      response 302, nil, { "Location" => controller_or_url }
+    end
+  end
+
+  def params
+    @env["params"]
+  end
+
+  def csrf_value
+    Rack::Csrf.token(@env) if @env['rack.session']
+  end
+
+  def csrf_name
+    Rack::Csrf.field
+  end
+
+  def not_found
+    [404, {"content-type" => "text/plain"}, ["not found"]]
+  end
+
+  def not_found!
+    raise NotFoundError
+  end
+
+  def server_error
+    [500, {"content-type" => "text/plain"}, ["internal server error"]]
+  end
+
+  def server_error!
+    raise ServerError
+  end
+
+  def path(*args)
+    Object.const_get(:App).path(*args)
+  end
+end

data/lib/yes_logger.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class YesLogger < Logger
+  def initialize(*)
+    super
+    @formatter = Yescode::LogfmtFormatter.new
+  end
+end

data/lib/yes_mail.rb

@@ -0,0 +1,88 @@
+Mail.defaults do
+  delivery_method :logger, logger: Logger.new($stdout) if Yescode.env.development?
+end
+
+class YesMail
+  using Refinements
+  include Emote::Helpers
+
+  class << self
+    attr_writer :template_path
+    attr_accessor :_from, :_layout, :_html_view, :_text_view
+
+    def template_path
+      @template_path || File.join(".", "app", "emails")
+    end
+
+    def layout(arg)
+      @_layout = arg
+    end
+
+    def from(arg)
+      @_from = arg
+    end
+
+    def html_view(arg)
+      @_html_view = arg
+    end
+
+    def text_view(arg)
+      @_text_view = arg
+    end
+
+    def inherited(subclass)
+      subclass._from = @_from
+      subclass._layout = @_layout
+      subclass._html_view = @_html_view
+      subclass._text_view = @_text_view
+      super
+    end
+  end
+
+  def deliver
+    raise NotImplementedError
+  end
+
+  def mail(from: nil, to: nil, subject: nil)
+    mail = Mail.new
+    mail[:from] = from || self.class._from
+    mail[:to] = to
+    mail[:subject] = subject
+
+    default_name = self.class.to_s.snake_case
+
+    text = part(self.class._text_view || "#{default_name}.text.emote")
+    html = part(self.class._html_view || "#{default_name}.html.emote")
+
+    text_part = Mail::Part.new do
+      body text
+    end
+
+    html_part = Mail::Part.new do
+      content_type "text/html; charset=UTF-8"
+      body html
+    end
+
+    mail.text_part = text_part
+    mail.html_part = html_part
+
+    mail.deliver
+  end
+
+  private
+
+  def template(name)
+    File.join(self.class.template_path, name)
+  end
+
+  def part(name)
+    content = template(name)
+    layout = template(self.class._layout || "layout")
+
+    if File.exist?(layout)
+      emote(layout, { content: })
+    else
+      emote(content)
+    end
+  end
+end

data/lib/yes_rack_logger.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class YesRackLogger
+  class << self
+    attr_accessor :logger
+  end
+
+  def initialize(app)
+    @app = app
+    @logger = self.class.logger
+  end
+
+  def call(env)
+    log_request(env)
+
+    start_allocations = GC.stat[:total_allocated_objects]
+    response = @app.call(env)
+    allocations = GC.stat[:total_allocated_objects] - start_allocations
+
+    log_response(env, response, allocations)
+
+    response
+  end
+
+  private
+
+  def common_parts(env)
+    {
+      method: env[Rack::REQUEST_METHOD],
+      path: env[Rack::PATH_INFO],
+      remote_addr: env["HTTP_X_FORWARDED_FOR"] || env["REMOTE_ADDR"],
+      protocol: env[Rack::SERVER_PROTOCOL],
+      content_type: env["CONTENT_TYPE"]
+    }
+  end
+
+  def log_request(env)
+    @logger&.info(
+      msg: "Request started",
+      **common_parts(env)
+    )
+  end
+
+  def log_response(env, response, allocations)
+    status, headers = response
+
+    duration = headers["X-Runtime"]
+    content_length = headers[Rack::CONTENT_LENGTH]
+
+    @logger&.info(
+      msg: "Response finished",
+      **common_parts(env),
+      content_length:,
+      status:,
+      duration:,
+      allocations:
+    )
+  end
+end