acts_as_splittable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50058ee03ea54fe96784f78b9fab607da4f9dcde
+  data.tar.gz: d04d4414b76cbb3d404f84529387ad02fc555595
+SHA512:
+  metadata.gz: 8e348b339fc458891a206818484dc6c7cb0492360da9f41e50f5e0e5f62e901829d4f75936624f64cae2437c6fc49f3a749aba6475ead80abb0cece633a698e3
+  data.tar.gz: 8356fac51d37d0ca44394aefca88fd8531124963457e709a6c3c42a249d983cee746f965037cff5408787f538c0eca75ea864d3db0c92ece8dc14fc6dcb41677

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy
+spec/database.yml
+Gemfile.lock
+*.sqlite3
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in acts_as_splittable.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 tatat
+
+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,128 @@
+ActsAsSplittable
+====================
+
+Create virtual attributes.
+
+
+Usage
+--------------------
+
+
+```ruby
+class Splittable < ActiveRecord::Base
+
+  acts_as_splittable
+
+  splittable :email,        split: ['@', 2], partials: [:email_local, :email_domain], on_join: Proc.new{|partials| partials.join('@') }
+  splittable :postal_code,  pattern: /\A(?<postal_code1>[0-9]{3})(?<postal_code2>[0-9]{4})\Z/
+  splittable :phone_number, partials: [:phone_number1, :phone_number2, :phone_number3], on_split: :split_phone_number, on_join: :join_phone_number
+
+  validates :email_local,   format: { with: /\A[a-zA-Z0-9_.-]+\Z/ }
+  validates :email_domain,  format: { with: /\A(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,4}\Z/ }
+  validates :postal_code1,  format: { with: /\A[0-9]{3}\Z/ }
+  validates :postal_code2,  format: { with: /\A[0-9]{4}\Z/ }
+  validates :phone_number1, format: { with: /\A[0-9]{3}\Z/ }
+  validates :phone_number2, format: { with: /\A[0-9]{4}\Z/ }
+  validates :phone_number3, format: { with: /\A[0-9]{4}\Z/ }
+
+  protected
+
+  def split_phone_number(value)
+    return if value.nil?
+    [value[0, 3], value[3, 4], value[7, 4]]
+  end
+
+  def join_phone_number(values)
+    values.join
+  end
+end
+```
+
+then
+
+```ruby
+splittable = Splittable.create!(
+  email_local:   'splittable',
+  email_domain:  'example.com',
+  postal_code1:  '012',
+  postal_code2:  '3456',
+  phone_number1: '012',
+  phone_number2: '3456',
+  phone_number3: '7890',
+)
+
+p splittable.email        #=> "splittable@example.com"
+p splittable.postal_code  #=> "0123456"
+p splittable.phone_number #=> "01234567890"
+```
+
+or
+
+```ruby
+splittable               = Splittable.new
+splittable.email_local   = 'splittable'
+splittable.email_domain  = 'example.com'
+splittable.postal_code1  = '012'
+splittable.postal_code2  = '3456'
+splittable.phone_number1 = '012'
+splittable.phone_number2 = '3456'
+splittable.phone_number3 = '7890'
+
+splittable.save!
+```
+
+### Manualy
+
+```ruby
+class Splittable < ActiveRecord::Base
+  
+  # callbacks are
+  #   after_initialize { new_record? or split_column_values! }
+  #   before_save      { join_column_values! }
+  acts_as_splittable callbacks: false
+
+  splittable :email, pattern: /\A(?<email_local>[^@]+)@(?<email_domain>[^@]+)\Z/, on_join: Proc.new{|values| values.join('@') }
+
+  validates :email, presence: true
+end
+```
+
+then
+
+```ruby
+splittable = Splittable.new(
+  email_local:   'splittable',
+  email_domain:  'example.com',
+)
+
+p splittable.email  #=> nil
+p splittable.valid? #=> false
+
+splittable.join_column_values!
+
+p splittable.email  #=> "splittable@example.com"
+p splittable.valid? #=> true
+```
+
+and
+
+```ruby
+splittable = Splittable.find(splittable_id)
+
+p splittable.email_local  #=> nil
+p splittable.email_domain #=> nil
+
+splittable.split_column_values!
+
+p splittable.email_local  #=> 'splittable'
+p splittable.email_domain #=> 'example.com'
+```
+
+Contributing
+--------------------
+
+1. Fork it
+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/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsSplittable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['-c', '-fs']
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks
+

data/acts_as_splittable.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "acts_as_splittable/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "acts_as_splittable"
+  s.version     = ActsAsSplittable::VERSION
+  s.authors     = ["tatat"]
+  s.email       = ["ioiioioloo@gmail.com"]
+  s.homepage    = "https://github.com/tatat/acts_as_splittable"
+  s.summary     = "Create virtual attributes."
+  s.description = "Create virtual attributes."
+
+  s.files       = `git ls-files`.split($/)
+
+  s.add_dependency 'rails', ['>= 3', '< 5']
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+end

data/lib/acts_as_splittable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsSplittable
+  VERSION = "0.0.2"
+end

data/lib/acts_as_splittable.rb

@@ -0,0 +1,95 @@
+require 'active_record'
+
+module ActsAsSplittable
+
+  def acts_as_splittable(options = {})
+    options.reverse_merge!(
+      callbacks: true,
+    )
+
+    extend  ClassMethods
+    include InstanceMethods
+
+    if options[:callbacks]
+      after_initialize { new_record? or split_column_values! }
+      before_save      { join_column_values! }
+    end
+  end
+
+  module ClassMethods
+    SPLITTABLE_DEFAULT_JOIN_PROCESS = Proc.new{|values| values.join }
+
+    def splittable_columns
+      @splittable_columns ||= {}
+    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
+        end
+      end
+    end
+
+    def inherited(child)
+      super
+      child.splittable_columns.merge! splittable_columns.dup
+    end
+  end
+
+  module InstanceMethods
+    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)
+
+        values = if on_split
+          on_split.is_a?(Symbol) ? send(on_split, value) : on_split.(value)
+        elsif value
+          if split
+            value.to_s.split *(split.is_a?(Array) ? split : [split])
+          else
+            matches = value.to_s.match(pattern)
+            matches[1..(matches.length - 1)]
+          end
+        end || []
+
+        partials.each_with_index do |partial, index|
+          send :"#{partial}=", values[index]
+        end
+      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]
+        partials                                    = partials.map{|partial| send(partial) }
+
+        send :"#{column}=", on_join.is_a?(Symbol) ? send(on_join, partials) : on_join.(partials)
+      end
+        
+      self
+    end
+
+    def splittable_partials
+      @splittable_partials ||= {}
+    end
+  end
+end
+
+ActiveRecord::Base.extend ActsAsSplittable

data/lib/tasks/acts_as_splittable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_splittable do
+#   # Task goes here
+# end

data/spec/database.yml.sample

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: acts_as_splittable.sqlite3

data/spec/models/aplittable_with_validation_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe SplittableWithValidation do
+  
+  before :each do
+    @splittable = SplittableWithValidation.new
+  end
+
+  it 'should be valid' do
+    @splittable.email_local  = 'splittable'
+    @splittable.email_domain = 'example.com'
+
+    @splittable.should be_valid
+  end
+
+  it 'should be invalid' do
+    @splittable.email_local  = 'splitt@ble'
+    @splittable.email_domain = 'example.com'
+
+    @splittable.should_not be_valid
+  end
+
+end
+
+describe SplittableWithValidationForOriginalColumn do
+
+  describe '#split_column_values!' do
+    before :each do
+      @splittable = SplittableWithValidationForOriginalColumn.create!(email: 'splittable@example.com')
+    end
+
+    it 'should be nil' do
+      @splittable.email_local.should  be_nil
+      @splittable.email_domain.should be_nil
+    end
+
+    it 'should not be nil' do
+      @splittable.split_column_values!
+      @splittable.email_local.should_not  be_nil
+      @splittable.email_domain.should_not be_nil
+    end
+  end
+
+  describe '#valid?' do
+    before :each do
+      @splittable = SplittableWithValidationForOriginalColumn.new
+    end
+
+    it 'should be valid' do
+      @splittable.email_local  = 'splittable'
+      @splittable.email_domain = 'example.com'
+
+      @splittable.join_column_values!.should be_valid
+    end
+
+    it 'should be invalid' do
+      @splittable.email_local  = 'splitt@ble'
+      @splittable.email_domain = 'example.com'
+
+      @splittable.join_column_values!.should_not be_valid
+    end
+  end
+    
+end

data/spec/models/splittable_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+[Splittable, SplittableInherited, SplittableInheritedInherited].each do |klass|
+  describe klass 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.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',
+      )
+
+      @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 = Splittable.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
+
+  end
+end

data/spec/models.rb

@@ -0,0 +1,46 @@
+EMAIL_SPLIT_PATTERN = /\A(?<email_local>[^@]+)@(?<email_domain>[^@]+)\Z/
+EMAIL_JOIN_PROCESS  = Proc.new{|values| values.join('@') }
+
+class Splittable < ActiveRecord::Base
+
+  acts_as_splittable
+
+  splittable :email,        split: ['@', 2], partials: [:email_local, :email_domain], on_join: EMAIL_JOIN_PROCESS
+  splittable :postal_code,  pattern: /\A(?<postal_code1>[0-9]{3})(?<postal_code2>[0-9]{4})\Z/
+  splittable :phone_number, partials: [:phone_number1, :phone_number2, :phone_number3], on_split: :split_phone_number, on_join: :join_phone_number
+
+  protected
+
+  def split_phone_number(value)
+    return if value.nil?
+    [value[0, 3], value[3, 4], value[7, 4]]
+  end
+
+  def join_phone_number(values)
+    values.join
+  end
+end
+
+class SplittableInherited < Splittable; end
+class SplittableInheritedInherited < SplittableInherited; end
+
+class SplittableWithValidation < ActiveRecord::Base
+  self.table_name = 'splittables'
+
+  acts_as_splittable
+
+  splittable :email, pattern: EMAIL_SPLIT_PATTERN, on_join: EMAIL_JOIN_PROCESS
+
+  validates :email_local,  format: { with: /\A[a-zA-Z0-9_.-]+\Z/ }
+  validates :email_domain, format: { with: /\A(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,4}\Z/ }
+end
+
+class SplittableWithValidationForOriginalColumn < ActiveRecord::Base
+  self.table_name = 'splittables'
+
+  acts_as_splittable callbacks: false
+
+  splittable :email, pattern: EMAIL_SPLIT_PATTERN, on_join: EMAIL_JOIN_PROCESS
+
+  validates :email, format: { with: /\A[a-zA-Z0-9_.-]+@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,4}\Z/ }
+end

data/spec/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define version: 0 do
+
+  create_table "splittables", force: true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.string   "postal_code"
+    t.string   "phone_number"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'active_support/testing/assertions'
+require File.expand_path('../../lib/acts_as_splittable', __FILE__)
+
+ENV['RAILS_ENV']     ||= 'test'
+
+db_name      = ENV['DB'] || 'sqlite3'
+database_yml = File.expand_path('../database.yml', __FILE__)
+
+raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample" unless File.exists?(database_yml)
+
+ActiveRecord::Base.configurations = YAML.load_file(database_yml)
+ActiveRecord::Base.establish_connection(db_name)
+ActiveRecord::Base.connection
+
+load File.dirname(__FILE__) + '/schema.rb'
+load File.dirname(__FILE__) + '/models.rb'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include ActiveSupport::Testing::Assertions
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_splittable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- tatat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create virtual attributes.
+email:
+- ioiioioloo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- acts_as_splittable.gemspec
+- lib/acts_as_splittable.rb
+- lib/acts_as_splittable/version.rb
+- lib/tasks/acts_as_splittable_tasks.rake
+- spec/database.yml.sample
+- spec/models.rb
+- spec/models/aplittable_with_validation_spec.rb
+- spec/models/splittable_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tatat/acts_as_splittable
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Create virtual attributes.
+test_files: []