acts_as_splittable 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0398f1488b36c65e7f0573f2b0c1e8b103e2c0cd
-  data.tar.gz: ebc482f510f36b2d4e96b52bb2a658afdab6f1dc
+  metadata.gz: 46aa795a10f340366785314f8d7b06c134aef5d5
+  data.tar.gz: ac8a335ccb40e3a20a0c5e9276e4cad6b1f78881
 SHA512:
-  metadata.gz: e2a3c47fe22bf41f4d68cc895ac283f0ea6b1b0ed8aac4e642069cf5ccaec769ff497d3e8eabb2f61309e4c057ae07daaade3a88e5ba3ae5416e0dd7e79f04ab
-  data.tar.gz: dfd523946987d69389c3a3580b176aa28b3bc294b548ecc0c5f198e5a684c3777c3f658c28f19f4d59666c2ccae9b9ab81c3ec87ab58f895a11f69f9190cf6d6
+  metadata.gz: 4e1d5fc52de895056ae9655ff439526d7660ee616299b21d0b263d0371f476d883a0c6d5ac761b15f521dbe2f6babafb3b22d4c85295023525f6a3b23539f60c
+  data.tar.gz: b81343e23eb3e736e20637ab50c83252fec7eaa2e4afdcf24ad3582938358ac0ec64bd78b0cf13dd3b037ac242779b0dde712cf43aa2fe61f21279a0a7e9bea4

data/README.md

@@ -171,6 +171,24 @@ p splittable.email_local  #=> "splittable"
 p splittable.email_domain #=> "example.com"
 ```
 
+### Use Delimiter (Shorthand)
+
+```ruby
+class Splittable < ActiveRecord::Base
+  
+  acts_as_splittable split_on_change: true, join_on_change: true
+
+  splittable :email, delimiter: '@', partials: [:email_local, :email_domain]
+  # :delimiter will be expanded to:
+  # {
+  #   split: ['@'],
+  #   on_join: Proc.new{|values| values.join('@')}
+  # }
+
+  # ...
+end
+```
+
 Contributing
 --------------------
 
@@ -178,4 +196,4 @@ Contributing
 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
+5. Create new Pull Request

data/acts_as_splittable.gemspec

@@ -7,8 +7,8 @@ require "acts_as_splittable/version"
 Gem::Specification.new do |s|
   s.name        = "acts_as_splittable"
   s.version     = ActsAsSplittable::VERSION
-  s.authors     = ["tatat", "takkkun"]
-  s.email       = ["ioiioioloo@gmail.com", "heartery@gmail.com"]
+  s.authors     = ["tatat", "takkkun", "wneko"]
+  s.email       = ["ioiioioloo@gmail.com", "heartery@gmail.com", "aoki@u-ne.co"]
   s.homepage    = "https://github.com/tatat/acts_as_splittable"
   s.summary     = "Create virtual attributes."
   s.description = "Create virtual attributes."

data/lib/acts_as_splittable/config.rb

@@ -0,0 +1,17 @@
+module ActsAsSplittable
+  class Config
+    def splitters
+      @splitters ||= []
+    end
+
+    def splitter(key)
+      splitters.find do |splitter|
+        splitter.name == key.to_sym
+      end
+    end
+
+    def inherit!(other)
+      splitters.replace (other.splitters + splitters).uniq(&:name)
+    end
+  end
+end

data/lib/acts_as_splittable/splittable.rb

@@ -1,57 +1,34 @@
 module ActsAsSplittable
-
   module Splittable
 
-    def split_column_values!(column = nil)
-      if column.nil?
-        self.class.splittable_columns.each_key{|key| send __method__, key }
-      else
-        column                                      = column.to_sym
-        split, pattern, partials, on_split, on_join = self.class.splittable_columns[column]
-        value                                       = send(column)
-
-        unless value.nil?
-          values = if on_split
-            splittable_run_callback(on_split, value)
-          elsif value
-            if split
-              value.to_s.split *(split.is_a?(Array) ? split : [split])
-            elsif matches = value.to_s.match(pattern)
-              matches[1..(matches.length - 1)]
-            end
-          end || []
+    def splittable_partials
+      @splittable_partials ||= {}
+    end
 
-          partials.each_with_index do |partial, index|
-            send :"#{partial}=", values[index]
-          end
+    def split_column_values!(columns = nil)
+      splittable_aggregate_columns(columns) do |column, splitter|
+        value = __send__(column) or next
 
-          reset_splittable_changed_partials partials
+        values = splitter.split(value, self)
+        splitter.partials.zip(values).each do |key, value|
+          __send__ :"#{key}=", value
         end
+        reset_splittable_changed_partials splitter.partials
       end
-
       self
     end
 
-    def join_column_values!(column = nil)
-      if column.nil?
-        self.class.splittable_columns.each_key{|key| send __method__, key }
-      else
-        split, pattern, partials, on_split, on_join = self.class.splittable_columns[column.to_sym]
-        values                                      = partials.map{|partial| send(partial) }
+    def join_column_values!(columns = nil)
+      splittable_aggregate_columns(columns) do |column, splitter|
+        values = splitter.partials.map {|partial| __send__(partial) }
+        next if values.include?(nil)
 
-        unless values.any?(&:nil?)
-          send :"#{column}=", splittable_run_callback(on_join, values)
-          reset_splittable_changed_partials partials
-        end
+        __send__ :"#{column}=", splitter.restore(values, self)
+        reset_splittable_changed_partials splitter.partials
       end
-
       self
     end
 
-    def splittable_partials
-      @splittable_partials ||= {}
-    end
-
     protected
 
     attr_writer :splittable_changed_partials
@@ -70,6 +47,15 @@ module ActsAsSplittable
     end
 
     private
+    def splittable_aggregate_columns(columns = nil)
+      config = self.class.splittable_config
+      columns = columns ? Array(columns) : config.splitters.collect(&:name)
+      columns.collect!(&:to_sym)
+
+      columns.collect do |column|
+        yield(column, config.splitter(column)) if block_given?
+      end
+    end
 
     def splittable_run_callback(callback, *args)
       if callback.is_a?(Proc)
@@ -78,7 +64,6 @@ module ActsAsSplittable
         send(callback, *args)
       end
     end
-    
-  end
 
-end
+  end
+end

data/lib/acts_as_splittable/splitter.rb

@@ -0,0 +1,66 @@
+module ActsAsSplittable
+  class Splitter < Struct.new(:name, :for_split, :pattern, :partials, :on_split, :on_join)
+    DEFAULTS = {
+      on_join: Proc.new {|values| values.join }
+    }.freeze
+
+    ALIASES = {
+      split:  :for_split,
+      column: :name,
+      regex:  :pattern,
+    }.freeze
+
+    def initialize(options = {})
+      @options = options
+
+      options   = DEFAULTS.merge(options)
+      delimiter = options.delete(:delimiter)
+
+      options.each do |key, value|
+        case key
+        when *ALIASES.keys
+          self[ALIASES[key]] = value
+        else
+          self[key] = value
+        end
+      end
+
+      if delimiter
+        self.for_split = [delimiter]
+        self.on_join   = Proc.new {|values| values.join(delimiter)}
+      end
+
+      self.partials ||= pattern_members
+    end
+
+    def split(value, delegate = nil)
+      case
+      when on_split
+        delegation(delegate || self, on_split, value)
+      when for_split
+        value.to_s.split *Array(for_split)
+      when pattern
+        value.to_s.match(pattern).to_a.tap(&:shift)
+      else
+        Array(value)
+      end
+    end
+
+    def restore(values, delegate = nil)
+      delegation(delegate || self, on_join, values)
+    end
+
+    private
+    def delegation(target, method, *args)
+      if method.is_a?(Proc)
+        target.instance_exec(*args, &method)
+      else
+        target.__send__(method, *args)
+      end
+    end
+
+    def pattern_members
+      pattern.names.map(&:to_sym)
+    end
+  end
+end

data/lib/acts_as_splittable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsSplittable
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/acts_as_splittable.rb

@@ -2,11 +2,13 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'active_record'
 require 'acts_as_splittable/splittable'
+require 'acts_as_splittable/splitter'
+require 'acts_as_splittable/config'
 
 module ActsAsSplittable
 
   def acts_as_splittable(options = {})
-    options = options.reverse_merge!(
+    options.reverse_merge!(
       callbacks:       true,
       predicates:      false,
       join_on_change:  false,
@@ -29,65 +31,37 @@ module ActsAsSplittable
   end
 
   module ClassMethods
-    SPLITTABLE_DEFAULT_JOIN_PROCESS = Proc.new{|values| values.join }
-
     attr_writer :splittable_options
 
-    def splittable_options(other_options = {})
+    def splittable_options
       @splittable_options ||= {}
     end
 
     def with_splittable_options(other_options = {})
-      original_options        = splittable_options
-      self.splittable_options = splittable_options.merge(other_options)
+      old = splittable_options
+      self.splittable_options = old.merge(other_options)
       Proc.new.(splittable_options)
-      self.splittable_options = original_options
+    ensure
+      self.splittable_options = old
     end
 
-    def splittable_columns
-      @splittable_columns ||= {}
+    def splittable_config
+      @splittable_config ||= Config.new
     end
 
     def splittable(column, options)
-      column                     = column.to_sym
-      partials                   = (options[:partials] || options[:pattern].names).map(&:to_sym)
-      splittable_columns[column] = [options[:split], options[:pattern], partials, options[:on_split], options[:on_join] || SPLITTABLE_DEFAULT_JOIN_PROCESS]
-
-      partials.each do |partial|
-        define_method partial do
-          splittable_partials[partial]
-        end
-
-        define_method :"#{partial}=" do |value|
-          splittable_partials[partial] = value
-          splittable_changed_partials << partial unless splittable_changed_partial? partial
-
-          self.class.with_splittable_options split_on_change: false do |options|
-            join_column_values! column if options[:join_on_change]
-          end
-        end
-
-        if splittable_options[:predicates]
-          define_method :"#{partial}_changed?" do
-            splittable_changed_partial? partial
-          end
-        end
+      options.merge!(name: column.to_sym)
+      splitter = Splitter.new(options)
+      splittable_config.splitters << splitter
+
+      splitter.partials.each do |partial|
+        define_splittable_getter(partial)
+        define_splittable_setter(partial, splitter)
+        define_splittable_predicator(partial) if splittable_options[:predicates]
       end
 
       if splittable_options[:split_on_change]
-        splittable_module.module_eval <<-"EOS"
-          def #{column}=(value)
-            if defined?(super)
-              super
-            elsif respond_to?(:write_attribute, true)
-              write_attribute :#{column}, value
-            end
-            
-            self.class.with_splittable_options join_on_change: false do
-              split_column_values! :#{column}
-            end
-          end
-        EOS
+        define_splittable_setter_hook(splitter.name)
       end
     end
 
@@ -95,7 +69,7 @@ module ActsAsSplittable
       super
 
       child.splittable_options = splittable_options.dup
-      child.splittable_columns.merge! splittable_columns.dup
+      child.splittable_config.inherit! splittable_config
     end
 
     protected
@@ -103,8 +77,54 @@ module ActsAsSplittable
     def splittable_module
       @splittable_module ||= Module.new
     end
-  end
+    
+    private
+
+    def define_splittable_getter(partial)
+      define_method partial do
+        splittable_partials[partial]
+      end
+    end
+
+    def define_splittable_setter(partial, splitter)
+      define_method :"#{partial}=" do |value|
+        splittable_partials[partial] = value
+
+        unless splittable_changed_partial? partial
+          splittable_changed_partials << partial
+        end
+
+        self.class.with_splittable_options split_on_change: false do |options|
+          if options[:join_on_change]
+            join_column_values! splitter.name 
+          end
+        end
+      end
+    end
+
+    def define_splittable_predicator(partial)
+      define_method :"#{partial}_changed?" do
+        splittable_changed_partial? partial
+      end
+    end
 
+    def define_splittable_setter_hook(name)
+      splittable_module.module_eval do
+        define_method("#{name}=") do |value|
+          if defined?(super)
+            super(value)
+          elsif respond_to?(:write_attribute, true)
+            write_attribute name, value
+          end
+
+          self.class.with_splittable_options join_on_change: false do
+            split_column_values! name
+          end
+        end
+      end
+    end
+
+  end
 end
 
 ActiveRecord::Base.extend ActsAsSplittable

data/spec/models/splittable_spec.rb

@@ -1,129 +1,133 @@
 require 'spec_helper'
 
-[Splittable, SplittableInherited, SplittableInheritedInherited].each do |klass|
-  describe klass do
+shared_examples_for 'splittable' do
+  before :each do
+    @splittable1               = described_class.new(name: "#{described_class.name} 1")
+    @splittable1.email_local   = 'splittable'
+    @splittable1.email_domain  = 'example.com'
+    @splittable1.postal_code1  = '012'
+    @splittable1.postal_code2  = '3456'
+    @splittable1.phone_number1 = '012'
+    @splittable1.phone_number2 = '3456'
+    @splittable1.phone_number3 = '7890'
+    @splittable1.save!
+
+    @splittable2 = described_class.create!(
+      name:          "#{described_class.name} 2",
+      email_local:   'splittable',
+      email_domain:  'example.com',
+      postal_code1:  '012',
+      postal_code2:  '3456',
+      phone_number1: '012',
+      phone_number2: '3456',
+      phone_number3: '7890',
+    )
+
+    @splittables = [@splittable1, @splittable2]
+  end
+
+  it 'should assign attributes' do
+    @splittables.each do |record|
+      record.assign_attributes(postal_code1: '987', postal_code2: '6543')
+
+      record.postal_code1.should == '987'
+      record.postal_code2.should == '6543'
+    end
+  end
+
+  it 'should join partials before save' do
+    @splittables.each do |record|
+      record.email.should        == 'splittable@example.com'
+      record.postal_code.should  == '0123456'
+      record.phone_number.should == '01234567890'
+    end
+  end
+
+  it 'should split columns after initialize' do
+    @splittables.each do |record|
+      splittable = described_class.find(record.id)
+
+      splittable.email_local.should   == 'splittable'
+      splittable.email_domain.should  == 'example.com'
+      splittable.postal_code1.should  == '012'
+      splittable.postal_code2.should  == '3456'
+      splittable.phone_number1.should == '012'
+      splittable.phone_number2.should == '3456'
+      splittable.phone_number3.should == '7890'
+    end
+  end
 
+  context 'when nil includes in partials or value of column is nil' do
     before :each do
-      @splittable1               = klass.new(name: "#{klass.name} 1")
-      @splittable1.email_local   = 'splittable'
-      @splittable1.email_domain  = 'example.com'
-      @splittable1.postal_code1  = '012'
-      @splittable1.postal_code2  = '3456'
-      @splittable1.phone_number1 = '012'
-      @splittable1.phone_number2 = '3456'
-      @splittable1.phone_number3 = '7890'
+      @splittable1 = described_class.new(name: "#{described_class.name} 1")
       @splittable1.save!
 
-      @splittable2 = klass.create!(
-        name:          "#{klass.name} 2",
-        email_local:   'splittable',
-        email_domain:  'example.com',
-        postal_code1:  '012',
-        postal_code2:  '3456',
-        phone_number1: '012',
-        phone_number2: '3456',
-        phone_number3: '7890',
+      @splittable2 = described_class.create!(
+        name: "#{described_class.name} 2"
       )
 
       @splittables = [@splittable1, @splittable2]
     end
 
-    it 'should assign attributes' do
+    it 'should not join partials before save' do
       @splittables.each do |record|
-        record.assign_attributes(postal_code1: '987', postal_code2: '6543')
-
-        record.postal_code1.should == '987'
-        record.postal_code2.should == '6543'
+        record.email.should be_nil
       end
     end
 
-    it 'should join partials before save' do
+    it 'should not split columns after initialize' do
       @splittables.each do |record|
-        record.email.should        == 'splittable@example.com'
-        record.postal_code.should  == '0123456'
-        record.phone_number.should == '01234567890'
-      end
-    end
+        splittable = described_class.find(record.id)
 
-    it 'should split columns after initialize' do
-      @splittables.each do |record|
-        splittable = klass.find(record.id)
-
-        splittable.email_local.should   == 'splittable'
-        splittable.email_domain.should  == 'example.com'
-        splittable.postal_code1.should  == '012'
-        splittable.postal_code2.should  == '3456'
-        splittable.phone_number1.should == '012'
-        splittable.phone_number2.should == '3456'
-        splittable.phone_number3.should == '7890'
+        splittable.email_local.should be_nil
+        splittable.email_domain.should be_nil
       end
     end
+  end
+end
 
-    describe '#*_changed?' do
-      before do
-        @splittable = klass.new
-      end
-
-      it 'should return true when value is changed until #split_column_values! or #join_column_values! is called' do
-        @splittable.email_local_changed?.should_not  be_true
-        @splittable.email_domain_changed?.should_not be_true
-
-        @splittable.email_local = 'splittable'
-        @splittable.email_local_changed?.should be_true
-
-        @splittable.email_domain = 'example.com'
-        @splittable.email_domain_changed?.should be_true
-
-        @splittable.join_column_values!
-
-        @splittable.email_local_changed?.should_not  be_true
-        @splittable.email_domain_changed?.should_not be_true
+shared_examples_for 'splittable with callbacks' do
 
-        @splittable.email_local = nil
-        @splittable.email_local_changed?.should be_true
+  describe '#*_changed?' do
+    before do
+      @splittable = described_class.new
+    end
 
-        @splittable.email_domain = nil
-        @splittable.email_domain_changed?.should be_true
+    it 'should return true when value is changed until #split_column_values! or #join_column_values! is called' do
+      @splittable.email_local_changed?.should_not  be_true
+      @splittable.email_domain_changed?.should_not be_true
 
-        @splittable.split_column_values!
+      @splittable.email_local = 'splittable'
+      @splittable.email_local_changed?.should be_true
 
-        @splittable.email_local_changed?.should_not  be_true
-        @splittable.email_domain_changed?.should_not be_true
-      end
-    end
+      @splittable.email_domain = 'example.com'
+      @splittable.email_domain_changed?.should be_true
 
-    context 'when nil includes in partials or value of column is nil' do
-      before :each do
-        @splittable1 = klass.new(name: "#{klass.name} 1")
-        @splittable1.save!
+      @splittable.join_column_values!
 
-        @splittable2 = klass.create!(
-          name: "#{klass.name} 2"
-        )
+      @splittable.email_local_changed?.should_not  be_true
+      @splittable.email_domain_changed?.should_not be_true
 
-        @splittables = [@splittable1, @splittable2]
-      end
+      @splittable.email_local = nil
+      @splittable.email_local_changed?.should be_true
 
-      it 'should not join partials before save' do
-        @splittables.each do |record|
-          record.email.should be_nil
-        end
-      end
+      @splittable.email_domain = nil
+      @splittable.email_domain_changed?.should be_true
 
-      it 'should not split columns after initialize' do
-        @splittables.each do |record|
-          splittable = Splittable.find(record.id)
+      @splittable.split_column_values!
 
-          splittable.email_local.should be_nil
-          splittable.email_domain.should be_nil
-        end
-      end
+      @splittable.email_local_changed?.should_not  be_true
+      @splittable.email_domain_changed?.should_not be_true
     end
   end
+
 end
 
 describe Splittable do
-  context 'when was given a proc to callbacks' do
+   it_behaves_like 'splittable'
+   it_behaves_like 'splittable with callbacks'
+
+   context 'when was given a proc to callbacks' do
     it 'should call in the record' do
       model_class = Class.new(ActiveRecord::Base) do
         self.table_name = :splittables
@@ -167,6 +171,19 @@ describe Splittable do
   end
 end
 
+
+describe SplittableInherited do
+  it_behaves_like 'splittable'
+  it_behaves_like 'splittable with callbacks'
+end
+
+
+describe SplittableInheritedInherited do
+  it_behaves_like 'splittable'
+  it_behaves_like 'splittable with callbacks'
+end
+
+
 describe SplittableSplitOrJoinOnChange do
 
   it 'should join partials when one of partials is set and all of them are not nil' do
@@ -242,4 +259,23 @@ describe SplittableSplitOrJoinOnChangeWithAliasAttribute do
     splittable1.email_domain.should  == '1.example.com'
   end
 
-end
+end
+
+describe SplittableUseDelimiter do
+
+  let (:splittable) do
+    SplittableUseDelimiter.new(email: 'splittable@example.com')
+  end
+
+  it 'should split value when value is set' do
+    splittable.email_local.should == 'splittable'
+    splittable.email_domain.should == 'example.com'
+  end
+
+  it 'should join partials before save' do
+    splittable.email_local  = 'splittable+1'
+    splittable.email_domain = 'mail.example.com'
+    splittable.email.should == 'splittable+1@mail.example.com'
+  end
+
+end

data/spec/models.rb

@@ -65,4 +65,12 @@ class SplittableSplitOrJoinOnChangeWithAliasAttribute < ActiveRecord::Base
   splittable :email, pattern: EMAIL_SPLIT_PATTERN, on_join: EMAIL_JOIN_PROCESS
 
   alias_attribute :email_address, :email
-end
+end
+
+class SplittableUseDelimiter < ActiveRecord::Base
+  self.table_name = 'splittables'
+
+  acts_as_splittable join_on_change: true, split_on_change: true, callbacks: false
+
+  splittable :email, delimiter: '@', partials: [:email_local, :email_domain]
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_splittable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - tatat
 - takkkun
+- wneko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,6 +78,7 @@ description: Create virtual attributes.
 email:
 - ioiioioloo@gmail.com
 - heartery@gmail.com
+- aoki@u-ne.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -89,7 +91,9 @@ files:
 - Rakefile
 - acts_as_splittable.gemspec
 - lib/acts_as_splittable.rb
+- lib/acts_as_splittable/config.rb
 - lib/acts_as_splittable/splittable.rb
+- lib/acts_as_splittable/splitter.rb
 - lib/acts_as_splittable/version.rb
 - lib/tasks/acts_as_splittable_tasks.rake
 - spec/database.yml.sample