has_duration 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/README.md

@@ -0,0 +1,34 @@
+# @markup markdown
+
+# HasDuration
+
+Do you use rails time convenience methods? Those things are great, they let you do stuff like `1.day.from_now` or `Time.now - 10.years`. The `10.years` part is an {ActiveSupport::Duration} object.
+
+This plugin extends ActiveRecord so you can conveniently store durations like: how often to contact a given customer, or how long can your users stay in the bathtub without their fingertips wrinkling.
+
+
+## Installation: Add this to your Gemfile
+
+    gem 'has_duration'
+
+## Given a table defined as:
+
+    create_table :user do |t|
+      t.string :contact_every, null: false
+      t.string :bathtub_tolerance
+    end
+
+## You can have a model like this
+
+    class User < ActiveRecord::Base
+      has_duration :contact_every
+      # Has duration does not validate presence, you have to do that yourself.
+      validates :contact_every, presence: true
+      has_duration :bathtub_tolerance
+    end
+
+    user = User.create!(contact_every: 1.year, bathtub_tolerance: 30.minutes)
+    puts 'that must be a record' if customer.bathtub_tolerance > 3.hours
+    puts "If contacted today, next contact would be made on #{user.contact_every.from_now}"
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasDuration'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/has_duration/version.rb

@@ -0,0 +1,3 @@
+module HasDuration
+  VERSION = "0.0.1"
+end

data/lib/has_duration.rb

@@ -0,0 +1,55 @@
+# The DurationValidator checks that a given field has an {ActiveSupport::Duration} or nil
+# If you also need presence checks you should use ActiveSupport's built in presence validator.
+# @note
+#   Although this method is available to you, you should use
+#   {HasDuration::ActiveRecordExtension::has_duration} which also adds serialization.
+class DurationValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value.is_a?(ActiveSupport::Duration) || value.nil?
+      record.errors[attribute] << 'must be an ActiveSupport::Duration (1.month, 2.years, etc)'
+    end
+  end
+end
+
+module HasDuration
+  # The DurationSerializer is a custom ActiveRecord serializer that stores durations in a text
+  # field in your model.
+  # @note
+  #   Although this method is available to you, you should use
+  #   {HasDuration::ActiveRecordExtension::has_duration} which also adds validation.
+  class DurationSerializer
+    def self.dump(duration)
+      duration.inspect.gsub(' ','.') if duration.is_a?(ActiveSupport::Duration)
+    end
+    
+    def self.load(duration)
+      return if duration.nil?
+      if duration =~ /^(\d{0,10})\.(year|month|week|day|hour|minute|second)s?$/
+        $1.to_i.send($2)
+      end
+    end
+  end
+
+  module ActiveRecordExtension
+    # Adds a field to your ActiveRecord model that validates and serializes ActiveSupport::Duration objects, like: '1 year', '2 seconds', etc.
+    #
+    # For example:
+    #       class VisitDuration < ActiveRecord::Base
+    #         has_duration :doctor
+    #         validates :doctor, presence: true
+    #         has_duration :club
+    #       end
+    #
+    #       # ruby > durations = VisitDuration.create(doctor: 1.hour, club: 4.hours)
+    #       # ruby > Time.now
+    #       # => 2012-09-16 12:12:22 -0300 
+    #       # ruby > durations.doctor.from_now
+    #       # => 2012-09-16 13:12:22 -0300 
+    def has_duration(field_name)
+      serialize field_name, DurationSerializer
+      validates field_name, duration: true
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, HasDuration::ActiveRecordExtension)

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: has_duration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- nubis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70311913057680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311913057680
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70311913057160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70311913057160
+description: ! 'Extends ActiveRecord to let you store time durations like ''1.month''
+  or ''10.years''.
+
+  It does it by providing a serializer and validator for ActiveSupport::Duration objects.
+
+'
+email:
+- nubis@woobiz.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/has_duration/version.rb
+- lib/has_duration.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/nubis/has_duration
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Extends ActiveRecord to let you store time durations like '1.month' or '10.years'
+test_files: []
+has_rdoc: