better_model 1.3.0 → 2.0.0

data/lib/generators/better_model/taggable/taggable_generator.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+
+module BetterModel
+  module Generators
+    class TaggableGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :column_name, type: :string, default: "tags",
+                   desc: "Name of the tags column (default: tags)"
+      class_option :skip_index, type: :boolean, default: false,
+                   desc: "Skip adding GIN index (PostgreSQL only)"
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_migration_file
+        migration_template "migration.rb.tt",
+                          "db/migrate/add_#{column_name}_to_#{table_name}.rb"
+      end
+
+      def show_readme
+        # Display README as template to interpolate variables
+        if behavior == :invoke
+          say "=" * 79, :green
+          say ""
+          say "Taggable column has been added to your model!"
+          say ""
+          say "Next steps:"
+          say ""
+          say "1. Run the migration:"
+          say "   $ bin/rails db:migrate"
+          say ""
+          say "2. Add Taggable configuration to your model:"
+          say ""
+          say "   class #{model_name} < ApplicationRecord"
+          say "     include BetterModel"
+          say ""
+          if postgresql?
+            say "     # PostgreSQL: No additional configuration needed"
+          else
+            say "     # SQLite/MySQL: Add serialization for the tags column"
+            say "     serialize :#{column_name}, coder: JSON, type: Array"
+            say ""
+          end
+          say "     taggable do"
+          say "       tag_field :#{column_name}      # Column name (default: :tags)"
+          say "       normalize true              # Convert to lowercase"
+          say "       strip true                  # Remove whitespace (default)"
+          say "       min_length 2                # Minimum tag length"
+          say "       max_length 30               # Maximum tag length"
+          say "       validates_tags minimum: 1, maximum: 10"
+          say "     end"
+          say "   end"
+          say ""
+          say "3. Usage examples:"
+          say ""
+          say "   # Add tags"
+          say "   #{name.underscore}.tag_with(\"ruby\", \"rails\", \"web\")"
+          say ""
+          say "   # Remove tags"
+          say "   #{name.underscore}.untag(\"web\")"
+          say ""
+          say "   # Replace all tags"
+          say "   #{name.underscore}.retag(\"ruby\", \"api\")"
+          say ""
+          say "   # Check for tag"
+          say "   #{name.underscore}.tagged_with?(\"ruby\")  # => true"
+          say ""
+          say "   # CSV interface"
+          say "   #{name.underscore}.tag_list = \"ruby, rails, tutorial\""
+          say "   #{name.underscore}.tag_list  # => \"ruby, rails, tutorial\""
+          say ""
+          say "   # Search with tags (Predicable integration)"
+          say "   #{model_name}.#{column_name}_contains(\"ruby\")"
+          say "   #{model_name}.#{column_name}_overlaps([\"ruby\", \"python\"])"
+          say "   #{model_name}.#{column_name}_contains_all([\"ruby\", \"rails\"])"
+          say ""
+          say "   # Statistics"
+          say "   #{model_name}.tag_counts                    # => {\"ruby\" => 45, \"rails\" => 38}"
+          say "   #{model_name}.popular_tags(limit: 10)       # => [[\"ruby\", 45], [\"rails\", 38]]"
+          say "   #{model_name}.related_tags(\"ruby\", limit: 5)  # => [\"rails\", \"gem\", \"tutorial\"]"
+          say ""
+          say "For more information, see: docs/taggable.md"
+          say ""
+          say "=" * 79, :green
+        end
+      end
+
+      private
+
+      def table_name
+        name.tableize
+      end
+
+      def model_name
+        name.camelize
+      end
+
+      def migration_class_name
+        "Add#{column_name.camelize}To#{name.camelize.pluralize}"
+      end
+
+      def column_name
+        options[:column_name]
+      end
+
+      def add_index?
+        !options[:skip_index]
+      end
+
+      def postgresql?
+        # Check if PostgreSQL adapter is being used
+        # Note: This checks the current adapter, which may not reflect production
+        # The migration template includes runtime detection as well
+        return false unless defined?(ActiveRecord::Base)
+
+        adapter_name = ActiveRecord::Base.connection.adapter_name rescue nil
+        adapter_name == "PostgreSQL"
+      end
+    end
+  end
+end

data/lib/generators/better_model/taggable/templates/README.tt

@@ -0,0 +1,62 @@
+===============================================================================
+
+Taggable column has been added to your model!
+
+Next steps:
+
+1. Run the migration:
+   $ bin/rails db:migrate
+
+2. Add Taggable configuration to your model:
+
+   class <%= model_name %> < ApplicationRecord
+     include BetterModel
+
+<% if postgresql? -%>
+     # PostgreSQL: No additional configuration needed
+<% else -%>
+     # SQLite/MySQL: Add serialization for the tags column
+     serialize :<%= column_name %>, coder: JSON, type: Array
+
+<% end -%>
+     taggable do
+       tag_field :<%= column_name %>      # Column name (default: :tags)
+       normalize true              # Convert to lowercase
+       strip true                  # Remove whitespace (default)
+       min_length 2                # Minimum tag length
+       max_length 30               # Maximum tag length
+       validates_tags minimum: 1, maximum: 10
+     end
+   end
+
+3. Usage examples:
+
+   # Add tags
+   product.tag_with("ruby", "rails", "web")
+
+   # Remove tags
+   product.untag("web")
+
+   # Replace all tags
+   product.retag("ruby", "api")
+
+   # Check for tag
+   product.tagged_with?("ruby")  # => true
+
+   # CSV interface
+   product.tag_list = "ruby, rails, tutorial"
+   product.tag_list  # => "ruby, rails, tutorial"
+
+   # Search with tags (Predicable integration)
+   <%= model_name %>.<%= column_name %>_contains("ruby")
+   <%= model_name %>.<%= column_name %>_overlaps(["ruby", "python"])
+   <%= model_name %>.<%= column_name %>_contains_all(["ruby", "rails"])
+
+   # Statistics
+   <%= model_name %>.tag_counts                    # => {"ruby" => 45, "rails" => 38}
+   <%= model_name %>.popular_tags(limit: 10)       # => [["ruby", 45], ["rails", 38]]
+   <%= model_name %>.related_tags("ruby", limit: 5)  # => ["rails", "gem", "tutorial"]
+
+For more information, see: docs/taggable.md
+
+===============================================================================

data/lib/generators/better_model/taggable/templates/migration.rb.tt

@@ -0,0 +1,21 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    change_table :<%= table_name %> do |t|
+      # Tags column - database-specific implementation
+      if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+        # PostgreSQL: Use native array with default empty array
+        t.string :<%= column_name %>, array: true, default: []
+      else
+        # SQLite/MySQL: Use text column (requires serialization in model)
+        t.text :<%= column_name %>
+      end
+    end
+<% if add_index? -%>
+
+    # Add index for PostgreSQL array searches (GIN index for better performance)
+    if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+      add_index :<%= table_name %>, :<%= column_name %>, using: 'gin'
+    end
+<% end -%>
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_model
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - alessiobussolari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-31 00:00:00.000000000 Z
+date: 2025-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,6 +46,9 @@ files:
 - lib/better_model/permissible.rb
 - lib/better_model/predicable.rb
 - lib/better_model/railtie.rb
+- lib/better_model/schedulable.rb
+- lib/better_model/schedulable/occurrence_calculator.rb
+- lib/better_model/schedulable/schedule_builder.rb
 - lib/better_model/searchable.rb
 - lib/better_model/sortable.rb
 - lib/better_model/state_transition.rb
@@ -70,6 +73,9 @@ files:
 - lib/generators/better_model/stateable/templates/README
 - lib/generators/better_model/stateable/templates/install_migration.rb.tt
 - lib/generators/better_model/stateable/templates/migration.rb.tt
+- lib/generators/better_model/taggable/taggable_generator.rb
+- lib/generators/better_model/taggable/templates/README.tt
+- lib/generators/better_model/taggable/templates/migration.rb.tt
 - lib/generators/better_model/traceable/templates/create_table_migration.rb.tt
 - lib/generators/better_model/traceable/traceable_generator.rb
 - lib/tasks/better_model_tasks.rake