simple_drilldown 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ddf461c2a4468488cbc463a59aa94229bb26f85e248e712da54545865c669e
-  data.tar.gz: 33af8b7b6cf86b22c17e4db5193b3c0cc8db3e228f2dfbc2a376f5b0e534b2fa
+  metadata.gz: 24272122319881a4c28db29d1b986ebd2f49d0ed50d642648fe5e5795c4f04b4
+  data.tar.gz: c5ec174af7dcb4d1ca5dfabfa0abc27b8999177d2f6580be2f65f874825bfcf0
 SHA512:
-  metadata.gz: 1adc008b5dd8e53570735de90939ed33ad7e4e0f16067c177c60bb05ff6b189097f4c2057376fcfb99bc931b05579189f276167b204397aee46f990830362913
-  data.tar.gz: f45aa0e99c1df10b9a6ce8dfb0f2782e3535f80c75294b7c0c2a7e0396b532cef6f626e7859c6e1f9d2455e2f6858e40197dee458c77659e53756832d31f5819
+  metadata.gz: 6310bab272395d0b003616e99e9467c81f31148a6410e83e124770589ef6e9e81de2b60ca8aa84b31eadfc1fb62bfbe81a7e377187a2d0479d0c6e3c819cdbe1
+  data.tar.gz: ba2943b101e839e0793c51c4d80e94e27952476993c70b6eeaaa1a3a953336da0115890262f2a135ca49669a6298b8bf777bc5d60ba304616ca3c61041c504a4

data/README.md

@@ -1,10 +1,131 @@
 # SimpleDrilldown
-Short description and motivation.
+
+<a href="https://travis-ci.org/DatekWireless/simple_drilldown">
+<img align="right" src="https://travis-ci.org/DatekWireless/simple_drilldown.svg?branch=master" alt="Build Status">
+</a>
+
+simple_drilldown offers a simple way to define axis to filter and group records
+for analysis.  The result is a record count for the selected filter and
+distribution and the option to list the actual records.
 
 ## Usage
-How to use my plugin.
+
+### Rails
+
+For a given schema:
+
+```ruby
+ActiveRecord::Schema.define(version: 20141204155251) do
+  create_table "posts" do |t|
+    t.string   "title",      null: false
+    t.text     "body",       null: false
+    t.integer  "user_id",    null: false
+    t.datetime "published_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "users" do |t|
+    t.string "name",   limit: 16, null: false
+  end
+
+  create_table "comments" do |t|
+    t.integer  "post_id", null: false
+    t.string   "title",   null: false
+    t.text     "body",    null: false
+    t.integer  "rating",  null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end
+```
+
+We have three entities:
+
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments
+end
+
+class User < ActiveRecord::Base
+  has_many :comments
+  has_many :posts
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :user
+end
+```
+
+#### Controller
+
+Create a new controller to focus on posts.  Each drilldown controller focuses on
+one main entity.
+
+```ruby
+class PostsDrilldownController < DrilldownController
+
+  # What fields should be displayed as default when listing actual Post records.
+  default_fields %w{created_at user title}
+
+  # The main focus of the drilldown
+  target_class Post
+
+  # How should we count the reords?
+  select "count(*) as count".freeze
+
+  # When listing records, what relations should be included for optimization?
+  list_includes :user, :comments
+
+  # In what order should records be listed?
+  list_order 'posts.created_at'
+
+  # Field definitions when listing records
+  field :created_at
+  field :title
+
+  # The "attr_method" option transforms the value from the database to a
+  # readable form.
+  field :user, attr_method: lambda { |post| post.user.name }
+  field :body, attr_method: lambda { |post| post.body[0..32] }
+  field :comments, attr_method: lambda { |post| post.comments.count }
+
+  dimension :calendar_date, "DATE(posts.created_at)", interval: true
+  dimension :comments, "SELECT count(*) FROM comments c WHERE c.post_id = posts.id"
+  dimension :user, 'users.name', includes: :user
+  dimension :day_of_month, "date_part('day', posts.created_at)"
+  dimension :day_of_week, "CASE WHEN date_part('dow', posts.created_at) = 0 THEN 7 ELSE date_part('dow', posts.created_at) END",
+            label_method: lambda { |day_no| Date::DAYNAMES[day_no.to_i % 7] }
+  dimension :hour_of_day, "date_part('hour', posts.created_at"
+  dimension :month, "date_part('month', posts.created_at",
+            label_method: lambda { |month_no| Date::MONTHNAMES[month_no.to_i] }
+  dimension :week, "date_part('week', posts.created_at)"
+  dimension :year, "date_part('year', posts.created_at)"
+end
+```
+
+The controller inherits the ```index``` action and other actions to display the
+results.
+
+### Views
+
+You need the following views:
+
+
+
+## Excel export
+
+# TODO: Write about Excel export.
+
+```ruby
+{excel_type: 'Number', excel_style: 'ThreeDecimalNumberFormat'}
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,7 +143,12 @@ $ gem install simple_drilldown
 ```
 
 ## Contributing
-Contribution directions go here.
+
+1. Fork it
+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`)
+5. Create new Pull Request
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/locales/nb.yml

@@ -6,7 +6,7 @@ nb:
   fields: Felt
   filter: Filter
   from_date: Fra dato
-  group_by: Grupper på
+  group_by: Gruppér på
   line: Linje
   list: Liste
   none: Ingen

data/lib/simple_drilldown/drilldown_controller.rb

@@ -416,7 +416,7 @@ module SimpleDrilldown
         options[:include].uniq!
 
         joins = self.class.make_join([], @target_class.name.underscore.to_sym, options.delete(:include))
-        result[:transactions] = @target_class.joins(joins).where(@base_condition).where(list_conditions(conditions, values)).includes(options[:include]).order(options[:order]).all
+        result[:transactions] = @target_class.unscoped.joins(joins).where(@base_condition).where(list_conditions(conditions, values)).includes(options[:include]).order(options[:order]).all
       end
     end
 

data/lib/simple_drilldown/version.rb

@@ -1,3 +1,3 @@
 module SimpleDrilldown
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_drilldown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Uwe Kubosch
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple data warehouse and drilldown.