self_renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 848e357e1ba51e052c701abea3fbeb1a8f289969
+  data.tar.gz: 7241ccc769b20cfe5f4a5c0d3a5a7c9976723bf7
+SHA512:
+  metadata.gz: fd399730d8ccf230e03ea73fdb0969a8cba1a1f27b2c359fe299611e59a815cf575002b5611fdc20d68a72c8909a98121324eef635ccafaf1a36e414a6defc73
+  data.tar.gz: 29a9655309e952a3f9599b59f2fcfac7870e5e6cd0a52fa704f0edcd2d5e68582d4b19a1195cf35bfa6b798500f94f52f1f73c68dffc5ea751698ac7b7b3b39b

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    self_renderer (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.3.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.20)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    debug_inspector (0.0.2)
+    docile (1.1.5)
+    i18n (0.8.1)
+    interception (0.5)
+    json (2.0.4)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    os (1.0.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    pry-rescue (1.4.5)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    pry-test (0.6.4)
+      os
+      pry
+      pry-byebug
+      pry-rescue
+      pry-stack_explorer
+    rainbow (2.2.1)
+    rake (12.0.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.5.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.13.2)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  pry-test
+  rake
+  rubocop
+  self_renderer!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nathan Hopkins
+
+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,36 @@
+# SelfRenderer
+
+Rails model & object rendering outside the context of web requests.
+
+## Use Cases
+
+* Serialize model in background job to send over ActionCable
+* etc....
+
+## Quick Start
+
+```sh
+gem install self_renderer
+```
+
+```ruby
+require "self_renderer"
+
+class User < ApplicationRecord
+  include SelfRenderer
+end
+```
+
+```ruby
+# render html strings
+User.find(1).render_to_html(template: "users/show.html.erb")
+User.find(2).render_to_html(partial: "users/_item.html.erb")
+
+# render json strings
+User.find(3).render_to_json(template: "users/show.json.jbuilder")
+User.find(4).render_to_json(partial: "users/_item.json.jbuilder")
+
+# render ruby hashes
+User.find(5).render_to_hash(template: "users/show.json.jbuilder")
+User.find(6).render_to_hash(partial: "users/show.json.jbuilder")
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task default: [:test]
+
+task :test do
+  exec "bundle exec pry-test --disable-pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "self_renderer"
+
+# 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/self_renderer/version.rb

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

data/lib/self_renderer.rb

@@ -0,0 +1,49 @@
+require "json"
+require "active_support/core_ext/string/inflections"
+require "self_renderer/version"
+
+module SelfRenderer
+  # Renders an HTML string reprsenting this object
+  def render_to_html(template: nil, partial: nil, assigns: {}, locals: {})
+    return render_self template: "#{template}.html", assigns: assigns, locals: locals if template.present?
+    render_self partial: "#{partial}.html", assigns: assigns, locals: locals
+  end
+
+  # Renders a JSON string reprsenting this object
+  def render_to_json(template: nil, partial: nil, assigns: {}, locals: {})
+    return render_self template: "#{template}.json", assigns: assigns, locals: locals if template.present?
+    render_self partial: "#{partial}.json", assigns: assigns, locals: locals
+  end
+
+  # Returns a Hash representation of this object as rendered by #render_to_json
+  def render_to_hash(template: nil, partial: nil, assigns: {}, locals: {})
+    JSON.load render_to_json(template: template, partial: partial, assigns: assigns, locals: locals)
+  end
+
+  protected
+
+    def self_renderer
+      @self_renderer ||= begin
+        renderer = ApplicationController.renderer.new
+
+        # HACK: get around limitations in devise/warden when rendering
+        #       views outside the contect of a formal http request
+        if defined? Warden
+          env = renderer.instance_eval { @env }
+          warden = Warden::Proxy.new(env, Warden::Manager.new(Rails.application))
+          env["warden"] = warden
+        end
+
+        renderer
+      end
+    end
+
+    def render_self(template: nil, partial: nil, assigns: {}, locals: {})
+      name = self.class.name.parameterize(separator: "_")
+      assigns[name] = self
+      locals[name] = self
+      return self_renderer.render(template, assigns: assigns, locals: locals).squish if template
+      return self_renderer.render(partial: partial, assigns: assigns, locals: locals).squish if partial
+      nil
+    end
+end

data/test/self_renderer_test.rb

@@ -0,0 +1,11 @@
+require "pry-test"
+require "coveralls"
+Coveralls.wear!
+SimpleCov.command_name "pry-test"
+require File.expand_path("../../lib/self_renderer", __FILE__)
+
+class TestSelfRenderer < PryTest::Test
+  test "truth" do
+    assert true
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: self_renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry-test
+  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: coveralls
+  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: 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: 
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/self_renderer.rb
+- lib/self_renderer/version.rb
+- test/self_renderer_test.rb
+homepage: https://github.com/hopsoft/self_renderer
+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.11
+signing_key: 
+specification_version: 4
+summary: Rails model & object rendering outside the context of web requests
+test_files:
+- test/self_renderer_test.rb