simple_hot_folder 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5d628ab6d1c8b9f73a849e877a72e0524bf5560
-  data.tar.gz: 461a54314b24ab407e58fc931e506fb92a24ae55
+  metadata.gz: 46b8b20c55ab4f59864c93b7ade95d016678eeac
+  data.tar.gz: f2c6594371633b0e6513abd7dfa82d3f84dc597c
 SHA512:
-  metadata.gz: d8390e89d2d03a0fea0b116d8baf8922c50292263b68669c1d6c96dc14cb9e36b38f243296a154ae395ce756ce7be2796e498add73b825fbca1a4221fb10f9f8
-  data.tar.gz: 5d844e412483647632b54aa63bc3ea460dfe89d6cbb0513edb17eca499885e3bc1e30520c71cbd3ed32328138e86f37a16daa62af61bba4b7c57eb4cb3cbc2b3
+  metadata.gz: 3d8b895591e3d4285e6668438ffd606be35461c7533a7ba6f4ac9964e7cd062d36e4e82f38ff27ccc3912bee56953aa43f574b767c51bdc38a5061013db213e1
+  data.tar.gz: 05ece09a5a6626919fb966b55b2a6b4c8e9ee072811f75ac8f2e6247cd855650da11aa098942bbd144922384f44ade499d205477b238ec91f6838749194bf408

data/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: "ruby:2.4"
+
+# Pick zero or more services to be used on all builds.
+# Only needed when using a docker container to run your tests in.
+# Check out: http://docs.gitlab.com/ce/ci/docker/using_docker_images.html#what-is-a-service
+# services:
+#   - mysql:latest
+#   - redis:latest
+#   - postgres:latest
+
+# variables:
+#   POSTGRES_DB: database_name
+
+# Cache gems in between builds
+# cache:
+#   paths:
+#     - vendor/ruby
+
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+  - ruby -v                                   # Print out ruby version for debugging
+  # Uncomment next line if your rails app needs a JS runtime:
+  # - apt-get update -q && apt-get install nodejs -yqq
+  - gem install bundler  --no-ri --no-rdoc    # Bundler is not installed with the image
+  # - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+  - bundle install --path vendor
+
+unit_tests:
+  script:
+  - rake test

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
+  - 2.1
+  - 2.0
+branches:
+  only: master

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [0.1.4] - 2018-07-13
+
+* Delete current item from input folder after it has been processed. 
+
+## [0.1.3] - 2018-07-12
+
+* Travis configuration.
 * Gem description.
 
 ## [0.1.0] - 2018-07-10

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gtemplate.gemspec
 gemspec
 
-group :test do
+group :test, :development do
   gem 'minitest-reporters'
 end

data/README.md

@@ -1,8 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/simple_hot_folder.svg)](https://badge.fury.io/rb/simple_hot_folder)
+[![Build Status](https://travis-ci.org/galfus/simple-hot-folder.svg?branch=master)](https://travis-ci.org/galfus/simple-hot-folder)
+
 # Simple Hot Folder
 
 ### NOTE
 
-This gem is at an early stage of development. Please do not use it already.}
+This gem is at an early stage of development. Please do not use it already.
 
 
 ## Install
@@ -23,16 +26,16 @@ hot_folder = SimpleHotFolder.for_files(
 )
 
 # Successful
-hot_folder.process_input! do |entry|
-  puts "Processing file #{entry.name}..."
-  puts "File path: #{entry.path}"
-  puts "Now, the file is automatically moved to the output folder"
+hot_folder.process_input! do |item|
+  puts "Processing file #{item.name}..."
+  puts "File path: #{item.path}"
+  puts "Now, the file is automatically deleted"
 end
 
 # On error
-hot_folder.process_input! do |entry|
-  puts "Processing file #{entry.name}..."
-  puts "File path: #{entry.path}"
+hot_folder.process_input! do |item|
+  puts "Processing file #{item.name}..."
+  puts "File path: #{item.path}"
   puts "The file will be automatically moved to the error folder"
   puts "A text file will be created with the error message ('Trigger error')"
   puts "The process will continue with the next file"

data/Rakefile

@@ -87,12 +87,24 @@ task :release => :build do
   if ask_for_confirmation != 'Y'
     show_error_and_exit! "Aborting release"
   end
+  puts ""
   sh "git commit --allow-empty -m 'Release #{version}'"
   sh "git tag v#{version}"
   sh "git push origin master"
+  sh "git push github master"
   show_release
 end
 
+desc "Push code to the remote respositories"
+task :push do
+  show_text ">> Pushing code to GitLab y GitHub"
+  puts ""
+  sh "git push origin master"
+  puts ""
+  sh "git push github master"
+  puts ""
+end
+
 desc "Build #{gem_file} into pkg folder"
 task :build do
   show_text ">> Creating #{gem_file}"
@@ -105,6 +117,7 @@ end
 desc "Publish #{gem_file} in RubyGems"
 task :publish do
   show_text ">> Publishing  #{gem_file}"
+  puts ""
   sh "gem push pkg/#{gem_file}"
   puts ""
 end

data/lib/simple_hot_folder/hot_folder.rb

@@ -6,6 +6,12 @@ module SimpleHotFolder
       '..',
     ]
 
+    # Create hot folder that listens for files.
+    #
+    # @param [String] input_path Input folder path
+    # @param [String] error_path Error folder path
+    # @param [String] output_path Error folder path
+    # @return [HotFolder]
     def initialize(input_path, error_path, output_path)
       @input_path = input_path
       @error_path = error_path
@@ -13,46 +19,51 @@ module SimpleHotFolder
       @validate_file = default_validate_file_function
     end
 
+    # Yield a {Item} for each file/folder in the input path.
+    # Each file/folder is automatically deleted after the yield
+    # block is executed.
+    #
+    # @yieldparam [Item] item The file/folder.
     def process_input!
       entries = read_input(@input_path)
-      entries.each do |entry|
+      entries.each do |item|
         begin
-          yield entry
-          FileUtils.mv(entry.path, @output_path) if File.exist?(entry.path)
+          yield item
+          FileUtils.rm(item.path) if File.exist?(item.path)
         rescue Exception => e
-          move_file_to_error!(entry, e)
+          move_file_to_error!(item, e)
         end
       end
     end
 
     private
 
-    def move_file_to_error!(entry, exception)
-      FileUtils.mv(entry.path, @error_path) if File.exist?(entry.path)
-      write_error_file(entry, exception.message)
+    def move_file_to_error!(item, exception)
+      FileUtils.mv(item.path, @error_path) if File.exist?(item.path)
+      write_error_file(item, exception.message)
     end
 
-    def write_error_file(entry, text)
-      path = "#{@error_path}/#{entry.name}.txt"
+    def write_error_file(item, text)
+      path = "#{@error_path}/#{item.name}.txt"
       File.open(path, 'w') { |file| file.write(text) }
     end
 
     def read_input(path)
       Dir.entries(path)
-        .map { |name| Entry.new(name, "#{path}/#{name}") }
-        .keep_if { |entry| processable?(entry) }
-        # .each { |entry| p entry.path }
-        # .keep_if { |entry| @validate_file.(entry) }
+        .map { |name| Item.new(name, "#{path}/#{name}") }
+        .keep_if { |item| processable?(item) }
+        # .each { |item| p item.path }
+        # .keep_if { |item| @validate_file.(item) }
     end
 
-    def validate_entry(entry)
-      entry
+    def validate_item(item)
+      item
     end
 
-    def processable?(entry)
-      return false if !File.file?(entry.path)
-      return false if IGNORE_FOLDERS.include?(entry.name)
-      return false if entry.name.start_with?('.')
+    def processable?(item)
+      return false if !File.file?(item.path)
+      return false if IGNORE_FOLDERS.include?(item.name)
+      return false if item.name.start_with?('.')
       true
     end
 
@@ -64,7 +75,11 @@ module SimpleHotFolder
    
   end
 
-  class HotFolder::Entry
+  # Each file or folder from the input folder.
+  #
+  # @param [String] name Name of the file/folder.
+  # @param [String] path Path of the file/folder.
+  class HotFolder::Item
     attr_reader :name
     attr_reader :path
     def initialize(name, path)

data/lib/simple_hot_folder/version.rb

@@ -1,4 +1,4 @@
 module SimpleHotFolder
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.4'.freeze
   NAME = 'simple_hot_folder'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_hot_folder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Manu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md