fuelator 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d77c1686b54d71b05bf14019a0836fdb1792153f
-  data.tar.gz: 8ef9a1116108e0e74f02fbc0a32d879982c32008
+SHA256:
+  metadata.gz: f14896dfaa72e8e708d299a5d9a2d92d86d26379bb146f9d4efdf0b97b02567e
+  data.tar.gz: b968191c04bfb2d9b892a635571036a52f6366239739feb3ecbbf042311e311d
 SHA512:
-  metadata.gz: 58090a226ecd35fc4e9e44a75d6e2a970ba037abc4007a635067a8ff6733c56aa23dba796a4091e01007afec4d7b05589c286be6fdb6d6eb656c08cdd90e61b7
-  data.tar.gz: 12f7ea9902bb986c56ceb814a1925afec374d6ac654789c78d07cc18c1fcafe7b80939425e9daddeb2e02a42d86f614ecfefe2de11b4abd2ee4370939d44f27c
+  metadata.gz: 4732f1251452d02ca01d76a8c710c6813c8a5c364db3fc981d5c46ea1634caf34e3b16367b84d92dbe7d71c2282b4906a9ddf2150ac1020dfe34a1754140dee9
+  data.tar.gz: 3315e505c1fb8e3227a0c7318c1d1296b892e9dcc0145bdf34c2b937f823468f4046bf54e3a0265d3815bc43d21f0889c79318382ce81b8f6c8dae0b2241a68b

data/.travis.yml

@@ -1,6 +1,14 @@
----
 language: ruby
 cache: bundler
 rvm:
-  - 2.7.1
+- 2.7.1
 before_install: gem install bundler -v 2.1.4
+deploy:
+  provider: rubygems
+  api_key:
+    secure: MoYFYQizeO0Ii291702jmbSVPUdzPUzvql3jvyaicMvQGeKFVFzlEHAUedzolUvb8hlC83MQ2PzfxRZawhv7zZuMGFbtMyxF/3PyrZLey3U9eOFuaGal/ZRl7VL8ZAILLdjTR7y3E8LnTWZDmPJBQFhJIRKYQnv1DjxHSV3JYx1eEA1HgnDGlfCALcNsGmLWPhv5aiuSfUjtkJT0EB2nGgfvsyZ9+qzLMfy9w1cXwnytDAjruwSzUnvLEjO3VA5DDIzi74kbWVEM16HIJYtq5wwf9BZ29AYRzdcev/FQwxWcCo/mVLzV1NsCCRZUeeHu8RQt2GVnNFgu/ojMdHDJTtEw8fIfQ8jmKUlD6uDriFBxc/nWaTtvTFX1aaSCV/SyeJhF7YiXF/S6+OiJbe6VMnWPehmie0YE2bMXR90BQlsNE+EcbIgdArOVMX9GMinv60rfJudQMcd4+obaVPjOtmEQEVXbbQLSNgU/qh+ZPyzJIHDgDH2Z22zqor0p5rYIdO3pTOgLnY/afTnmt6nZn2S/oCJyNMJZ8sDHzkEU8A6kpyvK3k1n8S3y0/74SeWHf9dDbWju/+QA/PFpkVcN5jqoS/djbPAJzv494ytrnNyBbgByHaEY1znFl40hjLryIWpUHo3wedQW7NmZaZtUEClZRwtwmA/jeVq/9NYDr8E=
+  gem: fuelator
+  on:
+    tags: true
+    repo: 645383/fuelator
+  skip_cleanup: 'true'

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem 'pry'

data/Gemfile.lock

@@ -1,12 +1,17 @@
 PATH
   remote: .
   specs:
-    fuelator (0.1.3)
+    fuelator (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.3)
     diff-lcs (1.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,6 +32,7 @@ PLATFORMS
 
 DEPENDENCIES
   fuelator!
+  pry
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/README.md

@@ -22,7 +22,19 @@ Or install it yourself as:
 ## Usage
 If you plan a trip to Moon, once you are at fuel station, run:
 
-    $ fuelator  28801, [[:launch, 9.807], [:land, 1.62], [:launch, 1.62], [:land, 9.807]] 
+    $ fuelator  -m 28801 -p launch,9.807 -p land,1.62 -p launch,1.62 -p land,9.807
+
+Or use API provided:
+```ruby
+require 'fuelator'
+
+Fuelator.calculate(28801, [[:launch, 9.807], [:land, 1.62], [:launch, 1.62], [:land, 9.807]])
+# => 51898
+```
+Be ready do handle errors:
+```ruby
+Fuelator::Parameters::Error
+```
 
 ## Development
 

data/bin/fuelator

@@ -1,47 +1,85 @@
 #!/usr/bin/env ruby
 
 require "fuelator"
-require 'optionparser'
+require 'optparse'
 
-def log(object)
-  STDERR.puts object
-end
+class OptsParser
+  Version = Fuelator::VERSION
+
+  class Options
+    attr_accessor :verbose, :mass, :pairs
+
+    def initialize
+      @verbose = false
+      @mass    = 0
+      @pairs   = []
+    end
+  end
 
-verbose = false
+  def self.parse
+    @options = Options.new
+    parser.parse!
+    @options
+  end
 
-optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: fuelator [args]"
+  def self.parser
+    @parser ||= OptionParser.new do |parser|
+      parser.banner = "Usage: fuelator [options]"
+      parser.separator ""
+      parser.separator "Specific options:"
 
-  opts.separator "Args sample: 28801 launch 9.807 land 1.62 launch 1.62 land 9.807"
-  opts.separator "Where 28801 - flight ship mass"
-  opts.separator "directive/gravity pairs:"
-  opts.separator "      launch - flight directive"
-  opts.separator "      1.62 -  target planet gravity"
-  opts.separator "Add as many directive/gravity pairs as you wish. Note, you can not pass 2 same directives in a sequence."
+      boolean_verbose_option parser
+      float_mass_option(parser)
+      list_pairs_option(parser)
 
-  opts.on("-v", "--verbose", "Verbose mode") do |v|
-    verbose = v
+      parser.separator ""
+      parser.separator "Common options:"
+      # No argument, shows at tail. This will print an options summary.
+      # Try it and see!
+      parser.on_tail("-h", "--help", "Show this message") do
+        puts parser
+        exit
+      end
+      # Another typical switch to print the version.
+      parser.on_tail("--version", "Show version") do
+        puts Version
+        exit
+      end
+    end
   end
-end
-optparse.parse!
 
-def run(params, verbose)
-  if params.count == 0
-    log("run `fuelator -h` for help")
-    return
+  def self.boolean_verbose_option(parser)
+    # Boolean switch.
+    parser.on("-v", "--[no-]verbose", "Show error backtrace") do |v|
+      @options.verbose = v
+    end
+  end
+
+  def self.float_mass_option(parser)
+    # Mass required float option.
+    parser.on("-m", "--mass MASS", Float, "Space ship mass") do |v|
+      @options.mass = v
+    end
+  end
+
+  def self.list_pairs_option(parser)
+    # List of arguments.
+    parser.on("-p", "--pair PAIRS", Array, "Directive/gravity comma separated pairs: -p launch,9.2 -p land,2.2") do |list|
+      list = list.map { |v| (!!Float(v) rescue false) ? v.to_f : v.to_sym }
+      @options.pairs << list
+    end
   end
-  result = Fuelator.calculate(params)
-  log "#{result.to_i} kg"
-rescue Fuelator::Error, Fuelator::Parameters::Error => e
-  log_error(e, verbose)
-rescue StandardError => e
-  log_error(e, verbose)
 end
 
-def log_error(e, verbose)
-  log e
-  log e.backtrace if verbose
-  false
+def run_script
+  options = OptsParser.parse
+  begin
+    puts "#{Fuelator::Calc.new(options.mass, options.pairs).run} kg"
+  rescue Fuelator::Parameters::Error, StandardError => e
+    puts e
+    puts e.backtrace if options.verbose
+  end
 end
 
-exit 1 unless run ARGV, verbose
+ARGV << '-h' if ARGV.empty?
+run_script

data/lib/fuelator.rb

@@ -1,56 +1,8 @@
 require "fuelator/version"
+require 'fuelator/parameters/validator'
+require 'fuelator/parameters/pair'
 require "fuelator/parameters"
-# Calculation of fuel required for flight based on input params
+require "fuelator/calc"
 
 module Fuelator
-  # Calculate fuel for a flight
-  #
-  # Example:
-  #   >> Fuelator.calculate(28801, [[:launch, 9.807], [:land, 1.62], [:launch, 1.62], [:land, 9.807]])
-  #   => 51898
-
-  class Error < StandardError; end
-
-  FLIGHT_CONSTANTS = {
-    launch: {
-      theta: 0.042,
-      bias:  33,
-    },
-    land:   {
-      theta: 0.033,
-      bias:  42,
-    },
-  }
-
-  # @param [Array] params
-  #  [123, [[:launch, 123]]] or flatten [123, :launch, 123]
-  # params are validated and validation error may be raised
-  # @return Float - fuel for a flight
-  def self.calculate(*params)
-    parameters = Parameters.new(params)
-
-    full_mass = parameters.mass
-
-    parameters.dir_grav_pairs.reverse.map do |val|
-      full_mass += recursive_calculate(full_mass, val)
-    end.last - parameters.mass
-  end
-
-  private
-
-  def self.recursive_calculate(mass, params)
-    directive = params[0]
-    gravity   = params[1]
-    constants = FLIGHT_CONSTANTS[directive]
-
-    begin
-      fuel_mass = (mass * gravity * constants[:theta] - constants[:bias]).to_i # rounded down
-    rescue StandardError => e
-      raise Error.new(e.message)
-    end
-
-    return 0 if fuel_mass <= 0
-    result = recursive_calculate(fuel_mass, params)
-    fuel_mass + result
-  end
 end

data/lib/fuelator/calc.rb

@@ -0,0 +1,46 @@
+# Calculation of fuel required for flight based on input params
+
+module Fuelator
+  # Calculate fuel for a flight
+  #
+  # Example:
+  #   >> Fuelator.Calc.new(28801, [[:launch, 9.807], [:land, 1.62], [:launch, 1.62], [:land, 9.807]]).run
+  #   => 51898
+  class Calc
+    attr_reader :parameters
+
+    FLIGHT_CONSTANTS = {
+      launch: {
+        theta: 0.042,
+        bias:  33,
+      },
+      land:   {
+        theta: 0.033,
+        bias:  42,
+      },
+    }
+
+    def initialize(mass, pairs)
+      @parameters = Parameters.new(mass, pairs)
+    end
+
+    def run
+      full_mass = parameters.mass
+
+      parameters.reversed.map do |val|
+        full_mass += recursive_calculate(full_mass, val)
+      end.last - parameters.mass
+    end
+
+    private
+
+    def recursive_calculate(mass, pair)
+      constants = FLIGHT_CONSTANTS[pair.directive]
+      fuel_mass = (mass * pair.gravity * constants[:theta] - constants[:bias]).to_i # rounded down
+
+      return 0 if fuel_mass <= 0
+      result = recursive_calculate(fuel_mass, pair)
+      fuel_mass + result
+    end
+  end
+end

data/lib/fuelator/parameters.rb

@@ -1,41 +1,48 @@
-require 'fuelator/parameters/error'
 # For flight parameters validation purposes
 
 module Fuelator
   class Parameters
-    attr_reader :mass, :dir_grav_pairs
+    include Validator
 
-    def initialize(params)
-      params          = normalize(params)
-      @mass           = params[0]
-      @dir_grav_pairs = params[1..-1].each_slice(2).to_a
+    class Error < StandardError; end
+
+    attr_reader :mass, :pairs, :order
+
+    def initialize(mass, pairs)
+      @mass  = mass
+      @pairs = pairs.map { |pair| Pair.new(pair) }
+      @order = define_order
 
       validate!
     end
 
+    def reversed
+      pairs.reverse
+    end
+
     private
 
-    def normalize(params)
-      params.flatten.map { |v| (!!Float(v) rescue false) ? v.to_f : v.to_sym }
+    def valid_mass?
+      !mass.nil? && mass.is_a?(Numeric)
     end
 
-    def validate!
-      error(:mass, mass) unless mass.is_a?(Float)
-      validate_pairs!
+    def valid_pairs?
+      !pairs.empty?
     end
 
-    def validate_pairs!
-      dir = nil
-      dir_grav_pairs.each do |pair|
-        error(:pairs, pair.count) if (pair.count % 2) != 0
-        error(:format, pair[0], pair[1]) unless pair[0].is_a?(Symbol) && pair[1].is_a?(Float)
-        error(:sequence, dir, pair[0]) if dir == pair[0] # no same directives allowed in a sequence
-        dir = pair[0]
-      end
+    def valid_order?
+      !order
     end
 
-    def error(type, *args)
-      raise Error.new Error::MESSAGES[type] % args
+    # you can only calculate if directives passed in right order - :launch->:land
+    def define_order
+      dir = nil
+      pairs.map do |pair|
+        return true if dir == pair.directive
+
+        dir = pair.directive
+      end
+      false
     end
   end
 end

data/lib/fuelator/parameters/pair.rb

@@ -0,0 +1,25 @@
+module Fuelator
+  class Parameters
+    class Pair
+      include Validator
+      DIRECTIVES = [:launch, :land]
+
+      attr_reader :directive, :gravity
+
+      def initialize(pair)
+        @directive = pair[0]
+        @gravity   = pair[1]
+
+        validate!
+      end
+
+      def valid_directive?
+        DIRECTIVES.include?(directive) && directive.is_a?(Symbol)
+      end
+
+      def valid_gravity?
+        !gravity.nil? && gravity.is_a?(Numeric)
+      end
+    end
+  end
+end

data/lib/fuelator/parameters/validator.rb

@@ -0,0 +1,15 @@
+module Fuelator
+  class Parameters
+    module Validator
+
+      # runs #valid_[variable]? method for every instance variable
+      # raises Error defined in parent namespace
+      def validate!
+        instance_variables.each do |v|
+          v_name = v.to_s.gsub(/^@/, '')
+          raise Error.new("value for #{v_name} is invalid") unless send("valid_#{v_name}?")
+        end
+      end
+    end
+  end
+end

data/lib/fuelator/version.rb

@@ -1,3 +1,3 @@
 module Fuelator
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuelator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Sergii Brytiuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies: []
 description: |-
   The goal of this application is to calculate fuel
@@ -26,10 +26,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -37,8 +35,10 @@ files:
 - bin/setup
 - fuelator.gemspec
 - lib/fuelator.rb
+- lib/fuelator/calc.rb
 - lib/fuelator/parameters.rb
-- lib/fuelator/parameters/error.rb
+- lib/fuelator/parameters/pair.rb
+- lib/fuelator/parameters/validator.rb
 - lib/fuelator/version.rb
 homepage: https://github.com/645383/fuelator
 licenses:
@@ -61,10 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: They do not trust Elon Musk any more
 test_files: []
-has_rdoc: 

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 sbrytiuk@lgscout.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 [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Sergii Brytiuk
-
-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/lib/fuelator/parameters/error.rb

@@ -1,15 +0,0 @@
-# Flight parameters validation error,
-# Add error descriptive message to map of messages when new validation case added
-
-module Fuelator
-  class Parameters
-    class Error < StandardError
-      MESSAGES = {
-        format: "directive/gravity pairs should be in format string/float: directive: %s, gravity: %s",
-        sequence: "you can not pass 2 same directives in a sequence: %s => %s",
-        mass: "mass should be float: %s",
-        pairs: "provide pairs for directive/gravity: %s elements"
-      }
-    end
-  end
-end