veils 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19af8ae77a2a277d8a7ef77fd012b5bb32c3cfed92a7bd26230443d00f38b383
-  data.tar.gz: 8a47dde0ce90a85e003d516dd2342750bfaf65dcf1aeed219225e1fdbb08dc0a
+  metadata.gz: d99efbe23df9b3d5cd3841fa0f9a0c2c718b0962f1099fba7f2643ea2aa56cfd
+  data.tar.gz: 2d02c6413c4cb4289266f42924b4d3649b1604e47c3e12bb404c605e3e55d124
 SHA512:
-  metadata.gz: 9778a8b8ca3d9bfb8a791dadaac136dba1314a135d50d5cf8923c6fb32ded4664d59d4e4fd9693058c779440b6bd92811b6c4e7e7c781c2ad89453db659f815d
-  data.tar.gz: 26bfde820b534a74f1a63ca73b8ca1bb77e760480eb4f236d24a9102b169041d2642b0d44ea0ac0ab5b4bf71310240880ce9f69538c32362b2dd26af4d720bb9
+  metadata.gz: d6a93d529548ef92f5a5b280b8fa12bf1febb125314f91debb2fdf626c66a9acc521a91c2109bb20d5a3b27c65499220b95a5f447793cbcaf68ac6c2443c7f91
+  data.tar.gz: 62cb2d7f4358289997c01c0632ea230fd0dbbb8e53af99cde363648fa046cbcc02202f069fcb0e66d125e9430693f61ea966e587b8c9b36b10326dc5c9ac3302

data/README.md

@@ -13,6 +13,9 @@
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/veils)](https://hitsofcode.com/view/github/yegor256/veils)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/veils/blob/master/LICENSE.txt)
 
+Read this blog post first:
+[Veil Objects to Replace DTOs](https://www.yegor256.com/2020/05/19/veil-objects.html)
+
 First, install it:
 
 ```bash
@@ -29,7 +32,26 @@ obj = Veil.new(obj, to_s: 'Hello, world!')
 The method `to_s` will return `Hello, world!` until some other
 method is called and the veil is "pierced."
 
-Keep in mind that `Veil` is thread-safe.
+You can also use `Unpiercable` decorator, which will never be pierced:
+a very good instrument for data memoization.
+
+You can also try `AlterOut`, which lets you modify the output
+of object methods on fly:
+
+```ruby
+require 'alterout'
+obj = AlterOut.new(obj, to_s: proc { |s| s + 'extra tail' })
+```
+
+There is also `AlterIn` decorator, to modify incoming method arguments
+(the result of the `proc` will replace the list of input arguments):
+
+```ruby
+require 'alterin'
+obj = AlterIn.new(obj, print: proc { |i| [i + 1] })
+```
+
+Keep in mind that all classes are thread-safe.
 
 ## How to contribute
 

data/Rakefile

@@ -24,8 +24,6 @@ require 'rubygems'
 require 'rake'
 require 'rake/clean'
 
-CLEAN = FileList['coverage']
-
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')
 end

data/lib/alterin.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2020 Yegor Bugayenko
+#
+# 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.
+
+# Decorator to modify method inputs.
+#
+# For more information read
+# {README}[https://github.com/yegor256/veils/blob/master/README.md] file.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2020 Yegor Bugayenko
+# License:: MIT
+class AlterIn
+  def initialize(origin, methods = {})
+    @origin = origin
+    @methods = methods
+  end
+
+  def to_s
+    method_missing(:to_s)
+  end
+
+  def to_json(options = nil)
+    return @origin.to_a.to_json(options) if @origin.is_a?(Array)
+    method_missing(:to_json, options)
+  end
+
+  def method_missing(*args)
+    method = args[0]
+    unless @origin.respond_to?(method)
+      raise "Method #{method} is absent in #{@origin}"
+    end
+    inputs = args[1..-1]
+    inputs = @methods[method].call(inputs) if @methods.key?(method)
+    if block_given?
+      @origin.__send__(*([method] + inputs)) do |*a|
+        yield(*a)
+      end
+    else
+      @origin.__send__(*([method] + inputs))
+    end
+  end
+
+  def respond_to?(method, include_private = false)
+    @origin.respond_to?(method, include_private) || @methods[method]
+  end
+
+  def respond_to_missing?(_method, _include_private = false)
+    true
+  end
+end

data/lib/alterout.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2020 Yegor Bugayenko
+#
+# 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.
+
+# Decorator to modify method outputs.
+#
+# For more information read
+# {README}[https://github.com/yegor256/veils/blob/master/README.md] file.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2020 Yegor Bugayenko
+# License:: MIT
+class AlterOut
+  def initialize(origin, methods = {})
+    @origin = origin
+    @methods = methods
+  end
+
+  def to_s
+    method_missing(:to_s)
+  end
+
+  def to_json(options = nil)
+    return @origin.to_a.to_json(options) if @origin.is_a?(Array)
+    method_missing(:to_json, options)
+  end
+
+  def method_missing(*args)
+    method = args[0]
+    unless @origin.respond_to?(method)
+      raise "Method #{method} is absent in #{@origin}"
+    end
+    out =
+      if block_given?
+        @origin.__send__(*args) do |*a|
+          yield(*a)
+        end
+      else
+        @origin.__send__(*args)
+      end
+    out = @methods[method].call(out) if @methods.key?(method)
+    out
+  end
+
+  def respond_to?(method, include_private = false)
+    @origin.respond_to?(method, include_private) || @methods[method]
+  end
+
+  def respond_to_missing?(_method, _include_private = false)
+    true
+  end
+end

data/test/test_alterin.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2020 Yegor Bugayenko
+#
+# 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.
+
+require 'minitest/autorun'
+require 'json'
+require_relative '../lib/alterin'
+
+# AlterIn test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2020 Yegor Bugayenko
+# License:: MIT
+class AlterInTest < Minitest::Test
+  def test_simple
+    obj = Object.new
+    def obj.plus(first, second)
+      first + second
+    end
+    foo = AlterIn.new(obj, plus: proc { |a, b| [a + 1, b + 1] })
+    assert_equal(7, foo.plus(2, 3))
+  end
+end

data/test/test_alterout.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2020 Yegor Bugayenko
+#
+# 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.
+
+require 'minitest/autorun'
+require 'json'
+require_relative '../lib/alterout'
+
+# AlterOut test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2020 Yegor Bugayenko
+# License:: MIT
+class AlterOutTest < Minitest::Test
+  def test_simple
+    obj = Object.new
+    def obj.read(val)
+      val
+    end
+    foo = AlterOut.new(obj, read: proc { |r| r + 1 })
+    assert_equal(6, foo.read(5))
+  end
+end

data/test/test_unpiercable.rb

@@ -24,13 +24,13 @@
 
 require 'minitest/autorun'
 require 'json'
-require_relative '../lib/veil'
+require_relative '../lib/unpiercable'
 
 # Veil test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2020 Yegor Bugayenko
 # License:: MIT
-class VeilTest < Minitest::Test
+class UnpiercableTest < Minitest::Test
   def test_simple
     obj = Object.new
     def obj.read(foo)
@@ -42,7 +42,7 @@ class VeilTest < Minitest::Test
     assert_equal(1, foo.read(5))
     foo.to_s
     foo.touch
-    assert_equal(5, foo.read(5))
+    assert_equal(1, foo.read(5))
   end
 
   def test_behaves_like_array_with_json

data/veils.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'veils'
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'Ruby Veil Objects'
   s.description = 'Decorate your existing Ruby object with veils

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -100,9 +100,13 @@ files:
 - README.md
 - Rakefile
 - appveyor.yml
+- lib/alterin.rb
+- lib/alterout.rb
 - lib/unpiercable.rb
 - lib/veil.rb
 - logo.svg
+- test/test_alterin.rb
+- test/test_alterout.rb
 - test/test_unpiercable.rb
 - test/test_veil.rb
 - veils.gemspec
@@ -131,5 +135,7 @@ signing_key:
 specification_version: 2
 summary: Ruby Veil Objects
 test_files:
+- test/test_alterin.rb
+- test/test_alterout.rb
 - test/test_unpiercable.rb
 - test/test_veil.rb