keight 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4b037e58fd8fe6bf09a20d6d682b749eb33aa1
-  data.tar.gz: ad00095bed413d481bba4c1ad309e93a5363781e
+  metadata.gz: bc49bd013923bbf4714db247133b1dee371519d3
+  data.tar.gz: f5cda960b9bd0772aae79b835ceca64ae7470c5e
 SHA512:
-  metadata.gz: 6ad2bde75007e0b5b65349d899f05cc27b85146845702e3057d888df325288a87bc182575e9752db1c24c5fb0ae79fa4e9965c0e3fd8e8e9127453bda55fa6fc
-  data.tar.gz: f9fa23872351a09629b3365d312ff5d4b45fdff6c90aa2cebd7f905f2ac3f9157ec1f51d1fe93fa2ab5c52a7e3ddf8ea361e302f04810d5b4687363b3e10c38e
+  metadata.gz: 32ef664b317f9c4053f1bad16e61de02616bcec598d40eb566f278fcc9e87ac35511c6f031cd91a26fae2c06a9de088b2ee8db80530b7966473878f6e613c3d7
+  data.tar.gz: e45639182983542961cda6d1dfc9bdb7b4e6b282a235162a66dabe74da220bd0cdd46b177d5b4d2410a67ef48fc0d0bfa60dca17bf58fdf559a17b4f65eef4d6

data/README.md

@@ -1,7 +1,7 @@
 Keight.rb README
 ================
 
-($Release: 0.0.1 $)
+($Release: 0.1.0 $)
 
 
 Overview
@@ -41,10 +41,16 @@ Quick Tutorial
 --------------
 
 ```console
+$ ruby -v     # required Ruby >= 2.0
+ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14]
+$ mkdir gems
+$ export GEM_HOME=$PWD/gems
+$ export PATH=$GEM_HOME/bin:$PATH
+
 $ gem install keight
 $ vi hello.rb
-$ vi config.ru
-$ rackup -c config.ru -p 8000
+$ vi config.ru     # != 'config.rb'
+$ rackup -p 8000 config.ru
 ```
 
 hello.rb:
@@ -82,24 +88,38 @@ config.rb:
 require 'keight'
 require './hello'
 
-app = K8::RackApplication.new
+app = K8::RackApplication.new()
 app.mount '/hello', HelloAction
 
+### or
+#mapping = [
+#  ['/api', [
+#    ['/hello'         , "./hello:HelloAction"],
+#  ]],
+#]
+#app = K8::RackApplication.new(mapping)
+
 run app
 ```
 
-Open http://localhost:8000/hello or http://localhost:8000/hello/123 by browser.
+Open http://localhost:8000/hello or http://localhost:8000/hello/123
+with your browser.
 
 Do you like it? If so, try `k8rb init myapp1` to generate project skeleton.
 
 ```console
 $ k8rb init myapp1
-$ cd myapp1
+$ cd myapp1/
 $ export APP_ENV=dev    # 'dev', 'prod', or 'stg'
 $ k8rb mapping
 $ k8rb configs
-$ rackup -c config.ru -p 8000
-$ ab -n 1000000 -c 100 http://127.0.0.1:8000/api/hello
+$ rackup -p 8000 -E production config.ru
+$ open http://127.0.0.1:8000/
+$ ab -n 1000 -c 10 http://127.0.0.1:8000/api/hello
+## or:
+$ gem install puma
+$ rackup -p 8000 -E production -s puma config.ru
+$ ab -n 10000 -c 100 http://localhost:8000/api/hello
 ```
 
 

data/bench/benchmarker.rb

@@ -1,5 +1,5 @@
 ###
-### $Release: 0.0.1 $
+### $Release: 0.1.0 $
 ### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -7,7 +7,7 @@
 
 module Benchmarker
 
-  VERSION = "$Release: 0.0.1 $".split(/ /)[1]
+  VERSION = "$Release: 0.1.0 $".split(/ /)[1]
 
   def self.new(opts={}, &block)
     #: creates runner object and returns it.

data/bin/k8rb

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 0.0.1 $
+### $Release: 0.1.0 $
 ### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/keight.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |o|
   o.name          = "keight"
-  o.version       = "$Release: 0.0.1 $".split[1]
+  o.version       = "$Release: 0.1.0 $".split[1]
   o.author        = "makoto kuwata"
   o.email         = "kwa(at)kuwata-lab.com"
   o.platform      = Gem::Platform::RUBY
@@ -31,6 +31,7 @@ END
   o.test_file     = "test/keight_test.rb"
 
   o.required_ruby_version = '>= 2.0'
+  o.add_runtime_dependency 'rack', '~> 1.6'
   o.add_runtime_dependency 'baby_erubis', '~> 2.1', '>= 2.1.1'
   #o.add_development_dependency "oktest", "~> 0"
 end

data/lib/keight.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 0.0.1 $
+### $Release: 0.1.0 $
 ### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -432,6 +432,10 @@ module K8
   end
 
 
+  class UnknownActionMethodError < BaseError
+  end
+
+
   class UnknownContentError < BaseError
   end
 
@@ -1091,12 +1095,13 @@ module K8
     end
 
     def _mount(mappings, urlpath_pattern, action_class)
+      child_mappings = nil
       #; [!4l8xl] can accept array of pairs of urlpath and action class.
       if action_class.is_a?(Array)
         array = action_class
         child_mappings = []
         array.each {|upath, klass| _mount(child_mappings, upath, klass) }
-        action_class = child_mappings
+        action_class = nil
       #; [!ne804] when target class name is string...
       elsif action_class.is_a?(String)
         str = action_class
@@ -1106,11 +1111,22 @@ module K8
         action_class.is_a?(Class) && action_class < BaseAction  or
           raise ArgumentError.new("mount('#{urlpath_pattern}'): Action class expected but got: #{action_class.inspect}")
       end
+      #; [!30cib] raises error when action method is not defined in action class.
+      _validate_action_method_existence(action_class) if action_class
       #; [!flb11] mounts action class to urlpath.
-      mappings << [urlpath_pattern, action_class]
+      mappings << [urlpath_pattern, action_class || child_mappings]
     end
     private :_mount
 
+    def _validate_action_method_existence(action_class)
+      action_class._action_method_mapping.each do |_, action_methods|
+        action_methods.each do |req_meth, action_method_name|
+          action_class.method_defined?(action_method_name)  or
+            raise UnknownActionMethodError.new("#{req_meth.inspect}=>#{action_method_name.inspect}: unknown action method in #{action_class}.")
+        end
+      end
+    end
+
     def _load_action_class(str, error)
       #; [!9brqr] raises error when string format is invalid.
       filepath, classname = str.split(/:/, 2)
@@ -1497,28 +1513,28 @@ module K8
       end
       begin
         #; [!rz13i] returns HTTP 404 when urlpath not found.
-        tuple = find(req.path)  or
+        tuple4 = find(req.path)  or
           raise HttpException.new(404)
-        action_class, action_methods, urlpath_param_names, urlpath_param_values = tuple
+        action_class, action_methods, urlpath_param_names, urlpath_param_values = tuple4
         #; [!rv3cf] returns HTTP 405 when urlpath found but request method not allowed.
         action_method = action_methods[req_meth_]  or
           raise HttpException.new(405)
         #; [!0fgbd] finds action class and invokes action method with urlpath params.
         action_obj = action_class.new(req, resp)
         content = action_obj.handle_action(action_method, urlpath_param_values)
-        tuple = [resp.status, resp.headers, content]
+        ret = [resp.status, resp.headers, content]
       rescue HttpException => ex
-        tuple = handle_http(ex, req, resp)
+        ret = handle_http(ex, req, resp)
       rescue Exception => ex
-        tuple = handle_error(ex, req, resp)
+        ret = handle_error(ex, req, resp)
       ensure
         #; [!vdllr] clears request and response if possible.
         req.clear()  if req.respond_to?(:clear)
         resp.clear() if resp.respond_to?(:clear)
       end
       #; [!9wp9z] returns empty body when request method is HEAD.
-      tuple[2] = [""] if req_meth == :HEAD
-      return tuple
+      ret[2] = [""] if req_meth == :HEAD
+      return ret
     end
 
     def handle_http(ex, req, resp)
@@ -1724,7 +1740,7 @@ END
     def self.set(key, value, desc=nil)
       #; [!2yis0] raises error when not added yet.
       self.has?(key)  or
-        raise K8::ConfigError.new("add(#{key.inspect}, #{value.inspect}): cannot set because not added yet; use add() or put() instead.")
+        raise K8::ConfigError.new("set(#{key.inspect}, #{value.inspect}): cannot set because not added yet; use add() or put() instead.")
       #; [!3060g] sets key, value and desc.
       self.put(key, value, desc)
     end

data/lib/keight/skeleton/app/action.rb

@@ -4,7 +4,14 @@ require 'keight'
 require 'baby_erubis'
 require 'baby_erubis/renderer'
 
-require './config'
+
+class StrippedHtmlTemplate < BabyErubis::Html
+  def parse(input, *args)
+    ## strip spaces of indentation
+    stripped = input.gsub(/^[ \t]+</, '<')
+    return super(stripped, *args)
+  end
+end
 
 
 module My
@@ -18,17 +25,18 @@ class My::Action < K8::Action
   ## template
   ##
 
-  include BabyErubis::HtmlEscaper
-  include BabyErubis::Renderer
-
   ERUBY_PATH       = ['app/template']
   ERUBY_LAYOUT     = :_layout
-  ERUBY_HTML       = BabyErubis::Html
+  #ERUBY_HTML      = BabyErubis::Html
+  ERUBY_HTML       = StrippedHtmlTemplate
   ERUBY_HTML_EXT   = '.html.eruby'
   ERUBY_TEXT       = BabyErubis::Text
   ERUBY_TEXT_EXT   = '.eruby'
   ERUBY_CACHE      = {}
 
+  include BabyErubis::HtmlEscaper  # define escape()
+  include BabyErubis::Renderer     # define eruby_render_{html,text}()
+
   protected
 
   alias render_html eruby_render_html

data/lib/keight/skeleton/config.rb

@@ -21,24 +21,26 @@ if defined?(Config)     # Ruby < 2.2 has obsoleted 'Config' object
   end
 end
 
-
+## define Config class
 require 'keight'
-
 class Config < K8::BaseConfig
 end
 
+## load 'app.rb', 'app_xxx.rb' and 'app_xxx.private'
 require_relative "config/app"
 require_relative "config/app_#{app_env}"
 fpath = File.join(File.dirname(__FILE__), "config", "app_#{app_env}.private")
 load fpath if File.file?(fpath)
 
+## if SECRET value is left, report error and exit.
 errmsg = Config.validate_values()
 if errmsg
   $stderr.write(errmsg)
   exit 1
 end
 
-## directory to place uploaded files
-ENV['K8_UPLOAD_DIR'] = $config.k8_upload_dir if $config.k8_upload_dir
-
+## create $config object
 $config = Config.new()
+
+## temporary directory to put uploaded files
+ENV['K8_UPLOAD_DIR'] = $config.k8_upload_dir if $config.k8_upload_dir

data/test/keight_test.rb

@@ -18,7 +18,7 @@ class BooksAction < K8::Action
   #
   def do_index();    "<index>";  end
   def do_create();   "<create>"; end
-  #def do_new();      "<new>";    end
+  def do_new();      "<new>";    end
   def do_show(id);   "<show:#{id.inspect}(#{id.class})>";   end
   def do_update(id); "<update:#{id.inspect}(#{id.class})>"; end
   def do_delete(id); "<delete:#{id.inspect}(#{id.class})>"; end
@@ -42,6 +42,7 @@ class AdminBooksAction < K8::Action
   #
   def do_index(); end
   def do_create(); end
+  def do_new(); end
   def do_show(id); end
   def do_update(id); end
   def do_delete(id); end
@@ -1653,6 +1654,17 @@ Oktest.scope do
         ok {pr}.raise?(ArgumentError, "mount('/api'): Action class expected but got: String")
       end
 
+      spec "[!30cib] raises error when action method is not defined in action class." do
+        |mapping|
+        class ExampleAction3 < K8::Action
+          mapping '', :GET=>:do_index, :POST=>:do_create
+          def do_index; end
+        end
+        pr = proc { mapping.mount '/example3', ExampleAction3 }
+        expected_msg = ":POST=>:do_create: unknown action method in ExampleAction3."
+        ok {pr}.raise?(K8::UnknownActionMethodError, expected_msg)
+      end
+
       spec "[!w8mee] returns self." do
         |mapping|
         ret = mapping.mount '/books', BooksAction
@@ -2731,7 +2743,7 @@ Oktest.scope do
         ex = C41.instance_variable_get('@ex')
         ok {ex} != nil
         ok {ex}.is_a?(K8::ConfigError)
-        ok {ex.message} == "add(:hom, 123): cannot set because not added yet; use add() or put() instead."
+        ok {ex.message} == "set(:hom, 123): cannot set because not added yet; use add() or put() instead."
       end
 
       spec "[!3060g] sets key, value and desc." do

data/test/oktest.rb

@@ -1,5 +1,5 @@
 ###
-### $Release: 0.0.1 $
+### $Release: 0.1.0 $
 ### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -16,7 +16,7 @@ end
 module Oktest
 
 
-  VERSION = '$Release: 0.0.1 $'.split(/ /)[1]
+  VERSION = '$Release: 0.1.0 $'.split(/ /)[1]
 
 
   class SkipException < Exception

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keight
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - makoto kuwata
@@ -9,8 +9,22 @@ autorequire:
 bindir:
 - bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: baby_erubis
   requirement: !ruby/object:Gem::Requirement