jb 0.5.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb74db932925f1909325449f10a2ac2351ef0bb3b1a010828167d72455971f95
-  data.tar.gz: 7164ea018d3efa679e7dcb87dd99c5c5747c04786abc970a8aa6a00144d36ed1
+  metadata.gz: b8532f278227b3fc1282898874bf192c8ccf72d8fd3c1d40f1fb4d2751c1894f
+  data.tar.gz: 395b638d4565433fa519951b12a906f32448d7c4a35a531f099679e0ed643366
 SHA512:
-  metadata.gz: 723fe0582c315422cc15b0852ad5a3ddbefcad568aa0d98d1d0a2812bc293ca25a420e9111c15925c92ac9be1f848b63f00c0d0867ec60ba83c44940d434d607
-  data.tar.gz: f7b76dadc834f0aefca888e502c641792eb7824e864bcf63374f162d38916f9a285a34f0463af37e4a3c507bb46b9dcd4ae7ac6cf0c7765a4d5a6442650108f1
+  metadata.gz: 7a1e9e60aee2347cc897ec6ec10061faf4b008b840dc6c95de373ca3d3ec1544853487c0be54b2a2777713dbff5b15a4fc35af04d25d106f6ba908db896af09c
+  data.tar.gz: c696aacf1ed03636f984980ab60a5a5b53eab6d4c54ad0562392daae1e32dc82464a59073e57c6061414634e6c49a8250787cda15c90be90dce7395e91a699f4

data/.github/workflows/main.yml

@@ -0,0 +1,63 @@
+name: Ruby
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '26 13 * * *'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby_version: [ruby-head, '3.2', '3.1', '3.0', '2.7']
+        rails_version: [edge, '7.1', '7.0', '6.1']
+
+        include:
+          - ruby_version: '3.0'
+            rails_version: '6.0'
+
+          - ruby_version: '2.7'
+            rails_version: '6.0'
+
+          - ruby_version: '2.6'
+            rails_version: '6.1'
+          - ruby_version: '2.6'
+            rails_version: '6.0'
+          - ruby_version: '2.6'
+            rails_version: '5.2'
+          - ruby_version: '2.6'
+            rails_version: '5.1'
+          - ruby_version: '2.6'
+            rails_version: '5.0'
+          - ruby_version: '2.6'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+          - ruby_version: '2.5'
+            rails_version: '5.2'
+          - ruby_version: '2.5'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+          - ruby_version: '2.4'
+            rails_version: '5.2'
+          - ruby_version: '2.4'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler: ${{ matrix.bundler_version }}
+          bundler-cache: true
+        continue-on-error: ${{ (matrix.ruby_version == 'ruby-head') || (matrix.allow_failures == 'true') }}
+      - run: bundle exec rake
+        continue-on-error: ${{ (matrix.ruby_version == 'ruby-head') || (matrix.allow_failures == 'true') }}

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -8,3 +9,4 @@
 /spec/reports/
 /tmp/
 /test/dummy_app/log/*
+/test/dummy_app/tmp/

data/Gemfile

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jb.gemspec
 gemspec
 
+if ENV['RAILS_VERSION'] == 'edge'
+  gem 'rails', git: 'https://github.com/rails/rails.git', branch: 'main'
+elsif ENV['RAILS_VERSION']
+  gem 'rails', "~> #{ENV['RAILS_VERSION']}.0"
+else
+  gem 'rails'
+end
+
+gem 'nokogiri', RUBY_VERSION < '2.1' ? '~> 1.6.0' : '>= 1.7'
+gem 'loofah', RUBY_VERSION < '2.5' ? '< 2.21.0' : '>= 0'
+gem 'selenium-webdriver'
+gem 'net-smtp' if RUBY_VERSION >= '3.1'
+
 # For benchmarking
-gem 'jbuilder'
-gem 'benchmark-ips'
 gem 'action_args'

data/README.md

@@ -21,19 +21,34 @@ Put a template file named `*.jb` in your Rails app's `app/views/*` directory, an
 
 ## Features
 
-* No ugly builder syntax
+* No original builder syntax that you have to learn
 * No `method_missing` calls
 * `render_partial` with :collection option actually renders the collection (unlike Jbuilder)
 
 
 ## Syntax
 
-A `.jb` template should contain Ruby code that returns any Ruby Object that responds_to `to_json` (generally Hash or Array).
-Then the return value will be `to_json`ed to a JSON String.
+A `.jb` template should contain Ruby code that returns any Ruby Object that responds\_to `to_json` (generally Hash or Array). Then the return value will be `to_json`ed to a JSON String.
 
 
 ## Examples
 
+Let's start with a very simple one. Just write a Ruby Hash as a template:
+
+``` ruby
+{language: 'Ruby', author: {name: 'Matz'}}
+```
+
+This renders the following JSON text:
+
+``` javascript
+{"language": "Ruby", "author": {"name": "Matz"}}
+```
+
+Note that modern Ruby Hash syntax pretty much looks alike JSON syntax. It's super-straight forward. Who needs a DSL to do this?
+
+Next one is a little bit advanced usage. The template doesn't have to be a single literal but can be any code that returns a Hash object:
+
 ``` ruby
 # app/views/messages/show.json.jb
 
@@ -97,18 +112,17 @@ This will build the following structure:
 }
 ```
 
-To define attribute and structure names dynamically, just use Ruby Hash.
-Note that modern Ruby Hash syntax pretty much looks alike JSON syntax.
-It's super-straight forward. Who needs a DSL to do this?
+If you want to define attribute and structure names dynamically, of course you still can do this with a Ruby Hash literal.
 
 ``` ruby
-{author: {name: 'Matz'}}
+# model_name, column_name = :author, :name
+
+{model_name => {column_name => 'Matz'}}
 
 # => {"author": {"name": "Matz"}}
 ```
 
-Top level arrays can be handled directly.  Useful for index and other collection actions.
-And you know, Ruby is such a powerful language for manipulating collections:
+Top level arrays can be handled directly. Useful for index and other collection actions. And you know, Ruby is such a powerful language for manipulating collections:
 
 ``` ruby
 # @comments = @post.comments
@@ -136,11 +150,7 @@ Jb has no special DSL method for extracting attributes from array directly, but
 # => [{"id": 1, "name": "Matz"}, {"id": 2, "name": "Nobu"}]
 ```
 
-You can use Jb directly as an Action View template language.
-When required in Rails, you can create views ala show.json.jb.
-You'll notice in the following example that the `.jb` template
-doesn't have to be one big Ruby Hash literal as a whole
-but it can be any Ruby code that finally returns a Hash instance.
+You can use Jb directly as an Action View template language. When required in Rails, you can create views ala `show.json.jb`. You'll notice in the following example that the `.jb` template doesn't have to be one big Ruby Hash literal as a whole but it can be any Ruby code that finally returns a Hash instance.
 
 ``` ruby
 # Any helpers available to views are available in the template
@@ -163,10 +173,7 @@ end
 json
 ```
 
-You can use partials as well.  The following will render the file
-`views/comments/_comments.json.jb`, and set a local variable
-`comments` with all this message's comments, which you can use inside
-the partial.
+You can use partials as well.  The following will render the file `views/comments/_comments.json.jb`, and set a local variable `comments` with all this message's comments, which you can use inside the partial.
 
 ```ruby
 render 'comments/comments', comments: @message.comments
@@ -176,12 +183,10 @@ It's also possible to render collections of partials:
 
 ```ruby
 render partial: 'posts/post', collection: @posts, as: :post
-
-# or
-
-render @post.comments
 ```
 
+> NOTE: Don't use `render @post.comments` because if the collection is empty, `render` will return `nil` instead of an empty array.
+
 You can pass any objects into partial templates with or without `:locals` option.
 
 ```ruby
@@ -194,7 +199,7 @@ render 'sub_template', user: user
 
 You can of course include Ruby `nil` as a Hash value if you want. That would become `null` in the JSON.
 
-To prevent Jb from including null values in the output, Active Support provides `Hash#compact!` method for you:
+You can use `Hash#compact`/`!` method to prevent including `null` values in the output:
 
 ```ruby
 {foo: nil, bar: 'bar'}.compact
@@ -212,8 +217,7 @@ end
 
 
 ## The Generator
-Jb extends the default Rails scaffold generator and adds some .jb templates.
-If you don't need them, please configure like so.
+Jb extends the default Rails scaffold generator and adds some `.jb` templates. If you don't need them, please configure like so.
 
 ```ruby
 Rails.application.config.generators.jb false

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/bin/benchmark.sh

@@ -2,4 +2,4 @@
 
 cd $(dirname "$0")/../test/dummy_app
 
-BUNDLE_GEMFILE=../../Gemfile bundle e rails r bin/bench.rb
+BUNDLE_GEMFILE=../../gemfiles/benchmark.gemfile bundle e rails r bin/bench.rb

data/gemfiles/benchmark.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'rails'
+
+gem 'jbuilder'
+gem 'benchmark-ips'
+gem 'action_args'

data/jb.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 # frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jb/version'
@@ -20,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'multi_json'
-
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'test-unit-rails'
   spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'action_args'
+  spec.add_development_dependency 'debug'
+  spec.add_development_dependency 'selenium-webdriver'
 end

data/lib/generators/rails/jb_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators/named_base'
 require 'rails/generators/resource_helpers'
 

data/lib/generators/rails/scaffold_controller_generator.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
 
 module Rails
   module Generators
     class ScaffoldControllerGenerator
-      hook_for :jb, default: true
+      hook_for :jb, type: :boolean, default: true
     end
   end
 end

data/lib/jb/action_view_legacy_monkeys.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# Monkey-patches for Action View 4 and 5
+
+module Jb
+  module PartialRenderer
+    module JbTemplateDetector
+      # A monkey-patch to inject StrongArray module to Jb partial renderer
+      private def find_partial(*)
+        template = super
+        extend RenderCollectionExtension if template && (template.handler == Jb::Handler)
+        template
+      end
+    end
+
+    # A horrible monkey-patch to prevent rendered collection from being converted to String
+    module StrongArray
+      def join(*)
+        self
+      end
+
+      def html_safe
+        self
+      end
+    end
+
+    # A monkey-patch strengthening rendered collection
+    module RenderCollectionExtension
+      private def collection_with_template
+        super.extend StrongArray
+      end
+
+      private def collection_without_template
+        super.extend StrongArray
+      end
+
+      private def render_collection
+        return [] if @collection.blank?
+        super
+      end
+    end
+  end
+
+  # A monkey-patch that converts non-partial result to a JSON String
+  module TemplateRenderer
+    module JSONizer
+      def render_template(template, *)
+        template.respond_to?(:handler) && (template.handler == Jb::Handler) ? super.to_json : super
+      end
+    end
+  end
+end
+
+::ActionView::PartialRenderer.prepend ::Jb::PartialRenderer::JbTemplateDetector
+::ActionView::TemplateRenderer.prepend ::Jb::TemplateRenderer::JSONizer

data/lib/jb/action_view_monkeys.rb

@@ -1,54 +1,70 @@
 # frozen_string_literal: true
-require 'multi_json'
+# Monkey-patches for Action View 6+
 
 module Jb
-  module PartialRenderer
-    module JbTemplateDetector
-      # A monkey-patch to inject StrongArray module to Jb partial renderer
-      private def find_partial
-        template = super
-        extend RenderCollectionExtension if template && (template.handler == Jb::Handler)
-        template
+  # A monkey-patch that converts non-partial result to a JSON String
+  module TemplateRenderer
+    module JSONizer
+      def render_template(_view, template, *)
+        rendered_template = super
+        rendered_template.instance_variable_set :@body, rendered_template.body.to_json if template.respond_to?(:handler) && (template.handler == Jb::Handler)
+        rendered_template
       end
     end
+  end
 
-    # A horrible monkey-patch to prevent rendered collection from being converted to String
-    module StrongArray
-      def join(*)
-        self
-      end
-
-      def html_safe
-        self
-      end
+  # A wrapper class for template result that makes `to_s` method do nothing
+  class TemplateResult < SimpleDelegator
+    def to_s
+      __getobj__
     end
+  end
 
-    # A monkey-patch strengthening rendered collection
-    module RenderCollectionExtension
-      private def collection_with_template
-        super.extend StrongArray
-      end
-
-      private def collection_without_template
-        super.extend StrongArray
-      end
+  # Rails 7.1+: A monkey-patch not to stringify rendered object from JB templates
+  module TemlateResultCaster
+    def _run(method, template, *, **)
+      val = super
+      val = Jb::TemplateResult.new val if template.respond_to?(:handler) && (template.handler == Jb::Handler)
+      val
+    end
+  end
 
-      private def render_collection
-        return [] if @collection.blank?
-        super
+  # Rails 6.1+: A monkey-patch for jb template collection result's `body` not to return a String but an Array
+  module CollectionRendererExtension
+    private def render_collection(_collection, _view, _path, template, _layout, _block)
+      obj = super
+      if template.respond_to?(:handler) && (template.handler == Jb::Handler)
+        if ActionView::AbstractRenderer::RenderedCollection::EmptyCollection === obj
+          def obj.body; []; end
+        else
+          def obj.body; @rendered_templates.map(&:body); end
+        end
       end
+      obj
     end
   end
 
-  # A monkey-patch that converts non-partial result to a JSON String
-  module TemplateRenderer
-    module JSONizer
-      def render_template(template, *)
-        template.respond_to?(:handler) && (template.handler == Jb::Handler) ? MultiJson.dump(super) : super
+  # Rails 6.0: A monkey-patch for jb template collection result's `body` not to return a String but an Array
+  module PartialRendererExtension
+    private def render_collection(_view, template)
+      obj = super
+      if template.respond_to?(:handler) && (template.handler == Jb::Handler)
+        if ActionView::AbstractRenderer::RenderedCollection::EmptyCollection === obj
+          def obj.body; []; end
+        else
+          def obj.body; @rendered_templates.map(&:body); end
+        end
       end
+      obj
     end
   end
 end
 
-::ActionView::PartialRenderer.prepend ::Jb::PartialRenderer::JbTemplateDetector
 ::ActionView::TemplateRenderer.prepend ::Jb::TemplateRenderer::JSONizer
+::ActionView::Base.prepend ::Jb::TemlateResultCaster if (ActionView::VERSION::MAJOR >= 7) && (ActionView::VERSION::MINOR >= 1)
+begin
+  # ActionView::CollectionRenderer is a newly added class since 6.1
+  ::ActionView::CollectionRenderer.prepend ::Jb::CollectionRendererExtension
+rescue NameError
+  ::ActionView::PartialRenderer.prepend ::Jb::PartialRendererExtension
+end

data/lib/jb/handler.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module Jb
   class Handler
     class_attribute :default_format
     self.default_format = :json
 
-    def self.call(template)
-      template.source
+    def self.call(template, source=nil)
+      source || template.source
     end
 
     def self.handles_encoding?

data/lib/jb/railtie.rb

@@ -1,14 +1,34 @@
 # frozen_string_literal: true
+
 module Jb
   class Railtie < ::Rails::Railtie
     initializer 'jb' do
       ActiveSupport.on_load :action_view do
-        require 'jb/action_view_monkeys'
+        if Rails::VERSION::MAJOR >= 6
+          require 'jb/action_view_monkeys'
+        else
+          require 'jb/action_view_legacy_monkeys'
+        end
         require 'jb/handler'
         ::ActionView::Template.register_template_handler :jb, Jb::Handler
       end
     end
 
+    if Rails::VERSION::MAJOR >= 5
+      module ::ActionController
+        module ApiRendering
+          include ActionView::Rendering
+        end
+      end
+
+      ActiveSupport.on_load :action_controller do
+        if self == ActionController::API
+          include ActionController::Helpers
+          include ActionController::ImplicitRender
+        end
+      end
+    end
+
     generators do |app|
       Rails::Generators.configure! app.config.generators
       Rails::Generators.hidden_namespaces.uniq!

data/lib/jb/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Jb
-  VERSION = '0.5.0'
+  VERSION = '0.8.2'
 end

data/lib/jb.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 require "jb/version"
 require 'jb/railtie'

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: jb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Akira Matsuda
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2023-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: action_args
+  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: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,12 +124,14 @@ files:
 - bin/benchmark.sh
 - bin/console
 - bin/setup
+- gemfiles/benchmark.gemfile
 - jb.gemspec
 - lib/generators/rails/jb_generator.rb
 - lib/generators/rails/scaffold_controller_generator.rb
 - lib/generators/rails/templates/index.json.jb
 - lib/generators/rails/templates/show.json.jb
 - lib/jb.rb
+- lib/jb/action_view_legacy_monkeys.rb
 - lib/jb/action_view_monkeys.rb
 - lib/jb/handler.rb
 - lib/jb/railtie.rb
@@ -124,7 +140,7 @@ homepage: https://github.com/amatsuda/jb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.5.0.dev
+signing_key:
 specification_version: 4
 summary: Faster and simpler Jbuilder alternative
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem update bundler