flatten_record 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3f760e4ba28e47a8cb7e46621300db8c99d36c9
-  data.tar.gz: 4129c16a709afbd09567ee9ce888257651f20a19
+  metadata.gz: ca6514cd5417800256fc9d02679ebfc487b9434d
+  data.tar.gz: dd8e7587673dd14b19d7692844c5af44617ef090
 SHA512:
-  metadata.gz: 5713c428677377b05b1feb93bc50fa821c173e6ccc33a52c6c571e1731c495d372b4f9006920d4ef811686b8d990ee6ef2f513f3efa3a9861e1d88fc71f851ba
-  data.tar.gz: 3ea39337ec9243801d6883bf1831267e3bbb28f70f6bf6af543dd8684e19ea7a4456e9c3c4029e2c507901d43900ba149525f9c94fa2c72e27148c8951a5cf2f
+  metadata.gz: 92f296a7b05159983e97ec7c8ed736eec0533aeabd9a0051bba644bf780cebeeed140d208d7d3f24352d26034e15f3fa0cd465a2606fcbc3c8157ea4d8ac1e1d
+  data.tar.gz: 178e1bb147d516a3adcbf46508badc083642ace332338a6bb7942debc3e8646352a8b94646654177f851fa6fb72849a1c1a3440b207f984b02ad3d0a096b8430

data/README.md

@@ -1,8 +1,35 @@
 # FlattenRecord [![Code Climate](https://codeclimate.com/github/alvinsj/flatten_record.png)](https://codeclimate.com/github/alvinsj/flatten_record)  [![Build Status](https://travis-ci.org/alvinsj/flatten_record.png?branch=master)](https://travis-ci.org/alvinsj/flatten_record)
 
-An ActiveRecord plugin that denormalizes your existing ActiveRecord models. 
+An ActiveRecord plugin that helps to denormalize your existing ActiveRecord models. 
 
-It provides an easier way to create denormalized records to be used for reporting, includes generation of migration file. 
+It provides an easier way to denormalize/flatten normalized records, and generation the table schema.
+
+## Example
+
+Existing normalized tables
+
+| orders  | customers |  line_items |
+|:-------|:---------|:-----------|
+|     id       | id   | id          |
+| customer_id  | name | description |
+| discount     |      | total       |
+| total        |      | order_id    |
+
+Denormalized table, generated by flatten_record
+
+|denormalized_orders|
+|:-------------------|
+| id                |
+| order_id          |
+| discount          |
+| total             |
+| customer_id       |
+| customer_name     |
+| line_item_id      |
+| line_item_description |
+| line_item_total       |
+| line_items_sum  (custom column)  | 
+| total_in_usd    (custom column)      | 
 
 ## Usage
 
@@ -19,19 +46,24 @@ Include module in your newly defined model
     	include FlattenRecord::Flattener
 
     	denormalize :order, {
+    	        
+    	    # specifying association
       		include: { 
-      		    # :belongs_to association
+      			# :belongs_to association
       			customer: {}
       		
       			# :has_many association, create multiple denormalized records  
       			line_items: {}
-  			},
-  			methods: {
-          		# save methods defined in Normalized model
+
+          	},
+          	
+			# save results of methods defined in Normalized model
+          	methods: {
           		total_in_usd: :decimal 
           	},
+          	
+			# compute results of methods defined in Denormalized model
           	compute: {
-          		# compute methods defined in Denormalized model
           		line_items_sum: { type: :decimal, default: 0 } 
           	}
     	}
@@ -40,9 +72,9 @@ Include module in your newly defined model
     	def compute_line_items_sum(order)
       		order.line_items.collect(&:total).inject(:+)
     	end
-  	end
+    end
   	
-  	class Order < ActiveRecord::Base
+	class Order < ActiveRecord::Base
 		def total_in_usd
 			# calculation
 		end
@@ -58,8 +90,8 @@ Update definition and generate new migration file
     $ rails generate flatten_record:migration denormalized_order
     Warning. Table already exists: denormalized_orders
 	Generating migration based on the difference..
-	Add columns: d_line_items_description
-      create  db/migrate/20140313034736_add_d_line_items_description_to_denormalized_orders.rb      
+	Add columns: line_items_description
+      create  db/migrate/20140313034736_add_line_items_description_to_denormalized_orders.rb      
 
 ### Use denormalizer methods
 Create record
@@ -74,7 +106,7 @@ Update record(s)
 
 	irb(main)> DenormalizedOrder.update_with(order)
 
-## Design & Documentation  
+## API Documentation/Development/Discussion  
 
 Refer to the [wiki](https://github.com/alvinsj/flatten_record/wiki).
     

data/lib/flatten_record/meta/compute_column.rb

@@ -10,16 +10,9 @@ module FlattenRecord
       end
 
       def denormalize(instance, to_record)
-        first_record = to_record.respond_to?(:each) ? to_record.flatten.first : to_record
-
-        begin
-          to_record = assign_value(to_record, name) do |record|
-            record.send("compute_#{@column.name}".to_sym, instance)
-          end
-        rescue
-          raise "compute_#{@column.name} is not found in #{to_record.inspect}"
+        assign_value(to_record, name) do |record|
+          record.send("compute_#{@column.name}".to_sym, instance)
         end
-        to_record
       end 
     end
   end

data/lib/flatten_record/version.rb

@@ -1,3 +1,3 @@
 module FlattenRecord
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end