webamm_to_rails 7.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fdd1ccfe0c4337456780dbccbc8b94490db3d43ec6fea627f14d9a03c408119
+  data.tar.gz: 5a2a3f70e63ca2302f47baa9c936b564016bae624df5d7924353c5173f14de14
+SHA512:
+  metadata.gz: 2f1cd09012889fbfaa1734ed8d88d1e56bb07d157d780ad8f7dcabee41ca6d980e94e43781dbe1c90fa912d62d80381a6773bddbb523ec9266ff72d7f6448baa
+  data.tar.gz: d1e8c1008d6d854faf6a699b7b0c6314473c2e61373ddb2b66680874ca678a3b9b29841c4d3882be14385d083c38f28e9065202e74a91a13f4c56e8556b88132

data/README.md

@@ -0,0 +1,3 @@
+# WEBAMM definition to Ruby on Rails code
+
+Library to convert WEBAMM (Web Application Metadata Markup) definition to Ruby on Rails code.

data/lib/webamm_to_rails/features/definitions.rb

@@ -0,0 +1,19 @@
+require_relative 'devise_onlineable/definition'
+
+module WebammToRails
+  module Features
+    class Definitions
+      def initialize(waml_definition:)
+        @waml_definition = waml_definition
+      end
+
+      def collection
+        features = []
+
+        features |= ::WebammToRails::Features::DeviseOnlineable::Definition.new(waml_definition: @waml_definition).collection
+
+        features
+      end
+    end
+  end
+end

data/lib/webamm_to_rails/features/devise_onlineable/definition.rb

@@ -0,0 +1,44 @@
+require_relative 'definitions/connection/presenter'
+
+module WebammToRails
+  module Features
+    module DeviseOnlineable
+      class Definition
+        def initialize(waml_definition:)
+          @waml_definition = waml_definition
+        end
+
+        def collection
+          return [] if @waml_definition.authentication.none? { |auth| auth.features.include?('online_indication') }
+
+          [
+            {
+              path: 'app/channels/application_cable/connection.rb',
+              content: ::WebammToRails::Features::DeviseOnlineable::Definitions::Connection::Presenter.new(waml_definition: @waml_definition).render
+            },
+            {
+              path: 'app/channels/online_channel.rb',
+              content: File.read(File.expand_path('templates/app/channels/online_channel.rb.erb', __dir__))
+            },
+            {
+              path: 'app/models/concerns/devise_onlineable.rb',
+              content: File.read(File.expand_path('templates/app/models/concerns/devise_onlineable.rb.erb', __dir__))
+            },
+            {
+              path: 'app/javascript/channels/consumer.js',
+              content: File.read(File.expand_path('templates/app/javascript/channels/consumer.js.erb', __dir__))
+            },
+            {
+              path: 'app/javascript/channels/index.js',
+              content: File.read(File.expand_path('templates/app/javascript/channels/index.js.erb', __dir__))
+            },
+            {
+              path: 'app/javascript/channels/online_channel.js',
+              content: File.read(File.expand_path('templates/app/javascript/channels/online_channel.js.erb', __dir__))
+            }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/webamm_to_rails/features/devise_onlineable/definitions/connection/presenter.rb

@@ -0,0 +1,29 @@
+module WebammToRails
+  module Features
+    module DeviseOnlineable
+      module Definitions
+        module Connection
+          class Presenter
+            def initialize(waml_definition:)
+              @waml_definition = waml_definition
+            end
+
+            def render
+              template_path = File.expand_path('template.erb', __dir__)
+              template_content = File.read(template_path)
+              raw_content = ERB.new(template_content, trim_mode: '-').result(instance_eval { binding })
+
+              ::WebammToRails::Utils::FormatCode.call(raw_content)
+            end
+
+            private
+
+            def devise_models
+              @waml_definition.authentication.select { |auth| auth.features.include?('online_indication') }.map(&:table).map(&:singularize)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webamm_to_rails/features/devise_onlineable/definitions/connection/template.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = find_verified_user
+    end
+
+    private
+
+    def find_verified_user
+      <%= devise_models.map { |name| "env['warden'].user(:#{name.underscore})" }.join(" || ") %> || reject_unauthorized_connection
+    end
+  end
+end

data/lib/webamm_to_rails/features/devise_onlineable/templates/app/channels/online_channel.rb.erb

@@ -0,0 +1,13 @@
+class OnlineChannel < ApplicationCable::Channel
+  def subscribed
+    current_user.appear
+  end
+
+  def unsubscribed
+    current_user.disappear
+  end
+
+  def appear
+    current_user.appear
+  end
+end

data/lib/webamm_to_rails/features/devise_onlineable/templates/app/javascript/channels/consumer.js.erb

@@ -0,0 +1,6 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+
+import { createConsumer } from "@rails/actioncable"
+
+export default createConsumer()

data/lib/webamm_to_rails/features/devise_onlineable/templates/app/javascript/channels/index.js.erb

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

data/lib/webamm_to_rails/features/devise_onlineable/templates/app/javascript/channels/online_channel.js.erb

@@ -0,0 +1,48 @@
+import consumer from "./consumer"
+
+consumer.subscriptions.create("OnlineChannel", {
+  initialized() {
+    this.update = this.update.bind(this)
+  },
+
+  connected() {
+    this.install()
+    this.update()
+  },
+
+  disconnected() {
+    this.uninstall()
+  },
+
+  rejected() {
+    this.uninstall()
+  },
+
+  update() {
+    if(this.documentIsActive) {
+      this.appear()
+    }
+  },
+
+  appear() {
+    this.perform("appear")
+  },
+
+  install() {
+    window.addEventListener("focus", this.update)
+    window.addEventListener("blur", this.update)
+    document.addEventListener("turbo:load", this.update)
+    document.addEventListener("visibilitychange", this.update)
+  },
+
+  uninstall() {
+    window.removeEventListener("focus", this.update)
+    window.removeEventListener("blur", this.update)
+    document.removeEventListener("turbo:load", this.update)
+    document.removeEventListener("visibilitychange", this.update)
+  },
+
+  get documentIsActive() {
+    return document.visibilityState === "visible" && document.hasFocus()
+  },
+})

data/lib/webamm_to_rails/features/devise_onlineable/templates/app/models/concerns/devise_onlineable.rb.erb

@@ -0,0 +1,39 @@
+module DeviseOnlineable
+  extend ActiveSupport::Concern
+
+  def appear
+    redis_client.multi do |multi|
+      multi.set(online_status_key, 1)
+      multi.expire(online_status_key, 3_600)
+      multi.set("#{online_status_key}:last_seen", Time.zone.now.to_i)
+      multi.expire("#{online_status_key}:last_seen", 3_600)
+    end
+  end
+
+  def disappear
+    redis_client.multi do |multi|
+      multi.del(online_status_key)
+      multi.del("#{online_status_key}:last_seen")
+    end
+  end
+
+  def online_status
+    return :offline unless redis_client.exists?(online_status_key)
+
+    last_seen = redis_client.get("#{online_status_key}:last_seen").to_i
+
+    Time.zone.at(last_seen) > 5.minutes.ago ? :online : :away
+  end
+
+  private
+
+  def online_status_key
+    "#{self.class.to_s.underscore}_online_presence:#{id}"
+  end
+
+  def redis_client
+    @redis_client ||= Redis.new(
+      url: ENV.fetch('REDIS_URL') { 'redis://localhost:6379/1' }
+    )
+  end
+end

data/lib/webamm_to_rails/rails_boilerplate/builder.rb

@@ -0,0 +1,318 @@
+module WebammToRails
+  module RailsBoilerplate
+    class Builder
+      def self.call
+        files = [
+          {
+            path: '.github/workflows/ci.yml',
+            content: File.read(File.expand_path('templates/github/workflows/ci.yml.erb', __dir__)) 
+          },
+          {
+            path: '.github/dependabot.yml',
+            content: File.read(File.expand_path('templates/github/dependabot.yml.erb', __dir__))
+          },
+          {
+            path: 'app/assets/builds/.keep',
+            content: ''
+          },
+          {
+            path: 'app/assets/config/manifest.js',
+            content: File.read(File.expand_path('templates/app/assets/config/manifest.js.erb', __dir__))
+          },
+          {
+            path: 'app/assets/images/.keep',
+            content: ''
+          },
+          {
+            path: 'app/assets/stylesheets/application.tailwind.css',
+            content: File.read(File.expand_path('templates/app/assets/stylesheets/application.tailwind.css.erb', __dir__))
+          },
+          {
+            path: 'app/channels/application_cable/channel.rb',
+            content: File.read(File.expand_path('templates/app/channels/application_cable/channel.rb.erb', __dir__))
+          },
+          {
+            path: 'app/channels/application_cable/connection.rb',
+            content: File.read(File.expand_path('templates/app/channels/application_cable/connection.rb.erb', __dir__))
+          },
+          {
+            path: 'app/controllers/concerns/.keep',
+            content: ''
+          },
+          {
+            path: 'app/helpers/application_helper.rb',
+            content: File.read(File.expand_path('templates/app/helpers/application_helper.rb.erb', __dir__))
+          },
+          {
+            path: 'app/javascript/application.js',
+            content: File.read(File.expand_path('templates/app/javascript/application.js.erb', __dir__))
+          },
+          {
+            path: 'app/javascript/controllers/index.js',
+            content: File.read(File.expand_path('templates/app/javascript/controllers/index.js.erb', __dir__))
+          },
+          {
+            path: 'app/javascript/controllers/application.js',
+            content: File.read(File.expand_path('templates/app/javascript/controllers/application.js.erb', __dir__))
+          },
+          {
+            path: 'app/javascript/controllers/hello_controller.js',
+            content: File.read(File.expand_path('templates/app/javascript/controllers/hello_controller.js.erb', __dir__))
+          },
+          {
+            path: 'app/jobs/application_job.rb',
+            content: File.read(File.expand_path('templates/app/jobs/application_job.rb.erb', __dir__))
+          },
+          {
+            path: 'app/mailers/application_mailer.rb',
+            content: File.read(File.expand_path('templates/app/mailers/application_mailer.rb.erb', __dir__))
+          },
+          {
+            path: 'app/models/application_record.rb',
+            content: File.read(File.expand_path('templates/app/models/application_record.rb.erb', __dir__))
+          },
+          {
+            path: 'app/models/concerns/.keep',
+            content: ''
+          },
+          {
+            path: 'app/models/application_record.rb',
+            content: File.read(File.expand_path('templates/app/models/application_record.rb.erb', __dir__))
+          },
+          {
+            path: 'app/views/layouts/application.html.erb',
+            content: File.read(File.expand_path('templates/app/views/layouts/application.html.erb', __dir__))
+          },
+          {
+            path: 'app/views/layouts/mailer.html.erb',
+            content: File.read(File.expand_path('templates/app/views/layouts/mailer.html.erb', __dir__))
+          },
+          {
+            path: 'app/views/layouts/mailer.text.erb',
+            content: File.read(File.expand_path('templates/app/views/layouts/mailer.text.erb', __dir__))
+          },
+          {
+            path: 'app/views/pwa/manifest.json.erb',
+            content: File.read(File.expand_path('templates/app/views/pwa/manifest.json.erb', __dir__))
+          },
+          {
+            path: 'app/views/pwa/service-worker.js',
+            content: File.read(File.expand_path('templates/app/views/pwa/service-worker.js.erb', __dir__))
+          },
+          {
+            path: 'bin/brakeman',
+            content: File.read(File.expand_path('templates/bin/brakeman.erb', __dir__))
+          },
+          {
+            path: 'bin/bundle',
+            content: File.read(File.expand_path('templates/bin/bundle.erb', __dir__))
+          },
+          {
+            path: 'bin/dev',
+            content: File.read(File.expand_path('templates/bin/dev.erb', __dir__))
+          },
+          {
+            path: 'bin/docker-entrypoint',
+            content: File.read(File.expand_path('templates/bin/docker-entrypoint.erb', __dir__))
+          },
+          {
+            path: 'bin/rails',
+            content: File.read(File.expand_path('templates/bin/rails.erb', __dir__))
+          },
+          {
+            path: 'bin/rake',
+            content: File.read(File.expand_path('templates/bin/rake.erb', __dir__))
+          },
+          {
+            path: 'bin/rubocop',
+            content: File.read(File.expand_path('templates/bin/rubocop.erb', __dir__))
+          },
+          {
+            path: 'bin/setup',
+            content: File.read(File.expand_path('templates/bin/setup.erb', __dir__))
+          },
+          {
+            path: 'config/environments/development.rb',
+            content: File.read(File.expand_path('templates/config/environments/development.rb.erb', __dir__))
+          },
+          {
+            path: 'config/environments/production.rb',
+            content: File.read(File.expand_path('templates/config/environments/production.rb.erb', __dir__))
+          },
+          {
+            path: 'config/environments/test.rb',
+            content: File.read(File.expand_path('templates/config/environments/test.rb.erb', __dir__))
+          },
+          {
+            path: 'config/initializers/assets.rb',
+            content: File.read(File.expand_path('templates/config/initializers/assets.rb.erb', __dir__))
+          },
+          {
+            path: 'config/initializers/content_security_policy.rb',
+            content: File.read(File.expand_path('templates/config/initializers/content_security_policy.rb.erb', __dir__))
+          },
+          {
+            path: 'config/initializers/filter_parameter_logging.rb',
+            content: File.read(File.expand_path('templates/config/initializers/filter_parameter_logging.rb.erb', __dir__))
+          },
+          {
+            path: 'config/initializers/inflections.rb',
+            content: File.read(File.expand_path('templates/config/initializers/inflections.rb.erb', __dir__))
+          },
+          {
+            path: 'config/initializers/permissions_policy.rb',
+            content: File.read(File.expand_path('templates/config/initializers/permissions_policy.rb.erb', __dir__))
+          },
+          {
+            path: 'config/locales/en.yml',
+            content: File.read(File.expand_path('templates/config/locales/en.yml.erb', __dir__))
+          },
+          {
+            path: 'config/application.rb',
+            content: File.read(File.expand_path('templates/config/application.rb.erb', __dir__))
+          },
+          {
+            path: 'config/boot.rb',
+            content: File.read(File.expand_path('templates/config/boot.rb.erb', __dir__))
+          },
+          {
+            path: 'config/cable.yml',
+            content: File.read(File.expand_path('templates/config/cable.yml.erb', __dir__))
+          },
+          {
+            path: 'config/credentials.yml.enc',
+            content: File.read(File.expand_path('templates/config/credentials.yml.enc.erb', __dir__))
+          },
+          {
+            path: 'config/database.yml',
+            content: File.read(File.expand_path('templates/config/database.yml.erb', __dir__))
+          },
+          {
+            path: 'config/environment.rb',
+            content: File.read(File.expand_path('templates/config/environment.rb.erb', __dir__))
+          },
+          {
+            path: 'config/master.key',
+            content: File.read(File.expand_path('templates/config/master.key.erb', __dir__))
+          },
+          {
+            path: 'config/puma.rb',
+            content: File.read(File.expand_path('templates/config/puma.rb.erb', __dir__))
+          },
+          {
+            path: 'config/storage.yml',
+            content: File.read(File.expand_path('templates/config/storage.yml.erb', __dir__))
+          },
+          {
+            path: 'db/seeds.rb',
+            content: File.read(File.expand_path('templates/db/seeds.rb.erb', __dir__))
+          },
+          {
+            path: 'lib/assets/.keep',
+            content: ''
+          },
+          {
+            path: 'lib/tasks/.keep',
+            content: ''
+          },
+          {
+            path: 'log/.keep',
+            content: ''
+          },
+          {
+            path: 'log/development.log',
+            content: ''
+          },
+          {
+            path: 'public/404.html',
+            content: File.read(File.expand_path('templates/public/404.html.erb', __dir__))
+          },
+          {
+            path: 'public/406-unsupported-browser.html',
+            content: File.read(File.expand_path('templates/public/406-unsupported-browser.html.erb', __dir__))
+          },
+          {
+            path: 'public/422.html',
+            content: File.read(File.expand_path('templates/public/422.html.erb', __dir__))
+          },
+          {
+            path: 'public/500.html',
+            content: File.read(File.expand_path('templates/public/500.html.erb', __dir__))
+          },
+          # {
+          #   path: 'public/icon.png',
+          #   content: File.read(File.expand_path('templates/public/icon.png.erb', __dir__))
+          # },
+          # {
+          #   path: 'public/icon.svg',
+          #   content: File.read(File.expand_path('templates/public/icon.svg.erb', __dir__))
+          # },
+          {
+            path: 'public/robots.txt',
+            content: File.read(File.expand_path('templates/public/robots.txt.erb', __dir__))
+          },
+          {
+            path: 'storage/.keep',
+            content: ''
+          },
+          {
+            path: 'tmp/.keep',
+            content: ''
+          },
+          {
+            path: 'vendor/.keep',
+            content: ''
+          },
+          {
+            path: '.dockerignore',
+            content: File.read(File.expand_path('templates/dockerignore.erb', __dir__))
+          },
+          {
+            path: '.gitattributes',
+            content: File.read(File.expand_path('templates/gitattributes.erb', __dir__))
+          },
+          {
+            path: '.gitignore',
+            content: File.read(File.expand_path('templates/gitignore.erb', __dir__))
+          },
+          {
+            path: '.node-version',
+            content: File.read(File.expand_path('templates/node-version.erb', __dir__))
+          },
+          {
+            path: '.rubocop.yml',
+            content: File.read(File.expand_path('templates/rubocop.yml.erb', __dir__))
+          },
+          {
+            path: '.ruby-version',
+            content: File.read(File.expand_path('templates/ruby-version.erb', __dir__))
+          },
+          {
+            path: 'config.ru',
+            content: File.read(File.expand_path('templates/config.ru.erb', __dir__))
+          },
+          {
+            path: 'Dockerfile',
+            content: File.read(File.expand_path('templates/Dockerfile.erb', __dir__))
+          },
+          {
+            path: 'Procfile.dev',
+            content: File.read(File.expand_path('templates/Procfile.dev.erb', __dir__))
+          },
+          {
+            path: 'Rakefile',
+            content: File.read(File.expand_path('templates/Rakefile.erb', __dir__))
+          },
+          {
+            path: 'README.md',
+            content: File.read(File.expand_path('templates/README.md.erb', __dir__))
+          },
+          {
+            path: 'tailwind.config.js',
+            content: File.read(File.expand_path('templates/tailwind.config.js.erb', __dir__))
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/webamm_to_rails/rails_boilerplate/templates/Dockerfile.erb

@@ -0,0 +1,83 @@
+# syntax = docker/dockerfile:1
+
+# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
+# docker build -t my-app .
+# docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY=<value from config/master.key> my-app
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.2.2
+FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install base packages
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+# Throw-away build stage to reduce size of final image
+FROM base AS build
+
+# Install packages needed to build gems and node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libpq-dev node-gyp pkg-config python-is-python3 && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install JavaScript dependencies
+ARG NODE_VERSION=18.0.0
+ARG YARN_VERSION=1.22.19
+ENV PATH=/usr/local/node/bin:$PATH
+RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
+    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
+    npm install -g yarn@$YARN_VERSION && \
+    rm -rf /tmp/node-build-master
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Install node modules
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+RUN rm -rf node_modules
+
+
+# Final stage for app image
+FROM base
+
+# Copy built artifacts: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN groupadd --system --gid 1000 rails && \
+    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER 1000:1000
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

data/lib/webamm_to_rails/rails_boilerplate/templates/Procfile.dev.erb

@@ -0,0 +1,3 @@
+web: env RUBY_DEBUG_OPEN=true bin/rails server
+js: yarn build --watch
+css: yarn build:css --watch

data/lib/webamm_to_rails/rails_boilerplate/templates/README.md.erb

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...