month_year 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01b15d9956e7fae917685ceb3532c8bd05e40109
+  data.tar.gz: ca5d222878850f017a1bf2ce57fffc0861ef5394
+SHA512:
+  metadata.gz: e9690972ec5c71d1b10b87eb3d810d23c61603f112ad67c24a6d4167785aa552adae7a2e159b3ada9106ce61ba444f04490724b8cb0dad0a713787cd2b51c42e
+  data.tar.gz: 8c33f16dac9420f1ee03a96f8ed4310908a4adb2bdb4baae92a280e03f774e2fa846d4eaa2efffabb57df184d570985bb429aa84dc8dc8049d803f617a133cd4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+
+script: 'bundle exec rake'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in month_year.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Daniel Illi
+
+MIT License
+
+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,38 @@
+# MonthYear
+
+A MonthYear represents a specific month in a specific year.
+It implements comparison operations, can be used to create ranges, (de-)serializes to/from Integer and can
+be used for attributes of ActiveRecord Models.
+
+Inspired by a [blog post](blog post) by [Robert Pankowecki](https://github.com/paneq/). Thanks!
+
+[![Build Status](https://travis-ci.org/daniel-illi/month_year.svg?branch=master)](https://travis-ci.org/daniel-illi/month_year)
+[![Coverage Status](https://coveralls.io/repos/github/daniel-illi/month_year/badge.svg?branch=master)](https://coveralls.io/github/daniel-illi/month_year?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'month_year'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install month_year
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/daniel-illi/month_year/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/month_year.rb

@@ -0,0 +1,118 @@
+require 'month_year/version'
+
+class MonthYear
+
+  attr_reader :year, :month
+
+  class << self
+    # Instantiate a `MonthYear` object from a `Date`-like object
+    # (a `Date` or `Time` instance,
+    # or in fact from any object responding to :year and :month).
+    #
+    # Example:
+    #   >> MonthYear.from_date(Date.today)
+    #   => #<MonthYear:0x00000001f15c10 @month=12, @year=2016>
+    #
+    # Arguments:
+    #   date: (Date)
+    #
+    def from_date(date)
+      raise ArgumentError unless [:year, :month].all? {|v| date.respond_to?(v) }
+      self.new(date.year, date.month)
+    end
+
+    def load(month_year)
+      raise_load_error(month_year) unless month_year.is_a?(Integer)
+      year = month_year / 100
+      month = month_year % 100
+      self.new(year, month)
+    end
+
+    def dump(month_year)
+      raise_dump_error(month_year) unless month_year.is_a?(self)
+      month_year.to_i
+    end
+  end
+
+  # Instantiate a new `MonthYear` object.
+  #
+  # Example:
+  #   >> MonthYear.new(2016, 12)
+  #   => #<MonthYear:0x00000001f15c10 @month=12, @year=2016>
+  #
+  # Arguments:
+  #   year: (Integer)
+  #   month: (Integer)
+  #
+  def initialize(year, month)
+    raise ArgumentError unless [year, month].all? {|v| Fixnum === v }
+    raise ArgumentError unless (1..12).cover?(month)
+    @year, @month = year, month
+  end
+
+  def ==(other)
+    other.class == self.class && (self <=> other) == 0
+  end
+  alias_method :eql?, :==
+
+  def <=>(other)
+    (year <=> other.year).nonzero? || month <=> other.month
+  end
+
+  def hash
+    to_i.hash
+  end
+
+  def succ
+    if month == 12
+      self.class.new(year+1, 1)
+    else
+      self.class.new(year, month+1)
+    end
+  end
+  alias_method :next, :succ
+
+  # Return the numeric representation of this `MonthYear` instance.
+  #
+  # Example:
+  #   >> MonthYear.new(2016, 12).to_i
+  #   => 201612
+  #
+  def to_i
+    year * 100 + month
+  end
+
+  # Return the string representation of this `MonthYear` instance.
+  #
+  # Example:
+  #   >> MonthYear.new(2016, 12).to_s
+  #   => "2016-12"
+  #
+  def to_s
+    "#{year}-#{month}"
+  end
+
+  protected
+
+  def state
+    [year, month]
+  end
+
+  private
+
+  def active_record?
+    Object.const_defined?(::ActiveRecord::SerializationTypeMismatch)
+  end
+
+  def argument_error_class
+    active_record? ? ::ActiveRecord::SerializationTypeMismatch : ArgumentError
+  end
+
+  def throw_load_error(obj)
+    raise argument_error_class, "Argument was supposed to be an Integer, but was a #{obj.class}. -- #{obj.inspect}"
+  end
+
+  def throw_dump_error(obj)
+    raise argument_error_class, "Argument was supposed to be a #{self}, but was a #{obj.class}. -- #{obj.inspect}"
+  end
+end

data/lib/month_year/version.rb

@@ -0,0 +1,3 @@
+class MonthYear
+  VERSION = "0.0.1"
+end

data/month_year.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'month_year/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "month_year"
+  spec.version       = MonthYear::VERSION
+  spec.authors       = ["Daniel Illi"]
+  spec.email         = ["daniel@illi.zone"]
+  spec.summary       = %q{MonthYear represents a specific month in a specific year.}
+  spec.description   = <<-DESC
+A MonthYear instance represents a specific month in a specific year.
+It implements comparison operations, can be used to create ranges, (de-)serializes to/from Integer and can
+be used for attributes of ActiveRecord Models.
+  DESC
+  spec.homepage      = "https://github.com/daniel-illi/month_year"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry"
+end

data/spec/year_month_spec.rb

@@ -0,0 +1,46 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'month_year'
+require 'pry'
+
+describe MonthYear do
+  let(:date){ Date.new(2001, 2, 3) }
+  let(:time){ Time.new(2001, 2, 3, 4, 5, 6, "+01:00") }
+  let(:month_year){ MonthYear.new(2001, 2) }
+
+  context "::from_date" do
+    it 'instantiates with date argument' do
+      month_year = MonthYear.from_date(date)
+      expect(month_year.year).to eq(date.year)
+      expect(month_year.month).to eq(date.month)
+    end
+
+    it 'instantiates with time argument' do
+      month_year = MonthYear.from_date(time)
+      expect(month_year.year).to eq(time.year)
+      expect(month_year.month).to eq(time.month)
+    end
+
+    it 'thows error with string argument' do
+      expect { MonthYear.from_date('200102') }.to raise_error(ArgumentError)
+    end
+  end
+
+  it '::dump returns numeric value' do
+    expect(MonthYear.dump(month_year)).to eq(month_year.to_i)
+  end
+
+  it '::load instantiates from numeric value' do
+    expect(MonthYear.load(month_year.to_i)).to eq(month_year)
+  end
+
+  it '#eql?'
+  it '#=='
+  it '#<=>'
+  it '#hash'
+  it '#succ'
+  it '#next'
+  it '#to_i'
+  it '#to_s'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: month_year
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Illi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |
+  A MonthYear instance represents a specific month in a specific year.
+  It implements comparison operations, can be used to create ranges, (de-)serializes to/from Integer and can
+  be used for attributes of ActiveRecord Models.
+email:
+- daniel@illi.zone
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/month_year.rb
+- lib/month_year/version.rb
+- month_year.gemspec
+- spec/year_month_spec.rb
+homepage: https://github.com/daniel-illi/month_year
+licenses:
+- MIT
+metadata: {}
+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.5.2
+signing_key: 
+specification_version: 4
+summary: MonthYear represents a specific month in a specific year.
+test_files:
+- spec/year_month_spec.rb