sinatra_more 0.2.5 → 0.2.7

data/README.rdoc

@@ -46,10 +46,12 @@ of tools, helpers and components that will make Sinatra suitable for more comple
 Here is a small list of what sinatra_more contains:
 
 * Generic view and tag helpers (<tt>tag</tt>, <tt>content_tag</tt>, <tt>input_tag</tt>, ...)
-* Asset helpers (<tt>link_to</tt>, <tt>image_tag</tt>, <tt>javascript_include_tag</tt>, ...)
-* Form helpers and builder support (<tt>form_tag</tt>, <tt>form_for</tt>, <tt>field_set_tag</tt>, <tt>text_field</tt>, ...)
+* Asset tag helpers (<tt>link_to</tt>, <tt>image_tag</tt>, <tt>javascript_include_tag</tt>, ...)
+* Full form helpers and builders support (<tt>form_tag</tt>, <tt>form_for</tt>, <tt>field_set_tag</tt>, <tt>text_field</tt>, ...)
+* Generally useful formatting extensions (<tt>relative_time_ago</tt>, <tt>js_escape_html</tt>, <tt>sanitize_html</tt>)
 * Plug and play setup for the excellent Warden authentication system
-* Code generators for creating a new sinatra application
+* Robust 'mailer' support for sinatra (akin to <tt>ActionMailer</tt> but simpler and powered by <tt>pony</tt>) (COMING SOON)
+* Code generators for creating a new sinatra application (COMING SOON)
 
 Keep in mind, the user will be able to pull in these components seperately and leave out those that are not required.
 
@@ -333,7 +335,14 @@ I hope to create or merge in an even better 'default' form_builder in the near f
   * (from RackUtils) Escape ampersands, brackets and quotes to their HTML/XML entities.
 * <tt>relative_time_ago(date)</tt>
   * Returns relative time in words referencing the given date
-  * <tt>relative_time_ago(2.days.ago)</tt> => "2 days ago"
+  * <tt>relative_time_ago(2.days.ago)</tt> => "2 days"
+  * <tt>relative_time_ago(5.minutes.ago)</tt> => "5 minutes"
+  * <tt>relative_time_ago(2800.days.ago)</tt> => "over 7 years"
+* <tt>time_in_words(date)</tt>
+  * Returns relative time in the past or future using appropriate date format
+  * <tt>time_in_words(2.days.ago)</tt> => "2 days ago"
+  * <tt>time_in_words(100.days.ago)</tt> => "Tuesday, July 21"
+  * <tt>time_in_words(1.day.from_now)</tt> => "tomorrow"
 * <tt>escape_javascript(html_content)</tt>
   * Escapes html to allow passing information to javascript. Used for passing data inside an ajax .js.erb template
   * <tt>escape_javascript("<h1>Hey</h1>")</tt>
@@ -417,10 +426,16 @@ name then you need to specify that as follows:
 
   SinatraMore::WardenPlugin::PasswordStrategy.user_class = CustomUser
 
-Similarly, the strategy used expects that you have an <tt>authenticate</tt> method on your user class as follows:
+In addition, the strategy used expects that you have an <tt>authenticate</tt> method with the specific signature below:
 
-  def authenticate(username, password)
+  class CustomUser
+    # ...
     # Returns user record if user and password match; otherwise return false
+    def authenticate(username, password)
+      user = User.find(username)
+      user.has_password?(password) ? user : false
+    end
+    # ...
   end
 
 Using this plugin you also do need to define your own routes for managing warden sessions. An example is below:
@@ -445,12 +460,12 @@ Using this plugin you also do need to define your own routes for managing warden
     redirect '/session/login'
   end
 
-I was made aware of other sinatra/warden extensions which work very similarly to the system I outline for this plugin.
+I was made aware of other sinatra/warden plugins which work very similarly to the system I outline for this plugin.
 Most notably is the sinatra_warden plugin by Justin Smestad (http://github.com/jsmestad/sinatra_warden)
 Eventually I plan to vendor that gem or just remove support for this piece of my plugin completely. 
 
-If anybody has any thoughts on this, please let me know. There is something convenient to me about having
-access to a plug-and-play warden solution directly from this gem.
+If anybody has any thoughts on this or the warden integration in general, please let me know. 
+Nonetheless, there is a certain convenience for me having access to a plug-and-play warden solution directly from this gem.
 
 == Acknowledgements
 

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.7

data/lib/sinatra_more/markup_plugin/format_helpers.rb

@@ -2,10 +2,11 @@ module SinatraMore
   module FormatHelpers
 
     # Returns escaped text to protect against malicious content
-    def h(text)
+    def escape_html(text)
       Rack::Utils.escape_html(text)
     end
-    alias escape_html h
+    alias h escape_html
+    alias sanitize_html escape_html
 
     # Returns escaped text to protect against malicious content
     # Returns blank if the text is empty
@@ -14,9 +15,11 @@ module SinatraMore
       h text
     end
 
-    # Returns relative time in words referencing the given date
-    # relative_time_ago(Time.now)
-    def relative_time_ago(date)
+
+    # Smart time helper which returns relative text representing times for recent dates
+    # and absolutes for dates that are far removed from the current date
+    # time_in_words(10.days.ago) => '10 days ago'
+    def time_in_words(date)
       date = date.to_date
       date = Date.parse(date, true) unless /Date.*/ =~ date.class.to_s
       days = (date - Date.today).to_i
@@ -31,6 +34,25 @@ module SinatraMore
       return date.strftime('%A, %B %e') if days.abs < 182
       return date.strftime('%A, %B %e, %Y')
     end
+    alias time_ago time_in_words
+
+    # Returns relative time in words referencing the given date
+    # relative_time_ago(Time.now) => 'about a minute ago'
+    def relative_time_ago(from_time)
+      distance_in_minutes = (((Time.now - from_time.to_time).abs)/60).round
+      case distance_in_minutes
+        when 0..1 then 'about a minute'
+        when 2..44 then "#{distance_in_minutes} minutes"
+        when 45..89 then 'about 1 hour'
+        when 90..1439 then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
+        when 1440..2879 then '1 day'
+        when 2880..43199 then "#{(distance_in_minutes / 1440).round} days"
+        when 43200..86399 then 'about 1 month'
+        when 86400..525599 then "#{(distance_in_minutes / 43200).round} months"
+        when 525600..1051199 then 'about 1 year'
+        else "over #{(distance_in_minutes / 525600).round} years"
+      end
+    end
 
     # Used in xxxx.js.erb files to escape html so that it can be passed to javascript from sinatra
     # escape_javascript("<h1>Hey</h1>")
@@ -43,6 +65,7 @@ module SinatraMore
     end
 
     alias js_escape escape_javascript
+    alias js_escape_html escape_javascript
     alias escape_for_javascript escape_javascript
 
   end

data/sinatra_more.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.2.5"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]

data/test/markup_plugin/test_format_helpers.rb

@@ -25,27 +25,60 @@ class TestFormatHelpers < Test::Unit::TestCase
     end
   end
 
-  context 'for #relative_time_ago method' do
+  context 'for #time_in_words method' do
     should "display today" do
-      assert_equal 'today', relative_time_ago(Time.now)
+      assert_equal 'today', time_in_words(Time.now)
     end
     should "display yesterday" do
-      assert_equal 'yesterday', relative_time_ago(1.day.ago)
+      assert_equal 'yesterday', time_in_words(1.day.ago)
     end
     should "display tomorrow" do
-      assert_equal 'tomorrow', relative_time_ago(1.day.from_now)
+      assert_equal 'tomorrow', time_in_words(1.day.from_now)
     end
     should "return future number of days" do
-      assert_equal 'in 4 days', relative_time_ago(4.days.from_now)
+      assert_equal 'in 4 days', time_in_words(4.days.from_now)
     end
     should "return past days ago" do
-      assert_equal '4 days ago', relative_time_ago(4.days.ago)
+      assert_equal '4 days ago', time_in_words(4.days.ago)
     end
     should "return formatted archived date" do
-      assert_equal 100.days.ago.strftime('%A, %B %e'), relative_time_ago(100.days.ago)
+      assert_equal 100.days.ago.strftime('%A, %B %e'), time_in_words(100.days.ago)
     end
     should "return formatted archived year date" do
-      assert_equal 500.days.ago.strftime('%A, %B %e, %Y'), relative_time_ago(500.days.ago)
+      assert_equal 500.days.ago.strftime('%A, %B %e, %Y'), time_in_words(500.days.ago)
+    end
+  end
+
+  context 'for #relative_time_ago method' do
+    should 'display now as a minute ago' do
+      assert_equal 'about a minute', relative_time_ago(1.minute.ago)
+    end
+    should "display a few minutes ago" do
+      assert_equal '4 minutes', relative_time_ago(4.minute.ago)
+    end
+    should "display an hour ago" do
+      assert_equal 'about 1 hour', relative_time_ago(1.hour.ago + 5.minutes.ago.sec)
+    end
+    should "display a few hours ago" do
+      assert_equal 'about 3 hours', relative_time_ago(3.hour.ago + 5.minutes.ago.sec)
+    end
+    should "display a day ago" do
+      assert_equal '1 day', relative_time_ago(1.day.ago)
+    end
+    should "display a few days ago" do
+      assert_equal '5 days', relative_time_ago(5.days.ago - 5.minutes.ago.sec)
+    end
+    should "display a month ago" do
+      assert_equal 'about 1 month', relative_time_ago(32.days.ago + 5.minutes.ago.sec)
+    end
+    should "display a few months ago" do
+      assert_equal '6 months', relative_time_ago(180.days.ago - 5.minutes.ago.sec)
+    end
+    should "display a year ago" do
+      assert_equal 'about 1 year', relative_time_ago(365.days.ago - 5.minutes.ago.sec)
+    end
+    should "display a few years ago" do
+      assert_equal 'over 7 years', relative_time_ago(2800.days.ago - 5.minutes.ago.sec)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors: 
 - Nathan Esquenazi