mensa 0.1.0 → 0.1.4

data/lib/mensa/configuration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Mensa
+  module Options
+    module ClassMethods
+      def option(name, default: nil)
+        attr_accessor(name)
+        schema[name] = default
+      end
+
+      def schema
+        @schema ||= {}
+      end
+    end
+
+    def set_defaults!
+      self.class.schema.each do |name, default|
+        instance_variable_set("@#{name}", default)
+      end
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+    end
+  end
+
+  class Configuration
+    include Options
+
+    option :logger, default: Rails.logger
+    option :base_controller, default: "::ApplicationController"
+
+    # TODO: add all icons below
+    option :icons, default: {
+      order_indicator_asc: "fa-solid fa-sort-up",
+      order_indicator_desc: "fa-solid fa-sort-down",
+      order_indicator: "fa-solid fa-sort",
+      control_bar_search: "fa-solid fa-magnifying-glass",
+      control_bar_filter: "fa-solid fa-filter",
+      control_bar_edit: "fa-solid fa-table-columns",
+      control_bar_compress: "fa-solid fa-compress",
+      control_bar_export: "fa-solid fa-file-export",
+      search: "fa-solid fa-magnifying-glass"
+    }
+    # PRO
+    # option :icons, default: {
+    #   order_indicator_asc: "fa-regular fa-arrow-up-short-wide",
+    #   order_indicator_desc: "fa-regular fa-arrow-down-wide-short",
+    #   order_indicator: "fa-regular fa-arrow-down-arrow-up",
+    #   control_bar_search: "fa-light fa-magnifying-glass",
+    #   control_bar_filter: "fa-light fa-bars-filter",
+    #   control_bar_edit: "fa-light fa-columns-3",
+    #   control_bar_compress: "fa-light fa-compress",
+    #   control_bar_export: "fa-light fa-file-export",
+    #   search: "fa-light fa-magnifying-glass"
+    # }
+
+    option :callbacks, default: {
+      # Callback is called when the export is started,
+      # the return value is passed as context to the export_complete callback
+      export_started: lambda do |user_id, table_name|
+      end,
+      export_complete: lambda do |user_id, table_name, context, attachment|
+      end
+    }
+
+    def initialize
+      set_defaults!
+    end
+  end
+
+  module Configurable
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    alias setup configure
+
+    def reset_config!
+      @config = Configuration.new
+    end
+  end
+
+end

data/lib/mensa/engine.rb

@@ -0,0 +1,37 @@
+require 'pagy'
+require 'satis'
+require 'textacular'
+require 'caxlsx_rails'
+require 'slim'
+require 'tailwindcss-rails'
+require "importmap-rails"
+require "turbo-rails"
+require "stimulus-rails"
+
+module Mensa
+  class Engine < ::Rails::Engine
+    isolate_namespace Mensa
+
+    initializer 'mensa.assets' do |app|
+      app.config.assets.paths << root.join("app/javascript")
+      app.config.assets.paths << root.join("app/components")
+      app.config.assets.paths << Mensa::Engine.root.join("vendor/javascript")
+      app.config.assets.precompile += %w[mensa_manifest]
+    end
+
+    initializer 'mensa.importmap', before: "importmap" do |app|
+      app.config.importmap.paths << root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << root.join("app/javascript")
+      app.config.importmap.cache_sweepers << root.join("app/components")
+      app.config.importmap.cache_sweepers << Mensa::Engine.root.join("vendor/javascript")
+    end
+
+    initializer 'mensa.helper' do
+      Rails.application.reloader.to_prepare do
+        ActiveSupport.on_load(:action_controller) do
+          Satis.add_helper(:table, ::Mensa::Table::Component)
+        end
+      end
+    end
+  end
+end

data/lib/mensa/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Mensa
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/mensa.rb

@@ -1,8 +1,27 @@
-# frozen_string_literal: true
-
-require_relative "mensa/version"
+require "mensa/version"
+require "mensa/engine"
+require 'mensa/configuration'
+require "importmap-rails"
 
 module Mensa
-  class Error < StandardError; end
-  # Your code goes here...
+  extend Configurable
+
+  class << self
+    def for_name(name, config = {})
+      instance = class_for_name(name).new(config)
+      instance.name = name
+      instance
+    end
+
+    def class_for_name(name)
+      class_name = "#{name}_table".camelcase
+      unless class_name.safe_constantize
+        module_class_name = name.to_s.split('_', 2).map(&:camelcase).join('::') + 'Table'
+        class_name = module_class_name if module_class_name.safe_constantize
+      end
+      Kernel.const_get("::#{class_name}")
+    rescue NameError
+      raise NotImplementedError, "No '#{name}' table defined."
+    end
+  end
 end

data/lib/tasks/mensa_tasks.rake

@@ -0,0 +1,13 @@
+namespace :mensa do
+  namespace :tailwindcss do
+    desc "Configure your Tailwind CSS"
+    task :config do
+      Rails::Generators.invoke("mensa:tailwind_config", ["--force"])
+    end
+  end
+end
+
+if Rake::Task.task_defined?("tailwindcss:build")
+  Rake::Task["tailwindcss:build"].enhance(["mensa:tailwindcss:config"])
+  Rake::Task["tailwindcss:watch"].enhance(["mensa:tailwindcss:config"])
+end

data/mensa.gemspec

@@ -0,0 +1,42 @@
+require_relative "lib/mensa/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "mensa"
+  spec.version     = Mensa::VERSION
+  spec.authors     = ["Tom de Grunt"]
+  spec.email       = ["tom@degrunt.nl"]
+  spec.homepage    = "https://github.com/entdec/mensa"
+  spec.summary     = "Fast and awesome tables"
+  spec.description = "Fast and awesome tables, with pagination, sorting, filtering and custom views."
+  spec.license     = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.post_install_message = <<~MESSAGE
+      Mensa requires additional setup. Please run the following
+      command to install the necessary files:
+
+      bin/rails mensa:install:migrations
+    MESSAGE
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/entdec/mensa"
+  spec.metadata["changelog_uri"] = "https://github.com/entdec/mensa/CHANGELOG"
+
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_dependency 'caxlsx_rails', '~> 0'
+  spec.add_dependency "rails", ">= 7.1"
+  spec.add_dependency 'pagy', '>=6'
+  spec.add_dependency 'textacular', '>=5'
+
+  spec.add_dependency 'slim'
+  spec.add_dependency 'tailwindcss-rails'
+  spec.add_dependency 'importmap-rails'
+  spec.add_dependency 'turbo-rails'
+  spec.add_dependency 'stimulus-rails'
+end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@entdec/mensa",
+  "dependencies": {
+    "postcss-advanced-variables": "^3.0.1",
+    "postcss-comment": "^2.0.0",
+    "postcss-import": "^16.0.1",
+    "postcss-mixins": "^9.0.4",
+    "tailwindcss": "^3.4.1"
+  }
+}

data/vendor/javascript/@rails--request.js.js

@@ -0,0 +1,2 @@
+class FetchResponse{constructor(t){this.response=t}get statusCode(){return this.response.status}get redirected(){return this.response.redirected}get ok(){return this.response.ok}get unauthenticated(){return 401===this.statusCode}get unprocessableEntity(){return 422===this.statusCode}get authenticationURL(){return this.response.headers.get("WWW-Authenticate")}get contentType(){const t=this.response.headers.get("Content-Type")||"";return t.replace(/;.*$/,"")}get headers(){return this.response.headers}get html(){return this.contentType.match(/^(application|text)\/(html|xhtml\+xml)$/)?this.text:Promise.reject(new Error(`Expected an HTML response but got "${this.contentType}" instead`))}get json(){return this.contentType.match(/^application\/.*json$/)?this.responseJson||(this.responseJson=this.response.json()):Promise.reject(new Error(`Expected a JSON response but got "${this.contentType}" instead`))}get text(){return this.responseText||(this.responseText=this.response.text())}get isTurboStream(){return this.contentType.match(/^text\/vnd\.turbo-stream\.html/)}async renderTurboStream(){if(!this.isTurboStream)return Promise.reject(new Error(`Expected a Turbo Stream response but got "${this.contentType}" instead`));window.Turbo?await window.Turbo.renderStreamMessage(await this.text):console.warn("You must set `window.Turbo = Turbo` to automatically process Turbo Stream events with request.js")}}class RequestInterceptor{static register(t){this.interceptor=t}static get(){return this.interceptor}static reset(){this.interceptor=void 0}}function getCookie(t){const e=document.cookie?document.cookie.split("; "):[];const n=`${encodeURIComponent(t)}=`;const s=e.find((t=>t.startsWith(n)));if(s){const t=s.split("=").slice(1).join("=");if(t)return decodeURIComponent(t)}}function compact(t){const e={};for(const n in t){const s=t[n];void 0!==s&&(e[n]=s)}return e}function metaContent(t){const e=document.head.querySelector(`meta[name="${t}"]`);return e&&e.content}function stringEntriesFromFormData(t){return[...t].reduce(((t,[e,n])=>t.concat("string"===typeof n?[[e,n]]:[])),[])}function mergeEntries(t,e){for(const[n,s]of e)if(!(s instanceof window.File))if(t.has(n)&&!n.includes("[]")){t.delete(n);t.set(n,s)}else t.append(n,s)}class FetchRequest{constructor(t,e,n={}){this.method=t;this.options=n;this.originalUrl=e.toString()}async perform(){try{const t=RequestInterceptor.get();t&&await t(this)}catch(t){console.error(t)}const t=new FetchResponse(await window.fetch(this.url,this.fetchOptions));if(t.unauthenticated&&t.authenticationURL)return Promise.reject(window.location.href=t.authenticationURL);const e=t.ok||t.unprocessableEntity;e&&t.isTurboStream&&await t.renderTurboStream();return t}addHeader(t,e){const n=this.additionalHeaders;n[t]=e;this.options.headers=n}sameHostname(){if(!this.originalUrl.startsWith("http:"))return true;try{return new URL(this.originalUrl).hostname===window.location.hostname}catch(t){return true}}get fetchOptions(){return{method:this.method.toUpperCase(),headers:this.headers,body:this.formattedBody,signal:this.signal,credentials:this.credentials,redirect:this.redirect}}get headers(){const t={"X-Requested-With":"XMLHttpRequest","Content-Type":this.contentType,Accept:this.accept};this.sameHostname()&&(t["X-CSRF-Token"]=this.csrfToken);return compact(Object.assign(t,this.additionalHeaders))}get csrfToken(){return getCookie(metaContent("csrf-param"))||metaContent("csrf-token")}get contentType(){return this.options.contentType?this.options.contentType:null==this.body||this.body instanceof window.FormData?void 0:this.body instanceof window.File?this.body.type:"application/json"}get accept(){switch(this.responseKind){case"html":return"text/html, application/xhtml+xml";case"turbo-stream":return"text/vnd.turbo-stream.html, text/html, application/xhtml+xml";case"json":return"application/json, application/vnd.api+json";default:return"*/*"}}get body(){return this.options.body}get query(){const t=(this.originalUrl.split("?")[1]||"").split("#")[0];const e=new URLSearchParams(t);let n=this.options.query;n=n instanceof window.FormData?stringEntriesFromFormData(n):n instanceof window.URLSearchParams?n.entries():Object.entries(n||{});mergeEntries(e,n);const s=e.toString();return s.length>0?`?${s}`:""}get url(){return this.originalUrl.split("?")[0].split("#")[0]+this.query}get responseKind(){return this.options.responseKind||"html"}get signal(){return this.options.signal}get redirect(){return this.options.redirect||"follow"}get credentials(){return this.options.credentials||"same-origin"}get additionalHeaders(){return this.options.headers||{}}get formattedBody(){const t="[object String]"===Object.prototype.toString.call(this.body);const e="application/json"===this.headers["Content-Type"];return e&&!t?JSON.stringify(this.body):this.body}}async function get(t,e){const n=new FetchRequest("get",t,e);return n.perform()}async function post(t,e){const n=new FetchRequest("post",t,e);return n.perform()}async function put(t,e){const n=new FetchRequest("put",t,e);return n.perform()}async function patch(t,e){const n=new FetchRequest("patch",t,e);return n.perform()}async function destroy(t,e){const n=new FetchRequest("delete",t,e);return n.perform()}export{FetchRequest,FetchResponse,RequestInterceptor,destroy,get,patch,post,put};
+