easy_params 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23259cc1e65725f6e9665a3ad772daaef176cd6f4e19ef19da024e967a081d46
-  data.tar.gz: 655a86c2642f3687157f616cdb535317af993ed95ac853e5acd614a769c31ba0
+  metadata.gz: f63905ee9e223d63e2f3855f7e67ace0f3d2abd14ed97fb1f706f73082f73c90
+  data.tar.gz: 1ce09ad5d8a018e97c9c46eb21b32f5dd537d448830578c8b760ee2c99d903ca
 SHA512:
-  metadata.gz: 82c370a09789747b80297d76f8315e3eb44531c613fe7f36b8b166316a7bdafbfa9554c1ca8eff24bb335b495373330e14eae63c5930cc0b4ea806bf17f74945
-  data.tar.gz: 4f8494ba8a3f7c9fc610593afa4a3bc7115d239779d7deecc1d4b2f9763a68ea83baa2c81d36577c98a08ef0544c7b29b73ce7e717d55ec5ab7fc2ef2aa6f7d0
+  metadata.gz: 935a110dbedbace4f05a9df987aec2932fec9ccec5cbc9dbb3b4a3460b42971cd7cdafa60c391b24ad334f74e39086c7d81df191e9622844ebda0f4ed9ca952f
+  data.tar.gz: 9ebe7ebeae1961a820e396361e020b5b8cfe712ad81480dcf14b64784d7de6cf16e66e8c8b9eaf44272c0aaed20805ab255bfe1effc073c4f2aebb355f21339a

data/.github/workflows/ruby.yml

@@ -1,50 +1,39 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: Ruby
 
 on:
   push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
+    branches:
+      - master
 
-permissions:
-  contents: read
+  pull_request:
+  workflow_call:
+    secrets:
+      QLTY_COVERAGE_TOKEN:
+        required: true
 
 jobs:
-  test:
-
+  build:
     runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0']
+        ruby:
+          - '3.4'
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Setup Code Climate test-reporter
-      run: |
-        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-        chmod +x ./cc-test-reporter
-        ./cc-test-reporter before-build
-    - name: Run the default task
-      env:
-        CC_TEST_REPORTER_ID: 3484f4290e34aa523ef280da3743fd5dc86a443fd7d8a1e5ba2339d1f63308d8
-      run: bundle exec rake
-    - name: Publish code coverage
-      run: |
-        export GIT_BRANCH="master"
-        ./cc-test-reporter after-build -d -t simplecov -r 3484f4290e34aa523ef280da3743fd5dc86a443fd7d8a1e5ba2339d1f63308d8
-
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rspec --require spec_helper
+      - name: Upload coverage to QLty
+        uses: qltysh/qlty-action/coverage@v2
+        with:
+          token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          files: coverage/coverage.json
+          format: simplecov

data/Gemfile

@@ -11,4 +11,4 @@ gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec_vars_helper', '~> 0.1'
 gem 'rubocop'
-gem 'simplecov', '~> 0.17'
+gem 'simplecov', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_params (0.6.2)
+    easy_params (0.7.0)
       activemodel (>= 3.2)
 
 GEM
@@ -111,7 +111,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec_vars_helper (~> 0.1)
   rubocop
-  simplecov (~> 0.17)
+  simplecov
 
 BUNDLED WITH
    2.7.1

data/README.md

@@ -1,8 +1,8 @@
 # EasyParams
 
+[![Maintainability](https://qlty.sh/gh/andriy-baran/projects/easy_params/maintainability.svg)](https://qlty.sh/gh/andriy-baran/projects/easy_params)
+[![Code Coverage](https://qlty.sh/gh/andriy-baran/projects/easy_params/coverage.svg)](https://qlty.sh/gh/andriy-baran/projects/easy_params)
 [![Gem Version](https://badge.fury.io/rb/easy_params.svg)](https://badge.fury.io/rb/easy_params)
-[![Maintainability](https://api.codeclimate.com/v1/badges/17872804ce576b8b0df2/maintainability)](https://codeclimate.com/github/andriy-baran/easy_params/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/17872804ce576b8b0df2/test_coverage)](https://codeclimate.com/github/andriy-baran/easy_params/test_coverage)
 
 Provides an easy way to define structure, validation rules, type coercion, and default values for any hash-like structure. It's built on top of `ActiveModel`.
 

data/lib/easy_params/base.rb

@@ -16,6 +16,11 @@ module EasyParams
     end
 
     class << self
+      def inherited(subclass)
+        super
+        subclass.clone_schema(self)
+      end
+
       def name
         'EasyParams::Base'
       end
@@ -54,11 +59,23 @@ module EasyParams
 
       def array(param_name, of:, default: nil, normalize: nil, **validations)
         validates param_name, **validations if validations.any?
-        type = EasyParams::Types::Array.of(EasyParams::Types.const_get(of.to_s.camelcase))
+        type = EasyParams::Types::Array.of(EasyParams.types[of])
         type = customize_type(type, default, &normalize)
         attribute(param_name, type)
       end
 
+      def clone_schema(parent)
+        @schema = parent.schema.dup
+      end
+
+      def define_type_method(type_name)
+        define_singleton_method(type_name) do |param_name, default: nil, normalize: nil, **validations|
+          validates param_name, **validations if validations.any?
+          type = customize_type(EasyParams.types[type_name], default, &normalize)
+          attribute(param_name, type)
+        end
+      end
+
       private
 
       def customize_type(type, default, &normalize)
@@ -68,16 +85,6 @@ module EasyParams
       end
     end
 
-    %w[Integer Decimal Float Bool String Date DateTime Time].each do |type_name|
-      send(:define_singleton_method,
-           type_name.underscore) do |param_name, default: nil, normalize: nil, **validations|
-        validates param_name, **validations if validations.any?
-        type = EasyParams::Types.const_get(type_name)
-        type = customize_type(type, default, &normalize)
-        attribute(param_name, type)
-      end
-    end
-
     def attributes
       self.class.schema.to_h { |k, type| [k, type.array? ? send(k).to_a : send(k)] }
     end

data/lib/easy_params/types.rb

@@ -2,37 +2,7 @@
 
 module EasyParams
   module Types
-    class CoercionError < StandardError; end
-
-    BOOLEAN_MAP =
-      { '1' => true, 't' => true, 'true' => true, 'True' => true, 'TRUE' => true, 'T' => true }.merge(
-        { '0' => false, 'f' => false, 'false' => false, 'False' => false, 'FALSE' => false, 'F' => false }
-      ).freeze
-
-    Struct    = EasyParams::Base.new
-    Array     = Collection.new(:array)
-    Each      = StructsCollection.new(:array_of_structs)
-    Integer   = Generic.new(:integer, &:to_i)
-    Float     = Generic.new(:float, &:to_f)
-    String    = Generic.new(:string, &:to_s)
-    Decimal   = Generic.new(:decimal) { |v| v.to_f.to_d }
-    Bool      = Generic.new(:bool) do |v|
-      BOOLEAN_MAP.fetch(v.to_s) { raise CoercionError }
-    end
-    Date = Generic.new(:date) do |v|
-      ::Date.parse(v)
-    rescue ArgumentError, RangeError
-      raise CoercionError, 'cannot be coerced'
-    end
-    DateTime = Generic.new(:datetime) do |v|
-      ::DateTime.parse(v)
-    rescue ArgumentError
-      raise CoercionError, 'cannot be coerced'
-    end
-    Time = Generic.new(:time) do |v|
-      ::Time.parse(v)
-    rescue ArgumentError
-      raise CoercionError, 'cannot be coerced'
-    end
+    Array = Collection.new(:array)
+    Each = StructsCollection.new(:array_of_structs)
   end
 end

data/lib/easy_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyParams
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/lib/easy_params.rb

@@ -10,7 +10,50 @@ require 'easy_params/base'
 require 'easy_params/types'
 require 'easy_params/version'
 
+# EasyParams provides a simple way to define parameter classes with type coercion and validation
 module EasyParams
   class Error < StandardError; end
-  # Your code goes here...
+  class CoercionError < StandardError; end
+
+  def self.types
+    @types ||= {}
+  end
+
+  def self.register_type(name, type = nil, &coerce_proc)
+    if type.nil? && coerce_proc
+      type = Types::Generic.new(name, &coerce_proc)
+    elsif type.nil? && !coerce_proc
+      raise ArgumentError, 'Either a type instance or a coercion block must be provided'
+    end
+    types[name] = type
+    Base.define_type_method(name)
+  end
+
+  BOOLEAN_MAP =
+    { '1' => true, 't' => true, 'true' => true, 'True' => true, 'TRUE' => true, 'T' => true }.merge(
+      { '0' => false, 'f' => false, 'false' => false, 'False' => false, 'FALSE' => false, 'F' => false }
+    ).freeze
+
+  register_type :integer, &:to_i
+  register_type :float, &:to_f
+  register_type :string, &:to_s
+  register_type(:decimal) { |v| v.to_f.to_d }
+  register_type(:bool) do |v|
+    BOOLEAN_MAP.fetch(v.to_s) { raise CoercionError }
+  end
+  register_type(:date) do |v|
+    ::Date.parse(v)
+  rescue ArgumentError, RangeError
+    raise CoercionError, 'cannot be coerced'
+  end
+  register_type(:datetime) do |v|
+    ::DateTime.parse(v)
+  rescue ArgumentError
+    raise CoercionError, 'cannot be coerced'
+  end
+  register_type(:time) do |v|
+    ::Time.parse(v)
+  rescue ArgumentError
+    raise CoercionError, 'cannot be coerced'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_params
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrii Baran