election_day 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97585098fe11bb7fe6cd704e9a2a77421ce7b7ce
-  data.tar.gz: cd644e4652f7b13542f943b50112a785c7242579
+  metadata.gz: aedfe7d53827fe093a8ca037083c62c9291c38b6
+  data.tar.gz: 543856fbafce3365912cd4a2eb9a4f8b66c702ff
 SHA512:
-  metadata.gz: 5bf47fda4864ddef0883018051b704aa307110d722d1e818143979a992b43122d39881f74f494b40a0e6bf3b70edb32ebf9e9843f5d35d99923b0d7283a60e1a
-  data.tar.gz: 3952543a03527fcefe83ec06fd558322e724823f04de3571e5f2453b7d6c3776f66fab53a02aaaa89717d22e42c2a30b4bd1298bac02d991b02efff2b429831a
+  metadata.gz: 1fb8b5be860eea049d66e76be1a7561c76915abde32a831c86900250cee411eb27b74db9e2937d8ac99e8960e81f8d5845091eaa4c3ebd2c95387052c1c4b0a6
+  data.tar.gz: 664047f11d41020cec55745bdaf1af85e870a5212a80b7e2bbdceeda5cab136fbfe2ec5eb16d64fdb7cb4857a99660b8221c324287a9dc95ac2330758f1c5416

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.3.0
 before_install: gem install bundler -v 1.11.2
+addons:
+  code_climate:
+    repo_token: ac00023f67d815abde2c39f89e12445fb0f688c74a114d81598865711537a4e5

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.1 (2016-10-16)
+- Improve documentation for RubyDoc
+
+## 0.1.0 (2016-10-16)
+- Initial release

data/README.md

@@ -1,6 +1,9 @@
 # Election Day
 
+[![Gem Version](https://badge.fury.io/rb/election_day.svg)](https://badge.fury.io/rb/election_day)
 [![Build Status](https://travis-ci.org/jcypret/election_day.svg?branch=master)](https://travis-ci.org/jcypret/election_day)
+[![Code Climate](https://codeclimate.com/github/jcypret/election_day/badges/gpa.svg)](https://codeclimate.com/github/jcypret/election_day)
+[![Test Coverage](https://codeclimate.com/github/jcypret/election_day/badges/coverage.svg)](https://codeclimate.com/github/jcypret/election_day/coverage)
 
 ## Installation
 

data/election_day.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Justin Cypret"]
   spec.email         = ["jcypret@gmail.com"]
 
-  spec.summary       = %q{A library extracted from raisethemoney.com to calculate Election Day.}
+  spec.summary       = %q{A library to calculate when U.S. Election Day occurs.}
   spec.homepage      = "https://github.com/jcypret/election_day"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "timecop", "~> 0.8.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/election_day.rb

@@ -1,35 +1,52 @@
 require "election_day/version"
 
+# A library to calculate when U.S. Election Day occurs.
+#
 # "The Tuesday next after the first Monday in the month of November"
 # -- The 28th Congress (http://memory.loc.gov/ll/llsl/005/0700/07590721.tif)
 module ElectionDay
 
-  # Returns `true` if current year is an election year.
+  # Checks whether year is an election year.
+  #
+  # @param year [Integer] the year to check
+  # @return [Boolean] whether year is an election year
   def self.election_year?(year = Date.today.year)
     year.even?
   end
 
-  # Returns `true` if current year is a midterm election year.
+  # Checks whether year is a midterm election year.
+  #
+  # @param year [Integer] the year to check
+  # @return [Boolean] whether year is a midterm election year
   def self.midterm_election_year?(year = Date.today.year)
     (year + 2) % 4 == 0
   end
 
-  # Returns `true` if current year is a presidential election year.
+  # Checks whether year is a presidential election year.
+  #
+  # @param year [Integer] the year to check
+  # @return [Boolean] whether year is a presidential election year
   def self.presidential_election_year?(year = Date.today.year)
     year % 4 == 0
   end
 
-  # Returns the `Date` of the next election.
+  # Returns the date of the next election.
+  #
+  # @return [Date] the date of the next election
   def self.next_election
     get_next_election(&:election_year?)
   end
 
-  # Returns the `Date` of the next midterm election.
+  # Returns the date of the next midterm election.
+  #
+  # @return [Date] the date of the next midterm election
   def self.next_midterm_election
     get_next_election(&:midterm_election_year?)
   end
 
-  # Returns the `Date` of the next presidential election.
+  # Returns the date of the next presidential election.
+  #
+  # @return [Date] the date of the next presidential election
   def self.next_presidential_election
     get_next_election(&:presidential_election_year?)
   end

data/lib/election_day/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: election_day
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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:
 - jcypret@gmail.com
@@ -76,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -107,5 +122,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A library extracted from raisethemoney.com to calculate Election Day.
+summary: A library to calculate when U.S. Election Day occurs.
 test_files: []