contracted_value 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec55efa08a60e3b4f73c1b8813af1a6a188493c6a870a08083d008dbff19a18
-  data.tar.gz: 70a611199db2edce337a2571b3a5ef22be515081c671ef64aff389658e6d3c39
+  metadata.gz: 761fdc9b4b487bb54d59724fa87a6e2e3ca1665cae0774bc2f7cdcf50d076913
+  data.tar.gz: c051835f898ce826968eb7616fc414ffeff3677926b48d001904528432354a88
 SHA512:
-  metadata.gz: b709ba4fd278372200a7b97379ba6fb69eb73099e9c13c0006537c6de921aa5228242b5d742f6c46c4969da89789b2edd40672a184fe5074d62101db5e3e09ac
-  data.tar.gz: efdd16b4cc5343a984105a3ac19e98caab7f88b5e399793cd99f94753f57711f4cf821d3ff9daeee864158248e3a47b7beeec3da058cfc3c3839d9973fc888ae
+  metadata.gz: a6d714074711c3d1ef3856e15cf2ba4e0035f90c493cdebe485d90aef52990f8b03d0055c0a96d7f34ccbbc1b230e0f905ea7baf8258200e739ec0bdd0b3cb87
+  data.tar.gz: 7543ae38d5eddb8b0304a7171caec91b4472b66210752c79783b481ee07b32b34924d122db46cf90442ed6127fe4055d862224b3c49b1f0c33b1d07fb53753cc

data/.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+*       @PikachuEXE
+
+# Order is important. The last matching pattern has the most precedence.
+# So if a pull request only touches javascript files, only these owners
+# will be requested to review.
+# *.rb    @PikachuEXE
+
+# You can also use email addresses if you prefer.
+# docs/*  docs@example.com

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github:
+  - PikachuEXE

data/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:00"
+      timezone: Asia/Hong_Kong
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:00"
+      timezone: Asia/Hong_Kong
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"

data/.github/workflows/coverage.yml

@@ -0,0 +1,63 @@
+name: Coverage
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - 'README.md'
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - 'README.md'
+
+jobs:
+  coverage:
+    name: Coverage
+    # Homemade support for [ci skip] no longer needed
+    # https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/
+    # if: "contains(github.event.commits[0].message, '[ci skip]') == false"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby:
+          - "2.7"
+        gemfile:
+          - gemfiles/contracts_16_0.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      COVERALLS: true
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Collect coverage info
+        run: bundle exec rake spec
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        continue-on-error: true
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ matrix.ruby }}-${{ matrix.gemfile }}
+          parallel: true
+
+  finish:
+    needs: coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send to Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.github/workflows/tests.yaml

@@ -0,0 +1,56 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - 'README.md'
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - 'README.md'
+
+jobs:
+  unit_tests:
+    name: Unit Tests
+    # Homemade support for [ci skip] no longer needed
+    # https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/
+    # if: "contains(github.event.commits[0].message, '[ci skip]') == false"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby:
+          - "3.0"
+          - "3.1"
+        gemfile:
+          - gemfiles/contracts_17_0.gemfile
+        allow_failures:
+          - false
+        include:
+          - os: ubuntu-latest
+            ruby: "2.7"
+            gemfile: gemfiles/contracts_16_0.gemfile
+            allow_failures: false
+          - os: ubuntu-latest
+            ruby: "ruby-head"
+            gemfile: gemfiles/contracts_17_0.gemfile
+            allow_failures: true
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+      ALLOW_FAILURES: "${{ matrix.allow_failures }}"
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake spec || $ALLOW_FAILURES

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-appraise "contracts_15_0" do
-  gem "contracts", "~> 0.15.0"
-end
-
 appraise "contracts_16_0" do
   gem "contracts", "~> 0.16.0"
 end

data/CHANGELOG.md

@@ -18,6 +18,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [Unreleased]
+
+### Changed
+
+- Requires Ruby 2.7 (due to use of ["Forward all arguments" syntax](https://rubyreferences.github.io/rubychanges/2.7.html#keyword-argument-related-changes))
+
+### Fixed
+
+- Fix Ruby 3.x compatibility
+
+
 ## 0.1.0 - 2019-06-05
 
 ### Added

data/README.md

@@ -2,15 +2,6 @@
 
 Library for creating contracted immutable(by default) value objects
 
-[![Gem Version](http://img.shields.io/gem/v/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)
-[![License](https://img.shields.io/github/license/PikachuEXE/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)
-
-[![Build Status](http://img.shields.io/travis/PikachuEXE/contracted_value.svg?style=flat-square)](https://travis-ci.org/PikachuEXE/contracted_value)
-
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/PikachuEXE/contracted_value.svg?style=flat-square)](https://codeclimate.com/github/PikachuEXE/contracted_value)
-[![Coverage Status](https://img.shields.io/codecov/c/github/PikachuEXE/contracted_value.svg?style=flat-square)](https://codecov.io/gh/PikachuEXE/contracted_value)
-
-
 This gem allows creation of value objects which are
 - contracted (enforced by [`contracts.ruby`](https://github.com/egonSchiele/contracts.ruby))
 - immutable (enforced by [`ice_nine`](https://github.com/dkubb/ice_nine))
@@ -18,6 +9,19 @@ This gem allows creation of value objects which are
 See details explanation in below sections
 
 
+## Status
+
+[![GitHub Build Status](https://img.shields.io/github/workflow/status/PikachuEXE/contracted_value/Tests?style=flat-square)](https://github.com/PikachuEXE/contracted_value/actions?query=workflow%3ATests)
+
+[![Gem Version](http://img.shields.io/gem/v/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)
+[![License](https://img.shields.io/github/license/PikachuEXE/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)
+
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/PikachuEXE/contracted_value.svg?style=flat-square)](https://codeclimate.com/github/PikachuEXE/contracted_value)
+[![Coverage Status](http://img.shields.io/coveralls/PikachuEXE/contracted_value.svg?style=flat-square)](https://coveralls.io/r/PikachuEXE/contracted_value)
+
+> The above badges are generated by https://shields.io/
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -146,6 +150,36 @@ location_range = ::Geometry::LocationRange::Entry.new(location)
 
 ```
 
+#### Passing objects of different `ContractedValue::Value` subclasses to `.new`
+Possible due to the implementation calling `#to_h` for `ContractedValue::Value` objects  
+But in case the attribute names are different, or adding new attributes/updating existing attributes is needed  
+You will need to call `#to_h` to get a `Hash` and do whatever modification needed before passing into `.new`  
+
+```ruby
+class Pokemon < ::ContractedValue::Value
+  attribute(:name)
+  attribute(:type)
+end
+
+class Pikachu < ::Pokemon
+  attribute(:name, default_value: "Pikachu")
+  attribute(:type, default_value: "Thunder")
+end
+
+# Ya I love using pokemon as examples, problem?
+pikachu = Pikachu.new(name: "PikaPika")
+pikachu.name #=> "PikaPika"
+pikachu.type #=> "Thunder"
+
+pokemon1 = Pokemon.new(pikachu)
+pokemon1.name #=> "PikaPika"
+pokemon1.type #=> "Thunder"
+
+pokemon2 = Pokemon.new(pikachu.to_h.merge(name: "Piak"))
+pokemon2.name #=> "Piak"
+pokemon2.type #=> "Thunder"
+```
+
 
 ### Input Validation
 
@@ -154,9 +188,9 @@ Input values are validated on object creation (instead of on attribute value acc
 - Value presence
 
 #### Value contract
-An attribute can be declared without any contract, and any input value would be pass the validation
-But you can pass a contract via `contract` option (must be a [`contracts.ruby`](https://github.com/egonSchiele/contracts.ruby) contract)
-Passing input value violating an attribute's contract would cause an error
+An attribute can be declared without any contract, and any input value would be pass the validation  
+But you can pass a contract via `contract` option (must be a [`contracts.ruby`](https://github.com/egonSchiele/contracts.ruby) contract)  
+Passing input value violating an attribute's contract would cause an error  
 
 ```ruby
 class YetAnotherRationalNumber < ::ContractedValue::Value
@@ -181,10 +215,10 @@ YetAnotherRationalNumber.new(
 ```
 
 #### Value presence
-An attribute declared should be provided a value on object creation, even the input value is `nil`
-Otherwise an error is raised
-You can pass default value via option `default_value`
-The default value will need to confront to the contract passed in `contract` option too
+An attribute declared should be provided a value on object creation, even the input value is `nil`  
+Otherwise an error is raised  
+You can pass default value via option `default_value`  
+The default value will need to confront to the contract passed in `contract` option too  
 
 
 ```ruby
@@ -289,6 +323,8 @@ end
 
 # Ya I love using pokemon as examples, problem?
 pikachu = Pikachu.new(name: "PikaPika")
+pikachu.name #=> "PikaPika"
+pikachu.type #=> "Thunder"
 ```
 
 #### All existing attributes can be redeclared  

data/contracted_value.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "ice_nine"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rake", ">= 10.0", "<= 13.0"
+  s.add_development_dependency "rake", ">= 10.0", "<= 14.0"
   s.add_development_dependency "pry"
 
   s.add_development_dependency "appraisal", "~> 2.0"
@@ -40,8 +40,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rspec-its", "~> 1.0"
 
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency "codecov"
+  s.add_development_dependency "simplecov", ">= 0.21"
+  s.add_development_dependency "simplecov-lcov", ">= 0.8"
 
   s.add_development_dependency "gem-release", ">= 0.7"
 
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rubocop", ">= 0.70"
 
-  s.required_ruby_version = ">= 2.3.0"
+  s.required_ruby_version = ">= 2.7.0"
 
   s.required_rubygems_version = ">= 1.4.0"
 end

data/gemfiles/{contracts_15_0.gemfile → contracts_17_0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "contracts", "~> 0.15.0"
+gem "contracts", "~> 0.17.0"
 
 gemspec path: "../"

data/lib/contracted_value/core.rb

@@ -131,7 +131,7 @@ module ContractedValue
   end
 
   class Attribute
-    def self.new(*)
+    def self.new(...)
       ::IceNine.deep_freeze(super)
     end
 

data/lib/contracted_value/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContractedValue
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/spec_helper.rb

@@ -1,15 +1,25 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
-require "contracted_value"
-
-if ENV["TRAVIS"]
+if ENV["COVERALLS"]
   require "simplecov"
-  SimpleCov.start
+  require "simplecov-lcov"
+
+  SimpleCov::Formatter::LcovFormatter.config do |c|
+    c.report_with_single_file = true
+    c.single_report_path = "coverage/lcov.info"
+  end
 
-  require "codecov"
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::LcovFormatter]
+  )
+
+  SimpleCov.start do
+    add_filter "spec/"
+  end
 end
 
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require "contracted_value"
+
 require "rspec"
 require "rspec/its"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracted_value
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - PikachuEXE
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -61,7 +61,7 @@ dependencies:
         version: '10.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '14.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '10.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,28 +134,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -208,9 +208,13 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".editorconfig"
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/coverage.yml"
+- ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -218,8 +222,8 @@ files:
 - README.md
 - Rakefile
 - contracted_value.gemspec
-- gemfiles/contracts_15_0.gemfile
 - gemfiles/contracts_16_0.gemfile
+- gemfiles/contracts_17_0.gemfile
 - lib/contracted_value.rb
 - lib/contracted_value/core.rb
 - lib/contracted_value/version.rb
@@ -230,7 +234,7 @@ homepage: http://github.com/PikachuEXE/contracted_value
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -238,15 +242,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.4.0
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.21
+signing_key:
 specification_version: 4
 summary: Some Tweaks for ActiveRecord
 test_files:

data/.travis.yml

@@ -1,25 +0,0 @@
-# Send builds to container-based infrastructure
-# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
-language: ruby
-before_install:
-  # This is required since 2.6.8 has issue when installing `rainbow`
-  # https://github.com/sickill/rainbow/issues/48
-  - gem update --system
-  - gem --version
-cache:
-  - bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-gemfile:
-  - gemfiles/contracts_15_0.gemfile
-  - gemfiles/contracts_16_0.gemfile
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: 2.7
-    - rvm: ruby-head