RubyGems - phpf - Versions diffs - 1.0.0 - Mend

phpf 1.0.0

Files changed (9) hide show

data/COPYING.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Tim Fletcher <tfletcher.com>
+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.html ADDED Viewed

@@ -0,0 +1,61 @@
+<html>
+<head>
+  <title>phpf</title>
+  <style type="text/css" media="screen">
+    html {
+      height: 100%;
+      margin-bottom: 1px;
+    }
+    body {
+      margin: 0;
+      padding: 30px;
+    }
+    h1, h2 {
+      font-family: Garamond, Rockwell, serif;
+    }
+    h2 {
+      margin-top: 1.5em;
+    }
+    code {
+      font-family: "Panic Sans", "Bitstream Vera Sans Mono", Consolas, Monaco, monospace;
+      font-size: 11px;
+    }
+  </style>
+</head>
+<body>
+<h1>phpf <small>1.0.0</small></h1>
+<p>A <a href="http://www.ruby-lang.org/">Ruby</a> port of <a href="http://www.php.net/date">PHP&rsquo;s date function</a>.</p>
+<h2>HOWTO get it</h2>
+<p>Use <a href="http://rubygems.org/">RubyGems</a> (<tt>gem install phpf</tt>),
+  or <a href="http://rubyforge.org/frs/?group_id=5524">download from RubyForge</a>.</p>
+<h2>HOWTO use it</h2>
+<p>Either use Time#phpf, or Kernel#date, e.g.</p>
+<pre><code>require 'phpf'
+time = Time.parse('1/1/2008 12:34:56')
+time.phpf('jS F Y H:i')  # => "1st January 2008 12:34"
+time.to_i  # => 1199190896
+date('jS F Y H:i', 1199190896)  # => "1st January 2008 12:34"
+</code></pre>
+<h2>See Also</h2>
+<p><a href="http://simonwillison.net/2003/Oct/7/dateInPython/">PHP&rsquo;s date() function in Python</a></p>
+</body>
+</html>

data/Rakefile.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = 'phpf'
+  s.version = '1.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = false
+  s.summary = "Port of PHP's date function."
+  s.description = s.summary
+  s.author = 'Tim Fletcher'
+  s.email = 'twoggle@gmail.com'
+  s.homepage = 'http://phpf.rubyforge.org/'
+  s.files = Dir.glob('lib/**/*') + %w( COPYING.txt Rakefile.rb README.html )
+  s.require_paths = ['lib']
+end
+Rake::GemPackageTask.new(GEMSPEC) { }
+Rake::PackageTask.new(GEMSPEC.name, GEMSPEC.version) do |p|
+  p.need_tar_gz = true
+  p.package_files.include GEMSPEC.files
+end
+desc 'Run all the tests'
+task :test do
+  if ARGV.length == 2 && ARGV.last =~ /SYM=(.)/
+    TEST_SYMBOL = $1.to_sym
+  end
+  require 'test/unit'
+  Test::Unit.run = false
+  $:.unshift 'lib'
+  require 'phpf/tests'
+  Test::Unit::AutoRunner.run
+  $SKIPPED_PHP_CHECKS.each do |format, version|
+    puts "- skipped check for %s (requires PHP %s)" % [format, version]
+  end
+end

data/lib/phpf.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require 'phpf/tokenizing'
+require 'phpf/evaluation'
+require 'phpf/translations'
+require 'time'
+module PHPF
+  def self.format(string)
+    Symbol === string ? StandardFormats.const_get(string.to_s.upcase) : string
+  end
+  # cf. http://uk3.php.net/manual/en/ref.datetime.php#datetime.constants
+  #
+  # DATE_RFC822/DATE_COOKIE/DATE_RFC1123/DATE_RSS, DATE_ISO8601,
+  # and DATE_RFC2822 all have equivalent Ruby methods.
+  #
+  module StandardFormats
+    RFC850, RFC1036 = "l, d-M-y H:i:s T".freeze
+    RFC3339, W3C, ATOM = "Y-m-d\TH:i:sP".freeze
+  end
+end
+class Time
+  def self.epoch
+    @@epoch ||= parse('1st Jan 1970 00:00:00 UTC').freeze
+  end
+  def phpf(string)
+    PHPF.evaluate(PHPF.tokenize(PHPF.format(string)), self).join
+  end
+end
+class Integer
+  def to_time
+    Time.epoch + self
+  end
+end
+module Kernel
+  def date(format_string, time = Time.now)
+    time.to_i.to_time.phpf(format_string)
+  end
+end

data/lib/phpf/evaluation.rb ADDED Viewed

@@ -0,0 +1,55 @@
+module PHPF
+  def self.evaluate(tokens, time)
+    tokens.map do |token|
+      translations.has_key?(token) ? call(translations[token], time) : token
+    end
+  end
+  private
+  def self.translate(symbol, &rule)
+    translations[@last_symbol = symbol] = rule
+  end
+  def self.only(php_version)
+    php_version_requirements[@last_symbol] = php_version
+  end
+  def self.test(time_string, expected_output)
+    test_cases[@last_symbol] << [time_string, expected_output]
+  end
+  def self.translations
+    @translations ||= {}
+  end
+  def self.call(translation, time)
+    translation.arity == 1 ? translation.call(time) : time.instance_eval(&translation)
+  end
+  def self.test_cases
+    @test_cases ||= Hash.new { |h, k| h[k] = [] }
+  end
+  def self.php_version_requirements
+    @php_version_requirements ||= {}
+  end
+  def self.epoch
+    '1st Jan 1970 00:00:00 UTC'
+  end
+  def self.ordinal(n)
+    return 'th' if (11..13).include?(n % 100)
+    case n % 10
+      when 1: 'st'
+      when 2: 'nd'
+      when 3: 'rd'
+      else    'th'
+    end
+  end
+  def self.date(time)
+    Date.new(time.year, time.month, time.mday)
+  end
+end

data/lib/phpf/tests.rb ADDED Viewed

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'phpf'
+$SKIPPED_PHP_CHECKS = {}
+module PHPF
+  class Tests < Test::Unit::TestCase
+    class VersionString
+      def initialize(string)
+        @string = string.to_s
+      end
+      def to_s
+        @string
+      end
+      def <=>(v)
+        @string.split('.') <=> v.to_s.split('.')
+      end
+      include Comparable
+    end
+    unless defined?(PHP)
+      PHP = 'php'
+    end
+    PHP_VERSION = begin
+      (output = `#{PHP} -version`).empty? ? nil : VersionString.new(output[/(\d\.\d\.\d)/, 1])
+    end
+    def assert_expected_php_output(string, tokens, time)
+      php_code = 'echo date(%p, %d);' % [ PHPF.untokenize(tokens), time.to_i ]
+      php_output = `#{PHP} -r #{php_code.inspect}`
+      assert_equal string, php_output, "unexpected PHP output: from %p" % php_code
+    end
+    def required_version(tokens)
+      tokens.inject(nil) do |v, token|
+        next v unless token.is_a?(Symbol)
+        next v unless PHPF.php_version_requirements.has_key?(token)
+        version = VersionString.new(PHPF.php_version_requirements[token])
+        v.nil?? version : (v > version ? v : version)
+      end
+    end
+    def assert_evaluates_to(string, format, time_string)
+      tokens = case format
+        when String then
+          tokens = PHPF.tokenize(format)
+          assert_equal format, PHPF.untokenize(tokens)
+          tokens
+        when Symbol then [format]
+        when Array then format
+      end
+      time = Time.parse(time_string)
+      unless PHP_VERSION.nil?
+        if (required_version = required_version(tokens)).nil?
+          assert_expected_php_output string, tokens, time
+        elsif PHP_VERSION >= required_version
+          assert_expected_php_output string, tokens, time
+        else
+          $SKIPPED_PHP_CHECKS[format] = required_version
+        end
+      end
+      assert_equal string, PHPF.evaluate(tokens, time).to_s
+    end
+    PHPF.test_cases.each do |symbol, test_cases|
+      if !defined?(TEST_SYMBOL) || TEST_SYMBOL == symbol
+        define_method("test_evaluate_#{symbol}") do
+          test_cases.each do |(time_string, expected_output)|
+            assert_evaluates_to expected_output, symbol.to_s, time_string
+          end
+        end
+      end
+    end
+    def test_php_examples # cf. http://php.net/date (Example #4)
+      time = Time.parse('March 10th, 2001, 5:16:18 pm')
+      assert_equal 'March 10, 2001, 5:16 pm', time.phpf('F j, Y, g:i a')
+      assert_equal '03.10.01', time.phpf('m.d.y')
+      assert_equal '10, 3, 2001', time.phpf('j, n, Y')
+      assert_equal '20010310', time.phpf('Ymd')
+      assert_equal '05-16-18, 10-03-01, 1631 1618 6 Satpm01', time.phpf('h-i-s, j-m-y, it is w Day')
+      assert_equal 'it is the 10th day.', time.phpf('\i\t \i\s \t\h\e jS \d\a\y.')
+      assert_equal '17:03:18 m is month', time.phpf('H:m:s \m \i\s \m\o\n\t\h')
+      assert_equal '17:16:18', time.phpf('H:i:s')
+    end
+  end
+end

data/lib/phpf/tokenizing.rb ADDED Viewed

@@ -0,0 +1,37 @@
+module PHPF
+  FormatCharacters = 'dDjlNSwzWFmMntLoYyaABgGhHisueIOPTZcrU'
+  def self.tokenize(format_string)
+    tokens = []
+    until format_string.empty?
+      case format_string
+        when /^([#{FormatCharacters}])/
+          tokens << $1.to_sym
+        when /^\\([#{FormatCharacters}])/
+          tokens << $1
+        when /^([^\\#{FormatCharacters}]+?)(?=[\\#{FormatCharacters}])/
+          tokens << $1
+        when /^([^\\#{FormatCharacters}]+?)$/
+          tokens << $1
+        else
+          raise 'cannot tokenize format string: %p' % format_string
+      end
+      format_string = $'
+    end
+    return tokens
+  end
+  def self.untokenize(tokens)
+    tokens.map { |token| untok(token, token.to_s) }.join
+  end
+  private
+  def self.untok(token, string)
+    if Symbol === token
+      return string
+    else
+      FormatCharacters.include?(string) ? '\\' + string : string
+    end
+  end
+end

data/lib/phpf/translations.rb ADDED Viewed

@@ -0,0 +1,244 @@
+require 'date'
+# cf. http://php.net/date
+#
+module PHPF
+  # d: Day of the month, 2 digits with leading zeros (e.g. 01 to 31)
+  #
+  translate(:d) { '%02d' % mday }
+  test '1st', '01'
+  test '23rd', '23'
+  # D: A textual representation of a day, three letters (e.g. Mon through Sun)
+  #
+  translate(:D) { Time::RFC2822_DAY_NAME[wday] }
+  test '9th Dec 2007', 'Sun'
+  # j: Day of the month without leading zeros (e.g. 1 to 31)
+  #
+  translate(:j) { mday }
+  test '1st', '1'
+  test '23rd', '23'
+  # l: A full textual representation of the day of the week
+  # e.g. Sunday through Saturday
+  #
+  translate(:l) { strftime('%A') }
+  test '9th Dec 2007', 'Sunday'
+  # N: ISO-8601 numeric representation of the day of the week
+  # e.g. 1 [for Monday] through 7 [for Sunday]
+  #
+  translate(:N) { |time| date(time).cwday }
+  only '5.1.0'
+  test '9th Dec 2007', '7'
+  test '10th Dec 2007', '1'
+  # S: English ordinal suffix for the day of the month
+  # e.g. st, nd, rd or th
+  #
+  translate(:S) { |time| ordinal(time.day) }
+  test '1st', 'st'
+  test '2nd', 'nd'
+  test '3rd', 'rd'
+  test '4th', 'th'
+  # w: Numeric representation of the day of the week
+  # e.g. 0 [for Sunday] through 6 [for Saturday]
+  #
+  translate(:w) { wday }
+  test '9th Dec 2007', '0'
+  test '10th Dec 2007', '1'
+  # z: The day of the year (starting from 0)
+  # e.g. 0 through 365
+  #
+  translate(:z) { yday - 1 }
+  test '1st Jan 2007', '0'
+  test '31st Dec 2007', '364'
+  test '31st Dec 2008', '365'
+  # W: ISO-8601 week number of year, weeks starting on Monday
+  # e.g. 42 [for the 42nd week in the year]
+  #
+  translate(:W) { |time| '%02d' % date(time).cweek }
+  test '24th Dec 2007 12:00', '52'
+  test '31st Dec 2007 12:00', '01'
+  test ' 1st Jan 2008 12:00', '01'
+  test ' 8th Jan 2008 12:00', '02'
+  # F: A full textual representation of a month (January through December)
+  #
+  translate(:F) { strftime('%B') }
+  test 'Jan', 'January'
+  test 'Dec', 'December'
+  # m: Numeric representation of a month, with leading zeros
+  # e.g. 01 through 12
+  #
+  translate(:m) { '%02d' % month }
+  test 'Jan', '01'
+  test 'Dec', '12'
+  # M: A short textual representation of a month
+  # e.g. Jan through Dec
+  #
+  translate(:M) { Time::RFC2822_MONTH_NAME[month - 1] }
+  test 'Jan', 'Jan'
+  test 'Dec', 'Dec'
+  # n: Numeric representation of a month, without leading zeros
+  # e.g. 1 through 12
+  #
+  translate(:n) { month }
+  test 'Jan', '1'
+  test 'Dec', '12'
+  # t: Number of days in the given month (28 through 31)
+  #
+  translate(:t) { |time| ((date(time) >> 1) - time.mday).day }
+  test 'Jan 2007', '31'
+  test 'Feb 2007', '28'
+  test 'Feb 2008', '29'
+  # L: 1 if it is a leap year, 0 otherwise
+  #
+  translate(:L) { Date.leap?(year) ? 1 : 0 }
+  test 'Jan 2007', '0'
+  test 'Jan 2008', '1'
+  # o: ISO-8601 year number. This has the same value as Y,
+  # except that if the ISO week number (W) belongs to the previous
+  # or next year, that year is used instead.
+  #
+  translate(:o) { |time| date(time).cwyear }
+  only '5.1.0'
+  test '24th Dec 2007 12:00', '2007'
+  test '31st Dec 2007 12:00', '2008'
+  test ' 1st Jan 2008 12:00', '2008'
+  test ' 8th Jan 2008 12:00', '2008'
+  # Y: A full numeric representation of a year
+  # e.g. 1999
+  #
+  translate(:Y) { year }
+  test 'Jan 1999', '1999'
+  # y: A two digit representation of a year
+  # e.g. 99 or 03
+  #
+  translate(:y) { strftime('%y') }
+  test 'Jan 1999', '99'
+  # a: Lowercase Ante meridiem and Post meridiem (am or pm)
+  #
+  translate(:a) { strftime('%p').downcase }
+  test '00:42', 'am'
+  test '12:42', 'pm'
+  # A: Uppercase Ante meridiem and Post meridiem (AM or PM)
+  #
+  translate(:A) { strftime('%p') }
+  test '00:42', 'AM'
+  test '12:42', 'PM'
+  # B: Swatch Internet time (000 through 999)
+  # cf. http://www.ypass.net/crap/internettime/
+  #
+  translate(:B) { '%03d' % (((utc.to_i + 3600) % 86400) / 86.4) }
+  test '1st Jan 2008 00:00:00 UTC', '041'
+  # g: 12-hour format of an hour without leading zeros (1 through 12)
+  #
+  translate(:g) { strftime('%I').to_i }
+  test '00:42', '12'
+  test '06:42', '6'
+  test '12:42', '12'
+  test '18:42', '6'
+  # G: 24-hour format of an hour without leading zeros (0 through 23)
+  #
+  translate(:G) { hour }
+  test '00:42', '0'
+  test '06:42', '6'
+  test '12:42', '12'
+  test '18:42', '18'
+  # h: 12-hour format of an hour with leading zeros (01 through 12)
+  #
+  translate(:h) { strftime('%I') }
+  test '00:42', '12'
+  test '06:42', '06'
+  test '12:42', '12'
+  test '18:42', '06'
+  # H: 24-hour format of an hour with leading zeros (00 through 23)
+  #
+  translate(:H) { strftime('%H') }
+  test '00:42', '00'
+  test '06:42', '06'
+  test '12:42', '12'
+  test '18:42', '18'
+  # i: Minutes with leading zeros (00 to 59)
+  #
+  translate(:i) { strftime('%M') }
+  test '00:00', '00'
+  test '00:12', '12'
+  # s: Seconds, with leading zeros (00 through 59)
+  #
+  translate(:s) { strftime('%S') }
+  test '00:00:00', '00'
+  test '00:00:12', '12'
+  # e: Timezone identifier
+  # e.g. UTC, GMT, Atlantic/Azores
+  #
+  # TODO
+  # O: Difference to Greenwich time (GMT) in hours
+  # e.g. +0200
+  #
+  # translate(:O) { '+%03d00' % (gmt_offset / 3600) }
+  # TODO
+  # P: Difference to Greenwich time (GMT) with colon between hours and minutes
+  # e.g. +02:00
+  #
+  # only '5.1.3'
+  # TODO
+  # T: Timezone abbreviation
+  # e.g. EST, MDT
+  #
+  # TODO
+  # Z: Timezone offset in seconds. The offset for timezones west of UTC
+  # is always negative, and for those east of UTC is always positive.
+  # e.g. -43200 through 50400
+  #
+  # TODO
+  # c: ISO 8601 date
+  # e.g. 2004-02-12T15:19:21+00:00
+  #
+  translate(:c) { iso8601.sub(/Z$/, '+00:00') }
+  only '5'
+  test '1st Jan 2008 00:00:00 UTC', '2008-01-01T00:00:00+00:00'
+  test '1st Jan 2008 12:34:56 PST', '2008-01-01T20:34:56+00:00'
+  # r: RFC 2822 formatted date
+  # e.g. Thu, 21 Dec 2000 16:01:07 +0200
+  #
+  translate(:r) { rfc2822 }
+  test '1st Jan 2008 00:00:00 GMT', 'Tue, 01 Jan 2008 00:00:00 +0000'
+  # U: Seconds since the Unix Epoch
+  #
+  translate(:U) { to_i }
+  test epoch, '0'
+  test '1st Jan 2008 00:00:00 UTC', '1199145600'
+end

metadata ADDED Viewed

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: phpf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Fletcher
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2008-02-14 00:00:00 +00:00
+default_executable:
+dependencies: []
+description: Port of PHP's date function.
+email: twoggle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/phpf
+- lib/phpf/evaluation.rb
+- lib/phpf/tests.rb
+- lib/phpf/tokenizing.rb
+- lib/phpf/translations.rb
+- lib/phpf.rb
+- COPYING.txt
+- Rakefile.rb
+- README.html
+has_rdoc: false
+homepage: http://phpf.rubyforge.org/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.0.1
+signing_key:
+specification_version: 2
+summary: Port of PHP's date function.
+test_files: []