chronik 0.1.0

data/README.md

@@ -0,0 +1,62 @@
+Chronik
+=======
+
+Chronik is a very small library used to translate dates' classes, as seen on
+public transport timetables, like "Weekdays" or "Easter and Christmas", to
+actual dates (or weekdays if it directly relates to them). It is inspired by
+[mojombo/chronic](https://github.com/mojombo/chronic).
+
+Instalation
+-----------
+
+    gem install chronik
+
+Usage
+-----
+
+Most basic usage: translate day(s) of the week to integer (from 0 to 6)
+
+    require 'chronik'
+    label = Chronik::Label.new "Soboty" # Polish word for Saturday
+    label.weekdays #=> [6]
+
+Slightly more complicated: get the dates of given holidays. Since holidays are
+repeted every once in a year and we don't want an infinite array, we need to
+specify a date range.
+
+    require 'chronik'
+    require 'date'
+    range = Date.new(2011,1,1)..Date.new(2011,12,31)
+    label = Chronik::Label.new "Wielkanoc" # Polish word for Easter
+    label.holidays(range) #=> [Date.new(2011,4,24), Date.new(2011,4,25)]
+
+Limitations
+-----------
+
+Currently only Polish language is supported, but it is super easy to add
+another language. Look for constants in
+[lib/chronik/chronik.rb](http://github.com/stanley/chronik/tree/master/lib/chronik/chronik.rb)
+file.
+
+License
+-------
+
+Copyright (C) 2011 by Stanisław Wasiutyński
+
+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/lib/chronik.rb

@@ -0,0 +1,8 @@
+$:.unshift File.dirname(__FILE__) # For testing
+
+# stdlib
+require 'date'
+
+# internals
+require 'chronik/chronik'
+require 'chronik/label'

data/lib/chronik/chronik.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+module Chronik
+  class << self
+
+    private
+
+    # The Easter Sunday in the given year
+    #
+    # year - [integer]
+    #
+    # Returns Date
+    def easter(year)
+      c = year/100
+      n = year-19*(year/19)
+      k = (c-17)/25 
+      i = c-c/4-(c-k)/3+19*n+15
+      i = i-30*(i/30) 
+      i = i-(i/28)*(1-(i/28)*(29/(i+1))*((21-n)/11)) 
+      j = year+year/4+i+2-c+c/4 
+      j = j-7*(j/7) 
+      l = i-j 
+      month = 3+(l+40)/44 
+      day = l+28-31*(month/4) 
+
+      Date.new year, month, day
+    end
+
+    # Defines dates relative to Easter.
+    #
+    # holidays - [Integer] or [Range]: offset in regard to Easter.
+    #
+    # Returns Proc.
+    def easter_dates(holidays=0)
+      holidays = [holidays] unless holidays.respond_to?(:map)
+      dates(lambda{|year| holidays.map{|offset| easter(year) + offset} })
+    end
+
+    # Defines one day of a year without specifying the year itself.
+    #
+    # month - [Integer]
+    # day   - [Integer]
+    #
+    # Returns Proc.
+    def fixed_dates(month, day)
+      dates(lambda{|year| Date.new(year, month, day) })
+    end
+
+    # Defines an infinite number of days, which can be retrieved by calling
+    # a block, returned by this method, with time range as an argument.
+    #
+    # days - [Proc]: calling it with a year should return a Date instance.
+    #
+    # Returns Proc.
+    def dates(days)
+      lambda do |range|
+        (range.first.year..range.last.year).map do |year|
+          days.call(year)
+        end.flatten.grep(range)
+      end
+    end
+  end
+
+  SUGAR = [:dni, :i, :w]
+
+  ALL_HOLIDAYS = [:'święta', :wolne]
+
+  HOLIDAYS = {
+    [:wielkanoc, :wielkanocy] => easter_dates(0..1),
+    [:wielkanocny] => easter_dates(1),
+    [:sylwester, :sylwestra] => fixed_dates(12,31)
+  }
+
+  WEEKDAYS = {
+    [:*, :'tydzień'] => (0..6).to_a,
+    [:powszedni, :powszednie] => (1..5).to_a,
+    [:weekend, :weekendy] => [0,6],
+    [:sobota, :soboty] => [6],
+    [:niedziela, :niedziele] => [0]
+  }
+
+end

data/lib/chronik/label.rb

@@ -0,0 +1,45 @@
+require 'unicode'
+
+module Chronik
+  # The class of days.
+  class Label
+    def initialize(text)
+      @tokens = text.split.map{|word| Unicode.downcase(word).to_sym} - SUGAR
+    end
+    
+    # Special days which are represented by this label. Those are probably one
+    # in a year holidays like Christmas.
+    #
+    # range - [Range]:
+    #
+    # Returns an Array of Dates.
+    def holidays(range=(Date.today..Date.today.next_month))
+      output = []
+      @tokens.each do |token|
+        if ALL_HOLIDAYS.include?(token)
+          return HOLIDAYS.values.map do |dates|
+            dates.call(range)
+          end.flatten.uniq
+        end
+        HOLIDAYS.each_pair do |labels,dates|
+          if labels.include?(token)
+            output.concat(dates.call(range))
+          end
+        end
+      end
+      output
+    end
+
+    # Day(s) of a week (Sunday is 0). Also range of days, like weekend.
+    #
+    # Returns an Array of Integers.
+    def weekdays
+      @tokens.each do |token|
+        WEEKDAYS.each_pair do |labels,wdays|
+          return wdays if labels.include?(token)
+        end
+      end
+      []
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: chronik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Stanisław Wasiutyński
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-30 00:00:00.000000000 +00:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode
+  requirement: &7841380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *7841380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7840980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7840980
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &7840520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7840520
+description: 
+email: staszek.wasiutynski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chronik/chronik.rb
+- lib/chronik/label.rb
+- lib/chronik.rb
+- README.md
+has_rdoc: true
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Dates' class parser
+test_files: []