pakyow-core 0.11.3 → 1.0.0.rc1

data/lib/pakyow/errors.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "json"
+
+require "pakyow/error"
+
+module Pakyow
+  class InvalidData < Error
+    class_state :messages, default: {
+      verification: "Provided data didn't pass verification"
+    }.freeze
+
+    # Failed verifier result.
+    #
+    def result
+      @context[:result]
+    end
+
+    # Object that failed verification.
+    #
+    def object
+      @context[:object]
+    end
+
+    def contextual_message
+      <<~MESSAGE
+        Here's the data:
+
+        #{indent_as_code(JSON.pretty_generate(object))}
+
+        And here are the failures:
+
+        #{indent_as_code(JSON.pretty_generate(result.messages))}
+      MESSAGE
+    end
+  end
+
+  class UnknownCommand < Error
+    class_state :messages, default: {
+      default: "`{command}' is not a known command"
+    }.freeze
+  end
+
+  class UnknownFramework < Error
+    class_state :messages, default: {
+      default: "`{framework}' is not a known framework"
+    }.freeze
+  end
+
+  class UnknownHelperContext < Error
+    class_state :messages, default: {
+      default: "`{context}' is not a known helper context"
+    }.freeze
+  end
+
+  class UnknownType < Error
+    class_state :messages, default: {
+      default: "`{type}' is not a known type"
+    }.freeze
+
+    def contextual_message
+      known_types = @context[:types].each_with_object(String.new) { |known_type, known_types_message|
+        known_types_message << "  - #{known_type.inspect}\n"
+      }
+
+      <<~MESSAGE
+        Try using one of these known types:
+
+        #{known_types}
+      MESSAGE
+    end
+  end
+
+  class UnknownPlugin < Error
+    class_state :messages, default: {
+      default: "`{plugin}' is not a known plugin"
+    }.freeze
+
+    def contextual_message
+      available_plugins = Pakyow.plugins.keys.each_with_object(String.new) { |plugin_name, available_plugins_message|
+        available_plugins_message << "  - #{plugin_name.inspect}\n"
+      }
+
+      <<~MESSAGE
+        Try using one of these available plugins:
+
+        #{available_plugins}
+      MESSAGE
+    end
+  end
+
+  class UnknownValidationError < Error
+    class_state :messages, default: {
+      default: "`{validation}' is not a known validation"
+    }.freeze
+  end
+end

data/lib/pakyow/framework.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "pakyow/environment"
+
+module Pakyow
+  # Base framework class.
+  #
+  class Framework
+    class << self
+      # rubocop:disable Naming/MethodName
+      def Framework(name)
+        Class.new(self) do
+          @framework_name = name
+        end
+      end
+      # rubocop:enabled Naming/MethodName
+
+      def inherited(framework_class)
+        super
+
+        return unless instance_variable_defined?(:@framework_name)
+        Pakyow.register_framework(@framework_name, framework_class)
+      end
+    end
+
+    context = self
+    Pakyow.singleton_class.class_eval do
+      define_method :Framework do |name|
+        context.Framework(name)
+      end
+    end
+
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+    end
+  end
+end

data/lib/pakyow/generator.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "erb"
+require "fileutils"
+require "pathname"
+
+require "pakyow/support/cli/runner"
+require "pakyow/support/class_state"
+require "pakyow/support/extension"
+require "pakyow/support/hookable"
+
+require "pakyow/support/pipeline"
+require "pakyow/support/pipeline/object"
+
+module Pakyow
+  # Base class for generators.
+  #
+  class Generator
+    module Common
+      def dot
+        "."
+      end
+    end
+
+    include Common
+
+    include Support::Hookable
+    events :generate
+
+    attr_reader :files
+
+    def initialize(source_path)
+      @files = Dir.glob(::File.join(source_path, "**/*")).reject { |path|
+        ::File.directory?(path)
+      }.map { |path|
+        File.new(path, source_path, context: self)
+      }
+    end
+
+    def generate(destination_path, options)
+      @destination_path = destination_path
+
+      performing :generate do
+        FileUtils.mkdir_p(destination_path)
+
+        @files.each do |file|
+          file.generate(destination_path, options)
+        end
+      end
+    end
+
+    def run(command, message:)
+      Support::CLI::Runner.new(message: message).run(
+        "cd #{@destination_path} && #{command}"
+      )
+    end
+
+    class File
+      include Common
+
+      include Support::Pipeline::Object
+
+      attr_accessor :path, :logical_path, :content, :context
+
+      def initialize(path, source_path, context: self)
+        @path, @context = path, context
+
+        @logical_path = Pathname.new(path).relative_path_from(
+          Pathname.new(source_path)
+        ).to_s
+
+        @content = ::File.read(@path)
+      end
+
+      def generate(destination_path, options)
+        options.each do |key, value|
+          @context.instance_variable_set(:"@#{key}", value)
+        end
+
+        # Process the file.
+        #
+        Processor.new.call(self)
+
+        # Build the generated file path.
+        #
+        destination_path_for_file = ::File.join(destination_path, @logical_path)
+
+        # Make sure the directory exists.
+        #
+        FileUtils.mkdir_p(::File.dirname(destination_path_for_file))
+
+        # Skip keep files.
+        #
+        unless ::File.basename(@logical_path) == "keep"
+          # Write the file.
+          #
+          ::File.open(destination_path_for_file, "w+") do |file|
+            file.write(@content)
+          end
+        end
+      end
+    end
+
+    class Processor
+      include Support::Pipeline
+
+      action :process_erb
+      action :populate_path
+
+      def process_erb(file)
+        if ::File.extname(file.logical_path) == ".erb"
+          file.logical_path = ::File.join(
+            ::File.dirname(file.logical_path),
+            ::File.basename(file.logical_path, ".erb")
+          )
+
+          erb = if RUBY_VERSION.start_with?("2.5")
+            ERB.new(file.content, nil, "%<>-")
+          else
+            ERB.new(file.content, trim_mode: "%-")
+          end
+
+          file.content = erb.result(
+            file.context.instance_eval { binding }
+          )
+        end
+      end
+
+      PATH_VAR_REGEX = /%([^}]*)%/
+
+      def populate_path(file)
+        file.logical_path.scan(PATH_VAR_REGEX).each do |match|
+          file.logical_path.gsub!("%#{match[0]}%", file.context.send(match[0].to_sym))
+        end
+      end
+    end
+  end
+end

data/lib/pakyow/generators/project/default/%dot%env.erb

@@ -0,0 +1 @@
+SECRET=<%= generate_secret %>

data/lib/pakyow/generators/project/default/%dot%gitignore

@@ -0,0 +1,11 @@
+# Ignore bundler config.
+#
+.bundle
+
+# Ignore specific environment files.
+#
+.env.*
+
+# Ignore local databases.
+#
+database/*.db*

data/lib/pakyow/generators/project/default/%dot%ruby-version.erb

@@ -0,0 +1 @@
+<%= RUBY_VERSION %>

data/lib/pakyow/generators/project/default/Gemfile.erb

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "<%= RUBY_VERSION %>"
+
+<%- if generating_locally? -%>
+gem "pakyow", github: "pakyow/pakyow", require: "pakyow/all"
+<%- else -%>
+gem "pakyow", "~> <%= Pakyow::VERSION %>", require: "pakyow/all"
+<%- end -%>
+
+# Use the puma application server.
+#
+gem "puma"
+
+# Easily manage environment variables.
+#
+gem "dotenv"
+
+group :development do
+  # Speed up project boot time.
+  #
+  gem "bootsnap", require: false
+
+  # Use SQLite3 as the default data source in development.
+  #
+  gem "sqlite3"
+end

data/lib/pakyow/generators/project/default/README.md

@@ -0,0 +1,14 @@
+# Hello, Web
+
+Start your project:
+
+  * From a command prompt, run `pakyow boot`
+
+You can access your project at [`localhost:3000`](http://localhost:3000) from your web browser.
+
+## Learn more
+
+  * Website: https://pakyow.com
+  * Community: https://pakyow.com/talk
+  * Documentation: https://pakyow.com/docs/hello
+  * View Source: https://github.com/pakyow/pakyow

data/lib/pakyow/generators/project/default/config/application.rb.erb

@@ -0,0 +1,17 @@
+Pakyow.app :<%= @project_name %> do
+  # Learn more about configuring an application:
+  #
+  #   * https://pakyow.com/docs/configuration
+  #
+  configure do
+    # Application config for all environments.
+  end
+
+  configure :development do
+    # Application config for the development environment.
+  end
+
+  configure :production do
+    # Application config for the production environment.
+  end
+end

data/lib/pakyow/generators/project/default/config/environment.rb

@@ -0,0 +1,11 @@
+Pakyow.configure do
+  # Global environment configuration.
+end
+
+Pakyow.configure :development do
+  config.data.connections.sql[:default] = "sqlite://database/development.db"
+end
+
+Pakyow.configure :production do
+  config.data.connections.sql[:default] = ENV["DATABASE_URL"]
+end

data/lib/pakyow/generators/project/default/frontend/layouts/default.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+    <%= @human_project_name %>
+  </title>
+
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <link rel="shortcut icon" href="/favicon.ico">
+</head>
+
+<body>
+  <main>
+    <!-- @container -->
+  </main>
+</body>
+</html>

data/lib/pakyow/generators/project/default/public/robots.txt

@@ -0,0 +1 @@
+Allow: /

data/lib/pakyow/generators/project.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "securerandom"
+
+require "pakyow/generator"
+require "pakyow/version"
+
+module Pakyow
+  # @api private
+  module Generators
+    class Project < Generator
+      after "generate" do
+        Bundler.with_clean_env do
+          run "bundle install --binstubs", message: "Bundling dependencies"
+        end
+      end
+
+      def generating_locally?
+        local_pakyow = Gem::Specification.sort_by { |g| [g.name.downcase, g.version] }.group_by(&:name).detect { |k, _| k == "pakyow" }
+        !local_pakyow || local_pakyow.last.last.version < Gem::Version.new(Pakyow::VERSION)
+      end
+
+      def generate_secret
+        SecureRandom.hex(64)
+      end
+    end
+  end
+end

data/lib/pakyow/helpers/app.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pakyow
+  module Helpers
+    # Convenience methods for interacting with the app object.
+    #
+    module App
+      extend Forwardable
+
+      attr_reader :app
+
+      # @!method config
+      #   Delegates to {app}.
+      #
+      #   @see App#config
+      def_delegators :app, :config
+
+      # @!method path
+      #   @return builds the path to a named route (see {Paths#path})
+      #
+      # @!method path_to
+      #   @return builds the path to a route, following a trail of names (see {Paths#path_to})
+      def_delegators :"app.endpoints", :path, :path_to
+    end
+  end
+end

data/lib/pakyow/helpers/connection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pakyow
+  module Helpers
+    # Convenience methods for interacting with the connection object.
+    #
+    module Connection
+      extend Forwardable
+
+      attr_reader :connection
+
+      # @!method app
+      #   Returns the current app.
+      #
+      #   @see App
+      # @!method logger
+      #   Returns the logger.
+      #
+      #   @see Request#logger
+      #
+      # @!method params
+      #   Returns the request params.
+      #
+      #   @see Request#params
+      #
+      # @!method session
+      #   Returns the session.
+      #
+      #   @see Request#session
+      #
+      # @!method :cookies
+      #   Returns cookies.
+      #
+      #   @see Request#:cookies
+      def_delegators :connection, :app, :logger, :params, :session, :cookies
+
+      # @!method operations
+      #   Returns the operations lookup.
+      #
+      def_delegators :app, :operations
+    end
+  end
+end

data/lib/pakyow/info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "pakyow/version"
+
+module Pakyow
+  # Returns information about the environment.
+  #
+  def self.info
+    {
+      versions: {
+        ruby: "v#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})",
+        pakyow: "v#{VERSION}"
+      },
+
+      apps: Pakyow.mounts.map { |mount|
+        {
+          mount_path: mount[:path],
+          class: mount[:app].to_s,
+          reference: mount[:app].config.name.inspect,
+          frameworks: mount[:app].config.loaded_frameworks,
+          app_root: File.expand_path(mount[:app].config.root)
+        }
+      }
+    }
+  end
+end

data/lib/pakyow/integrations/bootsnap.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Configures bootsnap.
+#
+begin
+  require "bootsnap"
+
+  Bootsnap.setup(
+    cache_dir: File.join(Pakyow.config.root, "tmp/cache"),
+    development_mode: Pakyow.env?(:development),
+    load_path_cache: true,
+    autoload_paths_cache: false,
+    disable_trace: false,
+    compile_cache_iseq: true,
+    compile_cache_yaml: true
+  )
+rescue LoadError
+end

data/lib/pakyow/integrations/bundler/require.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Requires the bundle.
+#
+if defined?(Bundler)
+  Bundler.require :default, Pakyow.env
+end

data/lib/pakyow/integrations/bundler/setup.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Requires bundle/setup.
+#
+if defined?(Bundler)
+  require "bundler/setup"
+end

data/lib/pakyow/integrations/dotenv.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Loads environment variables.
+#
+if defined?(Dotenv)
+  env_path = ".env.#{Pakyow.env}"
+  Dotenv.load env_path if File.exist?(env_path)
+  Dotenv.load
+end

data/lib/pakyow/loader.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pakyow/support/inflector"
+require "pakyow/support/makeable"
+
+module Pakyow
+  # Loads files that define an app aspect and names the objects appropriately.
+  #
+  class Loader
+    def initialize(path)
+      @path = path
+    end
+
+    def call(target)
+      code = String.new
+      target.__object_name.namespace.parts.each do |part|
+        code << "module #{Support.inflector.camelize(part)}\n"
+      end
+
+      code << "class #{Support.inflector.camelize(target.__object_name.name)}\n"
+      code << File.read(@path)
+      code << "end\n"
+
+      target.__object_name.namespace.parts.count.times do
+        code << "end\n"
+      end
+
+      eval(code, TOPLEVEL_BINDING, @path, 1 - target.__object_name.namespace.parts.count - 1)
+    end
+  end
+end

data/lib/pakyow/logger/colorizer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "pakyow/support/cli/style"
+
+require "pakyow/logger"
+
+module Pakyow
+  class Logger
+    # Helpers for colorizing log messages.
+    #
+    module Colorizer
+      # Colorizes message based on level.
+      #
+      def self.colorize(message, level)
+        if color = color(level)
+          Support::CLI.style.public_send(color, message)
+        else
+          message
+        end
+      end
+
+      LEVEL_COLORS = {
+        internal: :magenta,
+        debug: :cyan,
+        info: :green,
+        warn: :yellow,
+        error: :red,
+        fatal: :red
+      }.freeze
+
+      # Returns a color for a level.
+      #
+      def self.color(level)
+        LEVEL_COLORS[level]
+      end
+    end
+  end
+end

data/lib/pakyow/logger/destination.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pakyow
+  class Logger
+    class Destination
+      attr_reader :name, :io
+
+      def initialize(name, io)
+        @name, @io = name, io
+      end
+
+      def call(entry)
+        @io.write(entry)
+      end
+    end
+  end
+end