rails-render-component 5.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 645da0a46e68ef46d7b53edacc8e124b3cec5df9586e8fb55ccf062a41ce7555
+  data.tar.gz: 5ad018080a3cfbc308bf5937fe040ed71e55d1d356bdc7add297e2a6f50dabc4
+SHA512:
+  metadata.gz: 90fe6727aeb85994873f1a61753681366a63329084f5d9979e228763cc843f031d1846ed4dfd09dc8e72b2ee827b8669ebac8241a1445a1c5f73a2c24e71e346
+  data.tar.gz: 4d9baa3a66e0476dcc7a34cef7002dd8938a3582b645aaffdec38f7784e8678b1b5119b8e1312bd22d15da484815ed90d21eb76eea7506c0ff802d356a4cf2a0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,44 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+Gemfile*lock
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+addons:
+  apt:
+    packages:
+      - libgmp-dev
+
+gemfile:
+  - gemfiles/Gemfile-rails.5.0.x
+  - gemfiles/Gemfile-rails.5.1.x
+  - gemfiles/Gemfile-rails.5.2.x
+  - gemfiles/Gemfile-rails.6.0.x
+  - gemfiles/Gemfile-rails.6.1.x
+
+rvm:
+  - 2.5
+  - 2.6
+
+script:
+  - cd test/example
+  - bundle exec rake test

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2007      Original creation by David Heinemeier Hansson, released under the MIT license
+Copyright (c) 2008      Rebirth by Pratik Naik and Dan Powell
+Copyright (c) 2010-2012 Upgrade to Rails 3.x by Volker Hochstein, Jonathan McCoy,
+Copyright (c) 2013-2015 Fixes for rails 4.x by Sergio Cambra, Richard Zheng and Mathieu Jobin
+Copyright (c) 2020-2021 Fix for Rails 5.0 by Mathieu Jobin
+
+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,76 @@
+# Rails::Render::Component
+
+Legacy functionality from Rails 1.x and (maybe) 2.x days.
+It execute the code in the `controller#action` before rendering the view into a string.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-render-component'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-render-component
+
+## Usage
+
+Components allow you to call other actions for their rendered response while executing another action. You can either delegate
+the entire response rendering or you can mix a partial response in with your other content.
+
+  class WeblogController < ActionController::Base
+    # Performs a method and then lets hello_world output its render
+    def delegate_action
+      do_other_stuff_before_hello_world
+      render_component :controller => "greeter",  :action => "hello_world", :params => { :person => "david" }
+    end
+  end
+
+  class GreeterController < ActionController::Base
+    def hello_world
+      render :text => "#{params[:person]} says, Hello World!"
+    end
+  end
+
+The same can be done in a view to do a partial rendering:
+
+  Let's see a greeting:
+  <%= render_component :controller => "greeter", :action => "hello_world" %>
+
+It is also possible to specify the controller as a class constant, bypassing the inflector
+code to compute the controller class at runtime:
+
+<%= render_component :controller => GreeterController, :action => "hello_world" %>
+
+== When to use components
+
+Components should be used with care. They're significantly slower than simply splitting reusable parts into partials and
+conceptually more complicated. Don't use components as a way of separating concerns inside a single application. Instead,
+reserve components to those rare cases where you truly have reusable view and controller elements that can be employed
+across many applications at once.
+
+So to repeat: Components are a special-purpose approach that can often be replaced with better use of partials and filters.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/mathieujobin/render-component.
+
+## Copyright
+
+Copyright (c) 2007      Original creation by David Heinemeier Hansson, released under the MIT license
+Copyright (c) 2008      Rebirth by Pratik Naik and Dan Powell
+Copyright (c) 2010-2012 Upgrade to Rails 3.x by Volker Hochstein, Jonathan McCoy,
+Copyright (c) 2013-2015 Fixes for rails 4.x by Sergio Cambra, Richard Zheng and Mathieu Jobin
+Copyright (c) 2020-2021 Fix for Rails 5.0 by Mathieu Jobin

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails/render/component"
+
+# 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/gemfiles/Gemfile-rails.5.0.x

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Bundler 1.x default to insecure http:// for github: shortcut
+git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec :path => ".."
+
+gem "rails", "~> 5.0.7"

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Bundler 1.x default to insecure http:// for github: shortcut
+git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec :path => ".."
+
+gem "rails", "~> 5.1.0"

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Bundler 1.x default to insecure http:// for github: shortcut
+git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec :path => ".."
+
+gem "rails", "~> 5.2.4"

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Bundler 1.x default to insecure http:// for github: shortcut
+git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec :path => ".."
+
+gem "activerecord", "~> 6.0.0"

data/gemfiles/Gemfile-rails.6.1.x

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Bundler 1.x default to insecure http:// for github: shortcut
+git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec :path => ".."
+
+gem "activerecord", "~> 6.1.0"

data/lib/rails/render/component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'render_component/components'
+require 'action_controller'
+require 'action_dispatch/middleware/flash'
+require_relative "component/version"
+require_relative "../../render_component/components"
+
+ActionController::Base.send :include, RenderComponent::Components
+
+module Rails
+  module Render
+    module Component
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/rails/render/component/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Render
+    module Component
+      VERSION = "5.0.1"
+    end
+  end
+end

data/lib/render_component/components.rb

@@ -0,0 +1,162 @@
+module RenderComponent
+  module Components
+    module MethodsToPrepend
+      def session
+        if parent_controller.present?
+          parent_controller.session
+        else
+          @_request.session
+        end
+      end
+
+      def flash(refresh = false) #:nodoc:
+        if @component_flash.nil? || refresh
+          @component_flash =
+            if parent_controller&.flash.is_a?(ActionDispatch::Flash::FlashHash)
+              parent_controller.flash
+            elsif session['flash'].is_a? Array
+              session['flash'] = ActionDispatch::Flash::FlashHash.new(session['flash'].to_h)
+            else
+              session['flash'] ||= ActionDispatch::Flash::FlashHash.new
+            end
+        end
+        @component_flash
+      end
+    end
+
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+        helper HelperMethods
+
+        # If this controller was instantiated to process a component request,
+        # +parent_controller+ points to the instantiator of this controller.
+        attr_accessor :parent_controller
+      end
+
+      base.prepend(MethodsToPrepend)
+    end
+
+    module ClassMethods
+      # Track parent controller to identify component requests
+      def process_with_components(request, action, parent_controller = nil) #:nodoc:
+        controller = new
+        controller.parent_controller = parent_controller
+        controller.dispatch(action, request, make_response!(request))
+      end
+    end
+
+    module HelperMethods
+      def render_component(options)
+        controller.send(:render_component_into_view, options)
+      end
+    end
+
+    module InstanceMethods
+
+      protected
+        def response_redirect(response)
+          if response.respond_to?(:to_path)
+            response.to_path
+          elsif response.respond_to?(:redirect_url)
+            response.redirect_url
+          else
+            response.instance_variable_get(:@response).redirect_url
+          end
+        end
+
+        # Renders the component specified as the response for the current method
+        def render_component(options) #:doc:
+          component_logging(options) do
+            component_status, component_headers, response = component_response(options)
+            redirect_url = response_redirect(response)
+            if redirect_url
+              redirect_to redirect_url
+            else
+              render plain: response.body, status: component_status
+            end
+          end
+        end
+
+        # Returns the component response as a string
+        def render_component_into_view(options) #:doc:
+          component_logging(options) do
+            component_status, component_headers, response = component_response(options)
+            redirected = response_redirect(response)
+            if redirected
+              if redirected =~ %r{://}
+                location = URI.parse(redirected)
+                redirected = location.query ? "#{location.path}?#{location.query}" : location.path
+              end
+              render_component_into_view(Rails.application.routes.recognize_path(redirected, { :method => nil }))
+            else
+              response.body.html_safe
+            end
+          end
+        end
+
+      private
+        def component_response(options)
+          options[:controller] = options[:controller].to_s if options[:controller] && options[:controller].is_a?(Symbol)
+          klass = component_class(options)
+          component_request  = request_for_component(klass.controller_path, options)
+          klass.process_with_components(component_request, options[:action], self)
+        end
+
+        # determine the controller class for the component request
+        def component_class(options)
+          if controller = options[:controller]
+            controller.is_a?(Class) ? controller : "#{controller.to_s.camelize}Controller".constantize
+          else
+            self.class
+          end
+        end
+
+        # Create a new request object based on the current request.
+        # NOT IMPLEMENTED FOR RAILS 3 SO FAR: The new request inherits the session from the current request,
+        # bypassing any session options set for the component controller's class
+        def request_for_component(controller_path, options)
+          if options.is_a? Hash
+            old_style_params = options.delete(:params)
+            options.merge!(old_style_params) unless old_style_params.nil?
+
+            request_params = options.symbolize_keys
+            request_env = {}
+
+            request.env.select {|key, value| key == key.upcase || key == 'rack.input'}.each {|item| request_env[item[0]] = item[1]}
+
+            request_env['REQUEST_URI'] = url_for(options)
+            request_env["PATH_INFO"] = url_for(options.merge(:only_path => true))
+            request_env["action_dispatch.request.symbolized_path_parameters"] = request_params
+            request_env["action_dispatch.request.parameters"] = request_params.symbolize_keys
+            request_env["action_dispatch.request.path_parameters"] = Hash[request_params.select{|key, value| [:controller, :action].include?(key)}].symbolize_keys
+            request_env["warden"] = request.env["warden"] if (request.env.has_key?("warden"))
+            component_request = ActionDispatch::Request.new(request_env)
+
+            # its an internal request request forgery protection has to be disabled
+            # because otherwise forgery detection might raise an error
+            component_request.instance_eval do
+              def forgery_whitelisted?
+                true
+              end
+            end
+            component_request
+          else
+            request
+          end
+        end
+
+        def component_logging(options)
+          if logger
+            logger.info "Start rendering component (#{options.inspect}): "
+            result = yield
+            logger.info "\n\nEnd of component rendering"
+            result
+          else
+            yield
+          end
+        end
+    end
+  end
+end

data/rails-render-component.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails/render/component/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-render-component"
+  spec.version       = Rails::Render::Component::VERSION
+  spec.authors       = ["David Heinemeier Hansson", "VHO", "Sergio Cambra", "Mathieu Jobin"]
+  spec.email         = ["_", "_"  "_", "mathieu@justbudget.com"]
+
+  spec.summary       = "render actions in other controllers for their rendered response."
+  spec.description   = "Components allow you to call other actions for their rendered response while executing another action"
+  spec.homepage      = "http://github.com/mathieujobin/render_component."
+  spec.licenses      = ["MIT"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("railties", ">= 5.0", "< 7")
+  spec.add_development_dependency("rubocop")
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rails-render-component
+version: !ruby/object:Gem::Version
+  version: 5.0.1
+platform: ruby
+authors:
+- David Heinemeier Hansson
+- VHO
+- Sergio Cambra
+- Mathieu Jobin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Components allow you to call other actions for their rendered response
+  while executing another action
+email:
+- _
+- __
+- mathieu@justbudget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".travis.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/Gemfile-rails.5.0.x
+- gemfiles/Gemfile-rails.5.1.x
+- gemfiles/Gemfile-rails.5.2.x
+- gemfiles/Gemfile-rails.6.0.x
+- gemfiles/Gemfile-rails.6.1.x
+- lib/rails/render/component.rb
+- lib/rails/render/component/version.rb
+- lib/render_component/components.rb
+- rails-render-component.gemspec
+homepage: http://github.com/mathieujobin/render_component.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/mathieujobin/render_component.
+  source_code_uri: http://github.com/mathieujobin/render_component.
+  changelog_uri: http://github.com/mathieujobin/render_component.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: render actions in other controllers for their rendered response.
+test_files: []