rirera 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7864353d497ead1533b9e403625700aa480d894
-  data.tar.gz: 7169d644d6f4e1cc9ccd3b9981356da04ef2944d
+  metadata.gz: 2d02a077e1539aa7fa2fc09811675b3bb2a70812
+  data.tar.gz: 34b3e8dc64c67cb757e1c05a980b2378c10f3c75
 SHA512:
-  metadata.gz: 31d521763cebfa87463d3fac829d9d9032fe5794d359c59ba55c30d3220124120af0c31b0242b71f71f445a4ff3fab099467f510d6a483c59cd20694c75cb78e
-  data.tar.gz: 7abca528b85ffe87e200f266dcd37a6e4e53832b0c27db05a27439c0df3c760ca53b4328d40ac0a7461a06b4eac0bafd65b633f5de44989ab5ba7fc38268c8cc
+  metadata.gz: 2a40fe14a9fdf29772d94445a732f23166697ef4c5ca71af424bcad6a4164f8742d3ab86f05392914814badf23931716d479d2cb88a4915a996a1e190cf10e21
+  data.tar.gz: 23fc98e1d8989e4caba702a4045f738a28c3b541c94923c7b62ac054aee6a88bfc41891164bf624f52acb8fcf320ef04e1b6962d16f438d691102358fefa4f4c

data/CHANGELOG

@@ -1,3 +1,5 @@
 Version 0.1.0: Initial version
 Version 0.1.1: added rdoc usage documentation
 Version 0.1.2: added screenshot to README.rdoc
+Version 0.1.3: class refactoring/encapsulation
+Version 0.1.4: adding proper cli

data/Gemfile

@@ -1 +1,4 @@
+source "https://rubygems.org"
+
 gem "colorize", "~> 0.7.3"
+gem "trollop", "2.0"

data/README.md

@@ -18,4 +18,15 @@ Add your broker, and its specific commision rates to `conf/rirera.yml`
 
 ## Run
 
-`rirera <broker_name>`
+```
+$ rirera -h
+Options:
+  --broker, -b <s>:   choose your broker
+  --volume, -v <f>:   volume (amount of money)
+  --target, -t <f>:   target price
+  --actual, -a <f>:   actual price
+    --stop, -s <f>:   stop loss
+        --loop, -l:   start rirera in loop input mode (other options will be
+                      discarded)
+        --help, -h:   Show this message
+```

data/README.rdoc

@@ -1,13 +1,11 @@
 = rirera
 
-* http://github.com/MaximilianMeister/rirera
+* https://github.com/MaximilianMeister/rirera
 
 == What is rirera?
 
 A small ruby command line tool to calculate a risk reward ratio.
 
-![screenshot](http://ibin.co/1jv1nIeXZ8j9)
-
 == Configuration
 
 Add your broker, and its specific commision rates to `conf/rirera.yml`
@@ -18,4 +16,13 @@ Add your broker, and its specific commision rates to `conf/rirera.yml`
 
 == Run
 
-   rirera <broker_name>
+   $ rirera -h
+   Options:
+     --broker, -b <s>:   choose your broker
+     --volume, -v <f>:   volume (amount of money)
+     --target, -t <f>:   target price
+     --actual, -a <f>:   actual price
+       --stop, -s <f>:   stop loss
+           --loop, -l:   start rirera in loop input mode (other options will be
+                         discarded)
+           --help, -h:   Show this message

data/bin/rirera

@@ -1,17 +1,59 @@
 #!/usr/bin/env ruby
 
 require 'rirera'
+require 'trollop'
 
-begin
-  while true do
-    system "clear"
-    rrr = Rirera.new(ARGV[0])
+def input
+  begin
+    while true do
+      system "clear"
+      rrr = Rirera.new
+      rrr.broker = rrr.get_broker(@opts[:broker])
+      print "volume: "
+      rrr.volume = rrr.sanity_check($stdin.gets)
+      print "target price: "
+      rrr.target = rrr.sanity_check($stdin.gets)
+      print "actual price: "
+      rrr.actual = rrr.sanity_check($stdin.gets)
+      loop do
+        print "stop loss: "
+        rrr.stop = rrr.stop_loss(rrr.actual, rrr.sanity_check($stdin.gets))
+        puts "stop loss has to be lower than actual price" if rrr.stop.nil?
+        break unless rrr.stop.nil?
+      end
+      rrr.print_result
+      puts ""
+      puts "Again? (y/n)"
+      exit if $stdin.gets.chomp == "n"
+      @opts.delete_if {|key,value| key != :broker }
+    end
+  rescue Interrupt => e
+      puts ""
+      abort "Exit..."
+  end
+end
+
+def main
+  @opts = Trollop::options do
+    opt :broker, "choose your broker", :short => 'b', :required => true, :type => String
+    opt :volume, "volume (amount of money)", :short => 'v', :type => Float
+    opt :target, "target price", :short => 't', :type => Float
+    opt :actual, "actual price", :short => 'a', :type => Float
+    opt :stop, "stop loss", :short => 's', :type => Float
+    opt :loop, "start rirera in loop input mode (other options will be discarded)", :short => 'l'
+  end
+
+  if @opts[:loop_given]
+    input
+  else
+    rrr = Rirera.new
+    rrr.broker = rrr.get_broker(@opts[:broker])
+    rrr.volume = @opts[:volume_given] ? @opts[:volume] : abort("missing volume")
+    rrr.target = @opts[:target_given] ? @opts[:target] : abort("missing target")
+    rrr.actual = @opts[:actual_given] ? @opts[:actual] : abort("missing actual")
+    rrr.stop = @opts[:stop_given] ? rrr.stop_loss(rrr.actual,@opts[:stop]) : abort("missing stop")
+    abort("stop loss has to be lower than actual price") if rrr.stop.nil?
     rrr.print_result
-    puts ""
-    puts "Again? (y/n)"
-    exit if $stdin.gets.chomp == "n"
   end
-rescue Interrupt => e
-    puts ""
-    puts "Exit..."
 end
+main

data/lib/rirera.rb

@@ -2,25 +2,17 @@ require 'colorize'
 require 'yaml'
 
 class Rirera
-  attr_accessor :volume, :target, :actual, :stop
+  attr_accessor :broker, :volume, :target, :actual, :stop
 
-  def initialize(broker)
-    print_title
+  def initialize
     @conf = load_config
-    @broker = get_broker(broker)
-    @volume, @target, @actual, @stop = input
-  end
-
-  def usage
-    "Usage: ./rirera broker_name"
   end
 
   def get_broker(broker)
     unless @conf['broker'][broker].nil?
       broker
     else
-      puts "Not a valid broker"
-      abort usage
+      abort "Not a valid broker"
     end
   end
 
@@ -41,8 +33,6 @@ class Rirera
     puts "|_/                  "
     puts "L___________________ "
     puts ""
-    sleep 1
-    system "clear"
   end
 
   def print_rrr
@@ -69,16 +59,16 @@ class Rirera
     YAML.load_file(File.join(File.expand_path("..", File.dirname(__FILE__)),"conf/rirera.yml"))
   end
 
-  def test_input(actual_price, stop_loss)
-    if stop_loss > actual_price
-      puts "Stop Loss has to be lower than Price"
-      false
+  def stop_loss(actual_price, stop_loss)
+    if stop_loss >= actual_price
+      nil
     else
-      true
+      stop_loss
     end
   end
 
   def sanity_check(num)
+    num.chomp!.gsub!(",",".")
     # only allow int and float
     unless is_numeric?(num)
       puts "Wrong input"
@@ -136,19 +126,4 @@ class Rirera
     ((@volume + get_total_commission) / get_amount).round(2)
   end
 
-  def input
-    print "Volume: "
-    volume = sanity_check($stdin.gets.chomp)
-    print "Target price: "
-    target = sanity_check($stdin.gets.chomp.gsub(",","."))
-    print "Price: "
-    actual = sanity_check($stdin.gets.chomp.gsub(",","."))
-    stop = 0.0
-    loop do
-      print "Stop Loss: "
-      stop = sanity_check($stdin.gets.chomp.gsub(",","."))
-      break if test_input(actual.to_f, stop.to_f)
-    end
-    [volume, target, actual, stop]
-  end
 end

data/rirera.gemspec

@@ -1,16 +1,17 @@
 Gem::Specification.new do |s|
-  s.name              = 'rirera'
-  s.version           = '0.1.3'
-  s.date              = Time.now.strftime('%Y-%m-%d')
-  s.summary           = "Risk Reward Ratio"
-  s.description       = "A simple Risk Reward Ratio calculator"
-  s.authors           = ["Maximilian Meister"]
-  s.email             = 'mmeister@suse.de'
-  s.rubyforge_project = 'rirera'
-  s.files             = `git ls-files`.split("\n")
-  s.executables       = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths     = ["lib"]
-  s.homepage          ='http://github.com/MaximilianMeister/rirera'
-  s.license           = 'MIT'
-  s.add_dependency('colorize',['~> 0.7.3', '>= 0.7.3'])
+  s.name                    = 'rirera'
+  s.version                 = '0.1.4'
+  s.date                    = Time.now.strftime('%Y-%m-%d')
+  s.summary                 = "Risk Reward Ratio"
+  s.description             = "A simple Risk Reward Ratio calculator"
+  s.authors                 = ["Maximilian Meister"]
+  s.email                   = 'mmeister@suse.de'
+  s.rubyforge_project       = 'rirera'
+  s.files                   = `git ls-files`.split("\n")
+  s.executables             = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.bindir                  = 'bin'
+  s.require_paths           = ["lib"]
+  s.homepage                = 'http://github.com/MaximilianMeister/rirera'
+  s.license                 = 'MIT'
+  s.post_install_message    = 'Happy trading!'
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rirera
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Maximilian Meister
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.3
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.3
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
+date: 2014-12-20 00:00:00.000000000 Z
+dependencies: []
 description: A simple Risk Reward Ratio calculator
 email: mmeister@suse.de
 executables:
@@ -50,7 +30,7 @@ homepage: http://github.com/MaximilianMeister/rirera
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Happy trading!
 rdoc_options: []
 require_paths:
 - lib