no_fly_list 0.6.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f1516f63b4ece62151501ea60f15ae1d5c2c3ea5738f22881ad5e2456a74b68
-  data.tar.gz: c9b88ce48a93a03fd21ade6eccfb0210e788c26ea78150ce92ee5ecf5f0ce8b0
+  metadata.gz: 9fb7865780acd9586b0ff700686a1546a4c294f9fc3d7a71fe47f2fb7a6def0c
+  data.tar.gz: be5186e8116c5db42c4aa4e3536ab4343b95967f5cd05dcfb64c8f99ebb85270
 SHA512:
-  metadata.gz: ea013a28e4c1246f511ae736951a89a2c292668a6d3ce1ecbf2ada940cee52576144f5de4cfebd2f10a38feb3a80f94082cc1d6ab340d692fe14f75e329b0913
-  data.tar.gz: 9b714d9919bcf14c9fda34bada054f49af0202ab1189f0e487f38d1140df4f27e5580ef3b737adf0a59efc55e19bf381f74cdf2ccdeeb2fcf73d3a49b8135049
+  metadata.gz: 630d2aa00cc4b2465321d1040697cff6c54124247275a0b75677d70653fe347ec1c0ad7e9c573dea060de07be1de02977f1ff6f467bfe1465299a1f764e35325
+  data.tar.gz: 1201844673a3893a3c760ab1fc88ed6826839d799bca6a93b17c2c3e802fa4e9df4d485bdc5511cec4c7cbf2bdcc3cba9cfd1280970d58b5eaa93492f7ece67a

data/lib/generators/no_fly_list/install_generator.rb

@@ -39,14 +39,19 @@ module NoFlyList
 
       def connection_abstract_class_name
         # should be abstract class name
-        ActiveRecord::Base.descendants.find do |klass|
+        klass = ActiveRecord::Base.descendants.find do |klass|
           klass.abstract_class? && klass.connection_db_config.name == connection_name
-        end.name
+        end
+        klass&.name || "ApplicationRecord"
       end
 
       def migration_version
         "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
       end
+
+      def migration_class_name
+        "CreateApplicationTaggingTable"
+      end
     end
   end
 end

data/lib/generators/no_fly_list/models_generator.rb

@@ -36,18 +36,17 @@ module NoFlyList
         if model_class < ActiveRecord::Base
           true
         else
-          say "#{class_name} is not an ActiveRecord model. Aborting generator.", :red
-          false
+          raise ArgumentError, "#{class_name} is not an ActiveRecord model. Aborting generator."
         end
       rescue NameError
-        say "#{class_name} is not a valid constant. Aborting generator.", :red
-        false
+        raise ArgumentError, "#{class_name} is not a valid constant. Aborting generator."
       end
 
       def model_abstract_class_name
-        model_class.ancestors.find do |klass|
-          klass.is_a?(Class) && klass.abstract_class?
-        end.name
+        klass = model_class.ancestors.find do |ancestor|
+          ancestor.is_a?(Class) && ancestor.abstract_class?
+        end
+        klass&.name || "ApplicationRecord"
       end
     end
   end

data/lib/generators/no_fly_list/tagging_generator.rb

@@ -9,6 +9,7 @@ module NoFlyList
   module Generators
     class TaggingGenerator < Rails::Generators::NamedBase
       include ActiveRecord::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
 
       class_option :database, type: :string, default: "primary",
                               desc: "Use different database for migration"

data/lib/generators/no_fly_list/transformer_generator.rb

@@ -5,15 +5,14 @@ require "rails/generators"
 require "rails/generators/active_record"
 require "rails/generators/named_base"
 
-unless defined?(ApplicationTagTransformer)
-  module NoFlyList
-    module Generators
-      # bin/rails g no_fly_list:transformer
-      class TransformerGenerator < Rails::Generators::Base
-        source_root File.expand_path("templates", __dir__)
-        def create_tag_transformer_file
-          template "tag_transformer.rb", File.join("app/transformers", "application_tag_transformer.rb")
-        end
+module NoFlyList
+  module Generators
+    # bin/rails g no_fly_list:transformer
+    class TransformerGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_tag_transformer_file
+        template "tag_transformer.rb", File.join("app/transformers", "application_tag_transformer.rb")
       end
     end
   end

data/lib/no_fly_list/default_transformer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NoFlyList
+  module DefaultTransformer
+    module_function
+
+    # @param [String, Array<String>] tags
+    def parse_tags(tags)
+      tags = recreate_string(tags) if tags.is_a?(Array)
+      tags.split(separator).map(&:strip)
+    end
+
+    # Recreate a string from an array of tags
+    # @param [Array<String>] tags
+    # @return [String]
+    def recreate_string(tags)
+      tags.join(separator)
+    end
+
+    # @return [String]
+    def separator
+      ","
+    end
+  end
+end

data/lib/no_fly_list/railties/tasks.rake

@@ -20,7 +20,7 @@ namespace :no_fly_list do
 
     classes.each do |klass|
       color = NoFlyList::TaskHelpers.adapter_color(klass)
-      type = klass.included_modules.include?(NoFlyList::ApplicationTag) ? 'Global' : 'Model-specific'
+      type = klass.included_modules.include?(NoFlyList::ApplicationTag) ? "Global" : "Model-specific"
 
       puts "#{color}#{klass.name}#{NoFlyList::TaskHelpers::COLORS[:reset]}"
       puts "  Type: #{type}"
@@ -42,8 +42,8 @@ namespace :no_fly_list do
       puts "  #{message}"
 
       [
-        ["#{klass.name}Tag", "Tags", :tag],
-        ["#{klass.name}::Tagging", "Taggings", :tagging]
+        [ "#{klass.name}Tag", "Tags", :tag ],
+        [ "#{klass.name}::Tagging", "Taggings", :tagging ]
       ].each do |class_name, type, column_type|
         if (check_class = NoFlyList::TaskHelpers.check_class(class_name))
           status, message = NoFlyList::TaskHelpers.check_table(check_class)
@@ -53,13 +53,13 @@ namespace :no_fly_list do
             puts "  #{NoFlyList::TaskHelpers.format_columns(check_class)}"
           end
         else
-          puts "  #{NoFlyList::TaskHelpers::colorize('✗', :red)} #{type} class not found: #{class_name}"
+          puts "  #{NoFlyList::TaskHelpers.colorize('✗', :red)} #{type} class not found: #{class_name}"
         end
       end
 
       klass._no_fly_list.tag_contexts.each do |context, config|
         puts "\n  Context: #{context}"
-        bullet = NoFlyList::TaskHelpers::colorize('•', :green)
+        bullet = NoFlyList::TaskHelpers.colorize("•", :green)
         puts "  #{bullet} Tag class: #{config[:tag_class_name]}"
         puts "  #{bullet} Tagging class: #{config[:tagging_class_name]}"
         puts "  #{bullet} Polymorphic: #{config[:polymorphic]}"

data/lib/no_fly_list/taggable_record/config.rb

@@ -19,7 +19,7 @@ module NoFlyList
         taggable_class: @taggable_class.to_s,
         tag_class_name: tag_class_name,
         tagging_class_name: tagging_class_name,
-        transformer: options.fetch(:transformer, ApplicationTagTransformer).to_s,
+        transformer: options.fetch(:transformer, "ApplicationTagTransformer").to_s,
         polymorphic: options.fetch(:polymorphic, false),
         restrict_to_existing: options.fetch(:restrict_to_existing, false),
         limit: options.fetch(:limit, nil),

data/lib/no_fly_list/taggable_record/tag_setup.rb

@@ -41,7 +41,7 @@ module NoFlyList
       def initialize(taggable_klass, context, options = {})
         @taggable_klass = taggable_klass
         @context = context
-        @transformer = options.fetch(:transformer, ApplicationTagTransformer)
+        @transformer = options.fetch(:transformer, "ApplicationTagTransformer")
         @polymorphic = options.fetch(:polymorphic, false)
         @restrict_to_existing = options.fetch(:restrict_to_existing, false)
         @counter_cache = options.fetch(:counter_cache, false)

data/lib/no_fly_list/tagging_proxy.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module NoFlyList
   class TaggingProxy
     include Enumerable
@@ -21,23 +19,37 @@ module NoFlyList
     # @param restrict_to_existing [Boolean] Only allow existing tags
     # @param limit [Integer, nil] Maximum number of tags allowed
     def initialize(model, tag_model, context,
-                   transformer: ApplicationTagTransformer,
+                   transformer: "ApplicationTagTransformer",
                    restrict_to_existing: false,
                    limit: nil)
       @model = model
       @tag_model = tag_model
       @context = context
-      @transformer = transformer.is_a?(String) ? transformer.constantize : transformer
+      @transformer = resolve_transformer(transformer)
       @restrict_to_existing = restrict_to_existing
       @limit = limit
-      @pending_changes = []
+      @pending_changes = nil # Use nil to indicate no changes yet
+      @clear_operation = false
+    end
+
+    def resolve_transformer(trans)
+      const = trans
+      const = const.constantize if const.is_a?(String)
+      unless const.respond_to?(:parse_tags) && const.respond_to?(:recreate_string)
+        warn "NoFlyList: transformer #{trans.inspect} is invalid. Falling back to DefaultTransformer"
+        const = NoFlyList::DefaultTransformer
+      end
+      const
+    rescue NameError
+      warn "NoFlyList: transformer #{trans.inspect} not found. Falling back to DefaultTransformer"
+      NoFlyList::DefaultTransformer
     end
 
     # Determines if tags have changed from database state
     # @return [Boolean] True if pending changes differ from database
     # @api private
     def changed?
-      @pending_changes.present? && @pending_changes != current_list_from_database
+      @clear_operation || (!@pending_changes.nil? && @pending_changes != current_list_from_database)
     end
 
     def method_missing(method_name, *args)
@@ -73,7 +85,7 @@ module NoFlyList
 
     # @return [Boolean] true if the proxy is valid
     def save
-      return true unless @pending_changes.any?
+      return true unless changed?
       return false unless valid?
 
       # Prevent recursive validation
@@ -92,8 +104,9 @@ module NoFlyList
 
           # Update counter
           model.update_column("#{@context}_count", 0) if setup[:counter_cache]
+
           # Create new tags
-          @pending_changes.each do |tag_name|
+          pending_list.each do |tag_name|
             tag = find_or_create_tag(tag_name)
             next unless tag
 
@@ -112,7 +125,7 @@ module NoFlyList
           end
         end
         # Update counter to match the actual count
-        model.update_column("#{@context}_count", @pending_changes.size) if setup[:counter_cache]
+        model.update_column("#{@context}_count", pending_list.size) if setup[:counter_cache]
 
         refresh_from_database
         true
@@ -133,15 +146,22 @@ module NoFlyList
 
     # @return [Integer]
     def count
+      # Always return the database count for count operations
       @model.send(@context.to_s).count
     end
 
     # @return [Integer]
     def size
-      if @pending_changes.any?
+      # For size, return the database count if we've had a validation error
+      if !valid?
+        count
+        # Otherwise show pending changes
+      elsif @clear_operation
+        0
+      elsif !@pending_changes.nil?
         @pending_changes.size
       else
-        @model.send(@context.to_s).size
+        count
       end
     end
 
@@ -160,9 +180,44 @@ module NoFlyList
       @transformer_name ||= transformer.name
     end
 
+    # Returns tags that will be added (not in database but in pending changes)
+    # @return [Array<String>] Tags to be added
+    def additions
+      return [] if @clear_operation
+      return [] if @pending_changes.nil?
+
+      @pending_changes - current_list_from_database
+    end
+
+    # Returns tags that will be removed (in database but not in pending changes)
+    # @return [Array<String>] Tags to be removed
+    def removals
+      if @clear_operation
+        current_list_from_database
+      elsif @pending_changes.nil?
+        []
+      else
+        current_list_from_database - @pending_changes
+      end
+    end
+
     # @return [String]
     def inspect
-      "#<#{self.class.name} tags=#{current_list.inspect} transformer_with=#{transformer_name} >"
+      if @clear_operation
+        db_tags = current_list_from_database
+        "#<#{self.class.name} tags=[] changes=[CLEARING ALL (#{db_tags.size}): #{db_tags.inspect}] transformer_with=#{transformer_name}>"
+      elsif !@pending_changes.nil?
+        add_list = additions
+        remove_list = removals
+        changes = []
+        changes << "+#{add_list.inspect}" if add_list.any?
+        changes << "-#{remove_list.inspect}" if remove_list.any?
+        changes_str = changes.join(", ")
+
+        "#<#{self.class.name} tags=#{current_list.inspect} changes=[#{changes_str}] transformer_with=#{transformer_name}>"
+      else
+        "#<#{self.class.name} tags=#{current_list.inspect} transformer_with=#{transformer_name}>"
+      end
     end
 
     # Adds one or more tags to the current tag list
@@ -174,6 +229,7 @@ module NoFlyList
     def add(*tags)
       return self if limit_reached?
 
+      @clear_operation = false
       new_tags = if tags.size == 1 && tags.first.is_a?(String)
                    transformer.parse_tags(tags.first)
       else
@@ -181,8 +237,12 @@ module NoFlyList
       end
       return self if new_tags.empty?
 
-      @pending_changes = current_list + new_tags
+      # Initialize @pending_changes with database values if not yet initialized
+      @pending_changes = current_list_from_database if @pending_changes.nil?
+
+      @pending_changes = @pending_changes + new_tags
       @pending_changes.uniq!
+      mark_record_dirty
       self
     end
 
@@ -199,13 +259,20 @@ module NoFlyList
     # @return [TaggingProxy] Returns self for method chaining
     # @raise [ActiveRecord::RecordInvalid] If validation fails
     def remove(*tags)
-      old_list = current_list.dup
+      @clear_operation = false
+
+      # Initialize @pending_changes with database values if not yet initialized
+      @pending_changes = current_list_from_database if @pending_changes.nil?
+
+      old_list = @pending_changes.dup
+
       tags_to_remove = if tags.size == 1 && tags.first.is_a?(String)
                          transformer.parse_tags(tags.first)
       else
                          tags.flatten.map { |tag| tag.to_s.strip }
       end
-      @pending_changes = current_list - tags_to_remove
+
+      @pending_changes = @pending_changes - tags_to_remove
       mark_record_dirty if @pending_changes != old_list
       self
     end
@@ -220,9 +287,9 @@ module NoFlyList
     # @example Clear all tags
     #   tags.clear #=> []
     def clear
-      old_list = current_list.dup
+      @clear_operation = true
       @pending_changes = []
-      mark_record_dirty if @pending_changes != old_list
+      mark_record_dirty if current_list_from_database.any?
       model.write_attribute("#{@context}_count", 0) if setup[:counter_cache]
       self
     end
@@ -235,6 +302,7 @@ module NoFlyList
     def clear!
       @model.send(@context.to_s).destroy_all
       @pending_changes = []
+      @clear_operation = false
       @model.update_column("#{@context}_count", 0) if setup[:counter_cache]
       self
     end
@@ -276,7 +344,9 @@ module NoFlyList
     end
 
     def set_list(_context, value)
+      @clear_operation = false
       @pending_changes = transformer.parse_tags(value)
+      mark_record_dirty
       valid? # Just check validity without raising
       self
     end
@@ -286,24 +356,25 @@ module NoFlyList
     end
 
     def refresh_from_database
-      @pending_changes = []
+      @pending_changes = nil
+      @clear_operation = false
     end
 
     def validate_limit
       return unless @limit
-      return if @pending_changes.size <= @limit
+      return if pending_list.size <= @limit
 
-      errors.add(:base, "Cannot have more than #{@limit} tags (attempting to save #{@pending_changes.size})")
+      errors.add(:base, "Cannot have more than #{@limit} tags (attempting to save #{pending_list.size})")
     end
 
     def validate_existing_tags
       return unless @restrict_to_existing
-      return if @pending_changes.empty?
+      return if pending_list.empty?
 
       # Transform tags to lowercase for comparison
-      normalized_changes = @pending_changes.map(&:downcase)
+      normalized_changes = pending_list.map(&:downcase)
       existing_tags = @tag_model.where("LOWER(name) IN (?)", normalized_changes).pluck(:name)
-      missing_tags = @pending_changes - existing_tags
+      missing_tags = pending_list - existing_tags
 
       return unless missing_tags.any?
 
@@ -316,9 +387,9 @@ module NoFlyList
 
     def setup
       @setup ||= begin
-        context = @context.to_sym
-        @model.class._no_fly_list.tag_contexts[context]
-      end
+                   context = @context.to_sym
+                   @model.class._no_fly_list.tag_contexts[context]
+                 end
     end
 
     def find_or_create_tag(tag_name)
@@ -329,36 +400,24 @@ module NoFlyList
       end
     end
 
-    def save_changes
-      # Clear existing tags
-      model.send(context_taggings).delete_all
-
-      # Create new tags
-      @pending_changes.each do |tag_name|
-        tag = find_or_create_tag(tag_name)
-        next unless tag
-
-        attributes = {
-          tag: tag,
-          context: @context.to_s.singularize
-        }
-
-        # Add polymorphic attributes for polymorphic tags
-        if setup[:polymorphic]
-          attributes[:taggable_type] = model.class.name
-          attributes[:taggable_id] = model.id
-        end
-
-        # Use create! to ensure we catch any errors
-        model.send(context_taggings).create!(attributes)
+    # Helper method to get the list of tags that should be saved
+    def pending_list
+      if @clear_operation
+        []
+      elsif !@pending_changes.nil?
+        @pending_changes
+      else
+        current_list_from_database
       end
-
-      refresh_from_database
-      true
     end
 
     def current_list
-      if @pending_changes.any?
+      # If validation failed, always return what's in the database
+      if errors.any?
+        current_list_from_database
+      elsif @clear_operation
+        []
+      elsif !@pending_changes.nil?
         @pending_changes
       else
         current_list_from_database

data/lib/no_fly_list/task_helpers.rb

@@ -13,8 +13,8 @@ module NoFlyList
     }.freeze
 
     REQUIRED_COLUMNS = {
-      tag: ['name'],
-      tagging: ['tag_id', 'taggable_id', 'context']
+      tag: [ "name" ],
+      tagging: %w[tag_id taggable_id context]
     }.freeze
 
     def self.adapter_color(klass)
@@ -28,9 +28,9 @@ module NoFlyList
 
     def self.check_table(klass)
       klass.table_exists?
-      [true, "#{colorize('✓', :green)} Table exists: #{klass.table_name}"]
+      [ true, "#{colorize('✓', :green)} Table exists: #{klass.table_name}" ]
     rescue StandardError => e
-      [false, "#{colorize('✗', :red)} Error: #{e.message}"]
+      [ false, "#{colorize('✗', :red)} Error: #{e.message}" ]
     end
 
     def self.verify_columns(klass, type)
@@ -61,16 +61,15 @@ module NoFlyList
     def self.find_taggable_classes
       Rails.application.eager_load!
       ActiveRecord::Base.descendants.select do |klass|
-        klass.included_modules.any? { |mod| mod.in?([NoFlyList::TaggableRecord]) }
+        klass.included_modules.any? { |mod| mod.in?([ NoFlyList::TaggableRecord ]) }
       end
     end
 
     def self.find_tag_classes
       Rails.application.eager_load!
       ActiveRecord::Base.descendants.select do |klass|
-        klass.included_modules.any? { |mod| mod.in?([NoFlyList::ApplicationTag, NoFlyList::TagRecord]) }
+        klass.included_modules.any? { |mod| mod.in?([ NoFlyList::ApplicationTag, NoFlyList::TagRecord ]) }
       end
     end
   end
 end
-

data/lib/no_fly_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NoFlyList
-  VERSION = "0.6.0"
+  VERSION = "0.7.2"
 end

data/lib/no_fly_list.rb

@@ -28,6 +28,7 @@ module NoFlyList
 
   autoload :TaggingRecord
   autoload :TagRecord
+  autoload :DefaultTransformer
 
   autoload :TaggingProxy
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: no_fly_list
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,6 +44,7 @@ files:
 - lib/no_fly_list.rb
 - lib/no_fly_list/application_tag.rb
 - lib/no_fly_list/application_tagging.rb
+- lib/no_fly_list/default_transformer.rb
 - lib/no_fly_list/railtie.rb
 - lib/no_fly_list/railties/tasks.rake
 - lib/no_fly_list/tag_record.rb
@@ -67,7 +67,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tagging system for ActiveRecord models
 test_files: []