valued 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94acb8c6bb54e7ae03a0ed7c3be248769fab10001972b83a16469960e1428b4b
+  data.tar.gz: a50be06601f251cf3c426137f12c78473ff4a864de3f86fb596ba5cf377805ab
+SHA512:
+  metadata.gz: e885b302bd91434e22f8cc7b028a0d3d95aff9a82c63969bd408b76d085badc8fe2154965b8869a605ba92b17b23225dac4b640409a42c3fa4d0ba83267c6c07
+  data.tar.gz: 5fc71d72c26842ab38341721c11c2d1c72ba97cc4e14e416d0565db5a970f332392715b3fadfca4ac904258530b9d7f2dcfa61ea40581e940adad48b1ea97e53

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,84 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Exclude:
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - Rakefile
+    - Guardfile
+    - bin/*
+    - tmp/**/*
+  TargetRubyVersion: 2.6
+
+Style:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+    - "Rakefile"
+    - "*.gemspec"
+    - "apps/api/application.rb"
+    - "**/*.rake"
+
+Metrics/ClassLength:
+  CountComments: false
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+Metrics/MethodLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+Metrics/ModuleLength:
+  CountComments: false
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+require: rubocop-rspec
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valued.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    valued (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.4)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  rubocop-rspec (~> 1.38)
+  valued!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mario Mainz
+
+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,88 @@
+[![Build Status](https://travis-ci.org/mmainz/valued.svg?branch=master)](https://travis-ci.org/mmainz/valued)
+
+# Valued
+
+Valued is a Ruby gem that allows you to easily define value objects.
+
+In the past, I mainly used `Struct` for objects of this kind. However, structs
+in Ruby have some drawbacks, like the fact that they implement hash access with
+`[]`, which is undesirable if you want to use duck typing. Also, they require
+all their attributes to always be passed to their constructor, which makes it
+cumbersome to construct them from a JSON payload that may miss some optional
+attribute.
+
+You can of course also just implement those objects yourself, but that requires
+a lot of boilerplate, like implementing `==`, `inspect`, `to_h` and other
+methods you almost always need.
+
+With Valued, you can automatically define a `Struct`-like class that behaves
+properly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valued'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install valued
+
+## Usage
+
+Just include `Valued` in your class and then define `attributes`.
+
+```ruby
+require 'valued'
+
+class Quantity
+  include Valued
+
+  attributes :unit, :amount
+end
+```
+
+After that, you can use your class similarly to a struct. You construct an
+instance of it with a hash:
+
+```ruby
+quantity = Quantity.new(unit: 'm', amount: 2)
+p quantity.amount
+=> 2
+p quantity.unit
+=> 'm'
+```
+
+If you omit a parameter in the constructor, it is set to `nil`.
+
+```ruby
+quantity = Quantity.new(amount: 2)
+p quantity.unit
+=> nil
+```
+
+Classes defined with valued automatically implement `==`, `eql?`, `hash`,
+`to_h`, `to_s` and `inspect`.
+
+```ruby
+quantity = Quantity.new(amount: 2, unit: 'm')
+second_quantity = Quantity.new(amount: 2, unit: 'm')
+quantity == second_quantity
+=> true
+
+quantity.to_h
+=> {:amount=>2, :unit=>"m"}
+p quantity
+=> #<Quantity amount=2 unit="m">
+```
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/valued/version.rb

@@ -0,0 +1,3 @@
+module Valued
+  VERSION = '0.1.0'
+end

data/lib/valued.rb

@@ -0,0 +1,57 @@
+require 'valued/version'
+
+module Valued
+  module ClassMethods
+    def attributes(*attributes)
+      attributes.each { |attr| attr_reader attr }
+      define_method('_attributes') { attributes }
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def initialize(attributes = {})
+    _attributes.each do |attribute|
+      if attributes.key?(attribute)
+        instance_variable_set(
+          "@#{attribute}",
+          attributes.fetch(attribute).freeze
+        )
+      end
+    end
+  end
+
+  def ==(other)
+    _attributes.all? do |attribute|
+      other.respond_to?(attribute) && send(attribute) == other.send(attribute)
+    end
+  end
+
+  def eql?(other)
+    self.class == other.class && self == other
+  end
+
+  def hash
+    (_attributes.map { |attribute| send(attribute) } + [self.class]).hash
+  end
+
+  def to_h
+    _attributes.each_with_object({}) do |attribute, hash|
+      hash[attribute] = send(attribute)
+    end
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    inspected_attributes =
+      _attributes.map do |attribute|
+        "#{attribute}=#{send(attribute).inspect}"
+      end.join(' ')
+    "#<#{self.class} #{inspected_attributes}>"
+  end
+end

data/valued.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valued/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'valued'
+  spec.version = Valued::VERSION
+  spec.authors = ['Mario Mainz']
+  spec.email = %w[mainz.mario@googlemail.com]
+
+  spec.summary = 'A Ruby gem that makes it easy to create value objects.'
+  spec.homepage = 'https://github.com/mmainz/valued'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mmainz/valued'
+
+  spec.files =
+    Dir.chdir(File.expand_path('..', __FILE__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
+    end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.38'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: valued
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Mainz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '13.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+description: 
+email:
+- mainz.mario@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/valued.rb
+- lib/valued/version.rb
+- valued.gemspec
+homepage: https://github.com/mmainz/valued
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mmainz/valued
+  source_code_uri: https://github.com/mmainz/valued
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that makes it easy to create value objects.
+test_files: []