pluck_map 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac225219ca58a7ff5126649f3fdec9e90e8350f2ba7cbb6ca12a8ca2a130758
-  data.tar.gz: 1efe86c6841ac2ea5b0d262dd067df326d0be807d98605e9bf45e649859111cc
+  metadata.gz: 3316ae636b712a8656e2efce061b2055b6e75f19b59e0265f1139e312e88d7ec
+  data.tar.gz: bb75083e099c90e38f4b2a92840c197eb93a4c268b8c65917f4172c21e1b9f51
 SHA512:
-  metadata.gz: a9054980e92bb48e728d8750816195693692c9718078e164d729a7577d53ba0d0221079b212baaa7501bb9b34874e27a386c186010b74a0c48462c5e53d76fb7
-  data.tar.gz: 6af0252a0c7163df76266f8104c2dd9957a5a3c3e4317dc6bd4d95411cac271ecd3b9eb35edd1ea1c1da122a41b250a1ca87c67eb2787e080963ca259738111c
+  metadata.gz: c2801ad881bdc370044fe2c997f7f3d1c137ae757af7aabc4bcc0d3c71e5a412ea136f95a769968aa4972e6d8385ccd6f961c265d8e6946363595bbc3139aae2
+  data.tar.gz: 1ef71fbbd7f3fcdb4494087fc537db3962fb2529373272edb3c96a0a71481c0b18f69f43201cde511640aa5970f0b7a545dfd96e3dabab32f2e89d07a07c2b87

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.5.0 (2019 May 1)
+
+* REFACTOR: Introduced a new syntax for defining PluckMap Presenters and deprecated
+  calling `PluckMap::Presenter.new` with a block
+* FEATURE: Add `to_json` presenter method (@boblail)
+* FEATURE: Add `to_csv` presenter method (@boblail)
+
 ## v0.4.1 (2019 Apr 26)
 
 * FIX: Use `PluckMap::NullLogger` when `Rails.logger` is `nil` (@boblail)

data/README.md

@@ -34,9 +34,9 @@ We can skip that unnecessary instantiation by using `pluck`:
   end
 ```
 
-This tends to be about one order of magnitude faster the first example.
+In [a simple benchmark](https://github.com/boblail/pluck_map/blob/master/test/benchmarks.rb), the second example is 3× faster than the first and allocates half as much memory. :rocket: (Mileage may vary, of course, but in real applications with more complex models, I've gotten more like a 10× improvement at bottlenecks.)
 
-It is straightforward but verbose (we repeat the attribute names at least three times) and changing a block like this produces noisy diffs:
+One drawback to this technique is its verbosity — we repeat the attribute names at least three times and changes to blocks like this make for noisy diffs:
 
 ```diff
   def index
@@ -53,14 +53,12 @@ It is straightforward but verbose (we repeat the attribute names at least three
   end
 ```
 
-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` is simply a shorthand for generating the above pluck-map pattern. Using it, we could write our example like this:
+`PluckMap::Presenter` gives us 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)
-    presenter = PluckMap::Presenter.new do |q|
+    presenter = PluckMap[Message].define do |q|
       q.id
       q.postedAt select: :created_at
       q.text
@@ -77,7 +75,7 @@ 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|
+    presenter = PluckMap[Message].define do |q|
       q.id
       q.postedAt select: :created_at
       q.text

data/Rakefile

@@ -36,7 +36,17 @@ namespace :test do
       t.libs << "test"
       t.libs << "lib"
       t.test_files = FileList["test/**/*_test.rb"]
-    end  end
+    end
+  end
+end
+
+namespace :benchmark do
+  ADAPTERS.each do |adapter|
+    desc "Run benchmarks on #{adapter}"
+    task adapter => "db:#{adapter}:env" do
+      load File.expand_path("test/benchmarks.rb", __dir__)
+    end
+  end
 end
 
 def run_without_aborting(*tasks)
@@ -46,6 +56,7 @@ def run_without_aborting(*tasks)
     puts task
     Rake::Task[task].invoke
   rescue Exception
+    puts "\e[31m#{$!.class}: #{$!.message}\e[0m"
     errors << task
   end
 
@@ -58,5 +69,11 @@ task :test do
   run_without_aborting(*tasks)
 end
 
+desc "Run #{ADAPTERS.join(', ')} benchmarks"
+task :benchmark do
+  tasks = ADAPTERS.map { |adapter| "benchmark:#{adapter}" }
+  run_without_aborting(*tasks)
+end
+
 desc "Run #{ADAPTERS.join(', ')} tests by default"
 task default: :test

data/lib/pluck_map/attribute.rb

@@ -1,10 +1,11 @@
 module PluckMap
   class Attribute
-    attr_reader :id, :selects, :name, :value, :block
+    attr_reader :id, :model, :selects, :name, :value, :block
     attr_accessor :indexes
 
-    def initialize(id, options={})
+    def initialize(id, model, options={})
       @id = id
+      @model = model
       @selects = Array(options.fetch(:select, id))
       @name = options.fetch(:as, id)
       @block = options[:map]

data/lib/pluck_map/attribute_builder.rb

@@ -1,26 +1,29 @@
 require "pluck_map/attribute"
+require "pluck_map/attributes"
 
 module PluckMap
-  class AttributeBuilder
+  class AttributeBuilder < BasicObject
 
-    def self.build(&block)
-      builder = self.new
+    def self.build(model:, &block)
+      attributes = []
+      builder = self.new(attributes, model)
       if block.arity == 1
         block.call(builder)
       else
         builder.instance_eval(&block)
       end
-      builder.instance_variable_get(:@attributes).freeze
+      Attributes.new(attributes)
     end
 
-    def initialize
-      @attributes = []
+    def initialize(attributes, model)
+      @attributes = attributes
+      @model = model
     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)
+      @attributes.push Attribute.new(attribute_name, @model, options)
       :attribute_added
     end
 

data/lib/pluck_map/attributes.rb

@@ -0,0 +1,63 @@
+module PluckMap
+  class Attributes
+    include Enumerable
+
+    attr_reader :selects
+
+    def initialize(attributes)
+      @_attributes = attributes.freeze
+      @_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
+      _attributes_by_id.freeze
+    end
+
+
+
+    def each(&block)
+      _attributes.each(&block)
+    end
+
+    def [](index)
+      _attributes[index]
+    end
+
+    def length
+      _attributes.length
+    end
+
+
+
+    def by_id
+      _attributes_by_id
+    end
+
+
+
+    def ==(other)
+      return false if self.class != other.class
+      _attributes == other.send(:_attributes)
+    end
+
+    def hash
+      _attributes.hash
+    end
+
+    def eql?(other)
+      return true if self.equal?(other)
+      return false if self.class != other.class
+      _attributes.eql?(other.send(:_attributes))
+    end
+
+  private
+    attr_reader :_attributes, :_attributes_by_id
+  end
+end

data/lib/pluck_map/model_context.rb

@@ -0,0 +1,14 @@
+require "pluck_map/presenter"
+
+module PluckMap
+  class ModelContext
+    def initialize(model)
+      @model = model
+    end
+
+    def define(&block)
+      attributes = PluckMap::AttributeBuilder.build(model: @model, &block)
+      PluckMap::Presenter.new(@model, attributes)
+    end
+  end
+end

data/lib/pluck_map/presenter.rb

@@ -3,23 +3,17 @@ require "pluck_map/presenters"
 
 module PluckMap
   class Presenter
-    include HashPresenter
+    include CsvPresenter, HashPresenter, JsonPresenter
 
-    attr_reader :attributes
+    attr_reader :model, :attributes
 
-    def initialize(&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
+    def initialize(model = nil, attributes = nil, &block)
+      if block_given?
+        puts "DEPRECATION WARNING: `PluckMap::Presenter.new` will be deprecated. Use `PluckMap[Model].define` instead."
+        @attributes = PluckMap::AttributeBuilder.build(model: nil, &block)
+      else
+        @model = model
+        @attributes = attributes
       end
 
       if respond_to?(:define_presenters!, true)
@@ -37,6 +31,10 @@ module PluckMap
   protected
 
     def pluck(query)
+      if model && query.model != model
+        raise ArgumentError, "Query for #{query.model} but #{model} expected"
+      end
+
       # puts "\e[95m#{query.select(*selects).to_sql}\e[0m"
       results = benchmark("pluck(#{query.table_name})") { query.pluck(*selects) }
       return results unless block_given?
@@ -51,14 +49,21 @@ module PluckMap
     end
 
   private
-    attr_reader :attributes_by_id, :selects
 
     def invoke(attribute_id, object)
       attributes_by_id.fetch(attribute_id).apply(object)
     end
 
+    def selects
+      attributes.selects
+    end
+
+    def attributes_by_id
+      attributes.by_id
+    end
+
     def keys
-      puts "DEPRECATION WARNING: PluckMap::Presenter#keys is deprecated with no replacement"
+      puts "DEPRECATION WARNING: PluckMap::Presenter#keys is deprecated; use #selects instead"
       selects
     end
 

data/lib/pluck_map/presenters/to_csv.rb

@@ -0,0 +1,29 @@
+module PluckMap
+  module CsvPresenter
+
+    def to_csv(query)
+      define_to_csv!
+      to_csv(query)
+    end
+
+    private def define_to_csv!
+      require "csv"
+
+      headers = CSV.generate_line(attributes.map(&:name))
+      ruby = <<-RUBY
+      def to_csv(query)
+        pluck(query) do |results|
+          rows = [#{headers.inspect}]
+          results.each_with_object(rows) do |values, rows|
+            values = Array(values)
+            rows << CSV.generate_line([#{attributes.map(&:to_ruby).join(", ")}])
+          end.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/presenters/to_json.rb

@@ -0,0 +1,23 @@
+require "json"
+
+module PluckMap
+  module JsonPresenter
+
+    def to_json(query, json: default_json, **)
+      json.dump(to_h(query))
+    end
+
+  private
+
+    def default_json
+      if defined?(MultiJson)
+        MultiJson
+      elsif defined?(Oj)
+        Oj
+      else
+        JSON
+      end
+    end
+
+  end
+end

data/lib/pluck_map/presenters.rb

@@ -1 +1,3 @@
+require "pluck_map/presenters/to_csv"
 require "pluck_map/presenters/to_h"
+require "pluck_map/presenters/to_json"

data/lib/pluck_map/version.rb

@@ -1,3 +1,3 @@
 module PluckMapPresenter
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/pluck_map.rb

@@ -1,10 +1,15 @@
 require "pluck_map/version"
+require "pluck_map/model_context"
 require "pluck_map/presenter"
 require "pluck_map/null_logger"
 
 module PluckMap
   class << self
     attr_accessor :logger
+
+    def [](model)
+      PluckMap::ModelContext.new(model)
+    end
   end
 
   @logger = (Rails.logger if defined?(Rails)) || PluckMap::NullLogger.new

data/pluck_map.gemspec

@@ -27,6 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "benchmark-memory"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "shoulda-context"
   spec.add_development_dependency "rr"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_map
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-27 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -136,6 +136,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: benchmark-ips
+  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: benchmark-memory
+  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: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -217,10 +259,14 @@ files:
 - lib/pluck_map.rb
 - lib/pluck_map/attribute.rb
 - lib/pluck_map/attribute_builder.rb
+- lib/pluck_map/attributes.rb
+- lib/pluck_map/model_context.rb
 - lib/pluck_map/null_logger.rb
 - lib/pluck_map/presenter.rb
 - lib/pluck_map/presenters.rb
+- lib/pluck_map/presenters/to_csv.rb
 - lib/pluck_map/presenters/to_h.rb
+- lib/pluck_map/presenters/to_json.rb
 - lib/pluck_map/version.rb
 - pluck_map.gemspec
 homepage: https://github.com/boblail/pluck_map