reasonable-value 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53d73215512ebc2cc1a5e62547ba69d63fd93a12
+  data.tar.gz: 9a9973e5f2791acb93601dc0051a2020e4680d8f
+SHA512:
+  metadata.gz: 318aa3ca1bc5fafe0a3c0feeee442007066b2fd562294b90cad0893c9e04698ec1208cf1d2eaf61d212c92bdba91564c55f18741ef86d513faf37a28ba1087e9
+  data.tar.gz: 98c79f526df7c612bcbe06e89952caf2a437965c90b9c31354fab1de8055b33edf1c747ce977715ed1057b6d2ac412270b065ebda843bf065facffe95c994b70

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--order random
+--color

data/.rubocop.yml

@@ -0,0 +1,85 @@
+AllCops:
+  # Use Ruby 2.3 parser
+  TargetRubyVersion: 2.3
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+ClassLength:
+  Max: 150
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - 'spec/**/*'
+
+Style/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # things with the previous or next line, not counting empty lines or comment
+  # lines.
+  AllowForAlignment: true
+
+Style/LambdaCall:
+  Enabled: true
+  EnforcedStyle: braces
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+  SupportedStyles:
+    - empty_lines
+    - no_empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+  SupportedStyles:
+    - empty_lines
+    - no_empty_lines
+
+Style/EmptyLinesAroundBlockBody:
+  Description: "Keeps track of empty lines around block bodies."
+  Enabled: false
+
+Style/EmptyLines:
+  Description: "Don't use several empty lines in a row."
+  Enabled: true
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EndOfLine:
+  Description: 'Use Unix-style line endings.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#crlf'
+  Enabled: true
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/WordArray:
+  Description: 'Use %w or %W for arrays of words.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+- 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby '2.4.1'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Thomas Larrieu
+
+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,132 @@
+# Reasonable::Value
+
+Reasonable::Value is a value object implementation in its smallest possible
+form.
+
+## Why another implementation ?
+
+### Virtus
+  [Virtus](https://github.com/solnic/virtus) does too many things and is
+  deprecated in favor of [dry-struct](https://github.com/dry-rb/dry-struct)
+
+### dry-struct
+I felt that [dry-struct](https://github.com/dry-rb/dry-struct) was
+1. Not documented enough
+2. Did not properly handle "truly" optional attributes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reasonable-value'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reasonable-value
+
+## Usage
+
+By default attributes are mandatory, but corcible (meaning that passing a Float
+when an Integer is expected will **not** raise an error:
+``` ruby
+class StandardValue < Reasonable::Value
+
+  attribute :integer, Integer
+
+end
+
+p StandardValue.new
+# => TypeError: expected :integer to be a Integer but was a NilClass
+
+p StandardValue.new(integer: nil)
+# => TypeError: expected :integer to be a Integer but was a NilClass
+
+p StandardValue.new(integer: 1)
+# => #<StandardValue:0x007f65ec156720 @attributes={:integer=>1}>
+
+p StandardValue.new(integer: 1.1)
+# => #<StandardValue:0x007f65ec166738 @attributes={:integer=>1}>
+```
+
+If you want optional attributes, you can say so like that:
+``` ruby
+class OptionalValue < Reasonable::Value
+
+  attribute :string, String, optional: true
+
+end
+
+p OptionalValue.new
+# => #<OptionalValue:0x0055ecec2ae2c8 @attributes={}>
+
+p OptionalValue.new(string: nil)
+# => #<OptionalValue:0x007f65ec16c430 @attributes={}>
+
+p OptionalValue.new(string: 'string')
+# => #<OptionalValue:0x007f65ec174f18 @attributes={:string=>"string"}>
+
+p OptionalValue.new(string: 1.1)
+# => #<OptionalValue:0x007f65ec1792e8 @attributes={:string=>"1.1"}>
+```
+
+You are not limited to Integer or String, you can use any type you want:
+``` ruby
+class ValueWithCustomType < Reasonable::Value
+
+  attribute :custom, StandardValue
+
+end
+
+p ValueWithCustomType.new(custom: StandardValue.new(integer: 1))
+# => #<ValueWithCustomType:0x007f65ec18d540 @attributes={:custom=>#<StandardValue:0x007f65ec18d6a8 @attributes={:integer=>1}>}>
+
+p ValueWithCustomType.new(custom: { integer: 1 })
+# => #<ValueWithCustomType:0x007f65ec19f920 @attributes={:custom=>#<StandardValue:0x007f65ec19f358 @attributes={:integer=>1}>}>
+```
+
+If you define the appropriate method on the class of the attribute,
+Reasonable::Value will handle casting gracefully:
+``` ruby
+class CastableType
+
+  def to_standard_value
+    StandardValue.new(integer: 1)
+  end
+
+end
+
+p ValueWithCustomType.new(custom: CastableType.new)
+# => #<ValueWithCustomType:0x007f65ec1a6590 @attributes={:custom=>#<StandardValue:0x007f65ec1a5bb8 @attributes={:integer=>1}>}>
+```
+
+Equality is based on attributes, instead of identity:
+
+``` ruby
+p StandardValue.new(integer: 1) == StandardValue.new(integer: 1)
+# => true
+
+p StandardValue.new(integer: 1) == StandardValue.new(integer: 2)
+# => false
+```
+
+## 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]/reasonable-value.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'reasonable/value'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/reasonable/value.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'reasonable/value/version'
+require 'active_support/core_ext/string/inflections'
+
+module Reasonable
+  class Value
+
+    include Comparable
+    def <=>(other)
+      @attributes <=> other.instance_variable_get(:@attributes)
+    end
+
+    def initialize(**attributes)
+      @attributes = {}
+
+      self.class.send(:config).each do |name, config|
+        next if attributes[name].nil? && config[:options][:optional]
+
+        @attributes[name] = coerce(attributes, name, config)
+      end
+    end
+
+    class << self
+
+      def inherited(subklass)
+        config.each do |name, config|
+          subklass.attribute(name, config[:type], options: config[:options])
+        end
+      end
+
+      protected
+
+      def attribute(name, type, **options)
+        mutex.synchronize { config[name] = { type: type, options: options } }
+
+        define_method(name) { @attributes[name] }
+      end
+
+      private
+
+      def mutex
+        return @mutex if defined?(@mutex)
+
+        @mutex = Thread::Mutex.new
+      end
+
+      def config
+        return @config if defined?(@config)
+
+        @config = {}
+      end
+
+    end
+
+    private
+
+    def coerce(attributes, name, config)
+      Coercer.(config[:type], attributes[name])
+    rescue TypeError
+      type_error(name, config[:type], attributes[name].class)
+    end
+
+    def type_error(name, expected, actual)
+      raise(
+        TypeError,
+        "expected :#{name} to be a #{expected} but was a #{actual}"
+      )
+    end
+
+    class Coercer
+
+      class << self
+
+        def call(type, value)
+          built_in(type, value) || custom(type, value)
+        end
+
+        private
+
+        def built_in(type, value)
+          return unless Kernel.respond_to?(type.to_s)
+
+          Kernel.public_send(type.to_s, value)
+        end
+
+        def custom(type, value)
+          return value if value.is_a?(type)
+
+          if value.respond_to?("to_#{type.to_s.underscore}")
+            return value.public_send("to_#{type.to_s.underscore}")
+          end
+
+          raise TypeError unless value.is_a?(Hash)
+          raise TypeError unless type.ancestors.include?(Reasonable::Value)
+
+          type.new(value)
+        end
+
+      end
+
+    end
+    private_constant :Coercer
+
+  end
+end

data/lib/reasonable/value/version.rb

@@ -0,0 +1,7 @@
+module Reasonable
+  class Value
+
+    VERSION = '0.2.1'.freeze
+
+  end
+end

data/reasonable-value.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reasonable/value/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'reasonable-value'
+  spec.version = Reasonable::Value::VERSION
+  spec.authors = ['Thomas Larrieu']
+  spec.email = ['thomas.larrieu@gmail.com']
+
+  spec.summary = 'Simple value object gem with straighforward type validation'
+  spec.homepage = 'https://www.github.com/jobteaser/reasonable-value'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 = %w(lib)
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: reasonable-value
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Thomas Larrieu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- thomas.larrieu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reasonable/value.rb
+- lib/reasonable/value/version.rb
+- reasonable-value.gemspec
+homepage: https://www.github.com/jobteaser/reasonable-value
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Simple value object gem with straighforward type validation
+test_files: []