smuggle 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c28e234e739e3124cd325d75adcbdfbce6af88b4b48ad55ece82ca5d0db14e
-  data.tar.gz: 2e5357b380f21f5249e233505c6d67f91b43db50b28bdbdcc04f771af95dd112
+  metadata.gz: 889fa2b22dfc67ab693e35df9ed5c6cbe59f24e5f4a0dc53f668852994dd64ce
+  data.tar.gz: 70473995af55dd6dcf294e70223944ab2c547c102c955dfd36e61eca326293ab
 SHA512:
-  metadata.gz: 8a6b749134917f0b16b745e5678b6332f6f2f24895fd5171c34762c7b8dad848d439fa713b495d860eda326e16a40de31c236d0d252fbfe5af7928c02d43e9a1
-  data.tar.gz: a91cd6e70449ed729cab625faa84a79d199364abf538de800c4646077709619c93ba33b3aab9ec55d54a937f3e621bc29a595105b53b905b6af5cc094e4b53b6
+  metadata.gz: fcfb395b44dbb7fdbcaba150cd96bbbeda3dd6292404870c3a1b341f826ee1d2b3685781873df0a94d3688616df0199b275c5321aa3cd46b86223577ee2b04e4
+  data.tar.gz: aa20b7a0657d6280760dc1b5af27daa3818d24d5fb81a3eee7bce6cf9cb10212798170cc2ef70146dd62be8e30ff4aa52218f9c5d0b07bd88ef12979662cdc4f

data/README.md

@@ -51,7 +51,7 @@ class User
 end
 ```
 
-An exporter can be defined by inheriting from [Smuggle::Exporter::Base](lib/smuggle/exporter/base.rb) and define the attributes to export:
+An exporter can be defined by inheriting from [Smuggle::Exporter::Base](lib/smuggle/exporter/base.rb) and defining the attributes to export:
 
 ```ruby
 class UserExporter < Smuggle::Exporter::Base
@@ -104,31 +104,38 @@ Smuggle::Services::Export.call(scope: users, exporter: UserExporter)
 
 ### Importers
 
-Give the following ActiveRecord model:
+Given the following plain old ruby object:
 
 ```ruby
-class User < ApplicationRecord
-  validates :full_name, :username, presence: true
+class User
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
 end
 ```
 
-To define a importers you need to inherit from [Smuggle::Importer::Base](lib/smuggle/importer/base.rb) and define the attributes to import:
+An importer can be defined by inheriting from [Smuggle::Importer::Base](lib/smuggle/importer/base.rb) and defining the attributes to export:
 
 ```ruby
 class UserImporter < Smuggle::Importer::Base
-  # List all the attributes you need to import, everything else will be ignored
-  attributes :full_name, :username
+  # If no attributes are defined, the importer will infer them from the model's .attribute_names
+  # If any attributes are explicitly defined, all other entries in the CSV are ignored
+  attributes :name
 
   # Computed attributes from the row data
-  def full_name
+  def name
     [row[:first_name], row[:last_name]].join(" ")
   end
 
   def persist
-    # You can implement how to persist the data anyway you prefer
-    # This is an example using active record
-    model.create(to_h)
-    # model.new(to_h).save(validate: false) # Another example skipping validations
+    # Create your instance here
+    model.new(to_h)
+    # The result is collected by the Import service
+
+    # If you want to persist your data, you can do so here. This is an example using ActiveRecord
+    # model.create(to_h)
   end
 end
 ```
@@ -138,16 +145,16 @@ For example:
 Given the following `users.csv` file:
 
 ```
-"first_name","last_name","username"
-"Rick","Sanchez","rsanchez"
-"Morty","Smith","msmith"
-"Jerry","Smith","jsmith"
+"first_name","last_name"
+"Rick","Sanchez"
+"Morty","Smith"
 ```
 
 Just run:
 
 ```ruby
 Smuggle::Services::Import.call(model: User, filepath: "users.csv")
+# => [#<User name: "Rick Sanchez">, #<User name: "Morty Smith">]
 ```
 
 The importer class will be resolved from the model name, otherwise you could explicitely set the importer like this:

data/lib/smuggle/importer/base.rb

@@ -6,8 +6,8 @@ module Smuggle
       class << self
         attr_writer :attributes
 
-        def inherited(base)
-          base.attributes = []
+        def inherited(subclass)
+          subclass.attributes = []
         end
 
         def attributes(*names)
@@ -40,10 +40,14 @@ module Smuggle
         end
       end
 
+      private
+
       def defined_attributes
         return self.class.attributes if self.class.attributes?
 
-        model.attribute_names if model.respond_to?(:attribute_names)
+        return model.attribute_names if model.respond_to?(:attribute_names)
+
+        []
       end
     end
   end

data/lib/smuggle/services/export.rb

@@ -36,7 +36,10 @@ module Smuggle
         CSV.generate do |csv|
           csv << exporter.header
 
-          scope.each do |record|
+          method = :each
+          method = :find_each if scope.respond_to?(:find_each)
+
+          scope.public_send(method) do |record|
             csv << exporter.new(record).to_csv
           end
         end

data/lib/smuggle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Smuggle
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smuggle
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pablo Crivella
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -115,42 +115,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.1'
 description: 
 email:
 - pablocrivella@gmail.com
@@ -203,8 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: It exports and imports all kinds of stuff from and to CSV