plain_params 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb54893c12c29f4fe1decf5259e4d50502c300dcb9fc7d74a025d2c91a74dc54
-  data.tar.gz: df9edd0784556630498b94bba2642b140507ef1deb762ebfac8f6458929a9b30
+  metadata.gz: 2732e1cfef1a1932dfb6b1b7b829145b3f765bfcd779600fb3ddecf3f324f867
+  data.tar.gz: e41d104a92928e9acfb726dc25fe57ca7cdc8d6c0341e9d90e0ef033154ba7bf
 SHA512:
-  metadata.gz: f9d2f3ceb20c027834a3d72743a4348b8e569e99856d4c922b7dc752c5ccb8ed3b829d0fa33314bddd56382ed0fb8c9f2c2339c4dbca2161e49ae390965b2bdc
-  data.tar.gz: 74ee1065560293d9b7bbbbcb3fbcabeee8d3761310c78259878e1f9215bc478efe8d423e3fbfd318dcc2e6bc810d14957fdd641ccb825207bb21713f26e0fb32
+  metadata.gz: 4b32b007ab99633269c6d13a6c865d4b01b0a5076920c5a2472893bed145786b61bb91a15d2f61925397fdf62b7c8c2c7ba418e698d30f9f0476b5324087dcd4
+  data.tar.gz: 01ee101b993dbf46d01bb5fc4f02992abb5f81eee616fbb46885e53a4aba13fe53a6aed6994c121eb299c81cd2797f528a5781c9a54ea2790935da654d57b7f6

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.5] - Unreleased
+
+### Added
+- Comprehensive test suite with 100% coverage
+- Example usage files demonstrating practical applications
+- Rubocop configuration for code quality
+- Rake tasks for common operations
+- Support for Ruby 3.4+ implicit block parameter `it`
+
+### Changed
+- Refactored main class to use modern Ruby syntax
+- Improved code organization with separate methods for initialization
+- Enhanced README with better examples and clearer documentation
+- Simplified accessor setup logic
+
+### Fixed
+- Virtual fields now properly support custom getter methods
+- Fixed issue with virtual field initialization order
+
+## [0.0.4] - 2024-11-15
+
+### Added
+- Initial release with basic functionality
+- Support for real and virtual fields
+- ActiveModel integration
+- Basic validation support 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Gedean Dias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1 +1,205 @@
-# plain_params
+# PlainParams
+
+A lightweight Ruby gem for parameter validation and organization using ActiveModel, without the overhead of ActiveRecord or complex validation libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plain_params'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install plain_params
+```
+
+## Overview
+
+PlainParams provides a simple way to handle parameter validation by dividing attributes into two categories:
+
+- **Real fields**: Required attributes with automatic presence validation
+- **Virtual fields**: Optional computed attributes that can depend on real fields
+
+## Basic Usage
+
+### Simple Example
+
+```ruby
+class UserParams < PlainParams
+  @real_fields = %i[name email]
+  @virtual_fields = %i[display_name]
+
+  def display_name
+    name.upcase if name
+  end
+end
+
+# Create instance with parameters
+params = UserParams.new(name: "john", email: "john@example.com")
+
+# Access attributes
+params.name         # => "john"
+params.email        # => "john@example.com"
+params.display_name # => "JOHN"
+
+# Check validity
+params.valid?       # => true
+
+# Get all values
+params.values
+# => {
+#      real: { name: "john", email: "john@example.com" },
+#      virtual: { display_name: "JOHN" }
+#    }
+```
+
+### Validation Example
+
+```ruby
+class ProductParams < PlainParams
+  @real_fields = %i[name price quantity]
+  @virtual_fields = %i[total_value in_stock]
+
+  validates :price, numericality: { greater_than: 0 }
+  validates :quantity, numericality: { greater_than_or_equal_to: 0 }
+
+  def total_value
+    price * quantity if price && quantity
+  end
+
+  def in_stock
+    quantity && quantity > 0
+  end
+end
+
+# Invalid parameters
+params = ProductParams.new(name: "Widget", price: -10)
+params.valid?  # => false
+params.errors.full_messages
+# => ["Price must be greater than 0", "Quantity can't be blank"]
+```
+
+### Advanced Example with Dependencies
+
+```ruby
+class OrderParams < PlainParams
+  @real_fields = %i[customer_id items_count discount_percentage]
+  @virtual_fields = %i[has_discount order_size discount_multiplier]
+
+  validates :items_count, numericality: { greater_than: 0 }
+  validates :discount_percentage, numericality: { 
+    greater_than_or_equal_to: 0,
+    less_than_or_equal_to: 100 
+  }
+
+  def has_discount
+    discount_percentage && discount_percentage > 0
+  end
+
+  def order_size
+    return :small if items_count <= 5
+    return :medium if items_count <= 20
+    :large
+  end
+
+  def discount_multiplier
+    1 - (discount_percentage.to_f / 100)
+  end
+end
+
+params = OrderParams.new(
+  customer_id: 123,
+  items_count: 10,
+  discount_percentage: 15
+)
+
+params.order_size         # => :medium
+params.has_discount       # => true
+params.discount_multiplier # => 0.85
+```
+
+## Features
+
+### ActiveModel Integration
+
+PlainParams integrates seamlessly with ActiveModel, providing:
+
+- Full validation support
+- Attribute naming conventions
+- Error handling
+- Form helper compatibility
+
+### String Key Support
+
+Parameters can be passed with either symbol or string keys:
+
+```ruby
+# Both work identically
+UserParams.new(name: "john", age: 30)
+UserParams.new("name" => "john", "age" => 30)
+```
+
+### Error Handling
+
+PlainParams provides clear error messages for common issues:
+
+```ruby
+# Missing field definitions
+class EmptyParams < PlainParams
+end
+EmptyParams.new  # => RuntimeError: No @real_fields or @virtual_fields provided
+
+# Duplicate fields
+class DuplicateParams < PlainParams
+  @real_fields = %i[name]
+  @virtual_fields = %i[name]
+end
+DuplicateParams.new  # => RuntimeError: Duplicated field(s) 'name'
+
+# Invalid fields
+UserParams.new(invalid: "value")  # => RuntimeError: field 'invalid' is not in @real_fields or @virtual_fields
+```
+
+## API Reference
+
+### Class Methods
+
+- `real_fields` - Returns array of real field names
+- `virtual_fields` - Returns array of virtual field names
+
+### Instance Methods
+
+- `values` - Returns hash with all real and virtual values
+- `real_values` - Returns hash with only real field values
+- `virtual_values` - Returns hash with only virtual field values
+- `valid?` - Validates the instance according to defined validations
+- `persisted?` - Always returns `false` (ActiveModel compatibility)
+
+## Best Practices
+
+1. **Keep virtual fields simple** - They should contain display logic or simple calculations
+2. **Use real fields for validation** - Put your validation rules on real fields
+3. **Leverage ActiveModel validations** - Use the full power of ActiveModel validations
+4. **Virtual fields for computed values** - Use virtual fields for values derived from real fields
+
+## Requirements
+
+- Ruby >= 3.0
+- ActiveModel >= 7.0, < 9.0
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gedean/plain_params.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/examples/usage.rb

@@ -0,0 +1,55 @@
+require 'uri'
+require_relative '../lib/plain_params'
+
+class ContactParams < PlainParams
+  @real_fields = %i[name email phone]
+  @virtual_fields = %i[formatted_phone email_domain]
+
+  validates :email, format: { with: URI::MailTo::EMAIL_REGEXP }
+  validates :phone, format: { with: /\A\d{10,11}\z/ }
+
+  def formatted_phone
+    return unless phone
+    if phone.length == 11
+      "(#{phone[0..1]}) #{phone[2..6]}-#{phone[7..10]}"
+    else
+      "(#{phone[0..1]}) #{phone[2..5]}-#{phone[6..9]}"
+    end
+  end
+
+  def email_domain
+    email.split('@').last if email
+  end
+end
+
+puts "=== Valid Contact ==="
+contact = ContactParams.new(
+  name: "Alice Smith",
+  email: "alice@example.com",
+  phone: "11987654321"
+)
+
+if contact.valid?
+  puts "Name: #{contact.name}"
+  puts "Email: #{contact.email}"
+  puts "Phone: #{contact.phone}"
+  puts "Formatted Phone: #{contact.formatted_phone}"
+  puts "Email Domain: #{contact.email_domain}"
+  puts "\nAll values:"
+  p contact.values
+else
+  puts "Errors: #{contact.errors.full_messages.join(', ')}"
+end
+
+puts "\n=== Invalid Contact ==="
+invalid_contact = ContactParams.new(
+  name: "Bob",
+  email: "invalid-email",
+  phone: "123"
+)
+
+if invalid_contact.valid?
+  puts "Valid!"
+else
+  puts "Errors: #{invalid_contact.errors.full_messages.join(', ')}"
+end 

data/lib/plain_params.rb

@@ -6,63 +6,68 @@ class PlainParams
   include ActiveModel::Validations
   
   def initialize(params_attributes = {})
-    raise 'No @real_fields or @virtual_fields provided in the class definition' if (self.class.real_fields.nil? and self.class.virtual_fields.nil?)
+    raise 'No @real_fields or @virtual_fields provided in the class definition' if self.class.real_fields.nil? && self.class.virtual_fields.nil?
 
     self.class.real_fields ||= []
     self.class.virtual_fields ||= []
 
+    setup_accessors
     self.attributes = params_attributes
   end
 
-  def self.real_fields = @real_fields
-  def self.virtual_fields = @virtual_fields
+  class << self
+    attr_accessor :real_fields, :virtual_fields
+  end
 
   def values
-    fields_values = {}
-
-    fields_values[:real] = self.class.real_fields.map { |afield| [afield, send(afield)] }.to_h
-    fields_values[:virtual] = self.class.virtual_fields.map { |afield| [afield, send(afield)] }.to_h
-
-    fields_values
+    {
+      real: self.class.real_fields.to_h { [it, send(it)] },
+      virtual: self.class.virtual_fields.to_h { [it, send(it)] }
+    }
   end
   
   def real_values = values[:real]
   def virtual_values = values[:virtual]
-
   def persisted? = false
 
   private
+  
+  def setup_accessors
+    self.class.real_fields.each do |field|
+      self.class.send(:attr_accessor, field)
+      self.class.send(:validates_presence_of, field)
+    end
+    
+    self.class.virtual_fields.each do |field|
+      self.class.send(:attr_writer, field) unless self.class.method_defined?("#{field}=")
+      self.class.send(:attr_reader, field) unless self.class.method_defined?(field)
+    end
+  end
     
   def attributes=(attributes)
-    duplicated_fields = self.class.real_fields.intersection(self.class.virtual_fields)
+    duplicated_fields = self.class.real_fields & self.class.virtual_fields
     raise "Duplicated field(s) '#{duplicated_fields.join(', ')}' in @real_fields and @virtual_fields" if duplicated_fields.any?
 
     symbolized_attributes = attributes.symbolize_keys
-
-    (symbolized_attributes.keys - (self.class.real_fields + self.class.virtual_fields)).each do |invalid_field|
-      raise "field '#{invalid_field.to_s}' is not in @real_fields or @virtual_fields"
-    end
-
-    # initialized @real_fields first
-    self.class.real_fields.each do |available_field|
-      (instance_variable_set"@#{available_field.to_s}", symbolized_attributes[available_field])
-      self.class.send(:attr_accessor, available_field)
-      self.class.send(:validates_presence_of, available_field)
+    invalid_fields = symbolized_attributes.keys - (self.class.real_fields + self.class.virtual_fields)
+    
+    invalid_fields.each do |invalid_field|
+      raise "field '#{invalid_field}' is not in @real_fields or @virtual_fields"
     end
 
-    # @virtual_fields comes sencondly for use already initialized @available fields
-    self.class.virtual_fields.each do |virtual_field|
-      unless symbolized_attributes[virtual_field].nil?
-        self.send("#{virtual_field.to_s}=", symbolized_attributes[virtual_field])
-      end
-    end
+    initialize_real_fields(symbolized_attributes)
+    initialize_virtual_fields(symbolized_attributes)
   end
 
-  def self.real_fields=(value) 
-    @real_fields = value
+  def initialize_real_fields(attributes)
+    self.class.real_fields.each do |field|
+      instance_variable_set("@#{field}", attributes[field])
+    end
   end
 
-  def self.virtual_fields=(value) 
-    @virtual_fields = value
+  def initialize_virtual_fields(attributes)
+    self.class.virtual_fields.each do |field|
+      send("#{field}=", attributes[field]) if attributes.key?(field)
+    end
   end
 end

metadata

@@ -1,42 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: plain_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Gedean Dias
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2025-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '9.0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
-description: No ActiveRecord or Dry-Validation, just plain parameters.
+        version: '13.0'
+description: A simple and lightweight parameter validation library that leverages
+  ActiveModel to provide a clean interface for handling parameters with real and virtual
+  fields.
 email: gedean.dias@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
 - README.md
+- examples/usage.rb
 - lib/plain_params.rb
 homepage: https://github.com/gedean/plain_params
 licenses:
 - MIT
 metadata: {}
-post_install_message: Please check readme file for use instructions.
+post_install_message: Thank you for installing PlainParams! Check out the README for
+  usage examples.
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +83,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: No ActiveRecord or Dry-Validation, just plain parameters.
+summary: Lightweight parameter validation using ActiveModel
 test_files: []