RubyGems - hotsheet - Versions diffs - 0.1.1 → 0.2.1 - Mend

hotsheet 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

checksums.yaml +4 -4
data/LICENSE +1 -1
data/README.md +45 -38
data/app/assets/hotsheet.css +1 -0
data/app/assets/hotsheet.js +33 -0
data/app/controllers/hotsheet/application_controller.rb +7 -3
data/app/controllers/hotsheet/home_controller.rb +9 -0
data/app/controllers/hotsheet/sheets_controller.rb +45 -0
data/app/views/hotsheet/home/error.html.erb +1 -0
data/app/views/hotsheet/home/show.html.erb +1 -0
data/app/views/hotsheet/shared/_nav.html.erb +14 -0
data/app/views/hotsheet/sheets/index.html.erb +20 -0
data/app/views/layouts/hotsheet/application.html.erb +7 -7
data/config/locales/en.yml +3 -3
data/config/routes.rb +5 -5
data/lib/generators/templates/hotsheet.rb +14 -4
data/lib/hotsheet/column.rb +31 -0
data/lib/hotsheet/config.rb +29 -0
data/lib/hotsheet/engine.rb +5 -4
data/lib/hotsheet/sheet.rb +44 -0
data/lib/hotsheet/version.rb +1 -1
data/lib/hotsheet.rb +38 -12
metadata +18 -90
data/CHANGELOG.md +0 -22
data/app/assets/config/hotsheet.js +0 -2
data/app/assets/javascripts/hotsheet/application.js +0 -1
data/app/assets/javascripts/hotsheet/channels/consumer.js +0 -3
data/app/assets/javascripts/hotsheet/channels/inline_edit_channel.js +0 -3
data/app/assets/javascripts/hotsheet/controllers/application.js +0 -8
data/app/assets/javascripts/hotsheet/controllers/editable_attribute_controller.js +0 -39
data/app/assets/javascripts/hotsheet/controllers/flash_controller.js +0 -8
data/app/assets/stylesheets/hotsheet/application.css +0 -153
data/app/channels/application_cable/channel.rb +0 -6
data/app/channels/application_cable/connection.rb +0 -6
data/app/channels/inline_edit_channel.rb +0 -9
data/app/controllers/hotsheet/pages_controller.rb +0 -43
data/app/helpers/hotsheet/application_helper.rb +0 -7
data/app/views/hotsheet/pages/_editable_attribute.html.erb +0 -15
data/app/views/hotsheet/pages/index.html.erb +0 -27
data/app/views/layouts/hotsheet/_flash.html.erb +0 -10
data/app/views/layouts/hotsheet/_sidebar.html.erb +0 -11
data/config/initializers/hotsheet/content_security_policy.rb +0 -14
data/config/initializers/hotsheet/pagy.rb +0 -7
data/lib/hotsheet/configuration.rb +0 -59
data/lib/hotsheet/editable_attributes.rb +0 -24
data/vendor/assets/stylesheets/hotsheet/pagy.css +0 -37

data/app/views/hotsheet/shared/_nav.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<nav class="nav" data-controller="nav">
+  <ul>
+    <li><%= link_to Hotsheet.t("title"), root_path, class: "title" %></li>
+  </ul>
+  <ul class="sheets">
+    <% Hotsheet.sheets.each_with_index do |entry, index| %>
+      <li>
+        <% sheet_name, sheet = entry %>
+        <%= link_to sheet.model.model_name.human(count: 2), sheets_path(sheet_name),
+                    class: ("active" if params[:sheet_name] == sheet_name), data: { x: index } %>
+      </li>
+    <% end %>
+  </ul>
+</nav>

data/app/views/hotsheet/sheets/index.html.erb ADDED Viewed

@@ -0,0 +1,20 @@
+<div class="table" spellcheck="false" data-controller="sheets">
+  <% @columns.each_with_index do |entry, x_index| %>
+    <% column_name, column = entry %>
+    <% editable = column.editable? %>
+    <div class="column">
+      <span class="cell header" data-name="<%= column_name %>">
+        <%= @sheet.model.human_attribute_name column_name %>
+      </span>
+      <% @cells[x_index]&.each_with_index do |value, y_index| %>
+        <% if editable %>
+          <span class="cell" tabindex="0" data-xy="<%= "#{x_index},#{y_index}" %>"><%= value %></span>
+        <% else %>
+          <span class="cell readonly"><%= value %></span>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/layouts/hotsheet/application.html.erb CHANGED Viewed

@@ -1,21 +1,21 @@
 <!DOCTYPE html>
 <html lang="<%= I18n.locale %>">
   <head>
-    <title>Hotsheet</title>
+    <title><%= Hotsheet.t "title" %></title>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="robots" content="noindex,nofollow">
     <meta name="turbo-prefetch" content="false">
+    <meta name="turbo-refresh-method" content="morph">
+    <meta name="turbo-refresh-scroll" content="preserve">
     <%= csrf_meta_tags %>
-    <%= csp_meta_tag %>
-    <%= stylesheet_link_tag "hotsheet/application" %>
-    <%= javascript_include_tag "hotsheet/application", "data-turbolinks-track": :reload,
-          type: :module, nonce: content_security_policy_nonce, defer: true %>
+    <%= stylesheet_link_tag "hotsheet", nonce: true %>
+    <%= javascript_include_tag "hotsheet", nonce: true, defer: true %>
   </head>
   <body>
-    <%= render "layouts/hotsheet/sidebar" %>
+    <%= render "hotsheet/shared/nav" %>
     <main>
-      <%= render "layouts/hotsheet/flash" %>
+      <div class="flash"></div>
       <%= yield %>
     </main>
   </body>

data/config/locales/en.yml CHANGED Viewed

@@ -1,5 +1,5 @@
 en:
-  home: Home
   hotsheet:
-    success: '%{record} updated successfully'
-    error: '%{record} update failed: %{errors}'
+    error_forbidden: Forbidden
+    error_not_found: Not found
+    title: Hotsheet

data/config/routes.rb CHANGED Viewed

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 Hotsheet::Engine.routes.draw do
-  root to: "pages#index"
+  root "home#show"
-  post :broadcast_edit_intent, to: "pages#broadcast_edit_intent"
-  Hotsheet.models.each do |model|
-    resources model.table_name, controller: :pages, only: %i[index update], model: model.name
+  scope ":sheet_name" do
+    resources controller: :sheets, only: %i[index update], as: :sheets
   end
+  match "*path", to: "home#error", via: :all
 end

data/lib/generators/templates/hotsheet.rb CHANGED Viewed

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
-Hotsheet.configure do |config|
-  # Configure the models to be used by Hotsheet (see https://github.com/renuo/hotsheet?tab=readme-ov-file#usage)
+# Configure the models to be used by Hotsheet.
+# See https://github.com/renuo/hotsheet/blob/main/README.md#usage.
-  # config.model :User do |model|
-  #   model.excluded_attributes = %i[created_at updated_at]
+Hotsheet.configure do
+  # Configure the visible and editable columns for each model.
+  # The ID is included as the first column by default.
+  # sheet :User do
+  #   column :name
+  #   column :email, editable: false
+  #   column :birthdate, editable: -> { rand > 0.5 }
   # end
+  # Leave the block out to include all database columns.
+  # sheet :Post
 end

data/lib/hotsheet/column.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+class Hotsheet::Column
+  include Hotsheet::Config
+  attr_reader :config
+  CONFIG = {
+    editable: { allowed_classes: [FalseClass, Proc], default: true },
+    visible: { allowed_classes: [FalseClass, Proc], default: true }
+  }.freeze
+  def initialize(config)
+    @config = merge_config! CONFIG, config
+  end
+  def editable?
+    is? :editable
+  end
+  def visible?
+    is? :visible
+  end
+  private
+  def is?(permission)
+    perm = @config[permission]
+    perm.is_a?(Proc) ? perm.call : perm
+  end
+end

data/lib/hotsheet/config.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Hotsheet::Config
+  def merge_config!(default, custom)
+    config = default.transform_values { |value| value[:default] }
+    custom.each do |key, value|
+      unless default.key? key
+        raise Hotsheet::Error, "Config must be one of #{default.keys}, got '#{key}'"
+      end
+      ensure_allowed_value! key, value, default[key]
+      config[key] = value
+    end
+    config
+  end
+  private
+  def ensure_allowed_value!(key, value, config)
+    allowed = config[:allowed_classes]
+    value = value.class
+    return if allowed.include? value
+    raise Hotsheet::Error, "Config '#{key}' must be one of #{allowed}, got '#{value}'"
+  end
+end

data/lib/hotsheet/engine.rb CHANGED Viewed

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-module Hotsheet
-  class Engine < ::Rails::Engine
-    isolate_namespace Hotsheet
+class Hotsheet::Engine < Rails::Engine
+  isolate_namespace Hotsheet
-    config.assets.precompile += %w[hotsheet/application.css hotsheet/application.js]
+  if config.respond_to? :assets
+    config.assets.paths << Hotsheet::Engine.root.join("app/assets")
+    config.assets.precompile << %w[hotsheet.css hotsheet.js]
   end
 end

data/lib/hotsheet/sheet.rb ADDED Viewed

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+class Hotsheet::Sheet
+  include Hotsheet::Config
+  CONFIG = {}.freeze
+  attr_reader :config, :model
+  def initialize(name, config, &columns)
+    @config = merge_config! CONFIG, config
+    @model = name.to_s.constantize
+    @columns = {}
+    column :id, editable: false
+    columns ? instance_eval(&columns) : use_default_configuration
+  end
+  def columns
+    @columns.select { |_name, column| column.visible? }
+  end
+  def cells_for(columns)
+    @model.pluck(*columns.keys).transpose
+  end
+  private
+  def use_default_configuration
+    @model.column_names[1..].each { |name| column name }
+  end
+  def column(name, config = {})
+    ensure_column_exists! name
+    @columns[name.to_s] = Hotsheet::Column.new config
+  end
+  def ensure_column_exists!(name)
+    return if @model.column_names.include? name.to_s
+    raise Hotsheet::Error, "Column must be one of #{@model.column_names}, got '#{name}'"
+  end
+end

data/lib/hotsheet/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Hotsheet
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/hotsheet.rb CHANGED Viewed

@@ -1,27 +1,53 @@
 # frozen_string_literal: true
-require "sprockets/railtie"
-require "turbo-rails"
-require "hotsheet/engine"
 require "hotsheet/version"
-require "hotsheet/configuration"
-require "hotsheet/editable_attributes"
+require "hotsheet/engine"
+require "hotsheet/config"
+require "hotsheet/sheet"
+require "hotsheet/column"
 module Hotsheet
   class Error < StandardError; end
   class << self
-    def configuration
-      @configuration ||= Configuration.new
+    include Config
+    attr_reader :config
+    CONFIG = {}.freeze
+    def configure(config = {}, &sheets)
+      @config = [merge_config!(CONFIG, config), sheets]
+      self
+    end
+    def sheets
+      @sheets ||= begin
+        @sheets = {}
+        instance_eval(&@config.pop)
+        @sheets
+      end
     end
-    def configure(&block)
-      @configuration = Configuration.new.tap(&block)
+    I18N = Psych.load_file(Hotsheet::Engine.root.join("config/locales/en.yml"))["en"]["hotsheet"].freeze
+    def t(key)
+      I18n.t "hotsheet.#{key}", default: I18N[key]
     end
-    def models
-      @models ||= configuration.models.each_key.map(&:constantize)
+    private
+    def sheet(name, config = {}, &)
+      ensure_sheet_exists! name
+      sheet = Sheet.new(name, config, &)
+      @sheets[sheet.model.table_name] = sheet
+    end
+    def ensure_sheet_exists!(name)
+      return if Object.const_defined? name
+      raise Hotsheet::Error, "Unknown model '#{name}'"
     end
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hotsheet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Renuo AG
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,64 +23,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: stimulus-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: turbo-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: This gem allows you to mount a view to manage your database using a table
-  view where you can edit DB records inline.
+description: Manage your Rails database through a spreadsheet-like interface.
 email:
 - ignacio.sfeir@renuo.ch
 - simon.isler@renuo.ch
@@ -91,50 +33,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
-- app/assets/config/hotsheet.js
-- app/assets/javascripts/hotsheet/application.js
-- app/assets/javascripts/hotsheet/channels/consumer.js
-- app/assets/javascripts/hotsheet/channels/inline_edit_channel.js
-- app/assets/javascripts/hotsheet/controllers/application.js
-- app/assets/javascripts/hotsheet/controllers/editable_attribute_controller.js
-- app/assets/javascripts/hotsheet/controllers/flash_controller.js
-- app/assets/stylesheets/hotsheet/application.css
-- app/channels/application_cable/channel.rb
-- app/channels/application_cable/connection.rb
-- app/channels/inline_edit_channel.rb
+- app/assets/hotsheet.css
+- app/assets/hotsheet.js
 - app/controllers/hotsheet/application_controller.rb
-- app/controllers/hotsheet/pages_controller.rb
-- app/helpers/hotsheet/application_helper.rb
-- app/views/hotsheet/pages/_editable_attribute.html.erb
-- app/views/hotsheet/pages/index.html.erb
-- app/views/layouts/hotsheet/_flash.html.erb
-- app/views/layouts/hotsheet/_sidebar.html.erb
+- app/controllers/hotsheet/home_controller.rb
+- app/controllers/hotsheet/sheets_controller.rb
+- app/views/hotsheet/home/error.html.erb
+- app/views/hotsheet/home/show.html.erb
+- app/views/hotsheet/shared/_nav.html.erb
+- app/views/hotsheet/sheets/index.html.erb
 - app/views/layouts/hotsheet/application.html.erb
-- config/initializers/hotsheet/content_security_policy.rb
-- config/initializers/hotsheet/pagy.rb
 - config/locales/en.yml
 - config/routes.rb
 - lib/generators/hotsheet/install_generator.rb
 - lib/generators/templates/hotsheet.rb
 - lib/hotsheet.rb
-- lib/hotsheet/configuration.rb
-- lib/hotsheet/editable_attributes.rb
+- lib/hotsheet/column.rb
+- lib/hotsheet/config.rb
 - lib/hotsheet/engine.rb
+- lib/hotsheet/sheet.rb
 - lib/hotsheet/version.rb
-- vendor/assets/stylesheets/hotsheet/pagy.css
 homepage: https://github.com/renuo/hotsheet
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/renuo/hotsheet
   source_code_uri: https://github.com/renuo/hotsheet
+  bug_tracker_uri: https://github.com/renuo/hotsheet/issues
   changelog_uri: https://github.com/renuo/hotsheet/blob/main/CHANGELOG.md
   documentation_uri: https://github.com/renuo/hotsheet/blob/main/README.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Manage your database with a simple and familiar web interface
+summary: Database GUI for Rails.
 test_files: []

data/CHANGELOG.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- ## [Unreleased](https://github.com/renuo/hotsheet/compare/v0.1.0..HEAD) -->
-## [0.1.1](https://github.com/renuo/hotsheet/releases/tag/v0.1.1) (2025-02-03)
-- Improve configuration file usage and logic ([@simon-isler])
-- Configure compatible Ruby/Rails versions for testing ([@ignaciosy])
-- Improve flash messages layout ([@ignaciosy])
-- Form inputs are now always visible for usage simplicity ([@ignaciosy])
-## [0.1.0](https://github.com/renuo/hotsheet/releases/tag/v0.1.0) (2024-11-05)
-- Gem structure and initial configuration ([@ignaciosy])
-- Inline editing table (([@simon-isler]) and ([@edmunteanu]))
-- Dummy app for development and test ([@hunchr])
-- Configuration for initializer, CI, lint, tests ([@hunchr])
-- Generator `bin/rails g hotsheet:install` for copying initializer and mounting engine in routes ([@hunchr])
-- Pagination for data tables ([@hunchr])
-[@ignaciosy]: https://github.com/ignaciosy
-[@hunchr]: https://github.com/hunchr
-[@simon-isler]: https://github.com/simon-isler
-[@edmunteanu]: https://github.com/edmunteanu

data/app/assets/config/hotsheet.js DELETED Viewed

	@@ -1,2 +0,0 @@
1	- //= link_directory ../stylesheets/hotsheet .css
2	- //= link_directory ../javascripts/hotsheet .js

data/app/assets/javascripts/hotsheet/application.js DELETED Viewed

	@@ -1 +0,0 @@
1	- //= require ./controllers/application

data/app/assets/javascripts/hotsheet/channels/consumer.js DELETED Viewed

@@ -1,3 +0,0 @@
-import { createConsumer } from "https://unpkg.com/@rails/actioncable@7.1.3-4/app/assets/javascripts/actioncable.esm.js"
-export default createConsumer()

data/app/assets/javascripts/hotsheet/channels/inline_edit_channel.js DELETED Viewed

@@ -1,3 +0,0 @@
-import consumer from "channels/consumer"
-consumer.subscriptions.create({ channel: "InlineEditChannel" })

data/app/assets/javascripts/hotsheet/controllers/application.js DELETED Viewed

@@ -1,8 +0,0 @@
-import { Application } from "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js"
-import EditableAttributeController from "./controllers/editable_attribute_controller"
-import FlashController from "./controllers/flash_controller"
-window.Stimulus = Application.start()
-Stimulus.register("editable-attribute", EditableAttributeController)
-Stimulus.register("flash", FlashController)

data/app/assets/javascripts/hotsheet/controllers/editable_attribute_controller.js DELETED Viewed

@@ -1,39 +0,0 @@
-import { Controller } from "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js"
-export default class extends Controller {
-  static values = {
-    broadcastUrl: String,
-    resourceName: String,
-    resourceId: Number,
-    resourceInitialValue: String
-  }
-  static targets = ["attributeFormInput"]
-  broadcastEditIntent() { // TODO: trigger on input focus
-    const headers = {
-      "Content-Type": "application/json",
-      "X-CSRF-Token": document.querySelector("meta[name=csrf-token]").content,
-    }
-    const body = JSON.stringify({
-      broadcast: {
-        resource_name: this.resourceNameValue,
-        resource_id: this.resourceIdValue,
-      },
-    })
-    fetch(this.broadcastUrlValue, { method: "POST", headers, body })
-  }
-  submitForm(event) {
-    // Prevent standard submission triggered by Enter press
-    event.preventDefault()
-    const newValue = this.attributeFormInputTarget.value
-    if (this.resourceInitialValueValue === newValue) return;
-    // It's important to use requestSubmit() instead of simply submit() as the latter will circumvent the
-    // Turbo mechanism, causing the PATCH request to be submitted as HTML instead of TURBO_STREAM
-    this.attributeFormInputTarget.form.requestSubmit()
-  }
-}

data/app/assets/javascripts/hotsheet/controllers/flash_controller.js DELETED Viewed

@@ -1,8 +0,0 @@
-import { Controller } from "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js"
-export default class extends Controller {
-  close() {
-    this.element.addEventListener("animationend", () => { this.element.remove(); });
-    this.element.classList.add("closing");
-  }
-}