podium 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fe3049980e26404467c390e3c924daf6a3a1e4fba2551604b32bed951cc93bf
-  data.tar.gz: 0673c2d91a92122c0201a2e7e180c266a30ef9eaacba58f42329795a74a8ff53
+  metadata.gz: 16cf9d8391da15771a0a8037bf7208bbd41f1df1d59ca2f7e59f72ce82272e6a
+  data.tar.gz: 5b048971454d125419a63818aa921e630ed857f4623a3754b58e6f09633c0af0
 SHA512:
-  metadata.gz: 56054bac669a535d64f36067fa9b878ebbd1b7e77d80ee1b629d501cff46c491bd8ee71a35efb4440c94ad5c6e6ea77e5ba0105321d6fdd939200ec66315672c
-  data.tar.gz: 9d38ca4c64dc8e2e331008b46b4899e416f2536a7fb12bce207249d0b047c5ee19b3ca0ee7e8d56e0f698e52ba3d09906dd1e4dea9af900d84ae97ec96909af1
+  metadata.gz: 10f4b94115cf02bd34fe85d88781b3ee445e493de1b2e6bd1fe764f5ef66fb77d4a23702bd8349aa86c9f118dc899bd171b06bbabbb9cec34b2b5e12cbb53add
+  data.tar.gz: 49ce6a17e730ea03ef2608530b0088b58df6a30e24c6d500cb38d427c8ccbbcf065538ceac0bb00aa8c2eeaa3b20cc69d763052ca3c8421cf0f562e44aa8d8e6

data/.gitignore

@@ -1,12 +1,12 @@
 /.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
 /doc/
+/log/*.log
 /pkg/
-/spec/reports/
 /tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
 
-# rspec failure tracking
-.rspec_status
 Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.0.2

data/Gemfile

@@ -1,12 +1,15 @@
-# frozen_string_literal: true
-
 source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in podium.gemspec
+# Specify your gem's dependencies in podium.gemspec.
 gemspec
 
-gem "rake", "~> 13.0"
+group :development do
+  gem "sqlite3"
+end
 
-gem "rspec", "~> 3.0"
+# Start debugger with binding.b -- Read more: https://github.com/ruby/debug
+gem "debug", ">= 1.0.0", group: %i[ development test ]
 
-gem "webmock", "~> 3.12"
+gem "rake"
+gem "webmock"

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Max Brosnahan
+
+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/Rakefile

@@ -1,8 +1,17 @@
-# frozen_string_literal: true
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
 
-task default: :spec
+task default: :test

data/app/controllers/podium/podlet_preview_controller.rb

@@ -0,0 +1,26 @@
+module Podium
+  class PodletPreviewController < ActionController::Base
+    def index
+      @podlets = Podium::PodletPreview.podlets
+      links = @podlets.map do |podlet|
+        name = podlet.to_s.underscore
+        %(<li><a href="#{podlet_preview_path}/#{name.dasherize}"> #{name.humanize}</a></li>)
+      end.join("\n")
+      render html: <<-HTML.html_safe
+        <h1>Podlet Preview</h1>
+        <ul>
+          #{links}
+        </ul>
+      HTML
+    end
+
+    private
+
+    def podlet_resource(name, uri: nil)
+      podium_name = name.to_s.dasherize
+      uri ||= URI(request.url).tap { |u| u.path = "/#{podium_name}" }
+
+      Podium::Resource.new(uri, podium_name)
+    end
+  end
+end

data/app/helpers/podium/layout_helper.rb

@@ -0,0 +1,19 @@
+module Podium
+  module LayoutHelper
+    def podlet_content!(name)
+      @podlet_content.fetch(name).html_safe
+    end
+
+    def podlet_assets(type)
+      Podium.instance.podlet_resources(@podlet_content.keys).flat_map do |resource|
+        resource.manifest.public_send(type)
+      end
+    end
+
+    def podlet_js_tags
+      podlet_assets(:js).map do |data|
+        javascript_tag(nil, src: data.fetch("value"), type: data.fetch("type"))
+      end.join("\n").html_safe
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/podium/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/podium/install_generator.rb

@@ -0,0 +1,44 @@
+require "rails/generators"
+
+module Podium
+  class InstallGenerator < ::Rails::Generators::Base
+    APP_CONTROLLER_PATH = "app/controllers/application_controller.rb"
+    LAYOUT_PATH = "app/views/layouts/application.html.erb"
+
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Sets up your application for integrating with podium"
+
+    def copy_initializer
+      template "podium.rb", "config/initializers/podium.rb"
+
+      inside do
+        setup_app_controller
+      end
+    end
+
+    def add_podlets_to_layout
+      return if File.read(LAYOUT_PATH).include?("podlet_content!")
+      inject_into_file LAYOUT_PATH, "<%= podlet_content!(:header) %>\n    ", before: "<%= yield %>"
+      inject_into_file LAYOUT_PATH, "    <%= podlet_content!(:footer) %>\n", after: "<%= yield %>\n"
+      inject_into_file LAYOUT_PATH, "  <%= podlet_js_tags %>\n  ", before: "</head>\n"
+    end
+
+    private
+
+    def setup_app_controller
+      return unless File.exists?(APP_CONTROLLER_PATH)
+
+      return if File.read(APP_CONTROLLER_PATH).include?("Podium::ControllerHelpers")
+
+      new_content = <<-'RUBY'
+  include Podium::ControllerHelpers
+
+  def podlets
+    [:header, :footer]
+  end
+        RUBY
+      inject_into_class APP_CONTROLLER_PATH, "ApplicationController", new_content
+    end
+  end
+end

data/lib/generators/podium/podlet_generator.rb

@@ -0,0 +1,90 @@
+require "rails/generators"
+
+module Podium
+  class PodletGenerator < ::Rails::Generators::NamedBase
+    APP_CONTROLLER_PATH = "app/controllers/application_controller.rb"
+    PREVIEW_CONTROLLER_PATH = "app/controllers/podlet_preview_controller.rb"
+    LAYOUT_PATH = "app/views/layouts/application.html.erb"
+
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Generate boilerplate for a podlet"
+
+    def create_controller
+      template "podlet_controller.rb", "app/controllers/#{controller_file_name}"
+    end
+
+    def create_views
+      template "content.html.erb", "app/views/#{folder_name}/content.html.erb"
+    end
+
+    def prepare_assets
+      create_file "app/assets/javascripts/#{folder_name}/podlet.js"
+      create_file "app/assets/stylesheets/#{folder_name}/podlet.css"
+      return if contents("app/assets/config/manifest.js").include?(folder_name)
+      append_to_file "app/assets/config/manifest.js", "//= link_directory ../javascripts/#{folder_name} .js\n"
+      append_to_file "app/assets/config/manifest.js", "//= link_directory ../stylesheets/#{folder_name} .css\n"
+    end
+
+    def setup_routes
+      route = "podlet :#{podlet_name}"
+      return if route_present?(route)
+      if route_present?("podlet_preview")
+        inject_into_file "config/routes.rb", "\n  #{route}", before: "\n  podlet_preview"
+      else
+        inject_into_file "config/routes.rb", "\n  #{route}", before: "\nend"
+        inject_into_file "config/routes.rb", "\n  podlet_preview if Rails.env.development?", before: "\nend"
+      end
+    end
+
+    def setup_preview
+      unless preview_exists?
+        template "podlet_preview_controller.rb", PREVIEW_CONTROLLER_PATH
+      end
+      return if contents(PREVIEW_CONTROLLER_PATH).include?(podlet_name)
+
+      podlet_action = <<-RUBY
+\ndef #{podlet_name}
+  resource = podlet_resource(:#{podlet_name})
+  render html: resource.fetch({}).html_safe
+end
+      RUBY
+
+      inject_into_file PREVIEW_CONTROLLER_PATH, podlet_action, before: "\nend"
+    end
+
+    private
+
+    def preview_exists?
+      inside do
+        return File.exist?(PREVIEW_CONTROLLER_PATH)
+      end
+    end
+
+    def route_present?(route)
+      contents("config/routes.rb").include?(route)
+    end
+
+    def contents(path)
+      inside do
+        return File.read(path)
+      end
+    end
+
+    def folder_name
+      "#{podlet_name}_podlet"
+    end
+
+    def podlet_name
+      name.underscore
+    end
+
+    def controller_file_name
+      "#{controller_name.underscore}.rb"
+    end
+
+    def controller_name
+      "#{name.underscore.camelcase}PodletController"
+    end
+  end
+end

data/lib/generators/podium/templates/content.html.erb.tt

@@ -0,0 +1 @@
+<strong>hello from podlet</strong>

data/lib/generators/podium/templates/podium.rb.tt

@@ -0,0 +1,6 @@
+Podium.configure do |config|
+  config.register(:header)
+  config.register(:footer)
+  # config.register(:widget_a, "http://widget.com/widget_a")
+  config.name_to_url = -> (name) { "http://#{name}.my-podlet-host" }
+end

data/lib/generators/podium/templates/podlet_controller.rb.tt

@@ -0,0 +1,10 @@
+class <%= controller_name %> < ActionController::Base
+  include Podium::PodletHelpers
+
+  def content
+  end
+
+  def fallback
+    render html: ""
+  end
+end

data/lib/generators/podium/templates/podlet_preview_controller.rb.tt

@@ -0,0 +1,3 @@
+class PodletPreviewController < Podium::PodletPreviewController
+
+end

data/lib/podium/client.rb

@@ -20,6 +20,10 @@ module Podium
       end
     end
 
+    def podlet_resources(names)
+      names.map { |name| resources[name] ||= Resource.new(podlet_uri(name), name) }
+    end
+
     private
 
     attr_reader :name_to_url, :resources
@@ -34,9 +38,5 @@ module Podium
     def podlet_uri(name)
       podlet_mapping.fetch(name)
     end
-
-    def podlet_resources(names)
-      names.map { |name| resources[name] ||= Resource.new(podlet_uri(name), name) }
-    end
   end
 end

data/lib/podium/configuration.rb

@@ -0,0 +1,19 @@
+module Podium
+  class Configuration
+    attr_reader :podlets
+
+    attr_writer :name_to_url
+
+    def initialize
+      @podlets = {}
+    end
+
+    def register(name, url = nil)
+      @podlets[name] = url
+    end
+
+    def name_to_url
+      @name_to_url || ->(name) { raise "name_to_url not configured. Set name_to_url in podium configuration." }
+    end
+  end
+end

data/lib/podium/controller_helpers.rb

@@ -0,0 +1,15 @@
+module Podium
+  module ControllerHelpers
+    def self.included(base)
+      base.before_action :load_podlet_content
+    end
+
+    def load_podlet_content
+      @podlet_content = Podium.instance.load_content_for_podlets(podlets, podlet_context)
+    end
+
+    def podlet_context
+      {}
+    end
+  end
+end

data/lib/podium/core_ext.rb

@@ -0,0 +1,25 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      def podlet(name)
+        Podium::PodletPreview.register(name)
+        prefix = "#{name}_podlet"
+        scope name.to_s.dasherize, as: prefix do
+          get "/", to: "#{prefix}#content", as: "content"
+          get "/fallback", to: "#{prefix}#fallback"
+          get "/manifest.json", to: "#{prefix}#manifest", as: "manifest"
+        end
+      end
+
+      def podlet_preview
+        scope "podlet-preview" do
+          get "/", to: "podlet_preview#index", as: "podlet_preview"
+
+          Podium::PodletPreview.podlets.each do |name|
+            get "/#{name.to_s.dasherize}", to: "podlet_preview##{name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/podium/engine.rb

@@ -0,0 +1,4 @@
+module Podium
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/podium/podlet_helpers.rb

@@ -0,0 +1,59 @@
+module Podium
+  module PodletHelpers
+    def self.included(base)
+      base.layout false
+      base.extend(ClassMethods)
+      base.before_action :set_podium_headers, only: [:content, :fallback]
+    end
+
+    def manifest
+      render json: self.class.podlet_manifest.to_json
+    end
+
+    def set_podium_headers
+      response.set_header("podlet-version", self.class.version)
+    end
+
+    def podium_params
+      @podium_params ||= ActionController::Parameters.new(podium_header_params)
+    end
+
+    def podium_header_params
+      request.headers
+        .select { |(k)| k.start_with?("HTTP_PODIUM_") }
+        .reduce({}) do |acc, (header, value)|
+        key = header.gsub("HTTP_PODIUM_", "").underscore
+        acc[key] = value
+        acc
+      end
+    end
+
+    module ClassMethods
+      def podlet_manifest
+        @podlet_manifest ||= {
+          name: self.class.name.gsub("PodletController", "").underscore.dasherize,
+          version: version,
+          content: "/",
+          fallback: "/fallback",
+          proxy: {},
+
+        }.merge(assets)
+      end
+
+      def assets
+        {
+          assets: {
+            js: "",
+            css: "",
+          },
+          js: [],
+          css: [],
+        }
+      end
+
+      def version
+        @version ||= ENV.fetch("VERSION", DateTime.now().to_i.to_s)
+      end
+    end
+  end
+end

data/lib/podium/podlet_preview.rb

@@ -0,0 +1,11 @@
+module Podium
+  module PodletPreview
+    def self.register(name)
+      podlets << name
+    end
+
+    def self.podlets
+      @podlets ||= []
+    end
+  end
+end

data/lib/podium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Podium
-  VERSION = "0.4.0"
+  VERSION = "0.8.0"
 end

data/lib/podium.rb

@@ -1,12 +1,37 @@
 # frozen_string_literal: true
 
-require_relative "podium/version"
-require_relative "podium/client"
-require_relative "podium/resource"
-require_relative "podium/manifest"
+require "podium/version"
+require "podium/client"
+require "podium/resource"
+require "podium/manifest"
+require "podium/configuration"
+require "podium/controller_helpers"
+require "podium/podlet_preview"
+require "podium/podlet_helpers"
+require "podium/core_ext"
+require "podium/engine"
 
 module Podium
-  class Error < StandardError; end
+  class NotConfiguredError < StandardError; end
 
-  # Your code goes here...
+  def self.configuration
+    @configuration || (raise NotConfiguredError, "Did you forget to run Podium.configure ?")
+  end
+
+  def self.configure
+    @configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.instance
+    @instance ||= build_instance
+  end
+
+  def self.build_instance
+    client = Podium::Client.new(name_to_url: configuration.name_to_url)
+    configuration.podlets.each do |key, url|
+      client.register(key, url)
+    end
+    client
+  end
 end

data/lib/tasks/podium_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :podium do
+#   # Task goes here
+# end

data/podium.gemspec

@@ -28,9 +28,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "rails", "> 6.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: podium
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Max Brosnahan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: 
 email:
 - maximilianbrosnahan@gmail.com
@@ -25,15 +39,45 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/podium_manifest.js
+- app/assets/images/podium/.keep
+- app/assets/stylesheets/podium/.keep
+- app/controllers/.keep
+- app/controllers/concerns/.keep
+- app/controllers/podium/podlet_preview_controller.rb
+- app/helpers/.keep
+- app/helpers/podium/layout_helper.rb
+- app/jobs/.keep
+- app/mailers/.keep
+- app/models/.keep
+- app/models/concerns/.keep
+- app/views/.keep
 - bin/console
+- bin/rails
 - bin/setup
+- bin/test
+- config/routes.rb
+- lib/generators/podium/install_generator.rb
+- lib/generators/podium/podlet_generator.rb
+- lib/generators/podium/templates/content.html.erb.tt
+- lib/generators/podium/templates/podium.rb.tt
+- lib/generators/podium/templates/podlet_controller.rb.tt
+- lib/generators/podium/templates/podlet_preview_controller.rb.tt
 - lib/podium.rb
 - lib/podium/client.rb
+- lib/podium/configuration.rb
+- lib/podium/controller_helpers.rb
+- lib/podium/core_ext.rb
+- lib/podium/engine.rb
 - lib/podium/manifest.rb
+- lib/podium/podlet_helpers.rb
+- lib/podium/podlet_preview.rb
 - lib/podium/resource.rb
 - lib/podium/version.rb
+- lib/tasks/podium_tasks.rake
 - podium.gemspec
 homepage: https://github.com/gingermusketeer/podium
 licenses: