clomp 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3b495be69cf45ef6f945664149599b3966e937
-  data.tar.gz: 42249a2784393668c08a4874d0d9b8eb26968bc4
+  metadata.gz: f83c752440544965f9794dc3c04b609660c862cd
+  data.tar.gz: 117d87a57db19570f5fa50e33c18ea795b987bd5
 SHA512:
-  metadata.gz: ecf15b609fa0cf5f0fcb081954ca0610d544525270b04cec6ebe43f1b8bc44062c0e4ae3ba0735dad4ba2a982ea159148e722de807ae61dc76e3b7bf077f4a4a
-  data.tar.gz: '084ec7df8cb9c8ab2c922a33a3d8648d4f6681d3f1ff1e5eebe9a8c193684545074cd5363c0ec4904864ba18d5e216dfdf803e7e5935c42fc8ca7a37ed98a4fd'
+  metadata.gz: 8ea106882c901f0af269df6141d204a11254002a6e121fa46e86649f022ffeefae39c0bc9685e46078ccd309d6ad6e3e8ae67b73f7bb46ca3e4f19fb970d4d6d
+  data.tar.gz: 2bdb4c799cb9693e8b47f823a480fb808563deb631e2caaaaa87def66397d38ef8668d66fb8d25703ec4f2b8ecdb0117303dd6c09517de9f777fd7f83e57ef4e

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    clomp (0.0.10)
+    clomp (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    byebug (9.1.0)
+    byebug (10.0.0)
     codeclimate-test-reporter (1.0.7)
       simplecov
     diff-lcs (1.3)
@@ -23,7 +23,7 @@ GEM
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
       rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
+    rspec-core (3.7.1)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -31,7 +31,7 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+    rspec-support (3.7.1)
     rubocop (0.52.1)
       parallel (~> 1.10)
       parser (>= 2.4.0.2, < 3.0)

data/README.md

@@ -25,6 +25,13 @@ Build any service with the track! Add as many tracks as you want.
 tracks will be loaded sequentially. You can control success and failure state of any 
 specific step.
 
+### Example application
+You may check the following rails project for basic understanding.
+[Clomp Usage Example](https://github.com/rubyrider/clomp-example)
+
+Clomp is completely framework independent agnostic framework. You can use it with any ruby frameworks
+and even with your raw ruby code.
+
 
 Consider the following class:
 ```ruby
@@ -37,13 +44,6 @@ class AnotherOperation < Clomp::Operation
 end
     
 class SingingOperation < Clomp::Operation
-    # Configure your operation for common tracks,
-    # configuration can be overridden from individual tracks 
-    setup do |config|
-      config.fail_fast = true
-      config.optional = true
-     end
-      
     # this block only executes on failure step! 
     # pass options to receive the operation states!   
     add_track :get_lyrics do |options|

data/lib/clomp.rb

@@ -1,5 +1,6 @@
 require 'clomp/version'
 require 'clomp/common_states'
+require 'clomp/option'
 require 'clomp/track_builder'
 require 'clomp/operation'
 require 'clomp/track'

data/lib/clomp/executor.rb

@@ -9,7 +9,7 @@ module Clomp
       def [](result = {}, options, _self:)
         result['tracks'].each_with_index do |track, i|
           
-          break if break?(result['tracks'], i)
+          break if break?(result['tracks'].select {|track|  track.executed? }, i)
           
           next if _self.successful? && track.left_track?
           next if _self.failed? && track.right_track?
@@ -23,17 +23,15 @@ module Clomp
         
         _self
       end
-
+      
       def break?(tracks, index)
-        track =  index > 0 && tracks[index -1] || Track.new(name: SecureRandom.hex(5)).tap {|track| track.mark_as_success! && track.executed = true }
-  
-        if track.right_track? && track.failure?
-          return true if track.track_options[:fail_fast]
-        elsif track.left_track?
-          return true if track.track_options[:fail_fast]
-        end
-  
-        true if track.track_options[:pass_fast]
+        track = index > 0 && tracks[index -1] || Track.new(name: SecureRandom.hex(5)).tap {|track| track.mark_as_success! && track.executed = true}
+        
+        return true if track.right_track? && track.failure? && track.track_options[:fail_fast]
+        
+        return true if track.left_track? && track.track_options[:fail_fast]
+        
+        !track.track_options[:pass_fast].nil?
       end
     end
   end

data/lib/clomp/operation.rb

@@ -1,6 +1,6 @@
 module Clomp
   class Operation
-    attr_reader :result, :configs, :output, :executed
+    attr_reader :result, :configs, :output, :executed, :options
     
     # Constructor for operation object
     #
@@ -8,14 +8,14 @@ module Clomp
     # @param options [Hash] of options to be provided by .[] call/method
     # @return [self]
     def initialize(track_builders: [], options: {}, exec: true)
-      @options          = {}
+      @options          = Clomp::Option[{params: {}}]
       @options[:params] = options[:params]
       @options.merge!(options[:immutable_data]) if options[:immutable_data]
       # Setup result object!
       @result = Result.new(
           operation: self,
           tracks:    track_builders || [],
-          options:   @options || {}
+          options:   @options || Option.new
       )
       
       @executed = []
@@ -23,10 +23,16 @@ module Clomp
       @output   = get_status
       
       exec_steps! if exec
+
+      prepare_options
+    end
+    
+    def prepare_options
+      executed_track_list.map {|track|  @options.merge!(track.options)}
     end
     
     def executed_tracks
-      executed_track_list.collect {|executed_track| [executed_track.name, executed_track.type, executed_track.state].join(":") }.join(" --> ")
+      executed_track_list.collect {|executed_track| [executed_track.name, executed_track.type, executed_track.state, executed_track.options.keys.join(' || ')] }.join(" --> ")
     end
     
     # Execute all the steps! Execute all the tracks!
@@ -131,13 +137,13 @@ module Clomp
       end
       
       def call(mutable_data = {}, immutable_data = {})
-        new(
+        result = new(
             track_builders: @track_builders,
             options:        {
                 params:         mutable_data || {},
                 immutable_data: immutable_data || {}
             },
-            ).result
+        ).result
       end
       
       alias_method :[], :call

data/lib/clomp/option.rb

@@ -0,0 +1,37 @@
+module Clomp
+  class Option < ::Hash
+    alias_method :_get, :[] # preserve the original #[] method
+    protected :_get # make it protected
+  
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+  
+    def [](key)
+      super(key.to_sym)
+    end
+  
+    def set(key, value)
+      self[key] = value
+    end
+  
+    def method_missing(name, *args)
+      name_string = name.to_s
+      if name_string.chomp!('=')
+        self[name_string] = args.first
+      else
+        bangs = name_string.chomp!('!')
+      
+        if bangs
+          fetch(name_string.to_sym).presence || raise(KeyError.new("#{name_string} is blank."))
+        else
+          self[name_string]
+        end
+      end
+    end
+  
+    def respond_to_missing?(name, include_private)
+      true
+    end
+  end
+end

data/lib/clomp/result.rb

@@ -1,14 +1,18 @@
 module Clomp
   class Result
-    attr_reader :options, :operation, :state
+    attr_reader :operation, :state
     
     def initialize(options: {}, tracks: [], operation: nil)
       @report         = {}
       @operation      = set_prop :operation, operation || Operation.new
       @tracks         = set_prop :tracks, tracks || []
-      @options        = {}
+      @options        = Option.new
       @immutable_data = set_prop :options, options
-      @state          = ->(tracks) {tracks.select {|track| track.failure?}.count.zero?}
+      @state          = ->(tracks) { tracks.select {|track| track.failure?}.count.zero? }
+    end
+    
+    def options=(options = Option.new)
+      @options = options
     end
     
     def data

data/lib/clomp/track.rb

@@ -2,12 +2,12 @@ module Clomp
   class Track
     include Clomp::CommonStates
     
-    attr_reader :name, :block, :track_options, :state, :error, :track_from, :left, :right
+    attr_reader :name, :block, :track_options, :state, :error, :track_from, :left, :right, :options
     attr_accessor :executed
     
     VALID_TRACK_TYPES = %I(track failed_track finally catch)
     
-    def initialize(name: (raise Errors::NoTrackProvided), track_options: {}, right: true, track_from: nil, &block)
+    def initialize(name: (raise Errors::NoTrackProvided), track_options: {}, right: true, track_from: nil, options: Option.new, &block)
       @name          = name
       @track_from    = track_from
       @block         = block
@@ -17,6 +17,7 @@ module Clomp
       @right         = right
       @left          = !@right
       @executed      = false
+      @options       = options
     end
     
     def executed?
@@ -40,7 +41,7 @@ module Clomp
     # Track#exec! executes the steps defined in the operation class
     def exec!(object, options)
       mark_as_failure! # going to execute! set to failure initially
-      
+      @options = options
       if object.method(name.to_sym).arity > 1
         mark_as_success! if object.public_send(name.to_sym, options, **options) != false
       else

data/lib/clomp/track_builder.rb

@@ -6,6 +6,4 @@ module Clomp
       end
     end
   end
-end
-
-# 9dd796f8b50c23addaf020473df0c0430c3f37f4a8383459106eb1d72401433e
+end

data/lib/clomp/version.rb

@@ -1,3 +1,3 @@
 module Clomp
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clomp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Irfan Ahmed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - lib/clomp/errors.rb
 - lib/clomp/executor.rb
 - lib/clomp/operation.rb
+- lib/clomp/option.rb
 - lib/clomp/result.rb
 - lib/clomp/track.rb
 - lib/clomp/track_builder.rb