rails-fields 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6148f3e28ada22e83ccdd3d5c9ebe0054a61e61d28af95fcac0052b42e03ef5
-  data.tar.gz: 9095670043d7f5df6fc540739c2b81951d16b2abc4da9b901ce3f58c7aa71515
+  metadata.gz: b999d7f43e0cae7f26122e81c3a7c7106ee1226fedee0621cc4ef548ac76883e
+  data.tar.gz: c1d624fc00ae4e3c595ae06d857758c55088342d8dba908ac73a11c514cf8e47
 SHA512:
-  metadata.gz: 16125dfe4d17cc6b2c12465bf7182a0e73d0be3e2e79efb33b6feaa8272bc79bed026bc4ff5f35d3cf1bf27ed23c6b17151083827b55f9cf2f09be80b7410782
-  data.tar.gz: 956dc90b7ee6e99f1a0fb75987d86b1d0f88db2e294d9ff334c77f06da1476cc29fb538d4c2e7748b55f1f7e76b24a8bd574328d5e2a33be22524cb81536d21e
+  metadata.gz: a8e0d1712858632023a259026a9b43634714f898a6a79eacb5602931711b0d4edc488375ae5ed222e6b9c8fb4348f7bbb8eb4645645385d33ee0a28a9758fe76
+  data.tar.gz: 8ddf8b005b637e7004ab598579bc66b76d53a126305598a3c8563e33c5025211ce882e69b19f0b909ff9cbacf6f6c9768fff9cd5d5f999328e375bdc4a20b034

data/README.md

@@ -1,11 +1,60 @@
+<p align="center">
+  <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)
+
 # Rails Fields
 
-## Summary
 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
+- 💪🏻 Enforcement of fields declaration with real db columns
+- 📜 Automatic YARD model documentation
+
 ## 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.
 
+## Usage
+
+In your ActiveRecord models:
+
+```ruby
+class User < ApplicationRecord
+  field :id, :integer
+  field :created_at, :datetime
+  field :updated_at, :datetime
+
+  field :first_name, :string
+  field :country, :string
+  field :welcome, :string
+
+  has_many :todos
+  
+  def welcome
+    "Welcome #{first_name}!"
+  end
+end
+```
+
+Autogenerate GraphQL types using `#gql_type` class method:
+
+```ruby
+module Types
+  class QueryType < Types::BaseObject
+    
+    field :users, [User.gql_type], null: true
+    
+    def users
+      User.all
+    end
+    
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,21 +63,31 @@ Add this line to your application's Gemfile:
 gem 'rails-fields'
 ```
 
+If you want to have graphql types generated for your models, add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql'
+```
+
+*Don't forget to install it `$ ./bin/rails generate graphql:install`*
+
 And then execute:
 
 ```bash
 $ bundle install
 ```
+Update your `ApplicationRecord`:
 
-Or install it yourself as:
-
-```
-$ gem install rails-fields
-```
+```patch
++require 'rails_fields'
 
-## Usage
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
 
-(TBD: Add usage examples here)
++  extend RailsFields::ClassMethods
++  include RailsFields
+end
+```
 
 ## License
 

data/lib/rails_fields/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-fields
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gaston Morixe
@@ -44,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.2
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="