render_with_view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16c75b8652b4d928f2c02d3c22fc6b0557f05720
+  data.tar.gz: 946a91bd39ffc868a96eadd82a7277251e1113ba
+SHA512:
+  metadata.gz: d3b8e0a484f0baf8578a86314c58ccc504660c1a98ac103e18f6998b87ab5af963b5279727dcbfa9da60f4f0b21f6dab1c35c1def29041c96848c5e120fc96ec
+  data.tar.gz: 79aa31678bcfff82a4cd358dfdeec6ad3f918389b69e554c5d333c1d9eb0f2d87fa6f7ff1a8b7fbb401218c93261fb48099561b6ab3fac715647a4e1b6e4a957

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Mikkel Malmberg
+
+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,61 @@
+# render_with_view
+
+Be explicit about the things you send from your Rails controller to the view.
+
+### Example
+
+`app/controllers/application_controller.rb`:
+
+```ruby
+class ApplicationController
+  include RenderWithView
+end
+```
+
+`app/controllers/home_controller.rb`:
+
+```ruby
+class HomeController < ApplicationController
+  def index
+    render_with_view posts: Post.all
+  end
+end
+```
+
+`app/views/home/index.html.erb`:
+
+```erb
+<ul>
+  <% view.posts.each do |post| %>
+    <li><%= link_to post.title, post %></li>
+  <% end %>
+</ul>
+```
+
+### Why not just use instance variables?
+
+They feel like _magic_. Instead I like how this forces me to be explicit in what I send along to my templates. It's like a small step towards having a presenter/view layer (or whatever) but not going further than just adding the convention of using a single variable.
+
+### What's `view`?
+
+An object with reader methods for every key in the hash you gave it. A [HalfOpenStruct](https://gist.github.com/henrik/19c68b2a41ab4d098ce8) in a way.
+
+## Installation
+
+Add `render_with_view` to your Gemfile:
+
+```ruby
+gem 'render_with_view'
+```
+
+Include it in your `ApplicationController`:
+
+```ruby
+class ApplicationController
+  include RenderWithView
+end
+```
+
+# License
+
+MIT

data/lib/render_with_view/half_open_struct.rb

@@ -0,0 +1,42 @@
+module RenderWithView
+  # Like OpenStruct but doesn't let you read a non-assigned value (raises
+  # instead of returning nil). This avoids issues where you read the wrong
+  # value due to a typo and don't notice.
+  #
+  # Borrowed from @henrik,
+  # https://gist.github.com/henrik/19c68b2a41ab4d098ce8
+
+  class HalfOpenStruct
+    def initialize(hash = {})
+      @hash = hash
+    end
+
+    def include?(name)
+      @hash.include?(name)
+    end
+
+    def fetch(name, fallback)
+      @hash.fetch(name, fallback)
+    end
+
+    def method_missing(name, *args)
+      if name.to_s.end_with?("=")
+        write(name.to_s.chop.to_sym, *args)
+      elsif args.length == 0
+        read_or_raise(name)
+      else
+        raise NoMethodError
+      end
+    end
+
+    private
+
+    def write(name, value)
+      @hash[name] = value
+    end
+
+    def read_or_raise(name)
+      @hash.fetch(name) { raise "Unknown key: #{name}" }
+    end
+  end
+end

data/lib/render_with_view/rspec_matcher.rb

@@ -0,0 +1,31 @@
+RSpec::Matchers.define :set_view_local do |key, expected = nil|
+  match do |block|
+    block.call if block && block.is_a?(Proc)
+
+    value = assigns('__view__').send(key.to_sym) rescue nil
+
+    return !!value unless expected
+
+    expect(expected).to eq(value)
+  end
+
+  supports_block_expectations
+
+  description do
+    msg = "set view local"
+    msg += " to equal #{expected.inspect}" if expected
+    msg
+  end
+
+  failure_message do
+    msg = "expected view locals to have key #{key.inspect}"
+    msg += " to equal #{expected.inspect}" if expected
+    msg
+  end
+
+  failure_message_when_negated do
+    msg = "expected view locals to not have key #{key.inspect}"
+    msg += " to not equal #{expected.inspect}" if expected
+    msg
+  end
+end

data/lib/render_with_view/version.rb

@@ -0,0 +1,3 @@
+module RenderWithView
+  VERSION = '0.1.0'
+end

data/lib/render_with_view.rb

@@ -0,0 +1,20 @@
+require 'render_with_view/half_open_struct'
+
+module RenderWithView
+  class View < HalfOpenStruct; end
+
+  def self.included kls
+    kls.class_eval do
+      def render_with_view *args
+        tmpl = args.length == 2 ? args.shift : action_name
+        locals = args.shift
+
+        # save to ivar for testing purposes
+        @__view__ = View.new(locals)
+
+        render tmpl, locals: { view: @__view__ }
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: render_with_view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikkel Malmberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mikkel@brnbw.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/render_with_view.rb
+- lib/render_with_view/half_open_struct.rb
+- lib/render_with_view/rspec_matcher.rb
+- lib/render_with_view/version.rb
+homepage: https://github.com/mikker/render_with_view
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Be explicit about what you send to your Rails views
+test_files: []