nekonote-framework 1.0.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5de2cc68d527ef357666746ae5cc4423a2c2a0a3
+  data.tar.gz: 68348bd3c64514ea3738588c5678158fb07fe42f
+SHA512:
+  metadata.gz: af4a645150d95e69f18663b56b31d0cb28c54187d1e286df35e9d89254e7295b40eb681b9fcc42dcbe34527be5912cff3c64aef9cf1b926ed2a8a8540de228c6
+  data.tar.gz: 441702f028749ca8df4b0d0770c66cde538f17ff52882d7803e61e23725e1d193cfcd1e67858a45edc4f3e560195c6518cf057b90c292121c9a88618833d4d3d

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Kazuya Hotta
+
+MIT License
+
+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,49 @@
+# Nekonote Framework
+
+Nekonote Framework is a small web application framework that helps your web development.
+
+## Features
+
+### Simple
+"Simplicity" is one of most important things. Nekonote Framework is simple and easy to learn.
+
+### Lightweight
+Nekonote Framework is not full-stack framework. It's small and Lightweight.
+
+### Rack-based
+Nekonote Framework can generate Rack application easily even if you are not familiar with Rack.
+
+### MVC
+Nekonote Framework is designed as Push-MVC based architecture.
+
+### Application Structure
+It's possible to generate a structure of application by running nekonote command.
+
+### Sanitizing
+Nekonote Framework can sanitize HTTP request parameters as your expected.
+
+### Strict Routes
+You can configure routes easily by the configuration files. You may set some rules to them.
+
+### Error Pages
+You may configure routes for error pages by the configuration file.
+
+### Separable Environments
+It's possible to separate the configuration files by environments.
+
+### GUI Debuger
+The GUI-based debugger can display exception details on your browser.
+
+### Multiprocess-safe Logger
+Nekonote Framework provides you safety logging. It's multiprocess-safety and thread-safety.
+
+### Liquid Template Engine
+Liquid is a well-known powerful template engine. Templates are rendered by Liquid.
+
+## Getting Started
+
+Please see [Getting Started](https://nekonote-framework.github.io/document/1.0.0-beta/getting-started.html) on the reference manual.
+
+## License
+
+Nekonote Framework is friendly license and is released under the [MIT License](https://opensource.org/licenses/MIT).

data/bin/nekonote

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+begin
+    begin
+        require 'color_echo'
+        require 'nekonote'
+    rescue LoadError
+        # couldn't find them in LOAD_PATH
+        # installed via bundler? change LOAD_PATH to bundler
+        require 'bundler/setup'
+        require 'color_echo'
+        require 'nekonote'
+    end
+
+rescue LoadError => e
+    warn 'LoadError: ' + $/ + %(    #{e.message})
+    exit 1
+end
+
+begin
+    root = nil
+
+    # parse options
+    parser = Nekonote::CmdParser.new $*
+    if parser.version_option?
+        Nekonote::Cli.version
+
+    elsif parser.help_option?
+        Nekonote::Cli.usage
+
+    elsif parser.root_option?
+        root = parser.get_op_val_root
+        raise Nekonote::CLIError, 'Missing value with --root option.' if root == nil
+    end
+
+    options = {
+        :root => root
+    }
+
+    cmd, subcmd, val = parser.parse_un_options
+    Nekonote::Cli.new(cmd, subcmd, val, options).exec
+
+rescue StandardError, ScriptError => e
+    Nekonote::Error.abort e
+end

data/data/structure/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Nekonote Framework
+#   Copyright (c) 2017, Kazuya Hotta
+#   License https://github.com/khotta/Nekonote-Framework/blob/master/LICENSE
+gem 'nekonote-framework', 'REPLACE_ME_TO_NEKONOTE_VERSION'
+gem 'simple_rotate', '~> 1.2', '>= 1.2.0'
+gem 'color_echo', '~> 3.1', '>= 3.1.1'
+
+# Rack
+#   Copyright (c) 2007-2016 Christian Neukirchen <purl.org/net/chneukirchen>
+#   License https://github.com/rack/rack/blob/master/COPYING
+gem 'rack', '~> 2.0', '>= 2.0.3'
+
+# Liquid
+#   Copyright (c) 2005, 2006 Tobias Luetke
+#   License https://github.com/Shopify/liquid/blob/master/LICENSE
+gem 'liquid', '~> 4.0', '>= 4.0.0'
+
+# Puma
+#   Some code copyright (c) 2005, Zed Shaw
+#   Copyright (c) 2011, Evan Phoenix
+#   License https://github.com/puma/puma/blob/master/LICENSE
+#   Note: It seems that 'restart' doesn't work with 'bundler exec' in version 3.9.2
+gem 'puma', '3.8.2'

data/data/structure/config.ru

@@ -0,0 +1,14 @@
+# This is a configuration file about Rack which created automatically.
+# You must NOT delete this file.
+
+# for starting web server withouht 'nekonote server'
+if !defined? Nekonote
+    require 'bundler/setup'
+    require 'nekonote'
+end
+
+# set-up your application
+Nekonote.set_root File.expand_path(File.dirname(__FILE__)) if !Nekonote.has_root?
+self.instance_exec &Nekonote::Rackup.instance.use_middlewares
+self.instance_exec Nekonote::Preference.instance.get_public, &Nekonote::Rackup.instance.define_public_dir
+self.instance_exec Nekonote::Preference.instance.get_route,  &Nekonote::Rackup.instance.define_route

data/data/structure/handler/base.rb

@@ -0,0 +1,21 @@
+# BaseHandler class
+#
+# BaseHandler class is a mechanism for code reuse in each Handler classes.
+# All Handler classes are supposed to be inherited from this class.
+
+class BaseHandler < Nekonote::Handler
+    # This method will be executed at first
+    def __pre
+    end
+
+    # This method will be executed at last
+    def __post
+        if @custom_fields['page-title'].is_a? String
+            base = __setting_get :site, :title
+            if base != nil
+                list = {:title => "#{@custom_fields['page-title']} - #{base}"}
+                __assign list
+            end
+        end
+    end
+end

data/data/structure/handler/error.rb

@@ -0,0 +1,35 @@
+class ErrorHandler < BaseHandler
+    def missing_route
+        @subject = 'Invalid URL'
+        @msg     = 'The URL does not match any route'
+        @detail  = %('#{Nekonote::Env.get :REQUEST_URI}' does not match any route.)
+    end
+
+    def wrong_http_method
+        @subject = 'Unacceptable HTTP method'
+        @msg     = 'You have accessed with the unacceptable HTTP method.'
+    end
+
+    def fatal
+        @subject = 'Server Error'
+        @msg     = 'You can not access this page temporary.'
+    end
+
+    def not_found
+        @subject = 'No such resource'
+        @msg     = %('#{Nekonote::Env.get :REQUEST_URI}' was not found on the server.)
+    end
+
+    # It will be called at last
+    def __post
+        # assign values to templates
+        list = {}
+        list['subject'] = @subject if defined?(@subject)
+        list['msg']     = @msg     if defined?(@msg)
+        list['detail']  = @detail  if defined?(@detail)
+        __assign list
+
+        # change the response code to not 500 but 200
+        __set_code 200
+    end
+end

data/data/structure/handler/welcome.rb

@@ -0,0 +1,11 @@
+class WelcomeHandler < BaseHandler
+    def index
+        variables = {
+            'version'     => Nekonote::VERSION,
+            'description' => Nekonote::DESCRIPTION,
+            'root'        => Nekonote.get_root,
+            'env'         => Nekonote::Env.current
+        }
+        __assign variables
+    end
+end

data/data/structure/preference/development/logger.yml

@@ -0,0 +1,62 @@
+# Logger Configuration
+
+# false to disable
+# true to enable
+enabled: true
+
+# Path to a logfile which is supposed to be written log messages.
+# e.g. log/%s.log
+logfile: log/%s.log
+
+# Configures if the logger writes the exception details to the log file when some exception raised.
+write_exception: true
+
+# Log message format
+# log:
+#   Configures a log message format.
+# datetime:
+#   The date format for the variable $DATE in ‘log’ directive. 
+format:
+    log: "$DATE [$LEVEL] $LOG"
+    datetime: "%a %d %b %H:%M:%S"
+
+# Sets from which log severity levels are should be reported to the log file.
+threshold: debug
+
+# The default log severity level for log messages
+default_log_level: info
+
+# Sets the threshold to rotate log files.
+limit: 1G
+
+# Sets the maximum number of old log files.
+# 0 to keeping all old log files. 
+keep: 0
+
+# Configures if old log files are compressed when rotation is done.
+# enabled:
+#   false to disabled
+#   true to enabled
+# level:
+#   Compression level for gzip.
+compress:
+    enabled: false
+    level: 6
+
+# false to log messages are written to only log files.
+# true to log messages are written to stdout as well.
+with_stdout: false
+
+# false to the warning messsages are ignored.
+# ture to the warning messages are written to the log files.
+verbose: true
+
+# When this directive is set ‘true’, the logger can be multi-processes safe
+psync: true
+
+# Program will wait for this seconds after rotation was done.
+sleeptime: 0.1
+
+# false to disbale flushing buffered data after writing a log message to the log file.
+# true to enable flushing buffered data.
+flush: true

data/data/structure/preference/development/middlewares.rb

@@ -0,0 +1,152 @@
+# You may add any configurations of Rack middlewares here.
+# Please prepend underscore to beginning of your variable name to avoid naming conficts.
+# Some configuration are listed by default. You may set them enabling or disbaling.
+#
+# --------------------------------------------------------------------------
+# Rack::Reloader
+#   It reloads modified files without restarting nor reloading the web server.
+# --------------------------------------------------------------------------
+_cooldown = 10
+use Rack::Reloader, _cooldown
+
+# -------------------------------------------------------------------------------------------------
+# Rack::ShowExceptions
+#   A GUI based debugger. It's won't work when 'fatal' route is set in route_error.yml.
+#   You are supposed to DISABLE this function on production environment for security reason.
+# -------------------------------------------------------------------------------------------------
+use Rack::ShowExceptions
+
+# -------------------------------------------
+# Rack::Auth::Basic
+#   It provides Basic access authentication.
+# -------------------------------------------
+=begin
+_realm    = 'Here is secret zone'
+_username = 'username_here'
+_passwd   = 'password_here'
+use Rack::Auth::Basic, _realm do |username, passwd|
+    username == _username && passwd == _passwd
+end
+=end
+
+# --------------------------------------------
+# Rack::Auth::Digest::MD5
+#   It provides Digest access authentication.
+# --------------------------------------------
+=begin
+_realm    = 'Here is secret zone'
+_opaque   = 'replace_me' # this is supposed to be set to a long random string
+_username = 'username_here'
+_passwd   = 'password_here'
+_pw = {_username => _passwd}
+use Rack::Auth::Digest::MD5, _realm, _opaque do |username|
+    _pw[username]
+end
+=end
+
+# ==========================
+# Preferences for Session Management
+# ==========================
+_key          = 'rack.session'
+_domain       = nil
+_path         = '/'
+_expire_after = 3600
+_secure       = false
+_httponly     = false
+_sidbits      = 128
+
+_session_options = {
+    :key          => _key,
+    :domain       => _domain,
+    :path         => _path,
+    :expire_after => _expire_after,
+    :secure       => _secure,
+    :httponly     => _httponly,
+    :sidbits      => _sidbits
+}
+_session_options[:domain] = _domain if _domain != nil
+
+# ---------------------------------------------------------------------
+# Rack::Session::Cookie
+#   It provides cookie based simple session management.
+# ---------------------------------------------------------------------
+# use Rack::Session::Cookie, _session_options
+
+# --------------------------------------------------------------------------------------
+# Rack::Session::Pool
+#   It provides property-based session management.
+# --------------------------------------------------------------------------------------
+=begin
+_drop = false
+_session_pool_options = {
+    :drop => _drop
+}
+use Rack::Session::Pool, _session_options.merge(_session_pool_options)
+=end
+
+# ----------------------------------------------------------------------------------
+# Rack::Session::Dalli
+#   It provides memcached based session management.
+#   You must add 'dalli' to your Gemefile and typing bundle install to use it.
+# ----------------------------------------------------------------------------------
+=begin
+_servers = ['127.0.0.1:11211'] # you may add any number of servers by comma
+_connection_pooling = false
+
+# options for dalli client
+_namespace  = 'nekonote.session'
+_failover   = true
+_threadsafe = true
+_expires_in = 0
+_compress   = false
+_dalli_client_options = {
+    :namespace  => _namespace,
+    :failover   => _failover,
+    :threadsafe => _threadsafe,
+    :expires_in => _expires_in,
+    :compress   => _compress
+}
+
+# options for connection pooling
+# they will work when connection pooling is enbaled
+_size    = 5
+_timeout = 5
+_dalli_pool_options = {
+    :size    => _size,
+    :timeout => _timeout
+}
+
+# setup dalli
+require 'dalli'
+
+if _connection_pooling
+    # enable connection pooling
+    _dalli_client = ::Dalli::Client.new _servers, _dalli_client_options
+    _cache = ::ConnectionPool::Wrapper.new(_pool_options) {_dalli_client}
+else
+    # disable connection pooling
+    _cache = ::Dalli::Client.new _servers, _dalli_client_options
+end
+
+_dalli_options = {
+    :cache => _cache
+}
+use Rack::Session::Dalli, _session_options.merge(_dalli_options)
+=end
+
+# -----------------------------------------------------------------------------------------
+# Rack::Access
+#   It provides access restrcition based on IP address.
+#   You must add 'rack-contrib' to your Gemefile and typing bundle install to use it.
+# -----------------------------------------------------------------------------------------
+# Restricting access by IP addresses.
+# Note: You may append subnet mask to a IP address.
+# Note: You may specify any number of ipmasks by comma.
+=begin
+_rules = {
+    # '/location' => ['ipmasks' ,...]
+    '/' => ['127.0.0.1'] #,...
+}
+require 'rack/contrib'
+use Rack::Access, _rules
+=end