decoratable 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0090c17ce4e8f9334a6bdebfb059b47fb7c7350d'
-  data.tar.gz: 185f96d6a0f5402dda2d66eb913f731ce1944a39
+  metadata.gz: 4faaa57297c2f587f2d751980cee3d857b0442a7
+  data.tar.gz: d6c7d401b73f284dbd4a9ff3a22f152e95481dc6
 SHA512:
-  metadata.gz: ae18c7e17a48897596a56bdcc3f8e97ccf83d45d34edbd3ee7bea5aeb7f24b66a6eaf3bde36bc7ae726c299fe0c20e5ee09022d179ecb4ef549caa15b33186a8
-  data.tar.gz: 6d6c3293e01975fe16a305fc4a9494a272c82fec94511eabe83b663ee63e122974c9361e39f992412c803fc7000d2a7bd773d52f9dfe390edb57b3270b87f80b
+  metadata.gz: cce79e57059864cf7b5d8414f71b077ace17d48231706ca0485ec50901dc6037a2e701ac98c9d2d24a39759cceee546b7f90007efb4a81723d7b89731c560efa
+  data.tar.gz: 14816d8694e7e63a38a85dad25f5f86f4b96e88e17cb14f516a4b07fd8d5950b7c8cd4f124581bfe5f1a8fb5f571af23d7028a2af4dc1bb13807fe152787efc9

data/decoratable.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "decoratable"
-  spec.version       = "0.0.4"
+  spec.version       = "0.0.5"
   spec.authors       = ["ecin"]
   spec.email         = ["ecin@copypastel.com"]
   spec.description   = "Decorate your methods."

data/lib/decoratable/classic.rb

@@ -0,0 +1,146 @@
+require "thread"
+
+# Public: provide an easy way to define decorations
+# that add common behaviour to a method.
+#
+# More info on decorations as implemented in Python:
+# http://en.wikipedia.org/wiki/Python_syntax_and_semantics#Decorators
+#
+# Examples
+#
+#   module Decorations
+#     extend Decoratable
+#
+#     def retryable(tries = 1, options = { on: [RuntimeError] })
+#       attempts = 0
+#
+#       begin
+#         yield
+#       rescue *options[:on]
+#         attempts += 1
+#         attempts > tries ? raise : retry
+#       end
+#     end
+#
+#     def measurable(logger = STDOUT)
+#       start = Time.now
+#       yield
+#     ensure
+#       original_method = __decorated_method__
+#       method_location, line = original_method.source_location
+#       marker = "#{original_method.owner}##{original_method.name}[#{method_location}:#{line}]"
+#       duration = (Time.now - start).round(2)
+#
+#       logger.puts "#{marker} took #{duration}s to run."
+#     end
+#
+#     def debuggable
+#       begin
+#         yield
+#       rescue => e
+#         puts "Caught #{e}!!!"
+#         require "debug"
+#       end
+#     end
+#
+#     def memoizable
+#       key = :"@#{__decorated_method__.name}_cache"
+#
+#       instance_variable_set(key, {}) unless defined?(key)
+#       cache = instance_variable_get(key)
+#
+#       if cache.key?(__args__)
+#         cache[__args__]
+#       else
+#         cache[__args__] = yield
+#       end
+#     end
+#   end
+#
+#   class Client
+#     extend Decorations
+#
+#     # Let's keep track of how long #get takes to run,
+#     # and memoize the return value
+#     def get
+#       …
+#     end
+#     measurable :get
+#     memoizable :get
+#
+#     # Rescue and retry any Timeout::Errors, up to 5 times
+#     def post
+#       …
+#     end
+#     retryable :post, 5, on: [Timeout::Error]
+#   end
+module Decoratable
+  @@lock = Mutex.new
+
+  def self.extended(klass)
+    # This #method_added affects all methods defined in the module
+    # that extends Decoratable.
+    def klass.method_added(decoration_name)
+      return unless @@lock.try_lock
+
+      decoration_method = instance_method(decoration_name)
+
+      define_method(decoration_name) do |method_name, *decorator_args|
+        unless method_defined?(:__original_caller__)
+          define_method(:__original_caller__) { @__original_caller__ }
+        end
+
+        unless method_defined?(:__decorated_method__)
+          define_method(:__decorated_method__) { @__decorated_method__ }
+        end
+
+        unless method_defined?(:__args__)
+          define_method(:__args__) { @__args__ }
+        end
+
+        unless method_defined?(:__block__)
+          define_method(:__block__) { @__block__ }
+        end
+
+        original_method = instance_method(method_name)
+
+        decoration = Module.new do
+          self.singleton_class.instance_eval do
+            define_method(:name) do
+              "Decoratable::#{decoration_name}(#{method_name})"
+            end
+
+            alias_method :inspect, :name
+            alias_method :to_s, :name
+          end
+
+          define_method(method_name) do |*args, &block|
+            begin
+              # The decoration should have access to the original
+              # method it's modifying, along with the method call's
+              # arguments.
+              @__decorated_method__ = original_method
+              @__args__ = args
+              @__block__ = block
+              @__original_caller__ ||= caller
+
+              decoration_method.bind(self).call(*decorator_args) do
+                super(*args, &block)
+              end
+            ensure
+              @__decorated_method__ = nil
+              @__args__ = nil
+              @__block__ = nil
+              @__original_caller__ = nil
+            end
+          end
+        end
+
+        # Call aspect before "real" method.
+        prepend decoration
+      end
+    ensure
+      @@lock.unlock if @@lock.locked?
+    end
+  end
+end

data/test/decoratable/classic_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+require "decoratable/classic"
+
+require "logger"
+
+describe "Decoratable: Classic Style" do
+  # Test-only decorations
+  module Decorations
+    extend Decoratable
+
+    def loggable(logger: Logger.new(STDOUT))
+      logger.info __decorated_method__.name
+    end
+  end
+  it "decorates a method, classic style" do
+    logger = mock_logger
+    klass = Class.new do
+      extend Decorations
+
+      def call; end
+      loggable :call, logger: logger
+    end
+
+    object = klass.new
+    3.times { object.call }
+  end
+
+  def mock_logger
+    logger = Minitest::Mock.new
+
+    # We expect info to be called thrice
+    logger.expect(:info, nil, [:call])
+    logger.expect(:info, nil, [:call])
+    logger.expect(:info, nil, [:call])
+
+    logger
+  end
+
+  # Remove Decoratable constant so we reset back to original
+  Object.send(:remove_const, :Decoratable)
+  load "decoratable.rb"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decoratable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - ecin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -65,6 +65,7 @@ files:
 - Rakefile
 - decoratable.gemspec
 - lib/decoratable.rb
+- lib/decoratable/classic.rb
 - lib/decoratable/countable.rb
 - lib/decoratable/debuggable.rb
 - lib/decoratable/deprecatable.rb
@@ -73,6 +74,7 @@ files:
 - lib/decoratable/pryable.rb
 - lib/decoratable/retryable.rb
 - lib/decoratable/synchronizable.rb
+- test/decoratable/classic_test.rb
 - test/decoratable/countable_test.rb
 - test/decoratable/deprecatable_test.rb
 - test/decoratable/hintable_test.rb
@@ -107,6 +109,7 @@ signing_key:
 specification_version: 4
 summary: Easily define decorations for your methods. Put a bow on it.
 test_files:
+- test/decoratable/classic_test.rb
 - test/decoratable/countable_test.rb
 - test/decoratable/deprecatable_test.rb
 - test/decoratable/hintable_test.rb