axlsx_rad 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 834382ebf19e94d28b67e1b8fdf27036cef2c31e
-  data.tar.gz: 4deb68fde5206dd7292903386aa30e8d8c61689d
+  metadata.gz: 627f2ae10a0ddb5ea335613a53a674527aa6e6e0
+  data.tar.gz: 88a2da224cc8ca4878989e8668a3d19be02c3b0f
 SHA512:
-  metadata.gz: c8d48310cb59052aab604e80bc6b56efc499b9fea63eb16792e64f0c647adc10a4689543565cbc2c8465ad983c8839bc3f4cd8004a966cb04fde5079e1c6eacf
-  data.tar.gz: e328b22d9cc7f3431717d7a70cc33bf510a7caafbdf9ce469c23c8d742718c582f619ce68e7090cff9b6b8d997f7e53c5870fa30f8ebf412da9f5d8f31c1f97b
+  metadata.gz: 79e3021bf478184d7a1988af7ee04f1d10db7a975ddce9d1f981269f09de221a8b99ae0709683aed3a6ca8f7ce26a4c1e73057f05207735efe28c23e6863bdd6
+  data.tar.gz: 73299d0193a018e5a83180ef47203dc224c8c5204ee6067b9a8d7a4db91ac3ff34125d5a75738a701d0b69ead828d6d8f195128d38f30ad187b3005095b48964

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 CHANGELOG
 ---------
 
+- **2014-03-23**: 0.0.2
+  - Add ability to filter / remove duplicate documents
 - **2014-03-21**: 0.0.1
   - Initial release

data/README.md

@@ -59,22 +59,25 @@ Download and install axlsx_rad with the following:
       :head    => { :bg_color => '00FFFF', :b => true}
     }
 
-    # Subclass AxlsxRad::Config object. This object has attributes: oColumns
-    # and dStylesCfg. It doesn't matter how they are set but they should be
-    # set before instantiating a AxlsxRad::Worksheet object. Additionally,
-    # the #getStylesForHeader() and #getStylesForDocument( document ) methods
-    # should be overridden to return a style hash as shown below:
+    # Subclass AxlsxRad::Config object. This object has accepts the columns,
+    # styles and unique key initialization parameters, setting them to the
+    # aColumns, dStylesCfg and xxKeyUnique attributes. It doesn't matter how
+    # they are set but they should be set before instantiating a
+    # AxlsxRad::Worksheet object. Additionally, the #getStylesForHeader() and
+    # #getStylesForDocument( document ) methods should be overridden to return
+    # a style hash as shown below.
     #
-    # The contract contains: @aColumns, @dStylesCfg, #getStylesForHeader, and
-    # #getStylesForDocument( JsonDoc::Document ).
+    # The contract contains the #getStylesForHeader and
+    # #getStylesForDocument( JsonDoc::Document ) methods.
     #
     # The style names used in the reponse hash should correspond to the style
     # keys used in the styles configuration hash above.
 
     class MyWorksheetConfig < AxlsxRad::Config
-      def initialize(columns=[],styles={})
-        @aColumns   = columns
-        @dStylesCfg = styles
+      def initialize(columns=[],styles={},unique_key=nil)
+        @aColumns    = columns
+        @dStylesCfg  = styles
+        @xxKeyUnique = unique_key
       end
       def getStylesForHeader()
         return { :bgstyle => :head }
@@ -110,6 +113,9 @@ Download and install axlsx_rad with the following:
     end
 
     # Write XLSX spreadsheet
+    workbook.serialize('example_users.xlsx')
+
+    # Write XLSX spreadsheet by accessing the Axlsx::Package object
     workbook.oAxlsx.serialize('example_users.xlsx')
 
 #Documentation
@@ -120,10 +126,19 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
     $ gem install yard
     $ yard server -g
 
+Notes
+-----
+
+1. Removing duplicate documents
+ - If the unique_key parameter is set in the AxlsxRad::Config object, that key will be checked to retain or discard added documents which can streamline the adding process. Not setting this value or setting this value to nil will disable checking and add all documents. 
+
 #Change Log
 -----------
 
-- **2014-03-20**: 0.0.1
+- **2014-03-23**: 0.0.2
+  - Add ability to filter duplicate documents
+  - Add AxlsxRad::Workbook::serialize shortcut
+- **2014-03-21**: 0.0.1
   - Initial release
 
 #Links

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/axlsx_rad/config.rb

@@ -2,9 +2,11 @@ module AxlsxRad
   class Config
     attr_accessor :aColumns
     attr_accessor :dStylesCfg
-    def initialize(aColumns=[],dStylesCfg={})
-      @aColumns   = aColumns
-      @dStylesCfg = dStylesCfg
+    attr_accessor :xxKeyUnique
+    def initialize(aColumns=[],dStylesCfg={},xxKeyUnique=nil)
+      @aColumns    = aColumns
+      @dStylesCfg  = dStylesCfg
+      @xxKeyUnique = nil
     end
     # Override this method with rules to return style key
     def getStylesForHeader()

data/lib/axlsx_rad/workbook.rb

@@ -27,6 +27,10 @@ module AxlsxRad
       @dWorksheets[ sWorksheetName ].addDocument( oJsondoc )
     end
 
+    def serialize(sPath=nil)
+      @oAxlsx.serialize(sPath)
+    end
+
   end
 end
 
@@ -44,6 +48,7 @@ module AxlsxRad
       @oWsConfig       = oWsConfig
       self.loadWsConfig( oWsConfig )
       @bHasHead        = false
+      @dKeysUnique     = {}
     end
 
     def loadWsConfig(oWsConfig=nil)
@@ -64,10 +69,18 @@ module AxlsxRad
         end
         @bHasHead = true
       end
+      unless @oWsConfig.xxKeyUnique.nil?
+        xxKeyUniqueValue = oJsondoc.getProp( @oWsConfig.xxKeyUnique )
+        if @dKeysUnique.has_key?( xxKeyUniqueValue )
+          return
+        else
+          @dKeysUnique[ xxKeyUniqueValue ] = 1
+        end
+      end
       aValues = oJsondoc.getValArrayForProperties( @aColumns )
       aStyles = getStylesForDocument( oJsondoc )
       if aStyles.is_a?(Fixnum) || aStyles.is_a?(Array)
-        @oAxlsxWorksheet.add_row aValues, :style => aStyles         
+        @oAxlsxWorksheet.add_row aValues, :style => aStyles
       else
         @oAxlsxWorksheet.add_row aValues
       end
@@ -121,6 +134,11 @@ module AxlsxRad
     end
 
     def getStylesArrayForHash(dStyles={})
+      if dStyles.is_a?(Hash) && dStyles.keys.length == 0
+        return nil
+      elsif ! dStyles.is_a?(Hash)
+        return nil
+      end
       yStyleBg = dStyles.has_key?(:bgstyle) ? dStyles[:bgstyle] : nil
       yStyleBg = yStyleBg.to_sym if yStyleBg.is_a?(String)
       aStyles  = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axlsx_rad
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx