shipping_materials 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dec67506b0acc185f46cbfd415f5b26c032b1b0
-  data.tar.gz: 28c181e09c09451fa77ec82f9f6cd8e75e5b733b
+  metadata.gz: dd786b238dd207df0bd5c80582afab3496b2f410
+  data.tar.gz: a70915402894014d982e03e36311f296e4a36f74
 SHA512:
-  metadata.gz: e21ecd0979f492d4dec669d1ece80931035b451687b0e6cef458c9404b15d737a1287e9617e319771a8f5d2c4f9ca9c217492aa589b69012f5b2b8329f8fa398
-  data.tar.gz: 1799f53d73c0ede957138f1c7fb4c6386a8e13b13548dc8e6600dd2bcd6a6db5c577ed38ed1a8793cffd1c2f804e5b56d66d2c0905765fe08b530367fd1b40a7
+  metadata.gz: a215b7f887748fe776e89e3ae3f9d39c0bcbd4f00b3c52eb95574d009a3c302ae10b3ab841b2e76450b0153684212b35f31d85aad2979d65fe5b94cfc3436142
+  data.tar.gz: 6d557cba658f4f8c32256072649a4f48e37a5596f7a29bbf1feded9e9a631635f6e27dabb76bf39b2c28690f02285e65b37c6079ad4005e99c52ad35526c360d

data/README.md

@@ -11,7 +11,7 @@ includes packing slips and CSVs for label makers.
 ## Dependencies
 
 `wkhtmltopdf` if used for PDF generation.  The call to it is made as a linux
-command therefore this plugin will not work on Windows yet.
+command therefore this functionality will not work on Windows.
     
 `gzip` is used for the zip functionality.
 
@@ -40,7 +40,7 @@ If you would like to use S3, add the following:
 
 ### The Packager
 
-The DSL is provided via the ShippingMaterials::Packager class.
+The DSL is provided via the `ShippingMaterials::Packager` class.
 
 ```ruby
   packager = ShippingMaterials::Packager.new
@@ -59,7 +59,7 @@ type.
 
 Because we are creating shipping materials here, at the very least, it is
 assumed you are going to want packing slips.  You may specify a global template
-with the `#pdf` method:
+with the `#html` or `#pdf` methods:
 
 ```ruby
   packager.package orders do
@@ -111,7 +111,7 @@ context of the order array. A sample ERB template would look like this:
         <p><%= order.number %>
         <div>
         <% order.line_items.each do |li| %>
-          <p><%= line_item.desc %>: $<%= li.price %> x <%= li.qty %> = <%= li.total %></p>
+          <p><%= li.desc %>: $<%= li.price %> x <%= li.qty %> = <%= li.total %></p>
         <% end %>
         </div>
       <% end %>
@@ -135,11 +135,11 @@ Here is an example with hashes:
 ```ruby
   group 'Canadian Standard Post' do
     csv(headers: true) {
-      row 'Code' => 'Q',
+      row 'Code'         => 'Q',
           'Order Number' => :number,
-          'Name'     => [ :shipping_address, :name ]
+          'Name'         => [ :shipping_address, :name ]
            # ...
-          'Country'  => [ :shipping_address, :country, :iso ]
+          'Country'      => [ :shipping_address, :country, :iso ]
           
       row line_items: [ 'H', :id, :name, :quantity, :price ]
     }
@@ -159,6 +159,24 @@ As demonstrated in the second call to row, you can evalute your row in the
 context of your line items (or other one-to-many relationship) using its method
 name as a key.
 
+### CSV Callbacks
+
+Right now an `if` callback can be provided to the `row` method.  This is useful
+when calling row multiple times and you don't always want all of them to render.
+
+```ruby
+  group 'Canadian Standard Post' do
+    csv(headers: true) {
+      row 'Code'         => 'Q'
+           # ...
+
+      row({ line_items: [ 'H', :id, :name, :quantity, :price ] },
+          if: proc {|o| o.lines_items.size > 1 })
+    }
+  end
+```
+
+
 ### Sorting
 
 While most sorting should probably be done at the query level, Shipping

data/lib/shipping_materials.rb

@@ -1,5 +1,4 @@
 require 'tilt'
-require 'mustache'
 
 require 'shipping_materials/version'
 require 'shipping_materials/mixins/sortable'

data/lib/shipping_materials/config.rb

@@ -6,14 +6,6 @@ module ShippingMaterials
                     :s3_secret,
                     :gzip_file_name
 
-      def base_context
-        @base_context || :objects
-      end
-
-      def base_context=(bc)
-        @base_context = bc.to_sym
-      end
-
       def save_path=(save_path)
         @save_path = save_path.sub(/(\/)+$/, '')
       end

data/lib/shipping_materials/csv_dsl.rb

@@ -3,29 +3,31 @@ module ShippingMaterials
     require 'csv'
 
     attr_accessor :objects, :row_maps
+    attr_reader :headers
 
     def initialize(objects, options={})
-      @objects  = objects
-      @row_maps = {}
-      @options  = options
+      @objects   = objects
+      @row_maps  = {}
+      @options   = options
     end
 
     # This method is on the complex side. It is a DSL method that
     # performs type-checking and also sets the headers.
     # Be sure to see headers=() defined below
-    def row(collection)
+    def row(collection, callbacks={})
+      @callbacks = callbacks
       if collection.is_a? Array
-        @row_maps[:object] = collection
+        update_row_maps(:object, collection, callbacks)
       elsif collection.is_a? Hash
         f = collection.first
         if f[1].is_a? Array
-          @row_maps[f[0]] = f[1]
+          update_row_maps(f[0], f[1], callbacks)
         elsif f[1].is_a? Hash
-          self.headers = collection.first[1]
-          @row_maps[f[0]] = f[1].values
+          self.headers = f[1]
+          update_row_maps(f[0], f[1].values, callbacks)
         else
           self.headers = collection
-          @row_maps[:object] = collection.values
+          update_row_maps(:object, collection.values, callbacks)
         end
       end
     end
@@ -34,29 +36,25 @@ module ShippingMaterials
       CSV.generate do |csv|
         csv << headers if headers?
         @objects.each do |object|
-          @row_maps.each do |context, methods|
+          @row_maps.each do |context, stuff|
+            next unless apply_callbacks(stuff[:callbacks], object)
             if context == :object
-              csv << get_row(object, methods)
+              csv << get_row(object, stuff[:values])
             else
-              object.send(context).each do |c|
-                csv << get_row(c, methods)
+              object.send(context).each do |obj|
+                csv << get_row(obj, stuff[:values])
               end
             end
           end
         end
       end
     end
-
     alias_method :to_s, :to_csv
 
     def extension
       @options[:extension] || 'csv'
     end
 
-    def headers
-      @headers
-    end
-
     def headers=(object)
       @headers ||= object.keys.map {|h| h.to_s } if self.headers?
     end
@@ -66,19 +64,33 @@ module ShippingMaterials
     end
 
     private
+      def apply_callbacks(callbacks, object)
+        return true unless callbacks.any?
+        if callbacks[:if]
+          callbacks[:if].call(object)
+        else
+          true
+        end
+      end
 
-    def get_row(object, methods)
-      methods.map do |meth|
-        if meth.is_a? Symbol
-          object.send(meth)
-        elsif meth.is_a? Array
-          meth.reduce(object) {|obj, m| obj.send(m) }
-        elsif meth.is_a? Proc
-          object.instance_eval(&meth)
-        elsif meth.is_a? String
-          meth
+      def get_row(object, methods)
+        methods.map do |meth|
+          if meth.is_a? Symbol
+            object.send(meth)
+          elsif meth.is_a? Array
+            meth.reduce(object) {|o,m| o.send(m) }
+          elsif meth.is_a? Proc
+            object.instance_eval(&meth)
+          elsif meth.is_a? String
+            meth
+          end
         end
       end
-    end
+
+      def update_row_maps(key, values, callbacks)
+        @row_maps[key] ||= {}
+        @row_maps[key][:values] = values
+        @row_maps[key][:callbacks] = callbacks
+      end
   end
 end

data/lib/shipping_materials/packager.rb

@@ -17,11 +17,20 @@ module ShippingMaterials
         create_packing_slips(group)
         create_csvs(group)
       end
-      Storage.gzip if Config.use_gzip?
+      if Config.use_gzip?
+        Storage.write_gzip rescue nil
+      end
+      self
+    end
+
+    def html(template)
+      @packing_slip_template = template
+      @packing_slip_ext = :html
     end
 
     def pdf(template)
       @packing_slip_template = template
+      @packing_slip_ext = :pdf
     end
 
     def group(basename, &block)
@@ -31,22 +40,21 @@ module ShippingMaterials
     end
 
     private
+      def sort_group(group)
+        group.sorters ||= self.sorters
+        group.sort!
+      end
 
-    def sort_group(group)
-      return if self.sorters.empty?
-      group.sorters ||= self.sorters
-      group.sort!
-    end
-
-    def create_packing_slips(group)
-      packing_slip = PackingSlips.new(group.objects, @packing_slip_template)
-      Storage.write_pdf(group.basename, packing_slip.to_s)
-    end
+      def create_packing_slips(group)
+        packing_slip = PackingSlips.new(group.objects, @packing_slip_template)
+        filename = "#{group.basename}.#{@packing_slip_ext}"
+        Storage.send(:"write_#{@packing_slip_ext}", filename , packing_slip.to_s)
+      end
 
-    def create_csvs(group)
-      group.csvs.each do |csv|
-        filename = Storage.filenameize(group.basename) + '.' + csv.extension
-        Storage.write_file(filename, csv.to_s)
+      def create_csvs(group)
+        group.csvs.each do |csv|
+          filename = Storage.filenameize(group.basename) + '.' + csv.extension
+          Storage.write_file(filename, csv.to_s)
       end
     end
   end

data/lib/shipping_materials/packing_slips.rb

@@ -6,15 +6,8 @@ module ShippingMaterials
     end
 
     def to_s
-			if File.extname(@template_file) == '.mustache'
-				t = Mustache.new
-				t.template_file = @template_file
-				t[Config.base_context] = @objects
-				t.render
-			else
-				t = Tilt.new(@template_file)
-				t.render(@objects)
-			end
+      t = Tilt.new(@template_file)
+      t.render(@objects)
     end
 
     alias_method :to_html, :to_s

data/lib/shipping_materials/sorter.rb

@@ -2,7 +2,7 @@ module ShippingMaterials
   class Sorter
     def initialize
       @rules = []
-			@attr_callbacks = []
+      @attr_callbacks = []
     end
 
     def rule(&block)
@@ -28,22 +28,22 @@ module ShippingMaterials
         end
       end
 
-			apply_callbacks(a)
-			apply_callbacks(b)
+      apply_callbacks(a)
+      apply_callbacks(b)
 
       i += 1
       ( sort(a, i) + sort(b, i) ).compact
     end
 
 
-		private
+    private
 
-		def apply_callbacks(items)
-			@attr_callbacks.each do |attr|
-				items.sort! do |a,b|
-					b.send(attr) <=> a.send(attr)
-				end
-			end
-		end
+    def apply_callbacks(items)
+      @attr_callbacks.each do |attr|
+        items.sort! do |a,b|
+          b.send(attr) <=> a.send(attr)
+        end
+      end
+    end
   end
 end

data/lib/shipping_materials/storage.rb

@@ -12,6 +12,7 @@ module ShippingMaterials
           end
         end
       end
+      alias_method :write_html, :write_file
 
       def write_pdf(filename, contents)
         basename = filenameize(File.basename(filename, '.*'))
@@ -29,7 +30,7 @@ module ShippingMaterials
         end
       end
 
-      def gzip
+      def write_gzip
         filename = "#{Config.save_path}/#{Config.gzip_file_name}"
         `cd #{Config.save_path} && tar -cvzf #{filename} * && cd -`
         if Config.use_s3?

data/lib/shipping_materials/version.rb

@@ -1,3 +1,3 @@
 module ShippingMaterials
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/shipping_materials.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mustache'
   spec.add_dependency 'aws-sdk'
   spec.add_dependency 'tilt'
 

data/test/files/template.erb

@@ -0,0 +1,14 @@
+<html>
+  <body>
+    <% self.each do |order| %>
+    <div>
+      <h1><%= order.id %></h1>
+      <ul>
+      <% order.line_items.each do |li| %>
+        <li><%= li.name %> - <%= li.quantity %> x $<%= li.price %> = $<%= li.total %></li>
+      <% end %>
+      </ul>
+    </div>
+    <% end %>
+  </body>
+</html>

data/test/models.rb

@@ -10,6 +10,10 @@ module TestModels
 
   class LineItem
     attr_accessor :id, :name, :quantity, :price, :type, :variant
+
+    def total
+      quantity * price
+    end
   end
 
   class Variant

data/test/unit/csv_dsl_test.rb

@@ -8,21 +8,21 @@ module ShippingMaterials
 
       @csv.row(array)
 
-      assert_equal array, @csv.row_maps[:object],
+      assert_equal array, @csv.row_maps[:object][:values],
                   "Passing array to CSVDSL#row does not work"
     end
 
     def test_row_hash
       @csv = ShippingMaterials::CSVDSL.new(orders, headers: true)
       hash = { :order_id => :id,
-              :name     => :name,
-              :static_field => 'A string' }
+               :name     => :name,
+               :static_field => 'A string' }
 
       @csv.row(hash)
 
       assert_equal %w(order_id name static_field), @csv.headers,
                   "CSVDSL headers are not being set properly"
-      assert_equal hash.values, @csv.row_maps[:object],
+      assert_equal hash.values, @csv.row_maps[:object][:values],
                   "CSVDSL row map values not being properly set"
     end
 
@@ -32,7 +32,7 @@ module ShippingMaterials
 
       @csv.row(hash)
 
-      assert_equal hash[:line_items], @csv.row_maps[:line_items],
+      assert_equal hash[:line_items], @csv.row_maps[:line_items][:values],
                   "CSVDSL row map not being set properly when given " \
                   "hash with array"
     end
@@ -51,7 +51,7 @@ module ShippingMaterials
 
       assert_equal %w(order_id name static_field), @csv.headers,
                   "CSVDSL headers should be strings"
-      assert_equal hash[:line_items].values, @csv.row_maps[:line_items],
+      assert_equal hash[:line_items].values, @csv.row_maps[:line_items][:values],
                   "CSVDSL values should match line_item values"
     
     end
@@ -104,11 +104,21 @@ module ShippingMaterials
       assert_equal "1+Andrew\n", @csv.to_csv, "CSV with proc doesn't work"
     end
 
+    def test_callbacks
+      @csv = CSVDSL.new(orders.select {|o| o.id == 1 })
+      @csv.row :order_id      => :id,
+               :name          => :name,
+               :static_fields => 'A string'
+      @csv.row({ :line_items => [:id, :name, :quantity] }, :if => proc {|o| o.line_items.size < 1 })
+      
+      assert_equal "1,Andrew,A string\n", @csv.to_csv
+    end
+
     def test_to_csv
       @csv = CSVDSL.new(orders.select {|o| o.id == 1 }, headers: true)
       @csv.row :order_id       => :id,
-                :name          => :name,
-                :static_fields => 'A string'
+               :name          => :name,
+               :static_fields => 'A string'
 
       @csv.row :line_items => [:id, :name, :quantity]
 

data/test/unit/packager_test.rb

@@ -16,7 +16,7 @@ module ShippingMaterials
 
     def test_dsl
       @packager.package orders do
-        pdf './test/files/template.mustache'
+        html './test/files/template.erb'
 
         sort(:line_items) {
           rule { type == 'Vinyl' }

data/test/unit/packing_slips_test.rb

@@ -3,7 +3,6 @@ require 'test_helper'
 module ShippingMaterials
   class PackingSlipsTest < TestCase
     def test_basic_stuff
-      ps = ShippingMaterials::PackingSlips.new(orders, './test/files/template.mustache')
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shipping_materials
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Haust
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mustache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +108,7 @@ files:
 - lib/shipping_materials/version.rb
 - shipping_materials.gemspec
 - test/data.rb
-- test/files/template.mustache
+- test/files/template.erb
 - test/files/test.html
 - test/models.rb
 - test/suite.rb
@@ -155,13 +141,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Shipping Materials
 test_files:
 - test/data.rb
-- test/files/template.mustache
+- test/files/template.erb
 - test/files/test.html
 - test/models.rb
 - test/suite.rb

data/test/files/template.mustache

@@ -1,16 +0,0 @@
-<html>
-  <head>
-    <style>
-    </style>
-  </head>
-  <body>
-    {{# objects }}
-    <div>
-      {{ name }}, {{ country }}
-      {{# line_items }}
-        {{ name }}
-      {{/ line_items }}
-    </div>
-    {{/ objects }}
-  </body>
-</html>