warpera 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb63ab53e7a723de27ebc92922ed97714743f5f88efdb9029205e8e427685e63
-  data.tar.gz: c52696cd125809c16a44e58ea6d3df5305a05d4bbdbfa590044d340268cf541b
+  metadata.gz: 3643b139db3291db0a36370efa57df460986450bed4d9d143382b09e688d6ee9
+  data.tar.gz: 683c91b283a64db1987e0c577edfb01ca3c58cfd25573d3a6bb08541ef69d66a
 SHA512:
-  metadata.gz: a982e9ee134b423f4e7c0ef83b0bb0b94b09191eb03fca07e42f9c7a5acd58bd5e675209dd265deec5d4f60878f5a4d074c0eb483f2e44725d01f0df6c660d68
-  data.tar.gz: bd6e03933665aba14fc5926b6c5f5bfe13a32095f50e1edf32762511c85d4b824194fbd4d2f24e78189078f3e1145c44a9f94838b561ae012c982c54c7a05b20
+  metadata.gz: 5925947fbfd8375aec03e94b13c00dbcd3bfd99847e645b808f30ff64f370ca2fb0c0dabdf9ba838ed61c49b473510e215764ace1799ee9fe452a6e6d9871fcd
+  data.tar.gz: 42f8865e9650da9946ad1c9d66873ba2e8baca233f0d5bd49fb453744cc047c7c25a6c7692c0e747060062d9e89cd3aef247ac3ece9242b3a2c7ac2e50cecf2a

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in erasmus.gemspec
 gemspec
-
-gem 'fivemat'

data/README.md

@@ -1,15 +1,13 @@
-# Erasmus
+# Warpera
 
-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/erasmus`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A gem that makes working with years in different eras palatable
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'erasmus'
+gem 'warpera'
 ```
 
 And then execute:
@@ -18,22 +16,45 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install erasmus
+    $ gem install warpera
 
 ## Usage
 
-TODO: Write usage instructions here
+Require the gem in your files with:
+
+```ruby
+require 'warpera'
+```
+
+When working directly with the numbers and strings, use the `conv_s` and
+`conv_i` methods.
+
+When needing control over the year and era, use the `Warpera::Pair` class. This
+is helpful, for instance, dealing with storing a year in a database. Instead of
+potentially storing two fields for one attribute, use this to store one field
+for the one attribute.
 
 ## Development
 
-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.
+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.
+
+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][1].
 
-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).
+[1]: rubygems.org/gems/warpera
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/erasmus.
+Bug reports and pull requests are welcome on [the GitHub repo][2].
+
+[2]: https://github.com/parmort/warpera
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][3]
+
+[3]: https://opensource.org/licenses/MIT.

data/lib/warpera/pair.rb

@@ -1,7 +1,20 @@
 module Warpera
+  # Pairs year and era together for better readability and DRYing
   class Pair
-    attr_accessor :year, :era
 
+    # The year as a whole number
+    # @return [Integer] the year
+    attr_accessor :year
+
+    # The era
+    # @return [:ce, :bce]
+    attr_accessor :era
+
+    ##
+    # Sets the attributes
+    #
+    # @param year [Integer] the year
+    # @param era [:ce, :bce] the era
     def initialize(year:, era:)
       @year = year
       @era = era
@@ -10,10 +23,32 @@ module Warpera
       raise ArgumentError, 'Era is not valid' unless valid_era?
     end
 
+    ##
+    # Format the year and era into a string
+    #
+    # @example Current Era
+    #   >> Warpera::Pair.new(year: 2019, era: :ce).to_s
+    #   => "2019 CE"
+    # @example Previous Era
+    #   >> Warpera::Pair.new(year: 2019, era: :bce).to_s
+    #   => "2019 BCE"
+    #
+    # @return [String] the formatted year
     def to_s
       "#{@year} #{@era.upcase}"
     end
 
+    ##
+    # Format the year and era into an integer
+    #
+    # @example Current Era
+    #   >> Warpera::Pair.new(year: 2019, era: :ce).to_s
+    #   => 2019
+    # @example Previous Era
+    #   >> Warpera::Pair.new(year: 2019, era: :bce).to_s
+    #   => -2019
+    #
+    # @return [Integer] the formatted year
     def to_i
       if @era == :bce
         return -1 * @year

data/lib/warpera/version.rb

@@ -1,3 +1,3 @@
 module Warpera
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/warpera.rb

@@ -1,8 +1,14 @@
+# Deals with years possibly spanning different eras
 module Warpera
   require 'warpera/pair'
 
+  ##
+  # Convert an integer-formatted year into a string-formatted year
+  #
+  # @param year [Integer] the integer-formatted year
+  # @return [String] the string-formatted year
   def self.conv_s(year)
-    raise ArgumentError, 'Argument is not numeric' unless year.is_a? Numeric
+    raise ArgumentError, 'Argument is not an integer' unless year.is_a? Integer
 
     if year < 0
       "#{-1 * year} BCE"
@@ -11,6 +17,11 @@ module Warpera
     end
   end
 
+  ##
+  # Convert a string-formatted year into an integer-formatted year
+  #
+  # @param year [String] the string-formatted year
+  # @return [Integer] the integer-formatted year
   def self.conv_i(year)
     raise ArgumentError, 'Argument is not a string' unless year.is_a? String
 

data/warpera.gemspec

@@ -2,26 +2,39 @@ lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "warpera/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = "warpera"
-  spec.version       = Warpera::VERSION
-  spec.authors       = ["Nolan Prochnau"]
-  spec.email         = ["parvus.mortalis@gmail.com"]
+module GemSpec
+  def self.load_git_files
+    Dir.chdir(File.expand_path('..', __FILE__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+  end
+end
 
-  spec.summary       = "A gem that makes working with years in different eras palatable"
-  spec.homepage      = "https://github.com/parmort/warpera"
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name                  = "warpera"
+  s.version               = Warpera::VERSION
+  s.author                = "Nolan Prochnau"
+  s.email                 = ["parvus.mortalis@gmail.com"]
+  s.summary               = "A gem that makes working with years in different eras palatable"
+  s.homepage              = "https://github.com/parmort/warpera"
+  s.license               = "MIT"
+  s.files                 = GemSpec.load_git_files
+  s.bindir                = "exe"
+  s.executables           = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths         = ["lib"]
+  s.required_ruby_version = '~> 2'
+  s.extra_rdoc_files      = ['README.md']
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |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"]
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/parmort/warpera/issues",
+    "changelog_uri"     => "https://github.com/parmort/warpera/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
+    "homepage_uri"      => "https://github.com/parmort/warpera",
+    "source_code_uri"   => "https://github.com/parmort/warpera"
+  }
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "bundler", "~> 2.0"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "fivemat"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: warpera
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nolan Prochnau
@@ -52,12 +52,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - parvus.mortalis@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -81,16 +96,21 @@ files:
 homepage: https://github.com/parmort/warpera
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/parmort/warpera/issues
+  changelog_uri: https://github.com/parmort/warpera/blob/master/CHANGELOG.md
+  documentation_uri: https://www.example.info/gems/bestgemever/0.0.1
+  homepage_uri: https://github.com/parmort/warpera
+  source_code_uri: https://github.com/parmort/warpera
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="