format_alias 0.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in format_alias.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,44 @@
+= Format Alias
+
+= Installation
+
+Include following line in your Gemfile:
+
+  gem 'format_alias'
+  
+= Usage
+
+== Date formatting
+
+Useful when you want user to input formatted dates.
+
+  class News < ActiveRecord::Base
+    date_format_alias :created_at, '%d/%m/%Y'
+  end
+
+  item = News.new
+  item.created_at_formatted = '12.01.2001'
+  item.created_at # 2001-01-12
+
+== Setting polymorphic attribute.
+
+  Useful when you want to set variables from such select:
+
+    <select name="imageable">
+      <option value="Image:3">Image</option>
+      <option value="Banner:1">Banner</option>
+      ...
+    </select>
+
+    class News < ActiveRecord::Base
+      belongs_to :imageable, :polymorphic => true
+    
+      polymorphic_alias :imageable
+    end
+  
+    item = News.new
+    item.imageable = "Image:3"
+    item.imageable_id   # 3
+    item.imageable_type # Image
+  
+= To be continued...

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/format_alias.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "format_alias/version"
+
+Gem::Specification.new do |s|
+  s.name        = "format_alias"
+  s.version     = FormatAlias::VERSION
+  s.authors     = ["Victor Sokolov"]
+  s.email       = ["gzigzigzeo@gmail.com"]
+  s.homepage    = "http://github.com/gzigzigzeo/format_alias"
+  s.summary     = %q{ActiveRecord attribute accessor aliases for date formatting etc.}
+  s.description = %q{ActiveRecord attribute accessor aliases for date formatting etc.}
+
+  s.rubyforge_project = "format_alias"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'activerecord', '>= 3.0'
+  s.add_dependency 'activesupport', '>= 3.0'  
+  
+  s.add_development_dependency('rspec-rails')  
+  s.add_development_dependency('sqlite3-ruby')
+end

data/lib/format_alias.rb

@@ -0,0 +1,6 @@
+require 'active_support/concern'
+require "format_alias/version"
+require "format_alias/base"
+require "format_alias/formatters/date_format"
+require "format_alias/formatters/polymorphic_alias"
+require "format_alias/railtie"

data/lib/format_alias/base.rb

@@ -0,0 +1,20 @@
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/date_time/zones'
+require 'tzinfo'
+
+module FormatAlias
+  module Base
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def format_alias(attr, getter, setter, *args)
+        options = args.extract_options!
+        name = options.delete(:as) || "#{attr}_formatted"
+
+        define_method name, &getter
+        define_method "#{name}=", &setter
+      end
+    end
+  end
+end

data/lib/format_alias/formatters/date_format.rb

@@ -0,0 +1,14 @@
+module FormatAlias
+  module Base
+    module ClassMethods
+      def date_format_alias(attr, format, *args)
+        format_alias(
+          attr,
+          proc { send(attr).strftime(format) unless send(attr).nil? },
+          proc { |value| send(:"#{attr}=", (Time.parse(value, format) rescue nil)) },
+          *args
+        )
+      end
+    end
+  end
+end

data/lib/format_alias/formatters/polymorphic_alias.rb

@@ -0,0 +1,35 @@
+module FormatAlias
+  module Base
+    module ClassMethods
+      def polymorphic_alias(attr, *args)
+        options = args.extract_options!
+        polymorphic = options.delete(:polymorphic) || true
+        attrs = options.delete(:attrs)
+        delim = options.delete(:delimiter) || ':'
+
+        raise ArgumentError, "Specify :polymorphic or :attrs option for polymorphic_alias :#{attr} in #{self.name}" if attrs.blank? && polymorphic.blank?
+
+        if polymorphic
+          attrs = ["#{attr}_type", "#{attr}_id"]
+          options[:as] ||= "#{attr}_type_id"
+        else
+          options[:as] ||= "#{attr}_split"
+        end
+      
+        format_alias(
+          attr,
+          proc {
+            r = attrs.map { |a| send(a) }.compact
+            r.present? ? r.join(delim) : nil
+          },
+          proc { |value|
+            values = value.to_s.split(delim)
+            h = Hash[attrs.zip(values)]
+            h.map { |a, v| send("#{a}=", v) }
+          },
+          options
+        )
+      end
+    end
+  end
+end

data/lib/format_alias/railtie.rb

@@ -0,0 +1,11 @@
+module FormatAlias
+  if defined?(Rails::Railtie)
+    class Railtie < Rails::Railtie
+      initializer 'format_alias.extend_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:include, FormatAlias::Base)
+        end
+      end
+    end
+  end
+end  

data/lib/format_alias/version.rb

@@ -0,0 +1,3 @@
+module FormatAlias
+  VERSION = "0.0.4"
+end

data/spec/format_alias/format_alias_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "FormatAlias spec" do
+  before(:each) do
+    @t = TestClass.new
+  end
+
+  context "date/time conversions" do
+    it "should correctly convert dates" do
+      d = DateTime.new(2009, 1, 1)
+      @t.d = d
+      @t.d_formatted.should eq("20090101")
+    
+      @t.d_formatted = nil
+      @t.d.should be_nil
+    
+      @t.d_formatted = "20090202"
+      @t.d.should_not be_nil
+      @t.d.year.should eq(2009)
+      @t.d.month.should eq(2)
+      @t.d.day.should eq(2)
+    end
+  
+    it "should correctly convert dates with time zones" do
+      d = DateTime.new(2009, 1, 1, 12, 0)
+      @t.dt = d
+      @t.dt_formatted.should eq("20090101 12:00")
+
+      Time.use_zone 'Moscow' do
+        d = DateTime.new(2009, 1, 1, 12, 0)
+        @t.dt = d
+        @t.dt_formatted.should eq("20090101 12:00")
+      end
+    end
+  end
+  
+  context "polymorphic conversions" do
+    it "should correctly convert polymorphic" do
+      @t.poly_type_id = "Page:3"
+      @t.poly_type.should == 'Page'
+      @t.poly_id.should == '3'
+      
+      @t.poly_type_id = "Banner:4"
+      @t.poly_type_id.should == "Banner:4"
+      
+      @t.poly_type_id = nil
+      @t.poly_type_id.should == nil
+
+      @t.poly_type = nil
+      @t.poly_id = 5
+      @t.poly_type_id.should == "5"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+begin
+  require "bundler"
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+Bundler.require
+
+require 'support/test_class'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/support/test_class.rb

@@ -0,0 +1,13 @@
+class TestClass
+  include FormatAlias::Base
+  
+  attr_accessor :d, :dt
+  attr_accessor :poly_id, :poly_type
+  attr_accessor :value1, :value2, :value3
+  
+  date_format_alias(:d, "%Y%m%d")
+  date_format_alias(:dt, "%Y%m%d %H:%M")
+  
+  polymorphic_alias(:poly, :polymorphic => true)
+  polymorphic_alias(:values, :attrs => [:value1, :value2, :value3])
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: format_alias
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Victor Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-29 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id004
+description: ActiveRecord attribute accessor aliases for date formatting etc.
+email: 
+- gzigzigzeo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- format_alias.gemspec
+- lib/format_alias.rb
+- lib/format_alias/base.rb
+- lib/format_alias/formatters/date_format.rb
+- lib/format_alias/formatters/polymorphic_alias.rb
+- lib/format_alias/railtie.rb
+- lib/format_alias/version.rb
+- spec/format_alias/format_alias_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb
+has_rdoc: true
+homepage: http://github.com/gzigzigzeo/format_alias
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: format_alias
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ActiveRecord attribute accessor aliases for date formatting etc.
+test_files: 
+- spec/format_alias/format_alias_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb