format_alias 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3334f7494cf3e02c4a0082fed0e472ebb924067c
+  data.tar.gz: 0c85b6c7f2b0ae3263af9760b139481bde2c3436
+SHA512:
+  metadata.gz: 8d1cc3e40ae9ffad7a77b7ef1e87faa1699b2b97956b604f404ce9e327898768f4b708c90985ffaf0686dbd763a866dc19db831da75178af4e2e5fbdd6b68b54
+  data.tar.gz: 15bb72c6962af0cf2393cf31305bd365a47c15d292feab87cf65bcc900c7ca72f0e4e578306436afc83c11152da36399709933def9f527712bb0f185879e614a

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/README.md

@@ -0,0 +1,72 @@
+# Format Alias
+
+Provides virtual attributes to get/set certain model values in/to human
+readable format.
+
+## Date formatting
+
+```ruby
+class Foo
+  extend FormatAlias
+
+  attr_accessor :created_at
+  date_format_alias :created_at, '%d.%m.%Y'
+end
+
+bar = Foo.new
+bar.created_at_formatted = '12.01.2001'
+bar.created_at # => Sat, 01 Dec 2001
+```
+
+Accepts options:
+* `:suffix` - `formatted` by default
+* `:getter_name` - name of a getter method
+* `:setter_name` - name of a setter method (without '=')
+
+## Setting polymorphic attribute
+
+Useful when you want to set variables from such select:
+
+```html
+<select name="imageable">
+  <option value="Image:3">Image</option>
+  <option value="Banner:1">Banner</option>
+  ...
+</select>
+```
+```ruby
+class Foo < ActiveRecord::Base
+  extend FormatAlias
+  belongs_to :imageable
+  polymorphic_alias :imageable
+end
+
+bar = Foo.new
+bar.imageable_formatted = "Image:3"
+bar.imageable_id   # => 3
+bar.imageable_type # => "Image"
+```
+
+## Roll your own
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-batching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-batching
+
+## Contributing
+
+1. Fork it ( http://github.com/gzigzigzeo/format_alias/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/format_alias.gemspec

@@ -8,8 +8,14 @@ Gem::Specification.new do |s|
   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.summary     = %q{
+    Provides virtual attributes to get or set model values in human
+    readable format.
+  }
+  s.description = %q{
+    Provides virtual attributes to get or set certain model values (like
+    dates) in human readable/localized format.
+  }
 
   s.rubyforge_project = "format_alias"
 
@@ -17,10 +23,9 @@ Gem::Specification.new do |s|
   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')
+  s.add_dependency 'activesupport', '>= 3.0'
+
+  s.add_development_dependency('rspec-rails')
 end

data/lib/format_alias/formatters/date.rb

@@ -0,0 +1,12 @@
+module FormatAlias
+  def date_format_alias(name, format, options = {})
+    define_setter_alias(name, options) do |value|
+      time = Time.parse(value, format) rescue nil
+      { name => time }
+    end
+
+    define_getter_alias(name, options) do |value|
+      value.strftime(format) unless value.nil?
+    end
+  end
+end

data/lib/format_alias/formatters/polymorphic.rb

@@ -0,0 +1,18 @@
+module FormatAlias
+  def polymorphic_alias(name, options = {})
+    delimiter  = options.delete(:delimiter) || ':'
+    attributes = ["#{name}_type", "#{name}_id"]
+
+    options_with_attributes = options.merge(attributes: attributes)
+
+    define_setter_alias(name, options_with_attributes) do |value|
+      values = value.to_s.split(delimiter)
+      Hash[attributes.zip(values)]
+    end
+
+    define_getter_alias(name, options_with_attributes) do |*values|
+      values = values.compact
+      values.join(delimiter) if values.any?
+    end
+  end
+end

data/lib/format_alias/railtie.rb

@@ -1,11 +1,6 @@
 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  
+end

data/lib/format_alias/version.rb

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

data/lib/format_alias.rb

@@ -1,6 +1,41 @@
+require 'time'
 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"
+require 'active_support/core_ext/object/blank'
+require 'format_alias/version'
+require 'format_alias/formatters/date'
+require 'format_alias/formatters/polymorphic'
+require 'format_alias/railtie'
+
+module FormatAlias
+  private
+  def define_setter_alias(name, options, &setter)
+    define_method setter_name(name, options) do |value|
+      setter.call(value).each { |name, value| public_send("#{name}=", value) }
+    end
+  end
+
+  def define_getter_alias(name, options, &getter)
+    define_method getter_name(name, options) do
+      attributes = options[:attributes] || [name]
+      getter.call(*attributes.map { |name| public_send(name) })
+    end
+  end
+
+  def alias_name(name, options, type)
+    if options[:suffix].present?
+      "#{name}_#{options[:suffix]}"
+    elsif options[:"#{type}_name"].present?
+      "#{options[:"#{type}_name"]}"
+    else
+      "#{name}_formatted"
+    end
+  end
+
+  def setter_name(name, options)
+    "#{alias_name(name, options, :setter)}="
+  end
+
+  def getter_name(name, options)
+    alias_name(name, options, :getter)
+  end
+end

data/spec/format_alias/format_alias_spec.rb

@@ -6,49 +6,53 @@ describe "FormatAlias spec" do
   end
 
   context "date/time conversions" do
-    it "should correctly convert dates" do
+    it "correctly converts dates" do
       d = DateTime.new(2009, 1, 1)
       @t.d = d
-      @t.d_formatted.should eq("20090101")
-    
+      expect(@t.d_formatted).to eq("20090101")
+
       @t.d_formatted = nil
-      @t.d.should be_nil
-    
+      expect(@t.d).to 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)
+      expect(@t.d.year).to eq(2009)
+      expect(@t.d.month).to eq(2)
+      expect(@t.d.day).to eq(2)
     end
-  
-    it "should correctly convert dates with time zones" do
+
+    it "correctly converts dates with time zones" do
       d = DateTime.new(2009, 1, 1, 12, 0)
       @t.dt = d
       @t.dt_formatted.should eq("20090101 12:00")
+    end
 
-      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
+    it "works with suffix option" do
+      @t.dy_informatted = "20090202"
+      expect(@t.dy_informatted).to eq("2009")
+    end
+
+    it "works with getter/setter names option" do
+      @t.b = "20090202"
+      expect(@t.a).to eq("2009")
     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_formatted = "Page:3"
+      expect(@t.poly_type).to eq('Page')
+      expect(@t.poly_id).to eq('3')
+
+      @t.poly_formatted = "Banner:4"
+      expect(@t.poly_formatted).to eq("Banner:4")
+
+      @t.poly_formatted = nil
+      expect(@t.poly_formatted).to eq(nil)
 
       @t.poly_type = nil
       @t.poly_id = 5
-      @t.poly_type_id.should == "5"
+      expect(@t.poly_formatted).to eq("5")
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,15 +1,3 @@
-$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 'bundler/setup'
+require 'format_alias'
 require 'support/test_class'
-
-$: << File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/support/test_class.rb

@@ -1,13 +1,15 @@
 class TestClass
-  include FormatAlias::Base
-  
-  attr_accessor :d, :dt
+  extend FormatAlias
+
+  attr_accessor :d, :dt, :dy, :dg
   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])
+  date_format_alias(:dy, "%Y", suffix: 'informatted')
+  date_format_alias(:dg, "%Y", getter_name: 'a', setter_name: 'b')
+
+  polymorphic_alias(:poly)
+#  polymorphic_alias(:values, attrs: [:value1, :value2, :value3])
 end

metadata

@@ -1,140 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: format_alias
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 0.0.5
 platform: ruby
-authors: 
+authors:
 - Victor Sokolov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-29 00:00:00 +04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: rspec-rails
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '0'
   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: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Provides virtual attributes to get or set certain model values
+  (like\n    dates) in human readable/localized format.\n  "
+email:
 - gzigzigzeo@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- README.rdoc
+- README.md
 - 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/formatters/date.rb
+- lib/format_alias/formatters/polymorphic.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: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: format_alias
-rubygems_version: 1.6.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: ActiveRecord attribute accessor aliases for date formatting etc.
-test_files: 
+specification_version: 4
+summary: Provides virtual attributes to get or set model values in human readable
+  format.
+test_files:
 - spec/format_alias/format_alias_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_class.rb

data/README.rdoc

@@ -1,44 +0,0 @@
-= 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/lib/format_alias/base.rb

@@ -1,20 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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