rails_importer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2efa0069a20c4c032a168de757a72f39a75c85e3
-  data.tar.gz: af122e4cd9a794292f9218c214d2ae2f7433d1de
+  metadata.gz: 960482940d9658460f988cc0ebb40b48ae004205
+  data.tar.gz: 6633a7b469898d1450be8189729a3763ae4db22d
 SHA512:
-  metadata.gz: 54cfa3a1e61009617e04270ac55671263bd020b6e4eb6cd67018ecdf1f714ef81bda6f8e06ffe7210ab4750f829b5ee3a5a46c65f7d98d51d038e7b406211b0a
-  data.tar.gz: babd7b55764ed5f371affd5985dac0a5f48fd57191221951788574652fb6b103e74ec1e0746fbf98556d1f850f7a63f82599cb99bffb745a012322bba5cb4884
+  metadata.gz: 7c0591bd134f1e8dbde0179f701ea07ebbbce4ef6978f292d789509e05ac6a0bcc09de3e14f2f7585ae5ba441702ba1984e69edb20ae486e205498e65f0797a0
+  data.tar.gz: 3e5c4469e487e6c5384f948d1583a8ac86f9154a33393655021957a20745f5f0eae0da799043b0bb359a20302fe460e6291392044e724f91765bbbcdfcea73f9

data/CHANGELOG.md

@@ -16,6 +16,10 @@
 
 ## Changes
 
+### 0.2.0 (February 18, 2016)
+
+* [FEATURE] Add sample file link to import form which downloads a pre-defined sample file for each importer
+
 ### 0.1.0 (February 12, 2016)
 
 * [FEATURE] First release

data/README.md

@@ -112,6 +112,15 @@ end
 ```
 The `context` variable used above contains the app routes, so don't forget to use it.
 
+## Sample files
+You can add a sample file for each importer if you wish to communicate the spreadsheet structure your importer follows.
+
+The sample file must be located inside the `lib/rails_importer/templates/` folder and have the same name as your importer key. For the `ExampleImporter` used above, the path would be: `lib/rails_importer/templates/example.xslx`
+
+The import form has a link to the sample file. If you do not declare the file, then this link will redirect to `after_import_path`.
+
+Note: `.xlsx` sample files are the only ones currently supported (for now).
+
 ## Import Job
 When processing an import file, an ActiveJob instance is used. If you're deploying to production, you will want to use some active job adapter, such as [Sidekiq](https://github.com/mperham/sidekiq).
 

data/app/controllers/rails_importer/imports_controller.rb

@@ -17,11 +17,14 @@ module RailsImporter
       end
     end
 
-    # def template
-    #   file = File.open(@importer_class.sample_file)
+    def sample
+      file = File.open(@importer_class.sample_file)
 
-    #   send_data file.read, :filename => File.basename(@importer.sample_file)
-    # end
+      send_data file.read, :filename => File.basename(@importer_class.sample_file)
+    rescue => e
+      flash[:alert] = I18n.t(:sample_file_not_available, scope: :rails_importer)
+      redirect_to after_import_path
+    end
 
     private
 

data/app/views/rails_importer/imports/new.html.erb

@@ -4,5 +4,8 @@
   <%= f.label :import_file %>
   <%= f.file_field :import_file %>
 
+  <div class="sample-file">
+    <%= link_to I18n.t(:sample_file, scope: :rails_importer), sample_imports_path %>
+  </div>
   <%= f.submit %>
 <% end %>

data/config/locales/rails_importer.en.yml

@@ -2,3 +2,5 @@ en:
   rails_importer:
     importer_does_not_exist: Importer does not exist
     processing_import: Importing has begun. Results will be available soon.
+    sample_file: Sample file
+    sample_file_not_available: Sample file not available

data/config/locales/rails_importer.es.yml

@@ -2,3 +2,5 @@ es:
   rails_importer:
     importer_does_not_exist: El importador especificado no existe
     processing_import: La importación ha comenzado. En unos instances el resultado estará disponible.
+    sample_file: Archivo de ejemplo
+    sample_file_not_available: Archivo de ejemplo no disponible

data/config/routes.rb

@@ -1,5 +1,9 @@
 RailsImporter::Engine.routes.draw do
   scope "importers/:importer_key" do
-    resources :imports, only: [:new, :create], path: ''
+    resources :imports, only: [:new, :create], path: '' do
+      collection do
+        get :sample
+      end
+    end
   end
 end

data/lib/rails_importer/base.rb

@@ -56,9 +56,14 @@ module RailsImporter
       raise "#{__FILE__}:#{__LINE__} You must define it"
     end
 
+    # The importer sample file
+    def self.sample_file
+      Rails.root.join("lib/rails_importer/templates/#{key}.xlsx")
+    end
+
     private
 
-    # Returns a Roo instance acording the file extension.
+    # Returns a Roo::Spreadsheet instance according the file extension.
     def open_spreadsheet sheet_name = ''
       extension = File.extname(@filepath.split("/").last)
       @spreadsheet = Roo::Spreadsheet.open(@filepath, extension: extension)

data/lib/rails_importer/version.rb

@@ -1,3 +1,3 @@
 module RailsImporter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastián Vicencio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails