ramverk 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3be3ea670be24bfeae059cca40a71c25e8160bcf2e6e8439af96e8026b839a98
+  data.tar.gz: 514a6b5dd743ab1e4d6ed4d43cc5f34585cd8f2c51af325a532368bb3a73dae5
+SHA512:
+  metadata.gz: 813cf0310b75b77147415d47c776b26425fa36821d85f31870a5c1ba41f628f4311dd14f8c799046e10efdcf985926f4174e0f9b414773147383509f0cc01763
+  data.tar.gz: 63b93fb9c45997b7b6f66af7258ff2911c437c552c2c1a21fb56d16cf8e0f87bfc650496fa3070cf5297f21a96049b126b82bf099b41ad175321ff7dc022e888

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+.DS_Store
+/doc
+/spec/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require: rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  DisplayCopNames: true
+  Exclude:
+    - "*.gemspec"
+    - "Gemfile"
+
+Performance:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*"

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+script: "bundle exec rake spec:coverage"
+cache: bundler
+env:
+  global:
+    - CODECOV_TOKEN="52b505b7-f1b3-46d1-b6ec-efc17dd4558f""
+before_install:
+  - "gem update --system"
+rvm:
+  - 3.0.0
+  - 2.7.0
+  - 2.6.0
+  - ruby-head
+  - jruby
+  - jruby-head
+  - truffleruby
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: truffleruby
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+-m markdown

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rubocop"
+gem "rubocop-performance"
+
+gem "simplecov"
+gem 'codecov', require: false
+
+gem "byebug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tobias Sandelius
+
+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 SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Ramverk
+
+Ramverk is a web application framework written in Ruby.
+
+The goal of Ramverk is to keep the core framework as neat as possible and only include basic functionality like logging, constant autoloading. We rather add, than remove, functionality.
+
+## Inspirations
+
+- Ruby on Rails
+- Phoenix Framework
+- Hanami
+- Sinatra
+
+## Status
+
+Under development, not ready for prime-time just yet.
+
+[![Build Status](https://travis-ci.org/sandelius/ramverk.svg?branch=master)](https://travis-ci.org/sandelius/ramverk)
+[![codecov](https://codecov.io/gh/sandelius/ramverk/branch/master/graph/badge.svg)](https://codecov.io/gh/sandelius/ramverk)
+
+## Installation
+
+Ramverk supports Ruby (MRI) 2.6+ and JRuby 9.2+
+
+```
+$ gem install ramverk
+```
+
+## Usage
+
+```bash
+$ ramverk new petstore
+```
+
+```bash
+$ cd petstore && bundle && ramverk server
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sandelius/ramverk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  task :coverage do
+    ENV["COVERAGE"] = "true"
+    Rake::Task["spec"].invoke
+  end
+end
+
+task default: :spec

data/bin/ramverk

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler"
+require "ramverk/cli/command"
+
+Ramverk::Cli::Command.start

data/lib/ramverk/cli/command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "ramverk/cli/commands/base"
+
+module Ramverk
+  module Cli
+    class Command < Commands::Base
+      # $ ramverk version
+      require "ramverk/cli/commands/version"
+
+      # $ ramverk new PROJECT_NAME
+      require "ramverk/cli/commands/new"
+
+      # $ ramverk server
+      require "ramverk/cli/commands/server"
+
+      # $ ramverk console
+      require "ramverk/cli/commands/console"
+    end
+  end
+end

data/lib/ramverk/cli/commands/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "thor"
+require "shellwords"
+require "ramverk/version"
+require "ramverk/string"
+
+module Ramverk
+  module Cli
+    module Commands
+      # @abstract
+      class Base < Thor
+        include Thor::Actions
+
+        # @private
+        self.source_paths << File.expand_path("../templates", __dir__)
+
+        no_commands do
+          def env
+            (ENV["APP_ENV"] || ENV["RACK_ENV"] || :development).to_sym
+          end
+
+          def escape(string)
+            Shellwords.escape(string)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ramverk/cli/commands/console.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Ramverk::Cli::Command.class_eval do
+  desc "console", "Starts an interactive console session"
+  def console
+    puts "Loading #{env} environment..."
+
+    # Clear ARGV so IRB dont parse it
+    ARGV.shift until ARGV.empty?
+
+    # Add reload! helper method to console
+    TOPLEVEL_BINDING.eval("self").__send__(:include, Ramverk::Console::CodeReloading)
+
+    require File.expand_path("config/boot", Dir.pwd)
+
+    # Avoid "irb: warn: can't alias context from irb_context."
+    RSpec.configuration.disable_monkey_patching! if defined?(RSpec)
+
+    require "irb"
+    IRB.start
+  end
+end
+
+module Ramverk
+  class Console
+    module CodeReloading
+      # @private
+      def reload!
+        puts 'Reloading...'
+        Ramverk.configuration.autoload_loader.reload
+      end
+    end
+  end
+end

data/lib/ramverk/cli/commands/new.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Ramverk::Cli::Command.class_eval do
+  desc "new PROJECT_NAME", "Generates a new project structure"
+  def new(project_name)
+    project_name = escape(project_name)
+    project_name = Ramverk::String.underscore(project_name)
+    project_namespace = Ramverk::String.classify(project_name)
+
+    config = {
+      project_name: project_name,
+      project_namespace: project_namespace
+    }
+
+    root = Pathname.new(Dir.pwd).join(project_name)
+
+    template "new/.gitignore.tt", root.join(".gitignore"), config
+    template "new/Gemfile.tt", root.join("Gemfile"), config
+    template "new/Rakefile.tt", root.join("Rakefile"), config
+    template "new/config.ru.tt", root.join("config.ru"), config
+    template "new/.env.example.tt", root.join(".env.example"), config
+    template "new/.env.test.tt", root.join(".env.test"), config
+    template "new/.env.development.tt", root.join(".env.development"), config
+
+    template "new/lib/project.rb.tt", root.join("lib", "#{project_name}.rb"), config
+    create_file root.join("lib", project_name, ".gitkeep")
+
+    template "new/config/environment.rb.tt", root.join("config", "environment.rb"), config
+    template "new/config/boot.rb.tt", root.join("config", "boot.rb"), config
+
+    template "new/spec/spec_helper.rb.tt", root.join("spec", "spec_helper.rb"), config
+    template "new/spec/lib/project_spec.rb.tt", root.join("spec", "lib", "#{project_name}_spec.rb"), config
+    create_file root.join("spec", "support", ".gitkeep")
+  end
+end

data/lib/ramverk/cli/commands/server.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rack"
+
+Ramverk::Cli::Command.class_eval do
+  desc "server", "Starts the development server"
+  method_option :port, type: :numeric, aliases: "-p", default: 3000
+  def server
+    environment = ENV["APP_ENV"] || ENV["RACK_ENV"] || "development"
+
+    Ramverk::Server.new(
+      config: "config.ru",
+      Host: "0.0.0.0",
+      Port: options[:port],
+      AccessLog: [],
+      environment: environment
+    ).start
+  end
+end
+
+module Ramverk
+  class Server < Rack::Server
+    def middleware
+      mw = ::Hash.new { |e, m| e[m] = [] }
+      mw["development"].concat([::Rack::ShowExceptions])
+      mw
+    end
+  end
+end

data/lib/ramverk/cli/commands/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Ramverk::Cli::Command.class_eval do
+  desc "version", "Print framework version"
+  def version
+    puts Ramverk::VERSION
+  end
+end

data/lib/ramverk/cli/templates/new/.env.example.tt

@@ -0,0 +1,7 @@
+
+# This is an example file that should show all required ENV variables.
+#
+# This file is also included in version control so DO NOT add and real
+# credentials in here.
+
+ENV_VAR=env_value

data/lib/ramverk/cli/templates/new/.gitignore.tt

@@ -0,0 +1,25 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+
+# Assets
+/node_modules
+
+# Dotenv
+/.env
+/.env.development
+/.env.test
+
+# Misc
+.byebug_history
+.DS_Store
+/coverage

data/lib/ramverk/cli/templates/new/Gemfile.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# A make-like build utility for Ruby.
+gem "rake"
+
+# The Ruby Application Framework.
+gem "ramverk", "~> <%= Ramverk::VERSION %>"
+
+group :development, :test do
+  # A Ruby gem to load environment variables from `.env`.
+  gem "dotenv", "~> 2.7"
+end
+
+group :test do
+  # Behaviour Driven Development for Ruby.
+  gem "rspec", "~> 3.8"
+  # Rack::Test is a layer on top of Rack's MockRequest.
+  gem "rack-test", "~> 1.1"
+end

data/lib/ramverk/cli/templates/new/Rakefile.tt

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "config/environment"

data/lib/ramverk/cli/templates/new/config/boot.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is only used when booting up your application outside of a web
+# request. Background workers is one common use case where this file should
+# be loaded.
+
+require_relative "environment"
+
+Ramverk.boot

data/lib/ramverk/cli/templates/new/config/environment.rb.tt

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ramverk/setup"
+
+Ramverk.configure do |config|
+  # Paths of which Ramverk will autoload constants.
+  config.autoload_paths << "lib"
+
+  # DEVELOPMENT
+
+  config.environment :development do
+  end
+
+  # TEST
+
+  config.environment :test do
+  end
+
+  # PRODUCTION
+
+  config.environment :production do
+  end
+end

data/lib/ramverk/cli/templates/new/config.ru.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "config/environment"
+
+run Ramverk.rack

data/lib/ramverk/cli/templates/new/lib/project.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module <%= config[:project_namespace] %>
+end

data/lib/ramverk/cli/templates/new/spec/lib/project_spec.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe <%= config[:project_namespace] %> do
+  it "works" do
+    expect(true)
+      .to eq(true)
+  end
+end

data/lib/ramverk/cli/templates/new/spec/spec_helper.rb.tt

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+ENV["APP_ENV"] = "test"
+
+require_relative "../config/boot"
+
+# Requires supporting ruby files used for testing.
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Disable monkey-pachting core ruby.
+  config.disable_monkey_patching!
+end

data/lib/ramverk/configuration/dynamic_groups.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Ramverk
+  class Configuration
+    # Module for creating configuration items on the fly.
+    module DynamicGroups
+      # @private
+      def method_missing(meth, *args, &block)
+        return super unless meth.to_s.end_with?("=")
+
+        key = meth.to_s.sub("=", "")
+        dynamic_groups[key] = args.first
+
+        define_singleton_method(key) { dynamic_groups[key] }
+      end
+
+      # @private
+      # :nocov:
+      def respond_to_missing?(name, include_private = false)
+        super
+      end
+      # :nocov:
+
+      # @private
+      def freeze
+        dynamic_groups.freeze
+        dynamic_groups.each_value(&:freeze)
+
+        super
+      end
+
+      private
+
+      # @private
+      def dynamic_groups
+        @dynamic_groups ||= {}
+      end
+    end
+  end
+end

data/lib/ramverk/configuration/middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Ramverk
+  class Configuration
+    # Middleware manager.
+    class Middleware
+      # Return all registered middleware in the stack.
+      #
+      # @return [Array]
+      attr_reader :stack
+
+      # @private
+      def initialize
+        @stack = []
+      end
+
+      # Append a middleware to the stack.
+      #
+      # @param middleware [Class]
+      # @param *args [*]
+      # @param &block [Proc]
+      def append(middleware, *args, &block)
+        @stack << [middleware, args, block].freeze
+      end
+      alias use append
+
+      # Prepend a middleware to the stack.
+      #
+      # @param middleware [Class]
+      # @param *args [*]
+      # @param &block [Proc]
+      def prepend(middleware, *args, &block)
+        @stack.unshift [middleware, args, block].freeze
+      end
+
+      def run
+
+      end
+
+      # @private
+      def freeze
+        @stack.freeze
+
+        super
+      end
+    end
+  end
+end