nekonote-framework 1.0.0.pre.beta

data/data/structure/preference/development/public.yml

@@ -0,0 +1,29 @@
+# Publishing Static Files
+
+# Sets directories to publish
+# Files under the directory are published recursively
+published_directory:
+    - css  # public/css/* will be published recursively
+    - js   # public/js/*  will be published recursively
+    - img  # public/img/* will be published recursively
+
+# Sets files to publish
+published_file:
+    - favicon.ico # public/favicon.ico will be published
+
+# Sets headers to add published static files
+custom_header:
+    # Sets HTTP headers to all files located in the ‘public’ directory.
+    all:
+
+    # Sets HTTP headers to files located under a specific directory.
+    directory:
+
+    # Sets HTTP headers to files with a specific file name extension
+    extension:
+
+    # Sets HTTP headers to files matched a specific regular expression.
+    regexp:
+
+    # Sets HTTP headers to most common web font formats.
+    fonts:

data/data/structure/preference/development/route.yml

@@ -0,0 +1,30 @@
+# Routes Configuration
+#
+# e.g.
+# FooHandler:
+#    path: /foo                                                    # This is required. The following directives are optional.
+#    execute: foo                                                  # It says FooHandler#foo method is called when route matches.
+#    method: GET, POST                                             # It says GET or POST requests are accepted.
+#    params: foo=int, bar=string, baz=array, qux=float, quux=bool  # The listed parameters are accepted and are coverted to its expected types.
+#    content: json                                                 # It says Content-Type: application/json is set to response.
+#    template: foo                                                 # static/template/foo.tpl is rendered.
+#    layout: common                                                # static/layout/common.tpl is rendered
+#    # page_cache_time: 3600                                       # if you need page caching this route, need to comment out it.
+#    custom: some value                                            # unknown fields are not directive. It will be assigned into your templates.
+
+# ----------------------
+# Route Options
+# ----------------------
+preference:
+    path_as_regexp: false
+    allow_dup_slash: false
+
+# ----------------------
+# Routes
+# ----------------------
+WelcomeHandler:
+    path: /
+    execute: index
+    template: welcome/index
+    css: /css/welcome.css
+    page-title: Welcome

data/data/structure/preference/development/route_error.yml

@@ -0,0 +1,28 @@
+# Routing for Error Pages
+
+# This route is used when any route does not match a URL.
+# You must set “path_as_regexp” directive to “true” which in route.yml to use this route.
+missing_route:
+    handler: ErrorHandler
+    execute: missing_route
+    layout: error
+
+# This route is used when some value is set to “method” directive in route.y
+#   and a request HTTP method is not declared in that value.
+wrong_http_method:
+    handler: ErrorHandler
+    execute: wrong_http_method
+    layout: error
+
+# This route is used when a fatal error raised in program.
+# The exception object is set to a property called @error in a Handler you specified.
+fatal:
+    handler: ErrorHandler
+    execute: fatal
+    layout: error
+
+# This route is used when a requested file dosen’t exist under the “public” directo
+not_found:
+    handler: ErrorHandler
+    execute: not_found
+    layout: error

data/data/structure/preference/development/route_include.yml

@@ -0,0 +1,22 @@
+# This file is supposed to configure a group of some common preferences to configure routes in route.yml.
+# You may specify common preferences set here by 'include' directive in route.yml.
+#
+# e.g.
+# common:
+#     method: GET
+#     params: id=int
+#     content: json
+#     template: false
+#     layoute: false
+#
+# In order to set the above preferences you must write 'include' directive like:
+#
+# FooHandler:
+#     path: /foo
+#     method: foo
+#     include: common 
+#
+# BarHandler:
+#     path: /bar
+#     method: bar
+#     include: common

data/data/structure/preference/development/server/puma.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env puma
+# Configuration for puma web server.
+# Please check the reference manual of Puma to get more information.
+
+# document root
+# It's supposed to be set absolute path to application root.
+_app_root = 'REPLACE_ME_TO_APP_ROOT'
+
+# host address to bind
+_host = '0.0.0.0'
+
+# listen port
+_port = '2002'
+
+# the directory to oparate out of
+directory _app_root
+
+# where bind to
+# e.g. bind 'unix:///var/run/puma.sock'
+# e.g. bind 'unix:///var/run/puma.sock?umask=0111'
+# e.g. bind "ssl://#{_host}:#{_port}?key=path_to_key&cert=path_to_cert"
+bind "tcp://#{_host}:#{_port}"
+
+# for SSL you may use this instead of 'bind'
+# ssl_bind _host, _port, {
+#   key: path_to_key,
+#   cert: path_to_cert
+# }
+
+# Minimum to maximum number of threads to answer.
+threads 0, 16
+
+# The environment in which the rack's app will run.
+environment 'none'
+
+# true to server is daemonize
+daemonize true
+
+# PID and state for puma web server
+pidfile "#{_app_root}/tmp/pids/puma.pid"
+state_path "#{_app_root}/tmp/pids/puma.state"
+
+# log messages redrect to
+stdout_redirect "#{_app_root}/log/puma.stdout.log", "#{_app_root}/log/puma.stderr.log"
+# If you prefer to that output is appended, please pass true to the third parameter.
+#stdout_redirect "#{_app_root}/log/puma.stdout.log", "#{_app_root}/log/puma.stderr.log", true
+
+# Commented out to disable request logging.
+# quiet
+
+# -------------
+# Cluster mode
+# -------------
+# How many worker precesses to run?
+# The default is 0. It's not clusterized.
+# workers 2
+
+# Worker processes will be restarted when worker processes couldn't resond within this time.
+# It's not request time out. It's used for detecting malfunctional woker processes.
+# worker_timeout 60
+
+# Woker processes' timeout for booting
+# worker_boot_timeout 60

data/data/structure/preference/development/setting/example.yml

@@ -0,0 +1,40 @@
+# User Configuration Files
+#
+# You may configure some constant values here.
+# ====================
+# for example:
+# --------------------
+# foo:
+#     a: 1
+#     b: hello
+#     c: true
+#     d: 0.1
+#     e:
+#         - FOO
+#         - BAR
+#         - BAZ
+# --------------------
+# It's possible to reference them from Handler classes:
+#   __setting_get :foo     #=> {"a"=>1, "b"=>"hello", "c"=>true, "d"=>0.1, "e"=>["FOO", "BAR", "BAZ"]}
+#   __setting_get :foo, :a #=> 1
+#   __setting_get :foo, :b #=> "hello"
+#   __setting_get :foo, :c #=> true
+#   __setting_get :foo, :d #=> 0.1
+#   __setting_get :foo, :e #=> ["FOO", "BAR", "BAZ"]
+#
+# Returns nil in the following cases,
+#   __setting_get          #=> no given anything
+#   __setting_get :bar     #=> no such field
+#   __setting_get :foo, :f #=> no such field in foo:
+#
+# In templates, You must use 'setting_get' tag like: {% setting_get foo, a %}
+# ====================
+ foo:
+     a: 1
+     b: hello
+     c: true
+     d: 0.1
+     e:
+         - FOO
+         - BAR
+         - BAZ

data/data/structure/preference/development/setting/site.yml

@@ -0,0 +1,3 @@
+# site setting
+site:
+    title: Site Title

data/data/structure/preference/development/setting/welcome.yml

@@ -0,0 +1,7 @@
+# constant values for the welcome page
+url:
+    document: https://nekonote-framework.github.io/document
+    gem: https://rubygems.org/gems/nekonote-framework
+    github: https://github.com/khotta/Nekonote-Framework
+    contribute: https://nekonote-framework.github.io/contribute
+    license: https://github.com/khotta/Nekonote-Framework/blob/master/LICENSE

data/data/structure/public/css/layout/common.css

@@ -0,0 +1,11 @@
+body {
+    padding: 0em;
+    margin: 0em;
+    font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+}
+#header-line {
+    height: 1em;
+}
+#content {
+    margin-left: 0.4em;
+}

data/data/structure/public/css/layout/default.css

@@ -0,0 +1,3 @@
+#header-line {
+    background-color: #ff0066;
+}

data/data/structure/public/css/layout/error.css

@@ -0,0 +1,3 @@
+#header-line {
+    background-color: red;
+}

data/data/structure/public/css/welcome.css

@@ -0,0 +1,47 @@
+body {
+  background-color: #f0f0f5;
+}
+
+#content {
+  margin-left: 0.6em;
+  font-family: helvetica, arial, sans-serif;
+}
+#content h3 {
+  color: #e6005c;
+  font-family: 'Open Sans', sans-serif;
+  letter-spacing: 0.1em;
+}
+#content h4 {
+  color: #ff1a1a;
+  font-family: 'Open Sans', sans-serif;
+  letter-spacing: 0.1em;
+  font-weight: normal;
+  margin-top: 2em;
+  margin-bottom: 0.6em;
+}
+#content .description {
+  text-indent: 2em;
+}
+#content em {
+  color: #ff0066;
+}
+#content a {
+  color: #737373;
+  text-decoration: none;
+}
+#content a:hover {
+  color: #ff8566;
+  text-decoration: underline;
+}
+#content #footer-logo {
+  position: fixed;
+  bottom: 5%;
+  right: 5%;
+  background-image: url("/img/logo.png");
+  background-repeat: no-repeat;
+  background-size: 15em 5em;
+  height: 5em;
+  width: 15em;
+}
+
+/*# sourceMappingURL=welcome.css.map */

data/data/structure/static/layout/default.tpl

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<head>
+    <meta charset="UTF-8" />
+    <link rel="stylesheet" type="text/css" href="/css/layout/common.css?1.0.0" />
+    <link rel="stylesheet" type="text/css" href="/css/layout/default.css?1.0.0" />
+    {% if css %}<link rel="stylesheet" type="text/css" href="{{css}}" />{% endif %}
+    {% if title %}<title>{{title}}</title>{% endif %}
+</head>
+<body>
+  <div id="header-line"></div>
+
+  <div id="content">
+    {{content}}
+  </div>
+{% comment %}
+Note: {{content}} is magical. Your template is rendered there.
+{% endcomment %}
+</body>
+</html>

data/data/structure/static/layout/error.tpl

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<head>
+    <meta charset="UTF-8" />
+    <link rel="stylesheet" type="text/css" href="/css/layout/common.css?1.0.0" />
+    <link rel="stylesheet" type="text/css" href="/css/layout/error.css?1.0.0" />
+    {% if css %}<link rel="stylesheet" type="text/css" href="{{css}}" />{% endif %}
+</head>
+<body>
+<div id="header-line"></div>
+
+<div id="content">
+{{content}}
+</div>
+
+</html>

data/data/structure/static/sass/welcome.scss

@@ -0,0 +1,52 @@
+@mixin stylish-font {
+  font-family: 'Open Sans', sans-serif;
+  letter-spacing: 0.1em;
+}
+
+body {
+  background-color: #f0f0f5;
+}
+
+#content {
+  margin-left: 0.6em;
+  font-family: helvetica, arial, sans-serif;
+  h3 {
+    color: #e6005c;
+    @include stylish-font;
+  }
+  h4 {
+    color: #ff1a1a;
+    @include stylish-font;
+    font-weight: normal;
+    margin-top: 2em;
+    margin-bottom: 0.6em;
+  }
+  .description {
+    text-indent: 2em;
+  }
+  em {
+    color: #ff0066;
+  }
+  a {
+    color: #737373;
+    text-decoration: none;
+    &:link {
+    }
+    &:visited {
+    }
+    &:hover {
+      color: #ff8566;
+      text-decoration: underline;
+    }
+  }
+  #footer-logo {
+    position: fixed;
+    bottom: 5%;
+    right: 5%;
+    background-image: url("/img/logo.png");
+    background-repeat: no-repeat;
+    background-size: 15em 5em;
+    height: 5em;
+    width: 15em;
+  }
+}

data/data/structure/static/template/error.tpl

@@ -0,0 +1,4 @@
+<h3 style="color: red;">{{subject}} =(-x-;=</h3>
+<div style="margin-left: 1em;">
+    <p style="color: crimson;">{{msg}}{% if detail %}: {{detail}}{% endif %}</p>
+</div>

data/data/structure/static/template/welcome/index.tpl

@@ -0,0 +1,26 @@
+<div id="content">
+    <h3>Welcome to Nekonote Framework!</h3>
+    <p class="description">{{description}}</p>
+
+    <h4>Information</h4>
+    <ul>
+        <li>The version is <em>{{version}}</em></li>
+        <li>Current Environment: <em>{{env}}</em></li>
+        <li>The Application Root: <em>{{root}}</em></li>
+    </ul>
+
+    <h4>Do you need help?</h4>
+    <ul>
+        <li>Reference Manual <a href="{% setting_get url, document %}">{% setting_get url, document %}</a></li>
+        <li>Contribute <a href="{% setting_get url, contribute %}">{% setting_get url, contribute %}</a></li>
+    </ul>
+
+    <h4>Nekonote Framework is open-source software</h4>
+    <ul>
+        <li>License <a href="{% setting_get url, license %}">{% setting_get url, license %}</a></li>
+        <li>GitHub <a href="{% setting_get url, github %}">{% setting_get url, github %}</a></li>
+        <li>Repository <a href="{% setting_get url, gem %}">{% setting_get url, gem %}</a></li>
+    </ul>
+
+    <div id="footer-logo"></div>
+</div>

data/lib/loader.rb

@@ -0,0 +1,83 @@
+# for bundler
+require 'bundler'
+require 'bundler/setup'
+
+# ========================================
+# auto loading standard and gem libraries
+# ========================================
+# standard libraries
+# TODO need namespace for avoiding declaration
+autoload :Psych, 'yaml'
+autoload :YAML, 'yaml'
+autoload :Singleton, 'singleton'
+autoload :FileUtils, 'fileutils'
+autoload :URI, 'uri'
+
+# dependent gem libraries
+autoload :Rack, 'rack'
+autoload :Liquid, 'liquid'
+autoload :Puma, 'puma/control_cli'
+autoload :SimpleRotate, 'simple_rotate'
+
+# optional gem libraries
+autoload :ConnectionPool, 'connection_pool'
+# for Dalli
+autoload :Dalli, 'dalli'
+begin
+    module Rack
+        module Session
+            autoload :Dalli, 'rack/session/dalli'
+        end
+    end
+rescue LoadError
+    # ignore LoadError in case the set-up hasn't completed yet
+end
+
+# ==============================
+# auto loading internal files
+# ==============================
+module Nekonote
+    @@lib_root_path = File.expand_path(File.dirname(__FILE__)) + '/nekonote/'
+    def self.get_lib_root_path
+        return @@lib_root_path
+    end
+
+    # extends Nekonote module
+    require Nekonote.get_lib_root_path + 'spec'
+    require Nekonote.get_lib_root_path + 'core'
+
+    module Util
+        autoload :Filer, Nekonote.get_lib_root_path + 'util/filer'
+        autoload :Process, Nekonote.get_lib_root_path + 'util/process'
+    end
+
+    [
+        {:class => :Error,           :file => 'exception/error'},
+        {:class => :PageCacheError,  :file => 'exception/page_cache_error'},
+        {:class => :PreferenceError, :file => 'exception/preference_error'},
+        {:class => :ViewError,       :file => 'exception/view_error'},
+        {:class => :CLIError,        :file => 'exception/cli_error'},
+        {:class => :HandlerError,    :file => 'exception/handler_error'},
+        {:class => :LoggerError,     :file => 'exception/logger_error'},
+        {:class => :YamlAccess,      :file => 'yaml_access'},
+        {:class => :Env,             :file => 'env'},
+        {:class => :Preference,      :file => 'preference'},
+        {:class => :Setting,         :file => 'setting'},
+        {:class => :PageCache,       :file => 'page_cache'},
+        {:class => :View,            :file => 'view'},
+        {:class => :TagEnvGet,       :file => 'liquid/tag_env_get'},
+        {:class => :TagSettingGet,   :file => 'liquid/tag_setting_get'},
+        {:class => :Request,         :file => 'request'},
+        {:class => :Handler,         :file => 'handler.rb'},
+        {:class => :Rackup,          :file => 'rackup'},
+        {:class => :Cli,             :file => 'cli'},
+        {:class => :CmdParser,       :file => 'cmd_parser'},
+        {:class => :Puma,            :file => 'puma'},
+        {:class => :RackStaticFile , :file => 'rack/rack_static_file'},
+        {:class => :RackStatic,      :file => 'rack/rack_static'},
+        {:class => :URLMapper,       :file => 'rack/url_mapper'},
+        {:class => :Logger,          :file => 'logger'}
+    ].each do |data|
+        autoload data[:class], Nekonote.get_lib_root_path + data[:file]
+    end
+end