typed_accessors 0.1 → 0.2

data/README

@@ -1,9 +1,12 @@
-This rails plugin creates a set of typed accessors for data types.
-This is very handy when you are interacting with a service that
-returns strings and you want them automatically turned into more
-useful types.
+= Overview
 
-Ex:
+Typed accessors creates a set of accessors with a predefined typed.
+Often when dealing with webservices all the data comes back as
+strings, but you really want to be working with these things as
+numbers or dates.  Manually converting them is duplication, and can be
+error prone.
+
+== Example
 
   class Foo
     float_accessor :float
@@ -27,4 +30,21 @@ Ex:
   >> f.date.to_s
   => "2009-10-30"
 
-This work was done by Patt Ladd.  Sean Dague has helped in packaging it.
+== Installation
+
+First install the gem
+
+  gem install typed_accesors
+
+Then include it in your environment
+
+  require "typed_accessors"
+
+== Authors
+
+Creator: Pat Ladd
+Packager: Sean Dague
+
+== License
+
+This is released under an MIT license, see COPYING for full details.

data/Rakefile

@@ -4,8 +4,10 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/clean'
 require 'rake/contrib/sshpublisher'
+require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "0.1"
+PKG_NAME = "typed_accessors"
+PKG_VERSION = "0.2"
 
 $VERBOSE = nil
 TEST_CHANGES_SINCE = Time.now - 600 # Recent tests = changed in last 10 minutes
@@ -49,32 +51,32 @@ Rake::RDocTask.new(:doc) { |rdoc|
   rdoc.main = 'README'
   rdoc.rdoc_files.include('lib/**/*.rb', 'README')
   rdoc.rdoc_files.include('COPYING')
-  rdoc.rdoc_dir = 'docs/api'
+  rdoc.rdoc_dir = 'docs/typed_accessors'
   rdoc.title    = "Typed Accessors"
   rdoc.options << "--include=examples --line-numbers --inline-source"
-  rdoc.options << "--accessor=ical_component,ical_property,ical_multi_property"
 }
 
 Gem::manage_gems 
 require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s| 
-  s.name = "typed_accessors" 
-  s.version = PKG_VERSION 
-  s.homepage = "http://github.com/sdague/typed_accessors" 
-  s.platform = Gem::Platform::RUBY 
-  s.summary = "Predefined typed accessors" 
-  s.description = "Defines easy to use additional functions to creating typed accessors, which auto convert the attributes to non string types"
-
-  s.files = FileList["{test,lib,docs,examples}/**/*"].to_a
-  s.files += ["Rakefile", "README", "COPYING" ]
-  s.require_path = "lib" 
-  s.autorequire = "typed_accessors" 
-  s.has_rdoc = true 
-  s.extra_rdoc_files = ["README", "COPYING"]
-  s.rdoc_options.concat ['--main', 'README']
-
-  s.author = "Pat Ladd" 
+    s.name = "typed_accessors" 
+    s.version = PKG_VERSION 
+    s.homepage = "http://github.com/sdague/typed_accessors" 
+    s.platform = Gem::Platform::RUBY 
+    s.summary = "Predefined typed accessors" 
+    s.description = "Defines easy to use additional functions to creating typed accessors, which auto convert the attributes to non string types"
+    s.rubyforge_project = "http://rubyforge.org/projects/sdaguegems"
+    s.files = FileList["{test,lib,docs,examples}/**/*"].to_a
+    s.files += ["Rakefile", "README", "COPYING" ]
+    s.require_path = "lib" 
+    s.autorequire = "typed_accessors" 
+    s.has_rdoc = true 
+    s.extra_rdoc_files = ["README", "COPYING"]
+    s.rdoc_options.concat ['--main', 'README']
+    s.rdoc_options.concat ['--accessor int_accessor="RW int" --accessor int_reader="R int" --accessor int_writer="W int" --accessor float_accessor="RW float" --accessor float_reader="R float" --accessor float_writer="W float" --accessor bool_yn_accessor="RW bool" --accessor bool_yn_reader="R bool" --accessor bool_yn_writer="W bool"']
+    s.author = "Sean Dague"
+    s.email = "sean@dague.net"
 end 
 
 Rake::GemPackageTask.new(spec) do |pkg| 
@@ -83,18 +85,50 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_zip = true
 end
 
+desc "Publish the release files to RubyForge."
+task :release => [ :package, :publish_docs ] do
+    require 'rubyforge'
+    packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}" }
+    rubyforge = RubyForge.new
+    rubyforge.configure
+    rubyforge.login
+    rubyforge.scrape_project("sdaguegems")
+    rubyforge.add_release("sdaguegems", PKG_NAME, "v#{PKG_VERSION}", *packages)
+end
+
 desc 'Install the gem globally (requires sudo)'
 task :install => :package do |t|
   `sudo gem install pkg/typed_accessors-#{PKG_VERSION}.gem`
 end
 
+desc "Upload Docs to RubyForge"
+task :publish_docs => [:doc] do
+    publisher = Rake::SshDirPublisher.new(
+                                          "sdague@rubyforge.org",
+                                          "/var/www/gforge-projects/sdaguegems",
+                                          "docs"
+                                          )
+    publisher.upload
+end
+
+# task :release => [:clobber, :verify_committed, :spec, :publish_packages, :tag, :publish_news]
+
+desc "Verifies that there is no uncommitted code"
+task :verify_committed do
+  IO.popen('svn stat') do |io|
+    io.each_line do |line|
+      raise "\n!!! Do a svn commit first !!!\n\n" if line =~ /^\s*modified:\s*/
+    end
+  end
+end
+
 task :lines do
   lines = 0
   codelines = 0
-  Dir.foreach("lib/typed_accessors") { |file_name|
+  Dir.foreach("lib") { |file_name|
     next unless file_name =~ /.*rb/
 
-    f = File.open("lib/typed_accessors/" + file_name)
+    f = File.open("lib/" + file_name)
 
     while line = f.gets
       lines += 1

data/docs/typed_accessors/classes/Class.html

@@ -0,0 +1,260 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Class</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Class</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/typed_accessors_rb.html">
+                lib/typed_accessors.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Typed accessors works as a Mixin on <a href="Class.html">Class</a>. It
+creates a set of functions that are used in the class definition which eval
+and create new accessor methods at class eval time (so little performance
+penalty). For now, this is limitted to built in types, float, int, boolean,
+and date, though this approach could clearly be expanded.
+</p>
+<p>
+Example of a class definition
+</p>
+<pre>
+  class MyClass
+    float_accessor :distance
+    int_accessor :count
+    bool_yn_accessor :onfire
+    date_accessor :day
+  end
+</pre>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">bool_yn_accessor</a>&nbsp;&nbsp;
+      <a href="#M000004">date_accessor</a>&nbsp;&nbsp;
+      <a href="#M000002">float_accessor</a>&nbsp;&nbsp;
+      <a href="#M000003">int_accessor</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">bool_yn_accessor</span><span class="method-args">( *symbols )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a boolean accessor. It will convert and incoming string to a true /
+false value. If the string is &quot;y&quot; or &quot;yes&quot; it will be
+true, otherwise false.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/typed_accessors.rb, line 22</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bool_yn_accessor</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">attr_reader</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">bool_yn_writer</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">date_accessor</span><span class="method-args">( *symbols )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a data accessor using the Date parse function on strings. Not
+defined for other input types.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/typed_accessors.rb, line 44</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">date_accessor</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">attr_reader</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">date_writer</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">float_accessor</span><span class="method-args">( *symbols )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a float accessor, using built in .to_f functions on objects. Any
+object that has a .to_f is supported.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/typed_accessors.rb, line 30</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">float_accessor</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">attr_reader</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">float_writer</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">int_accessor</span><span class="method-args">( *symbols )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates an int accessor, using built in .to_i functions on objects. Any
+object that has a .to_i is supported.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/typed_accessors.rb, line 37</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">int_accessor</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">attr_reader</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+        <span class="ruby-identifier">int_writer</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">symbols</span> )
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/docs/typed_accessors/created.rid

@@ -0,0 +1 @@
+Sun, 29 Mar 2009 12:38:25 -0400

data/docs/typed_accessors/files/COPYING.html

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: COPYING</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>COPYING</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>COPYING
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Mar 27 16:49:34 -0400 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The MIT License
+</p>
+<p>
+Copyright (c) 2009 Patrick Ladd, Sean Dague &lt;<a
+href="http://dague.net">dague.net</a>&gt;
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&quot;Software&quot;), 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:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>