pluck_map 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77e7669a17721684395128655dda6e8da49d30b1
+  data.tar.gz: 355d90c4ed3e0dfe1667c1666a9c32c7ea573d42
+SHA512:
+  metadata.gz: 05ed5427a51748878512c6347f111890365264c011e192eea8e59fd2474dc175f935ee6434b98786603c16641a8bf4a7c6c5e9c5c3a77c203c0a1f902eb10b29
+  data.tar.gz: 5d3f898e451f9aea4ab28d237e86a38e7edf3ae353e00672a89451f699bd222e4456e187889e180eb33640e6846d92a69410d9c52c37cf31b3750ab0ebdb6bc2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,111 @@
+# PluckMap::Presenter
+
+The PluckMap presenter provides a DSL for creating performant presenters. It is useful when a Rails controller action does little more than fetch several records from the database and present them in some other data format (like JSON or CSV).
+
+Let's take an example. Suppose you have an action like this:
+
+```ruby
+  def index
+    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    render json: @messages.map { |message|
+      { id: message.id,
+        postedAt: message.created_at,
+        text: message.text } }
+  end
+```
+
+This, of course, _instantiates_ a `Message` for every result, though we aren't really using a lot of ActiveRecord's features (in this action, at least). We instantiate all those objects on line 3 and then throw them away immediately afterward.
+
+We can skip that step by using `pluck`:
+
+```ruby
+  def index
+    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    render json: @messages.pluck(:id, :created_at, :text)
+      .map { |id, created, text|
+        { id: id,
+          postedAt: created_at,
+          text: text } }
+  end
+```
+
+In many cases, this is significantly faster.
+
+But, now, if we needed to present a new attribute (say, `channel`), we have to write it _four_ times:
+
+```diff
+  def index
+    @messages = Message.created_by(current_user).after(3.weeks.ago)
+-   render json: @messages.pluck(:id, :created_at, :text)
++   render json: @messages.pluck(:id, :created_at, :text, :channel)
+-     .map { |id, created, text|
++     .map { |id, created, text, channel|
+        { id: id,
+          postedAt: created_at,
+-         text: text } }
++         text: text,
++         channel: channel } }
+  end
+```
+
+When we're presenting large or complex objects, the list of attributes we send to `pluck` or arguments we declare in the block passed to `map` can get pretty awkward.
+
+The `PluckMap::Presenter` DSL is just a shortcut for generating the above pluck-map pattern in a more succinct way. The example above looks like this:
+
+```ruby
+  def index
+    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    presenter = PluckMap::Presenter.new do |q|
+      q.id
+      q.postedAt select: :created_at
+      q.text
+      q.channel
+    end
+    render json: presenter.to_h
+  end
+```
+
+This DSL also makes it easy to make fields optional:
+
+```diff
+  def index
+    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    presenter = PluckMap::Presenter.new do |q|
+      q.id
+      q.postedAt select: :created_at
+      q.text
+-     q.channel
++     q.channel if params[:fields] =~ /channel/
+    end
+    render json: presenter.to_h
+  end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pluck_map"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pluck_map
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boblail/pluck_map.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pluck_map"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pluck_map/attribute.rb

@@ -0,0 +1,54 @@
+module PluckMap
+  class Attribute
+    attr_reader :id, :selects, :name, :alias, :block
+
+    def initialize(id, options={})
+      @id = id
+      @selects = Array(options.fetch(:select, id))
+      @name = options.fetch(:as, id)
+      @alias = name.to_s.gsub('_', ' ')
+      @block = options[:map]
+      raise ArgumentError, "You must select at least one column" if selects.empty?
+      raise ArgumentError, "You must define a block if you are going to select " <<
+        "more than one expression from the database" if selects.length > 1 && !block
+    end
+
+    def apply(object)
+      block.call(*object)
+    end
+
+    # These are the names of the values that are returned
+    # from the database (every row returned by the database
+    # will be a hash of key-value pairs)
+    #
+    # If we are only selecting one thing from the database
+    # then the PluckMapPresenter will automatically alias
+    # the select-expression, so the key will be the alias.
+    def keys
+      selects.length == 1 ? [self.alias] : selects
+    end
+
+    def no_map?
+      block.nil?
+    end
+
+    # When the PluckMapPresenter performs the query, it will
+    # receive an array of rows. Each row will itself be an
+    # array of values.
+    #
+    # This method constructs a Ruby expression that will
+    # extract the appropriate values from each row that
+    # correspond to this Attribute.
+    #
+    # The array of values will be correspond to the array
+    # of keys. This method determines which values pertain
+    # to it by figuring out which order its keys were selected in
+    def to_ruby(keys)
+      indexes = self.keys.map { |key| keys.index(key) }
+      return "values[#{indexes[0]}]" if indexes.length == 1 && !block
+      ruby = "values.values_at(#{indexes.join(", ")})"
+      ruby = "invoke(:\"#{id}\", #{ruby})" if block
+      ruby
+    end
+  end
+end

data/lib/pluck_map/presenter.rb

@@ -0,0 +1,89 @@
+require "pluck_map/version"
+require "pluck_map/attribute"
+
+module PluckMap
+  class Presenter
+    attr_reader :attributes
+
+    def initialize(&block)
+      @attributes = []
+      if block.arity == 1
+        block.call(self)
+      else
+        instance_eval(&block)
+      end
+      @initialized = true
+
+      @attributes_by_id = attributes.index_by(&:id).with_indifferent_access
+      @keys = attributes.flat_map(&:keys).uniq
+
+      define_presenters!
+    end
+
+    def method_missing(attribute_name, *args, &block)
+      return super if initialized?
+      attributes.push PluckMap::Attribute.new(attribute_name, args.extract_options!)
+      :attribute_added
+    end
+
+    def no_map?
+      attributes.all?(&:no_map?)
+    end
+
+  protected
+
+    def define_presenters!
+      define_to_h!
+    end
+
+    def initialized?
+      @initialized
+    end
+
+    def pluck(query)
+      # puts "\e[95m#{query.select(*selects(query.table_name)).to_sql}\e[0m"
+      results = benchmark("pluck(#{query.table_name})") { query.pluck(*selects(query.table_name)) }
+      return results unless block_given?
+      benchmark("map(#{query.table_name})") { yield results }
+    end
+
+    def benchmark(title)
+      result = nil
+      ms = Benchmark.ms { result = yield }
+      Rails.logger.info "\e[33m#{title}: \e[1m%.1fms\e[0m" % ms
+      result
+    end
+
+  private
+    attr_reader :attributes_by_id, :keys
+
+    def selects(table_name)
+      attributes.flat_map do |attribute|
+        if attribute.selects.length != 1
+          attribute.selects
+        else
+          select = attribute.selects[0]
+          select = "\"#{table_name}\".\"#{select}\"" if select.is_a?(Symbol)
+          "#{select} AS \"#{attribute.alias}\""
+        end
+      end.uniq
+    end
+
+    def invoke(attribute_id, object)
+      attributes_by_id.fetch(attribute_id).apply(object)
+    end
+
+    def define_to_h!
+      ruby = <<-RUBY
+      def to_h(query)
+        pluck(query) do |results|
+          results.map { |values| values = Array(values); { #{attributes.map { |attribute| "#{attribute.name.inspect} => #{(attribute.to_ruby(keys))}"}.join(", ")} } }
+        end
+      end
+      RUBY
+      # puts "\e[34m#{ruby}\e[0m" # <-- helps debugging PluckMapPresenter
+      class_eval ruby, __FILE__, __LINE__ - 7
+    end
+
+  end
+end

data/lib/pluck_map/version.rb

@@ -0,0 +1,3 @@
+module PluckMapPresenter
+  VERSION = "0.1.0"
+end

data/lib/pluck_map.rb

@@ -0,0 +1,5 @@
+require "pluck_map/version"
+require "pluck_map/presenter"
+
+module PluckMap
+end

data/pluck_map.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pluck_map/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pluck_map"
+  spec.version       = PluckMapPresenter::VERSION
+  spec.authors       = ["Bob Lail"]
+  spec.email         = ["bob.lail@cph.org"]
+
+  spec.summary       = "A DSL for presenting ActiveRecord::Relations without instantiating ActiveRecord models"
+  spec.homepage      = "https://github.com/boblail/pluck_map"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: pluck_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Lail
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- bob.lail@cph.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pluck_map.rb
+- lib/pluck_map/attribute.rb
+- lib/pluck_map/presenter.rb
+- lib/pluck_map/version.rb
+- pluck_map.gemspec
+homepage: https://github.com/boblail/pluck_map
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A DSL for presenting ActiveRecord::Relations without instantiating ActiveRecord
+  models
+test_files: []