jbuilder-jpartial 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de4f8644930394f0f22aa90292f5f66ab813f884
+  data.tar.gz: 5970911868f688dfe4ca101f73a1597786fdc1c9
+SHA512:
+  metadata.gz: 2b82ed0ce07772d5242a96c2a31a81eab5333969db7944f676a3114d26b8fc79cfa2c6977463032c2c10c5a5de37c53049a06b189de15ef92503a666bac7cd89
+  data.tar.gz: 0d99474b5a6c08d1d1a35ad55e1d05f1d029f380c5e2ae447ce88a776a2dd4827954ac384cc49f504bb2b2dc76ed0c3e8b834ebdf62e3ca781bc699a7559c5bf

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 M. Simon Borg
+
+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,140 @@
+# Jbuilder::Jpartial
+
+A lightweight library that provides a simple DSL for faster partial rendering with Jbuilder.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jbuilder-jpartial', require: 'jbuilder/jpartial'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jbuilder-jpartial
+    
+    require 'jbuilder/jpartial'
+
+## Usage
+
+#### In `config/initializers/jbuilder-jpartial.rb`
+
+```ruby
+module Jbuilder::Jpartial
+  jpartial :_post do |post|
+    json.title post.title
+    json.author post.author.name
+    json.content post.content
+    json.set! 'comments', post.comments do |comment|
+      json._comment comment
+    end
+  end
+  
+  jpartial :_comment do |comment|
+    json.content comment.content
+    json.author comment.author.name
+  end
+end
+```
+
+#### In `app/views/posts/index.jbuilder`
+
+```ruby
+json.set! 'posts', @posts do |post|
+  json._post post
+end
+```
+
+#### Result:
+```js
+{
+    "posts": [
+        {
+            "title": "The Best of Posts",
+            "author": "M. Simon Borg",
+            "content": "Pizza time!",
+            "comments": [
+                { "content": "So good", "author": "Matt's mom" },
+                { "content": "I agree", "author": "Matt's dad" }
+            ]
+        }
+    ]   
+}
+```
+#### Why?
+When traditional partials are used with `Jbuilder`, with each partial in a different file using standard Rails conventions, render times and memory usage can skyrocket quickly with the number of records, i.e. the number of partials rendered.
+
+Using a simple DSL, `Jbuilder::Jpartial` lets you define all partials in one initializer file and call them wherever you need them: from within other partial definitions or anywhere you use `Jbuilder` in your views.
+
+The result is faster rendering and lower memory usage, while still being able to leverage the advantages of Jbuilder. In the above example, if we had used traditional partials (defined in `app/views/posts/_post.jbuilder` and `app/views/posts/_comment.jbuilder`) those templates would have to be rendered once for each `post` and/or `comment`. If you have 50 posts, each with 50 comments, that's 2,500 templates rendered! Using `Jbuilder::Jpartial`, only one file (`app/views/posts/index.jbuilder`) is rendered. All of the partial rendering is taken care of in the abstract.
+
+#### How?
+Each `jpartial` block in your initializer file defines a Jbuilder method named after whatever symbol you pass as an argument. The objects you will pass to that method are yielded to the block. Inside the block you can use plain old Jbuilder syntax.
+
+e.g.
+
+```ruby
+module Jbuilder::Jpartial
+  jpartial :_post do |post|
+    json.title post.title
+  end
+end
+```
+
+Now in your `.jbuilder` templates you can call `json._post @post`.
+
+You can specify multiple arguments and even use keyword arguments if you need to pass more than one local variable to the partial. You can also call partial methods from within other partial methods.
+
+e.g.
+
+```ruby
+module Jbuilder::Jpartial
+  jpartial :_post do |post, author:|
+    json.title post.title
+    json._author author
+  end
+  
+  jpartial :_author do |author|
+    json.name author.name
+  end
+end
+```
+
+Now you can call `json._post @post, author: @author`
+
+Route helpers that are available within the views can also be used in the configuration file.
+
+e.g.
+
+```ruby
+module Jbuilder::Jpartial
+  jpartial :_post do |post|
+    json.href post_url(post)
+    json.title post.title
+  end
+end
+```
+
+However unlikely, if you try to name a partial with the same name as a method already defined by Jbuilder it will throw an error at start up. Just pick a different name, like `#set_partial!` instead of `#set!`.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/msimonborg/jbuilder-jpartial.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/jbuilder/jpartial/version.rb

@@ -0,0 +1,5 @@
+class Jbuilder
+  module Jpartial
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/jbuilder/jpartial.rb

@@ -0,0 +1,36 @@
+require 'jbuilder'
+
+require 'jbuilder/jpartial/version'
+
+# Top level Jbuilder class
+class Jbuilder
+  def json
+    self
+  end
+
+  alias_method :old_method_missing, :method_missing
+
+  def method_missing(method_name, *args, &block)
+    if method_name.to_s =~ /(.*)_(url|path)/ && defined? @context
+      @context.send(method_name, *args, &block)
+    else
+      old_method_missing(method_name, *args, &block)
+    end
+  end
+
+  # Jpartial module
+  module Jpartial
+    DangerousMethodName = Class.new(ArgumentError)
+
+    def self.jpartial(name, &block)
+      Jbuilder.class_eval do
+        if method_defined?(name) || private_method_defined?(name)
+          raise DangerousMethodName, "The method `##{name}` is already defined by Jbuilder. "\
+            'Please choose another name to define you partial'
+        else
+          define_method(name, &block)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder-jpartial
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- M. Simon Borg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Simple DSL for faster partial rendering with Jbuilder
+email:
+- msimonborg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jbuilder/jpartial.rb
+- lib/jbuilder/jpartial/version.rb
+homepage: https://github.com/msimonborg/jbuilder-jpartial
+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: Simple DSL for faster partial rendering with Jbuilder
+test_files: []