superglue 0.40.0

data/lib/superglue/redirection.rb

@@ -0,0 +1,30 @@
+module Superglue
+  module Redirection
+    def _compute_redirect_to_location(request, options)
+      computed_location = URI.parse(super)
+      next_param = Rack::Utils
+          .parse_nested_query(computed_location.query)
+
+      if request.params[:__] == "0"
+        computed_location.query = next_param.merge({__: "0"}).to_query
+      end
+
+      computed_location.to_s
+    end
+
+    def redirect_back_with_props_at(opts)
+      if request.referrer && params[:props_at]
+        referrer_url = URI.parse(request.referrer)
+        referrer_url.query = Rack::Utils
+          .parse_nested_query(referrer_url.query)
+          .merge({props_at: params[:props_at]})
+          .to_query
+
+        redirect_to referrer_url.to_s, opts
+      else
+        redirect_back(opts)
+      end
+    end
+  end
+end
+

data/lib/superglue.rb

@@ -0,0 +1,38 @@
+require 'superglue/helpers'
+require 'superglue/redirection'
+require 'props_template'
+
+module Superglue
+  module Controller
+    include Helpers, Redirection
+
+    def self.included(base)
+      if base.respond_to?(:helper_method)
+        base.helper_method :param_to_search_path
+        base.helper_method :props_from_form_with
+        base.helper_method :search_path_to_camelized_param
+      end
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    config.superglue = ActiveSupport::OrderedOptions.new
+    config.superglue.auto_include = true
+
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      Rails::Generators.hidden_namespaces.uniq!
+      require 'generators/rails/scaffold_controller_generator'
+    end
+
+    initializer :superglue do |app|
+      ActiveSupport.on_load(:action_controller) do
+        next if self != ActionController::Base
+
+        if app.config.superglue.auto_include
+          include Controller
+        end
+      end
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,42 @@
+namespace :superglue do
+  desc "Verifies if any version of Yarn is installed"
+  task :verify_yarn do
+    begin
+      yarn_version = `yarn --version`
+      raise Errno::ENOENT if yarn_version.blank?
+    rescue Errno::ENOENT
+      $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
+      $stderr.puts "Exiting!" && exit!
+    end
+  end
+
+  desc "Verifies if any version of react is in package.json"
+  task :verify_react do
+    package_json = JSON.parse(File.read(Rails.root.join("package.json")))
+
+    if package_json['dependencies']['react'].nil?
+      $stderr.puts "React not installed. Did you install React? https://github.com/rails/webpacker#react"
+      $stderr.puts "Exiting!" && exit!
+    end
+  end
+
+  desc "Verifies webpacker has been installed"
+  task "verify_webpacker" do
+    begin
+      require "webpacker/configuration"
+    rescue LoadError
+      $stderr.puts "Superglue's web install requires webpacker!"
+      $stderr.puts "https://github.com/rails/webpacker#installation"
+      $stderr.puts "Exiting!" && exit!
+    end
+  end
+
+  namespace :install do
+    desc "Install everything needed for superglue web"
+    task 'web' => ["superglue:verify_webpacker", "webpacker:verify_install", "superglue:verify_react"] do
+      template = File.expand_path("../install/web.rb", __dir__)
+      exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{template}"
+    end
+  end
+end
+

data/test/engine_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class EngineTest < ActiveSupport::TestCase
+  test "does not include itself in action controller base when superglue auto include is false" do
+    refute ActionController::Base.included_modules.any? { |m| m.name && m.name.include?('Superglue') }
+  end
+end

data/test/helpers_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class HelpersTest < ActiveSupport::TestCase
+  include Superglue::Helpers
+
+  test 'clean_props_at returns nil if qry is nil' do
+    qry = nil
+
+    assert_nil param_to_search_path(qry)
+  end
+
+  test 'clean_props_at returns a refined qry' do
+    qry = 'foo...bar/?)()-'
+
+    assert_equal param_to_search_path(qry), ['foo', 'bar']
+  end
+
+  test 'camelize_path' do
+    path = ['foo_bar', 'foo_bar=1', 'foo_baz_roo']
+
+    assert_equal search_path_to_camelized_param(path), 'fooBar.fooBar=1.fooBazRoo'
+  end
+end

data/test/render_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class RenderController < TestController
+  require 'action_view/testing/resolvers'
+
+  append_view_path(ActionView::FixtureResolver.new(
+    'render/simple_render_with_superglue.json.props' => 'json.author "john smith"',
+    'render/simple_render_with_superglue_with_bad_layout.json.props' => 'json.author "john smith"',
+    'layouts/application.json.props' => 'json.data {yield json}',
+    'layouts/does_not_exist.html.erb' => '',
+    'layouts/application.html.erb' => <<~HTML
+      <html>
+        <head>
+          <script><%= @initial_state.strip.html_safe %></script>
+        </head>
+        <body><%=yield%></body>
+      </html>
+    HTML
+  ))
+
+  layout 'application'
+
+  def render_action
+    render :action
+  end
+
+  def simple_render_with_superglue
+    @initial_state = render_to_string(formats: [:json], layout: true)
+    render inline: '', layout: true
+  end
+
+  def simple_render_with_superglue_with_bad_layout
+    @initial_state = render_to_string(formats: [:json], layout: 'does_not_exist')
+    render inline: '', layout: true
+  end
+
+  def form_authenticity_token
+    "secret"
+  end
+end
+
+class RenderTest < ActionController::TestCase
+  tests RenderController
+
+
+  setup do
+    if Rails.version >= '6'
+      # In rails 6, the fixture orders the templates based on their appearance in the handler
+      # This doesn't happen IRL, so I'm going to explicitly set the handler here.
+      #
+      # Note that the original is the following
+      # @controller.lookup_context.handlers = [:raw, :superglue, :erb, :js, :html, :builder, :ruby]
+      @controller.lookup_context.handlers = [:props, :erb]
+    end
+  end
+
+  test "simple render with superglue" do
+    get :simple_render_with_superglue
+
+    assert_response 200
+    rendered = <<~HTML
+      <html>
+        <head>
+          <script>{"data":{"author":"john smith"}}</script>
+        </head>
+        <body></body>
+      </html>
+    HTML
+
+    assert_equal rendered, @response.body
+    assert_equal 'text/html', @response.media_type
+  end
+
+  test "simple render when the layout doesn't exist" do
+    err = assert_raise ActionView::MissingTemplate do |e|
+      get :simple_render_with_superglue_with_bad_layout
+    end
+
+    assert_equal(true, err.message.starts_with?('Missing template layouts/does_not_exist with {:locale=>[:en], :formats=>[:json], :variants=>[], :handlers=>[:props, :erb]}.'))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rails'
+require 'abstract_controller'
+require 'abstract_controller/railties/routes_helpers'
+require 'action_controller'
+require 'superglue'
+require "active_support"
+require 'active_record'
+require 'active_support/testing/autorun'
+require 'active_support/test_case'
+
+require 'props_template'
+
+ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_to?(:test_order=)
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+Rails.cache = ActiveSupport::Cache::MemoryStore.new
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+require 'support/models'
+require 'support/test_application'
+

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: superglue
+version: !ruby/object:Gem::Version
+  version: 0.40.0
+platform: ruby
+authors:
+- Johny Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: props_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+description: Rails integration for SuperglueJS
+email: jho406@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/rails/scaffold_controller_generator.rb
+- lib/generators/rails/superglue_generator.rb
+- lib/generators/rails/templates/_form.json.props
+- lib/generators/rails/templates/controller.rb.tt
+- lib/generators/rails/templates/edit.json.props
+- lib/generators/rails/templates/index.json.props
+- lib/generators/rails/templates/new.json.props
+- lib/generators/rails/templates/show.json.props
+- lib/generators/rails/templates/web/edit.html.erb
+- lib/generators/rails/templates/web/edit.js
+- lib/generators/rails/templates/web/index.html.erb
+- lib/generators/rails/templates/web/index.js
+- lib/generators/rails/templates/web/new.html.erb
+- lib/generators/rails/templates/web/new.js
+- lib/generators/rails/templates/web/show.html.erb
+- lib/generators/rails/templates/web/show.js
+- lib/install/templates/web/action_creators.js
+- lib/install/templates/web/actions.js
+- lib/install/templates/web/application.js
+- lib/install/templates/web/application.json.props
+- lib/install/templates/web/application_visit.js
+- lib/install/templates/web/initializer.rb
+- lib/install/templates/web/reducer.js
+- lib/install/web.rb
+- lib/superglue.rb
+- lib/superglue/helpers.rb
+- lib/superglue/redirection.rb
+- lib/tasks/install.rake
+- test/engine_test.rb
+- test/helpers_test.rb
+- test/render_test.rb
+- test/test_helper.rb
+homepage: https://github.com/thoughtbot/superglue/
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Rails integration for SuperglueJS
+test_files:
+- test/render_test.rb
+- test/helpers_test.rb
+- test/engine_test.rb
+- test/test_helper.rb