rails-fields 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b999d7f43e0cae7f26122e81c3a7c7106ee1226fedee0621cc4ef548ac76883e
-  data.tar.gz: c1d624fc00ae4e3c595ae06d857758c55088342d8dba908ac73a11c514cf8e47
+  metadata.gz: 602330976f090420f2e4dc7ac7ce1fd5c897cf62c99f17a86bd3dbee88809b50
+  data.tar.gz: e2310c47d667f4d9199e7e0db893329d0eb75aaf257fe9579f31151b7e510be8
 SHA512:
-  metadata.gz: a8e0d1712858632023a259026a9b43634714f898a6a79eacb5602931711b0d4edc488375ae5ed222e6b9c8fb4348f7bbb8eb4645645385d33ee0a28a9758fe76
-  data.tar.gz: 8ddf8b005b637e7004ab598579bc66b76d53a126305598a3c8563e33c5025211ce882e69b19f0b909ff9cbacf6f6c9768fff9cd5d5f999328e375bdc4a20b034
+  metadata.gz: 4f186efcfac13495e229a308d088ea15698339cdec3be93d411504946514b4d618600947dc8182ee24048eb85c617878dee7115f2b7d88742a52334a8190c095
+  data.tar.gz: 893c54f91c6fe94601dd0ab278b5eb00e97946e4df03147f7ebfa8837c12be090f6ab4c18a735395e983b2d430617bfa05f7862521148afb52531299b087485e

data/README.md

@@ -8,9 +8,9 @@
 
 Enforce field types and attributes for ActiveRecord models in Ruby on Rails applications.
 
-- 🚀 Automagic ActiveRecord Migrations generations
-- 🦄 Automatic [GraphqQL types](https://graphql-ruby.org/type_definitions/objects.html) generation
-- 📝 Explicit declarative model attributes annotation
+- 🚀 Auto-magic 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
 - 📜 Automatic YARD model documentation
 
@@ -76,18 +76,6 @@ And then execute:
 ```bash
 $ bundle install
 ```
-Update your `ApplicationRecord`:
-
-```patch
-+require 'rails_fields'
-
-class ApplicationRecord < ActiveRecord::Base
-  primary_abstract_class
-
-+  extend RailsFields::ClassMethods
-+  include RailsFields
-end
-```
 
 ## License
 

data/lib/{rails_fields.rb → rails-fields.rb}

@@ -1,3 +1,4 @@
+require "rails_fields/railtie"
 require "rails_fields/errors/rails_fields_error"
 require "rails_fields/errors/rails_fields_mismatch_error"
 require "rails_fields/errors/rails_fields_unknown_type_error"
@@ -6,9 +7,13 @@ require "rails_fields/utils/mappings"
 require "rails_fields/utils/helpers"
 require "rails_fields/class_methods"
 require "rails_fields/instance_methods"
+require "rails_fields/enforce_fields_middleware"
+
+Rails.logger.debug "RailsFields file root"
 
 # Provides enforcement of declared field for ActiveRecord models.
 module RailsFields
+  Rails.logger.debug "RailsFields module"
   @processed_classes = {}
 
   def self.processed_classes
@@ -16,11 +21,11 @@ module RailsFields
   end
 
   # @param base [ActiveRecord::Base] the model to include the module in
-  def self.included(base)
-    # base.extend(ClassMethods)
-    # todo: raise if class methods not found
-    base.after_initialize do
-      self.class.enforce_declared_fields
-    end
-  end
+  # def self.included(base)
+  #   # base.extend(ClassMethods)
+  #   # todo: raise if class methods not found
+  #   # base.after_initialize do
+  #   #   self.class.enforce_declared_fields
+  #   # end
+  # end
 end

data/lib/rails_fields/enforce_fields_middleware.rb

@@ -0,0 +1,18 @@
+Rails.logger.debug "RailsFields::EnforceFieldsMiddleware"
+
+module RailsFields
+  class EnforceFieldsMiddleware
+    def initialize(app)
+      @app = app
+      Rails.logger.debug "RailsFields::EnforceFieldsMiddleware initialize"
+    end
+
+    def call(env)
+      Rails.logger.debug "RailsFields::EnforceFieldsMiddleware call"
+      ApplicationRecord.descendants.each do |model|
+        model.enforce_declared_fields # if model.respond_to?(:enforce_declared_fields)
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/rails_fields/railtie.rb

@@ -0,0 +1,22 @@
+require "active_support"
+require "active_support/rails"
+require "rails_fields/enforce_fields_middleware"
+
+Rails.logger.debug "RailsFields::Railtie"
+
+module RailsFields
+  class Railtie < Rails::Railtie
+    # config.eager_load_namespaces << RailsFields
+
+    initializer "rails_fields.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        extend RailsFields::ClassMethods
+        include RailsFields
+      end
+    end
+
+    initializer "rails_fields.middleware" do |app|
+      app.middleware.insert_before ActiveRecord::Migration::CheckPending, RailsFields::EnforceFieldsMiddleware
+    end
+  end
+end

data/lib/rails_fields/version.rb

@@ -1,3 +1,3 @@
 module RailsFields
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,20 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: rails-fields
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gaston Morixe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-27 00:00:00.000000000 Z
-dependencies: []
-description: The rails-fields gem provides robust field type enforcement for ActiveRecord
-  models in Ruby on Rails applications. It includes utility methods for type validation,
-  logging, and field mappings between GraphQL and ActiveRecord types. Custom error
-  classes provide clear diagnostics for field-related issues, making it easier to
-  maintain consistent data models.
+date: 2023-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  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: 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
+  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: webrick
+  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'
+description: |2
+      rails-fields gem provides robust field type enforcement for ActiveRecord models in Ruby on Rails applications.
+      It includes utility methods for type validation, logging, and field mappings between GraphQL and ActiveRecord types
+      Custom error classes provide clear diagnostics for field-related issues, making it easier to maintain consistent data models.
 email:
 - gaston@gastonmorixe.com
 executables: []
@@ -22,12 +91,14 @@ extensions: []
 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
 - lib/rails_fields/errors/rails_fields_mismatch_error.rb
 - lib/rails_fields/errors/rails_fields_unknown_type_error.rb
 - lib/rails_fields/instance_methods.rb
+- lib/rails_fields/railtie.rb
 - lib/rails_fields/utils/helpers.rb
 - lib/rails_fields/utils/logging.rb
 - lib/rails_fields/utils/mappings.rb
@@ -35,7 +106,10 @@ files:
 homepage: https://github.com/gastonmorixe/rails-fields
 licenses:
 - MIT
-metadata: {}
+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: