pluck_map 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baee1fa797afc235f781a0b9d2492a8796ff54b3e90fd795bda2fd772c70a146
-  data.tar.gz: a90a51ca0fb57d382f00228f31ace8e2157153aa4bf8f29f75589a6b6b6812f9
+  metadata.gz: c84ee8f4db192127a69450c81189315686ee14b23e65bfd08d49ee14c09e9d6c
+  data.tar.gz: d00b45929552234fe71457bf40649f8cdf6344198d278a4168760bf694c86e65
 SHA512:
-  metadata.gz: 8ca7ae6a27609c8e26edfe2f33d9929773b2fc1bba4ee193633def8f4f5637d6914654c36cfc67812fb1debae1d0095fa04636c4734e9b31f98f6582e16cbff2
-  data.tar.gz: cb720743428655889f2ea30e7e4de92f27a07564faf8190b18d6b44dc7165e971cbd7e027c252aedcb39ae85e1de8c16346f147142424c521ddeb71c2096c8dc
+  metadata.gz: 35eb0d21063e78cf8ea5968e93faa715fffba2198f4b54cfa5f0ade709bd375741c1b29dc27d03cdc8a5bbce99b5afa53fdc6e34f1fdabcfecb7f3a7cb117410
+  data.tar.gz: 909ab9afe1a0818bddaecb2406d8e69a5c4d6e64ee0949509ef3790ddaf167bf6e83d04ddff7e9ea540e10cebe710641983659cefb8ba48838dc55e82b10bbe2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.4.0 (2019 Apr 16)
+
+* REFACTOR: Introduced several DEPRECATION WARNINGs that will be harvested in v1.0.0 (@boblail)
+* REFACTOR: Changed the implementation of the private method `selects` (@boblail)
+
 ## v0.3.0 (2019 Apr 7)
 
 * IMPROVEMENT: Add support for MySQL (@boblail)

data/README.md

@@ -3,28 +3,30 @@
 [![Gem Version](https://badge.fury.io/rb/pluck_map.svg)](https://rubygems.org/gems/pluck_map)
 [![Build Status](https://travis-ci.org/boblail/pluck_map.svg)](https://travis-ci.org/boblail/pluck_map)
 
-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).
+This library provides a DSL for presenting ActiveRecord::Relations without instantiating ActiveRecord models. 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:
+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|
+    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.
+This instantiates a `Message` for every result, gets the attributes out of it, and then immediately discards it.
 
-We can skip that step by using `pluck`:
+We can skip that unnecessary instantiation by using `pluck`:
 
 ```ruby
   def index
-    @messages = Message.created_by(current_user).after(3.weeks.ago)
-    render json: @messages.pluck(:id, :created_at, :text)
+    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,
@@ -32,15 +34,15 @@ We can skip that step by using `pluck`:
   end
 ```
 
-In many cases, this is significantly faster.
+This tends to be about one order of magnitude faster the first example.
 
-But, now, if we needed to present a new attribute (say, `channel`), we have to write it _four_ times:
+It is straightforward but verbose (we repeat the attribute names at least three times) and changing a block like this produces noisy diffs:
 
 ```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)
+    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,
@@ -51,28 +53,30 @@ But, now, if we needed to present a new attribute (say, `channel`), we have to w
   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.
+And when we're presenting large or complex objects, the list of attributes we send to `pluck` or arguments we declare in the `map` block can get unwieldy!
 
-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:
+The `PluckMap::Presenter` is simply a shorthand for generating the above pluck-map pattern. Using it, we could write our example like this:
 
 ```ruby
   def index
-    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    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
+    render json: presenter.to_h(messages)
   end
 ```
 
+Using that definition, `PluckMap::Presenter` dynamically generates a `.to_h` method that is implemented exactly like the example above that uses `.pluck` and `.map`.
+
 This DSL also makes it easy to make fields optional:
 
 ```diff
   def index
-    @messages = Message.created_by(current_user).after(3.weeks.ago)
+    messages = Message.created_by(current_user).after(3.weeks.ago)
     presenter = PluckMap::Presenter.new do |q|
       q.id
       q.postedAt select: :created_at
@@ -80,7 +84,7 @@ This DSL also makes it easy to make fields optional:
 -     q.channel
 +     q.channel if params[:fields] =~ /channel/
     end
-    render json: presenter.to_h
+    render json: presenter.to_h(messages)
   end
 ```
 
@@ -104,10 +108,11 @@ Or install it yourself as:
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` 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

@@ -43,6 +43,7 @@ def run_without_aborting(*tasks)
   errors = []
 
   tasks.each do |task|
+    puts task
     Rake::Task[task].invoke
   rescue Exception
     errors << task

data/lib/pluck_map.rb

@@ -1,5 +1,11 @@
 require "pluck_map/version"
 require "pluck_map/presenter"
+require "pluck_map/null_logger"
 
 module PluckMap
+  class << self
+    attr_accessor :logger
+  end
+
+  @logger = defined?(Rails) ? Rails.logger : PluckMap::NullLogger.new
 end

data/lib/pluck_map/attribute.rb

@@ -1,12 +1,12 @@
 module PluckMap
   class Attribute
-    attr_reader :id, :selects, :name, :alias, :block
+    attr_reader :id, :selects, :name, :value, :block
+    attr_accessor :indexes
 
     def initialize(id, options={})
       @id = id
       @selects = Array(options.fetch(:select, id))
       @name = options.fetch(:as, id)
-      @alias = name.to_s.tr("_", " ")
       @block = options[:map]
 
       if options.key? :value
@@ -23,17 +23,6 @@ module PluckMap
       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
@@ -45,17 +34,37 @@ module PluckMap
     # 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)
+    def to_ruby(selects = nil)
+      if selects
+        puts "DEPRECATION WARNING: PluckMap::Attribute#to_ruby no longer requires an argument. Replace `attribute.to_ruby(keys)` with `attribute.to_ruby`."
+      end
+
       return @value.inspect if defined?(@value)
-      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
+
+
+
+    def values
+      [id, selects, name, value, block]
+    end
+
+    def ==(other)
+      return false if self.class != other.class
+      self.values == other.values
+    end
+
+    def hash
+      values.hash
+    end
+
+    def eql?(other)
+      return true if self.equal?(other)
+      return false if self.class != other.class
+      self.values.eql?(other.values)
+    end
   end
 end

data/lib/pluck_map/attribute_builder.rb

@@ -0,0 +1,28 @@
+require "pluck_map/attribute"
+
+module PluckMap
+  class AttributeBuilder
+
+    def self.build(&block)
+      builder = self.new
+      if block.arity == 1
+        block.call(builder)
+      else
+        builder.instance_eval(&block)
+      end
+      builder.instance_variable_get(:@attributes).freeze
+    end
+
+    def initialize
+      @attributes = []
+    end
+
+    def method_missing(attribute_name, *args)
+      options = args.extract_options!
+      options[:value] = args.first unless args.empty?
+      @attributes.push PluckMap::Attribute.new(attribute_name, options)
+      :attribute_added
+    end
+
+  end
+end

data/lib/pluck_map/presenter.rb

@@ -1,37 +1,33 @@
-require "pluck_map/version"
-require "pluck_map/attribute"
-require "pluck_map/null_logger"
+require "pluck_map/attribute_builder"
+require "pluck_map/presenters"
 
 module PluckMap
   class Presenter
-    attr_reader :attributes
+    include HashPresenter
 
-    @logger = defined?(Rails) ? Rails.logger : PluckMap::NullLogger.new
-    class << self
-      attr_accessor :logger
-    end
+    attr_reader :attributes
 
     def initialize(&block)
-      @attributes = []
-      if block.arity == 1
-        block.call(self)
-      else
-        instance_eval(&block)
+      @attributes = PluckMap::AttributeBuilder.build(&block)
+
+      @attributes_by_id = {}
+      @selects = []
+      attributes.each do |attribute|
+        attribute.indexes = attribute.selects.map do |select|
+          selects.find_index(select) || begin
+            selects.push(select)
+            selects.length - 1
+          end
+        end
+        attributes_by_id[attribute.id] = attribute
       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?
-      options = args.extract_options!
-      options[:value] = args.first unless args.empty?
-      attributes.push PluckMap::Attribute.new(attribute_name, options)
-      :attribute_added
+      if respond_to?(:define_presenters!, true)
+        puts "DEPRECATION WARNING: `define_presenters!` is deprecated; instead mix in a module that implements your presenter method (e.g. `to_h`). Optionally have the method redefine itself the first time it is called."
+        # because overridden `define_presenters!` will probably call `super`
+        PluckMap::Presenter.class_eval 'protected def define_presenters!; end'
+        define_presenters!
+      end
     end
 
     def no_map?
@@ -40,17 +36,9 @@ module PluckMap
 
   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.model)) }
+      # puts "\e[95m#{query.select(*selects).to_sql}\e[0m"
+      results = benchmark("pluck(#{query.table_name})") { query.pluck(*selects) }
       return results unless block_given?
       benchmark("map(#{query.table_name})") { yield results }
     end
@@ -58,39 +46,20 @@ module PluckMap
     def benchmark(title)
       result = nil
       ms = Benchmark.ms { result = yield }
-      self.class.logger.info "\e[33m#{title}: \e[1m%.1fms\e[0m" % ms
+      PluckMap.logger.info "\e[33m#{title}: \e[1m%.1fms\e[0m" % ms
       result
     end
 
   private
-    attr_reader :attributes_by_id, :keys
-
-    def selects(model)
-      attributes.flat_map do |attribute|
-        if attribute.selects.length != 1
-          attribute.selects
-        else
-          select = attribute.selects[0]
-          select = "#{model.quoted_table_name}.#{model.connection.quote_column_name(select)}" if select.is_a?(Symbol)
-          Arel.sql("#{select} AS \"#{attribute.alias}\"")
-        end
-      end.uniq
-    end
+    attr_reader :attributes_by_id, :selects
 
     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
+    def keys
+      puts "DEPRECATION WARNING: PluckMap::Presenter#keys is deprecated with no replacement"
+      selects
     end
 
   end

data/lib/pluck_map/presenters.rb

@@ -0,0 +1 @@
+require "pluck_map/presenters/to_h"

data/lib/pluck_map/presenters/to_h.rb

@@ -0,0 +1,22 @@
+module PluckMap
+  module HashPresenter
+
+    def to_h(query)
+      define_to_h!
+      to_h(query)
+    end
+
+    private 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}" }.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

@@ -1,3 +1,3 @@
 module PluckMapPresenter
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/pluck_map.gemspec

@@ -29,5 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pg"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "rr"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_map
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-07 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -202,8 +216,11 @@ files:
 - gemfiles/rails_edge.gemfile
 - lib/pluck_map.rb
 - lib/pluck_map/attribute.rb
+- lib/pluck_map/attribute_builder.rb
 - lib/pluck_map/null_logger.rb
 - lib/pluck_map/presenter.rb
+- lib/pluck_map/presenters.rb
+- lib/pluck_map/presenters/to_h.rb
 - lib/pluck_map/version.rb
 - pluck_map.gemspec
 homepage: https://github.com/boblail/pluck_map