easy_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 331619d7efeaab6300de8cdab6fc2cbdfa31a8aae6d6211a141d7b2eb1bfaa43
+  data.tar.gz: 9ec2044c33541ade2819d765f4286c7d9080b41c74d62158de342d1debd55d4c
+SHA512:
+  metadata.gz: 148b681e8468a40e0dd53db862d63e8159df4f42f1bae58c38b32dd592f7ac55171488c3a7e665fcb419c495d75cd8b2c53768e2ae7b5c6a2421befc35ffce6d
+  data.tar.gz: 2364b2d0e41bcaac4c50f920e8afeec71d0425f28128a814bc9246de710777b7967ad4bc673ef0d4c7ba646f5d1efc7f9412c804fdc6d2004e00ebd13acdba4d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andriy.baran.v@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in easy_params.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    easy_params (0.1.0)
+      activemodel (>= 3.2, < 6.1)
+      dry-struct (~> 1.0)
+      dry-types (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.8)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (1.3.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-types (~> 1.3)
+      ice_nine (~> 0.11)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    minitest (5.14.2)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rspec_vars_helper (0.1.0)
+      rspec (>= 2.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  easy_params!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_vars_helper (~> 0.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrii Baran
+
+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

@@ -0,0 +1,83 @@
+# EasyParams
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_params'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install easy_params
+
+## Usage
+
+```ruby
+# app/params/api/v2/icqa/move_params.rb
+class Api::V1::Carts::MoveParams < EasyParams::Base
+  attribute :receive_cart_id, integer
+  attribute :i_am_sure, bool
+  attribute :location_code, string.default('')
+  attribute :sections, struct do
+    attribute :from, string
+    attribute :to, string
+  end
+  attribute :options, array.of(struct) do
+    attribute :option_type_count, integer
+    attribute :option_type_value, integer
+
+    validates :option_type_count, :option_type_value, presence: { message: "can't be blank" }
+  end
+
+  validates :receive_cart_id, :location_code, presence: { message: "can't be blank" }
+end
+```
+Validation messages for nested attributes will look like this.
+```ruby
+{
+  :"sections/0/id"=>an_instance_of(Array),
+  :"sections/0/post/id"=>an_instance_of(Array),
+  :"post/id"=>an_instance_of(Array),
+  :"post/sections/0/id"=>an_instance_of(Array)
+ }
+```
+Optionally you can use more compact form 
+```ruby
+class MyParams < EasyParams::Base
+  extend EasyParams::DSL
+
+  quantity integer.default(1)
+  posts each do
+    content string.default('')
+  end
+  user has do
+    role string
+  end
+end
+```
+More examples here [params_spec.rb](https://github.com/andriy-baran/easy_params/blob/master/spec/easy_params_spec.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_params. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/easy_params/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EasyParams project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easy_params/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_params"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_params.gemspec

@@ -0,0 +1,42 @@
+require_relative 'lib/easy_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easy_params'
+  spec.version       = EasyParams::VERSION
+  spec.authors       = ['Andrii Baran']
+  spec.email         = ['andriy.baran.v@gmail.com']
+
+  spec.summary       = %q{A tool that handles common tasks needed when working with params in Rails}
+  spec.description   = %q{Dessribe structure, validate and coerce values. Powered by dry-types and dry-struct}
+  spec.homepage      = 'https://github.com/andriy-baran/easy_params'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/andriy-baran/easy_params'
+  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  version_string = ['>= 3.2', '< 6.1']
+
+  spec.add_runtime_dependency 'activemodel', version_string
+
+  # spec.add_dependency 'dry-logic', '~> 0.4.2'
+  spec.add_dependency 'dry-struct', '~> 1.0'
+  spec.add_dependency 'dry-types', '~> 1.2'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_vars_helper', '~> 0.1'
+end

data/lib/easy_params.rb

@@ -0,0 +1,12 @@
+require 'dry-struct'
+require 'dry-types'
+require 'active_model'
+require 'easy_params/base'
+require 'easy_params/dsl'
+require 'easy_params/types'
+require 'easy_params/version'
+
+module EasyParams
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/easy_params/base.rb

@@ -0,0 +1,44 @@
+module EasyParams
+  class Base < Dry::Struct
+    include ActiveModel::Validations
+
+    transform_keys(&:to_sym)
+
+    def self.name
+      'EasyParams::Base'
+    end
+
+    %w[Integer Decimal Float Bool String Array Date DateTime Time Struct StructDSL].each do |type|
+      send(:define_singleton_method, type.underscore) { EasyParams::Types.const_get(type) }
+    end
+
+    validate do
+      validate_nested
+    end
+
+    def validate_nested
+      run_nested_validations = proc do |attr_name, value, array_index, error_key_prefix|
+        case value
+        when Array
+          value.each.with_index do |element, i|
+            run_nested_validations[attr_name, element, i, error_key_prefix]
+          end
+        when self.class.struct
+          if value.invalid?
+            error_key_components = [error_key_prefix, attr_name, array_index]
+            attr_error_key_prefix = error_key_components.compact.join('/')
+            value.errors.each do |error_key, error_message|
+              errors.add("#{attr_error_key_prefix}/#{error_key}", error_message)
+            end
+          end
+          value.attributes.each do |nested_attr_name, nested_value|
+            run_nested_validations[nested_attr_name, nested_value, nil, attr_error_key_prefix]
+          end
+        else
+          # NOOP
+        end
+      end
+      attributes.each(&run_nested_validations)
+    end
+  end
+end

data/lib/easy_params/dsl.rb

@@ -0,0 +1,15 @@
+module EasyParams
+  module DSL
+    def each(&block)
+      array.of(struct_dsl, &block)
+    end
+
+    def has(&block)
+      struct_dsl(&block)
+    end
+
+    def method_missing(method_name, *args, &block)
+      public_send(:attribute, method_name, *args, &block)
+    end
+  end
+end

data/lib/easy_params/types.rb

@@ -0,0 +1,16 @@
+module EasyParams
+  module Types
+    include Dry::Types.module
+    Struct    = EasyParams::Base.meta(omittable: true)
+    StructDSL = ::Class.new(EasyParams::Base).extend(EasyParams::DSL).meta(omittable: true)
+    Integer   = Params::Integer.optional.meta(omittable: true).default(nil)
+    Decimal   = Params::Decimal.optional.meta(omittable: true).default(nil)
+    Float     = Params::Float.optional.meta(omittable: true).default(nil)
+    Bool      = Strict::Bool.optional.meta(omittable: true).default(nil)
+    String    = String.optional.meta(omittable: true).default(nil)
+    Array     = Array.of(Struct).meta(omittable: true).default([])
+    Date      = Params::Date.optional.meta(omittable: true).default(nil)
+    DateTime  = Params::DateTime.optional.meta(omittable: true).default(nil)
+    Time      = Params::Time.optional.meta(omittable: true).default(nil)
+  end
+end

data/lib/easy_params/version.rb

@@ -0,0 +1,3 @@
+module EasyParams
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: easy_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrii Baran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_vars_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Dessribe structure, validate and coerce values. Powered by dry-types
+  and dry-struct
+email:
+- andriy.baran.v@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_params.gemspec
+- lib/easy_params.rb
+- lib/easy_params/base.rb
+- lib/easy_params/dsl.rb
+- lib/easy_params/types.rb
+- lib/easy_params/version.rb
+homepage: https://github.com/andriy-baran/easy_params
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andriy-baran/easy_params
+  source_code_uri: https://github.com/andriy-baran/easy_params
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A tool that handles common tasks needed when working with params in Rails
+test_files: []