yodo 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWIzYjEyNTY5ODI3NWNlMjRiNzE0MTQzZjIzMzA2MDAzYWI5YTc3NA==
+  data.tar.gz: !binary |-
+    MTYyM2IxYTliOWZiZTdmYjkxN2UzZWFiZGU4NDE4Yzk5MjczMTFjNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDU4ZGQzOTQwNzQ4OWY1ODkxNDE2NWJhZjlmY2Q5Y2Y2MjQ5Zjk2YzRjZjZh
+    MmVkMzE1MTk0YTMwMGM0ODUzYWU2NDAxY2Q5NWY2MTMxZWFkNzFhNjFlMjQ0
+    ODFiYmJhMzZjMWI5MGZjYWU3MzAyMWM2ODg5MzlkNDZlZTY1NWY=
+  data.tar.gz: !binary |-
+    MzgzMDcyMjc5YmJkYjRiMzcyNTAxOTkyYmIzMWZmYWZhOWNkYjY5ZmEzOGE1
+    YWY1M2M5NGNjM2Q2OTA1NjVlODFjY2IxNDZkN2I2ZWJmOTU4NWYzNDQyZTgw
+    MDMzYzczMmFlYmE3OTM0MzQxZjU4MmU5NTNjMGMyZmJjODlhMjE=

data/README.md

@@ -0,0 +1,66 @@
+[![Build Status](https://secure.travis-ci.org/rubyservices/yodo.png?branch=master)](http://travis-ci.org/rubyservices/yodo) [![Gem Version](https://badge.fury.io/rb/yodo.png)](http://badge.fury.io/rb/yodo)
+# Yodo
+
+Determines what includes you need to avoid n+1 queries when using [ActiveModel::Serializers][active_model_serializers].
+
+## Usage
+
+If you already have a Rails project setup with `ActiveModels::Serializers`, add this to your Gemfile:
+
+```ruby
+gem 'yodo', '~> 0.0.1'
+```
+
+Then:
+
+```
+bundle install
+```
+
+In console:
+
+```ruby
+rails c
+```
+
+Do the following:
+
+```ruby
+require 'yodo/ams'
+
+# Get includes required as hash
+
+Yodo::AMS.analyze_all
+
+# That might return {AlphaSerializer=>{:suggested_includes=>[:deltas, :gam, :beta, :alpha, {:delts=>[:delts]}]}, GammaSerializer=>{:suggested_includes=>[]}, DeltaSerializer=>{:suggested_includes=>[:delts]}, BetaSerializer=>{:suggested_includes=>[:gammas, :gamma, :deltas, :ds, :beta, :gam, :bet, {:al=>[:deltas, :gam, :beta, :alpha, {:delts=>[:delts]}]}]}}
+
+# Take the results of Yodo::AMS.analyze_all and sort results in a human readable format
+
+Yodo::AMS.analyze_all.map {|s,h| h.map {|k,v| "#{s.name} #{k.to_s.gsub('_',' ')} = #{v}" unless v.empty?}.compact}.flatten.sort.each {|a| puts a}; nil
+
+# That might output:
+#
+# AlphaSerializer suggested includes = [:deltas, :gam, :beta, :alpha, {:delts=>[:delts]}]
+# BetaSerializer suggested includes = [:gammas, :gamma, :deltas, :ds, :beta, :gam, :bet, {:al=>[:deltas, :gam, :beta, :alpha, {:delts=>[:delts]}]}]
+# DeltaSerializer suggested includes = [:delts]
+```
+
+### Release Notes
+
+See the [Changelog][changelog] for basically what happened when, and git log for everything else.
+
+### Contributing
+
+Please fork, make changes in a separate branch, and do a pull request for your branch.
+
+### Contributors
+
+* Gary Weaver (https://github.com/garysweaver)
+
+### License
+
+Copyright (c) 2013 Gary S. Weaver, released under the [MIT license][lic].
+
+[active_model_serializers]: https://github.com/rails-api/active_model_serializers
+[changelog]: https://github.com/garysweaver/yodo/blob/master/CHANGELOG.md
+[lic]: http://github.com/garysweaver/yodo/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    exec 'rake spec'
+  else
+    exec 'rake appraise'
+  end
+end
+
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
+end

data/lib/yodo.rb

@@ -0,0 +1 @@
+require 'yodo/version'

data/lib/yodo/ams.rb

@@ -0,0 +1,58 @@
+module Yodo
+  class AMS
+    class << self
+      # Eager loads all Rails' classes to get list of all descendants of ActiveModel::Serializer. Then
+      # returns hash of serializers to results of analysis. Currently the only key in each serializer's
+      # results is :suggested_includes which is a hash representing the includes that should be done for
+      # each ActiveModel::Serializer or an empty array.
+      def analyze_all
+        Rails.application.eager_load!
+        analyze(*ActiveModel::Serializer.descendants)
+      end
+
+      # Takes one or more descendants of ActiveModel::Serializer and returns hash of serializers to 
+      # results of analysis. Currently the only key in each serializer's results is 
+      # :suggested_includes which is a hash representing the includes that could perhaps be used to avoid
+      # n+1 queries or an empty array.
+      def analyze(*args)
+        args.pop if args.last.is_a?(Hash)
+        serializer_to_results = {}        
+        args.each do |serializer|
+          serializer_to_results[serializer] = {:suggested_includes => find_includes(serializer)}
+        end
+        serializer_to_results
+      end
+
+    private
+      def find_includes(serializer, done = {})
+        # don't follow refs that we've already resolved
+        return [] if done[serializer]
+        results = []
+        serializer._associations.each do |k,v|
+          if v.options[:serializer].respond_to?(:_associations)
+            if results.last.is_a?(Hash)
+              options = results.last
+            else
+              results << (options = {})
+            end
+            # skip self-references or we'll never get done with this serializer
+            associations_with_defined_serializers = v.options[:serializer] == serializer ? [] : find_includes(v.options[:serializer], done)
+            if associations_with_defined_serializers.empty?
+              results.prepend(k)
+            else
+              options[k] = associations_with_defined_serializers
+            end
+          else
+            results.prepend(k)
+          end
+        end
+        # inefficient, but works for now...
+        if results.last.is_a?(Hash) && results.last.empty?
+          results.pop
+        end
+        done[serializer] = true
+        results
+      end
+    end
+  end
+end

data/lib/yodo/version.rb

@@ -0,0 +1,3 @@
+module Yodo
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: yodo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies: []
+description: Determines what includes you need to avoid n+1 queries when using ActiveModel::Serializers.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yodo/ams.rb
+- lib/yodo/version.rb
+- lib/yodo.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/yodo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: n+1 query avoidance with AMS.
+test_files: []