jb 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09fa54e898f00cadade145bbad06c48b3a110d780cb7caa61f652f3b5b9f91d4'
-  data.tar.gz: 8f7d703998d358b7be99b5a3dec6779b816ef135cd33c434aad95bf151205c13
+  metadata.gz: b8532f278227b3fc1282898874bf192c8ccf72d8fd3c1d40f1fb4d2751c1894f
+  data.tar.gz: 395b638d4565433fa519951b12a906f32448d7c4a35a531f099679e0ed643366
 SHA512:
-  metadata.gz: b1ccca7074f5b936db1d12e164404adaee0916255f4ee0bc2d92f080d5948e7d0cd661a18feaf29895842424377992f05807a9f498244af7617fef9d0722812c
-  data.tar.gz: 8564a73f19b09a5a9a75e4f07e92811a90b924de039832e4642ebb5b119403cb20a5c05023004b446ea8331f30b1129747cbc87db8af0aaa75183a1e5e11f063
+  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

@@ -9,3 +9,4 @@ gemfiles/*.lock
 /spec/reports/
 /tmp/
 /test/dummy_app/log/*
+/test/dummy_app/tmp/

data/Gemfile

@@ -5,5 +5,18 @@ 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 '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
@@ -178,8 +185,7 @@ It's also possible to render collections of partials:
 render partial: 'posts/post', collection: @posts, as: :post
 ```
 
-> NOTE: Don't use `render @post.comments` because if the collection is empty,
-`render` will return `nil` instead of an empty array.
+> 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.
 
@@ -211,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/jb.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'test-unit-rails'
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'action_args'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'debug'
+  spec.add_development_dependency 'selenium-webdriver'
 end

data/lib/jb/action_view_legacy_monkeys.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Mokey-patches for Action View 4 and 5
+# Monkey-patches for Action View 4 and 5
 
 module Jb
   module PartialRenderer

data/lib/jb/action_view_monkeys.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Mokey-patches for Action View 6+
+# Monkey-patches for Action View 6+
 
 module Jb
   # A monkey-patch that converts non-partial result to a JSON String
@@ -13,6 +13,22 @@ module Jb
     end
   end
 
+  # A wrapper class for template result that makes `to_s` method do nothing
+  class TemplateResult < SimpleDelegator
+    def to_s
+      __getobj__
+    end
+  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
+
   # 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)
@@ -45,6 +61,7 @@ module Jb
 end
 
 ::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

data/lib/jb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2023-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
+  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: 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
@@ -111,12 +125,6 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/benchmark.gemfile
-- gemfiles/rails_42.gemfile
-- gemfiles/rails_50.gemfile
-- gemfiles/rails_51.gemfile
-- gemfiles/rails_52.gemfile
-- gemfiles/rails_60.gemfile
-- gemfiles/rails_edge.gemfile
 - jb.gemspec
 - lib/generators/rails/jb_generator.rb
 - lib/generators/rails/scaffold_controller_generator.rb
@@ -147,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Faster and simpler Jbuilder alternative

data/.travis.yml

@@ -1,33 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.7.2
-  - 2.6.6
-  - 2.5.8
-
-gemfile:
-  - gemfiles/rails_60.gemfile
-  - gemfiles/rails_52.gemfile
-  - gemfiles/rails_51.gemfile
-  - gemfiles/rails_50.gemfile
-  - gemfiles/rails_42.gemfile
-
-matrix:
-  exclude:
-    - rvm: 2.7.2
-      gemfile: gemfiles/rails_52.gemfile
-    - rvm: 2.7.2
-      gemfile: gemfiles/rails_51.gemfile
-    - rvm: 2.7.2
-      gemfile: gemfiles/rails_50.gemfile
-    - rvm: 2.7.2
-      gemfile: gemfiles/rails_42.gemfile
-
-  include:
-    - rvm: 2.7.2
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: ruby-head
-      gemfile: gemfiles/rails_edge.gemfile
-
-  allow_failures:
-    - rvm: ruby-head

data/gemfiles/rails_42.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-gem 'rails', '~> 4.2.0'
-gem 'nokogiri', RUBY_VERSION < '2.1' ? '~> 1.6.0' : '>= 1.7'

data/gemfiles/rails_50.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-gem 'rails', '~> 5.0.0'

data/gemfiles/rails_51.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-gem 'rails', '~> 5.1.0'

data/gemfiles/rails_52.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-gem 'rails', '~> 5.2.0'

data/gemfiles/rails_60.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-gem 'rails', '~> 6.0.0'
-gem 'selenium-webdriver'

data/gemfiles/rails_edge.gemfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec :path => '../'
-
-git_source(:github) do |repo_name|
-  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
-  "https://github.com/#{repo_name}.git"
-end
-
-github 'rails/rails' do
-  gem 'rails'
-end
-
-gem 'selenium-webdriver'