rails_lens 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6834edcbcafa6ae9100b5d0da80aa6e1c551ccd883788e1247cb2bebf6375773
-  data.tar.gz: a73abcfc14ef3a95c03a590137b4d6ac2403cc2f91d5982f983567d95bd8c95b
+  metadata.gz: db0b169f8f397031eecb4ff3b50a5047f12cf1bc2c1d0929a674f3b0827c7c91
+  data.tar.gz: 5be691de8fce3047e5226f7a5d0e9f12a9410609d3de3a91f43d657dd287d6c2
 SHA512:
-  metadata.gz: bffbfa6cf5189db266ffa2787918033836d3d27ea8aaaeb27bbc8e9f5418f6e39c03e8465a7837febfcda349b56147a967b460c54cb5981edd0741d5554c029f
-  data.tar.gz: c5d2065ff8ddbe5f276413b74b053b1dd604c363931343021ab06b4bcf326ed367343a498b4a22afb4935db9386903834af3219f855b310dde90ceb5b02adfe6
+  metadata.gz: 2c40baa22b05b1c652d3fd3fb617a4d81c2d5349d6aa550dc49c1a7bbd3dfdd74b576151848dc6430e6ad01ff76705000892129b5990a432429dc3a60de4b3d4
+  data.tar.gz: 49900c83dd33dd65ccf0bf0221c130b6363a35d14eafa25403930d0990e445e94cb60d0344b0e0988485a2d4e0acdf165204a0930620b8e8dbf218486a81704a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.2.11](https://github.com/seuros/rails_lens/compare/rails_lens/v0.2.10...rails_lens/v0.2.11) (2025-11-24)
+
+
+### Features
+
+* add install command for automatic post-migration annotation ([#28](https://github.com/seuros/rails_lens/issues/28)) ([873fcdc](https://github.com/seuros/rails_lens/commit/873fcdcb4ca481273f71068824d066557f3cc38b))
+
+
+### Bug Fixes
+
+* replace deprecated ActiveSupport::Configurable and update CI to Rails 8.1 ([#26](https://github.com/seuros/rails_lens/issues/26)) ([b540214](https://github.com/seuros/rails_lens/commit/b540214afd25e0313ee2772e6c65d81bae68cb64))
+
 ## [0.2.10](https://github.com/seuros/rails_lens/compare/rails_lens/v0.2.9...rails_lens/v0.2.10) (2025-10-17)
 
 

data/README.md

@@ -117,6 +117,20 @@ bundle install
 
 ## Usage
 
+### Quick Setup (Recommended)
+
+Install automatic annotation after migrations:
+
+```bash
+bundle exec rails_lens install
+```
+
+This creates `lib/tasks/rails_lens.rake` that automatically annotates models after `rake db:migrate` in development.
+
+**Configuration:**
+- `AUTO_ANNOTATE=false` - Disable auto-annotation
+- `RAILS_LENS_ENV=test,development` - Environments where it runs (default: development only)
+
 ### Annotate Models
 
 ```bash

data/lib/rails_lens/cli.rb

@@ -124,6 +124,15 @@ module RailsLens
       end
     end
 
+    desc 'install', 'Install Rails Lens rake tasks for automatic annotation'
+    option :force, type: :boolean, desc: 'Overwrite existing rake task file'
+    def install
+      with_error_handling do
+        commands = Commands.new(self)
+        commands.install(options)
+      end
+    end
+
     private
 
     def setup_environment

data/lib/rails_lens/commands.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module RailsLens
   # Handles the actual execution of CLI commands
   class Commands
@@ -160,5 +162,116 @@ module RailsLens
         output.say 'Available: show, set, reset'
       end
     end
+
+    def install(options = {})
+      output.say 'Installing Rails Lens rake tasks...', :blue
+
+      # Determine Rails root
+      rails_root = if defined?(Rails) && Rails.respond_to?(:root) && Rails.root
+                     Rails.root.to_s
+                   else
+                     Dir.pwd
+                   end
+      tasks_dir = File.join(rails_root, 'lib', 'tasks')
+      rake_file = File.join(tasks_dir, 'rails_lens.rake')
+
+      # Check if file exists
+      if File.exist?(rake_file) && !options[:force]
+        output.say 'Rails Lens rake task already exists at lib/tasks/rails_lens.rake', :yellow
+        output.say 'Use --force to overwrite', :yellow
+        return { installed: false, path: rake_file }
+      end
+
+      # Create lib/tasks directory if it doesn't exist
+      FileUtils.mkdir_p(tasks_dir) unless Dir.exist?(tasks_dir)
+
+      # Write the rake task
+      File.write(rake_file, rake_task_template)
+
+      output.say "Created rake task at #{rake_file}", :green
+      output.say '', :reset
+      output.say 'The following task has been installed:', :blue
+      output.say '  • rails_lens:annotate - Annotate models after migrations', :green
+      output.say '', :reset
+      output.say 'Configuration options in lib/tasks/rails_lens.rake:', :blue
+      output.say '  • AUTO_ANNOTATE (default: true in development)', :cyan
+      output.say '  • RAILS_LENS_ENV (default: development)', :cyan
+      output.say '', :reset
+      output.say 'Disable auto-annotation:', :blue
+      output.say '  export AUTO_ANNOTATE=false', :cyan
+
+      { installed: true, path: rake_file }
+    end
+
+    private
+
+    def rake_task_template
+      <<~RAKE
+        # frozen_string_literal: true
+
+        # Rails Lens automatic annotation task
+        # Generated by: rails_lens install
+        #
+        # This task automatically annotates models after running migrations.
+        # It only runs in development by default to avoid slowing down CI/production deploys.
+        #
+        # Environment variables:
+        #   AUTO_ANNOTATE=false - Disable automatic annotation
+        #   RAILS_LENS_ENV=test,development - Environments where annotation runs
+
+        namespace :rails_lens do
+          desc 'Annotate models with schema information'
+          task annotate: :environment do
+            # Check if auto-annotation is enabled
+            auto_annotate = ENV.fetch('AUTO_ANNOTATE', 'true')
+            if auto_annotate == 'false'
+              puts 'Rails Lens: Auto-annotation disabled (AUTO_ANNOTATE=false)'
+              next
+            end
+
+            # Check if we're in an allowed environment
+            allowed_envs = ENV.fetch('RAILS_LENS_ENV', 'development').split(',').map(&:strip)
+            unless allowed_envs.include?(Rails.env)
+              puts "Rails Lens: Skipping annotation in \#{Rails.env} environment"
+              next
+            end
+
+            puts 'Rails Lens: Annotating models...'
+            begin
+              # Use RailsLens directly if available
+              if defined?(RailsLens)
+                results = RailsLens::Schema::AnnotationManager.annotate_all
+                puts "Rails Lens: Annotated \#{results[:annotated].length} models"
+                puts "Rails Lens: Skipped \#{results[:skipped].length} models" if results[:skipped].any?
+              else
+                # Fallback to CLI
+                system('bundle exec rails_lens annotate --quiet')
+              end
+            rescue StandardError => e
+              warn "Rails Lens: Annotation failed: \#{e.message}"
+              warn 'Rails Lens: Set AUTO_ANNOTATE=false to disable auto-annotation'
+            end
+          end
+        end
+
+        # Hook into db:migrate
+        if Rake::Task.task_defined?('db:migrate')
+          Rake::Task['db:migrate'].enhance do
+            Rake::Task['rails_lens:annotate'].invoke if defined?(Rails)
+          rescue StandardError => e
+            warn "Rails Lens hook failed: \#{e.message}"
+          end
+        end
+
+        # Hook into db:rollback
+        if Rake::Task.task_defined?('db:rollback')
+          Rake::Task['db:rollback'].enhance do
+            Rake::Task['rails_lens:annotate'].invoke if defined?(Rails)
+          rescue StandardError => e
+            warn "Rails Lens hook failed: \#{e.message}"
+          end
+        end
+      RAKE
+    end
   end
 end

data/lib/rails_lens/configuration.rb

@@ -1,93 +1,88 @@
 # frozen_string_literal: true
 
 module RailsLens
-  module Configuration
-    extend ActiveSupport::Concern
+  class Config
+    attr_accessor :verbose, :debug, :raise_on_error, :logger,
+                  :annotations, :erd, :schema, :extensions, :routes, :mailers
 
-    included do
-      # Add configuration for error handling
-      config_accessor :verbose, default: false
-      config_accessor :debug, default: false
-      config_accessor :raise_on_error, default: false
+    def initialize
+      @verbose = false
+      @debug = false
+      @raise_on_error = false
+      @logger = nil
 
-      # Logger configuration
-      config_accessor :logger
+      @annotations = {
+        position: :before,
+        format: :rdoc
+      }
 
-      # Configuration using ActiveSupport::Configurable
-      config_accessor :annotations do
-        {
-          position: :before,
-          format: :rdoc
-        }
-      end
+      @erd = {
+        output_dir: 'doc/erd',
+        orientation: 'TB',
+        theme: true,
+        default_colors: %w[
+          lightblue
+          lightcoral
+          lightgreen
+          lightyellow
+          plum
+          lightcyan
+          lightgray
+        ]
+      }
 
-      config_accessor :erd do
-        {
-          output_dir: 'doc/erd',
-          orientation: 'TB',
-          theme: true,
-          default_colors: %w[
-            lightblue
-            lightcoral
-            lightgreen
-            lightyellow
-            plum
-            lightcyan
-            lightgray
-          ]
+      @schema = {
+        adapter: :auto,
+        include_notes: true,
+        exclude_tables: nil, # Will use ActiveRecord::SchemaDumper.ignore_tables if nil
+        format_options: {
+          show_defaults: true,
+          show_comments: true,
+          show_foreign_keys: true,
+          show_indexes: true,
+          show_check_constraints: true
         }
-      end
+      }
 
-      config_accessor :schema do
-        {
-          adapter: :auto,
-          include_notes: true,
-          exclude_tables: nil, # Will use ActiveRecord::SchemaDumper.ignore_tables if nil
-          format_options: {
-            show_defaults: true,
-            show_comments: true,
-            show_foreign_keys: true,
-            show_indexes: true,
-            show_check_constraints: true
-          }
-        }
-      end
+      @extensions = {
+        enabled: true,
+        autoload: true,
+        interface_version: '1.0',
+        ignore: [],
+        custom_paths: [],
+        error_reporting: :warn,    # :silent, :warn, :verbose
+        fail_safe_mode: true,      # Continue processing if extensions fail
+        track_health: false        # Track extension success/failure rates
+      }
 
-      config_accessor :extensions do
-        {
-          enabled: true,
-          autoload: true,
-          interface_version: '1.0',
-          ignore: [],
-          custom_paths: [],
-          error_reporting: :warn,    # :silent, :warn, :verbose
-          fail_safe_mode: true,      # Continue processing if extensions fail
-          track_health: false        # Track extension success/failure rates
-        }
-      end
+      @routes = {
+        enabled: true,
+        include_defaults: true,
+        include_constraints: true,
+        pattern: '**/*_controller.rb',
+        exclusion_pattern: 'vendor/**/*_controller.rb'
+      }
 
-      config_accessor :routes do
-        {
-          enabled: true,
-          include_defaults: true,
-          include_constraints: true,
-          pattern: '**/*_controller.rb',
-          exclusion_pattern: 'vendor/**/*_controller.rb'
-        }
-      end
+      @mailers = {
+        enabled: true,
+        include_templates: true,
+        include_delivery_methods: true,
+        include_variables: true,
+        include_locales: true,
+        include_defaults: true,
+        pattern: '**/*_mailer.rb',
+        exclusion_pattern: 'vendor/**/*_mailer.rb'
+      }
+    end
+  end
 
-      config_accessor :mailers do
-        {
-          enabled: true,
-          include_templates: true,
-          include_delivery_methods: true,
-          include_variables: true,
-          include_locales: true,
-          include_defaults: true,
-          pattern: '**/*_mailer.rb',
-          exclusion_pattern: 'vendor/**/*_mailer.rb'
-        }
-      end
+  module Configuration
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config if block_given?
     end
   end
 end

data/lib/rails_lens/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsLens
-  VERSION = '0.2.10'
+  VERSION = '0.2.11'
 end

data/lib/rails_lens.rb

@@ -4,7 +4,6 @@ require 'zeitwerk'
 require 'rails'
 require 'active_record'
 require 'active_support'
-require 'active_support/configurable'
 require 'thor'
 require 'ostruct'
 
@@ -29,8 +28,7 @@ require_relative 'rails_lens/cli'
 require_relative 'rails_lens/configuration'
 
 module RailsLens
-  include ActiveSupport::Configurable
-  include Configuration
+  extend Configuration
 
   class << self
     def logger

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_lens
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Abdelkader Boudih