mongoid-report 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGI5NjU2YTI3ZTI0MmIxYzA0ZTRiYTQ4ZDhiZGNmY2FiZDRhMmViMg==
+    MjViNTY5ZjMxOWYzYWU5ZmY3NGNlMGJkZTVkMjFkZmY5ZGUxMTEyZA==
   data.tar.gz: !binary |-
-    MDY0ODA4ZGM4MWI0NzViOTljMTQ2ZTYwNjNjYWU3NTlkY2Q3MDMxMg==
+    YjhiZDUzNWIwNGYxYWI3OGQ4MjJhMDRkYWFmNjVkMmZhNjBlZmY4Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZmI4YWEzNzIwMDM0MTdjODBmZDFlNjAyYTliMTliZmVmYTA1NDcwMWJhY2Jj
-    N2IzYzY4M2UzYzNkNWQ2OTYwY2FlYWE2NGY4ZTQ3YmU0NjQyMGY0Njc4NTdk
-    ZTJkZjQ5MTQ4YTc3NTViMzVhMTQ4MjU4NGRmYTY3Y2U4ZjgyMWQ=
+    MjFhMWU4YWI4YzExYzUyYmI3ZWM4Yzk5OGE3NGJlOWE0OTcyNjY4NmMwODRj
+    ZDQ0NWViMDk4MTk3MWZmODBkZmYwZGQzMjgzNjU4M2VjN2M5ZmQ1MWEwYTZl
+    MTBmMjhjMDIxYzJiNTJkMTAxNzVmYjM1MjUzOTBlMWE3YWU4OTA=
   data.tar.gz: !binary |-
-    NzUxMGQzNzNjZjU5Yzk0ZWViNWFlNWU0MTI2YWUwOGE3MDk5YzM4ZjZjZjEw
-    YjU2ODU0ZTRlN2MzNWY3MTYzNDE4YTg1ZjdjZjM2ZGQ3MGE3NDQ2NzY4ZWZh
-    YTRmNTExYmMwNTk2ZjhmMjFkNGFkMmQwZDBjOTI4Mzk0NGQ2NGQ=
+    Y2E4NzQzMDJkZGIyOTBmZDJkY2IyNWM3NmUyZGQ0Y2U5YWRiMDM4MGMzOTli
+    Mzg5MDRhZjUwNWVmZTZmMTNlZGY0MTM0N2Y2ZDM4MDI0ZjQ1MjE2ZWYzMjg3
+    ODdjMTA4NDBiMmM2MjhkMzhjZjI2MGM0ZWI0ZWViYjcwYTIyOGU=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-report (0.0.10)
+    mongoid-report (0.0.11)
       mongoid (> 3.0.1)
 
 GEM

data/lib/mongoid/report/attach_proxy.rb

@@ -2,12 +2,27 @@ module Mongoid
   module Report
 
     AttachProxy = Struct.new(:context, :collection, :options) do
+      attr_reader :attach_name
+
+      def initialize(context, collection, options)
+        # Lets remove as option because of passing to the next blocks options
+        @attach_name = options.delete(:as) || collection
+        options = options.merge(attach_name: attach_name, for: collection)
+        super(context, collection, options)
+      end
+
       def aggregation_field(*fields)
-        context.aggregation_field(*fields, options.merge(for: collection))
+        field_options = fields.extract_options!
+        field_options.merge!(options)
+
+        context.aggregation_field(*fields, field_options)
       end
 
       def group_by(*fields)
-        context.group_by(*fields, options.merge(for: collection))
+        group_options = fields.extract_options!
+        group_options.merge!(options)
+
+        context.group_by(*fields, group_options)
       end
     end
 

data/lib/mongoid/report/queries_builder.rb

@@ -26,9 +26,17 @@ module Mongoid
         @fields ||= settings[:fields]
       end
 
+      def in_fields
+        @in_fields ||= fields.keys
+      end
+
+      def output_fields
+        @output_fields ||= fields.values
+      end
+
       def all_fields
         [:_id]
-          .concat(fields)
+          .concat(in_fields)
           .concat(groups)
       end
 
@@ -48,7 +56,7 @@ module Mongoid
             hash.merge!(group => GROUP_TEMPLATE % group)
           end
 
-          fields.inject(query) do |hash, field|
+          in_fields.inject(query) do |hash, field|
             hash.merge!(field => { '$sum' => GROUP_TEMPLATE % field })
           end
         end
@@ -67,8 +75,8 @@ module Mongoid
             end
           end
 
-          fields.inject(query) do |hash, field|
-            hash.merge!(field => 1)
+          fields.inject(query) do |hash, (field, name)|
+            hash.merge!(name => "$#{field}")
           end
         end
       end

data/lib/mongoid/report/scope.rb

@@ -37,7 +37,9 @@ module Mongoid
       end
 
       def fields
-        context.class.settings_property(report_name, :fields)
+        # We need to use here only output field names it could be different
+        # than defined colunms, Example: field1: 'report-field-name'
+        context.class.settings_property(report_name, :fields).values
       end
     end
 

data/lib/mongoid/report/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Report
-    VERSION = "0.0.10"
+    VERSION = "0.0.11"
   end
 end

data/lib/mongoid/report.rb

@@ -49,40 +49,43 @@ module Mongoid
     end
 
     module ClassMethods
+      def report(name, &block)
+        proxy = ReportProxy.new(self, name)
+        proxy.instance_eval(&block)
+      end
+
       def attach_to(collection, options = {}, &block)
         proxy = AttachProxy.new(self, collection, options)
         proxy.instance_eval(&block)
       end
 
       def group_by(*fields)
-        define_report_method(*fields) do |groups, report_name|
+        define_report_method(*fields) do |groups, report_name, _|
           settings[report_name][:group_by] = groups
         end
       end
 
       def aggregation_field(*fields)
-        define_report_method(*fields) do |columns, report_name|
+        define_report_method(*fields) do |columns, report_name, options|
           columns.each do |column|
-            add_field(report_name, column)
+            name = options.fetch(:as) { column }
+            add_field(report_name, column, name)
           end
         end
       end
 
-      def report(name, &block)
-        proxy = ReportProxy.new(self, name)
-        proxy.instance_eval(&block)
-      end
-
       def fields(collection)
-        settings_property(collection, :fields)
+        settings_property(collection, :fields, {})
       end
 
       def groups(collection)
-        settings_property(collection, :group_by)
+        settings_property(collection, :group_by, [])
       end
 
-      def settings_property(collection, key)
-        settings.fetch(collection, {}).fetch(key, [])
+      def settings_property(collection, key, default = [])
+        settings
+          .fetch(collection) { {} }
+          .fetch(key) { default }
       end
 
       private
@@ -90,41 +93,33 @@ module Mongoid
       def define_report_method(*fields)
         options = fields.extract_options!
 
-        # We should always have for option
-        report_name = initialize_settings_by(options)
-
-        # Because of modifying fields(usign exract options method of
-        # ActiveSupport) lets pass fields to the next block with collection.
-        yield fields, report_name
-      end
-
-      def initialize_settings_by(options)
         # We should always specify model to attach fields, groups
         collection = options.fetch(:for)
 
         # If user didn't pass as option to name the report we are using
         # collection class as key for settings.
-        report_name = options.fetch(:as) { collection }
+        attach_name = options.fetch(:attach_name) { collection }
+
+        # We should always have for option
+        initialize_settings_by(attach_name, collection)
+
+        # Because of modifying fields(usign exract options method of
+        # ActiveSupport) lets pass fields to the next block with collection.
+        yield fields, attach_name, options || {}
+      end
 
-        settings[report_name] ||= settings.fetch(report_name) do
+      def initialize_settings_by(attach_name, collection)
+        settings[attach_name] ||= settings.fetch(attach_name) do
           {
             for:       collection,
-            fields:    [],
+            fields:    {},
             group_by:  [],
           }
         end
-
-        report_name
       end
 
-      def add_field(report_name, field)
-        settings[report_name][:fields] << field
-
-        class_eval <<-FIELD
-          def #{field}
-            @#{field} ||= 0
-          end
-        FIELD
+      def add_field(attach_name, field, name)
+        settings[attach_name][:fields][field] = name
       end
 
     end

data/spec/mongoid/report/aggregation_spec.rb

@@ -166,6 +166,51 @@ describe Mongoid::Report do
       expect(rows[1]['field2']).to eq(2)
       expect(rows[1]['day']).to eq(yesterday)
     end
+
+    class Report11
+      include Mongoid::Report
+
+      report 'example' do
+        attach_to Model, as: 'model1' do
+          group_by :day
+          aggregation_field :field1, as: 'new-field1'
+        end
+
+        attach_to Model, as: 'model2' do
+          group_by :day
+          aggregation_field :field2
+        end
+      end
+    end
+
+    it 'should still aggregate with combined report and project using the new names' do
+      klass.create(day: today        , field1: 1 , field2: 2)
+      klass.create(day: today        , field1: 1 , field2: 2)
+      klass.create(day: yesterday    , field1: 1 , field2: 2)
+      klass.create(day: two_days_ago , field1: 1 , field2: 2)
+
+      example = Report11.new
+      scope = example.aggregate
+      scope
+        .query('$match' => { :day  => { '$gte' => yesterday.mongoize, '$lte' => today.mongoize } })
+        .yield
+        .query('$sort' => { day: -1 })
+      scope = scope.all
+
+      rows = scope['example-model1']
+      expect(rows.size).to eq(2)
+      expect(rows[0]['new-field1']).to eq(2)
+      expect(rows[0]['day']).to eq(today)
+      expect(rows[1]['new-field1']).to eq(1)
+      expect(rows[1]['day']).to eq(yesterday)
+
+      rows = scope['example-model2']
+      expect(rows.size).to eq(2)
+      expect(rows[0]['field2']).to eq(4)
+      expect(rows[0]['day']).to eq(today)
+      expect(rows[1]['field2']).to eq(2)
+      expect(rows[1]['day']).to eq(yesterday)
+    end
   end
 
 end

data/spec/mongoid/report/queries_builder_spec.rb

@@ -19,7 +19,7 @@ describe Mongoid::Report::QueriesBuilder do
       expect(queries[2]).to eq(
         '$project' => {
           :_id    => '$_id',
-          :field1 => 1,
+          :field1 => '$field1',
         })
     end
 
@@ -41,7 +41,7 @@ describe Mongoid::Report::QueriesBuilder do
         '$project' => {
           :_id    => 0,
           :day    => '$_id.day',
-          :field1 => 1,
+          :field1 => '$field1',
         })
     end
 
@@ -77,8 +77,8 @@ describe Mongoid::Report::QueriesBuilder do
           :_id    => 0,
           :day    => '$_id.day',
           :field2 => '$_id.field2',
-          :field1 => 1,
-          :field3 => 1,
+          :field1 => '$field1',
+          :field3 => '$field3',
         })
     end
   end

data/spec/mongoid/report_spec.rb

@@ -3,28 +3,13 @@ require 'spec_helper'
 describe Mongoid::Report do
 
   describe '.aggregation_field' do
-    it 'defines field for aggregation using class method' do
-      example = Report1.new
-      expect(example).to be_respond_to(:field1)
-    end
-
-    it 'defines as reader only' do
-      example = Report1.new
-      expect{ example.field1 = 'value' }.to raise_error
-    end
-
-    it 'defines field with 0 by default' do
-      example = Report1.new
-      expect(example.field1).to eq(0)
-    end
-
     it 'defines aggegration settings' do
       expect(Report1).to be_respond_to(:settings)
     end
 
     it 'defines aggregation field for specific model to make queries' do
       fields = Report1.fields(Model)
-      expect(fields).to eq([:field1])
+      expect(fields).to eq({ field1: :field1 })
     end
   end
 
@@ -35,7 +20,7 @@ describe Mongoid::Report do
 
     it 'defines field in terms of attached model' do
       fields = Report2.fields(Model)
-      expect(fields).to eq([:field1])
+      expect(fields).to eq({ field1: :field1 })
     end
   end
 
@@ -89,4 +74,17 @@ describe Mongoid::Report do
       expect(Report7.settings).to have_key("example-#{Model.collection.name}")
     end
   end
+
+  class Report10
+    include Mongoid::Report
+
+    aggregation_field :field1, for: Model, as: 'field-name'
+  end
+
+  describe '.aggregation_field `as` option' do
+    it 'creates settings with report-<attached-model-name' do
+      expect(Report10.fields(Model).keys).to eq([:field1])
+      expect(Report10.fields(Model).values).to eq(['field-name'])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-report
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Alexandr Korsak