hotsheet 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a5cc231b679617e535c8fb71bc077fbf8c735935967149af191484baa07d5cb
-  data.tar.gz: 4a9f48ce2ed52a96b313bb691b0908f141b18aea5807c41385753bca97671cf5
+  metadata.gz: 9b1074112914dc017affebb383fba9eaa3bbab56e59b40355510d94ddf0f21f9
+  data.tar.gz: 54d77d78f488cd563ee2377c3c5585580fa6d692d4c90de9126de82233ddfc3e
 SHA512:
-  metadata.gz: df1ce187b96c8dde0699ac26cbef9d4c28c08d1835d591537e0329beb308e6fafd4b9b1fbc08d851d30aa4a137cb006109b95fd77202f1663d963a928427e901
-  data.tar.gz: 5eacbcbadf7cac7f8ff7cde1a058ff8233ecd9e2f962de90a792b5eaa51c48dc2d2d7ee6c2db1b03a7c9579bb137d363a3ebe0b8873357d45eef4301e742880c
+  metadata.gz: 400ea189cbefc49907da08f1d22c3f3f40f9f28a7e7c0ad92a8469b4b18014f2f3767a2a57c03dbc81ff369366c107ab2252dad2c3c3e43a1deec3ac95b5bf4b
+  data.tar.gz: 64b2a5ca09604b2adacaa2da16e43bf95429d233c728e3f8175009b71fef00f0ac217a193711d1be4823bdc8870c56929d52316facc38b3130e68129fc2653a7

data/README.md

@@ -16,25 +16,45 @@
 
 ## Usage
 
-After installing, you can directly go to `/hotsheet` within your app by default.
+After the installation, you can start the Rails server and visit
+[/hotsheet](http://localhost:3000/hotsheet) to view the spreadsheet.
 
 ### Configuration
 
 You can configure which models ('sheets') this gem should manage, and specify which
 database columns should be editable or viewable in the spreadsheet. This can be
-done by configuring the initializer file created by the install command:
+done by editing the [config/initializers/hotsheet.rb](https://github.com/renuo/hotsheet/blob/main/lib/generators/templates/hotsheet.rb)
+file created by the install command:
 
 ```rb
-# config/initializers/hotsheet.rb
-
 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 :birthdate, editable: false
+    column :email, editable: false
+    column :birthdate, editable: -> { rand > 0.5 }
   end
+
+  # Leave the block out to include all database columns.
+  sheet :Post
 end
 ```
 
+### Basic Authentication
+
+If you don't want everyone to have access to Hotsheet, you can set a
+basic auth environment variable:
+
+```sh
+HOTSHEET_BASIC_AUTH="admin:password"
+```
+
+### Internationalization
+
+You can create custom translations by overwriting the default locales defined in
+[config/locales/en.yml](https://github.com/renuo/hotsheet/blob/main/config/locales/en.yml).
+
 ## Contributing
 
 See [Contributing Guide](https://github.com/renuo/hotsheet/blob/main/CONTRIBUTING.md) and please
@@ -48,7 +68,7 @@ This is a newly created gem, and we will firstly focus on:
 1. Configuration and access permissions
 1. Concurrent users (broadcasting, conflict resolution)
 
-Feel free to look at our [planned enhancements](https://github.com/renuo/hotsheet/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)
+Feel free to look at our [planned enhancements](https://github.com/renuo/hotsheet/issues?q=is:open+is:issue+label:feature)
 or add your own.
 
 ## License

data/app/controllers/hotsheet/application_controller.rb

@@ -2,4 +2,10 @@
 
 class Hotsheet::ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
+
+  # :nocov:
+  ENV["HOTSHEET_BASIC_AUTH"]&.split(":")&.then do |name, password|
+    http_basic_authenticate_with name:, password:
+  end
+  # :nocov:
 end

data/app/controllers/hotsheet/home_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Hotsheet::HomeController < Hotsheet::ApplicationController
+  def show; end
+
+  def error
+    render "error", status: :not_found
+  end
+end

data/app/controllers/hotsheet/sheets_controller.rb

@@ -18,27 +18,25 @@ class Hotsheet::SheetsController < Hotsheet::ApplicationController
     end
   end
 
-  def error
-    render "error", status: :not_found
-  end
-
   private
 
   def set_sheet
     @sheet = Hotsheet.sheets[params[:sheet_name]]
+
+    render "hotsheet/home/error", status: :not_found if @sheet.nil?
   end
 
   def set_column
     @column = @sheet.columns[params[:column_name]]
-    return respond Hotsheet.t "errors.not_found" if @column.nil?
+    return respond Hotsheet.t "error_not_found" if @column.nil?
 
-    respond Hotsheet.t "errors.forbidden" unless @column.editable?
+    respond Hotsheet.t "error_forbidden" unless @column.editable?
   end
 
   def set_resource
     @resource = @sheet.model.find_by id: params[:id]
 
-    respond Hotsheet.t "errors.not_found" if @resource.nil?
+    respond Hotsheet.t "error_not_found" if @resource.nil?
   end
 
   def respond(message = "")

data/app/views/hotsheet/home/error.html.erb

@@ -0,0 +1 @@
+<h1><%= Hotsheet.t "error_not_found" %></h1>

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

@@ -6,7 +6,7 @@
     <% Hotsheet.sheets.each_with_index do |entry, index| %>
       <li>
         <% sheet_name, sheet = entry %>
-        <%= link_to sheet.model.model_name.human(count: 2), sheet_path_for(sheet_name),
+        <%= 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 %>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  hotsheet:
+    error_forbidden: Forbidden
+    error_not_found: Not found
+    title: Hotsheet

data/config/routes.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 Hotsheet::Engine.routes.draw do
-  next unless defined? Rails::Server
+  root "home#show"
 
-  Hotsheet.sheets.each_key do |sheet_name|
-    resources sheet_name, sheet_name:, controller: :sheets, only: %i[index update]
+  scope ":sheet_name" do
+    resources controller: :sheets, only: %i[index update], as: :sheets
   end
 
-  root "sheets#root"
-  match "*path", to: "sheets#error", via: :all
+  match "*path", to: "home#error", via: :all
 end

data/lib/generators/templates/hotsheet.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
 # Configure the models to be used by Hotsheet.
-# See https://github.com/renuo/hotsheet?tab=readme-ov-file#usage.
-# The ID is included by default. It is always the first column.
+# See https://github.com/renuo/hotsheet/blob/main/README.md#usage.
 
 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 :birthdate, editable: false
+  #   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/version.rb

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

data/lib/hotsheet.rb

@@ -12,10 +12,10 @@ module Hotsheet
   class << self
     include Config
 
-    CONFIG = {}.freeze
-
     attr_reader :config
 
+    CONFIG = {}.freeze
+
     def configure(config = {}, &sheets)
       @config = [merge_config!(CONFIG, config), sheets]
       self
@@ -29,10 +29,10 @@ module Hotsheet
       end
     end
 
+    I18N = Psych.load_file(Hotsheet::Engine.root.join("config/locales/en.yml"))["en"]["hotsheet"].freeze
+
     def t(key)
-      I18n.t key, scope: "hotsheet"
-    rescue I18n::MissingTranslationData
-      I18n.with_locale(:en) { I18n.t key, scope: "hotsheet" }
+      I18n.t "hotsheet.#{key}", default: I18N[key]
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotsheet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Renuo AG
@@ -38,13 +38,14 @@ files:
 - app/assets/hotsheet.css
 - app/assets/hotsheet.js
 - app/controllers/hotsheet/application_controller.rb
+- app/controllers/hotsheet/home_controller.rb
 - app/controllers/hotsheet/sheets_controller.rb
-- app/helpers/hotsheet/application_helper.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/error.html.erb
 - app/views/hotsheet/sheets/index.html.erb
-- app/views/hotsheet/sheets/root.html.erb
 - app/views/layouts/hotsheet/application.html.erb
+- config/locales/en.yml
 - config/routes.rb
 - lib/generators/hotsheet/install_generator.rb
 - lib/generators/templates/hotsheet.rb

data/app/helpers/hotsheet/application_helper.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Hotsheet::ApplicationHelper
-  def sheet_path_for(sheet_name, **args)
-    hotsheet.public_send :"#{sheet_name}_path", **args
-  end
-end

data/app/views/hotsheet/sheets/error.html.erb

@@ -1 +0,0 @@
-<h1><%= Hotsheet.t "errors.not_found" %></h1>