inertia_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68ba506e9262c9b0ad4d631811f337b4713d103bf2f5c2fc80dce3a8dc688428
+  data.tar.gz: 8d1dce1b39abbb1c4bcdef67010ead191bfb83dec3ae2327cfe7fcd3e40191b0
+SHA512:
+  metadata.gz: 013501ef4ce007f27d8f16380fda786be161affaa2b46ba42221b2eb3f5568e29e97f2318e9c39e82f86312b8b55b9fc3c58c8a145467b53edf020bf6ca35bf6
+  data.tar.gz: 1c20923053db461a39614f988a999fe86272e80f4a89d572bd1419d0b9ddfbdc177c266951c41afacd1033844d81376b6603a8faa80fc0678de80615ca32fe41

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in inertia-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Bellawatt
+
+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,14 @@
+# Inertia.js Rails Adapter
+
+Visit [inertiajs.com](https://inertiajs.com/) to learn more.
+
+# Note to pre Rubygems release users
+
+The initial version of the gem was named `inertia`; however, that name was not available on Rubygems. 
+
+The 1.0.0 version release on Rubygems is `intertia_rails`.
+
+The changes required are:
+
+1. Use `gem 'inertia_rails'` in your Gemfile (or `gem install inertia_rails`)
+2. Change any `Inertia.configure` calls to `InertiaRails.configure`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/views/inertia.html.erb

@@ -0,0 +1 @@
+<div id="app" data-page="<%= page.to_json %>"></div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inertia_rails/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inertia_rails.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "inertia_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "inertia_rails"
+  spec.version       = InertiaRails::VERSION
+  spec.authors       = ["Brian Knoles", "Brandon Shar", "Eugene Granovsky"]
+  spec.email         = ["brain@bellawatt.com", "brandon@bellawatt.com", "eugene@bellawatt.com"]
+
+  spec.summary       = %q{Inertia adapter for Rails}
+  spec.homepage      = "https://github.com/inertiajs/inertia-rails/"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/inertia_rails.rb

@@ -0,0 +1,17 @@
+require 'inertia_rails/renderer'
+require 'inertia_rails/engine'
+
+ActionController::Renderers.add :inertia do |component, options|
+  InertiaRails::Renderer.new(
+    component,
+    request,
+    response,
+    method(:render),
+    props: options[:props],
+    view_data: options[:view_data],
+  ).render
+end
+
+module InertiaRails
+  class Error < StandardError; end
+end

data/lib/inertia_rails/controller.rb

@@ -0,0 +1,14 @@
+require_relative "inertia_rails"
+
+module InertiaRails
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def inertia_share(**args, &block)
+        InertiaRails.share(args) if args
+        InertiaRails.share_block(block) if block
+      end
+    end
+  end
+end

data/lib/inertia_rails/engine.rb

@@ -0,0 +1,16 @@
+require_relative "middleware"
+require_relative "controller"
+
+module InertiaRails
+  class Engine < ::Rails::Engine
+    initializer "inertia_rails.configure_rails_initialization" do |app|
+      app.middleware.use ::InertiaRails::Middleware
+    end
+
+    initializer "inertia_rails.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include ::InertiaRails::Controller
+      end
+    end
+  end
+end

data/lib/inertia_rails/inertia_rails.rb

@@ -0,0 +1,45 @@
+module InertiaRails
+  mattr_accessor :shared_plain_data, default: {}
+  mattr_accessor :shared_blocks, default: []
+
+  def self.configure
+    yield(Configuration)
+  end
+
+  # "Getters"
+  def self.shared_data
+    shared_plain_data.merge!(evaluated_blocks(shared_blocks))
+  end
+
+  def self.version
+    Configuration.evaluated_version
+  end
+
+  def self.layout
+    Configuration.layout
+  end
+
+  # "Setters"
+  def self.share(**args)
+    shared_plain_data.merge!(args)
+  end
+
+  def self.share_block(block)
+    shared_blocks.push(block)
+  end
+
+  private
+
+  module Configuration
+    mattr_accessor :layout, default: 'application'
+    mattr_accessor :version, default: nil
+
+    def self.evaluated_version
+      version.respond_to?(:call) ? version.call : version
+    end
+  end
+
+  def self.evaluated_blocks(blocks)
+    blocks.flat_map(&:call).reduce(&:merge) || {}
+  end
+end

data/lib/inertia_rails/middleware.rb

@@ -0,0 +1,44 @@
+module InertiaRails
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+  
+    def call(env)
+      status, headers, body = @app.call(env)
+      request = ActionDispatch::Request.new(env)
+  
+      return [status, headers, body] unless env['HTTP_X_INERTIA'].present?
+  
+      return force_refresh(request) if stale?(env['REQUEST_METHOD'], env['HTTP_X_INERTIA_VERSION'])
+  
+      if is_redirect_status?(status) &&
+          is_non_get_redirectable_method?(env['REQUEST_METHOD'])
+        status = 303
+      end
+  
+      [status, headers, body]
+    end
+  
+    private
+  
+    def is_redirect_status?(status)
+      [301, 302].include? status
+    end
+  
+    def is_non_get_redirectable_method?(request_method)
+      ['PUT', 'PATCH', 'DELETE'].include? request_method
+    end
+  
+    def stale?(request_method, inertia_version)
+      sent_version = InertiaRails.version.is_a?(Numeric) ? inertia_version.to_f : inertia_version
+      saved_version = InertiaRails.version.is_a?(Numeric) ? InertiaRails.version.to_f : InertiaRails.version
+      request_method == 'GET' && sent_version != saved_version
+    end
+  
+    def force_refresh(request)
+      request.flash.keep
+      Rack::Response.new('', 409, {'X-Inertia-Location' => request.original_url})
+    end
+  end
+end

data/lib/inertia_rails/renderer.rb

@@ -0,0 +1,55 @@
+require_relative "inertia_rails"
+
+module InertiaRails
+  class Renderer
+    attr_reader :component, :view_data
+
+    def initialize(component, request, response, render_method, props:, view_data:)
+      @component = component
+      @request = request
+      @response = response
+      @render_method = render_method
+      @props = props || {}
+      @view_data = view_data || {}
+    end
+
+    def render
+      if @request.headers['X-Inertia']
+        @response.set_header('Vary', 'Accept')
+        @response.set_header('X-Inertia', 'true')
+        @render_method.call json: page, status: 200
+      else
+        @render_method.call template: 'inertia', layout: ::InertiaRails.layout, locals: (view_data).merge({page: page})
+      end
+    end
+
+    private
+
+    def props
+      only = (@request.headers['X-Inertia-Partial-Data'] || '').split(',').compact.map(&:to_sym)
+
+      _props = ::InertiaRails.shared_data.merge(@props)
+
+      _props = (only.any? && @request.headers['X-Inertia-Partial-Component'] == component) ?
+        _props.select {|key| key.in? only} :
+        _props
+
+      deep_transform_values(_props, lambda {|prop| prop.respond_to?(:call) ? prop.call : prop })
+    end
+
+    def page
+      {
+        component: component,
+        props: props,
+        url: @request.original_url,
+        version: ::InertiaRails.version,
+      }
+    end
+
+    def deep_transform_values(hash, proc)
+      return proc.call(hash) unless hash.is_a? Hash
+
+      hash.transform_values {|value| deep_transform_values(value, proc)}
+    end
+  end
+end

data/lib/inertia_rails/version.rb

@@ -0,0 +1,3 @@
+module InertiaRails
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: inertia_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Knoles
+- Brandon Shar
+- Eugene Granovsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: 
+email:
+- brain@bellawatt.com
+- brandon@bellawatt.com
+- eugene@bellawatt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/inertia.html.erb
+- bin/console
+- bin/setup
+- inertia_rails.gemspec
+- lib/inertia_rails.rb
+- lib/inertia_rails/controller.rb
+- lib/inertia_rails/engine.rb
+- lib/inertia_rails/inertia_rails.rb
+- lib/inertia_rails/middleware.rb
+- lib/inertia_rails/renderer.rb
+- lib/inertia_rails/version.rb
+homepage: https://github.com/inertiajs/inertia-rails/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/inertiajs/inertia-rails/
+  source_code_uri: https://github.com/inertiajs/inertia-rails/
+  changelog_uri: https://github.com/inertiajs/inertia-rails//CHANGELOG.md
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Inertia adapter for Rails
+test_files: []