render_anywhere_lxv 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8eacbbdc35d179125219e17109dc332cefdc0b86
+  data.tar.gz: 941ed26d3de783a597b526a971c68d01e1b72e21
+SHA512:
+  metadata.gz: ed8e87dbe26c083bd8918f738d2aeda92da44fe6d12c3a2d5e41dd5d55a7b9eda95c61260065dd7a1d3ba1285fbaf828af97e99008780ae454990717e29e6348
+  data.tar.gz: d38f1b98c899bcd4e22087edd2b92aa598ee3c654a4dde2df9db4ad1c82bea9c82f47f7faa5cbc68a8152937d8c0beb38ce2fc00f3aabd27dcfd5403ebda3daa

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+log/
+
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "3.2" do
+  gem "rails", "~> 3.2.15"
+  gemspec
+end
+
+appraise "4.0" do
+  gem "rails", "~> 4.0.0"
+  gemspec
+end
+
+appraise "4.1" do
+  gem "rails", "~> 4.1.0"
+  gemspec
+end

data/Gemfile

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

data/LICENCE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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,83 @@
+render_anywhere
+====================
+
+Out of the box, Rails can render templates in a controller context only. This little gem allows for calling "render" from anywhere: models, background jobs, rake tasks, you name it.
+
+Installation
+------------------
+
+```bash
+    gem install render_anywhere
+```
+
+Usage
+--------------------
+
+Put render_anywhere in your Gemfile: 
+
+```ruby
+    gem 'render_anywhere', :require => false
+```
+
+In your Rails app, in a rake task, model, background job, or where ever you like, require render_anywhere, include the module and call render with the same arguments as ActionController::Base#render takes. It will return a string.
+
+```ruby
+    require 'render_anywhere'
+
+    class AnyClass
+      include RenderAnywhere
+
+      def build_html
+        html = render :template => 'normal/template/reference',
+                      :layout => 'application'
+        html
+      end
+      # Include an additional helper
+      # If being used in a rake task, you may need to require the file(s)
+      # Ex: require Rails.root.join('app', 'helpers', 'blog_pages_helper')
+      def include_helper(helper_name)
+        set_render_anywhere_helpers(helper_name)
+      end
+
+      # Apply an instance variable to the controller
+      # If you need to use instance variables instead of locals, just call this method as many times as you need.
+      def set_instance_variable(var, value)
+        set_instance_variable(var, value)
+      end
+
+      class RenderingController < RenderAnywhere::RenderingController
+        # include custom modules here, define accessors, etc. For example:
+        attr_accessor :current_user
+        helper_method :current_user
+      end
+
+      # If you define custom RenderingController, don't forget to override this method
+      def rendering_controller
+        @rendering_controller ||= self.class.const_get("RenderingController").new
+      end
+    end
+```
+
+Thanks
+--------------------
+
+[Yapp](http://yapp.us), whose CTO (me) kindly agreed to open source this library. App yourself!
+
+The basic approach used here came from [this gist](https://gist.github.com/977181) by [Julien Guimont aka juggy](https://github.com/juggy). Thanks!
+
+Contributing
+--------------------
+
+Run tests with `rake` or `rspec`.
+
+Run tests against different versions of rails with `appraisal rake` or `appraisal rspec`.
+
+Author
+--------------------
+
+Luke Melia, [@lukemelia](https://twitter.com/lukemelia), [lukemelia.com](http://lukemelia.com)
+
+License
+--------------------
+
+The MIT License. Copyright (c) 2011, Yapp, Inc.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/gemfiles/3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.15"
+
+gemspec :path => "../"

data/gemfiles/4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/render_anywhere.rb

@@ -0,0 +1,30 @@
+require 'abstract_controller'
+require 'action_view'
+
+require 'render_anywhere/version'
+require 'render_anywhere/rendering_controller'
+
+module RenderAnywhere
+  def render(*args)
+    rendering_controller.render_to_string(*args)
+  end
+
+  def set_render_anywhere_helpers(*args)
+    args.each do |helper_name|
+      rendering_controller.class_eval do
+        helper helper_name.to_s.constantize
+      end
+    end
+  end
+
+  def set_instance_variable(var, value)
+    rendering_controller.class_eval do
+      attr_accessor :"#{var}"
+    end
+    rendering_controller.public_send("#{var}=", value)
+  end
+
+  def rendering_controller
+    @rendering_controller ||= self.class.const_get("RenderingController").new
+  end
+end

data/lib/render_anywhere/rendering_controller.rb

@@ -0,0 +1,70 @@
+require 'ostruct'
+
+module RenderAnywhere
+  class RenderingController < ActionController::Metal
+    # Include all the concerns we need to make this work
+    include AbstractController::Logger
+    include AbstractController::Rendering
+    include ActionView::Layouts if defined?(ActionView::Layouts) # Rails 4.1.x
+    include AbstractController::Layouts if defined?(AbstractController::Layouts) # Rails 3.2.x, 4.0.x
+    include CacheDigests::ViewCacheDependency if defined?(CacheDigests)
+    include AbstractController::Helpers
+    include AbstractController::Translation
+    include AbstractController::AssetPaths
+    include ActionController::Caching
+
+    # Define additional helpers, this one is for csrf_meta_tag
+    helper_method :protect_against_forgery?
+
+    # override the layout in your subclass if needed.
+    layout 'application'
+
+    # configure the different paths correctly
+    def initialize(*args)
+      super()
+
+      self.class.send :include, Rails.application.routes.url_helpers
+
+      # this is you normal rails application helper
+      if defined?(ApplicationHelper)
+        self.class.send :helper, ApplicationHelper
+      end
+
+      lookup_context.view_paths = ApplicationController.view_paths
+      config.javascripts_dir = Rails.root.join('public', 'javascripts')
+      config.stylesheets_dir = Rails.root.join('public', 'stylesheets')
+      config.assets_dir = Rails.root.join('public')
+      config.cache_store = ActionController::Base.cache_store
+      config.relative_url_root = ActionController::Base.relative_url_root
+
+      # same asset host as the controllers
+      self.asset_host = ActionController::Base.asset_host
+    end
+
+    # we are not in a browser, no need for this
+    def protect_against_forgery?
+      false
+    end
+
+    # so that your flash calls still work
+    def flash
+      {}
+    end
+
+    # and nil request to differentiate between live and offline
+    def request
+      OpenStruct.new
+    end
+
+    # and params will be accessible
+    def params
+      {}
+    end
+
+    # so that your cookies calls still work
+    def cookies
+      {}
+    end
+
+  end
+end

data/lib/render_anywhere/version.rb

@@ -0,0 +1,3 @@
+module RenderAnywhere
+  VERSION = "0.0.12"
+end

data/render_anywhere.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "render_anywhere/version"
+
+Gem::Specification.new do |s|
+  s.name        = "render_anywhere_lxv"
+  s.version     = RenderAnywhere::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luke Melia", "Will Schreiber"]
+  s.email       = ["w@lxv.io"]
+  s.homepage    = ""
+  s.summary     = %q{Render Rails templates to a string from anywhere.}
+  s.description = %q{Out of the box, Rails will render templates in a controller context only. This gem allows for calling "render" from anywhere: models, background jobs, rake tasks, you name it.}
+  s.licenses    = ['MIT']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('rails', '>= 3.0.7')
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'appraisal'
+end

data/spec/lib/render_anywhere_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe RenderAnywhere do
+
+  class UserRenderer
+    include RenderAnywhere
+
+    def initialize(user)
+      @user = user
+    end
+
+    def render_ivar
+      set_instance_variable(:user, @user)
+      render 'spec/views/user_ivar', :layout => false
+    end
+
+    def render_current_user
+      rendering_controller.action_name = 'show'
+      rendering_controller.controller_name = 'user'
+      rendering_controller.current_user = @user
+      render 'spec/views/current_user', :layout => false
+    end
+
+    class RenderingController < RenderAnywhere::RenderingController
+      attr_accessor :controller_name
+      attr_accessor :current_user
+      helper_method :current_user
+    end
+  end
+
+  class OtherRenderer
+    include RenderAnywhere
+  end
+
+  User = Struct.new(:name)
+
+  let(:me) { User.new("Guzman") }
+  subject { UserRenderer.new(me) }
+
+  context "#rendering_controller" do
+    it "creates a RenderingController of the class nested inside the class using RenderAnywhere" do
+      expect(subject.rendering_controller).to be_a(UserRenderer::RenderingController)
+    end
+
+    it "creates a RenderingController of default class" do
+      expect(OtherRenderer.new.rendering_controller).to be_a(RenderAnywhere::RenderingController)
+    end
+  end
+
+  context "#render" do
+    it "renders with ivar" do
+      expect(subject.render_ivar).to eq("The current user is Guzman.\n")
+    end
+
+    it "renders with render_current_user" do
+      expect(subject.render_current_user).to eq("The current user is Guzman.\nThe controller name is user.\nThe controller action is show.\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+
+require 'bundler/setup'
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'rails'
+require 'action_controller'
+
+require 'render_anywhere'
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+class TestRailsApp < Rails::Application
+  config.secret_key_base = '1234'
+  config.eager_load = false if Rails::VERSION::MAJOR == 4
+
+  initialize!
+end
+
+module ApplicationHelper
+end
+
+class ApplicationController < ActionController::Base
+end

data/spec/views/current_user.html.erb

@@ -0,0 +1,3 @@
+The current user is <%= current_user.name %>.
+The controller name is <%= controller.controller_name %>.
+The controller action is <%= controller.action_name %>.

data/spec/views/user_ivar.html.erb

@@ -0,0 +1 @@
+The current user is <%= @user.name %>.

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: render_anywhere_lxv
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Luke Melia
+- Will Schreiber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: 'Out of the box, Rails will render templates in a controller context
+  only. This gem allows for calling "render" from anywhere: models, background jobs,
+  rake tasks, you name it.'
+email:
+- w@lxv.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- gemfiles/3.2.gemfile
+- gemfiles/4.0.gemfile
+- gemfiles/4.1.gemfile
+- lib/render_anywhere.rb
+- lib/render_anywhere/rendering_controller.rb
+- lib/render_anywhere/version.rb
+- render_anywhere.gemspec
+- spec/lib/render_anywhere_spec.rb
+- spec/spec_helper.rb
+- spec/views/current_user.html.erb
+- spec/views/user_ivar.html.erb
+homepage: ''
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Render Rails templates to a string from anywhere.
+test_files:
+- spec/lib/render_anywhere_spec.rb
+- spec/spec_helper.rb
+- spec/views/current_user.html.erb
+- spec/views/user_ivar.html.erb