nytimes-style 0.2.0 → 0.3.0

data/index.html

@@ -34,7 +34,7 @@
           <a class="pilcrow" href="#section-2">&#182;</a>
         </div>
         <p>A small set of helper methods for generating text that conforms to <em>The New York Times Manual of Style and Usage</em>,
-written by <a href="https://andreischeinkman.com">Andrei Scheinkman</a> and hosted on <a href="https://github.com/ascheink/nytimes-style">Github</a>.</p>
+hosted on <a href="https://github.com/ascheink/nytimes-style">Github</a>.</p>
       </td>
       <td class=code>
         <div class='highlight'><pre><span class="k">module</span> <span class="nn">Nytimes</span>
@@ -49,14 +49,14 @@ written by <a href="https://andreischeinkman.com">Andrei Scheinkman</a> and host
         </div>
         <blockquote><p>&ldquo;In general, spell out the first nine cardinal and
 ordinal numbers [but] spell any number that begins a sentence&hellip;&rdquo;
-There are many exceptions to this rule including &ldquo;ages of people
+Exceptions include &ldquo;ages of people
 and animals,&rdquo; &ldquo;sums of money,&rdquo; &ldquo;degrees of temperature&rdquo; and &ldquo;mentions of the Twelve
 Apostles and the Ten Commandments.&rdquo;</p></blockquote>
       </td>
       <td class=code>
         <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">nytimes_number</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
       <span class="k">if</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">10</span>
-        <span class="sx">%w(one two three four five six seven eight nine ten)</span><span class="o">[</span><span class="n">n</span> <span class="o">-</span> <span class="mi">1</span><span class="o">]</span>
+        <span class="sx">%w(one two three four five six seven eight nine)</span><span class="o">[</span><span class="n">n</span> <span class="o">-</span> <span class="mi">1</span><span class="o">]</span>
       <span class="k">else</span>
         <span class="n">n</span><span class="o">.</span><span class="n">to_s</span>
       <span class="k">end</span>
@@ -74,8 +74,12 @@ February in news copy when they are followed by numerals: Aug. 1; Sept.
 April, May, June and July except as a last resort in a chart or table.&rdquo;</p></blockquote>
       </td>
       <td class=code>
-        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">nytimes_date</span><span class="p">(</span><span class="n">date</span><span class="p">)</span>
-      <span class="s2">&quot;</span><span class="si">#{</span><span class="n">nytimes_month_and_day</span> <span class="n">date</span><span class="si">}</span><span class="s2">, </span><span class="si">#{</span><span class="n">date</span><span class="o">.</span><span class="n">year</span><span class="si">}</span><span class="s2">&quot;</span>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">nytimes_date</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">opts</span><span class="o">=</span><span class="p">{})</span>
+      <span class="n">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+      <span class="n">str</span> <span class="o">&lt;&lt;</span> <span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">&#39;%A, &#39;</span><span class="p">)</span> <span class="k">if</span> <span class="n">opts</span><span class="o">[</span><span class="ss">:day_of_week</span><span class="o">]</span>
+      <span class="n">str</span> <span class="o">&lt;&lt;</span> <span class="n">nytimes_month_and_day</span><span class="p">(</span><span class="n">date</span><span class="p">)</span>
+      <span class="n">str</span> <span class="o">&lt;&lt;</span> <span class="s2">&quot;, </span><span class="si">#{</span><span class="n">date</span><span class="o">.</span><span class="n">year</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">unless</span> <span class="n">opts</span><span class="o">[</span><span class="ss">:hide_current_year</span><span class="o">]</span> <span class="o">&amp;&amp;</span> <span class="n">date</span><span class="o">.</span><span class="n">year</span> <span class="o">==</span> <span class="no">Date</span><span class="o">.</span><span class="n">today</span><span class="o">.</span><span class="n">year</span>
+      <span class="k">return</span> <span class="n">str</span>
     <span class="k">end</span>
     
     <span class="k">def</span> <span class="nf">nytimes_month_and_day</span><span class="p">(</span><span class="n">date</span><span class="p">)</span>
@@ -108,16 +112,15 @@ two-letter abbreviations; some are hard to tell apart on quick reading.)&rdquo;<
     <span class="k">end</span>
     
     <span class="kp">private</span>
-    
+
+    <span class="no">STATE_DATA_FILE</span> <span class="o">=</span> <span class="no">File</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">__FILE__</span><span class="p">),</span> <span class="s1">&#39;nytimes-style/states.yml&#39;</span><span class="p">)</span>
+
     <span class="k">def</span> <span class="nf">states</span>
-      <span class="k">unless</span> <span class="vi">@states</span>
-        <span class="vi">@states</span> <span class="o">=</span> <span class="p">{}</span>
-        <span class="no">YAML</span><span class="o">::</span><span class="nb">load</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">__FILE__</span><span class="p">),</span> <span class="s1">&#39;nytimes-style/states.yml&#39;</span><span class="p">)))</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">state</span><span class="o">|</span>
-          <span class="vi">@states</span><span class="o">[</span><span class="n">state</span><span class="o">[</span><span class="s1">&#39;postal_code&#39;</span><span class="o">]]</span> <span class="o">=</span> <span class="vi">@states</span><span class="o">[</span><span class="n">state</span><span class="o">[</span><span class="s1">&#39;name&#39;</span><span class="o">]]</span> <span class="o">=</span> <span class="n">state</span>
-        <span class="k">end</span>
+      <span class="vi">@states</span> <span class="o">||=</span> <span class="no">YAML</span><span class="o">::</span><span class="nb">load</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="no">STATE_DATA_FILE</span><span class="p">))</span><span class="o">.</span><span class="n">inject</span><span class="p">({})</span> <span class="k">do</span> <span class="o">|</span><span class="n">h</span><span class="p">,</span> <span class="n">state</span><span class="o">|</span>
+        <span class="n">h</span><span class="o">.</span><span class="n">merge</span><span class="p">({</span> <span class="n">state</span><span class="o">[</span><span class="s1">&#39;postal_code&#39;</span><span class="o">]</span> <span class="o">=&gt;</span> <span class="n">state</span><span class="p">,</span> <span class="n">state</span><span class="o">[</span><span class="s1">&#39;name&#39;</span><span class="o">]</span> <span class="o">=&gt;</span> <span class="n">state</span> <span class="p">})</span>
       <span class="k">end</span>
-      <span class="k">return</span> <span class="vi">@states</span>
     <span class="k">end</span>
+    
 
   <span class="k">end</span>
 <span class="k">end</span></pre></div>

data/lib/nytimes-style.rb

@@ -2,18 +2,18 @@ require 'date'
 require 'yaml'
 
 # A small set of helper methods for generating text that conforms to _The New York Times Manual of Style and Usage_,
-# written by [Andrei Scheinkman](https://andreischeinkman.com) and hosted on [Github](https://github.com/ascheink/nytimes-style).
+# hosted on [Github](https://github.com/ascheink/nytimes-style).
 module Nytimes
   module Style
     
     # > "In general, spell out the first nine cardinal and 
     # > ordinal numbers [but] spell any number that begins a sentence..."
-    # There are many exceptions to this rule including "ages of people 
+    # Exceptions include "ages of people 
     # and animals," "sums of money," "degrees of temperature" and "mentions of the Twelve 
     # Apostles and the Ten Commandments."
     def nytimes_number(n)
       if n < 10
-        %w(one two three four five six seven eight nine ten)[n - 1]
+        %w(one two three four five six seven eight nine)[n - 1]
       else
         n.to_s
       end
@@ -26,7 +26,9 @@ module Nytimes
     def nytimes_date(date, opts={})
       str = ""
       str << date.strftime('%A, ') if opts[:day_of_week]
-      str << "#{nytimes_month_and_day date}, #{date.year}"
+      str << nytimes_month_and_day(date)
+      str << ", #{date.year}" unless opts[:hide_current_year] && date.year == Date.today.year
+      return str
     end
     
     def nytimes_month_and_day(date)
@@ -50,16 +52,15 @@ module Nytimes
     end
     
     private
-    
+
+    STATE_DATA_FILE = File.join(File.dirname(__FILE__), 'nytimes-style/states.yml')
+
     def states
-      unless @states
-        @states = {}
-        YAML::load(File.open(File.join(File.dirname(__FILE__), 'nytimes-style/states.yml'))).each do |state|
-          @states[state['postal_code']] = @states[state['name']] = state
-        end
+      @states ||= YAML::load(File.open(STATE_DATA_FILE)).inject({}) do |h, state|
+        h.merge({ state['postal_code'] => state, state['name'] => state })
       end
-      return @states
     end
+    
 
   end
 end

data/lib/nytimes-style/version.rb

@@ -1,5 +1,5 @@
 module Nytimes
   module Style
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/test/test_nytimes_style.rb

@@ -5,21 +5,29 @@ class NytimesStyleTest < Test::Unit::TestCase
 
   def test_dates
     date = Date.civil(2001, 9, 11)
-    assert_equal nytimes_month_and_day(date), "Sept. 11"
-    assert_equal nytimes_date(date), "Sept. 11, 2001"
-    assert_equal nytimes_date(date, :day_of_week => true), "Tuesday, Sept. 11, 2001"
+    assert_equal "Sept. 11", nytimes_month_and_day(date)
+    assert_equal "Sept. 11, 2001", nytimes_date(date)
     assert_raise(ArgumentError) { nytimes_month(0) }
   end
   
+  def test_date_options
+    date = Date.civil(2001, 9, 11)
+    assert_equal "Tuesday, Sept. 11, 2001", nytimes_date(date, :day_of_week => true)
+    assert_equal "Sept. 11, 2001", nytimes_date(date, :hide_current_year => true)
+    this_year = Date.today.year
+    recent_date = Date.civil(this_year, 2, 12)
+    assert_equal "Feb. 12", nytimes_date(recent_date, :hide_current_year => true)
+  end
+  
   def test_state_abbrevs
-    assert_equal nytimes_state_abbrev('AZ'), 'Ariz.'
-    assert_equal nytimes_state_abbrev('New Hampshire'), 'N.H.'
+    assert_equal 'Ariz.', nytimes_state_abbrev('AZ')
+    assert_equal 'N.H.',  nytimes_state_abbrev('New Hampshire'), 
     assert_raise(ArgumentError) { nytimes_state_abbrev('Canada') }
   end
   
   def test_numbers
-    assert_equal nytimes_number(5), 'five'
-    assert_equal nytimes_number(12), '12'
+    assert_equal 'five', nytimes_number(5)
+    assert_equal '12', nytimes_number(12)
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nytimes-style
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Andrei Scheinkman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
+date: 2011-06-09 00:00:00 -04:00
 default_executable: 
 dependencies: []