multiview 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +16 -0
- data/.rspec +3 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +128 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/multiview/manager.rb +62 -0
- data/lib/multiview/version.rb +3 -0
- data/lib/multiview.rb +18 -0
- data/multiview.gemspec +30 -0
- metadata +128 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 650c7df341ee5b96e1a2fda99e8d026c2aad2f2f
|
4
|
+
data.tar.gz: eba95cc7ffc902f9df1357c41a2b157fe236c0bb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 145978eaf69e93ede41a767433073879ed7cf1eb97948150a14d8f7de800e1a6dc9ea760b867d4faa7fa8fd5e952f3a4fcba98224f176a894d7e2b5cfa678f2a
|
7
|
+
data.tar.gz: 694c768525e76b4433b178fcffc3389fa5c9e99fea4af6f0db05fd81588e239c82901b40b048efa173b7cc20c4b4b89b85d1c955c03cc60268d229e18d9a8ba9
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at jon@ekohe.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Jon Xie
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
# Multiview
|
2
|
+
|
3
|
+
Support multiple versions for Rails views
|
4
|
+
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
Add this line to your application's Gemfile:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'multiview'
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
### We project
|
22
|
+
|
23
|
+
`app/controllers/topics_controller.rb`
|
24
|
+
|
25
|
+
```
|
26
|
+
class TopicsController < ApplicationController
|
27
|
+
def index
|
28
|
+
render plain: 'hello'
|
29
|
+
end
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
`app/controllers/v2/topics_controller.rb`
|
34
|
+
|
35
|
+
```
|
36
|
+
class V2::TopicsController < ApplicationController
|
37
|
+
def index
|
38
|
+
render plain: 'hello v2'
|
39
|
+
end
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
`config/routes.rb`
|
44
|
+
|
45
|
+
```
|
46
|
+
resources :topics
|
47
|
+
```
|
48
|
+
|
49
|
+
### Init
|
50
|
+
|
51
|
+
`config/initializers/multiview.rb`
|
52
|
+
|
53
|
+
```
|
54
|
+
$multiview = Multiview::Manager.new({
|
55
|
+
'topics' => 'v2'
|
56
|
+
})
|
57
|
+
|
58
|
+
# or use default manager: Multiview.manager
|
59
|
+
```
|
60
|
+
|
61
|
+
|
62
|
+
### Redispatch request by filter of controller
|
63
|
+
|
64
|
+
When get `/topics`, should redispatch to V2::TopicsController, don't call `TopicsController#index`, if we delete `V2::TopicsController` or change that config `{'topics' => 'v1'}`, it will call `TopicsController`
|
65
|
+
|
66
|
+
```
|
67
|
+
class ApplicationController < ActionController::Base
|
68
|
+
before_aciton :set_view_version_filter
|
69
|
+
|
70
|
+
def set_view_version_filter
|
71
|
+
$multiview.redispatch(self)
|
72
|
+
|
73
|
+
# or
|
74
|
+
# $multiview.redispatch(self, params[:controller], params[:action])
|
75
|
+
|
76
|
+
# if exist V3::XxxController, should to call V3::XxxController
|
77
|
+
# if not, should to call XxxController
|
78
|
+
# $multiview.redispatch(self, params[:controller], params[:action], 'v3')
|
79
|
+
end
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
### Dispatch request by middleware
|
84
|
+
|
85
|
+
```
|
86
|
+
class MultiviewMiddleware
|
87
|
+
def initialize(app)
|
88
|
+
@app = @app
|
89
|
+
end
|
90
|
+
|
91
|
+
def call(env)
|
92
|
+
path_info = Rails.application.routes.recognize_path(env['PATH_INFO'])
|
93
|
+
|
94
|
+
if path_info && path_info[:contorller]
|
95
|
+
$multiview.dispatch(env, path_info[:controller], path_info[:action])
|
96
|
+
# or
|
97
|
+
# $multiview.dispatch(env, path_info[:controller], path_info[:action], 'v2')
|
98
|
+
else
|
99
|
+
@app.call(env)
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
`config/application.rb`
|
106
|
+
|
107
|
+
```
|
108
|
+
config.middleware.insert_before Rails.application.routes, MultiviewMiddleware
|
109
|
+
```
|
110
|
+
|
111
|
+
|
112
|
+
## Development
|
113
|
+
|
114
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
115
|
+
|
116
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
117
|
+
|
118
|
+
## Contributing
|
119
|
+
|
120
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/multiview. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
121
|
+
|
122
|
+
## License
|
123
|
+
|
124
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
125
|
+
|
126
|
+
## Code of Conduct
|
127
|
+
|
128
|
+
Everyone interacting in the Multiview project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/multiview/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "multiview"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
module Multiview
|
2
|
+
class Manager
|
3
|
+
attr_reader :versions_map
|
4
|
+
|
5
|
+
# Params:
|
6
|
+
# config: {controller_path: version
|
7
|
+
def initialize(versions_map)
|
8
|
+
@versions_map = versions_map
|
9
|
+
end
|
10
|
+
|
11
|
+
def dispatch(env, controller_path, action_name, version = nil)
|
12
|
+
version ||= find_version(controller_path)
|
13
|
+
return if version.nil?
|
14
|
+
|
15
|
+
class_name = "#{version}/#{controller_path}_controller".camelize
|
16
|
+
ctrl_cls = class_name.safe_constantize
|
17
|
+
new_action_name = "#{class_name}##{action_name}"
|
18
|
+
env['multiview'] = {version: version}.with_indifferent_access
|
19
|
+
|
20
|
+
if ctrl_cls && ctrl_cls.public_method_defined?(action_name)
|
21
|
+
Rails.logger.debug("[Multiview] Dispatch to #{new_action_name}")
|
22
|
+
action_block = ctrl_cls.action(action_name)
|
23
|
+
action_block.call(env)
|
24
|
+
else
|
25
|
+
Rails.logger.warn("[Multiview] Not found #{new_action_name}")
|
26
|
+
nil
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def redispatch(controller, controller_path = nil, action_name = nil, version = nil)
|
31
|
+
controller_path ||= controller.params[:controller]
|
32
|
+
action_name ||= controller.params[:action]
|
33
|
+
version ||= find_version(controller_path)
|
34
|
+
return unless version
|
35
|
+
|
36
|
+
if result = dispatch(controller.request.env, controller_path, action_name, version)
|
37
|
+
res = controller.response
|
38
|
+
status, headers, body = result
|
39
|
+
res.status = status
|
40
|
+
res.header.clear
|
41
|
+
res.header.merge!(headers)
|
42
|
+
controller.response_body = body
|
43
|
+
else
|
44
|
+
# no action, just use views
|
45
|
+
load_version_view(controller, version)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
def find_version(path)
|
50
|
+
versions_map[path.to_sym]
|
51
|
+
end
|
52
|
+
|
53
|
+
private
|
54
|
+
|
55
|
+
def load_version_view(controller, version)
|
56
|
+
return if version.to_sym == :v1
|
57
|
+
Rails.logger.warn("[Multiview] Prepend view path app/views/#{version}")
|
58
|
+
controller.prepend_view_path(Rails.root.join("app/views/#{version}"))
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
62
|
+
end
|
data/lib/multiview.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require "multiview/version"
|
2
|
+
|
3
|
+
module Multiview
|
4
|
+
require 'multiview/manager'
|
5
|
+
|
6
|
+
class << self
|
7
|
+
def manager
|
8
|
+
@manager ||= Manager.new({})
|
9
|
+
end
|
10
|
+
|
11
|
+
%w{dispatch redispatch}.each do |m|
|
12
|
+
define_method m do |*args|
|
13
|
+
manager.send(m, *args)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
data/multiview.gemspec
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "multiview/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "multiview"
|
8
|
+
spec.version = Multiview::VERSION
|
9
|
+
spec.authors = ["Jon Xie"]
|
10
|
+
spec.email = ["jon@ekohe.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Support multiple versions for Rails view.}
|
13
|
+
spec.description = %q{Support multiple versions for Rails view.}
|
14
|
+
spec.homepage = "https://github.com/xiejiangzhi/multiview"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.15"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
27
|
+
spec.add_development_dependency "pry", ">= 0.10"
|
28
|
+
|
29
|
+
spec.add_dependency "rails", ">= 4.1"
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: multiview
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Jon Xie
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-07-05 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.15'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.15'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: pry
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.10'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.10'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rails
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '4.1'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '4.1'
|
83
|
+
description: Support multiple versions for Rails view.
|
84
|
+
email:
|
85
|
+
- jon@ekohe.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- ".rspec"
|
92
|
+
- ".travis.yml"
|
93
|
+
- CODE_OF_CONDUCT.md
|
94
|
+
- Gemfile
|
95
|
+
- LICENSE.txt
|
96
|
+
- README.md
|
97
|
+
- Rakefile
|
98
|
+
- bin/console
|
99
|
+
- bin/setup
|
100
|
+
- lib/multiview.rb
|
101
|
+
- lib/multiview/manager.rb
|
102
|
+
- lib/multiview/version.rb
|
103
|
+
- multiview.gemspec
|
104
|
+
homepage: https://github.com/xiejiangzhi/multiview
|
105
|
+
licenses:
|
106
|
+
- MIT
|
107
|
+
metadata: {}
|
108
|
+
post_install_message:
|
109
|
+
rdoc_options: []
|
110
|
+
require_paths:
|
111
|
+
- lib
|
112
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
118
|
+
requirements:
|
119
|
+
- - ">="
|
120
|
+
- !ruby/object:Gem::Version
|
121
|
+
version: '0'
|
122
|
+
requirements: []
|
123
|
+
rubyforge_project:
|
124
|
+
rubygems_version: 2.4.5.2
|
125
|
+
signing_key:
|
126
|
+
specification_version: 4
|
127
|
+
summary: Support multiple versions for Rails view.
|
128
|
+
test_files: []
|