ryanlowe-client_date 0.1.0

data/CHANGELOG

@@ -0,0 +1,12 @@
+
+== 0.1.0
+
+May 26
+= added GitHub gemspec
+
+May 1 2008
+- move to GitHub
+
+Sep 24 2007
+- add installation instructions to README
+- client_date plugin created from code in existing projects

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2007-2008 Ryan Lowe
+
+http://ryanlowe.ca
+http://disruptiveagility.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

@@ -0,0 +1,60 @@
+
+Hosted at GitHub since May 1, 2008
+http://github.com/ryanlowe/client_date
+
+Was hosted at Google Code
+http://code.google.com/p/client-date/
+
+
+= client_date
+
+The client_date Ruby on Rails plugin uses client-side Javascript
+to format a date/time in a view instead of the server. The client
+is given UTC time for formatting so the server doesn't have to
+store which time zone each user is in.
+
+Of course it's also very handy for users that haven't logged in
+or do not have a login.
+
+== Installation
+
+  gem install ryanlowe-client_date --source http://gems.github.com/
+
+== Setup
+
+  First include the ClientDate mixin in your ApplicationHelper.
+
+    module ApplicationHelper
+      include ClientDate
+      ...
+    end
+
+  Then copy the javascript code in javascripts/client_date.js to
+  your project.  You can do this two ways:
+
+  1. Copy client_date.js to your javascripts/ directory and
+     add it to your Rails project using javascript_include_tag.
+  2. Copy the code in client_date.js to javascripts/application.js
+     which is pulled in by javascript_include_tag :defaults.
+
+== Usage
+
+  In a view you can use:
+  
+  format_date(date)           # month, day
+  format_datetime(date)       # month, day, hour, minute
+  format_datetime(date,true)  # month, day, hour, minute, seconds
+  
+  The date parameter should be a normal Ruby date, like the "datetime" used
+  in Rails migrations.
+  
+  Example:
+  
+  <p>Created at: <%= format_datetime(post.created_at) %></p>
+  
+== Customization
+
+  Change how client_date formats dates and times by changing the
+  fd() and fdt() Javascript functions.
+  
+  

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the client_date plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the client_date plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClientDate'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/client_date.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "client_date"
+  s.version = "0.1.0"
+  s.date = "2008-05-26"
+  s.summary = "Uses client-side Javascript to format a datetime instead of the Ruby on Rails server"
+  s.email = "rails@ryanlowe.ca"
+  s.homepage = "http://github.com/ryanlowe/client_date"
+  s.description = "Uses client-side Javascript to format a datetime instead of the Ruby on Rails server"
+  s.has_rdoc = false
+  s.authors = ["Ryan Lowe"]
+  s.files = ["README", "CHANGELOG", "MIT-LICENSE","Rakefile", "client_date.gemspec", "init.rb","lib/client_date.rb",
+    "test/client_date_test.rb","test/test_helper.rb"]
+  s.test_files = ["test/client_date_test.rb","test/test_helper.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README","CHANGELOG"]
+  s.add_dependency("rails", ["> 2.0.0"])
+end

data/init.rb

@@ -0,0 +1 @@
+require 'client_date'

data/lib/client_date.rb

@@ -0,0 +1,29 @@
+module ClientDate
+  def format_date(date)
+    return "" if date.nil?
+    assemble_javascript(date,"fd")
+  end
+  
+  def format_datetime(date,seconds=false)
+    return "" if date.nil?
+    function = seconds ? "fdts" : "fdt"
+    assemble_javascript(date,function)
+  end
+  
+  private
+  
+    def date_params(date)
+      return "" if date.nil?
+      text  = date.year.to_s + ","
+      text += date.month.to_s + ","
+      text += date.day.to_s + ","
+      text += date.hour.to_s + ","
+      text += date.min.to_s + ","
+      text += date.sec.to_s
+      text
+    end
+  
+    def assemble_javascript(date,function)
+      "<script>"+function+"("+date_params(date)+");</script>"
+    end
+end

data/test/client_date_test.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/client_date'
+
+class ClientDateTest < Test::Unit::TestCase
+  include ClientDate
+
+  #
+  # format_date
+  #
+
+  def test_format_date
+    assert_equal "", format_date(nil)
+    assert_equal "<script>fd(2000,1,1,20,15,39);</script>", format_date(Time.gm(2000,"jan",1,20,15,39))
+  end
+  
+  #
+  # format_datetime
+  #
+  
+  def test_format_datetime
+    assert_equal "", format_datetime(nil)
+    assert_equal "<script>fdt(2000,1,1,20,15,47);</script>", format_datetime(Time.gm(2000,"jan",1,20,15,47))
+  end
+  
+  def test_format_datetime_with_seconds
+    assert_equal "", format_datetime(nil,true)
+    assert_equal "<script>fdts(2000,1,1,20,15,23);</script>", format_datetime(Time.gm(2000,"jan",1,20,15,23),true)
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+RAILS_ROOT = '.' unless defined?(RAILS_ROOT)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ryanlowe-client_date
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Lowe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Uses client-side Javascript to format a datetime instead of the Ruby on Rails server
+email: rails@ryanlowe.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+files: 
+- README
+- CHANGELOG
+- MIT-LICENSE
+- Rakefile
+- client_date.gemspec
+- init.rb
+- lib/client_date.rb
+- test/client_date_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/ryanlowe/client_date
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: Uses client-side Javascript to format a datetime instead of the Ruby on Rails server
+test_files: 
+- test/client_date_test.rb
+- test/test_helper.rb