asynchronize 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b87faff7002bd120d62dfdb0492443ea9ff339298116a65f4b648d3e69698ba
-  data.tar.gz: 4f278555322d36220fdf8e32ef750e550946c553009f43e9c4273005b594219f
+  metadata.gz: af0aada41350e739802a92c04ef32bc64fbb897dd4d3ff7b0450c1485f9a243a
+  data.tar.gz: 457e2ccdf4b87955b8dc68011f8e7d84be3458fa6a83333f56b755457729121f
 SHA512:
-  metadata.gz: 73d49afc4158a3d06e42428b008790cee9303f739bac56c8cd6dacecae57963204439e0f7d3631dc090bd5a77bde8c3985bcdf9bb13871aaf911dc9819dcdcaf
-  data.tar.gz: 60028e43fb1f7ca8a7fa9055750d777dfd91da8f1ae327306cc73927ab1db35632f8aacaec4cd43a80a146c77f97d740c1f7b76368de0ec3389b84a500b5b437
+  metadata.gz: d0f2214354035c147289553f31326709f7707a1a6a5a6101778f87198f18abd99c511763297f87662cec869426c20bae9ee5522d19232ce33878c4e238a573ae
+  data.tar.gz: 7abf0867f9c2e238f475b0925db4610194de9ef954baa48648d79492ae4fc89eaddba1e2801394cafc4034f675aaf5e5f4b0b80677c348404ef3b97cc81567af

data/asynchronize.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name = 'asynchronize'
-  s.version = '0.1.1'
+  s.version = '0.1.2'
   s.date = Date.today.to_s
   s.summary = 'Easily make multiple methods asynchronous with one line of code.'
   s.description = 'Take any synchronous method, and run it asynchronously, ' +
@@ -12,12 +12,14 @@ Gem::Specification.new do |s|
   s.files = [
     'lib/asynchronize.rb',
     'spec/spec.rb',
+    'spec/minitest_helper.rb',
     'asynchronize.gemspec',
     'Rakefile',
-    'readme.md'
+    'readme.md',
   ]
   s.test_files = [
-    'spec/spec.rb'
+    'spec/spec.rb',
+    'spec/minitest_helper.rb'
   ]
   s.homepage = 'https://github.com/kennycoc/asynchronize'
   s.license = 'MIT'

data/lib/asynchronize.rb

@@ -11,6 +11,17 @@ module Asynchronize
       # threads adding methods to your class.
       @@methods_asyncing = Set.new
 
+      ##
+      # Call to asynchronize a method.
+      #   That method will be added to a list of methods to asynchronize.
+      #   If the method already exists, it will be redefined to an asynchronous
+      #   version. If it does not, method_missing will redefine it when it does.
+      #   If the method is redefined afterwards, method_missing will also
+      #   asynchronize that version.
+      #
+      # @param methods [Symbol] The methods to be asynchronized.
+      # @example To add any number of methods to be asynchronized.
+      #   asynchronize :method1, :method2, :methodn
       def self.asynchronize(*methods)
         @@methods_to_async.merge(methods)
         methods.each do |method|
@@ -20,22 +31,33 @@ module Asynchronize
         end
       end
 
+      # require 'pry'; binding.pry
       # Save the old method_added so we don't overwrite it.
-      if method_defined? :method_added
-        alias_method :old_method_added, :method_added
-        undef_method(:method_added)
+      if self.methods.include? :method_added
+        singleton_class.send(:alias_method, :old_method_added, :method_added)
+        singleton_class.undef_method(:method_added)
       end
 
+      ##
+      # Will asynchronize a method if it has not been asynchronized already, and
+      #   it is in the list of methods to asynchronize. If method missing was
+      #   already defined, it will call the previous method_missing before
+      #   anything else Ruby calls this automatically when defining a method; it
+      #   should not be called directly.
       def self.method_added(method)
         # Don't do anything else if we're not actually adding a new method
         return if @@methods_asyncing.include? method
-        old_method_added(method) if method_defined? :old_method_added
+        @@methods_asyncing.add(method)
+        self.old_method_added(method) if self.methods.include? :old_method_added
         return unless @@methods_to_async.include? method
+        # This will delete from @@methods_asyncing
         Asynchronize.create_new_method(method, self)
       end
     end
   end
 
+  ##
+  # Responsible for actually creating the new methods and removing the old.
   def self.create_new_method(method, klass)
     klass.instance_eval do
       old_method = instance_method(method)
@@ -45,22 +67,22 @@ module Asynchronize
       undef_method method
 
       @@methods_asyncing.add(method)
-      define_method(method) do |*args, &block|
-        return _build_thread(old_method, args, block)
-      end
+      define_method(method, Asynchronize._build_new_method(old_method))
       @@methods_asyncing.delete(method)
       @@asynced_methods.add(instance_method(method))
     end
   end
 
   private
-  def _build_thread(old_method, args, block)
-    return Thread.new(old_method, args, block) do |told_method, targs, tblock|
-      result = told_method.bind(self).call(*targs)
-      if tblock.nil?
-        Thread.current[:return_value] = result
-      else
-        tblock.call(result)
+  def self._build_new_method(old_method)
+    return Proc.new do |*args, &block|
+      return Thread.new(old_method, args, block) do |told_method, targs, tblock|
+        result = told_method.bind(self).call(*targs)
+        if tblock.nil?
+          Thread.current[:return_value] = result
+        else
+          tblock.call(result)
+        end
       end
     end
   end

data/readme.md

@@ -1,11 +1,12 @@
 [![Build Status](https://travis-ci.org/kennycoc/asynchronize.svg?branch=master)](https://travis-ci.org/kennycoc/asynchronize)
+[![Maintainability](https://api.codeclimate.com/v1/badges/30d40e270a3d7a0775a9/maintainability)](https://codeclimate.com/github/kennycoc/asynchronize/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/30d40e270a3d7a0775a9/test_coverage)](https://codeclimate.com/github/kennycoc/asynchronize/test_coverage)
 # Asynchronize
 ### The easiest way to make multiple methods asynchronous.
 
 Find yourself writing the same boilerplate for all your asynchronous methods?
 Get dryyy with asynchronize.
 
-There are no dependencies other than Ruby.
 Just install with `gem install asynchronize` or add to your Gemfile and `bundle`
 
 ## Usage

data/spec/minitest_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require 'minitest/autorun'

data/spec/spec.rb

@@ -1,4 +1,4 @@
-require 'minitest/autorun'
+require './spec/minitest_helper.rb'
 require './lib/asynchronize.rb'
 
 class BasicSpec < Minitest::Test
@@ -82,8 +82,8 @@ class BasicSpec < Minitest::Test
 
     describe "when we call asynchronized before defining the method" do
       before do
-        Test.asynchronize :othertest
         class Test
+          asynchronize :othertest
           def othertest
             return 5
           end
@@ -104,5 +104,34 @@ class BasicSpec < Minitest::Test
         temp.must_equal 5, "temp is equal to #{temp}."
       end
     end
+
+    describe "when there is an existing method_added" do
+      before do
+        if defined? AnotherTest
+          BasicSpec.send(:remove_const, :AnotherTest)
+        end
+        class AnotherTest
+          @running = false
+          def self.method_added(method)
+            return if @running
+            @running = true
+            old_method = instance_method(method)
+            undef_method(method)
+            define_method(method) do
+              return old_method.bind(self).call + 1
+            end
+            @running = false
+          end
+          include Asynchronize
+          asynchronize :test
+          def test
+            return 4
+          end
+        end
+      end
+      it "should call that method_added before, and only once." do
+        AnotherTest.new.test.join[:return_value].must_equal 5
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asynchronize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kenneth Cochran
@@ -21,6 +21,7 @@ files:
 - asynchronize.gemspec
 - lib/asynchronize.rb
 - readme.md
+- spec/minitest_helper.rb
 - spec/spec.rb
 homepage: https://github.com/kennycoc/asynchronize
 licenses:
@@ -48,3 +49,4 @@ specification_version: 4
 summary: Easily make multiple methods asynchronous with one line of code.
 test_files:
 - spec/spec.rb
+- spec/minitest_helper.rb