timely 0.0.2 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cebe03ec2467f4efe23f881f70be2c08fbb7e20
+  data.tar.gz: 355bf2273646023df6e0f7e9218e7a91390dd25a
+SHA512:
+  metadata.gz: bec47226548cc65af0aa7e0da099b5dc4f4b80056eb1f47e0f5de53959db654b18ed851245fbab86f9d45a0d80cb3fcc3a0bbcc9cc6188958d120402832b78f1
+  data.tar.gz: c705e73fe8447761b8ea7a79984a77aeb13687bb81bc354e53f5f434d64f9d70f51325da10f81df7811e3c02a18621e02cc5b6dbcf7defcb33aa6f944ea066fe

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+coverage
+Gemfile.lock
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.2
+script: bundle exec rake spec
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4.gemfile
+notifications:
+  email:
+    - support@travellink.com.au
+  flowdock:
+    secure: QC1mV/0NZwA4tU2K1BQSety/seEf7ujL3uUlddXrMm0yHp0NBMlo1tnQ7KKopSKoyoPj9M9KmfhrCdbdZXDOU57WucH+pz7Tn9Zp9VkPUMniN4rYSwkrF17vihM5NpdyDzqo5mzthVPUEV0DtlK+Uu2W4wMUpu1uKaahFzHJH6k=
+sudo: false
+cache: bundler

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+* Initial release

data/Gemfile

@@ -1,13 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
-
-group :development, :test do
-  gem 'rake', '~> 0.9.2'
-  gem 'rdoc', '~> 3.12'
-  gem 'rspec'
-  gem 'simplecov-rcov'
-  gem 'simplecov'
-  gem 'sqlite3'
-  gem 'activesupport', '~> 2.3.0'
-  gem 'activerecord', '~> 2.3.0'
-end

data/README.md

@@ -1,6 +1,11 @@
 Timely
 ======
 
+[![Build Status](https://travis-ci.org/sealink/timely.png?branch=master)](https://travis-ci.org/sealink/timely)
+[![Coverage Status](https://coveralls.io/repos/sealink/timely/badge.png)](https://coveralls.io/r/sealink/timely)
+[![Dependency Status](https://gemnasium.com/sealink/timely.png?travis)](https://gemnasium.com/sealink/timely)
+[![Code Climate](https://codeclimate.com/github/sealink/timely.png)](https://codeclimate.com/github/sealink/timely)
+
 # DESCRIPTION
 
 Various helpers to work with times, dates and weekdays, etc.

data/Rakefile

@@ -1,47 +1,4 @@
-require 'rubygems'
-require 'rake'
-require 'date'
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
+require "bundler/gem_tasks"
 
 desc 'Default: run specs.'
 task :default => :spec
@@ -53,98 +10,3 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   # Put spec opts in a file named .rspec in root
 end
-
-desc "Generate SimpleCov test coverage and open in your browser"
-task :coverage do
-  ENV['COVERAGE'] = 'true'
-  Rake::Task['spec'].invoke
-end
-
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc "Validate #{gemspec_file}"
-task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
-  unless libfiles.empty?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activesupport', '~> 3.2.0'
+  gem 'activerecord', '~> 3.2.0'
+  gem 'actionpack', '~> 3.2.0'
+end

data/gemfiles/rails4.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activesupport', '~> 4.0'
+  gem 'activerecord', '~> 4.0'
+  gem 'actionpack', '~> 4.0'
+end
+

data/lib/timely.rb

@@ -1,17 +1,21 @@
 module Timely
-  VERSION = '0.0.2'
-
   require 'time'
   require 'date'
 
   require 'timely/string'
   require 'timely/date'
   require 'timely/time'
+  require 'timely/time_since'
   require 'timely/date_time'
   require 'timely/range'
   require 'timely/date_range'
   require 'timely/date_chooser'
   require 'timely/week_days'
-  require 'timely/temporal_patterns'
+  require 'timely/temporal_patterns/finder'
+  require 'timely/temporal_patterns/frequency'
+  require 'timely/temporal_patterns/interval'
+  require 'timely/temporal_patterns/pattern'
   require 'timely/trackable_date_set'
+
+  require 'timely/railtie' if defined?(Rails::Railtie)
 end

data/lib/timely/date.rb

@@ -10,6 +10,26 @@ module Timely
     end
 
     alias_method :at, :at_time
+
+    # returns true if date between from and to
+    # however if from and/or to are nil, it ignores that query
+    # e.g. date.between?(from, nil) is "date > from",
+    #      date.between?(from, nil) is "date < to"
+    #      date.between?(nil, nil)  is true
+    def between?(from, to)
+      from = from.to_date if from && !from.is_a?(Date)
+      to   = to.to_date if to && !to.is_a?(Date)
+
+      if from && to
+        self >= from && self <= to
+      elsif from
+        self >= from
+      elsif to
+        self <= to
+      else
+        true # i.e. no restrictive range return true
+      end
+    end
   end
 end
 

data/lib/timely/date_chooser.rb

@@ -3,9 +3,9 @@ module Timely
     # Where is this used... so far only in one place, _date_range.html.haml
     # May be good to refactor this as well, after the class behaviour is refactored.
     INTERVALS = [
-      {:code => 'w', :name => 'week(s)', :description =>
+      {:code => 'week', :name => 'week(s)', :description =>
           'Weekdays selected will be chosen every {{n}} weeks for the date range'},
-      {:code => 'wom', :name => 'week of month', :description =>
+      {:code => 'week_of_month', :name => 'week of month', :description =>
           'Weekdays selected will be chosen in their {{ord}} occurance every month,
           e.g. if wednesday and thursday are selected, the first wednesday and
           first thursday are selected. Note: this may mean the booking is copied
@@ -20,6 +20,7 @@ module Timely
       @to       = process_date(options[:to])
       @select   = options[:select]
       @dates    = options[:dates]
+      @specific_dates = options[:specific_dates]
       @interval = options[:interval]
       @weekdays = WeekDays.new(options[:weekdays]) if @select == 'weekdays'
       validate
@@ -40,7 +41,8 @@ module Timely
     #   :to       - The end of the date range
     #
     # You can either specify specific dates to be chosen each month:
-    #   :dates    - A comma separated string of days of the month, e.g. 1,16
+    #   :dates          - A comma separated string of days of the month, e.g. 1,16
+    #   :specific_dates - A comma separated string of dates, e.g. 26-10-2012, 03-11-2012, 01-01-2013
     #
     # or you can specify how to select the dates
     #   :day      - A hash of days, the index being the wday, e.g. 0 = sunday, and the value being 1 if chosen
@@ -60,6 +62,9 @@ module Timely
       when 'days'
         days = @dates.gsub(/\s/, '').split(',')
         all_days.select { |date| days.include?(date.mday.to_s) }
+      when 'specific_days'
+        days = @specific_dates.gsub(/\s/, '').split(',')
+        days.map(&:to_date)
       when 'weekdays'
         raise DateChooserException, "No days of the week selected" if @weekdays.weekdays.empty?
         raise DateChooserException, "No weekly interval selected" if @interval && @interval.empty?
@@ -67,12 +72,12 @@ module Timely
         all_days.select do |date|
           if @weekdays.has_day?(date.wday)
             case @interval[:unit]
-            when 'w'
+            when 'week'
               # 0 = first week, 1 = second week, 2 = third week, etc.
               nth_week = (date - @from).to_i / 7
               # true every 2nd week (0, 2, 4, 6, etc.)
               (nth_week % @interval[:level].to_i).zero?
-            when 'wom'
+            when 'week_of_month'
               week = @interval[:level].to_i
               (date.mday > (week-1)*7 && date.mday <= week*7)
             end

data/lib/timely/date_range.rb

@@ -1,17 +1,30 @@
+require 'date' # Ensure Date class is loaded for old rubies (1.8)
+
 module Timely
   class DateRange < ::Range
     def initialize(*args)
       if args.first.is_a?(Range)
-        super(args.first.first, args.first.last)
+        date_range = args.first
+        DateRange.validate_range(date_range.first, date_range.last)
+        super(date_range.first.to_date, date_range.last.to_date)
       elsif args.size == 1 && args.first.is_a?(Date)
-        super(args.first, args.first)
+        DateRange.validate_range(args.first, args.last)
+        super(args.first.to_date, args.first.to_date)
       else
-        super(*args)
+        DateRange.validate_range(args.first, args.last)
+        super(args.first.to_date, args.last.to_date)
       end
     end
     alias_method :start_date, :first
     alias_method :end_date, :last
 
+    def self.validate_range(first, last)
+      raise ArgumentError, "Date range missing start date" if first.nil?
+      raise ArgumentError, "Date range missing end date" if last.nil?
+      raise ArgumentError, "Start date is not a date" unless first.is_a? Date
+      raise ArgumentError, "End date is not a date" unless last.is_a? Date
+    end
+
     def self.from_params(start_date, duration = nil)
       start_date = start_date.to_date
       duration   = [1, duration.to_i].max
@@ -34,18 +47,42 @@ module Timely
     end
     alias_method :duration, :number_of_nights
 
-    def to_s(fmt = '%b %Y')
-      if first == last
-        first.to_s(:short)
-      elsif first == first.at_beginning_of_month && last == last.at_end_of_month
-        if first.month == last.month
+    def to_s(fmt = '%b %Y', date_fmt = '%Y-%m-%d')
+      Timely::DateRange.to_s(first, last, fmt, date_fmt)
+    end
+
+    def self.to_s(first = nil, last = nil, month_fmt = '%b %Y', date_fmt = default_date_format, time_fmt = nil)
+      time_fmt ||= date_fmt + ' %H:%M'
+      is_date = first.is_a?(Date) || last.is_a?(Date)
+      fmt = is_date ? date_fmt : time_fmt
+      if first && last
+        if first == last
           first.strftime(fmt)
+        elsif first == first.at_beginning_of_month && last == last.at_end_of_month
+          if first.month == last.month
+            first.strftime(month_fmt)
+          else
+            "#{first.strftime(month_fmt)} to #{last.strftime(month_fmt)}"
+          end
         else
-          "#{first.strftime(fmt)} to #{last.strftime(fmt)}"
+          "#{first.strftime(fmt)} to #{last.strftime(fmt)}#{" (inclusive)" if is_date}"
         end
+      elsif first
+        "on or after #{first.strftime(fmt)}"
+      elsif last
+        "on or before #{last.strftime(fmt)}"
       else
-        "#{first.to_s(:short)} to #{last.to_s(:short)}"
+        "no date range"
       end
     end
+
+
+    private
+
+    def self.default_date_format
+      # ::Date as we want Ruby's Date not Timely::Date
+      date_format = ::Date::DATE_FORMATS[:short] if ::Date.const_defined?('DATE_FORMATS')
+      date_format || '%Y-%m-%d'
+    end
   end
 end

data/lib/timely/rails.rb

@@ -1,4 +1,11 @@
 require 'timely/rails/extensions'
-ActiveRecord::Base.extend Timely::Extensions
-require 'timely/rails/season'
-require 'timely/rails/date_group'
+if defined?(ActiveRecord)
+  ActiveRecord::Base.extend Timely::Extensions
+  require 'timely/rails/season'
+  require 'timely/rails/date_group'
+end
+require 'timely/rails/date_range_validity_module'
+require 'timely/rails/calendar_tag'
+require 'timely/rails/date_time'
+require 'timely/rails/date'
+require 'timely/rails/period'