cattr_reader_preloaded 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-head
+  - rbx-18mode
+  - rbx-19mode
+
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rake

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alain Ravet
+
+MIT License
+
+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,81 @@
+[![Build Status](https://travis-ci.org/alainravet/cattr_reader_preloaded.png?branch=master)](https://travis-ci.org/alainravet/cattr_reader_preloaded) -
+[![Code Climate](https://codeclimate.com/github/alainravet/cattr_reader_preloaded.png)](https://codeclimate.com/github/alainravet/cattr_reader_preloaded)
+tested with Ruby (1.8.7, 1.9.3, and 2.0.0), JRuby(1.8 and 1.9 mode), and Rubinius(1.8 and 1.9 mode) - see [.travis.yml](.travis.yml)
+
+##TL;DR
+Precompute asynchronously a value when the file is loaded, not on the 1st call.
+```ruby
+cattr_reader_preloaded :gem_names do
+  `gem list --no-version`  # <<< SLOW
+end
+```
+---------------
+
+##Problem : 
+Some operations are very slow the 1st time you perform them, even when this takes place long after the program was started.
+Memoization will only speed up the 2nd and later calls.
+
+Example : this operation
+```ruby
+def gems_names
+  @@_gems_names ||= `gem list --no-version`  # <<<
+end
+```
+is slow :
+
+```ruby
+sleep 10 # simulates the program running for a while.
+
+3.times do
+  start = Time.now
+  gems_names  # <<< the slow operation
+  puts "%.4f" % (Time.now - start)
+end
+```
+```
+1.6710  : 1st call = slow
+0.0000  : 2nd call = fast (memoized)
+0.0000  : 3rd call = fast (memoized)
+```
+
+##Solution : 
+
+This gem adds a ```cattr_reader_preloaded``` method to ```Kernel``` that starts precomputing - asynchronously the value as soon as the file (class or module) is loaded by Ruby
+
+
+```ruby
+# replace
+#   def gems_names
+#     @@_gems_names ||= `gem list --no-version`
+#   end
+# by
+cattr_reader_preloaded  :gem_names do
+  `gem list --no-version`  # <<< SLOW
+end
+```
+and the result is now
+```
+0.0000
+0.0000
+0.0000
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cattr_reader_preloaded'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+0. Respect the code style and formatting.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/cattr_reader_preloaded.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cattr_reader_preloaded/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cattr_reader_preloaded"
+  spec.version       = CattrReaderPreloaded::VERSION
+  spec.authors       = ["Alain Ravet"]
+  spec.email         = ["alainravet@gmail.com"]
+  spec.description   = 'asynchronously precompute and cache values when a class/module is loaded, not on the 1st call.'
+  spec.summary       = 'asynchronously precompute and cache values when a class/module is loaded, not on the 1st call.'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/lib/cattr_reader_preloaded.rb

@@ -0,0 +1,27 @@
+require "cattr_reader_preloaded/version"
+
+module Kernel
+
+  # Usage :
+  #   cattr_reader_preloaded :gems_names do
+  #     `gem list --no-version`
+  #   end
+  #
+  def cattr_reader_preloaded(name, &block)
+    raise "initialization block is missing" unless block_given?
+    cache     = "@_cached_#{name}"   .to_sym
+    preloader = "@_#{name}_preloader".to_sym
+
+    self.class.send :define_method, name, lambda {
+     instance_variable_get(preloader).join.value
+    }
+
+    instance_variable_set(preloader, Thread.new do
+        instance_variable_set cache, block.call
+        self.class.send :define_method, name, lambda {
+          instance_variable_get cache
+        }
+        instance_variable_get cache
+    end)
+  end
+end

data/lib/cattr_reader_preloaded/version.rb

@@ -0,0 +1,3 @@
+module CattrReaderPreloaded
+  VERSION = "0.0.1"
+end

data/test/acceptance_test.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestCAttrReaderPreloaded < MiniTest::Unit::TestCase
+
+  def test_call_twice_a_method_that_does_not_preload
+    load_file('class_without_value_preloading.rb')
+
+    # no preloading => each call is slow and takes about the same time
+    assert_slower_than(0.1    ) { ClassWithoutValuePreloading.slow_op  }
+    assert_slower_than(0.1    ) { ClassWithoutValuePreloading.slow_op  }
+  end
+
+
+
+  def test_call_twice_a_method_that_preloads
+    load_file('class_with_value_preloading.rb')
+
+    # at this point, the value preloading is still running => must wait till it's finished
+    assert_slower_than(0.4    ) { @value = ClassWithValuePreloading.slow_op  }
+    assert @value == '<value-returned>'
+
+    # preloading is  finished => the second call is much faster
+    assert_faster_than(0.001) { @value = ClassWithValuePreloading.slow_op  }
+    assert @value == '<value-returned>'
+  end
+
+
+
+  def test_call_in_one_class_two_method_that_preload
+    load_file('class_with_two_values_preloading.rb')
+    # at this point, the values preloading is still running => must wait till it's finished
+
+    assert_slower_than(0.4    ) { @value = ClassWithTwoValuesPreloading.slow_op    }
+    assert @value == '<value-returned>'
+
+    # preloading of ALL values is finished
+    #  => 1st call on the 2nd method is almost instantaneous (value is already computed)
+    assert_faster_than(0.001) { @value = ClassWithTwoValuesPreloading.slow_op_2  }
+    assert @value == '<value_2-returned>'
+  end
+
+end

data/test/fixtures/class_with_two_values_preloading.rb

@@ -0,0 +1,12 @@
+class ClassWithTwoValuesPreloading
+
+  cattr_reader_preloaded(:slow_op  ) do
+    sleep 0.5
+    '<value-returned>'
+  end
+  cattr_reader_preloaded(:slow_op_2) do
+    sleep 0.3
+    '<value_2-returned>'
+  end
+
+end

data/test/fixtures/class_with_value_preloading.rb

@@ -0,0 +1,8 @@
+class ClassWithValuePreloading
+
+  cattr_reader_preloaded :slow_op do
+    sleep 0.5     # simulate a costly value precomputing
+    '<value-returned>'
+  end
+
+end

data/test/fixtures/class_without_value_preloading.rb

@@ -0,0 +1,7 @@
+class ClassWithoutValuePreloading
+
+  def self.slow_op
+    sleep 0.2
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "minitest/autorun"
+require File.dirname(__FILE__) + '/../lib/cattr_reader_preloaded'
+
+def load_file(fixture)
+  load File.dirname(__FILE__) + "/../test/fixtures/#{fixture}"
+end
+
+def assert_slower_than(minimum_time)
+  start = Time.now
+  yield
+  time_taken = (Time.now - start)
+  assert minimum_time < time_taken, "test was too fast (#{time_taken}); it should have take more than #{minimum_time}"
+end
+
+def assert_faster_than(maximum_time)
+  start = Time.now
+  yield
+  time_taken = (Time.now - start)
+  assert time_taken < maximum_time, "test was too slow (#{time_taken}); it should have take less than #{maximum_time}"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: cattr_reader_preloaded
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alain Ravet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  name: bundler
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: minitest
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  version_requirements: *id003
+  prerelease: false
+description: asynchronously precompute and cache values when a class/module is loaded, not on the 1st call.
+email: 
+- alainravet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cattr_reader_preloaded.gemspec
+- lib/cattr_reader_preloaded.rb
+- lib/cattr_reader_preloaded/version.rb
+- test/acceptance_test.rb
+- test/fixtures/class_with_two_values_preloading.rb
+- test/fixtures/class_with_value_preloading.rb
+- test/fixtures/class_without_value_preloading.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: asynchronously precompute and cache values when a class/module is loaded, not on the 1st call.
+test_files: 
+- test/acceptance_test.rb
+- test/fixtures/class_with_two_values_preloading.rb
+- test/fixtures/class_with_value_preloading.rb
+- test/fixtures/class_without_value_preloading.rb
+- test/test_helper.rb