mongoid-report 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjZhMmQ5YzU0ZWUwYzFjMjY2NjUyNjE0ZWFkMWM1ZWUzMzhhNjM2Mg==
+    NWFkMjE5MjllMjY1NjY3MjYzYTdlYTMyNWVhYTlmNjVjMzI4MWRjZg==
   data.tar.gz: !binary |-
-    ODI3YTVkMTNjNjlhYzhhOGNlZTI1NjYwOWE0YjAzYzY0OTQ1ZmViYg==
+    OWEzMzBkOTRlZTUxMzZhN2E1OWExMzNjYjM4ZTViZTIzODhjMzdhNg==
 SHA512:
   metadata.gz: !binary |-
-    NzBjM2VhYzBiN2JhMzc4ZjliYWYyNDFjNmE0MDY0ZTNlM2QyYTUxYjZjYmI3
-    YWU0YTA4OTgxMmQyZGZjM2VlZWMyMzhmZDMxZTk1ZTg2OWU3YWFiZWJhMGFi
-    MjA0MTg5MTNlZDUxMmNjZTVlNmYzMjg2NGZjODJkNDc4OTY1MTI=
+    ODM5YjVmMjY5ZTEzMTgzNDNkMjMyMmI3NzExZDFkOGYwMGFhMjg4ZDAxMzc1
+    ZjBmNjhmMDczMjcxODEyY2ExMmEyZTk5YzlhZDhkODJlYmE2OGUxOWQ5ZmE5
+    MGU5MjIwZTQxMTdjZTY4ZGQ3MjFkZWRjM2EyZjg3NjY4ZDc1NDQ=
   data.tar.gz: !binary |-
-    MjAyOWVkNmNjNGQ2ZjAyMTQyMzYzYzE0ZDVlNzdmZDMzMWE5NjU4NDgyNDli
-    Y2UzYWJkNTQ4NmQzZTMyNWM0MWU3MjMyOGE1ZjM5OGUzYjgwM2E0OGY4MDBm
-    MWQ4OWY2YTg4N2FiYmM3NjljMzQ0NjVjMTc3MDEyYTllMjEwOWM=
+    ZWRmOWIwMWZkNzMwZmZjZTMxM2E5ZTg0M2IxZDcxN2U4NzYzY2Q4OWRkNDVm
+    MTgzMmQzNWIyN2RiNTZmZDdjMGQ0YTBkOTUxY2Q0Y2U5ZTk5ZjFjYTJkZDFl
+    MjFmZjkwYzY1MDhkM2EwNGU1NDE5ZTBjMDU1M2FmMDE4MGNjOGQ=

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+

data/Gemfile

@@ -4,8 +4,6 @@ gemspec
 
 group :test do
   gem 'rspec'
-  gem 'rspec-expectations'
-  gem 'database_cleaner'
 end
 
 group :development, :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-report (0.0.6)
+    mongoid-report (0.0.7)
       mongoid (> 3.0.1)
 
 GEM
@@ -16,7 +16,6 @@ GEM
     builder (3.0.4)
     coderay (1.1.0)
     columnize (0.3.6)
-    database_cleaner (1.2.0)
     debugger (1.6.6)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.2.0)
@@ -62,10 +61,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.5)
-  database_cleaner
   mongoid-report!
   pry
   pry-debugger
   rake
   rspec
-  rspec-expectations

data/README.md

@@ -3,6 +3,10 @@
 Library for easy building aggregation report using mongodb aggregation
 framework.
 
+[![Build Status](https://secure.travis-ci.org/oivoodoo/mongoid-report.png?branch=master)](https://travis-ci.org/oivoodoo/mongoid-report)
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/oivoodoo/mongoid-report)
+
 ### Example
 
 ```ruby
@@ -45,14 +49,30 @@ framework.
       aggregation_field :field1
     end
   end
+
+  class Report5
+    include Mongoid::Report
+
+    attach_to Model, as: 'summary-report' do
+      group_by :day
+
+      aggregation_field :field1
+    end
+  end
 ```
 
 ```ruby
   example = Report4.new
-  result = example.aggregate_for(Model)
+  scope = example.aggregate_for(Model)
+  scope = scope.query('match' => { 'field1' => 1 })
+  result = scope.all
 
   result.is_a?(Array) => true
   result[0].is_a?(Hash) => true
+
+  example = Report5.new
+  scope = example.aggregate_for('summary-report')
+  result = scope.all
 ```
 
 ## Installation
@@ -67,15 +87,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mongoid_report
-
-## Usage
-
-TODO: Write usage instructions here
+    $ gem install mongoid-report
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/mongoid_report/fork )
+1. Fork it ( http://github.com/oivoodoo/mongoid-report/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :default do
+  system 'bundle exec rspec'
+end

data/lib/mongoid/report/queries_builder.rb

@@ -4,9 +4,9 @@ module Mongoid
     QueriesBuilder = Struct.new(:settings) do
       def do
         [].tap do |queries|
-          queries.concat([{ '$project' => query1 }])
-          queries.concat([{ '$group'   => query2 }])
-          queries.concat([{ '$project' => query3 }])
+          queries.concat([{ '$project' => project_query }])
+          queries.concat([{ '$group'   => group_query }])
+          queries.concat([{ '$project' => project_group_fields_query }])
         end
       end
 
@@ -33,14 +33,14 @@ module Mongoid
       end
 
       # Example: { '$project' => { :field1 => 1 } }
-      def query1
+      def project_query
         all_fields.inject({}) do |hash, field|
           hash.merge!(field => 1)
         end
       end
 
       GROUP_TEMPLATE = "$%s"
-      def query2
+      def group_query
         {}.tap do |query|
           query[:_id] = {}
 
@@ -55,7 +55,7 @@ module Mongoid
       end
 
       PROJECT_TEMPLATE = "$_id.%s"
-      def query3
+      def project_group_fields_query
         {}.tap do |query|
           if groups == [:_id]
             query[:_id] = '$_id'

data/lib/mongoid/report/scope.rb

@@ -0,0 +1,45 @@
+module Mongoid
+  module Report
+
+    Scope = Struct.new(:context, :report_name) do
+      def query(conditions)
+        queries.concat([conditions])
+        self
+      end
+
+      # We need to add grouping conditions when user needs it.
+      def yield
+        return self if @yielded
+
+        queries.concat(context.queries(report_name))
+        @yielded = true
+
+        self
+      end
+
+      def all
+        self.yield unless yielded?
+        Collection.new(klass.collection.aggregate(queries), fields)
+      end
+
+      private
+
+      def yielded?
+        @yielded
+      end
+
+      def queries
+        @queries ||= []
+      end
+
+      def klass
+        context.class.settings_property(report_name, :for)
+      end
+
+      def fields
+        context.class.settings_property(report_name, :fields)
+      end
+    end
+
+  end
+end

data/lib/mongoid/report/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Report
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/mongoid/report.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/class/attribute'
 require_relative 'report/queries_builder'
 require_relative 'report/attach_proxy'
 require_relative 'report/collection'
+require_relative 'report/scope'
 
 module Mongoid
   module Report
@@ -36,17 +37,8 @@ module Mongoid
       end
 
       # We should pass here mongoid document
-      def aggregate_for(klass)
-        queries = queries(klass)
-
-        yield queries if block_given?
-
-        # Lets wrap aggregation by collection structure for adding common
-        # methods like summary for data.
-        Collection.new(
-          klass.collection.aggregate(queries),
-          self.class.fields(klass),
-        )
+      def aggregate_for(report_name)
+        Scope.new(self, report_name)
       end
     end
 
@@ -78,33 +70,40 @@ module Mongoid
         settings_property(collection, :group_by)
       end
 
+      def settings_property(collection, key)
+        settings.fetch(collection, {}).fetch(key, [])
+      end
+
       private
 
       def define_report_method(*fields)
         options = fields.extract_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 }
-
         # We should always have for option
-        initialize_settings_by(report_name)
+        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(report_name)
+      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 }
+
         settings[report_name] ||= settings.fetch(report_name) do
           {
+            for:       collection,
             fields:    [],
             group_by:  [],
           }
         end
+
+        report_name
       end
 
       def add_field(report_name, field)
@@ -117,9 +116,6 @@ module Mongoid
         FIELD
       end
 
-      def settings_property(collection, key)
-        settings.fetch(collection, {}).fetch(key, [])
-      end
     end
 
   end

data/spec/mongoid/report/aggregation_spec.rb

@@ -13,6 +13,7 @@ describe Mongoid::Report do
 
       example = Report2.new
       rows = example.aggregate_for(klass)
+      rows = rows.all
 
       expect(rows.size).to eq(3)
       expect(rows[0]['field1']).to eq(1)
@@ -26,7 +27,9 @@ describe Mongoid::Report do
       klass.create!(day: yesterday , field1: 1)
 
       example = Report3.new
+
       rows = example.aggregate_for(klass)
+      rows = rows.all
 
       expect(rows.size).to eq(2)
       expect(rows[0]['field1']).to eq(1)
@@ -45,14 +48,13 @@ describe Mongoid::Report do
       klass.create(day: today        , field1: 1 , field2: 3)
 
       example = Report3.new
-      rows = example.aggregate_for(Model) do |queries|
-        # adding extra queries before the main
-        queries.unshift({ '$match' => { :day  => { '$gte' => yesterday.mongoize, '$lte' => today.mongoize } } })
-        queries.unshift({ '$match' => { :field2 => 2 } })
-        # adding sort to the end of aggregation query
-        queries.concat([{ '$sort' => { day: -1 } }])
-        queries
-      end
+      scope = example.aggregate_for(Model)
+      scope = scope.query('$match' => { :day  => { '$gte' => yesterday.mongoize, '$lte' => today.mongoize } })
+      scope = scope.query('$match' => { :field2 => 2 })
+      scope = scope.yield
+      scope = scope.query('$sort' => { day: -1 })
+
+      rows  = scope.all
 
       expect(rows.size).to eq(2)
       expect(rows[0]['field1']).to eq(2)

data/spec/mongoid/report/summary_spec.rb

@@ -14,6 +14,7 @@ describe Mongoid::Report do
 
       example = Report3.new
       rows = example.aggregate_for(klass)
+      rows = rows.all
 
       expect(rows.count).to eq(2)
       expect(rows.summary[:field1]).to eq(3)

data/spec/spec_helper.rb

@@ -2,20 +2,11 @@ require 'mongoid'
 require 'active_support/all'
 
 require 'rspec'
-require 'database_cleaner'
 
 Mongoid.configure do |config|
   config.connect_to('mongoid_report_test')
 end
 
-RSpec.configure do |config|
-  config.after(:each) do
-    Mongoid.purge!
-  end
-
-  config.backtrace_exclusion_patterns = [%r{lib\/rspec\/(core|expectations|matchers|mocks)}]
-end
-
 require_relative '../lib/mongoid/report.rb'
 require_relative 'support/models.rb'
 
@@ -25,15 +16,9 @@ RSpec.configure do |config|
 
   config.mock_with :rspec
 
-  config.before(:suite) do
-    DatabaseCleaner.clean_with(:truncation)
-  end
-
-  config.before(:each) do
-    DatabaseCleaner.start
-  end
-
   config.after(:each) do
-    DatabaseCleaner.clean
+    Mongoid.purge!
   end
+
+  config.backtrace_exclusion_patterns = [%r{lib\/rspec\/(core|expectations|matchers|mocks)}]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-report
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alexandr Korsak
@@ -62,6 +62,7 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- .travis.yml
 - .vimrc
 - Gemfile
 - Gemfile.lock
@@ -72,6 +73,7 @@ files:
 - lib/mongoid/report/attach_proxy.rb
 - lib/mongoid/report/collection.rb
 - lib/mongoid/report/queries_builder.rb
+- lib/mongoid/report/scope.rb
 - lib/mongoid/report/version.rb
 - mongoid-report.gemspec
 - spec/mongoid/report/aggregation_spec.rb