pdground 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd895af8d029eb4843845f292fe3b0a3819e1af7
-  data.tar.gz: 1c1fd6b8cc25cac891389a39de37e3dc9b197cd0
+SHA256:
+  metadata.gz: 4779c2e90e8d9f8f97a04d8b9f9b9569fba66365b8dbf712a916295525ba1fc8
+  data.tar.gz: 5d80c20d2c1ef02a3b8f283b71633cab97b6b631beb0d6fb67ff596ddab125ac
 SHA512:
-  metadata.gz: ca96d67a7f6333a4348ecf4a2dccc4a02096af9c0d7aaf7b72d18ef21419b87396b82c93e0d9a95a9d3295053fd4c373ad94d3fbf2fc15067c39c6d3cd099ee4
-  data.tar.gz: 54e22bc131abd8f110f6f9cd585e431a826ad3f5f858fbc697c47040b024a3aea3750cc621d2d7a01ac2bbf0f8e2af25f53d25bf8b7bb07eeecaee993354c2b2
+  metadata.gz: 7de4fec18be40763560de18d8ea741b194d70ca1b79054530ab427ed9c9b1db2ee87240cb22ec0d83d374647257976dcffb1d1f4d929ff5c8821dcb1393efaa0
+  data.tar.gz: 34b3b0da627f6b8d9e2505afb514e1987cde4d187d03fd90303e6c5ed7488177a96828174346833baf373f37aa951aa29dfb824717996418e4a75af326faf1d7

data/.gitlab-ci.yml

@@ -30,5 +30,6 @@ rubygems:
     name: rubygems
     url: https://rubygems.org/gems/pdground
   script:
+  - gem build pdground.gemspec
   - gem install dpl
   - dpl --provider=rubygems --api-key=$RUBYGEMS_KEY

data/.rubocop.yml

@@ -1,2 +1,4 @@
 Metrics/AbcSize:
-  Max: 20
+  Max: 20
+AllCops:
+  TargetRubyVersion: 2.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -1,8 +1,6 @@
 # Pdground
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pdground`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+PDGRound allows you to round a number with an uncertainty using the PDG rounding rules.
 
 ## Installation
 
@@ -22,22 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Pdground provides an easy to use function to round a given number with an uncertainty using the PDG rules. The rule [states the following](http://pdg.lbl.gov/2010/reviews/rpp2010-rev-rpp-intro.pdf) [Sec 5.3]:
+
+> The basic rule states that if the three highest order digits of the error lie between 100 and 354, we round to two significant digits. If they lie between 355 and 949, we round to one significant digit. Finally, if they lie between 950 and 999, we round up to 1000 and keep two significant digits. In all cases, the central value is given with a precision that matches that of the error
 
-## Development
+For example, given the value `12.2135 +- 0.03215` the rounded value reults in `12.214 +- 0.032` while for the value `12.2135 +- 0.06515` the rounded value reults in `12.21 +- 0.07`.
 
-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.
+Using `Pdground` in your code it is as simple as doing:
 
-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).
+```ruby
+require 'pdground'
+
+value = 12.2135
+error = 0.06515
+result = Pdground::round(meas: value, unc: error)
+puts "Rounded value: #{result[0]}"
+puts "Rounded error: #{result[1]}"
+# Rounded value: 12.21
+# Rounded error: 0.07 
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pdground. 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.
+If you want to contribute to improve this gem with any bug fix or new feature:
+* First open an issue to discuss the bug or feature
+* Place a merge request referring to the issue once agreed to include it
+
+Tests **must be added** to ensure maintainability.
 
 ## 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 Pdground project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pdground/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'pdground'

data/exe/pdground

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'pdground'

data/lib/pdground.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pdground/version'
 require 'pdground/extension'
 require 'pdground/pdground'

data/lib/pdground/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Redefine float with the apropriate options
 class Float
   def sigfig(digits)

data/lib/pdground/pdground.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # PDGRound module
 module PDGRound
   # Main function for the rounding

data/lib/pdground/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pdground
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'
 end

data/pdground.gemspec

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pdground/version'
@@ -28,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0'
   spec.add_development_dependency 'simplecov', '~> 0'
+
+  spec.required_ruby_version = '~> 2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdground
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - J.P. Araque
@@ -95,7 +95,6 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -118,9 +117,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -128,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Round numbers using the PDGRound rounding rules

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 jp.araque@cern.ch. 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/