solidstats 1.1.0 → 2.0.0

data/lib/solidstats.rb

@@ -1,12 +1,28 @@
+# frozen_string_literal: true
+
 require "solidstats/version"
 require "solidstats/engine"
+require "solidstats/asset_compatibility"
+require "solidstats/asset_manifest"
 
 module Solidstats
+  # Base error class for all Solidstats-specific errors
+  class Error < StandardError; end
+
+  # Configuration-related errors
+  class ConfigurationError < Error; end
+
+  # Component-related errors
+  class ComponentError < Error; end
+
+  # Service-related errors
+  class ServiceError < Error; end
+
   class << self
     # Returns the absolute path to this gem's root directory
-    # @return [String] Gem root path
+    # @return [Pathname] Gem root path
     def root
-      File.dirname(__dir__)
+      @root ||= Pathname.new(File.dirname(__dir__))
     end
 
     # Returns version string
@@ -14,5 +30,286 @@ module Solidstats
     def version
       VERSION
     end
+
+    # Returns the gem's app directory
+    # @return [Pathname] App directory path
+    def app_path
+      @app_path ||= root.join("app")
+    end
+
+    # Returns the components directory
+    # @return [Pathname] Components directory path
+    def components_path
+      @components_path ||= app_path.join("components", "solidstats")
+    end
+
+    # Returns the services directory
+    # @return [Pathname] Services directory path
+    def services_path
+      @services_path ||= app_path.join("services", "solidstats")
+    end
+
+    # Check if ViewComponent is available and properly loaded
+    # @return [Boolean] True if ViewComponent is loaded and usable
+    def view_component_available?
+      defined?(ViewComponent::Base) &&
+        ViewComponent::Base.respond_to?(:new) &&
+        defined?(Rails)
+    end
+
+    # Safely load ViewComponent if not already loaded
+    # @return [Boolean] True if ViewComponent was loaded successfully
+    def ensure_view_component!
+      return true if view_component_available?
+
+      unless defined?(Rails)
+        logger.warn "[Solidstats] Rails not available - ViewComponent cannot be loaded"
+        return false
+      end
+
+      begin
+        require "view_component"
+        require "view_component/engine"
+
+        # Verify it loaded correctly
+        if view_component_available?
+          logger.info "[Solidstats] ViewComponent loaded successfully"
+          true
+        else
+          logger.error "[Solidstats] ViewComponent loaded but not properly initialized"
+          false
+        end
+      rescue LoadError => e
+        logger.warn "[Solidstats] ViewComponent not available: #{e.message}"
+        false
+      rescue StandardError => e
+        logger.error "[Solidstats] Failed to load ViewComponent: #{e.message}"
+        false
+      end
+    end
+
+    # Check if running in development mode
+    # @return [Boolean] True if in development
+    def development?
+      defined?(Rails) && Rails.env.development?
+    end
+
+    # Check if running in production mode
+    # @return [Boolean] True if in production
+    def production?
+      defined?(Rails) && Rails.env.production?
+    end
+
+    # Check if running in test mode
+    # @return [Boolean] True if in test
+    def test?
+      defined?(Rails) && Rails.env.test?
+    end
+
+    # Current Rails environment
+    # @return [String, nil] Environment name or nil if Rails not available
+    def environment
+      Rails.env if defined?(Rails)
+    end
+
+    # Configuration object for the gem
+    # @return [Configuration] Configuration instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure the gem with a block
+    # @yield [Configuration] Configuration object
+    # @example
+    #   Solidstats.configure do |config|
+    #     config.cache_duration = 30.minutes
+    #     config.enable_components = true
+    #   end
+    def configure
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # Reset configuration to defaults
+    # @return [Configuration] New configuration instance
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Logger instance with fallback
+    # @return [Logger] Logger instance
+    def logger
+      @logger ||= build_logger
+    end
+
+    # Set a custom logger
+    # @param custom_logger [Logger] Custom logger instance
+    def logger=(custom_logger)
+      @logger = custom_logger
+    end
+
+    # Check if Solidstats can run in current environment
+    # @return [Boolean] True if environment is suitable
+    # @raise [ConfigurationError] If environment is not suitable
+    def environment_suitable?
+      unless development?
+        raise ConfigurationError,
+              "Solidstats can only be used in development mode. Current: #{environment || 'unknown'}"
+      end
+
+      true
+    end
+
+    # Get engine instance
+    # @return [Solidstats::Engine] Engine instance
+    def engine
+      Engine
+    end
+
+    # Get asset strategy for current application
+    # @return [Symbol] Asset strategy (:sprockets, :webpacker, :importmap, :auto)
+    def asset_strategy
+      return configuration.assets[:strategy] if configuration.assets[:strategy] != :auto
+
+      # Auto-detect asset strategy
+      if defined?(Importmap) && File.exist?(Rails.root.join("config/importmap.rb"))
+        :importmap
+      elsif defined?(Webpacker) && File.exist?(Rails.root.join("config/webpacker.yml"))
+        :webpacker
+      elsif defined?(Sprockets)
+        :sprockets
+      else
+        :none
+      end
+    end
+
+    # Check if assets should be fingerprinted
+    # @return [Boolean] True if fingerprinting is enabled
+    def asset_fingerprinting?
+      configuration.assets[:fingerprint] && !Rails.env.development?
+    end
+
+    # Get the asset prefix for engine assets
+    # @return [String] Asset prefix
+    def asset_prefix
+      case asset_strategy
+      when :importmap, :sprockets
+        "solidstats"
+      when :webpacker
+        "solidstats"
+      else
+        "solidstats"
+      end
+    end
+
+    private
+
+    # Build appropriate logger based on environment
+    # @return [Logger] Logger instance
+    def build_logger
+      if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+        Rails.logger
+      else
+        require "logger"
+        Logger.new($stdout, level: Logger::INFO).tap do |log|
+          log.formatter = proc do |severity, datetime, progname, msg|
+            "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}] #{severity}: #{msg}\n"
+          end
+        end
+      end
+    end
+  end
+
+  # Configuration class for Solidstats gem
+  class Configuration
+    # @!attribute [rw] cache_duration
+    #   @return [ActiveSupport::Duration] Cache duration for services
+    attr_accessor :cache_duration
+
+    # @!attribute [rw] enable_components
+    #   @return [Boolean] Whether to enable ViewComponent integration
+    attr_accessor :enable_components
+
+    # @!attribute [rw] log_level
+    #   @return [Symbol] Logging level
+    attr_accessor :log_level
+
+    # @!attribute [rw] enable_previews
+    #   @return [Boolean] Whether to enable component previews
+    attr_accessor :enable_previews
+
+    # @!attribute [rw] preview_layout
+    #   @return [String] Layout for component previews
+    attr_accessor :preview_layout
+
+    # @!attribute [rw] assets
+    #   @return [Hash] Asset configuration options
+    attr_accessor :assets
+
+    # @!attribute [rw] css_framework
+    #   @return [Symbol] CSS framework integration (:none, :bootstrap, :tailwind)
+    attr_accessor :css_framework
+
+    def initialize
+      set_defaults
+    end
+
+    # Check if components are enabled and available
+    # @return [Boolean] True if components can be used
+    def components_enabled?
+      @enable_components && Solidstats.view_component_available?
+    end
+
+    # Check if previews are enabled
+    # @return [Boolean] True if previews should be shown
+    def previews_enabled?
+      @enable_previews && Solidstats.development?
+    end
+
+    # Validate configuration
+    # @return [Boolean] True if configuration is valid
+    # @raise [ConfigurationError] If configuration is invalid
+    def validate!
+      unless cache_duration.respond_to?(:seconds)
+        raise ConfigurationError, "cache_duration must be a time duration"
+      end
+
+      unless [ :debug, :info, :warn, :error, :fatal, :unknown ].include?(@log_level)
+        raise ConfigurationError, "log_level must be a valid log level symbol"
+      end
+
+      true
+    end
+
+    private
+
+    def set_defaults
+      @cache_duration = 1.hour
+      @enable_components = true
+      @log_level = :info
+      @enable_previews = true
+      @preview_layout = "solidstats/component_preview"
+      @assets = {
+        fingerprint: true,
+        strategy: :auto,
+        precompile: true,
+        compile_on_demand: Rails.env.development?
+      }
+      @css_framework = :none
+    end
+  end
+end
+
+# Auto-require common dependencies if in Rails environment
+if defined?(Rails) && Rails.env.development?
+  # Ensure ViewComponent is available
+  Solidstats.ensure_view_component!
+
+  # Auto-require core services that are commonly used
+  begin
+    require_relative "solidstats/gem_metadata/fetcher_service" if
+      File.exist?(File.join(__dir__, "solidstats/gem_metadata/fetcher_service.rb"))
+  rescue LoadError => e
+    Solidstats.logger.debug "[Solidstats] Could not auto-load services: #{e.message}"
   end
 end

data/lib/tasks/solidstats_install.rake

@@ -1,8 +1,19 @@
 
+# frozen_string_literal: true
+
 namespace :solidstats do
-  desc "Install Solidstats into your Rails application"
+  desc "Install Solidstats in the current Rails application"
   task :install do
-    if system "rails g solidstats:install"
+    puts "🚀 Installing Solidstats..."
+
+    # Check Rails environment
+    unless Rails.env.development?
+      puts "⚠️  Warning: Solidstats is designed for development environments."
+      puts "Current environment: #{Rails.env}"
+    end
+
+    # Run the generator
+    if system("rails generate solidstats:install")
       puts "\n✅ Solidstats installation completed successfully!"
       puts "   Start your Rails server and visit http://localhost:3000/solidstats\n\n"
     else
@@ -10,4 +21,113 @@ namespace :solidstats do
       puts "   bundle exec rails generate solidstats:install\n\n"
     end
   end
+
+  desc "Validate Solidstats installation and configuration"
+  task validate: :environment do
+    puts "🔍 Validating Solidstats installation..."
+
+    begin
+      # Check basic configuration
+      Solidstats.configuration
+      puts "✅ Configuration loaded"
+
+      # Check ViewComponent availability
+      if Solidstats.view_component_available?
+        version = defined?(ViewComponent::VERSION) ? ViewComponent::VERSION : "unknown"
+        puts "✅ ViewComponent available (#{version})"
+      else
+        puts "❌ ViewComponent not available"
+      end
+
+      # Check asset strategy
+      strategy = Solidstats.asset_strategy
+      puts "✅ Asset strategy: #{strategy}"
+
+      # Validate asset manifest
+      Solidstats::AssetManifest.validate_assets!
+      puts "✅ All required assets present"
+
+      # Check routes
+      if Rails.application.routes.routes.any? { |r| r.path.spec.to_s.include?("solidstats") }
+        puts "✅ Routes mounted"
+      else
+        puts "⚠️  Routes not mounted - add 'mount Solidstats::Engine => \"/solidstats\"' to config/routes.rb"
+      end
+
+      puts "\n🎉 Solidstats validation complete!"
+
+    rescue => e
+      puts "❌ Validation failed: #{e.message}"
+      exit 1
+    end
+  end
+
+  desc "Show asset configuration information"
+  task assets: :environment do
+    puts "📦 Solidstats Asset Configuration"
+    puts "=" * 40
+
+    puts "Asset Strategy: #{Solidstats.asset_strategy}"
+    puts "Fingerprinting: #{Solidstats.asset_fingerprinting?}"
+    puts "Asset Prefix: #{Solidstats.asset_prefix}"
+
+    puts "\nPrecompiled Assets:"
+    Solidstats::AssetManifest.assets_for_environment.each do |asset|
+      puts "  • #{asset}"
+    end
+
+    if Rails.application.config.respond_to?(:assets)
+      puts "\nAsset Paths:"
+      Rails.application.config.assets.paths.select { |p| p.include?("solidstats") }.each do |path|
+        puts "  • #{path}"
+      end
+    end
+  end
+
+  desc "Test asset compilation"
+  task compile_assets: :environment do
+    puts "🔧 Testing asset compilation..."
+
+    begin
+      test_assets = [ "solidstats/application.css", "solidstats/application.js" ]
+
+      if Rails.application.config.respond_to?(:assets)
+        manifest = Rails.application.assets
+
+        # Check if we're using Propshaft (Rails 7+) or Sprockets
+        if manifest.respond_to?(:find_asset)
+          # Sprockets
+          test_assets.each do |asset|
+            if manifest.find_asset(asset)
+              puts "✅ #{asset} - found and compilable (Sprockets)"
+            else
+              puts "❌ #{asset} - not found (Sprockets)"
+            end
+          end
+        elsif manifest.respond_to?(:load_path) && manifest.load_path.respond_to?(:find)
+          # Propshaft
+          test_assets.each do |asset|
+            if manifest.load_path.find(asset)
+              puts "✅ #{asset} - found and compilable (Propshaft)"
+            else
+              puts "❌ #{asset} - not found (Propshaft)"
+            end
+          end
+        else
+          # Unknown asset pipeline
+          puts "⚠️  Unknown asset pipeline type: #{manifest.class}"
+          puts "Available methods: #{manifest.methods.grep(/find/).join(', ')}"
+        end
+      else
+        puts "⚠️  No asset pipeline detected"
+      end
+
+      puts "✅ Asset compilation test complete"
+
+    rescue => e
+      puts "❌ Asset compilation failed: #{e.message}"
+      puts "Asset pipeline class: #{Rails.application.assets.class}" if Rails.application.respond_to?(:assets)
+      exit 1
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidstats
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MezbahAlam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2025-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: 'View local project health: security dashboard with vulnerability analysis,
   gem impact assessment, code quality metrics, and project task tracking.'
 email:
@@ -50,15 +64,80 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/solidstats/application.js
+- app/assets/javascripts/solidstats/dashboard.js
+- app/assets/javascripts/solidstats/gem_metadata.js
 - app/assets/stylesheets/solidstats/application.css
+- app/assets/stylesheets/solidstats/components/action_button.css
+- app/assets/stylesheets/solidstats/components/dashboard.css
+- app/assets/stylesheets/solidstats/components/dashboard_header.css
+- app/assets/stylesheets/solidstats/components/dashboard_layout.css
+- app/assets/stylesheets/solidstats/components/gem_metadata.css
+- app/assets/stylesheets/solidstats/components/navigation.css
+- app/assets/stylesheets/solidstats/components/quick_navigation.css
+- app/assets/stylesheets/solidstats/components/security.css
+- app/assets/stylesheets/solidstats/components/status_badge.css
+- app/assets/stylesheets/solidstats/components/summary_card.css
+- app/assets/stylesheets/solidstats/components/tab_navigation.css
+- app/components/solidstats/base_component.rb
+- app/components/solidstats/code_quality/code_quality_section_component.html.erb
+- app/components/solidstats/code_quality/code_quality_section_component.rb
+- app/components/solidstats/code_quality/section_component.html.erb
+- app/components/solidstats/code_quality/section_component.rb
+- app/components/solidstats/dashboard_header_component.html.erb
+- app/components/solidstats/dashboard_header_component.rb
+- app/components/solidstats/previews/action_button_component_preview.rb
+- app/components/solidstats/previews/action_button_component_preview/button_vs_link.html.erb
+- app/components/solidstats/previews/action_button_component_preview/sizes.html.erb
+- app/components/solidstats/previews/action_button_component_preview/variants.html.erb
+- app/components/solidstats/previews/action_button_component_preview/with_icons.html.erb
+- app/components/solidstats/previews/navigation_component_preview.rb
+- app/components/solidstats/previews/stats_overview_component_preview.rb
+- app/components/solidstats/previews/status_badge_component_preview.rb
+- app/components/solidstats/previews/status_badge_component_preview/sizes.html.erb
+- app/components/solidstats/previews/status_badge_component_preview/statuses.html.erb
+- app/components/solidstats/previews/status_badge_component_preview/with_icons.html.erb
+- app/components/solidstats/previews/summary_card_component_preview.rb
+- app/components/solidstats/previews/summary_card_component_preview/clickable.html.erb
+- app/components/solidstats/previews/summary_card_component_preview/dashboard_layout.html.erb
+- app/components/solidstats/previews/summary_card_component_preview/statuses.html.erb
+- app/components/solidstats/previews/summary_card_component_preview/value_formats.html.erb
+- app/components/solidstats/quick_navigation_component.html.erb
+- app/components/solidstats/quick_navigation_component.rb
+- app/components/solidstats/security/gem_impact_analysis_component.html.erb
+- app/components/solidstats/security/gem_impact_analysis_component.rb
+- app/components/solidstats/security/overview_component.html.erb
+- app/components/solidstats/security/overview_component.rb
+- app/components/solidstats/security/section_component.html.erb
+- app/components/solidstats/security/section_component.rb
+- app/components/solidstats/security/timeline_component.html.erb
+- app/components/solidstats/security/timeline_component.rb
+- app/components/solidstats/tasks_section_component.html.erb
+- app/components/solidstats/tasks_section_component.rb
+- app/components/solidstats/ui/action_button_component.html.erb
+- app/components/solidstats/ui/action_button_component.rb
+- app/components/solidstats/ui/dashboard_layout_component.html.erb
+- app/components/solidstats/ui/dashboard_layout_component.rb
+- app/components/solidstats/ui/navigation_component.html.erb
+- app/components/solidstats/ui/navigation_component.rb
+- app/components/solidstats/ui/stats_overview_component.html.erb
+- app/components/solidstats/ui/stats_overview_component.rb
+- app/components/solidstats/ui/status_badge_component.html.erb
+- app/components/solidstats/ui/status_badge_component.rb
+- app/components/solidstats/ui/summary_card_component.html.erb
+- app/components/solidstats/ui/summary_card_component.rb
+- app/components/solidstats/ui/tab_navigation_component.html.erb
+- app/components/solidstats/ui/tab_navigation_component.rb
 - app/controllers/solidstats/application_controller.rb
 - app/controllers/solidstats/dashboard_controller.rb
+- app/controllers/solidstats/gem_metadata_controller.rb
 - app/helpers/solidstats/application_helper.rb
 - app/jobs/solidstats/application_job.rb
 - app/mailers/solidstats/application_mailer.rb
 - app/models/solidstats/application_record.rb
 - app/services/solidstats/audit_service.rb
 - app/services/solidstats/data_collector_service.rb
+- app/services/solidstats/gem_metadata/fetcher_service.rb
 - app/services/solidstats/log_size_monitor_service.rb
 - app/services/solidstats/todo_service.rb
 - app/views/layouts/solidstats/application.html.erb
@@ -73,10 +152,26 @@ files:
 - app/views/solidstats/dashboard/audit/_vulnerabilities_table.html.erb
 - app/views/solidstats/dashboard/audit/_vulnerability_details.html.erb
 - app/views/solidstats/dashboard/index.html.erb
+- app/views/solidstats/gem_metadata/_panel.html.erb
 - config/routes.rb
+- lib/generators/solidstats/feature/feature_generator.rb
+- lib/generators/solidstats/feature/templates/component.html.erb
+- lib/generators/solidstats/feature/templates/component.rb.erb
+- lib/generators/solidstats/feature/templates/component.scss
+- lib/generators/solidstats/feature/templates/component_test.rb.erb
+- lib/generators/solidstats/feature/templates/controller.rb.erb
+- lib/generators/solidstats/feature/templates/controller_test.rb.erb
+- lib/generators/solidstats/feature/templates/detail_view.html.erb
+- lib/generators/solidstats/feature/templates/preview.rb.erb
+- lib/generators/solidstats/feature/templates/service.rb.erb
+- lib/generators/solidstats/feature/templates/service_test.rb.erb
 - lib/generators/solidstats/install/install_generator.rb
 - lib/generators/solidstats/install/templates/README
+- lib/generators/solidstats/install_generator.rb
+- lib/generators/solidstats/templates/initializer.rb
 - lib/solidstats.rb
+- lib/solidstats/asset_compatibility.rb
+- lib/solidstats/asset_manifest.rb
 - lib/solidstats/engine.rb
 - lib/solidstats/version.rb
 - lib/tasks/solidstats_install.rake