roovo-dm-form_friendly_integer 1.0.0

data/CHANGELOG

@@ -0,0 +1 @@
+v1.0.0.  Initial Version

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2009 roovo
+
+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/Manifest

@@ -0,0 +1,12 @@
+autotest/discover.rb
+CHANGELOG
+lib/dm-form_friendly_integer.rb
+lib/dm-types/form_friendly_integer.rb
+LICENSE
+Manifest
+Rakefile
+README.rdoc
+spec/integration/form_friendly_integer_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/spec.rake

data/README.rdoc

@@ -0,0 +1,63 @@
+= DataMapper::Types::FormFriendlyInteger
+
+An adaptation of the DataMapper Integer type designed to work well with web forms.
+It behaves in the same way as the standard DataMapper Integer type when writing
+the property to the database but it doesn't immediately typecast the property unless
+it is an integer string.  The example below illustrates this.
+
+The reason for wanting this behaviour is to ensure that if an invalid entry is
+fed into a web form then when the form is re-displayed with it's errors, the
+value in the form input will be as it was when it was entered.
+
+== EXAMPLE:
+
+  model MyModel
+    include DataMapper::Resource
+
+    property :id,         Serial
+    property :a_number,   Integer
+    property :ff_number,  FormFriendlyInteger
+  end
+
+The +a_number+ property will behave as follows:
+
+  my_model = MyModel.new
+  my_model.a_number   = 7
+  my_model.ff_number  = 7
+  my_model.a_number                       # => 7
+  my_model.ff_number                      # => 7
+  my_model.save
+  Model.get(my_model.id).a_number         # => 7
+  Model.get(my_model.id).ff_number        # => 7
+
+  my_model = MyModel.new
+  my_model.a_number   = -7
+  my_model.ff_number  = -7
+  my_model.a_number                       # => -7
+  my_model.ff_number                      # => -7
+  my_model.save
+  Model.get(my_model.id).a_number         # => -7
+  Model.get(my_model.id).ff_number        # => -7
+
+  my_model = MyModel.new
+  my_model.a_number   = "7.45"
+  my_model.ff_number  = "7.45"
+  my_model.a_number                       # => 7
+  my_model.ff_number                      # => "7.45"
+  my_model.save
+  Model.get(my_model.id).a_number         # => 7
+  Model.get(my_model.id).ff_number        # => 7
+
+  my_model = MyModel.new
+  my_model.a_number   = "not a number"
+  my_model.ff_number  = "not a number"
+  my_model.a_number                       # => nil
+  my_model.ff_number                      # => "not a number"
+  my_model.save
+  Model.get(my_model.id).a_number         # => 0
+  Model.get(my_model.id).ff_number        # => 0
+
+  my_model = MyModel.new
+  my_model.a_number   = []                # => nothing raised
+  my_model.ff_number  = []                # => raise(ArgumentError, '+value+ must be nil or a String')
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'pathname'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+
+Echoe.new('dm-form_friendly_integer') do |p|
+  p.description               = "A DataMapper Integer type which behaves well on forms"
+  p.url                       = "http://github.com/roovo/dm-form_friendly_integer"
+  p.author                    = "roovo"
+  p.email                     = "roovo@roovoweb.com"
+  p.ignore_pattern            = ["tmp/*", "script/*"]
+  p.development_dependencies  = []
+  p.runtime_dependencies      = ['dm-core']
+end
+
+Pathname.glob(ROOT.join('tasks/**/*.rb').to_s).each { |f| require f }

data/autotest/discover.rb

@@ -0,0 +1,4 @@
+Autotest.add_discovery do
+  "rspec"
+end
+

data/dm-form_friendly_integer.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-form_friendly_integer}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["roovo"]
+  s.date = %q{2009-04-19}
+  s.description = %q{A DataMapper Integer type which behaves well on forms}
+  s.email = %q{roovo@roovoweb.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/dm-form_friendly_integer.rb", "lib/dm-types/form_friendly_integer.rb", "LICENSE", "README.rdoc", "tasks/spec.rake"]
+  s.files = ["autotest/discover.rb", "CHANGELOG", "lib/dm-form_friendly_integer.rb", "lib/dm-types/form_friendly_integer.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "spec/integration/form_friendly_integer_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/spec.rake", "dm-form_friendly_integer.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/roovo/dm-form_friendly_integer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Dm-form_friendly_integer", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dm-form_friendly_integer}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{A DataMapper Integer type which behaves well on forms}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0"])
+  end
+end

data/lib/dm-form_friendly_integer.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'pathname'
+
+gem     'dm-core',  '>=0.9.11'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-types' / 'form_friendly_integer'

data/lib/dm-types/form_friendly_integer.rb

@@ -0,0 +1,29 @@
+module DataMapper
+  module Types
+    # An adaption of the Integer DataMapper type designed to work well on web forms
+    #
+    # See the README for details
+    class FormFriendlyInteger < DataMapper::Type
+      primitive Integer
+
+      def self.load(value, property) #:nodoc:
+        if value.is_a?(Integer) || value.nil?
+          value
+        else
+          raise ArgumentError.new("+value+ must be nil or a String")
+        end
+      end
+
+      def self.typecast(value, property) #:nodoc:
+        if value.kind_of?(String) && value =~ /\A[+-]?\d+\z/
+          value.to_i
+        elsif value.kind_of?(String)
+          value
+        else
+          load(value, property)
+        end
+      end
+    end
+  end
+end
+

data/spec/integration/form_friendly_integer_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe DataMapper::Types::FormFriendlyInteger do
+  before(:all) do
+    class ::FormFriendlyIntegerTest
+      include DataMapper::Resource
+
+      property :id,           Serial
+      property :some_number,  FormFriendlyInteger
+    end
+    FormFriendlyIntegerTest.auto_migrate!
+  end
+
+  before(:each) do
+    FormFriendlyIntegerTest.all.destroy!
+  end
+
+  it 'should immediately typecast positive integer string values' do
+    FormFriendlyIntegerTest.new(:some_number => '345').some_number.should == 345
+  end
+
+  it 'should immediately typecast negative integer string values' do
+    FormFriendlyIntegerTest.new(:some_number => '-345').some_number.should == -345
+  end
+
+  it 'should NOT typecast decimal string values' do
+    FormFriendlyIntegerTest.new(:some_number => '345.1').some_number.should == '345.1'
+  end
+
+  it 'should NOT typecast non-numeric string values' do
+    FormFriendlyIntegerTest.new(:some_number => 'not a number').some_number.should == 'not a number'
+  end
+
+  it 'should raise an error for a non-string value' do
+    lambda { FormFriendlyIntegerTest.new(:some_number => []) }.should raise_error(ArgumentError, '+value+ must be nil or a String')
+  end
+
+  it "should save the number to the db with a positive integer string value" do
+    repository(:default) do
+      FormFriendlyIntegerTest.create(:some_number => '345')
+    end
+
+    FormFriendlyIntegerTest.first.some_number.should == 345
+  end
+
+  it "should save the number to the db with a negative integer string value" do
+    repository(:default) do
+      FormFriendlyIntegerTest.create(:some_number => '-345')
+    end
+
+    FormFriendlyIntegerTest.first.some_number.should == -345
+  end
+
+  it "should save the integer part of the string to the db with a decimal input string value" do
+    repository(:default) do
+      FormFriendlyIntegerTest.create(:some_number => '345.9')
+    end
+
+    FormFriendlyIntegerTest.first.some_number.should == 345
+  end
+
+  it "should save 0 to the db with a non-numeric input string value" do
+    repository(:default) do
+      FormFriendlyIntegerTest.create(:some_number => 'not a number')
+    end
+    FormFriendlyIntegerTest.first.some_number.should be_zero
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+require 'rubygems'
+ 
+gem 'rspec', '>=1.1.12'
+require 'spec'
+ 
+gem 'dm-core', '0.9.11'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-form_friendly_integer'
+
+begin
+  DataMapper.setup(:default,'sqlite3::memory:')
+  Object.const_set('ADAPTER', :sqlite)
+rescue Exception => e
+  Object.const_set('ADAPTER', nil)
+  warn "Could not load do_sqlite: #{e}"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: roovo-dm-form_friendly_integer
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- roovo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A DataMapper Integer type which behaves well on forms
+email: roovo@roovoweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/dm-form_friendly_integer.rb
+- lib/dm-types/form_friendly_integer.rb
+- LICENSE
+- README.rdoc
+- tasks/spec.rake
+files: 
+- autotest/discover.rb
+- CHANGELOG
+- lib/dm-form_friendly_integer.rb
+- lib/dm-types/form_friendly_integer.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/integration/form_friendly_integer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/spec.rake
+- dm-form_friendly_integer.gemspec
+has_rdoc: true
+homepage: http://github.com/roovo/dm-form_friendly_integer
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Dm-form_friendly_integer
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: dm-form_friendly_integer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A DataMapper Integer type which behaves well on forms
+test_files: []
+