smuggle 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b542958f709628b6a1d1fce332e11074c8e00a4c
-  data.tar.gz: 8df40c91ed11cd51f8e5b526a31f630cff4a7d9f
+SHA256:
+  metadata.gz: fa3dadc3be4934ed2b6829c8b96a80a7a10da5cc4466d251e9306007f555c52a
+  data.tar.gz: 5768506f6b6bfa05bad2f2e51c357f210545a2e0d7da4748a71b976f5702d027
 SHA512:
-  metadata.gz: 187563335fa1100e557bdbbddc7c155f82f755746f546e435d49ac55053ae5e60ce1d8b97cd8e6112eefad5daed8ea6fa584f4791b76e99706a5d7625d310c9e
-  data.tar.gz: 11ffc896106586065d7673f3f31dc6c9c4b4c5f60735104d507cc8f70b433d2c3806af62592f4446143ee574e5e8da7f6e6f17df9bb1c4d1f74d6ed17bc6919a
+  metadata.gz: f63495bd7e4cd81c3df888123990444c310c932886ce087b76817d29ed0964ffdb2842e2edf413f9e7a0b70f19a383a61faba689278273209c7950f86393def4
+  data.tar.gz: '08959772994e511e90bf5fb6996b3ceab6880e27cc1d9f025e88f8b9084c1c0150e3fd452786ee93bfae3080824e55fc343f9959aadecb9f7baf8a56b9cf157f'

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+
+## 0.3.0 - 2018-08-29
+
+### Added
+
+- Changelog
+- Attribute labels

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Pablo Crivella
+Copyright (c) 2018 Inspire Innovation BV (Utrecht, The Netherlands).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -99,9 +99,33 @@ Or if you are using active record, the exporter class will be automatically reso
 Smuggle::Services::Export.call(scope: User.all)
 ```
 
+## Attribute labels
+
+To add labels for your attributes (to show in the header instead of the raw attribute keys) you can add **attribute_labels** to your exporter:
+
+``` ruby
+class User
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+class UserExporter < ApplicationExporter
+  attributes :name
+  attribute_labels name: 'Full name'
+end
+
+users = [User.new('Rick Sanchez'), User.new('Morty Smith')]
+
+Smuggle::Services::Export.call(scope: users, exporter: UserExporter)
+# => "Full name\n" + "Rick Sanchez\n" + "Morty Smith\n"
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pablocrivella/smuggle.
+Bug reports and pull requests are welcome on GitHub at https://github.com/InspireNL/smuggle.
 
 ## Todo
 

data/lib/smuggle/exporter/base.rb

@@ -3,9 +3,11 @@ module Smuggle
     class Base < SimpleDelegator
       class << self
         attr_accessor :attributes
+        attr_accessor :attribute_labels
 
         def inherited(base)
           base.attributes = []
+          base.attribute_labels = {}
         end
 
         def attributes(*names)
@@ -15,6 +17,21 @@ module Smuggle
         def attributes?
           @attributes.any?
         end
+
+        def attribute_labels(labels)
+          @attribute_labels.merge!(labels)
+        end
+
+        def attribute_labels?
+          @attribute_labels.any?
+        end
+
+        def header
+          return @attributes unless attribute_labels?
+          return @attributes.map do |attribute|
+            @attribute_labels.fetch(attribute, attribute)
+          end
+        end
       end
 
       def to_csv

data/lib/smuggle/services/export.rb

@@ -34,7 +34,7 @@ module Smuggle
 
       def generate_csv
         CSV.generate do |csv|
-          csv << exporter.attributes
+          csv << exporter.header
 
           scope.each do |record|
             csv << exporter.new(record).to_csv

data/lib/smuggle/version.rb

@@ -1,3 +1,3 @@
 module Smuggle
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smuggle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pablo Crivella
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,9 +120,10 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: It Exports stuff to CSV