fife 0.0.1.alpha → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c985295f282009483540caf7df104753ccbc59
-  data.tar.gz: aa20d1317ca9286b8eb0937cb4d3b56df0eee3cd
+  metadata.gz: 7ba441e8b0b9a3491cb9878ab9d6791e1b9789f3
+  data.tar.gz: 30d4bbb2a0dd03dd70a845f8d3f952a432979a14
 SHA512:
-  metadata.gz: 09931e0e7810f6ecb565887186f6336adeb4b16c11161ddbf68622e8fe3618d8d826b6fda0b59ebc9a28291907e13cb348f265bd1e6129aab900ddaad1037ae4
-  data.tar.gz: 65b51126ee185b42ce488d678837fcd6ec5f8309dac05ee02e74562668f9f17a0170b50488bafcfd424e5898b415cfd5f3bc89f018954fde2426f3352895f344
+  metadata.gz: c88d307cd22d1ee490a579d947e833ef246cc17abb2fe33f7ac9dc8c509da15b11101f1260262e085e715d6ca6ff39daef642f4a3b626936d49333b9faa6dab7
+  data.tar.gz: 767cbfd8fc3cc569df285c339c772562f9d3dc072fbb833579cac47b223b39e74ed42cd5637111e6923087e6b00afff7da88ec8be5627f92f474ea8f5c22d39a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fife (0.0.1.alpha)
+    fife (0.1.0)
       activesupport (~> 4.2)
       net-sftp (~> 2.1)
 

data/README.md

@@ -69,7 +69,7 @@ Currently, `Fife` ships with 4 operations: `:noop`, `:name`, `:store` and `:clos
 * noop
 Performs no operation on the IO, and returns the IO directly.
 * close
-Closes the
+Closes the IO if not already closed.
 * store
 Stores the content of the IO.
 * name
@@ -89,7 +89,7 @@ If you feel lambdas are not enough for your job,
 you can easily define your own operations.
 
 ```ruby
-class Fife::Operations::MyOperation
+class MyOperation
   def initialize(arg1, arg2)
     # Initialize the Operation
   end
@@ -98,10 +98,15 @@ class Fife::Operations::MyOperation
     # Handle the io and return some IO instances
   end
 end
+
+# Register it
+Fife::Operations.register(:my_op, MyOperation)
 ```
+
 Then you can use it like
+
 ```ruby
-Fife(io_ary).pipe(:my_operation, 1, 2)
+Fife(io_ary).pipe(:my_op, 1, 2)
 ```
 
 ### Storage
@@ -120,10 +125,28 @@ the remote filename depends on the name of the IO.
 (I know it's nasty, but it's still under developing)
 
 ```ruby
-storage = Fife::Storage::Sftp.new('localhost', 'me', '/path/to/remote/dir', password: 'P@ssw0rd')
+storage = Fife::Storage::Sftp.new do
+  host 'localhost'
+  user 'me'
+  remote_dir '/path/to/my/remote/dir'
+  naming -> io {"lorem_ipsum_#{rand}"}
+  ssh_options password: 's3cret'
+end
 Fife(io_ary).pipe(:store, storage)
 ```
 
+### Abort on fail
+By default, **Fife** ignores all failures and keeps on executing further operations on succeeded operations.  
+This behavior can be changed by passing `abort_on_fail: true` to `Kernel#Fife`:
+
+```ruby
+Fife(io_ary, abort_on_fail: true)
+```
+
+When `abort_on_fail` is turned on, if some operation raises error, no further operation will be executed,
+and an `Fife::Pipe::Aborted` will be raised.
+You can get the real causes by accessing `Fife::Pipe::Aborted#causes`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fife/operations/close.rb

@@ -1,5 +1,6 @@
 class Fife::Operations::Close
   def call(io)
     io.close unless io.closed?
+    io
   end
 end

data/lib/fife/operations.rb

@@ -5,4 +5,14 @@ module Fife::Operations
   autoload :Close
   autoload :Name
   autoload :Store
+
+  @registered = ActiveSupport::HashWithIndifferentAccess.new
+
+  def self.register(name, operation_class)
+    @registered[name] = operation_class
+  end
+
+  def self.[](name)
+    @registered[name] ||= const_get(name.to_s.camelize)
+  end
 end

data/lib/fife/pipe.rb

@@ -1,22 +1,45 @@
 class Fife::Pipe
 
-  attr_reader :ios
+  class Aborted < RuntimeError
+    attr_reader :causes
 
-  def initialize(ios)
-    @ios = ios.flatten.tap(&:compact!)
+    def initialize(causes=[])
+      @causes = causes
+    end
+  end
+
+  attr_reader :ios, :abort_on_fail
+
+  def initialize(ios, abort_on_fail)
+    @ios = ios
+    @abort_on_fail = abort_on_fail
   end
 
   def pipe(op, *args)
-    op = Fife::Operations.const_get(op.to_s.camelize.to_sym).new(*args) unless op.respond_to? :call
+    op = Fife::Operations[op].new(*args) unless op.respond_to? :call
     output = []
 
     ios.map { |io|
       Thread.new do
-        output << op.call(io.tap(&:rewind))
+        output << catch(:halt) do
+          begin
+            op.call(io.tap(&:rewind))
+          rescue => e
+            throw :halt, e
+          end
+        end
       end
     }.each(&:join)
 
-    self.class.new(output)
+    errors, output = output.tap(&:flatten!).partition{|o| o.is_a?(StandardError)}
+
+    should_abort = abort_on_fail && (errors.any? || output.any?(&:nil?))
+    if should_abort
+      ios.each { |io| io.close unless io.closed? }
+      raise Aborted, errors
+    end
+
+    self.class.new(output.tap(&:compact!), abort_on_fail)
   end
 
 end

data/lib/fife/storage/sftp.rb

@@ -2,20 +2,47 @@ require 'net/sftp'
 require 'pathname'
 require 'fileutils'
 
+class Net::SFTP::Session
+  def mkdir_p!(pathname)
+    pathname = Pathname(pathname) unless pathname.is_a? Pathname
+    pathname.descend do |path|
+      mkdir!(path) rescue nil
+    end
+  end
+end
+
 class Fife::Storage::Sftp
-  attr_reader :host, :user, :remote_dir, :ssh_options
 
-  def initialize(host, user, remote_dir, ssh_options)
-    @host, @user, @ssh_options = host, user, ssh_options
-    @remote_dir = Pathname(remote_dir)
-    ensure_remote_dir_presence!
+  class UninitializedAttributes < RuntimeError; end
+
+  REQUIRED_ATTRIBUTES = [:host, :user, :naming, :ssh_options, :remote_dir]
+
+  def remote_dir(*value)
+    return @remote_dir if value.empty?
+    @remote_dir = Pathname(value[0])
+  end
+
+  (REQUIRED_ATTRIBUTES - [:remote_dir]).each do |attr|
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{attr}(*value)
+        return @#{attr} if value.empty?
+        @#{attr} = value[0]
+      end
+    RUBY
+  end
+
+  def initialize(&block)
+    instance_eval &block
+    uninitialized_attributes = REQUIRED_ATTRIBUTES.select{|attr| send(attr).nil?}
+    raise UninitializedAttributes, uninitialized_attributes unless uninitialized_attributes.empty?
   end
 
   def store(io)
-    raise UnnamedIO unless io.respond_to? :name
-    remote_path = remote_dir.join(io.name)
+    remote_path = remote_dir.join(@naming.call(io))
+    dir = remote_path.dirname
     Net::SFTP.start(host, user, ssh_options) do |sftp|
-      sftp.file.open(remote_path, 'w') { |f| IO.copy_stream(io, f) }
+      sftp.mkdir_p!(dir)
+      sftp.file.open(remote_path, 'w') { |f| IO.copy_stream(io.tap(&:rewind), f) }
     end
     io.close
   end

data/lib/fife/version.rb

@@ -1,3 +1,3 @@
 module Fife
-  VERSION = "0.0.1.alpha"
+  VERSION = '0.1.1'
 end

data/lib/fife.rb

@@ -11,7 +11,7 @@ module Fife
 end
 
 module Kernel
-  def Fife(*ios)
-    Fife::Pipe.new(ios)
+  def Fife(*ios, abort_on_fail: false)
+    Fife::Pipe.new(ios.tap(&:flatten!).tap(&:compact!), abort_on_fail)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fife
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.1.1
 platform: ruby
 authors:
 - aetherus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,9 +124,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8