human_time 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c2a82065b646a888faea7199f766707515a31648
4
+ data.tar.gz: 45ae17dff0ba5f66c5d43d21bac6cf31d0bd9119
5
+ SHA512:
6
+ metadata.gz: c49360aa332a2519a85668198a0efa237a0fb7d434a6817a5a76785e7128b12f02d09757748640d67da7c693d4970cdd24a3958ed42bfb4c0389f02f25e3bea7
7
+ data.tar.gz: 94d4a7ab2514e2a91093fc735bdd19190e1716b9b4fad915afcc02b3a70e11ee13d988d2a6626cc991232110d17dec7672725e4559a870bea6f846461ef41609
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at allenan@helium.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in human_time.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Andrew Allen
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,99 @@
1
+ # human_time
2
+
3
+ Ruby time and date comparisons for humans. Have you ever struggled to understand what a piece of code like this is trying to say?
4
+
5
+ ```ruby
6
+ some_time > another_time
7
+ ```
8
+
9
+ It should be simple, but our brains don't think in terms of "greater than" or "less than" when it comes to times and dates.
10
+
11
+ human_time lets you express time comparison the way your human brain thinks:
12
+
13
+ ```ruby
14
+ some_time.more_recent_than?(another_time)
15
+ ```
16
+
17
+ It also includes some synonyms so you can word it in a way that makes sense to your human brain:
18
+
19
+ ```ruby
20
+ some_time.newer_than?(another_time)
21
+ some_time.comes_after?(another_time)
22
+ ```
23
+
24
+ For a complete list of expressions, see the 'Usage' section below.
25
+
26
+
27
+ ## Installation
28
+
29
+ Add this line to your application's Gemfile:
30
+
31
+ ```ruby
32
+ gem 'human_time'
33
+ ```
34
+
35
+ And then execute:
36
+
37
+ $ bundle
38
+
39
+ Or install it yourself as:
40
+
41
+ $ gem install human_time
42
+
43
+ ## Usage
44
+
45
+ human_time simply adds aliases for the `>`, `>=`, `<` and `<=` methods on the `Date`, `Time` and `DateTime` classes.
46
+
47
+ ```ruby
48
+ older_date = Date.parse('2016-01-01')
49
+ newer_date = Date.parse('2016-01-02')
50
+
51
+ older_date < newer_date
52
+ # => true
53
+
54
+ older_date.older_than?(newer_date)
55
+ # => true
56
+
57
+ newer_date > older_date
58
+ # => true
59
+
60
+ newer_date.newer_than?(older_date)
61
+ # => true
62
+ ```
63
+
64
+ ### `>` aliases
65
+
66
+ - `newer_than?`
67
+ - `more_recent_than?`
68
+ - `comes_after?`
69
+
70
+ ### `>=` aliases
71
+
72
+ - `newer_than_or_equal_to?`
73
+ - `more_recent_than_or_equal_to?`
74
+ - `after_or_equal_to?`
75
+
76
+ ### `<` aliases
77
+
78
+ - `older_than?`
79
+ - `comes_before?`
80
+
81
+ ### `<=` aliases
82
+
83
+ - `older_than_or_equal_to?`
84
+ - `before_or_equal_to?`
85
+
86
+ ## Development
87
+
88
+ 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.
89
+
90
+ 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).
91
+
92
+ ## Contributing
93
+
94
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/human_time. 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.
95
+
96
+
97
+ ## License
98
+
99
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,34 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "human_time"
5
+
6
+ class Object
7
+ def older_date
8
+ Date.parse('2016-01-01')
9
+ end
10
+
11
+ def newer_date
12
+ Date.parse('2016-01-02')
13
+ end
14
+
15
+ def older_time
16
+ Time.parse('2016-01-01')
17
+ end
18
+
19
+ def newer_time
20
+ Time.parse('2016-01-02')
21
+ end
22
+
23
+ def older_datetime
24
+ DateTime.parse('2016-01-01')
25
+ end
26
+
27
+ def newer_datetime
28
+ DateTime.parse('2016-01-02')
29
+ end
30
+ end
31
+
32
+ # (If you use this, don't forget to add pry to your Gemfile!)
33
+ require "pry"
34
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'human_time/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "human_time"
8
+ spec.version = HumanTime::VERSION
9
+ spec.authors = ["Andrew Allen"]
10
+ spec.email = ["andrew@allenan.com"]
11
+
12
+ spec.summary = %q{Ruby time and date comparisons for humans}
13
+ spec.description = %q{Ruby time and date comparisons for humans}
14
+ spec.homepage = "https://github.com/allenan/human_time"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.12"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec", "~> 3.0"
25
+ spec.add_development_dependency "pry", "~> 0.10.4"
26
+ spec.add_development_dependency "awesome_print", "~> 1.7.0"
27
+ end
@@ -0,0 +1,3 @@
1
+ module HumanTime
2
+ VERSION = "0.1.0"
3
+ end
data/lib/human_time.rb ADDED
@@ -0,0 +1,36 @@
1
+ require 'date'
2
+ require 'time'
3
+
4
+ require "human_time/version"
5
+
6
+ module HumanTime
7
+ def self.greater_than_aliases
8
+ %w{newer_than? more_recent_than? comes_after?}
9
+ end
10
+
11
+ def self.greater_than_or_equal_to_aliases
12
+ %w{newer_than_or_equal_to? more_recent_than_or_equal_to? after_or_equal_to?}
13
+ end
14
+
15
+ def self.less_than_aliases
16
+ %w{older_than? comes_before?}
17
+ end
18
+
19
+ def self.less_than_or_equal_to_aliases
20
+ %w{older_than_or_equal_to? before_or_equal_to?}
21
+ end
22
+ end
23
+
24
+ class Date
25
+ HumanTime.greater_than_aliases.each{ |ali| alias_method ali, :> }
26
+ HumanTime.greater_than_or_equal_to_aliases.each{ |ali| alias_method ali, :>= }
27
+ HumanTime.less_than_aliases.each{ |ali| alias_method ali, :< }
28
+ HumanTime.less_than_or_equal_to_aliases.each{ |ali| alias_method ali, :<= }
29
+ end
30
+
31
+ class Time
32
+ HumanTime.greater_than_aliases.each{ |ali| alias_method ali, :> }
33
+ HumanTime.greater_than_or_equal_to_aliases.each{ |ali| alias_method ali, :>= }
34
+ HumanTime.less_than_aliases.each{ |ali| alias_method ali, :< }
35
+ HumanTime.less_than_or_equal_to_aliases.each{ |ali| alias_method ali, :<= }
36
+ end
metadata ADDED
@@ -0,0 +1,127 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: human_time
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrew Allen
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-08-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.10.4
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.10.4
69
+ - !ruby/object:Gem::Dependency
70
+ name: awesome_print
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 1.7.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 1.7.0
83
+ description: Ruby time and date comparisons for humans
84
+ email:
85
+ - andrew@allenan.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - human_time.gemspec
101
+ - lib/human_time.rb
102
+ - lib/human_time/version.rb
103
+ homepage: https://github.com/allenan/human_time
104
+ licenses:
105
+ - MIT
106
+ metadata: {}
107
+ post_install_message:
108
+ rdoc_options: []
109
+ require_paths:
110
+ - lib
111
+ required_ruby_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ required_rubygems_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ requirements: []
122
+ rubyforge_project:
123
+ rubygems_version: 2.5.1
124
+ signing_key:
125
+ specification_version: 4
126
+ summary: Ruby time and date comparisons for humans
127
+ test_files: []