quarter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee89de1f0184f1a1c816f6da0f81544b04c1700325dbdfe018cedb709a73eb68
+  data.tar.gz: f5728f54665347af3b15b6396121f8667ba01488af85bccbedc62c707f67fa41
+SHA512:
+  metadata.gz: 30c126a64d3ae114d3d244722f1f32453a96782f4d6ebf4ee264087818c7b5bca5b4619bf8b7775a9fc9b12158a0d5ec4b8a1382bdf192a0f15a80b67027a23c
+  data.tar.gz: 1bc3ff80ba433d9a21982d1a5b1da2183505363bb4dc98a48c3940ef5a9edb0510e9aa4ede503e94a4989688de3a742055280ab5d4056a832d84bc0b28eab2e6

data/LICENSE.txt

@@ -0,0 +1,4 @@
+Copyright (c) 2020 TIMCRAFT
+
+This is an Open Source project licensed under the terms of the LGPLv3 license.
+Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

data/README.md

@@ -0,0 +1,32 @@
+# percentage
+
+Ruby gem for working with standard calendar quarters.
+
+
+## Install
+
+Using Bundler:
+
+    $ bundle add quarter
+
+Using RubyGems:
+
+    $ gem install quarter
+
+
+## Usage
+
+```ruby
+require 'quarter'
+
+date = Date.today
+
+quarter = Quarter(date)
+
+p quarter.start_date
+p quarter.include?(date)
+p quarter.next
+p quarter.name
+p quarter.to_s
+p quarter.iso8601
+```

data/lib/quarter.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+require 'date'
+
+class Quarter
+  def initialize(year, number)
+    unless number.between?(1, 4)
+      raise ArgumentError, 'invalid quarter number'
+    end
+
+    @year = year
+
+    @number = number
+
+    freeze
+  end
+
+  attr_reader :year
+
+  attr_reader :number
+
+  def name
+    "Q#{@number}"
+  end
+
+  def to_s
+    "Q#{@number} #{@year}"
+  end
+
+  def iso8601
+    "#{@year}-Q#{@number}"
+  end
+
+  def hash
+    iso8601.hash
+  end
+
+  def eql?(other)
+    other.class == self.class && other.hash == self.hash
+  end
+
+  def <=>(other)
+    return unless other.class == self.class
+
+    if @year == other.year
+      @number <=> other.number
+    else
+      @year <=> other.year
+    end
+  end
+
+  include Comparable
+
+  def next
+    self + 1
+  end
+
+  alias_method :succ, :next
+
+  alias_method :next_quarter, :next
+
+  def prev
+    self - 1
+  end
+
+  alias_method :prev_quarter, :prev
+
+  def step(limit, step = 1)
+    raise ArgumentError if step.zero?
+
+    return enum_for(:step, limit, step) unless block_given?
+
+    quarter = self
+
+    operator = step > 0 ? :> : :<
+
+    until quarter.public_send(operator, limit)
+      yield quarter
+
+      quarter += step
+    end
+  end
+
+  def upto(max, &block)
+    step(max, 1, &block)
+  end
+
+  def downto(min, &block)
+    step(min, -1, &block)
+  end
+
+  def +(other)
+    years, remainder = (@number - 1 + other.to_i).divmod(4)
+
+    self.class.new(@year + years, 1 + remainder)
+  end
+
+  def -(other)
+    if other.class == self.class
+      (@year * 4 + @number) - (other.year * 4 + other.number)
+    else
+      self + (-other)
+    end
+  end
+
+  def include?(date)
+    @year == date.year && @number == Quarter(date.month)
+  end
+
+  alias_method :===, :include?
+
+  def start_date
+    Date.new(@year, @number * 3 - 2, 1)
+  end
+
+  def end_date
+    Date.new(@year, @number * 3, -1)
+  end
+
+  def dates
+    start_date .. end_date
+  end
+
+  def length
+    case @number
+    when 1 then Date.gregorian_leap?(@year) ? 91 : 90
+    when 2 then 91
+    when 3, 4 then 92
+    end
+  end
+
+  def months
+    Month.new(@year, @number) .. Month.new(@year, @number + 2)
+  end
+end
+
+def Quarter(object)
+  case object
+  when Quarter
+    object
+  when Integer
+    (object / 3.0).ceil
+  else
+    Quarter.new(object.year, Quarter(object.month))
+  end
+end
+
+class Quarter
+  REGEXP = /\AQ(1|2|3|4) (\d{4})\z/i
+
+  private_constant :REGEXP
+
+  ISO8601_REGEXP = /\A(\d{4})\-Q(1|2|3|4)\z/i
+
+  private_constant :ISO8601_REGEXP
+
+  def self.parse(string)
+    case string
+    when REGEXP
+      Quarter.new($2.to_i, $1.to_i)
+    when ISO8601_REGEXP
+      Quarter.new($1.to_i, $2.to_i)
+    else
+      raise ArgumentError, 'invalid quarter string'
+    end
+  end
+end
+
+def Quarter.today
+  Quarter(Date.today)
+end
+
+def Quarter.now
+  Quarter(Time.now)
+end

data/quarter.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'quarter'
+  s.version = '1.0.0'
+  s.license = 'LGPL-3.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Craft']
+  s.email = ['mail@timcraft.com']
+  s.homepage = 'https://github.com/readysteady/quarter'
+  s.description = 'Ruby gem for working with standard calendar quarters'
+  s.summary = 'See description'
+  s.files = Dir.glob('lib/**/*.rb') + %w[LICENSE.txt README.md quarter.gemspec]
+  s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/readysteady/quarter',
+    'source_code_uri' => 'https://github.com/readysteady/quarter',
+    'bug_tracker_uri' => 'https://github.com/readysteady/quarter/issues'
+  }
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: quarter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Craft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-27 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem for working with standard calendar quarters
+email:
+- mail@timcraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/quarter.rb
+- quarter.gemspec
+homepage: https://github.com/readysteady/quarter
+licenses:
+- LGPL-3.0
+metadata:
+  homepage: https://github.com/readysteady/quarter
+  source_code_uri: https://github.com/readysteady/quarter
+  bug_tracker_uri: https://github.com/readysteady/quarter/issues
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: See description
+test_files: []