plate_id 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4151d00de7c7c38bc47ea35c0267bcba125771227fb74eee5f5fb9199e4ae28
+  data.tar.gz: 9103e79ca0733b0a6352dcfdfd03a23a67c52d8a49ff1be79b677978eb76ec19
+SHA512:
+  metadata.gz: 5b70fca72ad26435053e59a4c14c511053c6234bcbe4d6d037076ef9a32aaf7f0df599ceae47ce4edaea4dc71d718825a4492392bfa9fda706f747c4238c07e5
+  data.tar.gz: a1d98817a18b6f6ca023e09d6e0592214b9ac7a9562fa1beaa91608f4ba413694a4cbdf6e6cfa6f192645b68866e302e5d1a5f8ba972b800cef370cfd00ba1f5

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/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in plate_id.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kobus Post
+
+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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "plate_id"
+
+# 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/lib/plate_id.rb

@@ -0,0 +1,67 @@
+require_relative "uri/plate_id"
+
+class PlateID
+  class << self
+
+    def create(model)
+      new(URI::PlateID.create(model))
+    end
+
+    def parse(plate_id)
+      plate_id.is_a?(self) ? plate_id : new(plate_id)
+    rescue URI::Error
+      nil
+    end
+
+    def find(plate_id)
+      res = parse(plate_id)
+      res&.find
+    end
+  end
+
+  attr_reader :uri
+
+  def host
+    uri.host
+  end
+
+  def base_class
+    uri.base_class
+  end
+
+  def id
+    uri.id
+  end
+
+  def to_s
+    uri.to_s
+  end
+
+  def initialize(plate_id)
+    @uri = fetch_uri(plate_id)
+  end
+
+  def plate_class
+    fetch_plate_class(uri)&.safe_constantize
+  end
+
+  def find
+    return unless uri.id
+
+    plate_class&.find_by(id: uri.id)
+  end
+
+  private
+
+  def fetch_uri(plate_id)
+    return plate_id if plate_id.is_a?(URI::PlateID)
+
+    URI::PlateID.parse(plate_id)
+  end
+
+  def fetch_plate_class(uri)
+    uri.class::MAPPING.detect do |_klass, map|
+      map[:host] == uri.host && map[:base_class] == uri.base_class
+    end[0]
+  end
+end

data/lib/uri/plate_id.rb

@@ -0,0 +1,160 @@
+module URI
+  class PlateID < Generic
+
+    # URI::PlateID encodes an Plate unique reference to a specific model as an URI
+    # and notates it according to a mapping. The PlateID URI is meant for external
+    # communication.
+    #
+    # The URI format looks like "plateid://group_name/base_class/id".
+
+    MAPPING = {
+      "Site" => { host: "Base", base_class: "Site" },
+      "Ngn::Attachment" => { host: "Base", base_class: "Attachment" },
+      "Ngn::Domain" => { host: "Base", base_class: "Domain" },
+      "Ngn::ClipboardItem" => { host: "Base", base_class: "ClipboardItem" },
+
+      "Ngn::Content::Post" => { host: "Content", base_class: "Post" },
+      "Ngn::Content::Section" => { host: "Content", base_class: "Section" },
+      "Ngn::Content::Row" => { host: "Content", base_class: "Row" },
+      "Ngn::Content::Column" => { host: "Content", base_class: "Column" },
+      "Ngn::Content::Element" => { host: "Content", base_class: "Element" },
+      "Ngn::Content::ContentObject" => { host: "Content", base_class: "ContentObject" },
+      "Ngn::Content::SiteTranslation" => { host: "Content", base_class: "SiteTranslation" },
+
+      "Ngn::ContentModel::ContentField" => { host: "ContentModel", base_class: "ContentField" },
+      "Ngn::ContentModel::ContentFieldTab" => { host: "ContentModel", base_class: "ContentFieldGroup" },
+      "Ngn::ContentModel::PostType" => { host: "ContentModel", base_class: "PostType" },
+      "Ngn::ContentModel::SectionType" => { host: "ContentModel", base_class: "SectionType" },
+      "Ngn::ContentModel::ElementType" => { host: "ContentModel", base_class: "ElementType" },
+      "Ngn::ContentModel::ObjectTypeKind" => { host: "ContentModel", base_class: "ContentType" },
+      "Ngn::ContentModel::TrayType" => { host: "ContentModel", base_class: "TrayType" },
+      "Ngn::ContentModel::AuthenticationType" => { host: "ContentModel", base_class: "AuthenticationType" },
+
+      "Ngn::Theming::SiteTheme" => { host: "Theming", base_class: "Theme" },
+      "Ngn::Theming::ThemeFile" => { host: "Theming", base_class: "ThemeFile" },
+      "Ngn::Theming::Prerender" => { host: "Theming", base_class: "Prerender" },
+
+      "Ngn::Auth::User" => { host: "Auth", base_class: "User" },
+      "Ngn::Auth::ApiIntegration" => { host: "Auth", base_class: "ApiIntegration" },
+
+      "Ngn::Auth::AccessControl::Policy" => { host: "AccessControl", base_class: "Policy" },
+
+      "Org::Company" => { host: "Organization", base_class: "Company" },
+      "Org::Partner" => { host: "Organization", base_class: "Partner" },
+      "Org::FormMessage" => { host: "Organization", base_class: "FormMessage" }
+    }
+
+    attr_reader :base_class, :id
+
+    class << self
+      # Create a new URI::PlateID by parsing a plateid string with argument check.
+      #
+      #   URI::PlateID.parse 'plateid://Group/Class/1'
+      #
+      def parse(uri)
+        generic_components = URI.split(uri) << nil << true # nil parser, true arg_check
+        new(*generic_components)
+      end
+
+      # Shorthand to build a URI::PlateID from a model.
+      #
+      #   URI::PlateID.create(Ngn::Content::Post.find(5))
+      #   URI::PlateID.create(Ngn::Content::Post)
+      def create(model)
+        model = model.new if model.class == Class
+        build(model_name: model.class.name, model_id: model.id)
+      end
+
+      # Create a new URI::PlateID from components with argument check.
+      #
+      # The allowed components are app, model_name, model_id and params, which
+      # can be either a hash or an array.
+      #
+      # Using a hash:
+      #
+      #   URI::PlateID.build(
+      #     model_name: 'Ngn::ContentModelElementType',
+      #     model_id: '1'
+      #   )
+      def build(args)
+        comps = Util.make_components_hash(self, args)
+        parts = MAPPING[comps[:model_name]].dup
+        parts[:scheme] = comps[:scheme]
+        parts[:id] = comps[:model_id]
+        parts[:path] = "/#{parts[:base_class]}/#{CGI.escape(parts[:id].to_s)}"
+
+        super(parts)
+      end
+    end
+
+    # Implement #to_s to avoid no implicit conversion of nil into string when path is nil
+    def to_s
+      "plateid://#{host}/#{base_class}/#{id}"
+    end
+
+    protected
+
+    def set_path(path)
+      set_model_components(path) unless defined?(@model_name) && @model_id
+      super
+    end
+
+    private
+
+    COMPONENT = [:scheme, :host, :base_class, :id].freeze
+    # Extracts model_name and model_id from the URI path.
+    PATH_REGEXP = %r(\A/([A-Z][^/]+)/?([0-9]+)?\z)
+
+    def check_host(host)
+      validate_component(host)
+      super
+    end
+
+    def check_path(path)
+      validate_component(path)
+      set_model_components(path, true)
+    end
+
+    def check_scheme(scheme)
+      if scheme == "plateid"
+        super
+      else
+        raise URI::BadURIError, "Not a plateid:// URI scheme: #{inspect}"
+      end
+    end
+
+    def set_model_components(path, validate = false)
+      _, base_class, id = path.match(PATH_REGEXP).to_a
+      id = CGI.unescape(id) if id
+
+      if validate
+        validate_mapping(host, base_class)
+        validate_component(host)
+        validate_component(base_class)
+      end
+
+      @host = host
+      @base_class = base_class
+      @id = id
+    end
+
+    def validate_component(component)
+      return component unless component.nil? || component.empty?
+
+      raise URI::InvalidComponentError,
+        "Expected a URI like plateid://Group/Class/1234: #{inspect}"
+    end
+
+    def validate_mapping(host, base_class)
+      reverse_map = MAPPING.values.detect do |map|
+        map[:host] == host && map[:base_class] == base_class
+      end
+      return if reverse_map
+
+      raise URI::InvalidComponentError,
+        "Not a valid PlateID URI: #{inspect}"
+    end
+  end
+
+  @@schemes["PlateID"] = PlateID
+end

data/plate_id.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "plate_id"
+  spec.version       = "0.0.0"
+  spec.authors       = ["Kobus Post"]
+  spec.email         = ["kobus@getplate.com"]
+  spec.homepage      = "https://www.getplate.com"
+
+  spec.summary       = "Refer to any Plate object or class by using the URI syntax: plateid://Group/Class/id"
+  spec.description   = "Identify any Plate record or class with URIs. Somewhat based on Rails's GlobalID gem."
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: plate_id
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Kobus Post
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-12 00:00:00.000000000 Z
+dependencies: []
+description: Identify any Plate record or class with URIs. Somewhat based on Rails's
+  GlobalID gem.
+email:
+- kobus@getplate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- lib/plate_id.rb
+- lib/uri/plate_id.rb
+- plate_id.gemspec
+homepage: https://www.getplate.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: 'Refer to any Plate object or class by using the URI syntax: plateid://Group/Class/id'
+test_files: []