rounder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 006a2a788e8b37b198eae0d38d0a0d02e4f27e9ea5dbf1b14804d3cca87bbf54
+  data.tar.gz: 15cbcd31bdb2588420cb3bc5665174cd665db90f8e40ad55f19eb00814a6cb3e
+SHA512:
+  metadata.gz: 6a4ce4c8ea3b8e6af224aa81ee4c75eceb425cc5793f557087f88f72047b5442181e5a740099ee9b010e799e10a49093b2f3bdcdaeafffe25d89259cd729412b
+  data.tar.gz: 1e91010df8669b64ee9c1b855383c8a3c63b788edf6302cc06905a8eaa618540ed09ec4fae3161b1777ed487fa68503f8c1e17be8c533ce5e43f0e8bf9818035

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+- 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: f8aRhdUEU6Tmz3cq8v8s3bjr9UuFDOlEo5YZ/4qhOK/zglOFTdEJQZA58jNp+F1jz7qXZ+JZev1D8qB8avDW0qbpjrMHLiK0A68CtFg2q7QzJ18dC38zJVXOroqSKgeK6lC8cgcpCFZHPcuDIfCaIJ1Z4LiPQ937c+LpdMUAxV6zliaJXy12CHbjeYDvDXN/994Y80W/qxznGWElpNnv+Xca3u3XmMCcPG9svzRNbt97QlskiBVp943pieb5XMs9IK50vnKG2SaGlJdgBLNeLIMYuUH3ejfjX+fXFM4FjwJdkOWbs4RVkflw1Yyh+9ikIqu6LDaSxRuMKmCZ3vFC91ZeIa4uh/H4zhadZtinHkBCRJcdCdxH/zpbqSbPmFiqoMCpUov9f/BXSj2ZDe9QPLrl6VybBS5IPLLy15d3x/4fV1woAgsVGmyENazgZchk2QTVE8uSHsOe7wxB6iBIMFNLtlBIdDlw9dJ9VBXMbeW/rsD5haKmENMOmPvolys0W7XYSBi8D1VU5JKin6q5V+nKlKevZ9tDP+9ppEI/wpM15KQ42VOvxS7JK8DEJSvmoXp1zIKlj33yXnaqlz1JPBnMBD4wo70A19fOiSPzQo+JN28cnCAw5Irm/Y5pXZe3YfqBQpTDYXOevmN56LBVLa18WUg0j1KgCL54mqwBANo=
+  gem: rounder
+  on:
+    tags: true
+    repo: yuriyalekseyev/rounder

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 dev.yuriy.a@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/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+We love contributions from everyone.
+By participating in this project,
+you agree to abide by the [Code of Conduct].
+
+  [code of conduct]: https://github.com/yuriyalekseyev/round_to/blob/master/CODE_OF_CONDUCT.md
+
+## Contributing Code
+
+1. [Fork] a repo.
+
+    [fork]: https://github.com/yuriyalekseyev/round_to/fork
+
+2. Install dependencies.
+    
+        bundle install
+    
+3. Create your feature branch.
+    
+        git checkout -b my-new-feature
+
+4. Make sure the tests pass:
+        
+        rspec
+    
+    There is also a command to load up a REPL for playing around.
+    
+        bin/console
+    
+5. Make your change, with new passing tests.
+Write a [good commit message].  
+  
+    [good commit message]: https://github.com/erlang/otp/wiki/Writing-good-commit-messages
+    
+        git commit -am 'Add some feature'
+    
+6. Push to your fork.  
+    
+        git push origin my-new-feature
+
+7. Create a new [Pull Request].
+
+    [pull request]: https://github.com/yuriyalekseyev/round_to/pulls
+
+Others will give constructive feedback.
+
+This is a time for discussion and improvements,
+and making the necessary changes will be required before we can
+merge the contribution.

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rounder (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15, >= 1.15.4)
+  rake (~> 10.0)
+  rounder!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuriy Alekseyev
+
+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,131 @@
+# Rounder
+
+[![Gem Version](https://badge.fury.io/rb/rounder.svg)](https://badge.fury.io/rb/rounder)
+[![Build Status](https://travis-ci.org/yuriyalekseyev/rounder.svg?branch=master)](https://travis-ci.org/yuriyalekseyev/rounder)
+
+Rounds any numeric value to any nearest multiple of the chosen step.
+
+Returns value of the same type as the input argument.
+
+For example:
+```ruby
+require 'rounder'
+
+17.round_to(10)               # => 20
+17.round_to(10.0)             # => 20.0
+
+9.47.floor_to(2.5)            # => 7.5
+
+101.ceil_to(25)               # => 125
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rounder'
+```
+
+And then execute:
+
+    bundle
+
+Or install the gem:
+
+    gem install rounder
+
+## Usage
+
+Require the gem: 
+
+```ruby
+require 'rounder'
+```
+
+There are three methods added to all Numeric objects: `#round_to`, `#floor_to`, and `#ceil_to`.
+
+`#round_to` rounds to the nearest multiple of the chosen step.
+
+```ruby
+54.round_to(100)  # => 100
+1.4.round_to(3)   # => 0
+1.5.round_to(3)   # => 3
+1.6.round_to(3)   # => 3
+-8.round_to(3)    # => -9
+```
+
+`#floor_to` rounds down to a multiple of the chosen step.
+
+```ruby
+299.floor_to(100)  # => 200
+1.81.floor_to(0.5) # => 1.5
+60.floor_to(15)    # => 60
+-8.floor_to(3)     # => -9
+```
+
+`#ceil_to` rounds up to a multiple of the chosen step.
+
+```ruby
+201.ceil_to(100)  # => 300
+1.71.ceil_to(0.5) # => 2.0
+60.ceil_to(15)    # => 60
+-8.ceil_to(3)     # => -6
+```
+
+Returned value type depends on the argument type.
+
+```ruby
+21.round_to(10)     # => 20
+21.round_to(10.0)   # => 20.0
+21.0.round_to(10)   # => 20
+21.0.round_to(10.0) # => 20.0
+```
+
+If you provide zero as an argument, Rounder returns unaltered value.
+
+```ruby
+21.round_to(0)     # => 21
+21.round_to(0.0)   # => 21.0
+```
+
+If negative step is provided, Rounder will use it absolute value
+
+```ruby
+4.round_to(2)     # => 4
+4.round_to(-2)    # => 4
+```
+
+RoundTo uses BigDecimal, so calculations are fairly precise
+
+```ruby
+2.round_to(0.0000000006)        # => 1.9999999998
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+[Bug Reports] and [Pull Requests] are welcome on [GitHub Project page]. 
+
+  [github project page]: https://github.com/yuriyalekseyev/rounder
+  [bug reports]: https://github.com/yuriyalekseyev/rounder/issues
+  [pull requests]: https://github.com/yuriyalekseyev/rounder/pulls
+
+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.
+
+Please read the [CONTRIBUTING.md] for details on our code of conduct, and the process for submitting pull requests to us.
+
+  [contributing.md]: https://github.com/yuriyalekseyev/rounder/blob/master/CONTRIBUTING.md
+
+## License
+
+The gem is available as open source under the terms of the [MIT License].
+
+  [MIT License]: https://opensource.org/licenses/MIT
+
+## Code of Conduct
+
+Everyone interacting in the Rounder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [Code of Conduct](https://github.com/yuriyalekseyev/rounder/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 'round_to'
+
+# 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/rounder.rb

@@ -0,0 +1,2 @@
+require 'rounder/version'
+require 'rounder/core'

data/lib/rounder/core.rb

@@ -0,0 +1,63 @@
+require 'bigdecimal'
+
+# Rounds any numeric value to any nearest multiple of the chosen step.
+# Returns value of the same type as the input argument.
+module Rounder
+  # Rounds down to a multiple of the chosen step.
+  #
+  # @example
+  #   99.floor_to(10) # => 90
+  #
+  # @param step [Numeric] chosen step.
+  # @return [Numeric]
+  def floor_to(step)
+    basic_rounding(step) do |result, step_decimal|
+      result > self ? result - step_decimal : result
+    end
+  end
+
+  # Rounds up to a multiple of the chosen step.
+  #
+  # @example
+  #   101.ceil_to(10) # => 110
+  #
+  # @param step [Numeric] chosen step.
+  # @return [Numeric]
+  def ceil_to(step)
+    basic_rounding(step) do |result, step_decimal|
+      result < self ? result + step_decimal : result
+    end
+  end
+
+  # Rounds to the nearest multiple of the chosen step.
+  #
+  # @example
+  #   101.round_to(10) # => 100
+  #
+  # @param step [Numeric] chosen step.
+  # @return [Numeric]
+  def round_to(step)
+    basic_rounding(step)
+  end
+
+  private
+
+  def basic_rounding(step)
+    check_argument_type(step)
+    return self if step.zero?
+    step_decimal = BigDecimal(step.abs.to_s)
+    result       = step_decimal * (self / step_decimal).round
+    result       = yield(result, step_decimal) if block_given?
+    step.class == Integer ? result.to_i : result.to_f
+  end
+
+  def check_argument_type(arg)
+    error_message = 'This method accepts only numeric values'
+    raise ArgumentError, error_message unless arg.is_a?(Numeric)
+  end
+end
+
+# The top-level number class.
+class Numeric
+  include Rounder
+end

data/lib/rounder/version.rb

@@ -0,0 +1,4 @@
+module Rounder
+  # Version of the gem
+  VERSION = '1.0.0'
+end

data/rounder.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rounder/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'rounder'
+  spec.version = Rounder::VERSION
+  spec.authors = ['Yuriy Alekseyev']
+  spec.email   = ['dev.yuriy.a@gmail.com']
+
+  spec.summary     = 'Better rounding in Ruby'
+  spec.description = 'Rounds any numeric value to any nearest multiple of the chosen step.'
+  spec.homepage    = 'https://github.com/yuriyalekseyev/rounder'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.15', '>= 1.15.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.required_ruby_version = '>= 2.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rounder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuriy Alekseyev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-25 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !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'
+description: Rounds any numeric value to any nearest multiple of the chosen step.
+email:
+- dev.yuriy.a@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rounder.rb
+- lib/rounder/core.rb
+- lib/rounder/version.rb
+- rounder.gemspec
+homepage: https://github.com/yuriyalekseyev/rounder
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Better rounding in Ruby
+test_files: []