pluck_map 1.0.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d907de27fded6b459dbff8787f939019823dc589ab3922df031afbdc891a63c5
-  data.tar.gz: 1282d91b22bebf374f39ac90f8cac489325c76b2abea949ce5c4c88343739228
+  metadata.gz: b67d33088429e33e5b52da0c68a9355dd0131d5404c9af3238cfc692b497dbad
+  data.tar.gz: 4af18c89e5e9fe10796cb8ee5cd3782e89e767f2104af016fc06a34edf0c5df9
 SHA512:
-  metadata.gz: af29f7f130881691cd7ec5d49b6fbb781fb2f21c16bb4762682a77e00404098806f94b70e0fdce488966a52a6be2859a783fb3fdc4a94f2ed3912ec1b55dd220
-  data.tar.gz: 9993639be1838a7653501b52df366f318b7b67032adb481e72d7ad675b0e470264af87fb4b16e834814d9e26856e8fd24582a0edf8429c243d27d3e4795fdfbe
+  metadata.gz: 7208cdebddc1813ead385a83fa08205868de2ba2b0b78c7470c7d9cd437b48867817c3c997ef24af117eb18e49a406f7a886221384dcaf8d5745ce7909ed97ec
+  data.tar.gz: 2f715ab9f2d5c687a42010d9176913201f9eaea23a795caf88fbc4b9e5448239ceacafc78632f197a632dfb376bff1b6afde0bad1326cc7bfefe384eea8df7ed

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-rvm: 2.5.5
+rvm: 2.6.3
 
 # we need MySQL 5.7+ to support JSON aggregation
 dist: xenial
@@ -21,6 +21,7 @@ matrix:
   - gemfile: gemfiles/rails_5.0.gemfile
   - gemfile: gemfiles/rails_5.1.gemfile
   - gemfile: gemfiles/rails_5.2.gemfile
+  - gemfile: gemfiles/rails_6.0.gemfile
   - gemfile: gemfiles/rails_edge.gemfile
   allow_failures:
   - gemfile: gemfiles/rails_edge.gemfile

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+* BREAKING: `define` returns a subclass of `PluckMap::Presenter` instead of an instance (@boblail)
+* FEATURE: `define` also creates structs to correspond to each presenter (@boblail)
+
 ## v1.0.0 (2019 Jul 17)
 
 * FIX: Respect default_scopes for relationships (@boblail)

data/lib/pluck_map/attributes.rb

@@ -37,6 +37,10 @@ module PluckMap
 
 
 
+    def ids
+      _attributes_by_id.keys
+    end
+
     def by_id
       _attributes_by_id
     end

data/lib/pluck_map/model_context.rb

@@ -1,4 +1,5 @@
 require "pluck_map/presenter"
+require "pluck_map/struct"
 
 module PluckMap
   class ModelContext
@@ -8,7 +9,27 @@ module PluckMap
 
     def define(&block)
       attributes = PluckMap::AttributeBuilder.build(model: @model, &block)
-      PluckMap::Presenter.new(@model, attributes)
+      define_class!(@model, attributes)
+    end
+
+  private
+
+    def define_class!(model, attributes)
+      # Create a new subclass of PluckMap::Presenter
+      klass = Class.new(PluckMap::Presenter)
+
+      # Partially apply initialize with the parameters passed to this method
+      klass.define_method(:initialize) do |query|
+        super(model, attributes, query)
+      end
+
+      # Generate a Struct constant in the namespace of the new subclass
+      struct = ::Struct.new(*attributes.ids, keyword_init: true)
+      struct.extend PluckMap::Struct::ClassMethods
+      struct.instance_variable_set :@presenter, klass
+      klass.const_set :Struct, struct
+
+      klass
     end
   end
 end

data/lib/pluck_map/presenter.rb

@@ -9,20 +9,21 @@ module PluckMap
   class Presenter
     include CsvPresenter, HashPresenter, JsonPresenter
 
-    attr_reader :model, :attributes
+    attr_reader :model, :attributes, :query
+
+    def initialize(model, attributes, query)
+      unless query.model <= model
+        raise ArgumentError, "Query for #{query.model} but #{model} expected"
+      end
 
-    def initialize(model, attributes)
       @model = model
       @attributes = attributes
+      @query = query
     end
 
   protected
 
-    def pluck(query)
-      unless query.model <= model
-        raise ArgumentError, "Query for #{query.model} but #{model} expected"
-      end
-
+    def pluck
       # puts "\e[95m#{query.select(*selects).to_sql}\e[0m"
       results = benchmark("pluck(#{query.table_name})") { query.pluck(*selects) }
       return results unless block_given?
@@ -70,6 +71,7 @@ module PluckMap
 
         # On Rails 4.2, `pluck` can't accept Arel nodes
         select = Arel.sql(select.to_sql) if ActiveRecord.version.segments.take(2) == [4,2] && select.respond_to?(:to_sql)
+
         select
       }
     end

data/lib/pluck_map/presenters/to_csv.rb

@@ -3,13 +3,19 @@ require "pluck_map/errors"
 module PluckMap
   module CsvPresenter
 
-    def to_csv(query)
+    def self.included(base)
+      def base.to_csv(query, **kargs)
+        new(query).to_csv(**kargs)
+      end
+    end
+
+    def to_csv
       if attributes.nested?
         raise PluckMap::UnsupportedAttributeError, "to_csv can not be used to present nested attributes"
       end
 
       define_to_csv!
-      to_csv(query)
+      to_csv
     end
 
     private def define_to_csv!
@@ -17,8 +23,8 @@ module PluckMap
 
       headers = CSV.generate_line(attributes.map(&:name))
       ruby = <<-RUBY
-      def to_csv(query)
-        pluck(query) do |results|
+      def to_csv
+        pluck do |results|
           rows = [#{headers.inspect}]
           results.each_with_object(rows) do |values, rows|
             values = Array(values)

data/lib/pluck_map/presenters/to_h.rb

@@ -1,15 +1,21 @@
 module PluckMap
   module HashPresenter
 
-    def to_h(query)
+    def self.included(base)
+      def base.to_h(query, **kargs)
+        new(query).to_h(**kargs)
+      end
+    end
+
+    def to_h
       define_to_h!
-      to_h(query)
+      to_h
     end
 
     private def define_to_h!
       ruby = <<-RUBY
-      def to_h(query)
-        pluck(query) do |results|
+      def to_h
+        pluck do |results|
           results.map { |values| values = Array(values); { #{attributes.map { |attribute| "#{attribute.name.inspect} => #{attribute.to_ruby}" }.join(", ")} } }
         end
       end

data/lib/pluck_map/presenters/to_json.rb

@@ -3,30 +3,36 @@ require "json"
 module PluckMap
   module JsonPresenter
 
-    def to_json(query, json: default_json, **)
+    def self.included(base)
+      def base.to_json(query, **kargs)
+        new(query).to_json(**kargs)
+      end
+    end
+
+    def to_json(json: default_json, **)
       if attributes.will_map?
-        to_json__default(query, json: json)
+        to_json__default(json: json)
       else
-        to_json__optimized(query)
+        to_json__optimized
       end
     end
 
   private
 
-    def to_json__default(query, json: default_json, **)
-      json.dump(to_h(query))
+    def to_json__default(json: default_json, **)
+      json.dump(to_h)
     end
 
-    def to_json__optimized(query, **)
+    def to_json__optimized(**)
       define_to_json__optimized!
-      to_json__optimized(query)
+      to_json__optimized
     end
 
     def define_to_json__optimized!
       sql = compile(to_json_object(attributes).as("object"))
 
       ruby = <<-RUBY
-      private def to_json__optimized(query, **)
+      private def to_json__optimized(**)
         sql = wrap_aggregate(query.select(Arel.sql(#{sql.inspect})))
         query.connection.select_value(sql)
       end

data/lib/pluck_map/struct.rb

@@ -0,0 +1,13 @@
+module PluckMap
+  module Struct
+    module ClassMethods
+      def presenter
+        @presenter || superclass.presenter
+      end
+
+      def load(relation)
+        presenter.to_h(relation).map { |values| new(**values) }
+      end
+    end
+  end
+end

data/lib/pluck_map/version.rb

@@ -1,3 +1,3 @@
 module PluckMapPresenter
-  VERSION = "1.0.0"
+  VERSION = "2.0.0.rc1"
 end

data/pluck_map.gemspec

@@ -17,6 +17,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # uses `keyword_init` argument of `Struct.new`
+  spec.required_ruby_version = '>= 2.5.0'
+
   spec.add_dependency "activerecord", ">= 4.2"
 
   spec.add_development_dependency "appraisal"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_map
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -276,6 +276,7 @@ files:
 - lib/pluck_map/relationships/many.rb
 - lib/pluck_map/relationships/one.rb
 - lib/pluck_map/relationships/polymorphic_one.rb
+- lib/pluck_map/struct.rb
 - lib/pluck_map/structured_attribute.rb
 - lib/pluck_map/version.rb
 - lib/pluck_map/visitors.rb
@@ -294,12 +295,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6