yokunai 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b9719cad3db06c3cd86fbb4da7f7379c1d551f4
-  data.tar.gz: ac3956b12822a711439af3829e5498d25c144603
+  metadata.gz: 7a9227b92fa543f6f76e9253a517fa657c520ad3
+  data.tar.gz: cda1a80b5cc638eb84518314d70805eb3d7b0987
 SHA512:
-  metadata.gz: 65a27940b072e18723b397dd3ba09358c2f762fd106248927fa7f9ea30b5be71472b2ee1953ed41df6adc5c18629978e7cf0407854f3112b1bab9dd235516b48
-  data.tar.gz: eb6205f88e4041db98d9f7889d6d1be666b8703549e0947bfb15b155a227db2334520127514c180bfa4e73e370a378590e7e42e4ea80542f7b18cbef8c8dca31
+  metadata.gz: 313194f9aea2eb56212f2639dec921f345795fa4329aaa1fb16f4ddef9d40c75441853d54ec933b4f267732b24f369d0c24f695b65afb7561b3f431361aaf317
+  data.tar.gz: fd857f2a8d6185271ae2157db8b74f7bbd99223129f444fd83060d770e4a69ca98a53d77ce06be7adfd0374c635e973b70fe57b8c2c9a4536045598798578c5e

data/README.markdown

@@ -1,4 +1,4 @@
-# よくない
+# よくない [![Build Status](https://ci.blackieops.com/buildStatus/icon?job=yokunai-tests)](https://ci.blackieops.com/job/yokunai-tests/)
 
 It's not very good.
 
@@ -32,15 +32,6 @@ class HomeController < Yokunai::AbstractController
 end
 ```
 
-Add some configuration for where you want to keep things:
-
-```yml
-# config/development.yml
----
-template_dir: web/views
-asset_dir: web/assets
-```
-
 Now just make a rackup config so we can run something:
 
 ```ruby
@@ -56,6 +47,26 @@ run Yokunai::Application.new(
 
 Then just `bundle exec rackup` and you're gold, Ponyboy.
 
+## Configuration
+
+You can configure Yokunai via a YAML file. Create `config/development.yml`
+(where `development` is whatever environment you want to configure). Anything in
+this file will be populated into the `Yokunai::Config` helper, so you can fetch
+things easily with `Yokunai::Config.get("my_key")` anywhere in your app.
+
+For example,
+
+```yml
+# config/development.yml
+---
+template_dir: web/htmls
+some_secret_key: abc123
+```
+
+Some values have defaults to make setup easier, feel free to override any of
+them. An exhaustive list can be found [in the Config class
+itself][config_defaults].
+
 ## Assets
 
 You probably have frontend assets, if this is a web page. There's a controller
@@ -70,3 +81,35 @@ ROUTES = {
 
 Now assets will be served out of the directory you set as your `asset_dir` in
 the YAML config.
+
+## Boot Hooks
+
+If your app needs to do something on-boot (maybe seed a cache, ping an
+orchestrator, etc.) then you can create a "boot hook" to do that. Just create a
+PORO class with a `.run` method, which will be invoked when the app boots.
+
+```ruby
+# lib/my_app/some_hook.rb
+module MyApp
+  class SomeHook
+    def self.run
+      puts "Got hooked"
+    end
+  end
+end
+```
+
+Then pass the class in when you boot the app:
+
+```ruby
+# config.ru
+[...]
+
+run Yokunai::Application(
+  routes: ...,
+  base_dir: ...,
+  hooks: [MyApp::SomeHook]
+)
+```
+
+[config_defaults]: ./lib/yokunai/config.rb

data/lib/yokunai.rb

@@ -3,8 +3,14 @@ require "mimemagic"
 require "ostruct"
 require "yaml"
 
-# Core
+# Setup
+require "yokunai/version"
 require "yokunai/config"
+
+# Boot hooks
+require "yokunai/hooks/config_populator"
+
+# Core
 require "yokunai/application"
 require "yokunai/render_context"
 require "yokunai/template"

data/lib/yokunai/abstract_controller.rb

@@ -8,8 +8,7 @@ module Yokunai
     DEFAULT_HEADERS = {
       "Content-Type" => "text/html",
       "Server" => "yokunai/1.0"
-    }
-
+    }.freeze
 
     # --------------------------------------------------------------------------
     # Instance Methods
@@ -17,13 +16,12 @@ module Yokunai
 
     # @param env [Rack::Env] The Rack ENV
     # @param captures [MatchData] The named captures from the route regex
-    def initialize(env, captures=nil)
+    def initialize(env, captures = nil)
       @env = env
       @captures = captures
       @templates = Yokunai::Template.new
     end
 
-
     # --------------------------------------------------------------------------
     # Default HTTP method handlers
     # --------------------------------------------------------------------------
@@ -52,7 +50,7 @@ module Yokunai
       unsupported_method
     end
 
-  private
+    private
 
     def respond(code: 200, headers: {}, body: "", template: nil, context: {})
       if template
@@ -75,5 +73,9 @@ module Yokunai
       [405, {}, ["Error 405: Method not supported on this resource.\n"]]
     end
 
+    def request
+      @request ||= Rack::Request.new(@env)
+    end
+
   end
 end

data/lib/yokunai/application.rb

@@ -3,28 +3,31 @@ module Yokunai
   # request to the appropriate controller for handling.
   class Application
 
+    # List of default hooks we run on app boot to set up the framework itself.
+    DEFAULT_HOOKS = [
+      Yokunai::Hooks::ConfigPopulator
+    ].freeze
+
     # @param route_map [Hash] A hash with path regexes as keys, and hashes as values with the controller to send matching requests to.
     # @param base_dir [String] The absolute base directory to use for various lookups.
-    def initialize(route_map:, base_dir:)
+    # @param hooks [Array] An optional list of classes which will have their class-level `run` method called when the app boots.
+    def initialize(route_map:, base_dir:, hooks: [])
       @routes = route_map
       Yokunai::Config.base_dir = base_dir
-      Yokunai::Config.populate(ENV["YOKUNAI_ENV"] || "development")
+      (DEFAULT_HOOKS + hooks).each(&:run)
     end
 
     # Route a request to the correct controller based on the given data.
     #
-    # @param path [String] the domain-relative path being requested.
     # @param env [Rack::Env] the full Rack environment
     # @return [Array] a Rack-compatible response array.
     def call(env)
       route = @routes.map do |exp, meta|
         next unless matches = env["PATH_INFO"].match(exp)
-        meta.merge({captures: matches})
+        meta.merge(captures: matches)
       end.compact.first
 
-      unless route
-        return Yokunai::ErrorsController.new(env).not_found
-      end
+      return Yokunai::ErrorsController.new(env).not_found unless route
 
       request_method = env["REQUEST_METHOD"]
       if route[:methods].include?(request_method)

data/lib/yokunai/config.rb

@@ -3,6 +3,12 @@ module Yokunai
   # `config.yml` (or whatever name is passed to `populate`).
   class Config
 
+    # Any key in this hash can be overridden in your app's `config/*.yml`.
+    DEFAULT_CONFIGURATION = {
+      "template_dir" => "web/views",
+      "asset_dir" => "web/assets"
+    }.freeze
+
     # Set the base directory path.
     #
     # @param base_dir [String]
@@ -25,7 +31,10 @@ module Yokunai
     #                      will use the value of YOKUNAI_ENV.
     def self.populate(name = nil)
       name ||= ENV["YOKUNAI_ENV"]
-      @@config = YAML.load_file(File.join(@@base_dir, "config", "#{name}.yml"))
+      config_path = File.join(@@base_dir, "config", "#{name}.yml")
+      user_config = File.exist?(config_path) ? YAML.load_file(config_path) : {}
+
+      @@config = DEFAULT_CONFIGURATION.merge(user_config)
     end
 
     # Get the value of a config option

data/lib/yokunai/hooks/config_populator.rb

@@ -0,0 +1,12 @@
+module Yokunai
+  module Hooks
+    class ConfigPopulator
+
+      # Seed the configuration class on boot.
+      def self.run
+        Yokunai::Config.populate(ENV["YOKUNAI_ENV"] || "development")
+      end
+
+    end
+  end
+end

data/lib/yokunai/static_controller.rb

@@ -9,7 +9,7 @@ module Yokunai
         mime = Yokunai::Mime.detect_from_path(asset_file)
         asset_body = File.read(asset_file)
 
-        respond(body: asset_body, headers: {"Content-Type" => mime})
+        respond(body: asset_body, headers: { "Content-Type" => mime })
       else
         respond_error(:not_found)
       end

data/lib/yokunai/template.rb

@@ -5,7 +5,8 @@ module Yokunai
     FALLBACK_EMPTY_LAYOUT = "<%= partial %>".freeze
 
     def initialize(template_path: nil)
-      @template_path = template_path || File.join(Yokunai::Config.base_dir, Yokunai::Config.get("template_dir"))
+      template_dir = File.join(Yokunai::Config.base_dir, Yokunai::Config.get("template_dir"))
+      @template_path = template_path || template_dir
       @raw_layout = get_layout
     end
 
@@ -19,9 +20,7 @@ module Yokunai
       return nil unless exist?(template)
 
       path = File.join(@template_path, template + ".erb")
-      layout_context = context.merge({
-        partial: ERB.new(File.read(path)).result(Yokunai::RenderContext.new(context).get_binding)
-      })
+      layout_context = context.merge(partial: ERB.new(File.read(path)).result(Yokunai::RenderContext.new(context).get_binding))
 
       ERB.new(@raw_layout).result(Yokunai::RenderContext.new(layout_context).get_binding)
     end

data/lib/yokunai/version.rb

@@ -0,0 +1,3 @@
+module Yokunai
+  VERSION = "0.1.2".freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yokunai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Blackie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,10 +52,12 @@ files:
 - lib/yokunai/application.rb
 - lib/yokunai/config.rb
 - lib/yokunai/errors_controller.rb
+- lib/yokunai/hooks/config_populator.rb
 - lib/yokunai/mime.rb
 - lib/yokunai/render_context.rb
 - lib/yokunai/static_controller.rb
 - lib/yokunai/template.rb
+- lib/yokunai/version.rb
 homepage: https://github.com/alexblackie/yokunai
 licenses:
 - BSD-3-Clause