typed_accessors 0.2 → 0.3.0

data/History.txt

@@ -0,0 +1,8 @@
+=== 0.3.0 2010-03-07
+* 1 major enhancement:
+  * Convert to newgem style package
+
+=== 0.2.0 2009-03-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/website.yml
+lib/typed_accessors.rb
+lib/typed_accessors/class.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+test/test_helper.rb
+test/test_typed_accessors.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on typed_accessors, see http://sdaguegems.rubyforge.org/typed_accessors
+
+

data/README.rdoc

@@ -0,0 +1,69 @@
+= typed_accessors
+
+* http://github.com/sdague/typed_accessors
+
+== DESCRIPTION:
+
+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.
+
+== SYNOPSIS:
+
+  class Foo
+    float_accessor :float
+    date_accessor :date
+  end
+
+  >> f = Foo.new
+  => #<Foo:0xb7a3dd44>
+  >> f.float = "1.4"
+  => "1.4"
+  >> f.float
+  => 1.4
+  >> f.float = "1"
+  => "1"
+  >> f.float
+  => 1.0
+  >> f.date = "2009-10-30"
+  => "2009-10-30"
+  >> f.date
+  => #<Date: 4910269/2,0,2299161>
+  >> f.date.to_s
+  => "2009-10-30"
+
+
+== REQUIREMENTS:
+
+
+== INSTALL:
+
+  sudo gem install typed_accessors
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009-2010 Pat Ladd
+Copyright (c) 2009-2010 Sean Dague
+
+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/Rakefile

@@ -1,143 +1,28 @@
-require 'rubygems' 
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/clean'
-require 'rake/contrib/sshpublisher'
-require 'rake/contrib/rubyforgepublisher'
-
-PKG_NAME = "typed_accessors"
-PKG_VERSION = "0.2"
-
-$VERBOSE = nil
-TEST_CHANGES_SINCE = Time.now - 600 # Recent tests = changed in last 10 minutes
-
-desc "Run all the unit tests"
-task :default => [ :test, :lines ]
-
-desc "Run the unit tests in test"
-Rake::TestTask.new(:test) { |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*_test.rb', 'test/component/*_test.rb']
-  t.verbose = true
-}
-
-# rcov code coverage
-rcov_path = '/usr/local/bin/rcov'
-rcov_test_output = "./test/coverage"
-rcov_exclude = "interactive.rb,read_write.rb,fixtures"
-
-# Add our created paths to the 'rake clobber' list
-CLOBBER.include(rcov_test_output)
-
-desc 'Removes all previous unit test coverage information'
-task (:reset_unit_test_coverage) do |t|
-  rm_rf rcov_unit_test_output
-  mkdir rcov_unit_test_output
-end
-
-desc 'Run all unit tests with Rcov to measure coverage'
-Rake::TestTask.new(:rcov) do |t|
-  t.libs << "test"
-  t.pattern = 'test/**/*_test.rb'
-  t.ruby_opts << rcov_path
-  t.ruby_opts << "-o #{rcov_test_output}"
-  t.ruby_opts << "-x #{rcov_exclude}"
-  t.verbose = true
-end
-
-# Generate the RDoc documentation
-Rake::RDocTask.new(:doc) { |rdoc|
-  rdoc.main = 'README'
-  rdoc.rdoc_files.include('lib/**/*.rb', 'README')
-  rdoc.rdoc_files.include('COPYING')
-  rdoc.rdoc_dir = 'docs/typed_accessors'
-  rdoc.title    = "Typed Accessors"
-  rdoc.options << "--include=examples --line-numbers --inline-source"
-}
-
-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.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| 
-  pkg.gem_spec = spec
-  pkg.need_tar = true
-  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") { |file_name|
-    next unless file_name =~ /.*rb/
-
-    f = File.open("lib/" + file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-  }
-  puts "\n------------------------------\n"
-  puts "Total Lines: #{lines}"
-  puts "Lines of Code: #{codelines}"
-end
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/typed_accessors'
+
+ENV['VERSION'] = TypedAccessors::VERSION
+
+Hoe.plugin :newgem
+Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'typed_accessors' do
+  self.developer 'Sean Dague', 'sean@dague.net'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = "sdaguegems" # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/config/website.yml

@@ -0,0 +1,2 @@
+host: sdague@rubyforge.org
+remote_dir: /var/www/gforge-projects/sdaguegems/typed_accessors

data/lib/typed_accessors.rb

@@ -1,100 +1,8 @@
-# Typed accessors works as a Mixin on Class.  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.
-#
-# Example of a class definition
-#
-#   class MyClass
-#     float_accessor :distance
-#     int_accessor :count
-#     bool_yn_accessor :onfire
-#     date_accessor :day
-#   end
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-class Class
-    
-    # Creates a boolean accessor.  It will convert and incoming string
-    # to a true / false value.  If the string is "y" or "yes" it will be
-    # true, otherwise false.
-    def bool_yn_accessor( *symbols )
-        attr_reader( *symbols )
-        bool_yn_writer( *symbols )
-    end
+require "typed_accessors/class.rb"
 
-    
-    # Creates a float accessor, using built in .to_f functions on
-    # objects.  Any object that has a .to_f is supported.
-    def float_accessor( *symbols )
-        attr_reader( *symbols )
-        float_writer( *symbols )
-    end
-    
-    # Creates an int accessor, using built in .to_i functions on
-    # objects.  Any object that has a .to_i is supported.
-    def int_accessor( *symbols )
-        attr_reader( *symbols )
-        int_writer( *symbols )
-    end
-    
-    # Creates a data accessor using the Date parse function on
-    # strings.  Not defined for other input types.
-    def date_accessor( *symbols )
-        attr_reader( *symbols )
-        date_writer( *symbols )
-    end
-
-    private
-    
-    def date_writer( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}=(val)
-                    if val.is_a? String
-                        instance_variable_set("@#{symbol}", Date.parse(val))
-                    else
-                        instance_variable_set("@#{symbol}", val)
-                    end
-                end
-            EOS
-        end
-    end
-    
-    def bool_yn_writer( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}=(val)
-                    if (val.is_a? String and val =~ /^(y(es)?|t(rue)?)$/i) or val == true then
-                        instance_variable_set("@#{symbol}", true)
-                    else
-                        instance_variable_set("@#{symbol}", false)
-                    end
-                end
-            EOS
-        end
-    end
-        
-    def float_writer( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}=(val)
-                    if !val.respond_to?('to_f') then raise ArgumentError, "#{symbol} must be Float" end
-                    instance_variable_set("@#{symbol}", val.to_f)
-                end
-            EOS
-        end
-    end
-
-    def int_writer( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}=(val)
-                    if !val.respond_to?('to_i') then raise ArgumentError, "#{symbol} must be Integer" end
-                    instance_variable_set("@#{symbol}", val.to_i)
-                end
-            EOS
-        end
-    end
+module TypedAccessors
+    VERSION = '0.3.0'
 end

data/lib/typed_accessors/class.rb

@@ -0,0 +1,100 @@
+# Typed accessors works as a Mixin on Class.  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.
+#
+# Example of a class definition
+#
+#   class MyClass
+#     float_accessor :distance
+#     int_accessor :count
+#     bool_yn_accessor :onfire
+#     date_accessor :day
+#   end
+
+class Class
+    
+    # Creates a boolean accessor.  It will convert and incoming string
+    # to a true / false value.  If the string is "y" or "yes" it will be
+    # true, otherwise false.
+    def bool_yn_accessor( *symbols )
+        attr_reader( *symbols )
+        bool_yn_writer( *symbols )
+    end
+
+    
+    # Creates a float accessor, using built in .to_f functions on
+    # objects.  Any object that has a .to_f is supported.
+    def float_accessor( *symbols )
+        attr_reader( *symbols )
+        float_writer( *symbols )
+    end
+    
+    # Creates an int accessor, using built in .to_i functions on
+    # objects.  Any object that has a .to_i is supported.
+    def int_accessor( *symbols )
+        attr_reader( *symbols )
+        int_writer( *symbols )
+    end
+    
+    # Creates a data accessor using the Date parse function on
+    # strings.  Not defined for other input types.
+    def date_accessor( *symbols )
+        attr_reader( *symbols )
+        date_writer( *symbols )
+    end
+
+    private
+    
+    def date_writer( *symbols )
+        symbols.each do |symbol|
+            class_eval(<<-EOS, __FILE__, __LINE__)
+                def #{symbol}=(val)
+                    if val.is_a? String
+                        instance_variable_set("@#{symbol}", Date.parse(val))
+                    else
+                        instance_variable_set("@#{symbol}", val)
+                    end
+                end
+            EOS
+        end
+    end
+    
+    def bool_yn_writer( *symbols )
+        symbols.each do |symbol|
+            class_eval(<<-EOS, __FILE__, __LINE__)
+                def #{symbol}=(val)
+                    if (val.is_a? String and val =~ /^(y(es)?|t(rue)?)$/i) or val == true then
+                        instance_variable_set("@#{symbol}", true)
+                    else
+                        instance_variable_set("@#{symbol}", false)
+                    end
+                end
+            EOS
+        end
+    end
+        
+    def float_writer( *symbols )
+        symbols.each do |symbol|
+            class_eval(<<-EOS, __FILE__, __LINE__)
+                def #{symbol}=(val)
+                    if !val.respond_to?('to_f') then raise ArgumentError, "#{symbol} must be Float" end
+                    instance_variable_set("@#{symbol}", val.to_f)
+                end
+            EOS
+        end
+    end
+
+    def int_writer( *symbols )
+        symbols.each do |symbol|
+            class_eval(<<-EOS, __FILE__, __LINE__)
+                def #{symbol}=(val)
+                    if !val.respond_to?('to_i') then raise ArgumentError, "#{symbol} must be Integer" end
+                    instance_variable_set("@#{symbol}", val.to_i)
+                end
+            EOS
+        end
+    end
+end