monthra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79f9ae5a25b04063d065b65051723f3fb3c6089e
+  data.tar.gz: eb5bf8ab4909feaf28f58db683d9fc526cd8a14b
+SHA512:
+  metadata.gz: 5626175dc02710b9ec19d2aa5ecd61fdbb585be0bd1d5695255118c3f27f5d90ec7e0cbcf24854fcfa8931096337aa1439f8268328d7dc33c77c0262b6d68dd1
+  data.tar.gz: c37f7ea73922de51e647d12541b0ba0f908609d709039af0bb00d6d7cd7c8706ab25bac74b49d816b1fc1d2fb2a7df240563566a98de3ef65452365048c9f1c8

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    monthra (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  monthra!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 jeremiah.hemphill@gmail.com
+
+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,50 @@
+# Monthra
+
+A month object that converts consistently into Date and Time objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monthra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monthra
+
+## Usage
+
+```
+# Instantiate with a year and month
+m = Monthra::Month.new(2018, 7)
+
+# Convert to a date, time, or string
+m.to_time
+m.to_date
+m.strfmonth("%Y-%m")
+
+# Convert a date, time, or string into a month
+Monthra::Month.at(Time.now)
+Monthra::Month.at(Date.today)
+Monthra::Month.strpmonth("2018-07", "%Y-%m")
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jeremiahishere/monthra.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "monthra"
+
+# 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/monthra.rb

@@ -0,0 +1,6 @@
+require "monthra/version"
+require 'monthra/month'
+
+module Monthra
+  # Your code goes here...
+end

data/lib/monthra/month.rb

@@ -0,0 +1,103 @@
+require 'date'
+require 'time'
+
+module Monthra
+  class Month
+    include Comparable
+
+    # param [Object] generic_month Must respond to month and year
+    # @return [Month]
+    def self.at(generic_month)
+      if generic_month.respond_to?(:year) && generic_month.respond_to?(:month)
+        self.new(generic_month.year, generic_month.month)
+      else
+        raise Exception("The param must have year and month methods")
+      end
+    end
+
+    # @param [String] month_str
+    # @param [String] format
+    # @return [Month]
+    def self.strpmonth(month_str, format)
+      self.at(Time.strptime(month_str, format))
+    end
+
+    # @param [Fixnum] new_year The year of the month
+    # @param [Fixnum] new_month The month of the year.  If a negative month is passed in, the year
+    #   is decremented.
+    def initialize(new_year, new_month)
+      setup_year_and_month(new_year, new_month)
+    end
+
+    # @param [Month] other_month The month to compare to
+    # @return [Fixnum] 1 if greater, 0 if equal, -1 if less
+    def <=>(other_month)
+      if year == other_month.year && month == other_month.month
+        return 0
+      elsif year > other_month.year || (year == other_month.year && month > other_month.month)
+        return 1
+      else # the current month is less
+        return -1
+      end
+    end
+
+    # @return [Fixnum] The year
+    def year
+      @year
+    end
+
+    # @return [Fixnum] The month
+    def month
+      @month
+    end
+
+    # @return [Time] The beginning of the month
+    def to_time
+      to_date.to_time
+    end
+
+    # @return [Date] The first day of the month
+    def to_date
+      Date.new(year, month, 1)
+    end
+
+    # @return [Date] The first day of the month
+    def begin_on
+      to_date
+    end
+
+    # @return [Date] The last day of the month
+    def end_on
+      Date.new(year, month, -1)
+    end
+
+    def strfmonth(format)
+      to_time.strftime(format)
+    end
+
+    # @return [String] year-month (padded)
+    def to_s
+      strfmonth("%Y-%m")
+    end
+
+    private
+
+    # if month > 12 or < -12 or == 0, raise exception
+    # if the month < 0, then subtract that number from 12 and decrement the year
+    # otherwise, just set the month and year
+    #
+    # @param [Fixnum] new_year
+    # @param [Fixnum] new_month
+    def setup_year_and_month(new_year, new_month)
+      if new_month > 12 || new_month < -12 || new_month == 0
+        raise Exception "Month out of range.  Allowable values: 1..12 and -12..-1."
+      elsif new_month < 0
+        @year = new_year - 1
+        @month = 13 + new_month
+      else
+        @year = new_year
+        @month = new_month
+      end
+    end
+  end
+end

data/lib/monthra/version.rb

@@ -0,0 +1,3 @@
+module Monthra
+  VERSION = "0.1.0"
+end

data/monthra.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "monthra/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "monthra"
+  spec.version       = Monthra::VERSION
+  spec.authors       = ["jeremiah.hemphill@gmail.com"]
+  spec.email         = ["jeremiah.hemphill@gmail.com"]
+
+  spec.summary       = %q{A month object for ruby.}
+  spec.description   = %q{It is pretty cool.}
+  spec.homepage      = "https://github.com/jeremiahishere/monthra"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: monthra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jeremiah.hemphill@gmail.com
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  prerelease: false
+  type: :development
+description: It is pretty cool.
+email:
+- jeremiah.hemphill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/monthra.rb
+- lib/monthra/month.rb
+- lib/monthra/version.rb
+- monthra.gemspec
+homepage: https://github.com/jeremiahishere/monthra
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: A month object for ruby.
+test_files: []