simple_value 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b5fa33c85148a84a10955b2964e59cf3e16c3b33a7cbf0236b69eb39d0aacce
+  data.tar.gz: d00257b7fa3d4f4dcaed10067d10188ba07ad112da972709db74235e7a7fa3c1
+SHA512:
+  metadata.gz: 873cbb1bac3bc65a6f2c69361c5bd6e144fd8c3d244299fd3b274e8904ad21607ade2a3027726c9889f5b68e0feb2abf21ddd60dbc115d0abeb3d1916e74604b
+  data.tar.gz: f50110600cd0e1474b985caf54af0ea2241768c0004987a2164be668531df5dfb5f619fed36bdddadae06a57dfe5b7d9cc2fc065e081cd7745bc2d63128a1306

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matous Vokal
+
+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,93 @@
+# SimpleValue
+
+A tiny Ruby gem for using value objects in your models. Create a plain Ruby class to represent the value object. Then easily use it in a model by extending `SimpleValue::Model` and using the `value_object` macro.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_value'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_value
+
+## Usage
+
+Let's suppose that we have a `User` model with a `phone` attribute. Currently, `User` validates the format of the phone number, which is stored as a string in the database.  
+
+```ruby
+class User < ApplicationRecord
+  before_validation :format_phone
+
+  validate :phone_validation
+
+  private
+
+  def format_phone
+    # logic for formatting the phone number
+  end
+
+  def phone_validation
+    # complicated validation logic
+  end
+end
+```
+
+The rest of the application is already written to use a string when interacting with a `User`. We can still move the validation and whatever other logic related to the phone number into a separate class.
+
+Moving the logic into its own class also prevents duplication in case another model needs to have a phone number. It can then simply use the same value object.
+
+```ruby
+class Phone
+  include ActiveModel::Validations
+
+  attr_reader :value
+
+  validate :validate_number
+
+  def initialize(value)
+    @value = format_number value
+  end
+
+  private
+
+  def format_number(number)
+    # logic for formatting the phone number
+  end
+
+  def validate_number
+    # complicated validation logic
+  end
+end
+```
+
+We can use the same DSL for validations in any class just by including `ActiveModel::Validations`. This way it is possible to easily move the phone validation from the `User` model to the new `Phone` class.  
+
+Currently this gem works for value objects that take a single required argument in their initializer. The value object also needs an `attr_reader` for its value (value is the default name, but it can be sometihng else).  
+
+The only thing left to do is to make the `User` model use the new value object. It needs to extends `SimpleValue::Model` in order to get access to the `value_object` macro.
+
+```ruby
+class User < ApplicationRecord
+  extend SimpleValue::Model
+
+  value_object :phone, Phone, validate: true
+end
+```
+
+The first argument of `value_object` is a symbol with the name of the attribute used to initialize the value object. The second arument is the class used for the value object.
+
+There are also two optional parameters for `value_object`. `validate` is set to false by default, if set to true, it will use whatever validations are in the value object and add the errors to the base of the model's errors.
+
+The second optional parameter is the name of the `attr_reader` used to get the value from the value object. By default it is set to `:value`.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_value"
+
+# 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/lib/simple_value/model.rb

@@ -0,0 +1,27 @@
+module SimpleValue
+  module Model
+    def value_object(attr_name, value_class, validate: false, value: :value)
+      attr_reader "#{attr_name}_object"
+
+      object_writer = "#{attr_name}_object=".to_sym
+      instance_reader = "@#{attr_name}_object".to_sym
+
+      define_method "#{attr_name}_object=" do |val|
+        instance_variable_set instance_reader, val
+        self[attr_name] = val.send value
+      end
+
+      define_method "#{attr_name}=" do |val|
+        send object_writer, value_class.new(val)
+      end
+
+      after_initialize do
+        send object_writer, value_class.new(self[attr_name])
+      end
+
+      return unless validate
+
+      validates_with Validator, "#{attr_name}_object".to_sym => attr_name
+    end
+  end
+end

data/lib/simple_value/validator.rb

@@ -0,0 +1,14 @@
+module SimpleValue
+  class Validator < ActiveModel::Validator
+    def validate(record)
+      options.each do |value_name, attribute_name|
+        value_object = record.send value_name
+        next if value_object.valid?
+
+        value_object.errors.each do |_, error|
+          record.errors.add attribute_name, error
+        end
+      end
+    end
+  end
+end

data/lib/simple_value/version.rb

@@ -0,0 +1,3 @@
+module SimpleValue
+  VERSION = "0.1.0"
+end

data/lib/simple_value.rb

@@ -0,0 +1,4 @@
+require 'simple_value/version'
+
+module SimpleValue
+end

data/simple_value.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_value/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_value"
+  spec.version       = SimpleValue::VERSION
+  spec.authors       = ["Matous Vokal"]
+  spec.email         = ["vokalmat@gmail.com"]
+
+  spec.summary       = "Simple value objects for your models"
+  spec.description   = "Tiny gem for moving logic from models into separate value objects"
+  spec.homepage      = "https://github.com/Sorc96/simple_value"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Sorc96/simple_value"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "activemodel"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: simple_value
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matous Vokal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-15 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: '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: activemodel
+  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'
+description: Tiny gem for moving logic from models into separate value objects
+email:
+- vokalmat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_value.rb
+- lib/simple_value/model.rb
+- lib/simple_value/validator.rb
+- lib/simple_value/version.rb
+- simple_value.gemspec
+homepage: https://github.com/Sorc96/simple_value
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Sorc96/simple_value
+  source_code_uri: https://github.com/Sorc96/simple_value
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Simple value objects for your models
+test_files: []