maquina 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5dffb067d8cdaf6d56c9777275907b321ec48188950945521a44d4d48fd92a2
+  data.tar.gz: 28a3e313221bd3f2e465ba565e5e493ba3ccc419512c7f5f59d80353a0d45168
+SHA512:
+  metadata.gz: 2b4517a5605cd8245948afec893c75b60fdc522d56982d76928726fdcf797e2552a026321f2e24d2ab8a7387e8de01158a10065300d4914f5d07cf4b1df0c3d7
+  data.tar.gz: cb442f6712c58691771d8b01f99d22038c9491b92c5cf324860d5e250b692d749c67254184194de8d2b0132fb9339d32f17ebe6976c9eacd30a903a87bf098a7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Mario Alberto Chávez
+
+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,28 @@
+# Maquina
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "maquina"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install maquina
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+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"

data/app/assets/images/maquina/maquina.svg

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.1" viewBox="0 0 486 486" xmlns="http://www.w3.org/2000/svg">
+<title>Maquina</title>
+<defs>
+<linearGradient id="a" x1="21.152%" y1="21.848%" y2="93.468%">
+<stop stop-color="#50B1FD" stop-opacity=".96" offset="0"/>
+<stop stop-color="#DE77DE" stop-opacity=".96" offset="1"/>
+</linearGradient>
+</defs>
+<g fill="none" fill-rule="evenodd">
+<g transform="translate(-13 -13)">
+<g transform="translate(13 13)">
+<circle cx="243" cy="243" r="243" fill="url(#a)"/>
+<path d="m238.9 47.002 3.4301 0.016598v30.431c-108.78 8.7223-163.18 71.895-163.18 189.52l54.567-31.709c3.7144-56.281 50.542-100.78 107.76-100.78 10.162 0 19.996 1.4034 29.319 4.0271 0.78425-57.904 1.3072-88.259 1.5685-91.068 161.58 36.443 197.13 192.94 138.54 291.1-4.3817-2.5298-13.063-7.5417-26.354-15.216 46.838-98.57 19.325-177.26-82.539-236.07l0.18734 65.903c28.537 19.437 47.276 52.193 47.276 89.325 0 30.25-12.436 57.595-32.475 77.201 49.541 28.346 75.468 43.309 77.781 44.887-110.21 123.65-264.32 78.878-321.77-19.957 4.3369-2.6059 12.929-7.7686 26.085-15.673 63.504 88.753 145.67 102.84 246.49 42.26l-57.118-31.449c-14.207 6.876-30.149 10.731-46.991 10.731-50.271 0-92.52-34.347-104.56-80.855-49.09 27.458-74.899 41.768-77.424 42.929-48.243-154.99 63.879-262.81 175.97-265.5l3.4312-0.04945zm3.0839 149.47c-25.681 0-46.5 20.819-46.5 46.5s20.819 46.5 46.5 46.5c25.681 0 46.5-20.819 46.5-46.5s-20.819-46.5-46.5-46.5z" fill="#fff"/>
+</g>
+</g>
+</g>
+</svg>

data/app/assets/javascripts/maquina/application.js

@@ -0,0 +1,4 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
+import "@hotwired/turbo-rails"
+
+import "controllers"

data/app/assets/javascripts/maquina/controllers/alert_controller.js

@@ -0,0 +1,29 @@
+import { Controller } from "@hotwired/stimulus"
+import { useTransition } from "stimulus-use"
+
+/**
+ * Alert Controller
+ *
+ * Cuando hay información en el objeto Flash de Rails se muestra con una animación
+ * el mensaje y desaparece solo después de 10 segundos o cerrándolo con la X.
+ */
+
+export default class extends Controller {
+  static targets = ["alert"];
+
+  connect() {
+    let element = this.element;
+    if (this.hasAlertTarget) {
+      element = this.alertTarget
+    }
+    useTransition(this, { element: element })
+
+    this.enter()
+
+    setTimeout(this.close.bind(this), 10000)
+  }
+
+  close() {
+    this.leave()
+  }
+}

data/app/assets/javascripts/maquina/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }

data/app/assets/javascripts/maquina/controllers/file_controller.js

@@ -0,0 +1,60 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["fileInput", "container", "preview", "placeholder"]
+  static values = { maxSize: Number, image: String, validationMessage: String }
+
+  connect() {
+    if (this.hasFileInputTarget) {
+      this.fileInputTarget.addEventListener("change", this.fileSelected.bind(this))
+    }
+  }
+
+  disconnect() {
+    if (this.hasFileInputTarget) {
+      this.fileInputTarget.removeEventListener("change", this.fileSelected.bind(this))
+    }
+  }
+
+  select(event) {
+    event.preventDefault();
+    this.fileInputTarget.click();
+  }
+
+  fileSelected(event) {
+    if (event.target.files.length > 0) {
+      this.containerTarget.querySelectorAll(".help-error").forEach(error => error.remove())
+      this.validateFile(event.target.files[0])
+    }
+  }
+
+  validateFile(file) {
+    if (file.size > this.maxSizeValue) {
+      this.fileInputTarget.value = ""
+      this.addError()
+      this.clearPreview()
+    } else {
+      this.loadPreview(file)
+    }
+  }
+
+  addError() {
+    const messageNode = document.createElement("p");
+    messageNode.classList.add("help", "help-error");
+    messageNode.innerText = this.validationMessageValue;
+
+    this.containerTarget.appendChild(messageNode)
+  }
+
+  clearPreview() {
+    this.previewTarget.classList.add("hidden")
+    this.placeholderTarget.classList.remove("hidden")
+    this.previewTarget.setAttribute("src", "")
+  }
+
+  loadPreview(file) {
+    this.previewTarget.setAttribute("src", URL.createObjectURL(file))
+    this.previewTarget.classList.remove("hidden")
+    this.placeholderTarget.classList.add("hidden")
+  }
+}

data/app/assets/javascripts/maquina/controllers/index.js

@@ -0,0 +1,11 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/app/assets/javascripts/maquina/controllers/mobile_menu_controller.js

@@ -0,0 +1,31 @@
+import { Controller } from "@hotwired/stimulus"
+import { useClickOutside, useTransition } from "stimulus-use"
+
+export default class extends Controller {
+  static targets = ["menu", "open", "close"]
+
+  connect() {
+    useClickOutside(this);
+    useTransition(this, { element: this.menuTarget })
+  }
+
+  toggle() {
+    this.toggleTransition();
+  }
+
+  clickOutside() {
+    if (!this.menuTarget.classList.contains("hidden")) {
+      this.toggleTransition();
+    }
+  }
+
+  enter() {
+    this.openTarget.classList.toggle("hidden")
+    this.closeTarget.classList.toggle("hidden")
+  }
+
+  leave() {
+    this.openTarget.classList.toggle("hidden")
+    this.closeTarget.classList.toggle("hidden")
+  }
+}

data/app/assets/javascripts/maquina/controllers/modal_controller.js

@@ -0,0 +1,39 @@
+import { Controller } from "@hotwired/stimulus"
+import { useTransition } from "stimulus-use"
+
+export default class extends Controller {
+  static targets = ["content", "container", "frame"]
+
+  connect() {
+    useTransition(this, { element: this.contentTarget })
+
+    this.resultCallback = this.modalResult.bind(this)
+    addEventListener("turbo:submit-end", this.resultCallback)
+  }
+
+  disconnect() {
+    removeEventListener("turbo:submit-end", this.resultCallback)
+  }
+
+  modalResult(event) {
+    if (event.detail.fetchResponse.response.status == 202) {
+      this.toggleModal(event)
+    }
+  }
+
+  toggleModal(event) {
+    event.preventDefault()
+
+    if (this.hasFrameTarget && this.contentTarget.classList.contains("hidden")) {
+      let url = event["detail"]["src"] || this.element.dataset["frameSrc"]
+      this.frameTarget.setAttribute("src", url)
+    } else if (!this.contentTarget.classList.contains("hidden")) {
+      this.frameTarget.setAttribute("src", "")
+      this.frameTarget.innerText = ""
+    }
+
+    document.documentElement.classList.toggle("overflow-hidden")
+    this.containerTarget.classList.toggle("hidden")
+    this.toggleTransition()
+  }
+}

data/app/assets/javascripts/maquina/controllers/modal_open_controller.js

@@ -0,0 +1,15 @@
+import { Controller } from "@hotwired/stimulus";
+import { useDispatch } from "stimulus-use";
+
+export default class extends Controller {
+  static targets = [];
+
+  connect() {
+    useDispatch(this)
+  }
+
+  open(event) {
+    event.preventDefault();
+    this.dispatch("toggle", {src: event.target.getAttribute("href")});
+  }
+}

data/app/assets/javascripts/maquina/controllers/popup_menu_controller.js

@@ -0,0 +1,17 @@
+import { Controller } from "@hotwired/stimulus";
+import { useClickOutside, useTransition } from "stimulus-use"
+
+export default class extends Controller {
+  static targets = ["menu"];
+
+  connect() {
+    useClickOutside(this);
+    useTransition(this, { element: this.menuTarget })
+  }
+
+  clickOutside() {
+    if (!this.menuTarget.classList.contains("hidden")) {
+      this.toggleTransition();
+    }
+  }
+}

data/app/assets/javascripts/maquina/controllers/submit_form_controller.js

@@ -0,0 +1,11 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = []
+
+  clear(event) {
+    if (!event.target.value) {
+      this.element.submit()
+    }
+  }
+}

data/app/assets/stylesheets/maquina/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/maquina/application.tailwind.css

@@ -0,0 +1,102 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+/* @layer base { */
+  :root {
+    --color-base: 31 27 54;
+    --color-accented:  37 99 235;
+    --color-inverted: 255 255 255;
+    --color-accented-hover: 59 130 246;
+    --color-muted: 55 65 81;
+    --color-dimmed: 75 85 99;
+    --color-error: 220 38 38;
+
+    --color-border-base: 209 213 219;
+    --color-border-accented:  37 99 235;
+  }
+
+  .label {
+    @apply text-sm font-medium text-skin-muted;
+  }
+
+  .input {
+    @apply appearance-none rounded-md border border-skin-base px-3 py-2 placeholder-gray-400 shadow-sm focus:border-skin-accented focus:outline-none focus:ring-skin-accented sm:text-sm;
+  }
+
+  .link {
+    @apply font-medium text-skin-accented hover:text-skin-accented-hover;
+  }
+
+  .check {
+    @apply border-skin-base h-4 w-4 text-skin-accented focus:ring-skin-accented rounded;
+  }
+
+  .button {
+    @apply inline-flex justify-center py-2 px-4 border border-skin-base rounded-md shadow-sm text-sm font-medium text-skin-muted bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-skin-accented;
+  }
+
+  .control-error .label {
+    @apply text-skin-error;
+  }
+
+  .control-error .input {
+    @apply border-skin-error focus:border-skin-error focus:ring-skin-error;
+  }
+
+  .help {
+    @apply mt-2 text-sm text-skin-dimmed;
+  }
+
+  .help-error {
+    @apply text-skin-error;
+  }
+
+  .button[disabled] {
+    @apply bg-gray-50 text-skin-dimmed cursor-default;
+  }
+
+  .button-accented {
+    @apply rounded-md border border-transparent bg-skin-accented py-2 px-4 text-sm font-medium text-skin-inverted shadow-sm hover:bg-skin-accented-hover focus:outline-none focus:ring-2 focus:ring-skin-accented focus:ring-offset-2;
+  }
+
+  input[type="search"] {
+    @apply block w-full rounded-md border border-skin-base pl-10 leading-5 placeholder-gray-400 focus:placeholder-gray-300 focus:outline-none focus:ring-1 focus:ring-skin-accented focus:border-skin-accented sm:text-sm;
+  }
+
+  .desktop-menu {
+    @apply hidden lg:ml-6 lg:flex lg:space-x-8;
+  }
+
+  .desktop-menu-item {
+    @apply font-sans uppercase border-transparent text-skin-dimmed underline-offset-4 decoration-2 hover:underline hover:decoration-skin-accented hover:text-skin-muted inline-flex items-center px-1 pt-1 text-sm font-medium;
+  }
+
+  .desktop-menu-item__active {
+    @apply decoration-skin-accented underline text-skin-base;
+  }
+
+  .mobile-menu {
+    @apply pt-2 pb-3 space-y-1;
+  }
+
+  .mobile-menu-item {
+    @apply font-sans border-transparent text-skin-dimmed hover:bg-gray-200 hover:border-gray-300 hover:text-skin-muted block pl-3 pr-4 py-2 border-l-4 text-base font-medium;
+  }
+
+  .mobile-menu-item__active {
+    @apply bg-skin-accented-hover border-skin-accented text-skin-accented hover:text-skin-accented hover:bg-skin-accented-hover hover:border-skin-accented;
+  }
+
+  .desktop-profile-menu-item {
+    @apply block w-full text-left font-sans px-4 py-2 text-sm text-skin-dimmed hover:bg-gray-200 hover:text-skin-muted;
+  }
+
+  .mobile-profile-menu-item {
+    @apply block font-sans px-4 py-2 text-base font-medium text-skin-dimmed hover:text-skin-muted hover:bg-gray-200;
+  }
+
+  .mobile-button {
+    @apply inline-flex items-center justify-center p-2 rounded-md text-skin-dimmed hover:text-skin-muted hover:bg-gray-100 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-skin-accented;
+  }
+/* } */

data/app/controllers/concerns/maquina/authenticate.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Authenticate
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :signed_in?, :current_user
+    end
+
+    def authenticate!
+      load_session
+
+      redirect_to maquina.new_sessions_path if !signed_in?
+    end
+
+    def signed_in?
+      load_session if Maquina::Current.active_session.blank?
+
+      Maquina::Current.signed_in?
+    end
+
+    def current_user
+      load_session if Maquina::Current.active_session.blank?
+
+      Maquina::Current.user
+    end
+
+    private
+
+    def load_session
+      active_session_id = session["--active_session"]
+      return if active_session_id.blank?
+
+      active_session = ActiveSession.eager_load(:user).find_by(id: active_session_id)
+      return if active_session.blank?
+
+      Maquina::Current.active_session = active_session
+    end
+  end
+end

data/app/controllers/concerns/maquina/create.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Create
+    extend ActiveSupport::Concern
+
+    included do
+      def create(&block)
+        authorize! with: policy_class if policy_class.present?
+
+        @resource ||= begin
+          resource = resource_class.new(resource_secure_params)
+          resource.save
+
+          resource
+        end
+
+        @status = @resource.errors.empty? ? :created : :unprocessable_entity
+        response.status = @status
+        set_flash_message(@status)
+
+        dual_action_response(@resource, &block)
+      end
+      alias_method :create!, :create
+    end
+  end
+end

data/app/controllers/concerns/maquina/destroy.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Destroy
+    extend ActiveSupport::Concern
+
+    included do
+      def destroy(&block)
+        @resource ||= begin
+          scope = resource_class
+          # TODO: Implement policy authorization (ActionPolicy)
+          # scope = scope.where(organization)
+          # TODO: Implement filtering by organization
+          scope.find_by!(find_by_param => params[:id])
+        end
+
+        @resource.destroy
+
+        status = :no_content
+        response.status = status
+        set_flash_message(status)
+
+        dual_action_response(@resource, &block)
+      end
+      alias_method :destroy!, :destroy
+    end
+  end
+end

data/app/controllers/concerns/maquina/edit.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Edit
+    extend ActiveSupport::Concern
+
+    included do
+      def edit(&block)
+        @resource ||= begin
+          scope = resource_class
+          # TODO: Implement filtering by organization
+          # scope = scope.where(organization)
+          scope = yield(scope) if block.present?
+
+          resource = scope.find_by!(find_by_param => params[:id])
+
+          authorize! resource, with: policy_class if policy_class.present?
+
+          resource
+        end
+
+        respond_to do |format|
+          format.html
+        end
+      end
+      alias_method :edit!, :edit
+    end
+  end
+end

data/app/controllers/concerns/maquina/index.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Index
+    extend ActiveSupport::Concern
+    include Pagy::Backend
+
+    included do
+      def index(&block)
+        authorize! with: policy_class if policy_class.present?
+
+        @collection ||= begin
+          scope = resource_class.order(updated_at: :desc)
+          scope = authorized_scope(scope) if policy_class.present?
+
+          search_value = params[:q]&.strip
+          scope = scope.search_full(search_value) if search_value.present?
+
+          scope = yield(scope) if block.present?
+
+          @pagination, record = pagy(scope)
+          record
+        end
+
+        respond_to do |format|
+          format.html { render :index }
+          format.json { render json: collection }
+        end
+      end
+      alias_method :index!, :index
+    end
+  end
+end

data/app/controllers/concerns/maquina/new.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Maquina
+  module New
+    extend ActiveSupport::Concern
+
+    included do
+      def new(&block)
+        authorize! with: policy_class if policy_class.present?
+
+        # TODO: Implement filtering by organization
+        @resource = resource_class.new
+        @resource = yield(@resource) if block.present?
+
+        respond_to do |format|
+          format.html
+        end
+      end
+      alias_method :new!, :new
+    end
+  end
+end