galaxy_converter 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d95182718dfea56d5aa20b5367f980f4551e8023
+  data.tar.gz: 5c7eacee4bd821f49230dbfdab976a48cb21c040
+SHA512:
+  metadata.gz: 19132e8261add543bf2080b29c4509bcae22e9c269d533b38ff5adc6c068abeedec758042974ea69f755c7f64477086d63971beb56415496165006625dda48d9
+  data.tar.gz: d634fe6ec2b59141020f40e87d02c0b641d6e375fb7f85c0888dfcc6589e3cbca837fe10076d88dff010549205e663bce9aabd987222c2aecd3588eb3955eb00

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

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 galaxy_converter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+## Table of Contents
+* [Scope](#scope)
+* [Design](#design)
+  * [SRP](#srp)
+  * [Roman numerals](#roman-numerals)
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Library](#library)
+  * [CLI](#cli)
+
+## Scope
+This gem is the Ruby implementation of the `Merchant's Guide to the Galaxy` code-kata.
+
+## Design
+
+### SRP
+The code design follows the single responsibility principle by using a dedicated class/module for any specific task.  
+
+### Roman numerals
+The design behind the `Roman numerals` logic was inspired by Sandi Metz's [solution](https://www.sandimetz.com/blog/2016/6/9/make-everything-the-same): in the beginning roman numerals can be expressed both with `subtractive` (eg `IV`) and `additive` (eg `IIII`) form. 
+Switching to the additive form makes easier to convert to Arabic numerals.  
+
+## Installation
+Install the gem from your shell:
+```shell
+gem install galaxy_converter
+```
+
+## Usage
+
+### Library
+Just require the library into your program and pass an array of notes to the converter:
+```ruby
+require "galaxy_converter"
+
+notes = ["glob is I", "prok is V", "pish is X", "tegj is L", "glob glob Silver is 34 Credits", "glob prok Gold is 57800 Credits", "pish pish Iron is 3910 Credits", "how much is pish tegj glob glob ?", "how many Credits is glob prok Silver ?", "how many Credits is glob prok Gold ?", "how many Credits is glob prok Iron ?", "how much wood could a woodchuck chuck if a woodchuck could chuck wood ? "]
+
+puts GalaxyConverter.call(notes)
+# pish tegj glob glob is 42
+# glob prok Silver is 68 Credits
+# glob prok Gold is 57800 Credits
+# glob prok Iron is 782 Credits
+# I have no idea what you are talking about
+```
+
+### CLI
+The gem provides a CLI interface. 
+Once installed you will be able to use the `galaxy_converter` command from the terminal.  
+
+#### Help
+You can print CLI help by:
+```shell
+galaxy_converter -h
+Usage: galaxy_converter ~/notes.txt
+    -h --help               Print this help
+    <path-to-file>          Load conversion notes
+```
+
+#### Input
+The program accepts as input a file containing several conversion notes:
+```txt
+# ~/notes.txt
+glob is I
+prok is V
+pish is X
+tegj is L
+glob glob Silver is 34 Credits
+glob prok Gold is 57800 Credits
+pish pish Iron is 3910 Credits
+how much is pish tegj glob glob ?
+how many Credits is glob prok Silver ?
+how many Credits is glob prok Gold ?
+how many Credits is glob prok Iron ?
+how much wood could a woodchuck chuck if a woodchuck could chuck wood ?
+```
+
+Just pass the file path to the program:
+```shell
+galaxy_converter ~/notes.txt
+> pish tegj glob glob is 42
+> glob prok Silver is 68 Credits
+> glob prok Gold is 57800 Credits
+> glob prok Iron is 782 Credits
+> I have no idea what you are talking about
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+Rake::TestTask.new(:bench) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_bench.rb"]
+end
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "galaxy_converter"
+
+input = ARGV.fetch(0, "")
+GalaxyConverter::CLI.new(input).call

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/galaxy_converter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "galaxy_converter/version"
+
+Gem::Specification.new do |s|
+  s.name = "galaxy_converter"
+  s.version = GalaxyConverter::VERSION
+  s.authors = ["costajob"]
+  s.email = ["costajob@gmail.com"]
+  s.homepage = "https://bitbucket.org/costajob/galaxy_converter"
+  s.license = "MIT"
+  s.summary = "Implementation of the Merchant's Guide to the Galaxy kata"
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir = "bin"
+  s.executables << "galaxy_converter"
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 2.2.2"
+
+  s.add_development_dependency "bundler", "~> 1.15"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "benchmark-ips", "~> 2"
+end

data/lib/galaxy_converter/abacus.rb

@@ -0,0 +1,24 @@
+require "galaxy_converter/roman_numeral"
+
+module GalaxyConverter
+  class Abacus
+    def initialize(mapping = {}, unit = Roman::Numeral)
+      @mapping = mapping
+      @unit = unit
+    end
+
+    def call(units)
+      converted = convert(units)
+      result = @unit.new(converted)
+      return 0 unless result.valid?
+      result.to_i
+    end
+
+    private def convert(units)
+      units.split(" ").reduce("") do |to_convert, unit|
+        return unless @mapping[unit]
+        to_convert << @mapping[unit]
+      end
+    end
+  end
+end

data/lib/galaxy_converter/cli.rb

@@ -0,0 +1,47 @@
+require "galaxy_converter/note"
+require "galaxy_converter/responder"
+
+module GalaxyConverter
+  class CLI
+    HELP_FLAGS = %w[-h --help]
+    COL_WIDTH = 23
+
+    def initialize(input, 
+                   pipe = STDOUT, 
+                   responder = Responder,
+                   note = Note)
+      @input = input
+      @pipe = pipe
+      @responder = responder
+      @note = note
+    end
+
+    def call
+      @pipe.puts output
+    end
+
+    private def output
+      return help if help?
+      return unless file?
+      data = File.readlines(@input).map(&:strip)
+      notes = @note.bulk(data)
+      @responder.new(notes).call
+    end
+
+    private def file?
+      File.file?(File.expand_path(@input))
+    end
+
+    private def help?
+      HELP_FLAGS.include?(@input)
+    end
+
+    private def help
+      [].tap do |h|
+        h << %q{Usage: galaxy_converter ~/notes.txt}
+        h << "    %-#{COL_WIDTH}s Print this help" % "-h --help"
+        h << "    %-#{COL_WIDTH}s Load conversion notes" % "<path-to-file>"
+      end
+    end
+  end
+end

data/lib/galaxy_converter/note.rb

@@ -0,0 +1,28 @@
+module GalaxyConverter
+  class Note
+    PREFIXES = ["how much is", "how many credits is"]
+    QUESTION_MARK = "?"
+
+    def self.bulk(notes)
+      Array(notes).map { |body| new(body) }
+    end
+
+    attr_reader :body
+
+    def initialize(body)
+      @body = body.to_s.strip.downcase
+    end
+
+    def question?
+      @body.end_with?(QUESTION_MARK)
+    end
+
+    def commercial?
+      !!@body.index("credits")
+    end
+
+    def stripped
+      @body.sub(/#{PREFIXES.join("|")}/, "").sub(QUESTION_MARK, "").strip
+    end
+  end
+end

data/lib/galaxy_converter/recognizer.rb

@@ -0,0 +1,44 @@
+require "galaxy_converter/abacus"
+require "galaxy_converter/note"
+
+module GalaxyConverter
+  class Recognizer
+    attr_reader :abacus
+
+    def initialize(notes, abacus = Abacus)
+      notes = notes.reject(&:question?)
+      @commercials, @assertions = notes.partition(&:commercial?)
+      @abacus = abacus.new(mapping)
+    end
+
+    def goods
+      @goods ||= @commercials.reduce({}) do |acc, note|
+        matching = note.body.match(goods_rule)
+        next acc unless matching
+        units, name, credits = matching.captures 
+        value = @abacus.call(units)
+        next acc if value.zero?
+        acc[name] = credits.to_f / value
+        acc
+      end
+    end
+
+    private def goods_rule
+      /([#{mapping.keys.join("|")}\s]+) (\w+) is (\d+)/
+    end
+
+    private def mapping
+      @mapping ||= @assertions.reduce({}) do |acc, note|
+        matching = note.body.match(mapping_rule)
+        next acc unless matching
+        unit, roman = matching.captures
+        acc[unit.strip] = roman.upcase
+        acc
+      end
+    end
+
+    private def mapping_rule
+      /(\w+) is (\w)/
+    end
+  end
+end

data/lib/galaxy_converter/responder.rb

@@ -0,0 +1,49 @@
+require "forwardable"
+require "galaxy_converter/recognizer"
+
+module GalaxyConverter
+  class Responder
+    extend Forwardable
+
+    def_delegators :@recognizer, :goods, :abacus
+
+    UNKNOWN_ANSWER = "I have no idea what you are talking about"
+
+    def initialize(notes, recognizer = Recognizer, abacus = Abacus)
+      @questions = notes.select(&:question?)
+      @recognizer = recognizer.new(notes, abacus)
+    end
+
+    def call
+      @questions.reduce([]) do |acc, note|
+        units, good = detect(note)
+        total = total(units, good)
+        acc << to_s(units, good, total, note.commercial?)
+        acc
+      end
+    end 
+
+    private def to_s(units, good, total, commercial)
+      return UNKNOWN_ANSWER if total.zero?
+      [].tap do |s|
+        s << units
+        s << good.to_s.capitalize
+        s << "is"
+        s << "%g" % total
+        s << "Credits" if commercial
+      end.reject(&:empty?).join(" ")
+    end
+
+    private def total(units, good)
+      return abacus.call(units) unless good
+      abacus.call(units) * goods.fetch(good, 0)
+    end
+
+    private def detect(note)
+      tokens = note.stripped.split
+      return [tokens.join(" "), nil] unless note.commercial?
+      good = tokens.pop
+      [tokens.join(" "), good]
+    end
+  end
+end

data/lib/galaxy_converter/roman_constraint.rb

@@ -0,0 +1,31 @@
+module GalaxyConverter
+  module Roman
+    module Constraint
+      extend self
+
+      def violated?(value)
+        violations.any? { |violation| value.index(violation) }
+      end
+
+      private def violations
+        @violations ||= repetitions + subtractions
+      end
+
+      private def repetitions
+        %w[I X C M].map { |c| c * 4 } +
+          %w[D L V].map { |c| c * 2 }
+      end
+
+      private def subtractions
+        %w[V X].map { |c| "II#{c}"} +
+          %w[L C].map { |c| "XX#{c}"} +
+          %w[D M].map { |c| "CC#{c}"} +
+          %w[L C D M].map { |c| "I#{c}" } +
+          %w[D M].map { |c| "X#{c}" } +
+          %w[X L C D M].map { |c| "V#{c}" } + 
+          %w[C D M].map { |c| "L#{c}"} +
+          ["DM"]
+      end
+    end
+  end
+end

data/lib/galaxy_converter/roman_numeral.rb

@@ -0,0 +1,39 @@
+require "galaxy_converter/roman_constraint"
+require "galaxy_converter/roman_rule"
+
+module GalaxyConverter
+  module Roman
+    class Numeral
+      SYMBOLS = {
+        "M" => 1000,
+        "D" => 500,
+        "C" => 100,
+        "L" => 50,
+        "X" => 10,
+        "V" => 5,
+        "I" => 1
+      }
+
+      def initialize(value, constraint = Constraint, rule = Rule)
+        @value = value.to_s.upcase
+        @constraint = constraint
+        @rule = rule
+      end
+
+      def to_s
+        @value
+      end
+
+      def to_i
+        @rule.call(@value).chars.reduce(0) do |total, symbol|
+          total += SYMBOLS.fetch(symbol, 0)
+        end
+      end
+
+      def valid?
+        return false if @value.empty?
+        !@constraint.violated?(@value)
+      end
+    end
+  end
+end

data/lib/galaxy_converter/roman_rule.rb

@@ -0,0 +1,22 @@
+module GalaxyConverter
+  module Roman
+    module Rule
+      extend self
+
+      LONG_TO_SHORT = {
+        "DCCCC" => "CM", # 900
+        "CCCC"  => "CD", # 400
+        "LXXXX" => "XC", # 90
+        "XXXX"  => "XL", # 40
+        "VIIII" => "IX", # 9
+        "IIII"  => "IV"  # 4
+      }
+
+      def call(value)
+        LONG_TO_SHORT.reduce(value) do |to_convert, (long, short)|
+          to_convert.gsub(short, long)
+        end
+      end
+    end
+  end
+end

data/lib/galaxy_converter/version.rb

@@ -0,0 +1,3 @@
+module GalaxyConverter
+  VERSION = "2.1.1"
+end

data/lib/galaxy_converter.rb

@@ -0,0 +1,11 @@
+require "galaxy_converter/version"
+require "galaxy_converter/cli"
+
+module GalaxyConverter
+  extend self
+
+  def call(notes)
+    notes = Note.bulk(notes)
+    Responder.new(notes).call
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: galaxy_converter
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- costajob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- costajob@gmail.com
+executables:
+- galaxy_converter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/galaxy_converter
+- bin/setup
+- galaxy_converter.gemspec
+- lib/galaxy_converter.rb
+- lib/galaxy_converter/abacus.rb
+- lib/galaxy_converter/cli.rb
+- lib/galaxy_converter/note.rb
+- lib/galaxy_converter/recognizer.rb
+- lib/galaxy_converter/responder.rb
+- lib/galaxy_converter/roman_constraint.rb
+- lib/galaxy_converter/roman_numeral.rb
+- lib/galaxy_converter/roman_rule.rb
+- lib/galaxy_converter/version.rb
+homepage: https://bitbucket.org/costajob/galaxy_converter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+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: Implementation of the Merchant's Guide to the Galaxy kata
+test_files: []