otb_job_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93b7a1ae26b497459d19707e053485b8fc6fa240336dfb99affe54d4e0dda745
+  data.tar.gz: f130cc222121c16a99c974810f83d0dc0cb71ed8f5fcb9f3abcf87becf8ed42b
+SHA512:
+  metadata.gz: 78ea3674c8b05d87c10e2d9163ffac5b9338ece76a84de06574a39210070fd78f36a90bece78c8230c2fc889a5a8bdd4a1fb4939588585c4c9e5a580169175d7
+  data.tar.gz: 3d0ad83877fbff306dd3f54b4bdd7325ea398493013f9c1374c3e28deefc4941b546e2f1643680bbe5c12604382309fe856e98f0a0db98a0f07c54303b1f963d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+  - 'bin/*'
+  TargetRubyVersion: 2.5.1
+
+Metrics/LineLength:
+  Max: 100
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/GuardClause:
+  Enabled: false
+  

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

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 mariozugaj@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,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in otb_job_queue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    otb_job_queue (0.1.0)
+      dry-validation (~> 0.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.1.3)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.7)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.1)
+    dry-inflector (0.1.2)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+    dry-validation (0.12.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.13.1)
+    jaro_winkler (1.5.1)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  minitest (~> 5.0)
+  otb_job_queue!
+  rake (~> 10.0)
+  rubocop (~> 0.60.0)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mario Zugaj
+
+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 @@
+# OtbJobQueue
+
+Solution for the OTB Job Queue Challenge
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'otb_job_queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install otb_job_queue
+
+## Usage
+
+```ruby
+require "otb_job_queue"
+
+# create a new job sequencer instance with a parser dependency
+sequencer = OtbJobQueue::JobsSequencer.new(OtbJobQueue::JobsParser)
+
+# job sequencing is invoked by calling .call method on the sequencer, with the appropriate input
+sequencer.call("a => ") 
+    #=> "a"
+sequencer.call("a => b, b => ") 
+    #=> "ba"
+sequencer.call("a => , b => c, c => ")
+    #=> "acb"
+sequencer.call("a => ,b => c, c => f, d => a, e => b, f => ")
+    #=> "afcbde"
+
+# as long as the input format is (job) => (dependency), it will sequence the string
+sequencer.call("a => \nb => c\nc => f\nd => a \ne => b\n f => ")
+    #=> "afcbde"
+sequencer.call("a =>  b => c c => f d => a e => b f => ")
+    #=> "afcbde"
+```
+
+### Error Handling
+
+```ruby
+require "otb_job_queue"
+
+sequencer = OtbJobQueue::JobsSequencer.new(OtbJobQueue::JobsParser)
+
+# If the job => dependency list has a circular dependency, CircularDependencyError will be raised
+sequencer.call("a => \nb => c\nc => f\nd => a \ne => \n f => b")
+    #=> OtbJobQueue::JobsSequencer::CircularDependencyError (Jobs can't have circular dependencies: topological sort failed: ["b", "c", "f"])
+
+# If the job => dependency list has a self dependency, SelfDependencyError will be raised
+sequencer.call("a => , b => c, c => c")
+    #=> OtbJobQueue::JobsSequencer::SelfDependencyError (Jobs can't depend on themselves: c => c)
+
+# If the invalid input type or invalid string format is given, InputError will be raised
+sequencer.call({})
+    #=> OtbJobQueue::JobsParser::InputError ({:jobs_input=>["must be String", "must be empty or is in invalid format"]})
+sequencer.call("a=>b=>cc=>c")
+    #=> OtbJobQueue::JobsParser::InputError ({:jobs_input=>["must be empty or is in invalid format"]})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 GitLab at https://gitlab.com/chanjman/otb-job-queue. 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 OtbJobQueue project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/chanjman/otb-job-queue/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "otb_job_queue"
+
+# 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/lib/otb_job_queue.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "otb_job_queue/version"
+
+require "otb_job_queue/core_extensions"
+require "otb_job_queue/jobs_parser"
+require "otb_job_queue/jobs_sequencer"

data/lib/otb_job_queue/core_extensions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "tsort"
+
+# Extends the Hash class to use Tsort's tsort method
+class Hash
+  include TSort
+
+  alias tsort_each_node each_key
+  def tsort_each_child(node, &block)
+    fetch(node).each(&block)
+  end
+end

data/lib/otb_job_queue/jobs_parser.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module OtbJobQueue
+  # Parses a string of jobs into an hash
+  class JobsParser
+    JOBS_QUEUE_FORMAT = /(\w) => (\w|)/.freeze
+
+    private_class_method :new
+
+    class InputError < TypeError; end
+
+    # Creates a new instance of the JobsParser with the valid jobs_input param
+    # @param jobs_input [String] jobs string
+    def initialize(jobs_input)
+      @jobs_input = jobs_input
+    end
+
+    # JobsParser's Validation schema
+    # Successful validation if input is an empty String or a String of valid format
+    Schema = Dry::Validation.Schema do
+      required(:jobs_input) { type?(String) & (empty? | format?(JOBS_QUEUE_FORMAT)) }
+    end
+
+    # Creates a new JobsParser instance and calls the .call method on it
+    # @api public
+    # @return [JobsParser.new(jobs_input).call, InputError] the jobs hash
+    # @example
+    #   OtbJobQueue::JobsParser.call('a => \nb => \nc => b')
+    #     => { "a"=> [], "b"=> [], "c" => ["b"] }
+    #   OtbJobQueue::JobsParser.call('Hello World!')
+    #     => InputError ({ :jobs_input => ["must be empty or is in invalid format"] })
+    def self.call(jobs_input)
+      validation = self::Schema.call(jobs_input: jobs_input)
+      if validation.success?
+        new(jobs_input).call
+      else
+        raise InputError, validation.messages
+      end
+    end
+
+    def call
+      parse
+    end
+
+    private
+
+    # Parses a string of jobs into an hash
+    # @api private
+    # @return [Hash] the jobs hash
+    def parse
+      @jobs_input.scan(JOBS_QUEUE_FORMAT).each_with_object({}) do |(job, dependency), memo|
+        memo[job] = dependency.empty? ? [] : [dependency]
+      end
+    end
+  end
+end

data/lib/otb_job_queue/jobs_sequencer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OtbJobQueue
+  # Sequences jobs order based on their dependencies
+  class JobsSequencer
+    class SelfDependencyError < StandardError; end
+    class CircularDependencyError < StandardError; end
+
+    # Creates a new instance of the JobsSequencer with a parser as a param
+    # @param parser
+    def initialize(parser)
+      @parser = parser
+    end
+
+    # Parses an input of jobs into a string or raises Errors
+    # @api public
+    # @return [String] correct sequence of jobs
+    # @example
+    #   sequencer = OtbJobQueue::JobsSequencer.new(OtbJobQueue::JobsParser)
+    #   sequencer.call("a => ") #=> "a"
+    #   sequencer.call("a => b\nb => c\nc => ") #=> 'cba'
+    def call(jobs_input)
+      jobs_to_sequence = @parser.call(jobs_input)
+      check_self_dependecies(jobs_to_sequence)
+      jobs_to_sequence.tsort.join
+    rescue TSort::Cyclic => error
+      raise CircularDependencyError, "Jobs can't have circular dependencies: #{error.message}"
+    end
+
+    private
+
+    # Verifies if the jobs_to_sequence has self dependencies
+    # @api private
+    # @param [Hash] jobs to sequence hash
+    # @return [SelfDependencyError, void]
+    def check_self_dependecies(jobs_to_sequence)
+      jobs_to_sequence.each do |job, dependency|
+        if job == dependency.first
+          raise SelfDependencyError, "Jobs can't depend on themselves: #{job} => #{dependency.first}"
+        end
+      end
+    end
+  end
+end

data/lib/otb_job_queue/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OtbJobQueue
+  VERSION = "0.1.0"
+end

data/otb_job_queue.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "otb_job_queue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "otb_job_queue"
+  spec.version       = OtbJobQueue::VERSION
+  spec.authors       = ["Mario Zugaj"]
+  spec.email         = ["mariozugaj@gmail.com"]
+
+  spec.summary       = "OTB Job Queue"
+  spec.description   = "Solution for the OTB Job Queue Challenge"
+  spec.homepage      = "https://gitlab.com/chanjman/otb-job-queue"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "byebug", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
+
+  spec.add_dependency "dry-validation", "~> 0.12.2"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: otb_job_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Zugaj
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-05 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: byebug
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: Solution for the OTB Job Queue Challenge
+email:
+- mariozugaj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/otb_job_queue.rb
+- lib/otb_job_queue/core_extensions.rb
+- lib/otb_job_queue/jobs_parser.rb
+- lib/otb_job_queue/jobs_sequencer.rb
+- lib/otb_job_queue/version.rb
+- otb_job_queue.gemspec
+homepage: https://gitlab.com/chanjman/otb-job-queue
+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.7.6
+signing_key: 
+specification_version: 4
+summary: OTB Job Queue
+test_files: []