clomp 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e100e9861f2a2b799e088d4d4ac31d5e17fd376
+  data.tar.gz: 156d3e65b3b7664ef2f2d1273d0d93967058fff8
+SHA512:
+  metadata.gz: 13c87f30b50cf897d32b06ebe9dbd6281227d6c58bde6169711f9e3627d3f005b3efe9ce0507440f050d2cdaa52a36bf77eebcc010a5108a67fe2ac4138507b0
+  data.tar.gz: 7ef600eaa8d98c726da464d79dfef75391c8134051f6bb6f14b593db1cbadd2e6977c8f4551223bb9e9486d6ee9096bb4f3081ea0972e7076d938cc41b25a6c2

data/.byebug_history

@@ -0,0 +1,3 @@
+c
+break
+_track.failure?

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at irfandhk@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in the_railway.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    clomp (0.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  clomp!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Irfan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Clomp [![CircleCI](https://circleci.com/gh/rubyrider/Clomp.svg?style=svg)](https://circleci.com/gh/rubyrider/Clomp)
+
+**Clomp gem provides a smooth, lightweight, productive and reusable way to build an operation using Railway oriented programing paradigm.**
+Clomp will give you an easy interface to complete your service operation. You can use it with any framework 
+or plain ruby object. 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Clomp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Clomp
+
+## Usage
+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.
+
+
+Consider the following class:
+```ruby
+class SingingOperation < Clomp::Operation
+    # this block only executes on successful steps! 
+    # pass options to receive the operation states!   
+    add_track :get_lyrics do |options|
+      # we call this a success state based block!
+      options[:do_some_thing] = 10
+    end
+    
+    add_track :get_instruments_ready
+    
+    add_track :start_signing
+    
+    finally :receive_price #final step, wont execute after this step!
+    
+    def get_instruments_ready(options, mutable_data: , **)
+      # do anything!
+    end
+    
+    def get_lyrics(options, mutable_data: , **)
+      mutable_data[:singer_name] = 'James' #mutate
+    end
+    
+    def start_signing(options)
+      puts options[:mutable_options]
+    end
+    
+    def receive_price(options)
+      puts "I am honored for this awesome price!"
+    end
+end
+```
+
+```ruby
+@result = SingingOperation.({singer_name: 'Base Baba'})
+@result.success? # => true
+@result.failure? # => false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyrider/clomp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TheRailway project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubyrider/clomp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "the_railway"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clomp.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clomp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clomp"
+  spec.version       = Clomp::VERSION
+  spec.authors       = ['Irfan Ahmed']
+  spec.email         = ['irfandhk@gmail.com', 'odesk.irfan@gmail.com']
+
+  spec.summary       = %q{Clomp is a simple service builder for ruby using railway oriented programing paradigm.}
+  spec.description   = %q{Clomp gem provides a smooth, lightweight, productive and reusable way to build an operation using Railway Oriented Programing paradigm.}
+  spec.homepage      = "https://github.com/rubyrider/clomp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+end

data/lib/clomp/common_states.rb

@@ -0,0 +1,38 @@
+module Clomp
+  module CommonStates
+    FAILURE = 'failure'
+    SUCCESS = 'success'
+    PENDING = 'pending'
+    
+    # Track#pending? not executed tracks!
+    def pending?
+      @state && @state == PENDING
+    end
+    
+    # Track#success? successfully executed!
+    def success?
+      @state && @state == SUCCESS
+    end
+    
+    # Track#failure? successfully failure!
+    def failure?
+      @state && @state == FAILURE
+    end
+    
+    # Track#mark_as_success! flag the track as successful track
+    # FIXME improve the flagship of track status! Should we use integer instead of string?
+    def mark_as_success!
+      @state && @state = SUCCESS
+    end
+    
+    # Track#mark_as_failure! flag the track as unsuccessful track
+    def mark_as_failure!
+      @state && @state = FAILURE
+    end
+    
+    # Any exception raise!
+    def exception_raised?
+      @error && @error.present?
+    end
+  end
+end

data/lib/clomp/context.rb

@@ -0,0 +1,5 @@
+module Clomp
+  class Context
+  
+  end
+end

data/lib/clomp/errors.rb

@@ -0,0 +1,7 @@
+module Clomp
+  module Errors
+    NoTrackProvided  = Class.new(ArgumentError)
+    TrackNotDefined  = Class.new(NotImplementedError)
+    UnknownTrackType = Class.new(ArgumentError)
+  end
+end

data/lib/clomp/operation.rb

@@ -0,0 +1,79 @@
+module Clomp
+  class Operation
+    attr_accessor :input, :options
+    
+    def call(track_builders: [], mutable_data: {}, immutable_data: {})
+      @track_builders           = track_builders
+      @mutable_data             = mutable_data
+      @immutable_data           = immutable_data
+      @options                  ||= {}
+      @options[:mutable_data]   = mutable_data
+      @options[:immutable_data] = immutable_data
+      
+      exec_steps!
+    end
+    
+    # Execute all the steps! Execute all the tracks!
+    def exec_steps!
+      @track_builders.each do |track|
+        raise Errors::TrackNotDefined, "Please define track: #{track.name}" unless self.respond_to?(track.name)
+        
+        _track = track.exec!(self, @options)
+        
+        break if _track.failure?
+      end
+      
+      @result = Result.new(@options, @track_builders, self)
+    end
+    
+    def executed_steps
+      @track_builders.collect { |track| track.name if track.success? }.compact
+    end
+    
+    # Name of the steps defined in the operation class
+    def steps
+      @track_builders.collect { |track| track.name }
+    end
+    
+    class << self
+      
+      # To store and read all the tracks!
+      attr_accessor :track_builders
+      
+      # get track name and options!
+      def track(track_name, track_options: {}, &block)
+        @track_builders ||= []
+        
+        @track_builders << build_track(track_name, track_options, :track, &block)
+      end
+
+      # get the track name for the failure case!
+      def failure(track_name, track_options: {}, &block)
+        @track_builders ||= []
+        
+        @track_builders << build_track(track_name, track_options, :failed_track, &block)
+      end
+
+      # get the track name for the final step! Only one step will be executed!
+      def finally(track_name, track_options: {}, &block)
+        @track_builders ||= []
+  
+        @track_builders << build_track(track_name, track_options, :finally, &block)
+      end
+      
+      def call(mutable_data = {}, immutable_data = {})
+        self.new.call(
+            track_builders: @track_builders,
+            mutable_data:   mutable_data,
+            immutable_data: immutable_data
+        )
+      end
+      
+      private
+      
+      def build_track(track_name, track_options = {}, track_type , &block)
+        Track.new(name: track_name, track_options: track_options, track_type: track_type, &block)
+      end
+    end
+  end
+end

data/lib/clomp/result.rb

@@ -0,0 +1,18 @@
+module Clomp
+  class Result
+    include CommonStates
+    extend Forwardable
+    
+    attr_reader :options, :state, :operation
+    
+    def_delegators :@operation, :steps, :executed_steps
+    
+    def initialize(options, tracks = [], operation)
+      @options   = options
+      @tracks    = tracks
+      @error     = nil
+      @state     = @tracks.select {|track| track.failure?}.count.zero? ? SUCCESS : FAILURE
+      @operation = operation
+    end
+  end
+end

data/lib/clomp/track.rb

@@ -0,0 +1,40 @@
+module Clomp
+  class Track
+    include Clomp::CommonStates
+    
+    attr_reader :name, :block, :track_options, :state, :error
+    
+    VALID_TRACK_TYPES = %I(track failed_track finally catch)
+    
+    def initialize(name: (raise Errors::NoTrackProvided), track_options: {}, track_type: VALID_TRACK_TYPES.first, &block)
+      raise UnknownTrackType, 'Please provide a valid track type' unless VALID_TRACK_TYPES.include?(track_type)
+      
+      @name          = name
+      @block         = block
+      @track_options = track_options
+      @type          = track_type
+      @state         = 'pending'
+      @error         = nil
+    end
+    
+    # Track#exec! executes the steps defined in the operation class
+    def exec!(object, options)
+      mark_as_failure! # going to execute! set to failure initially
+      
+      if object.method(name.to_sym).arity > 1
+        mark_as_success! if object.public_send(name.to_sym, options, **options) != false
+      else
+        mark_as_success! if object.public_send(name.to_sym, options) != false
+      end
+      
+      @block.(options) if success? && @block
+      
+      self
+    
+    rescue => e
+      @error = e.message
+      
+      self
+    end
+  end
+end

data/lib/clomp/version.rb

@@ -0,0 +1,3 @@
+module Clomp
+  VERSION = "0.0.3"
+end

data/lib/clomp.rb

@@ -0,0 +1,11 @@
+require 'clomp/version'
+require 'clomp/common_states'
+require 'clomp/operation'
+require 'clomp/track'
+require 'clomp/context'
+require 'clomp/errors'
+require 'clomp/result'
+
+module Clomp
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: clomp
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Irfan Ahmed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Clomp gem provides a smooth, lightweight, productive and reusable way
+  to build an operation using Railway Oriented Programing paradigm.
+email:
+- irfandhk@gmail.com
+- odesk.irfan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clomp.gemspec
+- lib/clomp.rb
+- lib/clomp/common_states.rb
+- lib/clomp/context.rb
+- lib/clomp/errors.rb
+- lib/clomp/operation.rb
+- lib/clomp/result.rb
+- lib/clomp/track.rb
+- lib/clomp/version.rb
+homepage: https://github.com/rubyrider/clomp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Clomp is a simple service builder for ruby using railway oriented programing
+  paradigm.
+test_files: []