solidcrud 0.1.0

data/lib/generators/solidcrud/install/templates/INSTALL.md

@@ -0,0 +1,80 @@
+# SolidCRUD Installation Guide
+
+## Authentication Configuration
+
+SolidCRUD supports multiple authentication methods. Choose the one that best fits your application:
+
+### Option 1: Basic HTTP Authentication (Simplest)
+
+Add this to `config/initializers/solidcrud.rb`:
+
+```ruby
+Solidcrud.setup do |config|
+  config.basic_auth_username = 'admin'
+  config.basic_auth_password = 'secure_password_here'
+end
+```
+
+### Option 2: Custom Authentication Method
+
+For integration with existing authentication systems:
+
+```ruby
+Solidcrud.setup do |config|
+  config.authenticate_with do
+    # Your authentication logic here
+    # Return true if authenticated, false otherwise
+
+    # Example with Devise:
+    if defined?(Devise)
+      authenticate_user!
+      true
+    else
+      false
+    end
+  end
+end
+```
+
+### Option 3: Automatic Devise Integration
+
+If you have Devise installed, SolidCRUD will automatically detect and use it. No configuration needed!
+
+### Option 4: No Authentication (Development Only)
+
+For development/testing, you can disable authentication:
+
+```ruby
+Solidcrud.setup do |config|
+  # No authentication configured - allows access without login
+  # WARNING: Not recommended for production!
+end
+```
+
+## Routes
+
+SolidCRUD mounts at `/admin` by default. Add this to your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Solidcrud::Engine => '/admin'
+  # ... your other routes
+end
+```
+
+## Usage
+
+After configuration, visit `/admin` to access the SolidCRUD interface.
+
+## Security Notes
+
+- Always configure authentication for production environments
+- Use strong passwords for basic auth
+- Consider using HTTPS in production
+- Regularly rotate credentials
+
+## Troubleshooting
+
+- If you see "Authentication not configured" - check your initializer
+- For Devise integration issues - ensure your user model includes authentication
+- Session issues - check that sessions are enabled in your Rails app

data/lib/generators/solidcrud/install/templates/solidcrud.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Configure SolidCRUD authentication
+Solidcrud.setup do |config|
+  # Exclude models from admin interface (optional)
+  # config.models_exclude = ['ModelName']
+
+  # Configure authentication methods (choose one or more):
+
+  # Option 1: Basic HTTP Authentication (simple username/password)
+  # config.basic_auth_username = 'admin'
+  # config.basic_auth_password = 'password'
+
+  # Option 2: Custom authentication method (for integration with existing auth systems)
+  # config.authenticate_with do
+  #   # Your custom authentication logic here
+  #   # Return true if authenticated, false otherwise
+  #   # This block has access to controller methods like current_user, session, etc.
+  #
+  #   # Example with Devise:
+  #   # authenticate_user! if defined?(Devise)
+  #
+  #   # Example with custom auth:
+  #   # redirect_to login_path unless session[:user_id]
+  #
+  #   true # or false
+  # end
+
+  # Option 3: Automatic Devise integration (if Devise is installed)
+  # No configuration needed - SolidCRUD will automatically detect and use Devise
+end

data/lib/generators/solidcrud/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Solidcrud
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def mount_engine
+        route "mount Solidcrud::Engine => '/admin'"
+      end
+
+      def copy_initializer
+        template 'solidcrud.rb', 'config/initializers/solidcrud.rb'
+      end
+    end
+  end
+end

data/lib/generators/solidcrud/templates/solidcrud.rb

@@ -0,0 +1,4 @@
+# Configure SolidCRUD
+Solidcrud.setup do |config|
+  # Example: config.models_exclude = ["ActiveStorage::Blob"]
+end

data/lib/solidcrud/authentication.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Solidcrud
+  module Authentication
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :authenticate_solidcrud_user!
+      helper_method :current_solidcrud_user, :solidcrud_user_signed_in?
+    end
+
+    private
+
+    def authenticate_solidcrud_user!
+      return if solidcrud_user_signed_in?
+
+      # Check authentication based on configured type
+      case Solidcrud.config.auth_type
+      when :basic_auth
+        authenticate_with_basic_auth
+      when :devise
+        authenticate_with_devise
+      when :jwt
+        authenticate_with_jwt
+      when :custom
+        authenticate_with_custom_method
+      else
+        # Fallback to legacy behavior
+        if respond_to?(:authenticate_with_devise, true) && authenticate_with_devise
+          return
+        elsif respond_to?(:authenticate_with_custom_method, true) && authenticate_with_custom_method
+          return
+        elsif Solidcrud.config.basic_auth_enabled?
+          authenticate_with_basic_auth
+        else
+          # No authentication configured - allow access (for development)
+          Rails.logger.warn "SolidCRUD: No authentication configured. Consider setting up authentication for production use."
+        end
+      end
+    end
+
+    def current_solidcrud_user
+      @current_solidcrud_user ||= begin
+        user = nil
+
+        # Try different methods to get current user
+        if respond_to?(:current_user, true)
+          user = current_user
+        elsif respond_to?(:current_admin_user, true)
+          user = current_admin_user
+        elsif respond_to?(:current_solidcrud_user_from_session, true)
+          user = current_solidcrud_user_from_session
+        end
+
+        user
+      end
+    end
+
+    def solidcrud_user_signed_in?
+      current_solidcrud_user.present?
+    end
+
+    def authenticate_with_devise
+      return false unless defined?(Devise)
+
+      # Check if there's a user signed in via Devise
+      if respond_to?(:authenticate_user!, true)
+        authenticate_user!
+        return true
+      elsif respond_to?(:authenticate_admin_user!, true)
+        authenticate_admin_user!
+        return true
+      end
+
+      false
+    end
+
+    def authenticate_with_custom_method
+      # Allow host app to define custom authentication
+      if Solidcrud.config.authenticate_method.is_a?(Proc)
+        instance_exec(&Solidcrud.config.authenticate_method)
+        return true
+      end
+
+      false
+    end
+
+    def authenticate_with_jwt
+      return false unless Solidcrud.config.jwt_enabled?
+
+      # Check for JWT in Authorization header
+      auth_header = request.headers['Authorization']
+      if auth_header&.match?(/^Bearer /)
+        token = auth_header.sub(/^Bearer /, '')
+        begin
+          # Decode and verify JWT
+          payload = JWT.decode(token, Solidcrud.config.jwt_secret)[0]
+
+          # Check token expiration
+          if payload['exp'] && payload['exp'] < Time.now.to_i
+            Rails.logger.warn "SolidCRUD: JWT token expired"
+            return false
+          end
+
+          # Store user info in session for current request
+          session[:solidcrud_user_id] = payload['user_id'] || payload['sub'] || 'jwt_user'
+          session[:solidcrud_user_email] = payload['email']
+          session[:solidcrud_user_role] = payload['role']
+
+          return true
+        rescue JWT::DecodeError => e
+          Rails.logger.warn "SolidCRUD: JWT decode error: #{e.message}"
+          return false
+        end
+      end
+
+      false
+    end
+
+    def current_solidcrud_user_from_session
+      # Simple session-based authentication for basic auth
+      return unless session[:solidcrud_user_id]
+
+      # For basic auth, we just store a flag
+      { id: session[:solidcrud_user_id], authenticated: true }
+    end
+
+    def sign_in_solidcrud_user(user = nil)
+      if user
+        session[:solidcrud_user_id] = user.try(:id) || 'basic_auth_user'
+        @current_solidcrud_user = user
+      else
+        session[:solidcrud_user_id] = 'basic_auth_user'
+        @current_solidcrud_user = { id: 'basic_auth_user', authenticated: true }
+      end
+    end
+
+    def sign_out_solidcrud_user
+      session.delete(:solidcrud_user_id)
+      @current_solidcrud_user = nil
+    end
+  end
+end

data/lib/solidcrud/configuration.rb

@@ -0,0 +1,64 @@
+module Solidcrud
+  class << self
+    attr_accessor :config
+
+    def setup
+      self.config ||= Configuration.new
+      yield(config)
+    end
+  end
+
+  class Configuration
+    attr_accessor :models_exclude
+    attr_accessor :authenticate_method
+    attr_accessor :basic_auth_username, :basic_auth_password
+    attr_accessor :auth_type
+    attr_accessor :jwt_secret
+    attr_accessor :devise_scope
+
+    def initialize
+      @models_exclude = []
+      @authenticate_method = nil
+      @basic_auth_username = nil
+      @basic_auth_password = nil
+      @auth_type = :custom # Default to custom authentication
+      @jwt_secret = nil
+      @devise_scope = :user
+    end
+
+    def basic_auth_enabled?
+      @basic_auth_username.present? && @basic_auth_password.present?
+    end
+
+    def jwt_enabled?
+      @jwt_secret.present?
+    end
+
+    def devise_enabled?
+      @auth_type == :devise
+    end
+
+    def authenticate_with(&block)
+      @authenticate_method = block
+    end
+
+    # Authentication type setters
+    def use_basic_auth
+      @auth_type = :basic_auth
+    end
+
+    def use_devise(scope: :user)
+      @auth_type = :devise
+      @devise_scope = scope
+    end
+
+    def use_jwt
+      @auth_type = :jwt
+    end
+
+    def use_custom(&block)
+      @auth_type = :custom
+      @authenticate_method = block
+    end
+  end
+end

data/lib/solidcrud/engine.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+require 'turbo-rails'
+
+module Solidcrud
+  class Engine < ::Rails::Engine
+    isolate_namespace Solidcrud
+
+    config.paths['db/migrate'] = 'lib/solidcrud/db/migrate'
+
+    config.autoload_paths << root.join('lib')
+
+    # Register turbo_stream MIME type
+    Mime::Type.register "text/vnd.turbo-stream.html", :turbo_stream
+
+    initializer "solidcrud.assets" do |app|
+      # Add SolidCRUD assets to the asset paths if assets are enabled
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join('app', 'assets').to_s
+      end
+
+      # Enable asset serving for API-only apps
+      app.config.serve_static_files = true
+    end
+
+    initializer "solidcrud.asset_routes" do |app|
+      # Asset routes are now defined in config/routes.rb
+      # This initializer is kept for future asset configuration
+    end
+
+    initializer "solidcrud.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Solidcrud::ApplicationHelper
+      end
+    end
+
+    initializer "solidcrud.csrf_protection" do |app|
+      # Enable CSRF protection for SolidCRUD routes
+      app.config.action_controller.forgery_protection_origin_check = false
+      app.config.action_controller.allow_forgery_protection = true
+    end
+
+    initializer "solidcrud.configuration" do |app|
+      # Initialize configuration
+      Solidcrud.config ||= Solidcrud::Configuration.new
+    end
+  end
+end

data/lib/solidcrud/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Solidcrud
+  VERSION = "0.1.0"
+end

data/lib/solidcrud.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+
+require "solidcrud/version"
+require "solidcrud/engine"
+require "solidcrud/configuration"
+
+module Solidcrud
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: solidcrud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SolidCRUD Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: SolidCRUD provides a plug-and-play /admin dashboard for Rails applications.
+  It auto-detects all ActiveRecord models and provides a complete CRUD interface with
+  a modern, responsive Bootstrap UI. Features include search, pagination, intelligent
+  form fields, and zero configuration required.
+email:
+- hello@solidcrud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/assets/javascripts/controllers/dashboard_controller.js
+- app/assets/javascripts/controllers/modal_controller.js
+- app/assets/javascripts/controllers/navigation_controller.js
+- app/assets/javascripts/controllers/notification_controller.js
+- app/assets/javascripts/controllers/search_controller.js
+- app/assets/javascripts/controllers/table_controller.js
+- app/assets/javascripts/solidcrud/application.js
+- app/assets/stylesheets/solidcrud/_components.scss
+- app/assets/stylesheets/solidcrud/_forms.scss
+- app/assets/stylesheets/solidcrud/_layout.scss
+- app/assets/stylesheets/solidcrud/_tables.scss
+- app/assets/stylesheets/solidcrud/_variables.scss
+- app/assets/stylesheets/solidcrud/application.css
+- app/assets/stylesheets/solidcrud/application.css.map
+- app/assets/stylesheets/solidcrud/application.scss
+- app/assets/stylesheets/solidcrud/temp.css.map
+- app/assets/stylesheets/solidcrud/temp2.css.map
+- app/assets/stylesheets/solidcrud/webfonts/fa-brands-400.ttf
+- app/assets/stylesheets/solidcrud/webfonts/fa-brands-400.woff2
+- app/assets/stylesheets/solidcrud/webfonts/fa-regular-400.ttf
+- app/assets/stylesheets/solidcrud/webfonts/fa-regular-400.woff2
+- app/assets/stylesheets/solidcrud/webfonts/fa-solid-900.ttf
+- app/assets/stylesheets/solidcrud/webfonts/fa-solid-900.woff2
+- app/assets/stylesheets/solidcrud/webfonts/fa-v4compatibility.ttf
+- app/assets/stylesheets/solidcrud/webfonts/fa-v4compatibility.woff2
+- app/assets/stylesheets/webfonts/fa-brands-400.ttf
+- app/assets/stylesheets/webfonts/fa-brands-400.woff2
+- app/assets/stylesheets/webfonts/fa-regular-400.ttf
+- app/assets/stylesheets/webfonts/fa-regular-400.woff2
+- app/assets/stylesheets/webfonts/fa-solid-900.ttf
+- app/assets/stylesheets/webfonts/fa-solid-900.woff2
+- app/assets/stylesheets/webfonts/fa-v4compatibility.ttf
+- app/assets/stylesheets/webfonts/fa-v4compatibility.woff2
+- app/controllers/solidcrud/admin_controller.rb
+- app/controllers/solidcrud/application_controller.rb
+- app/controllers/solidcrud/assets_controller.rb
+- app/controllers/solidcrud/sessions_controller.rb
+- app/helpers/solidcrud/application_helper.rb
+- app/javascript/solidcrud/application.js
+- app/javascript/solidcrud/controllers/crud_controller.js
+- app/javascript/solidcrud/controllers/index.js
+- app/views/layouts/solidcrud/application.html.erb
+- app/views/solidcrud/admin/edit.html.erb
+- app/views/solidcrud/admin/index.html.erb
+- app/views/solidcrud/admin/model.html.erb
+- app/views/solidcrud/admin/new.html.erb
+- app/views/solidcrud/admin/shared/_dashboard_stats.html.erb
+- app/views/solidcrud/admin/shared/_edit_form_sidebar.html.erb
+- app/views/solidcrud/admin/shared/_flash_messages.html.erb
+- app/views/solidcrud/admin/shared/_full_sidebar.html.erb
+- app/views/solidcrud/admin/shared/_modal.html.erb
+- app/views/solidcrud/admin/shared/_new_form_sidebar.html.erb
+- app/views/solidcrud/admin/shared/_record_row.html.erb
+- app/views/solidcrud/admin/shared/_records_table.html.erb
+- app/views/solidcrud/sessions/new.html.erb
+- config/routes.rb
+- lib/generators/solidcrud/install/install_generator.rb
+- lib/generators/solidcrud/install/templates/INSTALL.md
+- lib/generators/solidcrud/install/templates/solidcrud.rb
+- lib/generators/solidcrud/install_generator.rb
+- lib/generators/solidcrud/templates/solidcrud.rb
+- lib/solidcrud.rb
+- lib/solidcrud/authentication.rb
+- lib/solidcrud/configuration.rb
+- lib/solidcrud/engine.rb
+- lib/solidcrud/version.rb
+homepage: https://github.com/solidcrud/solidcrud
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/solidcrud/solidcrud
+  source_code_uri: https://github.com/solidcrud/solidcrud
+  changelog_uri: https://github.com/solidcrud/solidcrud/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/solidcrud/solidcrud/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Zero-config admin dashboard for Rails 6-8 with CRUD for all models.
+test_files: []