paramore 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a45a04ffeaabb270fd7b57a2e27e195205a26ad281c46d69561040d71fb6961
-  data.tar.gz: 0df60483be44946c6e1fedb711039d5a915787c54e46c5f841c73172393e35f9
+  metadata.gz: 6bc18680611ecf9983143593443a9d04e3a7b57ac77111f183960287600a9592
+  data.tar.gz: 613b869bddc6de6a585e8de9f0448373a40da62d4daecf736e19e0955fa477ed
 SHA512:
-  metadata.gz: f0f3ed2da9f139467f5d4f6db3d7cbc7f0b29c3c1385a4eb8835d0cbffced915d0c77700d69722d11807984624e611856b2acd36462fe6ea4cb577736f8c6255
-  data.tar.gz: decf8bc3cbaa99c75ce7070b59f58f4e84d5cd0b3d22681836ae56f61596a600f3777e58c929d9db31a698689ea07a7b00330d45f54a9706262b512734b07393
+  metadata.gz: efb59cc8e0ee2d9bb324f8d543ff7e5e22a652d4bc23b5ea067b5fdadb3d47cd85ea228d5d855e47a43980f2723b8dc7983d11f592c44404607c00967b522788
+  data.tar.gz: aba0613b0838fd1b1d523bfe62913e33f1b4be678891c0794db7af2aa3138cd9755ff3c8c9b501e13203ccb49c94cd6d04e303d43bb7df4951279cdc22ff7c44

data/README.md

@@ -1,7 +1,7 @@
 # Paramore
 
-Paramore is a small gem intended to make strong parameter definitions declarative
-and provide a unified way to typecast and sanitize their values outside of controllers.
+Paramore allows you to declare a typed schema for your params,
+so that any downstream code can work with the data it expects.
 
 # Installation
 
@@ -20,7 +20,7 @@ $ bundle
 <h3>Without typing</h3>
 
 ```ruby
-paramorize :item_params,
+param_schema :item_params,
   item: [:name, :description, :for_sale, :price, metadata: [tags: []]]
 ```
 
@@ -74,15 +74,15 @@ class ItemsController < ApplicationController
     Item.create(item_params)
   end
 
-  paramorize :item_params,
+  param_schema :item_params,
     item: {
-      name: Paratype[Paramore::SanitizedString],
-      description: Paratype[Paramore::StrippedString, null: true],
-      for_sale: Paratype[Paramore::Boolean],
-      price: Paratype[Paramore::Decimal],
-      metadata: Paratype[{
-        tags: Paratype[[Types::ItemTag], compact: true]
-      }]
+      name: Paramore.field(Paramore::SanitizedString),
+      description: Paramore.field(Paramore::StrippedString, null: true),
+      for_sale: Paramore.field(Paramore::Boolean),
+      price: Paramore.field(Paramore::Decimal),
+      metadata: Paramore.field({
+        tags: Paramore.field([Types::ItemTag], compact: true)
+      })
     }
 end
 ```
@@ -129,13 +129,13 @@ Notice that the `Paramore::StrippedString` does not perform `.squeeze(' ')`, onl
 <h3>nil</h3>
 
 Types are non-nullable by default and raise exceptions if the param hash misses any.
-This can be disabled for any type by declaring `Paratype[Paramore::Int, null: true]`.
+This can be disabled for any type by declaring `Paramore.field(Paramore::Int, null: true)`.
 
 nils will usually not reach any of the type classes - if some parameter is nullable, the class will not be called.
 If a parameter is non-nullable, then a `Paramore::NilParameter` error will be raised before calling the class.
 If a, say, `item_ids` array is non-nullable, but the received parameter is `['1', '', '3']`, only the `'1'` and `'2'` will get passed to type classes, and the resulting array will contain a nil, eg.: `['1', nil, '3']`.
-nils inside arrays can still be passed to type classes by declaring `Paratype[[Paramore::Int], empty: true]`.
-If you wish to get rid of empty array elements, declare `Paratype[Paramore::Int, compact: true]`.
+nils inside arrays can still be passed to type classes by declaring `Paramore.field([Paramore::Int], empty: true)`.
+If you wish to get rid of empty array elements, declare `Paramore.field(Paramore::Int, compact: true)`.
 
 <h3>Configuration</h3>
 

data/lib/paramore/errors.rb

@@ -4,8 +4,8 @@ class Paramore::NilParameter < StandardError
   end
 end
 
-class Paramore::NonParatype < StandardError
+class Paramore::NonFieldSchema < StandardError
   def initialize(param_name, type)
-    super("`#{param_name}` defined as a `#{type.class}`, expected `Paratype`! Perhaps you declared a plain hash instead of Paratype[{}]?")
+    super("`#{param_name}` defined as a `#{type.class}`, expected a call of `Paramore.field()`! Perhaps you declared a plain hash instead of Paramore.field({})?")
   end
 end

data/lib/paramore/extension.rb

@@ -8,7 +8,7 @@ module Paramore
       default
     ].freeze
 
-    def paramorize(accessor_name, configuration)
+    def param_schema(accessor_name, configuration)
       parameter_configuration = configuration.except(*OPTIONS)
 
       unless parameter_configuration.keys.size == 1

data/lib/paramore/field_schema.rb

@@ -0,0 +1,36 @@
+module Paramore
+  class FieldSchema
+    DEFAULT_OPTIONS = {
+      null: false,
+      empty: false,
+      compact: false,
+    }.freeze
+
+    def initialize(given_type, null:, empty:, compact:)
+      @given_type = given_type
+      @nullable = null
+      @empty = empty
+      @compact = compact
+    end
+
+    def compact?
+      compact
+    end
+
+    def nullable?
+      nullable
+    end
+
+    def use_empty_strings?
+      empty
+    end
+
+    def type
+      given_type
+    end
+
+    private
+
+    attr_reader :given_type, :nullable, :empty, :compact
+  end
+end

data/lib/paramore/permitted_parameter_argument.rb

@@ -8,7 +8,7 @@ module Paramore
           case definition
           when Hash
             { key => merge_hashes(parse(definition)) }
-          when Paratype
+          when Paramore::FieldSchema
             case definition.type
             when Array
               { key => [] }

data/lib/paramore/validate.rb

@@ -13,12 +13,12 @@ module Paramore
     end
 
     def types(types_definition)
-      types_definition.flat_map do |param_name, paratype|
-        unless paratype.is_a?(Paratype)
-          raise Paramore::NonParatype.new(param_name, paratype)
+      types_definition.flat_map do |param_name, field_schema|
+        unless field_schema.is_a?(Paramore::FieldSchema)
+          raise Paramore::NonFieldSchema.new(param_name, field_schema)
         end
 
-        paratype.type.is_a?(Hash) ? types(paratype.type) : paratype.type
+        field_schema.type.is_a?(Hash) ? types(field_schema.type) : field_schema.type
       end.uniq
     end
   end

data/lib/paramore.rb

@@ -1,7 +1,7 @@
 require_relative 'paramore/configuration'
 require_relative 'paramore/railtie'
 require_relative 'paramore/types'
-require_relative 'paratype'
+require_relative 'paramore/field_schema'
 
 module Paramore
   class << self
@@ -15,4 +15,11 @@ module Paramore
   def self.configure
     yield(configuration)
   end
+
+  def self.field(given_type, options = {})
+    Paramore::FieldSchema.new(
+      given_type,
+      **Paramore::FieldSchema::DEFAULT_OPTIONS.merge(options)
+    )
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paramore
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Lukas Kairevičius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -91,17 +91,17 @@ files:
 - lib/paramore/configuration.rb
 - lib/paramore/errors.rb
 - lib/paramore/extension.rb
+- lib/paramore/field_schema.rb
 - lib/paramore/permitted_parameter_argument.rb
 - lib/paramore/railtie.rb
 - lib/paramore/types.rb
 - lib/paramore/validate.rb
-- lib/paratype.rb
 homepage: https://github.com/lumzdas/paramore
 licenses:
 - MIT
 metadata: {}
 post_install_message: |
-  Thank you for installing Paramore 1.1.0 !
+  Thank you for installing Paramore 2.0.0 !
   From the command line you can run `paramore` to generate a configuration file
 
   More details here         : https://github.com/lumzdas/paramore/blob/master/README.md

data/lib/paratype.rb

@@ -1,32 +0,0 @@
-class Paratype
-  def self.[](given_type, null: false, empty: false, compact: false)
-    self.new(given_type, null: null, empty: empty, compact: compact)
-  end
-
-  def initialize(given_type, null:, empty:, compact:)
-    @given_type = given_type
-    @nullable = null
-    @empty = empty
-    @compact = compact
-  end
-
-  def compact?
-    compact
-  end
-
-  def nullable?
-    nullable
-  end
-
-  def use_empty_strings?
-    empty
-  end
-
-  def type
-    given_type
-  end
-
-  private
-
-  attr_reader :given_type, :nullable, :empty, :compact
-end