multiview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 650c7df341ee5b96e1a2fda99e8d026c2aad2f2f
+  data.tar.gz: eba95cc7ffc902f9df1357c41a2b157fe236c0bb
+SHA512:
+  metadata.gz: 145978eaf69e93ede41a767433073879ed7cf1eb97948150a14d8f7de800e1a6dc9ea760b867d4faa7fa8fd5e952f3a4fcba98224f176a894d7e2b5cfa678f2a
+  data.tar.gz: 694c768525e76b4433b178fcffc3389fa5c9e99fea4af6f0db05fd81588e239c82901b40b048efa173b7cc20c4b4b89b85d1c955c03cc60268d229e18d9a8ba9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/examples.txt
+
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require gem_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jon@ekohe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jon Xie
+
+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,128 @@
+# Multiview
+
+Support multiple versions for Rails views
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multiview'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### We project
+
+`app/controllers/topics_controller.rb`
+
+```
+class TopicsController < ApplicationController
+  def index
+    render plain: 'hello'
+  end
+end
+```
+
+`app/controllers/v2/topics_controller.rb`
+
+```
+class V2::TopicsController < ApplicationController
+  def index
+    render plain: 'hello v2'
+  end
+end
+```
+
+`config/routes.rb`
+
+```
+resources :topics
+```
+
+### Init
+
+`config/initializers/multiview.rb`
+
+```
+$multiview = Multiview::Manager.new({
+  'topics' => 'v2'
+})
+
+# or use default manager: Multiview.manager
+```
+
+
+### Redispatch request by filter of controller
+
+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`
+
+```
+class ApplicationController < ActionController::Base
+  before_aciton :set_view_version_filter
+
+  def set_view_version_filter
+    $multiview.redispatch(self)
+
+    # or 
+    # $multiview.redispatch(self, params[:controller], params[:action])
+
+    # if exist V3::XxxController, should to call V3::XxxController
+    # if not, should to call XxxController
+    # $multiview.redispatch(self, params[:controller], params[:action], 'v3')
+  end
+end
+```
+
+### Dispatch request by middleware
+
+```
+class MultiviewMiddleware
+  def initialize(app)
+    @app = @app
+  end
+
+  def call(env)
+    path_info = Rails.application.routes.recognize_path(env['PATH_INFO'])
+
+    if path_info && path_info[:contorller]
+      $multiview.dispatch(env, path_info[:controller], path_info[:action])
+      # or 
+      # $multiview.dispatch(env, path_info[:controller], path_info[:action], 'v2')
+    else
+      @app.call(env)
+    end
+  end
+end
+```
+
+`config/application.rb`
+
+```
+config.middleware.insert_before Rails.application.routes, MultiviewMiddleware
+```
+
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multiview"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multiview/manager.rb

@@ -0,0 +1,62 @@
+module Multiview
+  class Manager
+    attr_reader :versions_map
+
+    # Params:
+    #   config: {controller_path: version
+    def initialize(versions_map)
+      @versions_map = versions_map
+    end
+
+    def dispatch(env, controller_path, action_name, version = nil)
+      version ||= find_version(controller_path)
+      return if version.nil?
+
+      class_name = "#{version}/#{controller_path}_controller".camelize
+      ctrl_cls = class_name.safe_constantize
+      new_action_name = "#{class_name}##{action_name}"
+      env['multiview'] = {version: version}.with_indifferent_access
+
+      if ctrl_cls && ctrl_cls.public_method_defined?(action_name)
+        Rails.logger.debug("[Multiview] Dispatch to #{new_action_name}")
+        action_block = ctrl_cls.action(action_name)
+        action_block.call(env)
+      else
+        Rails.logger.warn("[Multiview] Not found #{new_action_name}")
+        nil
+      end
+    end
+
+    def redispatch(controller, controller_path = nil, action_name = nil, version = nil)
+      controller_path ||= controller.params[:controller]
+      action_name ||= controller.params[:action]
+      version ||= find_version(controller_path)
+      return unless version
+
+      if result = dispatch(controller.request.env, controller_path, action_name, version)
+        res = controller.response
+        status, headers, body = result
+        res.status = status
+        res.header.clear
+        res.header.merge!(headers)
+        controller.response_body = body
+      else
+        # no action, just use views
+        load_version_view(controller, version)
+      end
+    end
+
+    def find_version(path)
+      versions_map[path.to_sym]
+    end
+
+    private
+
+    def load_version_view(controller, version)
+      return if version.to_sym == :v1
+      Rails.logger.warn("[Multiview] Prepend view path app/views/#{version}")
+      controller.prepend_view_path(Rails.root.join("app/views/#{version}"))
+    end
+
+  end
+end

data/lib/multiview/version.rb

@@ -0,0 +1,3 @@
+module Multiview
+  VERSION = "0.1.0"
+end

data/lib/multiview.rb

@@ -0,0 +1,18 @@
+require "multiview/version"
+
+module Multiview
+  require 'multiview/manager'
+
+  class << self
+    def manager
+      @manager ||= Manager.new({})
+    end
+
+    %w{dispatch redispatch}.each do |m|
+      define_method m do |*args|
+        manager.send(m, *args)
+      end
+    end
+  end
+end
+

data/multiview.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "multiview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "multiview"
+  spec.version       = Multiview::VERSION
+  spec.authors       = ["Jon Xie"]
+  spec.email         = ["jon@ekohe.com"]
+
+  spec.summary       = %q{Support multiple versions for Rails view.}
+  spec.description   = %q{Support multiple versions for Rails view.}
+  spec.homepage      = "https://github.com/xiejiangzhi/multiview"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", ">= 0.10"
+
+  spec.add_dependency "rails", ">= 4.1"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: multiview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Support multiple versions for Rails view.
+email:
+- jon@ekohe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multiview.rb
+- lib/multiview/manager.rb
+- lib/multiview/version.rb
+- multiview.gemspec
+homepage: https://github.com/xiejiangzhi/multiview
+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.2
+signing_key: 
+specification_version: 4
+summary: Support multiple versions for Rails view.
+test_files: []