respond_to_faster 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f06087ed36268670b30677984ce24720fe47b07
-  data.tar.gz: 993129ec0042fa434b31f2a5b3ce49c21248c96d
+  metadata.gz: b424a2e779015c87f2875079a8ec8df721c23ac3
+  data.tar.gz: d9f71e62dad4f85912e22e4a1cb2922e4e99e3d7
 SHA512:
-  metadata.gz: '0929b03566c46db822d280dd117e11b94595435b1d0a99feb58972b1a23c9529d2dfdd21c19c3c898d9bd07bf568805ac89527414d3983867d9b3ad474b7da49'
-  data.tar.gz: 883278f1fc91b09eb4d2458c705cdd6f9e98ba8b90685e1ad42331c570c076c669b4f6ef25b42c8f4161c02b0c9592fa49c8efaad3b6dbe63b4f96c7c2ccdfe5
+  metadata.gz: 1e83e14ed3105dcdbd3c56279873311db4ae60426c64a21f0a7fd8066785a3ed0111fc2b3ace7556f069583568c4895809cfeb507fff4661c900d429beba16e8
+  data.tar.gz: e7996d9d301c561e9e64a40cff73e8382eac3919f018f96913111e03a1cebf27ea44d72f34e9439a1c4df4e4afe1e2daef1e72ff1103d42d930e6e4ea6afed22

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# RespondToFaster Changelog
+
+## 0.1
+
+### 0.1.0
+* Cache modules across singleton classes [#1](https://github.com/shioyama/respond_to_faster/pull/1)
+

data/Gemfile

@@ -4,3 +4,20 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in respond_to_faster.gemspec
 gemspec
+
+group :development, :test do
+  if ENV['RAILS_VERSION'] == '5.0'
+    gem 'activerecord', '>= 5.0', '< 5.1'
+  elsif ENV['RAILS_VERSION'] == '4.2'
+    gem 'activerecord', '>= 4.2.6', '< 5.0'
+  elsif ENV['RAILS_VERSION'] == '5.1'
+    gem 'activerecord', '>= 5.1', '< 5.2'
+  else
+    gem 'activerecord', '>= 5.2.0.beta2', '< 5.3'
+    gem 'railties', '>= 5.2.0.beta2', '< 5.3'
+  end
+
+  gem 'benchmark-ips'
+  gem 'sqlite3'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -1,29 +1,76 @@
 PATH
   remote: .
   specs:
-    respond_to_faster (0.1.0)
-      activerecord (>= 5.1, < 6.0)
+    respond_to_faster (0.0.1)
+      activerecord (>= 5.0, < 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
+    actionpack (5.2.0.beta2)
+      actionview (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+    activerecord (5.2.0.beta2)
+      activemodel (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      arel (>= 9.0)
+    activesupport (5.2.0.beta2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
+    benchmark-ips (2.7.2)
+    builder (3.2.3)
+    byebug (9.1.0)
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    database_cleaner (1.6.2)
     diff-lcs (1.3)
+    erubi (1.7.0)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.2.0.beta2)
+      actionpack (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -38,6 +85,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
@@ -46,10 +95,16 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16.a)
+  activerecord (>= 5.2.0.beta2, < 5.3)
+  benchmark-ips
+  bundler (~> 1.16)
+  database_cleaner (~> 1.6)
+  pry-byebug
+  railties (>= 5.2.0.beta2, < 5.3)
   rake (~> 10.0)
   respond_to_faster!
   rspec (~> 3.0)
+  sqlite3
 
 BUNDLED WITH
-   1.16.0.pre.2
+   1.16.0

data/README.md

@@ -1,22 +1,135 @@
-# RespondToFaster :rocket:
+RespondToFaster :rocket:
+========================
 
-Speed up methods on results from custom ActiveRecord queries.
+[![Gem Version](https://badge.fury.io/rb/respond_to_faster.svg)][gem]
+[![Build Status](https://travis-ci.org/shioyama/respond_to_faster.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/shioyama/respond_to_faster.svg)][gemnasium]
+
+[gem]: https://rubygems.org/gems/respond_to_faster
+[travis]: https://travis-ci.org/shioyama/respond_to_faster
+[gemnasium]: https://gemnasium.com/shioyama/respond_to_faster
+
+Speed up method response times on results from custom aliased ActiveRecord
+queries.
 
 ## Usage
 
-Suppose you have a query with some custom SQL, like this:
+Just add the gem to your Gemfile:
+
+```ruby
+gem 'respond_to_faster', '~> 0.1.0'
+```
+
+That's it! Read on to learn about what RespondToFaster is doing under the hood
+(or checkout the source code, it's only 20 lines long!)
+
+## Background
+
+Suppose you have a query with some custom SQL, like this (taken from the
+[ActiveRecord Querying documentation](http://guides.rubyonrails.org/active_record_querying.html#group)):
+
+```ruby
+Order.select("date(created_at) as ordered_date, sum(price) as total_price").group("date(created_at)")
+```
+
+This query will group orders by date, with each date result responding to the
+aliases `ordered_date` and `total_price`. So if `order` is the first result
+returned, this will work:
+
+```ruby
+order.ordered_date
+#=> Thu, 14 Dec 2017
+order.total_price
+#=> 20.98
+```
+
+This is nice, but are those really methods? Let's have a look:
+
+```ruby
+order.method(:ordered_date)
+#=> NameError: undefined method `ordered_date' for class `#<Class:0x00559df3a8ef30>'
+```
+
+That's strange! No method. So how is the object responding to the
+`ordered_date` message?
+
+As usual, Rails is doing some magic under the hood. You can find that magic
+documented in the [inline
+docs](https://github.com/rails/rails/blob/fd1304d2aaf5e21df0aac2e8e3f7becdaad15b19/activemodel/lib/active_model/attribute_methods.rb#L415-L420)
+for `ActiveModel::AttributeMethods`, where there is the somewhat cryptic message:
+
+> Allows access to the object attributes, which are held in the hash
+> returned by <tt>attributes</tt>, as though they were first-class
+> methods. So a <tt>Person</tt> class with a <tt>name</tt> attribute can for example use
+> <tt>Person#name</tt> and <tt>Person#name=</tt> and never directly use
+> the attributes hash -- except for multiple assignments with
+> <tt>ActiveRecord::Base#attributes=</tt>.
+
+This inline comment dates back to the [very first Rails commit by @dhh in
+2004](https://github.com/rails/rails/commit/db045dbbf60b53dbe013ef25554fd013baf88134).
+
+What the code (now in ActiveModel, previously in ActiveRecord) actually does is
+to override `respond_to?` and `method_missing` to check if a given method call
+matches a key in the `attributes` hash of the model. If there's a match,
+ActiveModel "dispatches" to an attribute handler, which returns the result.
+
+Which is all fine and good, but **method_missing is slow as molasses**. You never
+really want to be relying on it to return results unless you have no
+alternative.
+
+## What this gem does
+
+So what this gem does is to *remove these overrides*, which have been around
+since the dawn of Ruby on Rails. Not just tweak them, or override them, but
+**remove them**.
+
+Here is the code that does this, just two lines:
 
 ```ruby
-posts = Post.select(:title, :content)
+ActiveModel::AttributeMethods.send(:remove_method, :respond_to?)
+ActiveModel::AttributeMethods.send(:remove_method, :method_missing)
+```
+
+For the vast majority of cases, *this will have no impact on your ActiveRecord
+objects*. AR has grown over the years to the point where most attribute methods
+are defined, so these fallbacks are not necessary.
+
+The one exception is the example earlier with the custom aliased query. In this
+case, depending on the query, some custom attributes are needed on the objects
+returned, and ActiveRecord still relies on this (very slow) mechanism to make
+the magic work.
+
+But this is a high price to pay for some simple magic. This gem instead
+*defines the methods* on the singleton class of the objects returned, so that
+you never need to go to `method_missing`. This makes things **much faster**, as
+much as 5-10 times faster.
+
+## Caveats
+
+If you don't use any custom querying with aliases like the one above, this gem
+might not do much for you. It should make `respond_to?` a bit faster, but you
+may not even notice that.
+
+However, if you've got some crazy heavy SQL logic somewhere deep in your
+application, and you're finding it takes forever, give this gem a shot and tell
+me what you find! I'd like to get this eventually merged into ActiveRecord so
+I'd like to know about any issues you encounter in your application.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/shioyama/respond_to_faster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/shioyama/respond_to_faster. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the RespondToFaster project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shioyama/respond_to_faster/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RespondToFaster project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/shioyama/respond_to_faster/blob/master/CODE_OF_CONDUCT.md).

data/lib/respond_to_faster.rb

@@ -1,10 +1,18 @@
+require "active_record"
 require "respond_to_faster/version"
 
 module RespondToFaster
   def init_with(coder)
     super.tap do
-      (attribute_names - self.class.attribute_names).each do |name|
-        singleton_class.define_attribute_method name
+      unless (uncached_attrs = attribute_names - self.class.attribute_names).empty?
+        klass = self.class
+        mod_name = "RespondToFaster_#{uncached_attrs.hash.abs}".freeze
+        if klass.const_defined?(mod_name)
+          singleton_class.include klass.const_get(mod_name)
+        else
+          uncached_attrs.each &singleton_class.method(:define_attribute_method)
+          klass.const_set(mod_name, singleton_class.send(:generated_attribute_methods))
+        end
       end
     end
   end

data/lib/respond_to_faster/version.rb

@@ -1,3 +1,3 @@
 module RespondToFaster
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: respond_to_faster
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Salzberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Patches ActiveRecord to make models returned from custom queries respond
   much faster.
 email:
@@ -80,6 +94,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock