sana-mvcbase 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efe4c405cdfefbb65ab2f1427c8c5a45314c5093
+  data.tar.gz: 1943f8d1f3b6ecc1b6f80432998b16b25f6e24c5
+SHA512:
+  metadata.gz: f2fe133feed6724c3da90e40fe95a33f326b87cc8a541e9e1be11d108693e2f47f69c172f6930a0ed7934c9db46e686865a9ce5cdd5576720fe1c9673463db01
+  data.tar.gz: a6411dbaed1a53790453d32e43662148f3dbb20667fad091c7442f4ab5bb04b69493dd85017461416e4f6f91259edb502e6e50df58d161eb61ec629bc4c73024

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+.*.sw?

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.2
+os:
+  - linux
+  - osx
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shioruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,113 @@
+# [Sanae MVC Base](https://github.com/Narazaka/sana-mvcbase)
+
+[![Gem](https://img.shields.io/gem/v/sana-mvcbase.svg)](https://rubygems.org/gems/sana-mvcbase)
+[![Gem](https://img.shields.io/gem/dtv/sana-mvcbase.svg)](https://rubygems.org/gems/sana-mvcbase)
+[![Gemnasium](https://gemnasium.com/Narazaka/sana-mvcbase.svg)](https://gemnasium.com/Narazaka/sana-mvcbase)
+[![Inch CI](http://inch-ci.org/github/Narazaka/sana-mvcbase.svg)](http://inch-ci.org/github/Narazaka/sana-mvcbase)
+[![Travis Build Status](https://travis-ci.org/Narazaka/sana-mvcbase.svg)](https://travis-ci.org/Narazaka/sana-mvcbase)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/Narazaka/sana-mvcbase?svg=true)](https://ci.appveyor.com/project/Narazaka/sana-mvcbase)
+[![codecov.io](https://codecov.io/github/Narazaka/sana-mvcbase/coverage.svg?branch=master)](https://codecov.io/github/Narazaka/sana-mvcbase?branch=master)
+[![Code Climate](https://codeclimate.com/github/Narazaka/sana-mvcbase/badges/gpa.svg)](https://codeclimate.com/github/Narazaka/sana-mvcbase)
+
+Ukagaka SHIORI subsystem 'Sana' MVC Helper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sana-mvcbase'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sana-mvcbase
+
+## Usage
+
+```ruby
+require 'sana-mvcbase'
+require 'shiolink'
+
+# define controllers
+
+# for load(), unload()
+class DLController < SanaController
+  def _load(dirpath)
+    MySave.load
+    p dirpath
+  end
+
+  def _unload
+    p :unload
+  end
+end
+
+# view rendering module
+module MyViewModule
+  def render_response(name)
+    MyView.talk(name || event_id)
+  end
+end
+
+# view rendering base controller
+class MyWithViewController < SanaAnyEventController
+  include MyViewModule
+end
+
+# normal talk controller
+class TalkEventsController < MyWithViewController
+  def OnBoot
+    @foo = MySave.foo_flag
+    @bar = MyModel.bar(params.shell_name)
+  end
+
+  def OnFirstBoot
+    @foo = MySave.foo_flag
+    render :OnBoot
+  end
+end
+
+# resource controller
+class ResourcesController < SanaController
+  def homeurl
+    "http://www.example.com/foo/"
+  end
+end
+
+# register routing
+
+router = SanaRouter.new(TalkEventsController)
+router.draw do
+  controller DLController do
+    load
+    unload
+  end
+
+  controller ResourcesController do
+    route :homeurl
+  end
+
+  route :OnBoot, {shell_name: 0, halted: 6, halted_ghost_name: 7}
+
+  # OnFirstBoot is not registered but will called with default controller (= TalkEventsController)
+end
+
+# app start
+
+sana = Sana.new(router.events)
+shiolink = Shiolink.new(sana.method(:load), sana.method(:unload), sana.method(:request))
+shiolink.start
+```
+
+## API
+
+[API Document](http://www.rubydoc.info/github/Narazaka/sana-mvcbase)
+
+## License
+
+This is released under [MIT License](http://narazaka.net/license/MIT?2016).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--private"]
+end

data/appveyor.yml

@@ -0,0 +1,20 @@
+version: "{build}"
+branches:
+  except:
+    - gh-pages
+install:
+  - set RUBY_HOME=C:\Ruby%ruby_version%
+  - set PATH=%RUBY_HOME%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - gem install bundler --no-document
+  - bundle --version
+  - bundle install
+test_script:
+  - bundle exec rake spec
+build: off
+deploy: off
+environment:
+  matrix:
+    - ruby_version: 22
+    - ruby_version: 22-x64

data/lib/sana-mvcbase.rb

@@ -0,0 +1,2 @@
+require 'sana_router'
+require 'sana_controller'

data/lib/sana_controller.rb

@@ -0,0 +1,96 @@
+# Sana Controller
+class SanaController
+  # constructor
+  # @param [SanaRouter::Events] events events
+  # @param [Symbol] event_id event id
+  # @param [OpenStruct] request request
+  # @param [Hash<Symbol, Integer>] mapping request argument mappings
+  def initialize(events, event_id, request, mapping = {})
+    @events = events
+    @event_id = event_id
+    @request = request
+    @mapping = mapping
+  end
+
+  # events
+  # @return [SanaRouter::Events]
+  attr_reader :events
+  # event id
+  # @return [Symbol]
+  attr_reader :event_id
+  # request
+  # @return [OpenStruct]
+  attr_reader :request
+
+  # named access to request headers
+  # @return [SanaController::Params] params
+  def params
+    @params ||= Params.new(request, @mapping)
+  end
+
+  # exec action and get response
+  # @return [String, Openstruct] response
+  def action
+    @return_value = public_send(@event_id)
+    if @response
+      @response
+    else
+      render
+    end
+  end
+
+  private
+
+  # render result
+  # @param args various result options
+  # @return [String, Openstruct] response
+  def render(*args)
+    @response = render_response(*args)
+  end
+
+  # make result by given options
+  # @param args various result options
+  # @return [String, Openstruct] response
+  # @note this method should be overridden for convenient view rendering
+  # @example override
+  #   class HogeViewController < SanaController
+  #     def render_response(value = nil)
+  #       # @return_value is event method's return value
+  #       eval (value || @return_value)
+  #     end
+  #   end
+  def render_response(*args)
+    args[0] || @return_value
+  end
+
+  # named access to request headers
+  class Params
+    # constructor
+    # @param [OpenStruct] request request
+    # @param [Hash<Symbol, Integer>] mapping request argument mappings
+    # @example mapping
+    #   params = SanaController::Params.new(request, {shell_name: 0, halted: 6, halted_ghost_name: 7}) # mapping for Reference0, 6 and 7
+    def initialize(request, mapping = {})
+      @request = request
+      @mapping = mapping
+    end
+
+    # named access to the header
+    # @example named access
+    #   params.shell_name == params.Reference0
+    # @param [Symbol] method param name
+    # @return [String] header value
+    def method_missing(method)
+      @request[method] || @request["Reference#{@mapping[method]}".to_sym]
+    end
+  end
+end
+
+# Sana Controller (any event accepted)
+class SanaAnyEventController < SanaController
+  # SHIORI request()
+  # @param [Symbol] method method name = event id
+  def method_missing(method)
+    render
+  end
+end

data/lib/sana_router.rb

@@ -0,0 +1,126 @@
+require 'sana'
+# Sana Router
+class SanaRouter
+  # constructor
+  # @param [SanaController] default_controller default scope controller
+  def initialize(default_controller = nil)
+    @default_controller = default_controller
+    @controller = @default_controller
+    @route = {}
+    @mapping = {}
+  end
+
+  # register event route to controller
+  # @param [Symbol, Array<Symbol>] events event names
+  # @param [Hash<Symbol, Integer>] mapping request argument mappings
+  # @example register to various controllers
+  #   router.draw do
+  #     # register to specific controller
+  #     controller BootController do
+  #       route [:OnBoot, :OnFirstBoot]
+  #     end
+  #     controller CloseController do
+  #       route [:OnClose, :OnCloseAll]
+  #     end
+  #     # register to default controller
+  #     route :OnSecondChange
+  #   end
+  # @example mapping usage
+  #   route :OnBoot, {shell_name: 0, halted: 6, halted_ghost_name: 7} # mapping for Reference0, 6 and 7
+  def route(events, mapping = {})
+    Array(events).each do |method|
+      @route[method.to_sym] = @controller
+      @mapping[method.to_sym] = mapping
+    end
+    return
+  end
+
+  alias_method :r, :route
+
+  # register SHIORI load() route to controller
+  # @example register to specific controller
+  #   router.draw do
+  #     controller DLController do
+  #       load
+  #     end
+  #   end
+  def load
+    @load_controller = @controller
+  end
+
+  # register SHIORI unload() route to controller
+  # @example register to specific controller
+  #   router.draw do
+  #     controller DLController do
+  #       unload
+  #     end
+  #   end
+  def unload
+    @unload_controller = @controller
+  end
+
+  # execute register methods in instance context
+  # @yield instance_exec context
+  def draw(&block)
+    instance_exec &block
+  end
+
+  # set controller context
+  # @param [SanaController] controller target controller
+  # @yield controller context block
+  def controller(controller)
+    @controller = controller
+    yield if block_given?
+    @controller = @default_controller
+  end
+
+  # router events
+  # @example with Sana
+  #   sana = Sana.new(router.events)
+  # @return [SanaRouter::Events] events
+  def events
+    @events ||= Events.new(@route, @mapping, @load_controller, @unload_controller, @default_controller)
+  end
+
+  # router events
+  class Events
+    # constructor
+    # @param [Hash<Symbol, SanaController>] route route hash
+    # @param [Hash<Symbol, Hash<Symbol, Integer>>] mapping mapping hash
+    # @param [SanaController] load_controller load controller
+    # @param [SanaController] unload_controller unload controller
+    # @param [SanaController] default_controller default controller
+    def initialize(route, mapping, load_controller, unload_controller, default_controller = nil)
+      @route = route
+      @mapping = mapping
+      @load_controller = load_controller
+      @unload_controller = unload_controller
+      @default_controller = default_controller
+    end
+
+    # SHIORI request()
+    # @param [Symbol] method method name = event id
+    # @param [OpenStruct] request request
+    # @return [String, Openstruct] response
+    # @example request()
+    #   events.OnBoot(request)
+    def method_missing(method, request)
+      if controller = @route[method] || @default_controller
+        controller.new(self, method, request, @mapping[method]).action
+      else
+        super
+      end
+    end
+
+    # SHIORI load()
+    # @param [String] dirpath "ghost/master" path
+    def _load(dirpath)
+      @load_controller.new(self, __method__, nil, nil)._load(dirpath)
+    end
+
+    # SHIORI unload()
+    def _unload
+      @load_controller.new(self, __method__, nil, nil)._unload
+    end
+  end
+end

data/sana-mvcbase.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sana-mvcbase"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Narazaka"]
+  spec.email         = ["info@narazaka.net"]
+
+  spec.summary       = %q{Ukagaka SHIORI subsystem 'Sana' MVC Helper}
+  spec.description   = %q{Ukagaka SHIORI subsystem 'Sana' MVC Helper}
+  spec.homepage      = "https://github.com/Narazaka/sana-mvcbase"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.7.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "codecov", "~> 0.1"
+  spec.add_dependency "shioruby", ">= 0.0.3"
+  spec.add_dependency "sana", ">= 0.0.4"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: sana-mvcbase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: shioruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: sana
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description: Ukagaka SHIORI subsystem 'Sana' MVC Helper
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/sana-mvcbase.rb
+- lib/sana_controller.rb
+- lib/sana_router.rb
+- sana-mvcbase.gemspec
+homepage: https://github.com/Narazaka/sana-mvcbase
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ukagaka SHIORI subsystem 'Sana' MVC Helper
+test_files: []
+has_rdoc: