rails-fields 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b352b59432076c4b334a34bf061c94ec6982a5eca47adcbcdc58523efadef39
-  data.tar.gz: bcfe7ba51edb7381f5606bd0130a805a63b2f5a07f59776c0e4c541f5ecef6fc
+  metadata.gz: 72386aef5bd4ef9136597eb8226759ce716deb2d4a899b27837031c3d4678596
+  data.tar.gz: b0a8d07705dfba50be8270da36854db49cedc9d2c10f09b292cc48674f059965
 SHA512:
-  metadata.gz: 000acd3ebbd40351f1270a040cff06eaa5da891c98f22b624b65bb03ef6f2bc32d649d0f9031c5ed7ef454b7484782968bfb47cfae68c0973facf51cf2ce10b6
-  data.tar.gz: 15fd7d0f3483a43055e17bdbdd3bb12b17509e3bead773b8340b0fb8c5534649f3e66bdbfdfbd48e3004879309c7911ef9cc16396516eed7dadaec7eb9c5ea5d
+  metadata.gz: f5b4d8dd33a0f8b4103c649901e7f7c789aea02a64411998db0f5a722c811a59b1107a1e86b4c73f9d201173376789c76b6b5664ef46a96ecacca08994efcf22
+  data.tar.gz: 59ed93e40c507e75a139f2321c011101070e200d5d217e4eb1752cf085e60983b614f60511fad534b64c8eb4e8dca58d6d2930c24d3e2b844d928d366c8570fc

data/README.md

@@ -2,13 +2,13 @@
   <a href="https://rails-fields.dev" target="_blank"><img src="./assets/logo.svg" width="300" /></a>
 </p>
 
-[![Gem Version](https://badge.fury.io/rb/rails-fields.svg)](https://badge.fury.io/rb/rails-fields)
+[![Gem Version](https://badge.fury.io/rb/rails-fields.svg?v=320)](https://badge.fury.io/rb/rails-fields)
 
 # Rails Fields
 
 Enforce field types and attributes for ActiveRecord models in Ruby on Rails applications.
 
-- 🚀 Auto-magic ActiveRecord **Migrations** generation
+- 🚀 Automatic ActiveRecord **Migrations** generation
 - 🦄 Automatic [GraphQL types](https://graphql-ruby.org/type_definitions/objects.html) generation
 - 📝 Explicit **declarative** model attributes annotation
 - 💪🏻 Enforcement of fields declaration with real db columns
@@ -83,4 +83,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Author
 
-Gaston Morixe - gaston@gastonmorixe.com
+Gaston Morixe 2023 - gaston@gastonmorixe.com
+
+[rails-fields.dev](https://rails-fields.dev/?gh)

data/lib/rails/fields.rb

@@ -0,0 +1,3 @@
+# Autoload shim for hyphenated gem name.
+# RubyGems will try to require 'rails/fields' for 'rails-fields'.
+require "rails-fields"

data/lib/rails_fields/class_methods.rb

@@ -1,4 +1,7 @@
 module RailsFields
+  # Lightweight, typed container for field declarations
+  # Include :options to maintain compatibility with code that reads it
+  DeclaredField = Struct.new(:name, :type, :null, :index, :options, keyword_init: true)
   module ClassMethods
     # TODO: Check  all models at rails init app? like migrations?
 
@@ -36,16 +39,20 @@ module RailsFields
         ")
       end
 
-      declared_fields << OpenStruct.new(name: name.to_s, type:, null:, index:)
+      declared_fields << DeclaredField.new(name: name.to_s, type:, null:, index:)
     end
 
     def gql_type
+      unless defined?(GraphQL)
+        raise "GraphQL is not available. Add `gem 'graphql'` and install it, or avoid calling `gql_type`."
+      end
       return RailsFields.processed_classes[self] if RailsFields.processed_classes[self].present?
 
       fields = declared_fields
       owner_self = self
 
-      type = Class.new(::Types::BaseObject) do
+      base_object = defined?(::Types::BaseObject) ? ::Types::BaseObject : ::GraphQL::Schema::Object
+      type = Class.new(base_object) do
         # graphql_name "#{owner_self.name}Type"
         graphql_name "#{owner_self.name}"
         description "A type representing a #{owner_self.name}"
@@ -55,8 +62,9 @@ module RailsFields
 
           # Assuming a proper mapping from your custom types to GraphQL types
           # TODO: use a better method or block
-          field_gql_type = f.name == :id ? GraphQL::Types::ID : Utils::RAILS_TO_GQL_TYPE_MAP[f.type]
-          field f.name, field_gql_type
+          field_name = f.name.to_s
+          field_gql_type = field_name == 'id' ? GraphQL::Types::ID : Utils::RAILS_TO_GQL_TYPE_MAP[f.type]
+          field field_name, field_gql_type
         end
       end
 

data/lib/rails_fields/railtie.rb

@@ -14,7 +14,19 @@ module RailsFields
     end
 
     initializer "rails_fields.middleware" do |app|
-      app.middleware.insert_before ActiveRecord::Migration::CheckPending, RailsFields::EnforceFieldsMiddleware
+      # In Rails 8, ActiveRecord::Migration::CheckPending was removed.
+      # Try to insert after it when present; otherwise, append the middleware.
+      if defined?(Rails::VERSION) && Rails::VERSION::MAJOR >= 8
+        # Rails 8 removed ActiveRecord::Migration::CheckPending from the stack
+        app.middleware.use RailsFields::EnforceFieldsMiddleware
+      else
+        begin
+          app.middleware.insert_after ActiveRecord::Migration::CheckPending, RailsFields::EnforceFieldsMiddleware
+        rescue StandardError
+          # Fallback for environments where insert_after target is unavailable
+          app.middleware.use RailsFields::EnforceFieldsMiddleware
+        end
+      end
     end
   end
-end
+end

data/lib/rails_fields/utils/helpers.rb

@@ -1,6 +1,8 @@
 module RailsFields
   module Utils
     class << self
+      # Minimal wrapper to represent associations in changes
+      AssociationRef = Struct.new(:name)
       def allowed_types
         # TODO: this may depend on the current database adapter or mapper
         ActiveRecord::Base.connection.native_database_types.keys
@@ -35,7 +37,11 @@ module RailsFields
       # @param model [ActiveRecord::Base] the model to check
       # @return [Hash, Nil] the changes detected
       def detect_changes(model)
-        previous_fields = model.attribute_types.to_h { |k, v| [k.to_sym, v.type] }
+        # Exclude the primary key (e.g., :id) from comparisons
+        primary_key = model.primary_key&.to_sym
+        previous_fields = model.attribute_types
+                           .to_h { |k, v| [k.to_sym, v.type] }
+                           .reject { |name, _| name == primary_key }
         declared_fields = model.declared_fields.to_h do |f|
           [f.name.to_sym, {
             name: f.type.to_sym,
@@ -61,8 +67,7 @@ module RailsFields
           type_name = type[:name]
           if previous_fields[name]
             if previous_fields[name] != type_name
-              model_changes[:type_changed] << { name:, from: previous_fields[name],
-                                                to: type }
+              model_changes[:type_changed] << { name:, from: previous_fields[name], to: type }
             end
           else
             model_changes[:added] << { name:, type: }
@@ -89,8 +94,11 @@ module RailsFields
         # Detect potential renames
         potential_renames = []
         model_changes[:removed].each do |removed_field|
-          # puts "Log: removed_field: #{removed_field}"
-          added_field = model_changes[:added].find { |f| f[:type] == removed_field[:type] }
+          # Match by type name (normalize Hash/Scalar)
+          added_field = model_changes[:added].find do |f|
+            added_type = f[:type].is_a?(Hash) ? f[:type][:name] : f[:type]
+            added_type == removed_field[:type]
+          end
           if added_field
             potential_renames << { from: removed_field[:name],
                                    to: added_field[:name] }
@@ -103,8 +111,8 @@ module RailsFields
 
         # Filter out incorrect renames (one-to-one mapping)
         potential_renames.each do |rename|
-          next unless model_changes[:added].count { |f| f[:type] == rename[:to].to_sym } == 1 &&
-            model_changes[:removed].count { |f| f[:type] == rename[:from].to_sym } == 1
+          next unless model_changes[:added].count { |f| f[:name] == rename[:to].to_sym } == 1 &&
+            model_changes[:removed].count { |f| f[:name] == rename[:from].to_sym } == 1
 
           model_changes[:renamed] << rename
           model_changes[:added].reject! { |f| f[:name] == rename[:to].to_sym }
@@ -117,15 +125,20 @@ module RailsFields
         end
 
         declared_foreign_keys = declared_associations.map(&:foreign_key).map(&:to_sym)
-        existing_foreign_keys = ActiveRecord::Base.connection.foreign_keys(model.table_name).map(&:options).map { |opt| opt[:column].to_sym }
+        existing_foreign_keys = ActiveRecord::Base.connection
+          .foreign_keys(model.table_name)
+          .map { |fk| fk.respond_to?(:column) ? fk.column.to_sym : fk.options[:column].to_sym }
 
         associations_added = declared_associations.select do |reflection|
           !existing_foreign_keys.include?(reflection.foreign_key.to_sym)
         end
 
-        associations_removed = existing_foreign_keys.select do |foreign_key|
-          !declared_foreign_keys.include?(foreign_key)
-        end.map { |foreign_key| model.reflections.values.find { |reflection| reflection.foreign_key == foreign_key.to_s } }
+        associations_removed = existing_foreign_keys
+          .select { |foreign_key| !declared_foreign_keys.include?(foreign_key) }
+          .map do |foreign_key|
+            model.reflections.values.find { |reflection| reflection.foreign_key == foreign_key.to_s } ||
+              AssociationRef.new(foreign_key.to_s.delete_suffix('_id').to_sym)
+          end
 
         model_changes[:associations_added] = associations_added
         model_changes[:associations_removed] = associations_removed
@@ -151,34 +164,34 @@ module RailsFields
           field_type = change[:type]
           field_type_for_db = field_type[:name]
           # TODO: custom mapper
-          migration_code << "    add_column :#{model_name.tableize}, :#{change[:name]}, :#{field_type_for_db}"
+          migration_code << "    add_column :#{model.table_name}, :#{change[:name]}, :#{field_type_for_db}"
         end
 
         # Handle added associations
         model_changes.dig(:associations_added)&.each do |assoc|
-          migration_code << "    add_reference :#{model_name.tableize}, :#{assoc.name}, foreign_key: true"
+          migration_code << "    add_reference :#{model.table_name}, :#{assoc.name}, foreign_key: true"
         end
 
         # Handle removed associations
         model_changes.dig(:associations_removed)&.each do |assoc|
-          migration_code << "    remove_reference :#{model_name.tableize}, :#{assoc.name}, foreign_key: true"
+          migration_code << "    remove_reference :#{model.table_name}, :#{assoc.name}, foreign_key: true"
         end
 
         # Handle removed fields
         model_changes.dig(:removed)&.each do |change|
-          migration_code << "    remove_column :#{model_name.tableize}, :#{change[:name]}"
+          migration_code << "    remove_column :#{model.table_name}, :#{change[:name]}"
         end
 
         # Handle renamed fields
         model_changes.dig(:renamed)&.each do |change|
           change_to = change[:to]
-          migration_code << "    rename_column :#{model_name.tableize}, :#{change[:from]}, :#{change_to}"
+          migration_code << "    rename_column :#{model.table_name}, :#{change[:from]}, :#{change_to}"
         end
 
         # Handle fields' type changes
         model_changes.dig(:type_changed)&.each do |change|
-          change_to = change[:to]
-          migration_code << "    change_column :#{model_name.tableize}, :#{change[:name]}, :#{change_to}"
+          change_to = change[:to][:name]
+          migration_code << "    change_column :#{model.table_name}, :#{change[:name]}, :#{change_to}"
         end
 
         migration_code << "  end"

data/lib/rails_fields/utils/mappings.rb

@@ -1,29 +1,32 @@
 module RailsFields
   module Utils
-    # TODO: mapper can be different or custom
-    GQL_TO_RAILS_TYPE_MAP = {
-      ::GraphQL::Types::String => :string,
-      ::GraphQL::Types::Int => :integer,
-      ::GraphQL::Types::Float => :float,
-      ::GraphQL::Types::Boolean => :boolean,
-      ::GraphQL::Types::ID => :integer, # or :string depending on how you handle IDs
-      ::GraphQL::Types::ISO8601DateTime => :datetime,
-      ::GraphQL::Types::ISO8601Date => :date,
-      ::GraphQL::Types::JSON => :json,
-      ::GraphQL::Types::BigInt => :bigint
-    }.freeze
+    # Define maps only if GraphQL is available
+    if defined?(GraphQL)
+      # TODO: mapper can be different or custom
+      GQL_TO_RAILS_TYPE_MAP = {
+        ::GraphQL::Types::String => :string,
+        ::GraphQL::Types::Int => :integer,
+        ::GraphQL::Types::Float => :float,
+        ::GraphQL::Types::Boolean => :boolean,
+        ::GraphQL::Types::ID => :integer, # or :string depending on how you handle IDs
+        ::GraphQL::Types::ISO8601DateTime => :datetime,
+        ::GraphQL::Types::ISO8601Date => :date,
+        ::GraphQL::Types::JSON => :json,
+        ::GraphQL::Types::BigInt => :bigint
+      }.freeze
 
-    RAILS_TO_GQL_TYPE_MAP = {
-      # id: ::GraphQL::Types::String,
-      string: ::GraphQL::Types::String,
-      integer: ::GraphQL::Types::Int,
-      float: ::GraphQL::Types::Float,
-      boolean: ::GraphQL::Types::Boolean,
-      datetime: ::GraphQL::Types::ISO8601DateTime,
-      date: ::GraphQL::Types::ISO8601Date,
-      json: ::GraphQL::Types::JSON,
-      bigint: ::GraphQL::Types::BigInt,
-      text: ::GraphQL::Types::String
-    }.freeze
+      RAILS_TO_GQL_TYPE_MAP = {
+        # id: ::GraphQL::Types::String,
+        string: ::GraphQL::Types::String,
+        integer: ::GraphQL::Types::Int,
+        float: ::GraphQL::Types::Float,
+        boolean: ::GraphQL::Types::Boolean,
+        datetime: ::GraphQL::Types::ISO8601DateTime,
+        date: ::GraphQL::Types::ISO8601Date,
+        json: ::GraphQL::Types::JSON,
+        bigint: ::GraphQL::Types::BigInt,
+        text: ::GraphQL::Types::String
+      }.freeze
+    end
   end
 end

data/lib/rails_fields/version.rb

@@ -1,3 +1,3 @@
 module RailsFields
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-fields
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Gaston Morixe
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2025-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: graphql
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,21 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jekyll
+  name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -92,6 +77,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/rails-fields.rb
+- lib/rails/fields.rb
 - lib/rails_fields/class_methods.rb
 - lib/rails_fields/enforce_fields_middleware.rb
 - lib/rails_fields/errors/rails_fields_error.rb
@@ -110,7 +96,6 @@ metadata:
   homepage_uri: https://rails-fields.dev
   source_code_uri: https://github.com/gastonmorixe/rails-fields
   bug_tracker_uri: https://github.com/gastonmorixe/rails-fields/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Enforce field types and attributes for ActiveRecord models in Ruby on Rails
   applications.