OTB-test 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd3142710223bad92e3994da0491fb510acc0315
+  data.tar.gz: 597241e932c5283d1126cf243ae182e4548fb1d9
+SHA512:
+  metadata.gz: d4222b067a4ac9c312c3f33b77e8987a1293fd6d966ea32f8a24ce6109df9783ca72fafb36ed355b39b5f840da6fffd958dc59649f7f701bd4119208a931c717
+  data.tar.gz: c95cee4c677f795b653ab53d82c350d81e741e617c8aba032b49b3f8fc4c8d16428c7860a98c7738202e735693f79163626064fd4d12b069155885310b735a69

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 filipe.p@soltroiavillas.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in OTB-test.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    OTB-test (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  OTB-test!
+  bundler (~> 1.17)
+  pry (~> 0.10.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Filipe Paiva
+
+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/OTB-test.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "OTB/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "OTB-test"
+  spec.version       = OTB::Test::VERSION
+  spec.authors       = ["Filipe Paiva"]
+  spec.email         = ["filipe.p@soltroiavillas.com"]
+
+  spec.summary       = %q{OTB job queue algorithem}
+  spec.description   = %q{This gem organizes jobs according to it's dependencies. It takes in a string of jobs sperated by a commas and organizes them from 'a' tp 'z' according the dependencies.}
+  spec.homepage      = "https://github.com/Filipe-p/OTB-test"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

data/README.md

@@ -0,0 +1,131 @@
+# OTB Job Queuer
+
+Welcome to your new gem from OTB! It is a job queuer and can be user on the terminal or a Gem in your projects.
+The gem takes in a string in the format of:
+```
+a =>
+b => c
+c =>
+```
+or
+```
+a => \nb => \nc => c
+```
+And respondes with an ordered sequence of the jobs that takes into accoun the dependecies. For example in this case:  `a, c, b`
+
+Read usage to see how to call methods.
+
+## OTB Job Queuer Structure
+
+Most of the code is in one of two places:
+ `lib/OTB/`
+ or
+`spec/OTB/`
+
+In the 'lib/' you will find the methods and loggic that parses jobs and sorts queues based on their dependencies.
+In the 'spec/' you will find the tests make sure everything is running correctly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'OTB-test'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install OTB-test
+
+## Loading to terminal
+
+From terminal open your ruby console:
+
+    $ irb
+
+Then load the file `lib/otb.rb`:
+
+    $ pry(main)> load 'lib/otb.rb'
+
+It should return `true`.
+
+## Usage
+
+The usage of the gem methods is the same in terminal or in project. Check above how to load to terminal.
+
+You can also run the tests to see everything is passing! Skip to section ##Test to do this.
+
+###Queue Class Usage
+The purpose of this class is to create queues and then sort them.
+As such there are two public methods:
+ - Initialization with `new`
+ and
+ - sorting according to dependecies `sort_sequence` on a Queue object
+
+####Creating a new Queue
+```
+  OTB::Queue.new(string: 'a =>')
+```
+returns:
+```
+  => #<OTB::Queue:0x00007f8433d04260 @jobs="a =>", @jobs_parsed={"a"=>""}>
+```
+An OTB::Queue with @jobs and @jobs_parsed available
+
+####Sorting a Queue
+```
+  new_queue = OTB::Queue.new(string: 'a =>')
+  new_queue.sort_sequence
+```
+returns:
+```
+  => "a"
+```
+A string witht the sequence of the jobs ordered.
+
+
+###Job Class - Currently only parse implemented
+Job Class exists to parse strings of jobs into Hashes of jobs with dependencies.
+Further releases will allow you to store individial job objects and create several from a string.
+####Parsing jobs
+```
+  OTB::Job.parse('a => \nb => \nc =>')
+```
+returns:
+```
+  => {"a"=>"", "b"=>"", "c"=>""}
+```
+A Hash with keys being the jobs and values the dependencies.
+
+
+## Testes
+
+There are 17 test.
+ - 8 testing the Job class, mostly the `parse` method.
+ - 9 testing the Queue class, checking that exections are raised and that the queuer
+
+Inside the OTB-test directory execute:
+
+    $ rake spec
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 GitHub at https://github.com/[USERNAME]/OTB-test. 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 OTB::Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/OTB-test/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 "OTB/test"
+
+# 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/exercise_speficiation.md

@@ -0,0 +1,59 @@
+#On The Beach - Coding Exercise Specification
+
+##Intro
+The purpose of this exercise is to see how you approach a problem, and how you solve it. We’re interested to see how you structure your Ruby code, your command of the language and good design and testing principles, bear this in mind throughout.
+HINT: Start with a method that accepts a single string argument and returns a string (or a collection) which represents the ordered sequence of jobs (since each job is a single character).
+HINT: Brownie points will be given for showing us your working (notes, commit history, some kind of idea how you approached the problem).
+HINT: We’re pretty keen on tested code. Have Fun.
+
+##The Challenge
+Imagine we have a list of jobs, each represented by a character. Because certain jobs must be done before others, a job may have a
+dependency on another job. For example, a may depend on b, meaning the final sequence of jobs should place b before a. If a has no
+dependency, the position of a in the final sequence does not matter.
+*Given you’re passed an empty string (no jobs), the result should be an empty sequence.
+*Given the following job structure:
+```
+a =>
+```
+The result should be a sequence consisting of a single job a.
+*Given the following job structure:
+```
+a =>
+b =>
+c =>
+```
+The result should be a sequence containing all three jobs abc in no significant order.
+*Given the following job structure:
+```
+a =>
+b => c
+c =>
+```
+The result should be a sequence that positions c before b, containing all three jobs abc.
+*Given the following job structure:
+```
+a =>
+b => c
+c => f
+d => a
+e => b
+f =>
+```
+The result should be a sequence that positions f before c, c before b, b before e and a before d containing all six jobs abcdef.
+*Given the following job structure:
+```
+a =>
+b =>
+c => c
+```
+The result should be an error stating that jobs can’t depend on themselves.
+*Given the following job structure:
+```
+a =>
+b => c
+c => f
+d => a
+e =>
+f => b
+```
+The result should be an error stating that jobs can’t have circular dependencies.

data/lib/OTB/exception.rb

@@ -0,0 +1,16 @@
+class JobQueueError < StandardError;
+
+  def self.self_dependency_error
+    exception message: "Self dependency error - A job cannot depend on itself", internal_code: 4009, code:409
+  end
+
+  def self.circular_dependecy_error
+    exception message: "Circular dependency error - Jobs cannot depen on themselfves circularly creating an infinate loop", internal_code: 4009, code:409
+  end
+
+
+  def self.no_input_error
+    exception message: "No input passed. jobs: was nil" , internal_code: 2004, code: 204
+  end
+
+end

data/lib/OTB/job.rb

@@ -0,0 +1,31 @@
+module OTB
+  class Job
+
+    attr_accessor :job
+
+    def initialize(job)
+      # Further version of the code might want to change the initialization and create several Job objects.
+      # These could then be saved in the DB as such or passed to the queuer.
+      @job = job
+    end
+
+    def self.parse(jobs)
+      jobs_array = jobs.split('\n')
+      result_hash = {}
+      if jobs == ''
+        result_hash[''] =''
+        result_hash
+      else
+        array_job_dependencies_sanitized = jobs_array.each do |job_dependency|
+            array_job_dependency = []
+            array_job_dependency << job_dependency.split('=>')
+            array_job_dependency.each do |job, dependency|
+              if dependency.nil?; dependency = '' else dependency.strip! end
+              result_hash[job.strip] = dependency
+            end
+        end
+        result_hash
+      end
+    end
+  end
+end

data/lib/OTB/queue.rb

@@ -0,0 +1,68 @@
+module OTB
+  class Queue
+    attr_accessor :jobs, :jobs_parsed
+
+    #usign job:nil for stability & latter flexibity
+        # Idea being you could also have string:nil
+        # then you could initialized with Job objects in the jobs:
+        # or you could initialized with String objects in the string:
+    def initialize(string:nil)
+     @jobs = string
+     @jobs_parsed = OTB::Job.parse(@jobs) unless string.nil?
+    end
+
+    def sort_sequence
+      case @jobs
+        when ''
+          ''
+        when nil
+          raise JobQueueError.no_input_error
+        else
+          check_self_dependency(@jobs_parsed)
+          check_circular_dependency(@jobs_parsed)
+          sort_jobs_to_sequence(@jobs_parsed)
+      end
+    end
+
+    private
+
+    def check_self_dependency(jobs_parsed)
+     jobs_parsed.each do |job, dependency|
+       if job == dependency
+         raise JobQueueError.self_dependency_error
+       end
+     end
+    end
+
+    def check_circular_dependency(jobs_parsed)
+      hash_jobs_with_depencecies = {}
+
+      jobs_parsed.each_with_index do |job_dependency, index|
+      [job_dependency].each do |job, dependency|
+        if hash_jobs_with_depencecies.keys.include?(dependency) && hash_jobs_with_depencecies.values.include?(job)
+          raise JobQueueError.circular_dependecy_error
+        end
+        hash_jobs_with_depencecies[job] = dependency unless dependency.empty?
+      end
+     end
+    end
+
+    def sort_jobs_to_sequence(jobs_parsed)
+      sequence = []
+
+      jobs_parsed.each do |job, dependency|
+        if dependency.empty?
+          sequence << job unless sequence.include?(job)
+        elsif sequence.include?(job)
+          index = sequence.find_index(job)
+          sequence.insert(index, dependency)
+        else
+          sequence << dependency unless sequence.include?(dependency)
+          sequence << job unless sequence.include?(job)
+        end
+      end
+      sequence.join(', ')
+    end
+  end
+end
+

data/lib/OTB/version.rb

@@ -0,0 +1,5 @@
+module OTB
+  module Test
+    VERSION = "0.1.1"
+  end
+end

data/lib/otb.rb

@@ -0,0 +1,12 @@
+require_relative 'OTB/queue'
+require_relative 'OTB/version'
+require_relative 'OTB/exception'
+require_relative 'OTB/job'
+
+
+module OTB
+  # module Test
+  #   class Error < StandardError; end
+  #   # Your code goes here...
+  # end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: OTB-test
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Filipe Paiva
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: This gem organizes jobs according to it's dependencies. It takes in a
+  string of jobs sperated by a commas and organizes them from 'a' tp 'z' according
+  the dependencies.
+email:
+- filipe.p@soltroiavillas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- OTB-test-0.1.0.gem
+- OTB-test.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exercise_speficiation.md
+- lib/OTB/exception.rb
+- lib/OTB/job.rb
+- lib/OTB/queue.rb
+- lib/OTB/version.rb
+- lib/otb.rb
+homepage: https://github.com/Filipe-p/OTB-test
+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.14.1
+signing_key: 
+specification_version: 4
+summary: OTB job queue algorithem
+test_files: []