monthra 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.rspec +3 -0
- data/.travis.yml +5 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +35 -0
- data/LICENSE.txt +21 -0
- data/README.md +50 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/monthra.rb +6 -0
- data/lib/monthra/month.rb +103 -0
- data/lib/monthra/version.rb +3 -0
- data/monthra.gemspec +38 -0
- metadata +101 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 79f9ae5a25b04063d065b65051723f3fb3c6089e
|
4
|
+
data.tar.gz: eb5bf8ab4909feaf28f58db683d9fc526cd8a14b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5626175dc02710b9ec19d2aa5ecd61fdbb585be0bd1d5695255118c3f27f5d90ec7e0cbcf24854fcfa8931096337aa1439f8268328d7dc33c77c0262b6d68dd1
|
7
|
+
data.tar.gz: c37f7ea73922de51e647d12541b0ba0f908609d709039af0bb00d6d7cd7c8706ab25bac74b49d816b1fc1d2fb2a7df240563566a98de3ef65452365048c9f1c8
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
monthra (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.3)
|
10
|
+
rake (10.5.0)
|
11
|
+
rspec (3.7.0)
|
12
|
+
rspec-core (~> 3.7.0)
|
13
|
+
rspec-expectations (~> 3.7.0)
|
14
|
+
rspec-mocks (~> 3.7.0)
|
15
|
+
rspec-core (3.7.1)
|
16
|
+
rspec-support (~> 3.7.0)
|
17
|
+
rspec-expectations (3.7.0)
|
18
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
19
|
+
rspec-support (~> 3.7.0)
|
20
|
+
rspec-mocks (3.7.0)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.7.0)
|
23
|
+
rspec-support (3.7.1)
|
24
|
+
|
25
|
+
PLATFORMS
|
26
|
+
java
|
27
|
+
|
28
|
+
DEPENDENCIES
|
29
|
+
bundler (~> 1.16)
|
30
|
+
monthra!
|
31
|
+
rake (~> 10.0)
|
32
|
+
rspec (~> 3.0)
|
33
|
+
|
34
|
+
BUNDLED WITH
|
35
|
+
1.16.1
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 jeremiah.hemphill@gmail.com
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Monthra
|
2
|
+
|
3
|
+
A month object that converts consistently into Date and Time objects.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'monthra'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install monthra
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```
|
24
|
+
# Instantiate with a year and month
|
25
|
+
m = Monthra::Month.new(2018, 7)
|
26
|
+
|
27
|
+
# Convert to a date, time, or string
|
28
|
+
m.to_time
|
29
|
+
m.to_date
|
30
|
+
m.strfmonth("%Y-%m")
|
31
|
+
|
32
|
+
# Convert a date, time, or string into a month
|
33
|
+
Monthra::Month.at(Time.now)
|
34
|
+
Monthra::Month.at(Date.today)
|
35
|
+
Monthra::Month.strpmonth("2018-07", "%Y-%m")
|
36
|
+
```
|
37
|
+
|
38
|
+
## Development
|
39
|
+
|
40
|
+
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.
|
41
|
+
|
42
|
+
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).
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/jeremiahishere/monthra.
|
47
|
+
|
48
|
+
## License
|
49
|
+
|
50
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "monthra"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/lib/monthra.rb
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
require 'date'
|
2
|
+
require 'time'
|
3
|
+
|
4
|
+
module Monthra
|
5
|
+
class Month
|
6
|
+
include Comparable
|
7
|
+
|
8
|
+
# param [Object] generic_month Must respond to month and year
|
9
|
+
# @return [Month]
|
10
|
+
def self.at(generic_month)
|
11
|
+
if generic_month.respond_to?(:year) && generic_month.respond_to?(:month)
|
12
|
+
self.new(generic_month.year, generic_month.month)
|
13
|
+
else
|
14
|
+
raise Exception("The param must have year and month methods")
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
# @param [String] month_str
|
19
|
+
# @param [String] format
|
20
|
+
# @return [Month]
|
21
|
+
def self.strpmonth(month_str, format)
|
22
|
+
self.at(Time.strptime(month_str, format))
|
23
|
+
end
|
24
|
+
|
25
|
+
# @param [Fixnum] new_year The year of the month
|
26
|
+
# @param [Fixnum] new_month The month of the year. If a negative month is passed in, the year
|
27
|
+
# is decremented.
|
28
|
+
def initialize(new_year, new_month)
|
29
|
+
setup_year_and_month(new_year, new_month)
|
30
|
+
end
|
31
|
+
|
32
|
+
# @param [Month] other_month The month to compare to
|
33
|
+
# @return [Fixnum] 1 if greater, 0 if equal, -1 if less
|
34
|
+
def <=>(other_month)
|
35
|
+
if year == other_month.year && month == other_month.month
|
36
|
+
return 0
|
37
|
+
elsif year > other_month.year || (year == other_month.year && month > other_month.month)
|
38
|
+
return 1
|
39
|
+
else # the current month is less
|
40
|
+
return -1
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
# @return [Fixnum] The year
|
45
|
+
def year
|
46
|
+
@year
|
47
|
+
end
|
48
|
+
|
49
|
+
# @return [Fixnum] The month
|
50
|
+
def month
|
51
|
+
@month
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [Time] The beginning of the month
|
55
|
+
def to_time
|
56
|
+
to_date.to_time
|
57
|
+
end
|
58
|
+
|
59
|
+
# @return [Date] The first day of the month
|
60
|
+
def to_date
|
61
|
+
Date.new(year, month, 1)
|
62
|
+
end
|
63
|
+
|
64
|
+
# @return [Date] The first day of the month
|
65
|
+
def begin_on
|
66
|
+
to_date
|
67
|
+
end
|
68
|
+
|
69
|
+
# @return [Date] The last day of the month
|
70
|
+
def end_on
|
71
|
+
Date.new(year, month, -1)
|
72
|
+
end
|
73
|
+
|
74
|
+
def strfmonth(format)
|
75
|
+
to_time.strftime(format)
|
76
|
+
end
|
77
|
+
|
78
|
+
# @return [String] year-month (padded)
|
79
|
+
def to_s
|
80
|
+
strfmonth("%Y-%m")
|
81
|
+
end
|
82
|
+
|
83
|
+
private
|
84
|
+
|
85
|
+
# if month > 12 or < -12 or == 0, raise exception
|
86
|
+
# if the month < 0, then subtract that number from 12 and decrement the year
|
87
|
+
# otherwise, just set the month and year
|
88
|
+
#
|
89
|
+
# @param [Fixnum] new_year
|
90
|
+
# @param [Fixnum] new_month
|
91
|
+
def setup_year_and_month(new_year, new_month)
|
92
|
+
if new_month > 12 || new_month < -12 || new_month == 0
|
93
|
+
raise Exception "Month out of range. Allowable values: 1..12 and -12..-1."
|
94
|
+
elsif new_month < 0
|
95
|
+
@year = new_year - 1
|
96
|
+
@month = 13 + new_month
|
97
|
+
else
|
98
|
+
@year = new_year
|
99
|
+
@month = new_month
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
data/monthra.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "monthra/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "monthra"
|
8
|
+
spec.version = Monthra::VERSION
|
9
|
+
spec.authors = ["jeremiah.hemphill@gmail.com"]
|
10
|
+
spec.email = ["jeremiah.hemphill@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{A month object for ruby.}
|
13
|
+
spec.description = %q{It is pretty cool.}
|
14
|
+
spec.homepage = "https://github.com/jeremiahishere/monthra"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
if spec.respond_to?(:metadata)
|
20
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
21
|
+
else
|
22
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
23
|
+
"public gem pushes."
|
24
|
+
end
|
25
|
+
|
26
|
+
# Specify which files should be added to the gem when it is released.
|
27
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
28
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
29
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
30
|
+
end
|
31
|
+
spec.bindir = "exe"
|
32
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
33
|
+
spec.require_paths = ["lib"]
|
34
|
+
|
35
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
36
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
37
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
38
|
+
end
|
metadata
ADDED
@@ -0,0 +1,101 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: monthra
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- jeremiah.hemphill@gmail.com
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-07-13 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
version_requirements: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
requirement: !ruby/object:Gem::Requirement
|
21
|
+
requirements:
|
22
|
+
- - "~>"
|
23
|
+
- !ruby/object:Gem::Version
|
24
|
+
version: '1.16'
|
25
|
+
prerelease: false
|
26
|
+
type: :development
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
35
|
+
requirements:
|
36
|
+
- - "~>"
|
37
|
+
- !ruby/object:Gem::Version
|
38
|
+
version: '10.0'
|
39
|
+
prerelease: false
|
40
|
+
type: :development
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
version_requirements: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
requirements:
|
50
|
+
- - "~>"
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: '3.0'
|
53
|
+
prerelease: false
|
54
|
+
type: :development
|
55
|
+
description: It is pretty cool.
|
56
|
+
email:
|
57
|
+
- jeremiah.hemphill@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".rspec"
|
64
|
+
- ".travis.yml"
|
65
|
+
- Gemfile
|
66
|
+
- Gemfile.lock
|
67
|
+
- LICENSE.txt
|
68
|
+
- README.md
|
69
|
+
- Rakefile
|
70
|
+
- bin/console
|
71
|
+
- bin/setup
|
72
|
+
- lib/monthra.rb
|
73
|
+
- lib/monthra/month.rb
|
74
|
+
- lib/monthra/version.rb
|
75
|
+
- monthra.gemspec
|
76
|
+
homepage: https://github.com/jeremiahishere/monthra
|
77
|
+
licenses:
|
78
|
+
- MIT
|
79
|
+
metadata:
|
80
|
+
allowed_push_host: https://rubygems.org
|
81
|
+
post_install_message:
|
82
|
+
rdoc_options: []
|
83
|
+
require_paths:
|
84
|
+
- lib
|
85
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
91
|
+
requirements:
|
92
|
+
- - ">="
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: '0'
|
95
|
+
requirements: []
|
96
|
+
rubyforge_project:
|
97
|
+
rubygems_version: 2.4.8
|
98
|
+
signing_key:
|
99
|
+
specification_version: 4
|
100
|
+
summary: A month object for ruby.
|
101
|
+
test_files: []
|